← На главную

Справочная информация объектов метаданных (документов, справочников, отчетов) в платформе 1С представляет собой встроенный HTML-документ. При подготовке пользовательской документации часто требуется дополнить текстовое описание наглядными графическими схемами или поясняющими иллюстрациями. Разберем подробно, какими штатными средствами конфигуратора и альтернативными механизмами платформы решается эта задача.

Штатная вставка через меню конфигуратора

Рассмотрим по шагам стандартный алгоритм добавления графических данных во встроенную справку любого объекта метаданных:

1. Откроем дерево метаданных в конфигураторе и выберем нужный объект (например, Документ или Справочник).
2. Откроем окно редактирования справочной информации объекта (через контекстное меню или свойства объекта).
3. Обратим внимание на главное командное меню конфигуратора: при активном окне редактора справки в верхнем меню появляется специализированный пункт Элементы.
4. Перейдем в меню Элементы и выберем подпункт Картинка.
5. В открывшемся диалоговом окне перейдем к полю Адрес и нажмем кнопку выбора для указания исходного файла на диске.
6. Подтвердим выбор, после чего платформа автоматически преобразует и упакует графический ресурс во внутреннее хранилище справки конфигурации.

Использование горячих клавиш и буфера обмена

Проанализируем более быстрый способ интеграции графических данных без вызова диалоговых окон. Редактор справки поддерживает прямую вставку из буфера обмена:

1. Скопируем подготовленные данные в буфер обмена операционной системы (сочетанием клавиш Ctrl+C).
2. Установим курсор в нужную позицию редактора справки и выполним вставку сочетанием клавиш Ctrl+V.
3. Платформа самостоятельно создаст необходимую разметку и поместит объект во внутреннюю структуру справки.

Хранение и форматы графических данных в справке

Выясним технические особенности обработки графики платформой 1С:Предприятие:

1. Поддерживаемые форматы: Редактор справки поддерживает популярные растровые форматы (PNG, JPEG, GIF, BMP), а также векторный формат SVG в современных версиях платформы.
2. Внутренняя адресация: Платформа использует внутренний протокол адресации ресурсов вида v8help://. Это гарантирует целостность ссылок внутри конфигурации при переносе между базами данных.
3. Внедрение через Data URI (Base64): При редактировании справки в режиме прямого HTML-кода можно использовать внедрение данных непосредственно в разметку через Base64-строку в атрибуте src, что полностью исключает зависимость от внешних файлов.

Рекомендации по оптимизации и альтернативные подходы

Посмотрим на практические нюансы и ограничения, с которыми можно столкнуться при оформлении документации:

1. Контроль размера конфигурации: Массовое внедрение тяжелых графических файлов в справку объектов увеличивает общий размер файла конфигурации (.cf) и может замедлять процедуру сравнения и объединения. Рекомендуется предварительно оптимизировать и сжимать файлы перед добавлением.
2. Поле HTML-документа на форме: Если требуется динамическое обновление документации без изменения конфигурации, на управляемой форме можно расположить элемент ПолеHTMLДокумента и загружать инструкции из внешних веб-источников или общих макетов типа ДвоичныеДанные.
3. Поле форматированного документа: Для интерактивного ведения подсказок силами пользователей непосредственно в режиме «1С:Предприятие» можно использовать реквизит с типом ФорматированныйДокумент.