[!] Новый формат документации, реализуемый с помощью модуля Help. Что бы получить доступ к интерактивной документации перейдите на адрес ?id=Help/Show
Для создания раздела справки по модулю, необходимо в папке Help модуля (например, module1) создать файл (например, theme1 для раздела справки module1/theme1)
Внутри файла необходимо создать класс наследник от _WIA_Help с именем i128Help_<modulename>_<theme> (в нашем примере class i128Help_module1_theme1 extends _WIA_Help)
Для класса можно определить следующие функции:
function Title() - возвращает строку с названием страницы помощи
function Text() - возвращает текст помощи в формате html
function Sub() - возвращает массив строк, в каждой строке содержится имя дочернего раздела помощи
function UpLink() - возвращает имя родительского раздела помощи
[!] Help/ModuleRoot&module=<modulename> - открытие основной страницы описания модуля. Подключает страницы:
<modulename>/Root - Руководство пользователя модуля
Help/Module/ConfigParameters&module=<modulename> - Параметры (переменные) модуля
Help/Module/Functions&module=<modulename> - Функции модуля (__call)
Help/Module/Actions&module=<modulename> - Действия модуля (Actions)
Help/Module/Pages&module=<modulename> - Страницы модуля (Pages)
[!] Help/Module/ConfigParameters&module=<modulename> - строит таблицу параметров модуля (Имя, Описание, Значение по умолчанию, тип, Поле хранения)
Данные берутся из таблицы параметров модуля, определяемых в AdminModuleVariablesInit
[!] Help/Module/Functions&module=<modulename> - Строит таблицу с описанием внешних функций модуля (расположенных в папке __call)
Поля описания: Имя функции, Описание, Параметры
Для того что бы у функциии появилось описание, необходимо дополнить класс внешней функции специальными публичными функциями:
GetTitle() - возвращает описание функции
GetParamInfo() - возвращает ассоциативный массив с описанием параметров. Ассоциацией является имя параметра.
Каждый параметр в свою очередь описывается ассоциативным массивом с полями:
'Def' => Значение по умолчанию
'Desc' => Описание параметра
'Type' => Тип параметра
[!] Help/Module/Actions&module=<modulename> - строит таблицу экшенов модуля (папка Actions)
Поля описания: Имя, Описание, Параметры
Для того что бы у экшена появилось описание, необходимо дополнить класс экшена специальными публичными функциями:
GetTitle() - возвращает описание экшена
GetParamInfo() - возвращает ассоциативный массив с описанием параметров. Ассоциацией является имя параметра.
Каждый параметр в свою очередь описывается ассоциативным массивом с полями:
'Def' => Значение по умолчанию
'Desc' => Описание параметра
'Type' => Тип параметра
[!] Help/Module/Pages&module=<modulename> - строит таблицу страниц модуля
Поля описания: Имя страницы, Описание, Параметры.
Для того что бы у страницы появилось описание, необходимо дополнить класс страницы специальными публичными функциями:
GetTitle() - возвращает название страницы
GetParamInfo() - возвращает ассоциативный массив с описанием параметров. Ассоциацией является имя параметра.
Каждый параметр в свою очередь описывается ассоциативным массивом с полями:
'Desc' => Описание параметра
'Type' => Тип параметра
[!] Help/Module/Formats&module=<modulename> - строит таблицу форматов модуля
Поля описания: Имя формата, Описание, Параметры.
Для того что бы у формата появилось описание, необходимо дополнить класс формата специальными публичными функциями:
GetTitle() - возвращает описание формата
GetParamInfo() - возвращает ассоциативный массив с описанием параметров. Ассоциацией является имя параметра.
Каждый параметр в свою очередь описывается ассоциативным массивом с полями:
'Desc' => Описание параметра
[!] Help/Module/RecordParameters&module=<modulename> - строит таблицу параметров записей модуля
Поля описания: Имя, Описание, Значение по умолчанию, Тип, Поле хранения
Данные берутся из таблицы параметров модуля, определяемых в Variables
[+] Help/GeneralDescription
[+] Help/GeneralDescription/Architecture
[+] Help/GeneralDescription/MainFeatures
[+] Help/Server128
[+] Help/SystemRequirements
[+] Help/SystemRequirements/ApplicationServer
[+] Help/SystemRequirements/Client
[+] Help/SystemRequirements/TCPIP
[+] Help/TCPIPServer
[+] Help/TCPIPServer/Configuring
[+] Help/TCPIPServer/FileStructure
[+] Help/TCPIPServer/InstallationAndStartup
[+] Help/TCPIPServer/InstallationAndStartup/Installation
[+] Help/TCPIPServer/Introduction
[+] Help/TCPIPServer/MainCharacteristics
[+] Help/TCPIPServer/Protocol
[+] Help/TCPIPServer/UserInterface
[+] Admin/Root
[+] EC/Purpose
[+] EC/Root
[+] EC/SearchRequest
[+] EC/SearchResult
[+] EC/SearchResult/Navigation
[+] EC/Help/SearchResult
[+] EC/Help/SearchResult/Navigation
[+] EC/Help/SearchResult/SearchActions
[+] EC/Help/SearchResult/SearchActions
[+] EC/Help/SearchResult/SearchActions/Annotation
[+] EC/SearchResult/SearchActions/Contents
[+] EC/SearchResult/SearchActions/Copyright
[+] EC/SearchResult/SearchActions/Export
[+] EC/SearchResult/SearchActions/Favorites
[+] EC/SearchResult/SearchActions/FullText
[+] EC/SearchResult/SearchActions/JNJ
[+] EC/SearchResult/SearchActions/Keywords
[+] EC/SearchResult/SearchActions/NJASP
[+] EC/SearchResult/SearchActions/Print
[+] EC/SearchResult/SearchActions/RQST
[+] EC/SearchResult/SearchActions/SaveSearch
[+] EC/SearchResult/SearchActions/SubSearch
[+] EC/SearchResult/SearchActions/SysIndex
[+] EC/SearchResult/SearchActions/ViewFull
[+] EC/UILook
[+] Описано EC/Pages/ShowFull
[+] Описано Pages/Actions/ImportJIRBISButton
[+] Описано Pages/Actions/ImportJIRBISButtonProcess
[+] Описано Pages/Formats/brief
[+] Описано Pages/Formats/feed
[+] Описано Pages/Formats/full
[+] Описано Pages/__call/EchoCaption