AnyMath 文档
Notebook

从AnyMath脚本在DOCX中自动生成GOST报告

基于AnyMath脚本,您可以创建带有标题页的Word文档,标题页自动包含文档的所有输出数据,以及文本、代码和脚本执行结果。

示例的描述

在这个项目中,我们演示了如何根据在AnyMath中执行的交互式脚本组织GOST报告的生成。

当工程或科学过程需要定期发布具有固定结构且符合设计要求的相同类型的文档时,您的脚本可以用作数据源(.ngscript),包含文本、计算结果、公式和其他模型元素,并且结果可以根据指定的模板进行格式化(格式 .docx).

生成器执行从一种格式到另一种格式的直播:

*整个文本,标题,代码,图像和图形从脚本进入文档。,
*公式部分翻译-转换器支持特殊符号,比率运算符,度,下标和分数,某些类型的矩阵和方程组。

加载参数并创建初始模板后,我们的算法使用指定文件中的行填充模板。 .ngscript.

目前,不支持公式中的矩阵(公式转换器的限制),多级列表和SVG格式的图形(DOCX的限制)。 文档在MS Word中打开得更好,其他编辑器对公式的语法要求更高。

发电机特性

发生器接受输入:

*一个 .ngscript 或 .ipynb 档案

*有几个文件夹 .ngscript/.ipynb 文件(自动合并为一个文档)

在笔记本电脑内部,处理以下内容:

  1. Markdown-单元格-标题,列表,表格,图像,公式
  2. 代码单元格-源代码(可选),图形输出,DataFrame表,文本输出
  3. 内置配置在TOML格式在任何单元格

以下是文档生成器的一些有用功能:

*标题页具有可自定义字段:教育机构,工作类型,标题,作者,主管,城市,年份。 签名"已完成"/"已接受"也是可配置的。

*自动编号标题的三个级别(1,1.1,1.1.1)。

*图像自动标题"图N-标题"(端到端编号)。

*表自动标签"表N-名称"(端到端编号)。 表格可以来自markdown标记,也可以来自DataFrame的输出。

***章节内自动编号的乳胶公式,支持内联和显示模式,分数,度,指数,根,方程组(cases).

*代码可见性控制:您可以隐藏代码,只留下结果(#CODE_SKIP),或从报告中完全排除单元格(#SKIP).

*将标题链接到表格和图像—当您移动页面时,它们不会脱落。

*页眉和页脚:上面有组织名称(第一页)和信息(后续),下面有城市/年份(第一页)和页码(后续)。

在文本单元格内进行处理:

*文字:
*纯文本与自动编码检测
*粗体(**текст**)
*斜体(*текст*)

  • Инлайн-код (`код`)
    *标题(自动编号的三个级别):

  • # Заголовок →"1头"

  • ## Подзаголовок →"1.1字幕"

  • ### Подподзаголовок →"1.1.1副标题"
    *列表(项目符号):

  • * элемент 或 - элемент
    *图片:

  • ![alt-текст](attachment:имя_файла "Подпись") -嵌入式图像
    *格式:PNG,JPEG(通过base64)
    *自动签名"图N-签名"
    *表格:
    *严格的格式:

    #|
    ||Заголовок1 | Заголовок2||
    ||Ячейка1 | Ячейка2||
    |#
    
  • С подписью (предваряется #TABLE_NAME Название) или без подписи

  • Автоподпись «Таблица N» или «Таблица N — Название»

  • Формулы:

    • Инлайн: $L = \alpha \cdot P^{\beta}$
    • Выключные с автонумерацией: $$L = \alpha \cdot P^{\beta}$$
  • Поддерживаемые элементы LaTeX:

    • Греческие буквы: \alpha, \beta, \gamma, ..., \Omega
    • Операторы: \cdot, \times, \div, \pm, \mp
    • Отношения: \leq, \geq, \neq, \approx, \equiv, \propto, \sim
    • Стрелки: \rightarrow, \leftarrow, \Rightarrow, \Leftarrow, \leftrightarrow
    • Спецсимволы: \infty, \partial, \nabla, \forall, \exists, \in, \notin
    • Множества: \subset, \supset, \cup, \cap
    • Числовые множества: \mathbbR, \mathbbN, \mathbbZ, \mathbbC
    • Тригонометрия: \sin, \cos, \tan, \cot, \arcsin, ...
    • Логарифмы: \log, \ln, \lg, \lim, \max, \min
    • Дроби: \frac{числитель}{знаменатель}, \dfrac
    • Степени: x^{n}, x^n
    • Индексы: x_{n}, x_n
    • Корни: \sqrt{выражение}
    • Точки над символами: \dot{x}, \ddot{x}
    • Системы уравнений: \begin{cases}...\end{cases}
    • Смена шрифта: \mathbb{...}, \mathbf{...}, \mathcal{...}

При помещении в документацию кодовых ячеек поддерживаются:

  • Исходный код:

    • Отображается моноширинным шрифтом на сером фоне (стиль Code)

    • Можно скрыть через #DOCX_CODE_SKIP или no_code=true

  • Результаты выполнения:

    • Изображения (MIME: image/png, image/jpeg):
      • Автоподпись при наличии #DOCX_PLOT_TITLE Название

      • Формат подписи: «Рисунок N — Название»

    • HTML-таблицы (MIME: text/html):
      • Вывод DataFrame через show(stdout, MIME("text/html"), df)

      • Автоподпись при наличии #DOCX_TABLE_NAME: Название

      • Парсинг <thead>, <th>, <tr>, <td>

    • Текстовый вывод (MIME: text/plain, text):
      • Моноширинный шрифт (стиль CodeOutput)
  • Управляющие аннотации (строки с # в коде):

    • #SKIP — полностью исключить ячейку из отчёта
    • #CODE_SKIP — скрыть код, показать вывод
    • #PLOT_TITLE Название — подпись к графику
    • #TABLE_NAME Название — название для DataFrame-таблицы

它支持将输出信息放在外部文件和配置单元格中(在markdown或代码单元格中):

*部分: [template], [title_page], [extra_labels], [content], [custom_fields]

*在代码单元格中,行的前面是 #

*自动从报告中排除

*优先级:函数参数>内置配置>外部配置。汤姆尔

文档模板

首先,生成器加载一个文档模板,它将填充数据。 它可以在命令参数中指定,标准模板名称。: template.docx. 如果指定目录中没有具有所需名称的模板文件,则生成器将创建这样的文件。

您可以下载和编辑此文件并将其上传回AnyMath文件浏览器。 生成器将找到带有标记的字段,如 {{WORK_TITLE}},它将替换所有字段的位置的信息,尽可能地观察文档的样式。

数据来源

报表正文是从文件生成的 .ngscript,其位置通过参数传递给生成器。

至于标题页和页脚,生成器首先从文件中加载文档的输出信息。 config.toml. 这允许我们不使用扩展数量的参数重载报表生成器启动命令,尽管它们也可以指定为附加参数。

指定用于格式化文档的数据的三种方法:

  1. 将以下命令设置为参数 report_compile
  2. 存储在随附文件中 config.toml
  3. 放置配置。其中一个单元格中的toml文件(text作为插页,或code作为注释)

如何运行报表生成器脚本

要在当前文件夹中生成测试文件,请运行单元格:

In [ ]:
include("$(@__DIR__)/report_compiler.jl")
report_compile()
(+) Автоматически выбран файл: report_compiler_article.ngscript
(+) Загружен внешний конфиг из config.toml
(+) Отчёт создан: report.docx

在没有执行结果的情况下创建示例文档。 在您的脚本中,脚本很可能已经包含结果-文本,图形和表格。

您可以使用自己的文件运行生成器。 notebook_test.ngscript:

report_compile("notebook_test.ngscript",output_path="报告。docx")

Или можете сгенерировать целый учебник, указав в качестве аргумента не отчет, а папку с файлами:

report_compile("。/内容",output_path="Учебник。docx")
```</span>

更成功地生成报告:

当放置在最终文档中时,图形和图像不会缩放。 最好立即将它们设置为所需的dpi或像素大小,例如,使用命令 gr(size=(600,400), fmt=:png). Word中不支持交互式图形,因此最好以png格式输出。

~结论

这个小项目展示了如何从AnyMath脚本创建文档生成器。 完成后,您可以自动化工作流程,包括生成模型的快照以及从其他相关文件导入数据。

p.S.:"结论"一词前的"波浪号"图标(~)为我们创建了一个未编号的标题。