Отчет по работе из скрипта Engee
Генерация отчетов в формате DOCX
На основе скриптов Engee можно создавать документы Word с титульным листом, в которые автоматически попадают все выходные данные документа, а также текст, код и результаты выполнения скриптов.
Описание примера
В этом проекте мы демонстрируем, как организовать экспорт некоторого ограниченного перечня информации из скрипта Engee (интерактивный скрипт .ngscript) в файл .docx. Поскольку мы будем заниматься прямой трансляцией из одного формата в другой, наш транслятор будет иметь некоторые ограничения, в частности:
- переводится весь текст, код, изображения и графики,
- частично переводятся формулы, а именно, транслятор поддерживает специальные знаки, степени, нижние индексы и дроби,
- все списки становятся маркированными списками.
По ходу работы скрипт первым делом загружает выходную информацию документа из файла config.toml. Это позволяет нам не перегружать команду запуска генератора отчётм большим количеством аргументов, хотя их все тоже можно указать в качестве дополнительных параметров. Дальше транслятор создаёт файл template.docx (если его ещё нет в текущей директории). Его вы можете скачать и отредактировать удобным для вас образом.
После загрузки параметров и создания исходного шаблона, наш алгоритм наполняет шаблон строками из указанного файла .ngscript.
Отчет можно сгенерировать двумя командами:
include("scripts/generate_report.jl")
generate_report("notebook_test.ngscript")
Всё содержимое транслятора вы можете модифицировать под ваши нужды, равно как и шаблон template.docx.
Заключение
Этот небольшой проект показывает, как вы можете создавать генераторы документации из скриптов Engee. Доработав его вы можете автоматизировать документооборот, включающий генерацию снимков моделей и импорт данных из дрвгих сопутствующих файлов.