mirror of
https://github.com/CopterExpress/clever-show.git
synced 2026-05-26 07:07:58 +00:00
Docs: Added config editor docs and assests
This commit is contained in:
BIN
docs/assets/server-config-editor-menu.png
Normal file
BIN
docs/assets/server-config-editor-menu.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.8 KiB |
BIN
docs/assets/server-config-editor.png
Normal file
BIN
docs/assets/server-config-editor.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
@@ -257,7 +257,45 @@
|
||||
|
||||
### Config editor
|
||||
|
||||
...
|
||||
Встроенный редактор конфигураций позволяет открывать и интуитивно редактировать файлы конфигурации сервера и клиента, ровно как и сторонние файлы конфигурации формата `.ini`. Редактор может быть запущен с помощью контекстного меню в таблице коптеров в сервере, из меню сервера, или запущен как отдельное приложение.
|
||||
|
||||
Значение каждого столбца может быть отредактировано по двойному клику на него.
|
||||
|
||||
Значения столбца `Option` (названия секций и параметров) не могут повторяться в одном и том же уровне древа - названия секций и параметров будут автоматически изменятся с добавлением нумерации при повторяющихся наименованиях.
|
||||
|
||||
Для значений столбца `Value` (фактические значения параметров) будет использован соответствующий встроенный редактор значений (для целочисленных, дробных и булевых значений). Значения массивов любых типов также отображается в виде элементов древа. Каждое из этих значений можно редактировать, перемещать, удалять и добавлять независимо.
|
||||
|
||||
При редактировании параметра без значения можно указать значение `<list> ` или в виде списка в виде `[1, 2, 3]` или `(1, 2, 3)` - это автоматически преобразует значение в список.
|
||||
|
||||

|
||||
|
||||
Файл конфигурации отображается в редакторе в виде древа. Каждая "строка" в представлении - раздел или параметр конфигурации. Разделы конфигурации могут быть свёрнуты. Каждая строка может быть перемещена с помощью drag-n-drop для изменения порядка параметров и структуры разделов (возможно перетаскивание строки *на* раздел конфигурации для перемещения другого раздела\параметра в него). При зажатой клавише `alt` при перетаскивании параметр или раздел будут скопированы.
|
||||
|
||||
- Чекбокс `Color Indication` Включает или отключает цветовую индикацию состояния строк:
|
||||
- *Синий* - Данного параметра *не было* в файле конфигурации при загрузке и его значение было взято из спецификации конфигурации. Изменение данного параметра приведет к добавлению его в текущий файл конфигурации.
|
||||
- *Бирюзовый* - Данный параметр находится в файле конфигурации, но его значение совпадает со значением по умолчанию из спецификации конфигурации.
|
||||
- *Жёлтый* - Значение данного параметра было изменено пользователем в текущей сессии редактирования.
|
||||
- *Зелёный* - Данный параметр был добавлен в текущей сессии редактирования.
|
||||
- *Красный* - Данный параметр был исключен из конфигурации пользователем текущей сессии редактирования. Он не будет сохранен в конфигурации.
|
||||
- Чекбокс `Restart` - доступен только при редактировании конфигураций сервера или клиента. Автоматически перезапускает сервер или клиент после сохранения конфигурации.
|
||||
- Кнопка `Save as` - Позволяет сохранить копию файла конфигурации на компьютер. В диалоговом окне выберите расположение и имя файла. **Внимание!** Конфигурация *не будет* проверена на соответствие спецификации!
|
||||
- Кнопка `Save` - Сохраняет файл конфигурации. Перед сохранением будет проведена проверка файла на соответствие текущей конфигурации спецификации. При возникновении ошибок будет выведен детальный отчет по ним и будет предложено продолжить редактирование. При сохранении конфигурации сгенерированной на основе спецификации будет предложено выбрать новый путь для сохранения файла.
|
||||
- Кнопка `Cancel` - Отменяет внесенные в конфигурацию изменения и закрывает диалоговое окно редактора конфигураций.
|
||||
|
||||
|
||||
|
||||
#### Контекстное меню и команды редактора конфигураций
|
||||
|
||||

|
||||
|
||||
- `Duplicate` (`Shift+D`) - создает копию параметра или раздела (со всему входящими в него параметрами). К имени опции или раздела будет добавлена нумерация для избегания повторяющихся названий.
|
||||
- `Toggle exclude` (`Alt+Del`) - исключает параметр или раздел из конфигурации. Параметр или раздел *не* будут удалены, но *не* будут записаны при сохранении. Повторное применение этой команды на уже исключенных параметрах или разделах вернет их к нормальному состоянию.
|
||||
- `Remove from config` (`Del`) - *удаляет* параметр или раздел из конфигурации. **Внимание!** Это действие необратимо!
|
||||
- `Clear item value` (`Shift+R`) - *удаляет* значение параметра или всех параметров раздела (если использовано на разделе). Это так же приводит к сбросу типа значения параметра и он будет восстановлен из следующего текстового ввода при редактировании значения. **Внимание!** Это действие необратимо!
|
||||
- `Reset value to default` (`Ctrl+R`) - приводит к значению по умолчанию (из спецификации конфигурации) значение параметра или всех параметров раздела (если использовано на разделе). Это так же приводит к сбросу типа значения параметра и он будет восстановлен из следующего текстового ввода при редактировании значения. **Внимание!** Это действие необратимо!
|
||||
- `Reset all changes` (`Alt+R`) - восстанавливает к первоначальному виду параметр или все параметры раздела (если использовано на разделе). **Внимание!** Это действие необратимо!
|
||||
- `Add option` (`Shift+A`) - добавляет параметр с пустым значением, первое редактирование значения определит его тип
|
||||
- `Add section`(`Ctrl+A`) - добавляет раздел.
|
||||
|
||||
### Column preset editor
|
||||
|
||||
|
||||
Reference in New Issue
Block a user