мета-данные страницы
Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
документация_в_программе [17.07.2022 12:05] Egor |
документация_в_программе [17.07.2022 13:17] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== Справка/помощь в программе ====== | + | ====== Помощь в программе ====== |
| - | Документирование в программе разделено на три части: \\ | + | ===== Содержание ===== |
| - | 1. Общая справка по всей системе\\ | + | * [[#Общая информация|Общая информация]] |
| - | 2. Справка в журналах\\ | + | * [[#1. Общая помощь по всей системе|1. Общая помощь по всей системе]] |
| - | 3. Справка в карточках\\ | + | * [[#2. Помощь в журналах|2. Помощь в журналах]] |
| + | * [[#3. Помощь в карточках|3. Помощь в карточках]] | ||
| + | * [[#Настройка помощи|Настройка помощи]] | ||
| + | * [[#1. Задать персональные ссылки для определенной карточки/журнала|1. Задать персональные ссылки для определенной карточки/журнала]] | ||
| + | * [[#2. Закрепить ссылки за определенными мета-объектами|2. Закрепить ссылки за определенными мета-объектами]] | ||
| + | * [[#Дополнительная информация|Дополнительная информация]] | ||
| + | ---- | ||
| - | ====== 1. Общая справка по всей системе ====== | + | ====== Общая информация ====== |
| - | Доступ к общей справке по всей системе находится в главном меню "//Справка -> Документация//" | + | Помощь в программе разделена на три части: \\ |
| + | 1. Общая помощь по всей системе\\ | ||
| + | 2. Помощь в журналах\\ | ||
| + | 3. Помощь в карточках\\ | ||
| + | |||
| + | |||
| + | ===== 1. Общая помощь по всей системе ===== | ||
| + | |||
| + | |||
| + | Доступ к общей помощи по всей системе находится в главном меню "//Справка -> Документация//" | ||
| {{:pasted:20220717-120443.png}} | {{:pasted:20220717-120443.png}} | ||
| Строка 18: | Строка 33: | ||
| {{:pasted:20191223-131145.png}} | {{:pasted:20191223-131145.png}} | ||
| - | **На втором этапе** планируется сделать контекстно-зависимую помощь.\\ | ||
| - | Для вызова используется пункт кнопка **Помощь**.\\ | ||
| - | Кнопка **Помощь** появляется автоматически при подключении справочных материалов к форме.\\ | ||
| - | Для примера можно посмотреть справочники "Фирмы" и "Склады\отделы".\\ | ||
| - | {{:pasted:20191223-131227.png}}\\ | ||
| + | ===== 2. Помощь в журналах ===== | ||
| + | |||
| + | |||
| + | Кнопка помощь во всех журналах, наследниках от "TUniDblListForm" или "TUniListFrame" и находится в главном меню журнала, отображается если на нее назначена какая-нибудь ссылка. | ||
| + | |||
| + | Например журнал "//**Фирмы**//" | ||
| + | |||
| + | {{:pasted:20220717-123002.png}} | ||
| + | |||
| + | Журнал "Регистрация сотрудников" | ||
| + | |||
| + | {{:pasted:20220717-123036.png}} | ||
| + | |||
| + | С журналом может быть связано несколько ссылок на документацию, в этом случае слева появится список ссылок на помощь\\ | ||
| - | С формой можно связать несколько документов, в этом случае слева появится список справочных документов.\\ | ||
| {{:pasted:20191223-130731.png}} | {{:pasted:20191223-130731.png}} | ||
| - | При загрузке данных открывается нижняя панель статуса, не которой отображается сообщение "Идет загрузка данных ...".\\ | ||
| - | Эта панель закрывается после завершения загрузки документа.\\ | ||
| - | {{:wiki:him_lrxymzlbky.png}}\\ | ||
| - | Если при загрузке данных возникает ошибка, то открывается окно с сообщением об ошибке.\\ | + | ===== 3. Помощь в карточках ===== |
| - | {{:wiki:pasted:20191231-090530.png}}\\ | + | |
| - | Ошибка так же отображается на панели статуса и записывается в лог программы.\\ | ||
| - | {{:wiki:pasted:20191231-090836.png}}\\ | ||
| + | Кнопка "//**Помощь**//" находится во всех формах, наследниках от "//**UniForm**//" (если на нее назначена какая-нибудь ссылка) | ||
| + | |||
| + | {{:pasted:20220717-124607.png}} | ||
| <ifauth @programmers> | <ifauth @programmers> | ||
| - | Список ссылок на документы хранится в объекте T_Help | ||
| + | ====== Настройка помощи ====== | ||
| + | |||
| + | Класс описывающий работу помощи - "//**T_Help**//" | ||
| + | |||
| + | **Настроить отображение помощь можно двумя способами:** \\ | ||
| + | 1. Задать персональные ссылки для определенной карточки/журнала\\ | ||
| + | 2. Закрепить ссылки за определенными мета-объектами\\ | ||
| - | ===== Составление списка документов справки непосредственно в описании формы ===== | + | ===== 1. Задать персональные ссылки для определенной карточки/журнала ===== |
| - | В списке модулей должны быть указаны **rHelp**, **fHelp** | + | В списке модулей должны быть указаны |
| uses ... rHelp, fHelp ... | uses ... rHelp, fHelp ... | ||
| Для использования T_Help должна быть задана директива компилятора **CHROM**.\\ | Для использования T_Help должна быть задана директива компилятора **CHROM**.\\ | ||
| - | Пример функции, которая вызывает справку состоящую из трех документов:\\ | + | Пример функции, которая вызывает помощь состоящую из трех ссылок:\\ |
| - | первый - это явно заданный HTML-текст, второй и третий являются ссылками на страницы WEB-сайта с документацией. \\ | + | первая - это явно заданный HTML-текст, второй и третий являются ссылками на страницы WEB-сайта с документацией. \\ |
| При формировании элемента списка в **rlHelp.Add("Заголовок","URL","HTML","Показывать по умолчанию","Уровень доступа")** указываются параметры:\\ | При формировании элемента списка в **rlHelp.Add("Заголовок","URL","HTML","Показывать по умолчанию","Уровень доступа")** указываются параметры:\\ | ||
| **"Заголовок"**, который будет отображаться в списке документов;\\ | **"Заголовок"**, который будет отображаться в списке документов;\\ | ||
| Строка 105: | Строка 131: | ||
| </sxh> | </sxh> | ||
| - | ===== Составление списка документов справки через код метакласса формы ===== | + | ==== 2. Закрепить ссылки за определенными мета-объектами ==== |
| - | Сопоставление форм и WEB-страниц выполняется функцией T_Help.InitByAgbisRu\\ | + | Сопоставление форм и WEB-страниц выполняется функцией T_Help.InitByAgbisRu. В "//**case ifMetaTag of**//" нужно добавить "**//tag//**" необходимого мета-объекта и добавить ссылку\\ |
| <sxh Delphi> | <sxh Delphi> | ||
| class function T_Help.InitByAgbisRu(rfHelp:T_Help; lfIsAgbis, lfIsAdmin:Boolean; | class function T_Help.InitByAgbisRu(rfHelp:T_Help; lfIsAgbis, lfIsAdmin:Boolean; | ||
| Строка 141: | Строка 167: | ||
| </ifauth> | </ifauth> | ||
| - | ==== Дополнительная информация ==== | + | |
| + | ====== Дополнительная информация ====== | ||
| [[FormHelp|Помощь]] | [[FormHelp|Помощь]] | ||