<!element linuxdoc o o (sect | chapt | article | report | book | letter | telefax | slides | notes | manpage ) >
这是描述文档的总体类别,因此自然地(撇开文档类型定义不谈)它必须是包围整个文档的第一个标签。一些标签,即 sect
和 chapt
(参见分节标签部分),如果单独使用就没有任何意义,尽管它们被包含在更完整的分类文档中,因此我们稍后将它们描述为其他文档类的一部分。首先确定最适合您要编写的文档类型的顶级文档类。
要查找文档类的详细描述,请参见表 文档类。
章节 | 类标签 |
Article 标签 | <atricle> |
Report 标签 | <report> |
Book 标签 | <book> |
Letter 标签 | <letter> |
Telefax 标签 | <telefax> |
Slides 标签 | <slides> |
Notes 标签 | <notes> |
Manpage 标签 | <manpage>
|
对我而言,article 类是最重要的一个。这就是为什么它首先被描述并且最详细的原因。
<!element article - - (titlepag, header?, toc?, lof?, lot?, p*, sect*, (appendix, sect+)?, biblio?) +(footnote)> <!attlist article opts cdata "null">
options 属性 (opts
) 接受一个逗号分隔的列表,其中包含要在文档中包含的不同样式 (LaTeX .sty
) 表。
<!element titlepag o o (title, author, date?, abstract?)>
titlepag
) 在您启动文档类后会隐式放置。您无需显式编写它。无论如何,您必须注意它是强制性标签。它的目的是描述标题页的布局和元素。
<!element title - o (%inline, subtitle?) +(newline)>
<title>
标签注明。您不需要关闭它。标题可能包含由 <subtitle>
标签开始的副标题。如果您查看本文档的标题页,您会发现它是从以下标签映射而来的
<title>Linuxdoc Reference <subtitle>A introduction to the linuxdoc dtd
<!element author - o (name, thanks?, inst?, (and, name, thanks?, inst?)*)>
<author>
标签。如果您不注明 name
标签,则会隐式放置。作者还具有可选项目,可以在 author
标签内标记。如果您想感谢任何人(可能是提供有用信息的人),您将其放置在 <thanks>
标签内。接下来,如果您的写作是以机构工作人员的身份完成的,请将其放置在 <inst>
标签内。
<and>
标签再次开始整个故事,就好像已经启动了第二个 author
标签一样。显然,这个标签是为合著者准备的。
如果您想用日期标记您的文档,可以使用 <date>
标签来做到这一点。
不会检查您是否真的在此处放置了有效日期,但请不要滥用它。
此标签旨在用于文档的摘要描述。不要将 <abstract>
标签与很可能放置在文档第一节中的引言混淆(参见分节部分)。
<!element header - - (lhead, rhead) > <!element lhead - o (%inline)> <!element rhead - o (%inline)>
<header>
标签指定应在每页顶部打印的内容。它由左侧标题,即 <lhead>
和右侧标题,即 <rhead>
组成。如果使用了标题,则这两个元素都是必需的,但任何一个都可以留空,以便可以轻松实现仅具有左侧或右侧标题的效果。正如我们将看到的,可以在标题页之后给出初始标题。之后,可以为每个新章节或部分给出新标题。页面上打印的标题是在当前页面末尾生效的标题。因此,标题将是页面上最后一个开始的部分的标题。
如果您放置 <toc>
标签,将通过查找节标题并添加引用来生成目录。
在超链接文档中,这可能是超链接,在 LaTeX 文档中,您将看到页码。仅包含
sect3
的主要部分。
如果您放置 <lof>
标签,将通过查找图表的标题并添加引用来生成图表目录。
如果您放置 <lot>
标签,将通过查找表格的标题并添加引用来生成表格目录。
您可以在此处放置各个部分,根据分节部分。没有 body tag。正文从第一个章节、部分或段落开始。
在文章的末尾,您可以放置 <appendix>
标签
真的你不应该想到有人(例如医学博士在这里用刀捅你的肚子。,它开始一个附加部分的区域。
appendix
标签意味着对以下节标签使用不同的节编号类型。
它旨在收集您在文档中使用的所有 <cites>
和 <ncites>
。<biblio>
标签将被替换为根据文档的映射类型的参考书目,可能是超链接,可能是节号,或任何可能有用的东西。
到目前为止,我还没有能够创建一个 .bbl
文件,所以我无法验证。
脚注可以放置在文档的任何位置。在文档中放置 <footnote>
标签的确切位置应该是呈现标记文本引用的位置。它应该用于附加信息,这些信息对于理解文档的主要目的不是必需的,但可能有用、有趣或有趣。
然而,即使你尝试,最后一种情况也并非总是如此。文章中的任何位置。
<!element report - - (titlepag, header?, toc?, lof?, lot?, p*, chapt*, (appendix, chapt+)?, biblio?) +(footnote)>
<report>
标签分类的文档中,顶层由 <chapt>
标签分组(参见分节)。其余结构与 article 类 Article 标签相同。
<!element book - - (titlepag, header?, toc?, lof?, lot?, p*, chapt*, (appendix, chapt+)?, biblio?) +(footnote) >
<book>
标签对文档进行分类,则任何在那里有效的内容也有效。
<!entity % addr "(address?, email?, phone?, fax?)" > <!element letter - - (from, %addr, to, %addr, cc?, subject?, sref?, rref?, rdate?, opening, p+, closing, encl?, ps?)>
letter 文档类的目的也应该是不言自明的。如果您想写信,请放置 <letter>
标签。
信件的标签在表 信件中的标签中描述
标签 | 强制性 | 是什么 |
发件人 | 是 | 发件人 |
地址 | 否 | 发件人地址 |
电子邮件 | 否 | 发件人电子邮件 |
电话 | 否 | 发件人电话 |
传真 | 否 | 发件人传真 |
收件人 | 是 | 收件人 |
地址 | 否 | 收件人地址 |
电子邮件 | 否 | 收件人电子邮件 |
电话 | 否 | 收件人电话 |
传真 | 否 | 收件人传真 |
抄送 | 否 | 抄送 |
主题 | 否 | 信件主题 |
发件人参考 | 否 | 发件人参考 |
收件人参考 | 否 | 收件人参考 |
接收日期 | 否 | 接收日期? |
开头 | 是 | 开头 |
段落 | 是 | 参见 段落 |
结尾 | 是 | 结尾 |
附件 | 否 | 附件 |
附言 | 否 | 附言 |
<!element telefax - - (from, %addr, to, address, email?, phone?, fax, cc?, subject?, opening, p+, closing, ps?)>
<telefax>
标签时,收件人的 <fax>
标签变为强制性。原因应该很明显。
<!element slides - - (slide*) >
<slides>
标签分类的文档结构非常简单。它包含由 <slide>
标签启动的单个幻灯片。仅此而已。如果未显式写入,则第一个幻灯片将隐式启动。
<!element slide - o (title?, p+) >
<slide>
标签仅在 slides 文档类中允许。一个幻灯片可能包含一个标题(参见标题标签部分)和一个或多个段落(参见段落部分)。仅此而已。
<!element notes - - (title?, p+) >
<notes>
标签对文档进行分类后,仅允许标题(参见标题标签部分)和一个或多个段落(参见段落部分)。
<!element manpage - - (sect1*) -(sect2 | f | %mathpar | figure | tabular | table | %xref | %thrm )>
man
程序的需求。在由 <manpage>
标签分类的文档中,顶层节标签是 sect1
标签(参见分节部分),以便于将手册页粘贴到 article 或 book 文档类中。此处与正常分节的例外是,只允许一个子节级别 (sect2
)。