下一页 上一页 目录

3. 一个极简文档

在本节中,您将找到符合 linuxdoc dtd 规范的极简文档所需的内容。它旨在提供初步了解。如果您已经了解这些原则,请跳过本节。

3.1 逐步进行

创建美观的 linuxdoc 文档并将其映射到您需要的形式,您必须执行以下步骤:

3.2 启动文档

我们从一个简单的文档开始(行首的数字和冒号用于解释,请勿输入!)


1: <!doctype linuxdoc system>
2: <notes>
3: <title>A Small Linuxdoc Example</title>
4: <p>Hello <em>world</em>.</p>
5: <p><bf>Here</bf> we are.</p>
6: </notes>

现在我们来看看单行

  1. 像所有符合 SGML 规范的文档一样,linuxdoc 文档必须以序言开头。 如果您愿意,您可以将其视为必要的魔法,或者您可以尝试查找有关 SGML 的更多信息。 序言指示 SGML 解析器应该使用哪个 dtd(文档类型定义)来检查文档的语法。
  2. 打开文档类:您必须决定要编写哪种类型的文档。 有关文档类的详细描述,请参见 文档类 部分。 还将在那里解释必要的标头信息,这些信息取决于文档类。 在我们的例子中,我们放置一个 <notes> 标签,形成一个注释,指示一个简单的非结构化文档。
  3. 即使是可选的,为文档提供标题也是一个好主意。 这是通过 <title> 标签完成的。
  4. <p> 标签标记的段落,包含单词 world,该单词通过 <em> 标签进行行内强调
  5. 另一个完全标记的段落,另一个单词通过 <bf> 标签进行行内粗体
  6. 这里我们关闭打开的文档类标签。

相同的示例可以写得更短一些,方法是省略解析器自动放置的标签,并使用缩短的标签


1: <!doctype linuxdoc system>
2: <notes>
3: <title>A Small Linuxdoc Example
4: <p>Hello <em/world/.
5:
6: <bf/Here/ we are.
7: </notes>

现在我们再次查看单行

  1. 序言
  2. 文档类(也未更改)。
  3. 标题。 它没有关闭,因为下一行中的 p 标签隐式地关闭了它。
  4. 段落隐式地关闭了标题强调标签以简短形式表示。 只有当您的标记文本不包含文字 / 时,才能使用简短表示法。 段落在此行中未显式关闭。
  5. 此处的空行是您不需要关闭上一个段落且不需要打开下一个段落的原因。 空行被解释为当前段落的结尾和新段落的开始。
  6. 另一个段落(未直接打开),带有另一个简短的行内标签。
  7. 关闭打开的文档类标签,该标签也隐式地关闭了仍然打开的段落。

也许现在更清楚了,您必须如何使用标签。


下一页 上一页 目录