===== Условные обозначения при описании аттрибутов / свойств =====

На этой странице можно найти расшифровку префиксов в квадратных скобках, используемых в данной документации.

==== Структура файла ====

При описании иерархической структуры файлов префиксами указывается количество раз, которое может встретиться дочерний элемент внутри родительского:

^Префикс^Описание|
|**[1]** |только один элемент|
|**[1..N]** |один или более элементов|
|**[0..N]** |любое количество элементов|

==== Типы аттрибутов / свойств ====

Свойство каждого элемента имеет определенный тип: булева переменная, целое число или что-то другое. Список возможных типов указан в таблице ниже:

^Префикс^Описание|
|**[STRING]** |Строковый тип|
|**[BOOL]** |Булевый тип|
|**[INT]** |Целочисленный тип|
|**[FLOAT]** |Число с плавающей запятой|
|**[POS]** |Строка вида "x,y" - положение|
|**[RECT]** |Строка вида "x,y,width,height" - положение и размеры|
|**[DOCK]** |Прикрепление дочернего элемента \\ (TopRight / TopLeft / BottomRight / BottomLeft / Left / Right / Top / Bottom / Center)|
|**[COLOR]** |Цвет \\ (white / black / blue / cyan / green / magenta / transparent / yellow / red / #AARRGGBB)|

*после знака равно указывается значение по умолчанию

==== Разрешения доступа ====

Свойства могут быть проинициализированы один раз, а могут меняться в процессе работы программы. Префиксы разрешений перечислены ниже:

^Префикс^Описание|
|**[R]** |чтение из lua-скрипта|
|**[W]** |запись из lua-скрипта|
|**[I]** |инициализация через конфигурационный .xml файл|
|**[T]** |инициализация через библиотеку элементов|

==== Операционная система ====

Наша работа нацелена на кроссплатформенность. Однако в некоторых случаях функционал доступен только для определенной ОС. Префиксы следующие:

^Префикс^Описание|
|**[WIN]** |только Windows|
|**[RPI]** |только Raspbian|
|**[LINUX]** |только ОС на базе ядра Linux|

==== Прочее ====

^Префикс^Описание|
|**[ID]** |Уникальный идентификатор элемента|
|**[FILE]** |Возможна загрузка значения из файла|
|**[LANG]** |Можно указать разные значения для разных языков / \\ Можно загрузить текст из строковых данных|
|**[PRIV]** |Для внутреннего пользования*|
|**[EXP]** |Экспериментальная возможность*|
|**[DEPR]** |Аттрибут будет удален в последующих версиях*|

* в документацию данные префиксы будут попадать только при необходимости

\\