|
|
@@ -867,12 +867,75 @@ SEQ сам может быть элементом контейнера SWITCH.
|
|
|
|
|
|
#### Атрибут `name`
|
|
|
|
|
|
+Атрибут `name` является идентификатором элемента. Среди элементов текущего уровня
|
|
|
+вложенности, идентификатор должен быть уникальным. В разных ветках схемы могут
|
|
|
+присутствовать элементы с одинаковым именем. Важно, чтобы был уникален абсолютный
|
|
|
+путь элемента, т.е. комбинация имени самого элемента и имен всех его "предков".
|
|
|
+
|
|
|
+Для тега `COMMAND` атрибут также служит значением позиционного параметра, если не
|
|
|
+определен атрибут `value`. Т.е. оператор вводит строку, равную имени элемента
|
|
|
+`COMMAND`, чтобы вызвать эту команду.
|
|
|
+
|
|
|
|
|
|
#### Атрибут `value`
|
|
|
|
|
|
+Если идентификатор команды (атрибут `name`) отличается от имени команды для
|
|
|
+оператора, то атрибут `value` содержит имя команды, каким оно представляется
|
|
|
+оператору.
|
|
|
+
|
|
|
+Используется для следующих тегов:
|
|
|
+
|
|
|
+* `COMMAND`
|
|
|
+* `PARAM`
|
|
|
+* `PTYPE`
|
|
|
+
|
|
|
+```
|
|
|
+<COMMAND name="cmdid" value="next"\>
|
|
|
+```
|
|
|
+
|
|
|
+В примере идентификатор команды равен "cmdid". Он будет использоваться, если
|
|
|
+нужно создать ссылку на этот элемент внутри XML конфигов. Но пользователь, чтобы
|
|
|
+запустить команду на выполнение, в командной строке вводит текст `next`.
|
|
|
+
|
|
|
|
|
|
#### Атрибут `help`
|
|
|
|
|
|
+При работе с командной строкой оператор может получить подсказку по возможным
|
|
|
+командам, параметрам и их назначению. В клиенте "klish" подсказка будет показана
|
|
|
+при нажатии клавиши `?`. Самый простой способ задать текст подсказки для элемента
|
|
|
+- это указать значение атрибута `help`.
|
|
|
+
|
|
|
+Следующие теги поддерживают атрибут `help`:
|
|
|
+
|
|
|
+* `COMMAND`
|
|
|
+* `PARAM`
|
|
|
+* `PTYPE`
|
|
|
+
|
|
|
+Подсказка, заданная с помощью атрибута `help`, является статической. Другой
|
|
|
+способ задать подсказку для элемента - это создать вложенный элемент `HELP`.
|
|
|
+Элемент `HELP` генерирует текст подсказки динамически.
|
|
|
+
|
|
|
+```
|
|
|
+<COMMAND name="simple" help="Command with static help"/>
|
|
|
+
|
|
|
+<COMMAND name="dyn">
|
|
|
+ <HELP>
|
|
|
+ <ACTION sym="script">
|
|
|
+ ls -la "/etc/passwd"
|
|
|
+ </ACTION>
|
|
|
+ <HELP>
|
|
|
+</COMMAND>
|
|
|
+```
|
|
|
+
|
|
|
+Если для элемента одновременно заданы и атрибут `help` и вложенный элемент
|
|
|
+`HELP`, то будет использоваться динамический вложенный элемент `HELP`, а атрибут
|
|
|
+будет проигнорирован.
|
|
|
+
|
|
|
+Элемент `PTYPE` имеет свои подсказки. Как статический атрибут, так и динамический
|
|
|
+элемент. Эти подсказки будут использованы для параметра `PARAM`, использующего
|
|
|
+этот тип данных, в том случае, если для параметра не задан ни атрибут, ни
|
|
|
+динамический элемент `HELP`.
|
|
|
+
|
|
|
|
|
|
#### Атрибут `container`
|
|
|
|
Serj Kalichev