XML "Главной страницы"

Материал из ISPWiki

Введение

Для описания первоначального вида "главной страницы" используется файл billmgr_dashboard_5.xml, расположенный в каталоге /usr/local/ispmgr/etc. Цифра в имени файла означает "уровень доступа" пользователя, для которого будет использоваться файл. Например, "5" - это уровень клиента биллинга.

При первом заходе пользователя на главную страницу содержимое основного файла копируется в файл /usr/local/ispmgr/var/userconf/billmgr.USERNAME.dashboard.xml, где USERNAME - это имя пользователя. Все дальнейшие настройки пользователем вида главной страницы сохраняются в этом файле, не затрагивая основного файла или файлов других пользователей.

Корневой элемент XML (doc)

 <xs:element name="doc"/>

Корневой элемент содержит элементы block, описывающие блоки главной страницы.

Блок (block)

 <xs:element name="block">
   <xs:complexType>
     <xs:sequence>
       <xs:element minOccurs="0" ref="toolbtn"/>
       <xs:element minOccurs="0" ref="col"/>
     </xs:sequence>
     <xs:attribute name="name" use="required" type="xs:NCName"/>
     <xs:attribute name="position" use="required" type="xs:NCName"/>
     <xs:attribute name="type" use="required" type="xs:NCName"/>  
     <xs:attribute name="func" type="xs:NCName"/>  
     <xs:attribute name="rows" type="xs:integer"/>  
   </xs:complexType>
 </xs:element>

Каждый блок главной страницы описывается отдельным элементом block.

атрибут name

Уникальное имя блока.

атрибут position

Позиция блока на главной странице. Может принимать значения top (блок расположен вверху страницы), left (блок расположен в левой колонке) или right (блок расположен в правой колонке).

атрибут type

Тип блока. Может принимать значения toolbar (блок содержит кнопки) или list (блок содержит табличные данные).

атрибут func

Может существовать только, если type="list". Название функции, из вызова которой берутся табличные данные.

атрибут rows

Может существовать только, если type="list". Количество выводимых строк таблицы.

элемент toolbtn

Описывает кнопку, если у блока type="toolbar". Если у блока type="list", то указывает на элемент toolbtn основного XML-файла; перечисленные кнопки будут использоваться для выполнения операции над элементами таблицы.

элемент col

Указывает на элемент col основного XML-файла. Перечисленные колонки таблицы будут отображаться в описываемом блоке.

Кнопка (toolbtn)

 <xs:element name="toolbtn">
   <xs:complexType>
     <xs:attribute name="name" use="required" type="xs:NCName"/>
     <xs:attribute name="img" use="required" type="xs:NCName"/>
     <xs:attribute name="func" use="required" type="xs:NCName"/>  
     <xs:attribute name="list" type="xs:NCName"/>  
     <xs:attribute name="action" type="xs:NCName"/>  
   </xs:complexType>
 </xs:element>

Описывает кнопку, если у блока type="toolbar". Если у блока type="list", то указывает на элемент toolbtn основного XML-файла; перечисленные кнопки будут использоваться для выполнения операции над элементами таблицы.

атрибут name

Уникальное имя кнопки. В случае использования в блоке с аттрибутом type="list" должно совпадать с именем кнопки основного XML-файла.

атрибут img

Имя картинки, которая будет отображена на кнопке. Необходимо указать без расширения.

атрибут func

Содержит имя функции, которая будет отображаться в форме при нажатии на кнопку. Может быть использована совместно с аттрибутом list.

атрибут list

Содержит имя функции, которая будет отображаться в списке при нажатии на кнопку. Может быть использована совместно с аттрибутом func.

атрибут action

Содержит Javascript код, который будет выполняться при нажатии на кнопку.

Колонка таблицы (col)

 <xs:element name="col">
   <xs:complexType>
     <xs:attribute name="name" use="required" type="xs:NCName"/>
     <xs:attribute name="sort" use="required" type="xs:NCName"/>
     <xs:attribute name="sorted" use="required" type="xs:NCName"/>  
   </xs:complexType>
 </xs:element>

Указывает на элемент col основного XML-файла. Перечисленные колонки таблицы будут отображаться в описываемом блоке.

атрибут name

Имя колонки. Должно совпадать с именем колонки основного XML-файла

атрибут sort

Задаёт тип сортировки данных в колонке. Возможные значения: alpha (алфавитная сортировка; по умолчанию), digit (сортировка в порядке числового возрастания), file (сортировка по алфавиту, сначала отобразить директории, затем файлы), indicator (сортировка по "использованному значению" индикатора; только для колонок с индикаторами), ip (сортировка IP-адресов), prop (сортировка по наличию свойств; только для колонок, графически отображающих свойства).

атрибут sorted

если sorted="asc", таблица по умолчанию отсортирована по этой колонке. sorted="desc" отсортировано в обратном порядке.