Меню
[I128-2274] Экспорт страницы помощи в DOCX
НАЧАЛО >> Оглавление >> Общее описание >> История изменений >> Что нового в проекте I128 >> Версия 2026.2 >> [I128-2274] Экспорт страницы помощи в DOCX📄 Скачать в DOCX
| Тип | Версия | Статус | Приоритет | Исполнитель |
|---|---|---|---|---|
| ⚙️ Новые возможности | 2026.2 | 🔘 Завершено |
Средний | Ilya Mikhaylenko |
Компоненты: ИРБИС 128. Модуль Help - Помощь
Завершено: 26.03.2026 15:25
Новый функционал — экспорт в DOCX
Добавлена возможность выгрузки разделов справочной системы в формат DOCX. Эта функциональность интегрирована в модуль Help и использует Pandoc (через модуль FT) для конвертации.
- Добавлена страница Help/DownloadDocx для преобразования Markdown-документации в формат Word (DOCX) "на лету" с использованием Pandoc (модуль
FT). - На страницы просмотра справки (Help/Show) добавлена кнопка "Скачать в DOCX" (отображается, если активен модуль
FT). - Учтен перенос вложенных (include) документов, генерация разрывов страниц и поддержка пользовательского шаблона оформления (reference.docx).
Настройки администратора для модуля Help:
- В
api.phpвключено использование конфигурационного редактора (*UseEditorAsConfig = true) и отображение модуля в панели администратора (*hideAdminPanel = false). - В
AdminModuleVariablesInit.incдобавлены настройки генерации DOCX: подключение шаблона стилей, переключатели создания титульного листа и оглавления, настройка глубины оглавления. Убраны заглушки тестовых параметров.
Расширение синтаксиса Markdown:
- Добавлены новые макросы:
- ![Рисунок 1 -](): для вставки изображения с подписью и автоматической нумерацией - более удобный вариант чем прописывание изображений через синтаксис markdown с ручным определением метки изображения.
Приведенный выше пример создаст все необходимы markdown конструкции для вставки изображения с подписью и запомнит метку изображения userguide_5 на которую в дальнейшем можно ссылаться ав тексте через макрос {&l
-
и {&blockwarn ...}: для создания информационных блоков и предупреждений. Это inline-вариант оформления блоков @@@warn и @@@info
...
Подробности изменений в коде препроцессора, парсера и HTML-рендерера:
- Огромный монолитный класс i128HelpHelpMd был разбит на более мелкие, переиспользуемые компоненты для улучшения читаемости и поддержки: Логика обработки макросов ({&...}) вынесена в новый класс i128Help_Preprocessor со своей системой команд и резолвером путей. Логика парсинга самого Markdown вынесена в класс i128Help_MarkdownParser, который теперь работает с обработчиками для каждого типа блока (заголовки, списки, таблицы и т.д.). * Отрисовка HTML из разобранной структуры передана классу i128HelpMarkdownParser*HtmlRenderer.
- Общий принцип работы (Препроцессор => Парсер markdown в AST => Рендеринг в HTML) остался неизменным
-Добавлена возможность выгрузки разделов справочной системы в формат DOCX. Эта функциональность интегрирована в модуль Help и использует Pandoc (через модуль FT) для конвертации.
- Добавлена страница Help/DownloadDocx для преобразования Markdown-документации в формат Word (DOCX) "на лету" с использованием Pandoc (модуль
FT). - На страницы просмотра справки (Help/Show) добавлена кнопка "Скачать в DOCX" (отображается, если активен модуль
FT). - Учтен перенос вложенных (include) документов, генерация разрывов страниц и поддержка пользовательского шаблона оформления (reference.docx).
Настройки администратора для модуля Help:
- В
api.phpвключено использование конфигурационного редактора (*UseEditorAsConfig = true) и отображение модуля в панели администратора (*hideAdminPanel = false). - В
AdminModuleVariablesInit.incдобавлены настройки генерации DOCX: подключение шаблона стилей, переключатели создания титульного листа и оглавления, настройка глубины оглавления. Убраны заглушки тестовых параметров.
Расширение синтаксиса Markdown:
- Добавлены новые макросы:
- ![Рисунок 1 -](): для вставки изображения с подписью и автоматической нумерацией - более удобный вариант чем прописывание изображений через синтаксис markdown с ручным определением метки изображения.
Приведенный выше пример создаст все необходимы markdown конструкции для вставки изображения с подписью и запомнит метку изображения userguide_5 на которую в дальнейшем можно ссылаться ав тексте через макрос {&l
-
и {&blockwarn ...}: для создания информационных блоков и предупреждений. Это inline-вариант оформления блоков @@@warn и @@@info...
Подробности изменений в коде препроцессора, парсера и HTML-рендерера:
- Огромный монолитный класс i128HelpHelpMd был разбит на более мелкие, переиспользуемые компоненты для улучшения читаемости и поддержки: Логика обработки макросов ({&...}) вынесена в новый класс i128Help_Preprocessor со своей системой команд и резолвером путей. Логика парсинга самого Markdown вынесена в класс i128Help_MarkdownParser, который теперь работает с обработчиками для каждого типа блока (заголовки, списки, таблицы и т.д.). * Отрисовка HTML из разобранной структуры передана классу i128HelpMarkdownParser*HtmlRenderer.
- Общий принцип работы (Препроцессор => Парсер markdown в AST => Рендеринг в HTML) остался неизменным
1. Связанные задачи
1.1. 🔗 blocks: I128-2273
[I128-2273] Интеграция с Pandoc Статус:
Завершено| Автор: Ilya Mikhaylenko1.2. 🔗 Соответствует задача: I128-2277
[I128-2277] Экспорт страницы помощи в DOCX Статус:
Открытая задача| Автор: Ilya Mikhaylenko