Tech Doc Help

标记

Writerside支持Markdown和语义标记。使用Markdown,可以直接定义内容的格式,而使用语义标记, 则可以指定每个元素背后的“含义”。

Markdown vs 语义标记

在小型文档项目中,当需要快速编写文档并保持源文件易于阅读时,Markdown 是一个不错的选择。语义标记则更适合大型项目,尤其是在有许多编写人员编写相关文档而外部贡献者不多的情况下。有了 Writerside,可以在 Markdown 主题中将两种方法结合起来。

例如,使用通用的 Markdown 标记来突出显示 UI 控件的名称,如加粗:

**OK**

或者使用语义元素来包装它以用于用户界面控件:

<control>OK</control>

渲染后的输出结果将是一样的: OK。 通常粗体用于突出关键字。要改变使用 Markdown 展示的方式,必须手动检查所有粗体出现的地方,并做出相应的更改。而使用语义标记,只需改变 <control> 元素的呈现方式即可。 在 Markdown 中,可以用编号列表的形式记录一系列步骤,但编号列表在另一种上下文中可能有其他含义:优先级列表或插图中的编号项目。不过,有一种语义 <procedure> 元素带有 <step> 子元素,专门用于记录一系列步骤。

Last modified: 16 March 2024