# Встроенная справка внешней обработки 1С Спецификация добавления встроенной справки (Help) к внешней обработке (EPF) в формате XML-выгрузки версии 2.17. ## 1. Структура файлов ``` <ИмяОбработки>/ Ext/ Help.xml # Метаданные справки (обязательно) Help/ ru.html # HTML-страница справки на русском языке ``` Справка **не регистрируется** в `ChildObjects` корневого XML обработки — достаточно наличия файлов `Help.xml` и `Help/<язык>.html` в каталоге `Ext/`. ## 2. Help.xml — метаданные справки Пространство имён: `http://v8.1c.ru/8.3/xcf/extrnprops` (то же, что у Template.xml). ```xml ru ``` Элемент `` указывает код языка. Имя файла страницы: `<код_языка>.html`. Может быть несколько элементов `` для разных языков. ## 3. HTML-страница справки Формат: HTML 4.0 Transitional, кодировка UTF-8. ### Минимальный шаблон ```html Содержимое справки ``` ### Обязательные элементы head | Элемент | Назначение | |---------|------------| | `` | Кодировка UTF-8 | | `` | Стили справки 1С (протокол `v8help://`) | ### Поддерживаемая разметка Стандартный HTML 4.0: `

`..`

`, `

`, ``, ``, ``, ``, `
`, `
` и др. Стили 1С автоматически форматируют заголовки и абзацы. ## 4. Метаданные формы — IncludeHelpInContents В файле метаданных формы (`Forms/<ИмяФормы>.xml`) должен быть элемент: ```xml false ``` Полный контекст в файле формы: ```xml
ОсновнаяФорма ... Managed false ... ``` Значение `false` — справка не включается в общее оглавление справочной системы (стандартное поведение для внешних обработок). ## 5. Кнопка вызова справки на форме Для вызова справки используется стандартная команда платформы `Form.StandardCommand.Help`. ### Вариант А: кнопка в AutoCommandBar формы Простейший способ — добавить кнопку в автокомандную панель формы (`id="-1"`): ```xml false ``` Кнопка появится на автокомандной панели формы (верхняя строка). Подходит для простых форм. ### Вариант Б: кнопка в пользовательской CommandBar Если форма не использует AutoCommandBar (задан `Autofill=false`, панель скрыта или пуста), кнопку справки можно разместить в произвольной `` группе среди других пользовательских кнопок: ```xml false false ``` Для стандартной команды `Help` не нужно объявлять элемент в секции `` — платформа предоставляет её автоматически. ### Важно - `CommandBarButton` — кнопка должна быть типа CommandBarButton (внутри ``) - Никакого обработчика в Module.bsl не требуется — `Form.StandardCommand.Help` обрабатывается платформой - Платформа сама найдёт `Help.xml` и откроет соответствующую HTML-страницу ## 6. Чек-лист добавления справки 1. Создать `<ИмяОбработки>/Ext/Help.xml` с указанием языка (`ru`) 2. Создать `<ИмяОбработки>/Ext/Help/ru.html` с содержимым справки 3. Убедиться что в `Forms/<ИмяФормы>.xml` есть `false` 4. Добавить кнопку `Form.StandardCommand.Help` в CommandBar или AutoCommandBar формы 5. Собрать EPF — проверить что справка открывается по кнопке