Как добавить справку на форму в 1С: пошаговая инструкция

Работа с формами в 1С:Предприятие 8.3 часто требует добавления контекстной справки — без неё пользователи теряются в интерфейсе, а разработчики получают массу вопросов о функциональности. Справка на форме может быть как простой подсказкой в виде текстового блока, так и сложной системой с гиперссылками, картинками и интерактивными элементами. В этой статье разберём все способы интеграции справки: от базового добавления через конструктор до программного создания с использованием внешних файлов HTML и системы компоновки данных.

Особое внимание уделим типичным ошибкам, которые приводят к тому, что справка не отображается или работает некорректно. Например, многие забывают про настройку прав доступа к справочным материалам или не учитывают особенности клиент-серверного взаимодействия при загрузке внешних файлов. Также рассмотрим, как сделать справку адаптивной для разных режимов работы 1С (тонкий клиент, веб-клиент, мобильное приложение).

Если вы никогда не работали со справочными системами в 1С, начните с первых двух разделов — там описаны простейшие методы. Опытным разработчикам будет полезен раздел про динамическое формирование справки на основе данных формы или прав пользователя.

1. Базовые способы добавления справки через конструктор формы

Начнём с самого простого — встроенных инструментов 1С:Предприятие, которые не требуют написания кода. Конструктор формы позволяет добавить справку двумя способами:

📝 Текстовая подсказка — статический блок текста, который отображается непосредственно на форме. Подходит для кратких инструкций (например, формат заполнения поля).
🔗 Ссылка на внешний файл — привязка к .chm, .html или .pdf-файлу, который открывается в отдельном окне. Удобно для объёмных руководств.
⚙️ Системная справка — использование встроенной системы помощи 1С, где текст хранится в конфигурации и управляется через объект Справка.

Чтобы добавить текстовую подсказку:

Откройте форму в режиме редактирования (двойной клик по форме в дереве меток).
Перейдите на вкладку Элементы и выберите Добавить → Поле надписи.
Разместите элемент на форме и в свойствах укажите текст справки в поле Заголовок.
В свойстве ТипОформления выберите Подсказка или Справка, чтобы визуально отделить блок от остальных элементов.

Для привязки внешнего файла:

Добавьте на форму элемент Поле HTML-документа (вкладка Элементы → Прочие).
В свойстве ИмяФайла укажите путь к файлу справки (например, "Справка\Инструкция.html").
Настройте свойство РежимОтображения — выберите Встроенный (для отображения внутри формы) или Внешний (открытие в отдельном окне).

⚠️ Внимание: При использовании внешних файлов убедитесь, что путь к ним корректен для всех пользователей. Если файл лежит на сервере, укажите относительный путь от каталога базы (например, ".\Справка\manual.chm"). Для веб-клиента внешние файлы должны быть доступны по HTTP/HTTPS.

2. Программное создание справки в модуле формы

Если статических подсказок недостаточно, можно динамически формировать справку прямо в коде. Это актуально, когда текст зависит от данных формы, прав пользователя или других условий. Например, в документе ЗаказПокупателя можно показывать разные инструкции для менеджеров и бухгалтеров.

Базовый пример добавления справки через модуль формы:

Процедура ПриСозданииНаСервере(Отказ, СтандартнаяОбработка)
// Создаём элемент "Поле HTML-документа" программно
ЭлементФормы = Элементы.Добавить("СправкаПоФорме", Тип("ПолеHTMLДокумента"));
ЭлементФормы.ИмяФайла = "Справка\ОбщаяИнструкция.html";

// Динамически формируем текст справки в зависимости от роли пользователя
Если Пользователь.Имя = "Администратор" Тогда
ЭлементФормы.HTMLТело = "<h2>Инструкция для администратора</h2><p>Дополнительные возможности...</p>";
Иначе
ЭлементФормы.HTMLТело = "<h2>Базовая инструкция</h2><p>Описание полей формы...</p>";
КонецЕсли;
КонецПроцедуры

Для более сложных сценариев можно использовать:

📊 Шаблоны HTML — храните заготовки в файлах и подставляйте динамические данные (например, номер документа или имя пользователя).
🔄 Обратный вызов — обновляйте содержимое справки при изменении данных на форме (событие ПриИзменении).
🔒 Контроль доступа — скрывайте или показывайте блоки справки в зависимости от прав (Пользователь.Роли.Найти("Бухгалтер")).

Пример динамического обновления справки при изменении поля:

Процедура КлиентПриИзменении(Элемент)
Если Элемент.Имя = "ПолеЦена" Тогда
ТекстСправки = "<p>Текущая цена: " + Формат(Элементы.Цена.Значение, "ЧДЦ=2") + " руб.</p>";
ТекстСправки = ТекстСправки + "<p>Минимальная цена для этого товара: " + ПолучитьМинимальнуюЦену() + "</p>";
Элементы.СправкаПоФорме.HTMLТело = ТекстСправки;
КонецЕсли;
КонецПроцедуры

⚠️ Внимание: При программном формировании HTML-текста всегда экранируйте специальные символы (например, заменяйте "&" на "&"), чтобы избежать ошибок отображения. Для этого используйте функцию СтрЗначениеВHTML().

Добавить поле HTML-документа на форму|Проверить права доступа к справочным файлам|Экранировать специальные символы в HTML|Обработать событие ПриСозданииНаСервере|Тестировать в разных клиентах (тонкий, веб, мобильный)-->

3. Использование системы компоновки данных для сложных справок

Если справка должна содержать таблицы, диаграммы или данные из базы, удобно использовать систему компоновки данных (СКД). Этот метод позволяет:

📈 Отображать данные в виде таблиц или графиков прямо в справке.
🔍 Фильтровать информацию по параметрам формы (например, показывать справку только по выбранному товару).
📄 Экспортировать справку в Excel или PDF для печати.

Алгоритм создания справки через СКД:

Создайте новую схему компоновки данных (Файл → Новый → Схема компоновки данных).
Добавьте набор данных (например, запрос к справочнику Товары).
Настройте макет вывода: добавьте таблицу с нужными колонками (название, цена, описание).
В модуле формы свяжите схему с элементом ПолеHTMLДокумента:

Процедура ПриОткрытии()
Схема = ПолучитьОбъект("СхемаКомпоновкиДанных.СправкаПоТоварам");
Компоновщик = Новый КомпоновщикМакетаКомпоновкиДанных;
Макет = Компоновщик.Выполнить(Схема, ПараметрыКомпоновки);

// Формируем HTML из макета
HTML = Новый HTMLДокумент;
ПроцессорВывода = Новый ПроцессорВыводаРезультатаКомпоновкиДанныхВHTML;
ПроцессорВывода.УстановитьДокумент(HTML);
ПроцессорВывода.Вывести(Макет);

Элементы.СправкаПоФорме.HTMLТело = HTML.ПолучитьHTML();
КонецПроцедуры

Преимущество этого подхода — автоматическое обновление справки при изменении данных в базе. Например, если в справочник Товары добавили новое поле, его можно сразу отобразить в справке без правки кода.

Способ добавления справки	Сложность реализации	Гибкость	Подходит для
Текстовая подсказка в конструкторе	Низкая	Минимальная	Краткие инструкции, подсказки по полям
Внешний HTML/CHM-файл	Средняя	Высокая (можно использовать CSS, JS)	Объёмные руководства, мультимедиа
Программное формирование в модуле	Средняя	Средняя (зависит от логики)	Динамические подсказки, зависимые от данных
Система компоновки данных	Высокая	Максимальная	Справки с данными из базы, отчёты

4. Добавление контекстной справки (F1) для полей формы

Пользователи 1С привыкли нажимать F1 для вызова справки по текущему полю или форме. Чтобы это работало, нужно настроить контекстную помощь через свойство Справка элемента формы.

Шаги для настройки:

Выделите элемент формы (например, поле ввода Контрагент).
В палитре свойств найдите свойство Справка и нажмите кнопку ....
В открывшемся окне укажите:
- 📖 Текст справки — краткое описание поля (до 255 символов).
- 🔗 Ссылка на раздел — если используете внешнюю систему помощи (например, CHM-файл), укажите идентификатор раздела (например, #Контрагенты).

Повторите для всех элементов, требующих подсказок.

Для программного задания контекстной справки используйте метод УстановитьДействие():

Элементы.Контрагент.Справка = Новый Справка("ИдентификаторРазделаВCHM", "Краткое описание поля");
Элементы.Контрагент.УстановитьДействие("Помощь", Новый Действие("ОткрытьСправку"));

Если контекстная справка не открывается по F1, проверьте:

🔘 Настроено ли действие Помощь для формы (Форма.Действия.Помощь).
📂 Существует ли файл справки по указанному пути (для внешних CHM/HTML).
👤 Достаточно ли прав у пользователя для доступа к справочным материалам.

⚠️ Внимание: В веб-клиенте и мобильном приложении вызов справки по F1 может работать иначе, чем в тонком клиенте. Например, в веб-версии вместо F1 используется иконка ? рядом с полем. Всегда тестируйте справку во всех режимах работы 1С.

ПараметрыФормы = Новый Структура("HTMLТекст", СправкаHTML);
ОткрытьФормуМодально("ОбщаяФорма.ПросмотрHTML", ПараметрыФормы);

-->

5. Работа со справочными файлами: CHM, HTML, PDF

Для объёмных инструкций удобно использовать внешние файлы. Рассмотрим особенности каждого формата:

📚 CHM (Compiled HTML Help) — стандартный формат справки 1С. Поддерживает оглавление, поиск и гиперссылки. Для создания используйте Microsoft HTML Help Workshop или аналоги.
🌐 HTML — универсальный формат, позволяет встраивать видео, интерактивные элементы (JS), адаптироваться под мобильные устройства. Минус — требует навыков вёрстки.
📄 PDF — удобен для печатных инструкций, но не поддерживает гиперссылки внутри 1С (открывается во внешнем просмотрщике).

Чтобы подключить CHM-файл:

Поместите файл в каталог базы (например, .\Справка\Руководство.chm).
В свойстве формы ФайлСправки укажите путь к файлу.
Для вызова конкретного раздела используйте идентификаторы (например, #Раздел1).

Пример структуры CHM-файла для 1С:

Руководство.chm
├── Оглавление.hhk
├── Текстовые файлы
│   ├── Введение.html (идентификатор: #Intro)
│   ├── РаботаСДокументами.html (идентификатор: #Docs)
│   └── Настройки.html (идентификатор: #Settings)
└── Изображения
├── schema1.png
└── schema2.png

Для HTML-справки можно использовать шаблонизатор (например, Jinja2 для Python) или генерировать файлы прямо из 1С:

ТекстHTML = "
<!DOCTYPE html>
<html>
<head><title>Справка по форме</title></head>
<body>
<h1>" + ТекущийДокумент.Вид() + "</h1>
<p>Дата создания: " + Формат(ТекущаяДата(), "ДФ=dd.MM.yyyy") + "</p>
</body>
</html>
";

ЗаписатьТекст(ТекстHTML, "C:\Справка\form_help.html", КодировкаТекста.UTF8);

⚠️ Внимание: При обновлении конфигурации внешние файлы справки (особенно CHM) могут не копироваться автоматически. Всегда включайте их в состав распределяемого решения или используйте механизм ВнешниеОбработки для централизованного хранения.

Как создать CHM-файл без HTML Help Workshop?

Можно использовать бесплатные альтернативы:

1. HelpNDoc (helpndoc.com) — поддерживает экспорт в CHM, PDF, Word.

2. Far HTML — плагин для Far Manager, позволяет компилировать CHM из HTML.

3. Онлайн-сервисы (например, helpauthoringsoftware.com), но они могут иметь ограничения по функционалу.

Для простейшего CHM достаточно создать папку с HTML-файлами и скомпилировать её через командную строку:

hhc проект.hhp

где проект.hhp — файл проекта с описанием структуры справки.

6. Типичные ошибки и их решение

Даже опытные разработчики сталкиваются с проблемами при добавлении справки. Разберём самые распространённые ошибки и способы их исправления:

Ошибка	Причина	Решение
Справка не отображается в веб-клиенте	Путь к файлу указан как локальный (`C:\...`)	Используйте относительные пути (`./Справка/файл.html`) или URL (`http://server/help.html`)
При нажатии F1 ничего не происходит	Не настроено действие `Помощь` для формы	Проверьте свойство `Форма.Действия.Помощь` и метод `УстановитьДействие()`
Текст справки отображается как HTML-теги	Не экранированы специальные символы	Используйте `СтрЗначениеВHTML()` или заменяйте `&` на `&` вручную
CHM-файл не открывается в тонком клиенте	Файл заблокирован системой безопасности Windows	Разархивируйте CHM, проверьте свойства файла (снимите блокировку в `Свойства → Разблокировать`)
Динамическая справка не обновляется	Кэширование HTML в поле формы	Добавьте уникальный параметр в URL (например, `file.html?v=1`) или очищайте кэш программно

Ещё несколько нюансов:

🔄 Обновление справки: Если вы изменили внешний файл (например, help.html), но изменения не отображаются, очистите кэш 1С (Файл → Открыть каталог информационной базы → очистить папку Cache).
🛡️ Безопасность: Избегайте выполнения скриптов в HTML-справке (например, <script>), так как это может быть заблокировано политиками безопасности 1С.
📱 Мобильный клиент: В мобильной версии 1С не все форматы справок поддерживаются. Например, CHM может не открываться — используйте HTML или встраивайте текст прямо в форму.

Критическая ошибка: Если справка содержит конфиденциальные данные (например, инструкции по работе с платежными системами), никогда не храните её в открытом доступе на веб-сервере. Используйте аутентификацию или встраивайте текст прямо в конфигурацию.

💡

Перед выпуском обновления всегда тестируйте справку в трёх режимах: тонкий клиент, веб-клиент и мобильное приложение. Особенно проверяйте пути к файлам и отображение специальных символов.

7. Продвинутые техники: интерактивная справка и аналитика

Для крупных проектов обычной статической справки недостаточно. Рассмотрим продвинутые подходы:

🎯 Контекстная справка по ролям: Показывайте разные блоки справки в зависимости от роли пользователя. Например, бухгалтеру — инструкции по проводкам, а менеджеру — по работе с клиентами.

Если Пользователь.Роли.Найти("Бухгалтер") Тогда
Элементы.Справка.HTMLТело = ПолучитьСправкуДляБухгалтера();
ИначеЕсли Пользователь.Роли.Найти("Менеджер") Тогда
Элементы.Справка.HTMLТело = ПолучитьСправкуДляМенеджера();
КонецЕсли;

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

Процедура ОткрытьСправку(Раздел)
ЗаписьЛога = РегистрыСведений.ЛогСправки.СоздатьМенеджерЗаписи();
ЗаписьЛога.Пользователь = Пользователь.Имя;
ЗаписьЛога.Раздел = Раздел;
ЗаписьЛога.Дата = ТекущаяДата();
ЗаписьЛога.Записать();
КонецПроцедуры

🤖 Чат-бот для справки: Интегрируйте в форму виртуального помощника, который отвечает на вопросы пользователей. Можно использовать DialogFlow или собственную реализацию на основе ключевых слов.

Пример динамического формирования справки на основе данных формы:

Процедура ОбновитьСправку()
Текст = "<h2>Справка по документу №" + Объект.Номер + "</h2>";
Текст = Текст + "<p>Статус: " + Объект.Статус.Представление() + "</p>";

// Добавляем инструкции по текущему статусу
Если Объект.Статус = Перечисления.СтатусыДокумента.Новый Тогда
Текст = Текст + "<h3>Действия для нового документа</h3><ul>";
Текст = Текст + "<li>Заполните реквизиты контрагента</li>";
Текст = Текст + "<li>Укажите список товаров</li></ul>";
ИначеЕсли Объект.Статус = Перечисления.СтатусыДокумента.Согласован Тогда
Текст = Текст + "<h3>Документ согласован</h3><p>Ожидается оплата...</p>";
КонецЕсли;

Элементы.СправкаПоДокументу.HTMLТело = Текст;
КонецПроцедуры

Для интеграции с внешними системами (например, Confluence или Notion) можно использовать REST API. Пример загрузки справки из Confluence:

Функция ПолучитьСправкуИзConfluence(PageID)
Запрос = Новый HTTPЗапрос("https://your-confluence.atlassian.net/wiki/rest/api/content/" + PageID);
Запрос.УстановитьЗаголовок("Authorization", "Basic " + Base64Строка(Пользователь + ":" + Пароль));
Ответ = Новый HTTPСоединение.Получить(Запрос);
Возврат Ответ.ПолучитьТекст();
КонецФункции

FAQ: Частые вопросы по добавлению справки в 1С

Как сделать справку с картинками?

Для отображения изображений в справке:

Поместите картинки в каталог базы (например, .\Справка\Images\).
В HTML-коде справки используйте относительные пути:
```
<img src="Справка/Images/schema.png" alt="Схема документа">
```
Для CHM-файлов добавьте изображения в проект и ссылайтесь на них через идентификаторы.

В веб-клиенте убедитесь, что путь к картинкам доступен по HTTP (например, http://server/1c_base/Spravka/Images/schema.png).

Можно ли добавить видео в справку?

Да, но с оговорками:

В HTML-справке можно встраивать видео через тег <video> или YouTube-iframe.
В CHM видео не поддерживается — только статичные изображения.
В тонком клиенте видео будет проигрываться через внешний плеер (если установлен).

Пример вставки видео с YouTube:

<iframe width="560" height="315"
src="https://www.youtube.com/embed/VIDEO_ID"
frameborder="0" allowfullscreen></iframe>

Как сделать справку на нескольких языках?

Есть два подхода:

Мultiple HTML/CHM файлов: Создайте отдельные файлы для каждого языка (например, help_ru.html, help_en.html) и подгружайте их в зависимости от настроек пользователя:

ТекущийЯзык = Пользователь.Язык;
Если ТекущийЯзык = "en" Тогда
Элементы.Справка.ИмяФайла = "Справка/help_en.html";
Иначе
Элементы.Справка.ИмяФайла = "Справка/help_ru.html";
КонецЕсли;

Динамическая подстановка: Храните переводы в справочнике ПереводыСправки и подставляйте их в шаблон HTML.

Для CHM можно использовать один файл с разделами на разных языках и переключаться между ними по идентификаторам.

Почему справка в CHM не открывается в Windows 10/11?

Проблема связана с блокировкой CHM-файлов системой безопасности. Решения:

Скачайте файл справки на диск, кликните правой кнопкой → Свойства → нажмите Разблокировать (если есть кнопка).
Откройте Панель управления → Параметры браузера → Безопасность → Надежные сайты и добавьте путь к файлу.
Запустите 1С от имени администратора (временное решение).
Используйте альтернативные форматы (HTML, PDF).

Если проблема остаётся, проверьте, не заблокирован ли доступ к CHM групповой политикой (актуально для корпоративных ПК).

Как добавить справку в управляемую форму?

В управляемых формах алгоритм аналогичен обычным, но есть нюансы:

Используйте элемент ПолеHTMLДокумента (вкладка <

Добавляем справку на форму в 1С: от простого к сложному