← 文章 / 编程开发
idratherbewriting 20天前 · 2026-11-02 10:06:26 · 14 阅读

关于Nytril——一种用于构建文档的编程语言——的问答,嘉宾肖恩·麦克赖特(Shawn McCreight)

注:本文由 Nytril 赞助。

Shawn McCreight
Shawn McCreight 是 Nytril 的创始人兼 CEO,2018 年在华盛顿州 Gig Harbor 创立该公司。此前他于 1997 年创立 Guidance Software,担任董事长兼 CTO,并于 2006 年推动公司上市。OpenText 于 2017 年收购了 Guidance Software。Shawn 拥有 UC Berkeley 物理学学士学位。

Nytril 是一款围绕自有编程语言构建的文档编写工具。Nytril 创始人兼 CEO、来自华盛顿州 Gig Harbor 的 Shawn McCreight 在 10 月联系了我,希望向本站读者介绍这款产品。他在邮件中这样描述它:“你可以把它理解为 Excel+Word,或者 Markdown+Python。”文字、数据、单位、查询结果、计算和样式都存在于同一份源代码中,运行这些代码即可生成文档。

以编程方式撰写文档是什么体验?作者需要掌握多少编码知识?这类工具与 DITA、MadCap Flare 以及静态站点生成器相比处于什么位置?我把这 10 个问题发给了 Shawn。 Shawn 的回答方式颇为独特。他没有通过邮件或 Word 文档回复,而是编写了一个 Nytril 程序,将我的提问和他的回答作为数据存储,再从中生成文档。该项目一共产出了 11 份文档:一份是完整的问答集,另外 10 份则是独立的单题文档,用于演示内容复用。他直接从 Nytril 将完整问答导出为 PDF、DOCX 和 HTML,并连同源文件一起发送,以便读者评估输出质量并阅读生成这些内容的代码。
The Nytril IDE with Nytril source code on the left and a rendered multiplication table on the right
左侧是源代码,右侧是渲染后的文档,这是 Nytril IDE 的界面。图中示例来自 Nytril 网站,两个嵌套的 foreach 循环生成了乘法表,第 20 行的 size 变量用于设定其维度。(截图来自 nytril.com。)

问答集的原始格式文件

以下是 Shawn 直接通过 Nytril 导出并发来的文件:

  • PDF 版本(19 页,935 KB)。第 1 页为包含目录的标题页,第 2 至 8 页为问答内容,第 9 至 19 页打印了生成这些内容所需的完整源代码。
  • Word (DOCX) 版本(61 KB)。
  • HTML 版本(420 KB)。该导出将每一页绘制为 SVG 图像,因此在浏览器中查看时,版式与 PDF 保持一致。
  • Nytril 源文件(727 行,29 KB)。这是纯 UTF-8 文本。如果你安装了 Nytril,就可以在 IDE 里打开它,自己生成全部 11 份文档。

下面是问答在 PDF 中第一页的效果:

由 Nytril 生成的问答第一页。标题样式、问题底纹框和答案文本都在源代码中定义。

本文其余部分以网页形式呈现这份问答。答案是 Shawn 在源文件中写的原文,章节标题就是他给每个问题起的简短标题。问答之后,我附上了一些源代码片段并说明各部分的作用,最后附上完整源码。

1. Nytril 解决什么问题?

Tom 提问: 你为谁开发了 Nytril,想解决什么问题?之前用的是什么工具,它们有哪些不足?

我们团队几十年来一直从事软件、用户手册和培训课程的开发。早期,我们的材料是用 Word 和 RoboHelp 制作的,加上一些 CI 自动化。

核心问题在于无法分离和复用数据、格式、语言和图片。我们希望在不同的版本和类型的面向用户的材料之间复用内容,但所有信息都“困”在文档里。语言翻译只能在文档层面进行,成本高昂,也严重阻碍了翻译后发现问题时的修正。

我们开发 Nytril 就是为了优雅、强大、完整地解决这些问题。它面向希望构建和管理知识库,并据此生成多种定制形式和多种语言文档的技术写作者,适合那些希望对数据、图形、样式乃至整个文档创建流程拥有完全控制权的人。

2. 从一份数据生成多份文档的示例

Tom 问: 你把 Nytril 描述为“Excel 加 Word”或“Markdown 加 Python”。能否结合具体例子说明,比如如何用同一个源数据生成 100 份单页简报和产品目录?源数据长什么样?当产品规格变更时又会发生什么?

为了说明其工作原理,本文档是用 Nytril 编写的。问题和答案在此文档中同时展示,但另有 10 份文档各自单独展示一个问题,以体现内容复用。请查看本文档末尾展示的源代码,了解其具体呈现方式。

如果单独运行这段代码,在 Nytril 中执行后,你会看到此文档出现在屏幕上。在 IDE 菜单中,你可以选择查看其余 10 份文档中的任何一份。如果代码中的文本或格式发生更改,所有 11 份文档会自动更新。正是在这个意义上,Nytril 类似于电子表格:更改数据和/或代码后,立即更新即可看到结果。

我们编写 Nytril 代码的步骤如下:

  1. 定义一个类,用于存储每个条目的内容(即问题和答案)。
  2. 使用“特殊粘贴”功能将问题文本导入 Nytril,该功能会将剪贴板中的文本转换为 Nytril 源代码。
  3. 编写循环以遍历并格式化每个问题,从而创建主文档。
  4. 再次遍历每个问题,创建 10 份独立的问题文档。
  5. 添加一条语句,将源代码本身反映在文档中。

一个大规模的实际应用案例是 Nytril 为 Sparling Instruments 构建的网站,其中包含数十份由自定义数据结构驱动的规格表。这些表格既可以独立存在,也可以结合目录合并为单一文档以形成产品目录。如果任何数据、样式或文本发生变化,所有文档集合可以在几秒钟内重新构建并本地及在线发布。

3. Nytril 能做什么,而其他语言不能?

Tom 提问:很多技术写作者已经在用 DITA、MadCap Flare 或静态站点生成器这类工具做单源发布,配合变量、内容引用和条件文本。Nytril 能做哪些这些工具做不到的事?什么情况下你会建议别人留在现有工具上?

Nytril 不把结构化数据存在 XML 或专有数据库里再从中生成文档,而是把文档本身当作一个可执行的程序,在运行过程中构建内容。进入文档的一切内容对写作者完全可见,内置调试器还能让你逐行追踪代码运行过程。

  • 没有数据录入界面。
  • 数据和文本都直接用源代码表达。
  • 所有文件都保存在每位写作者自己的机器上。
  • 写作者可以离线编辑,之后再合并。
  • 没有云端内容管理系统,但可以用 Git 跟踪变更。
  • 从数据、格式化到文档导出,每个内容层级都拥有完整的编程能力。

Nytril 的工作方式和一个软件项目一样:你把数据、文本、变量和定义都组织在源代码里,并用版本控制管理。图片文件、数据库和 Web API 中的数据都可以通过代码轻松访问并加入内容。由于 Nytril 是一门完整的编程语言,计算和逻辑可以与内容自由混排,无需“跳出”去用另一门语言或语法。比如在 Mortgage Calculator 程序中,Nytril 在一个小程序里就完成了收集用户输入、计算数字和排版文档的全部工作。

尽管功能强大,Nytril 与其他方案毕竟不同,和任何系统一样存在学习曲线。如果不想承担切换成本,或者用不到这些额外能力,那就继续用现有的工具。

4. 入门

汤姆提问: Nytril 是一种具备 C# 风格语法的编程语言。普通作者需要掌握多少编程知识?对于只写过 Markdown 的人来说,第一周的学习体验是怎样的?

和 Markdown 一样,Nytril 中的所有内容和格式都用纯 UTF8 文本描述。它与 Markdown 最明显的区别在于:字面字符串需要加引号。而变量、函数和操作符则保持原始形式,空格和换行符也不起作用。像 Markdown、LaTeX、Typst 和 HTML 这类标记语言,默认模式是纯文本,一旦涉及格式、逻辑或其他操作,就必须使用“转义序列”。

客观地说,与包含相同文本的 Nytril 代码相比,普通的 Markdown 文档确实显得更简洁。但一旦作者开始插入字段和格式、添加外部数据、查询、图片和图形,Markdown 的方法便失去了原有的简洁与优雅。在复杂的数据驱动文档领域,Nytril 的源代码表达反而最为简洁。

值得注意的是,Nytril 中没有“Write”或“Print”语句。如果你想在文档中放入字符串或变量的值,只需直接输入名称即可,随后……

原始来源: idratherbewriting

评论 (0)