下一页 上一页 目录

4. 文档类


<!element linuxdoc o o 
        (sect | chapt | article | report | 
         book | letter | telefax | slides | notes | manpage ) >

这是描述文档的总体类别,因此自然地(撇开文档类型定义不谈)它必须是包围整个文档的第一个标签。一些标签,即 sectchapt(参见分节标签部分),如果单独使用就没有任何意义,尽管它们被包含在更完整的分类文档中,因此我们稍后将它们描述为其他文档类的一部分。首先确定最适合您要编写的文档类型的顶级文档类。

要查找文档类的详细描述,请参见表 文档类


章节
类标签
Article 标签<atricle>
Report 标签<report>
Book 标签<book>
Letter 标签<letter>
Telefax 标签<telefax>
Slides 标签<slides>
Notes 标签<notes>
Manpage 标签<manpage>
文档类

对我而言,article 类是最重要的一个。这就是为什么它首先被描述并且最详细的原因。

4.1 Article 标签


<!element article - -
        (titlepag, header?,
         toc?, lof?, lot?, p*, sect*,
         (appendix, sect+)?, biblio?) +(footnote)>

<!attlist article
        opts cdata "null">

您可以看到 article 需要包含一些标签。它们将在后面进行解释。

options 属性 (opts) 接受一个逗号分隔的列表,其中包含要在文档中包含的不同样式 (LaTeX .sty) 表。

Titlepage 标签


<!element titlepag o o (title, author, date?, abstract?)>

Titlepage 标签 (titlepag) 在您启动文档类后会隐式放置。您无需显式编写它。无论如何,您必须注意它是强制性标签。它的目的是描述标题页的布局和元素。

Title 标签


<!element title - o (%inline, subtitle?) +(newline)>

每个拥有标题页的文档类当然需要一个标题,该标题使用 <title> 标签注明。您不需要关闭它。标题可能包含由 <subtitle> 标签开始的副标题

如果您查看本文档的标题页,您会发现它是从以下标签映射而来的

<title>Linuxdoc Reference
<subtitle>A introduction to the linuxdoc dtd

Author 标签


<!element author - o (name, thanks?, inst?,
                        (and, name, thanks?, inst?)*)>

通常您在此处放置(您的)姓名。人们应该知道谁编写了文档,因此您放置 <author> 标签。如果您不注明 name 标签,则会隐式放置。作者还具有可选项目,可以在 author 标签内标记。

如果您想感谢任何人(可能是提供有用信息的人),您将其放置在 <thanks> 标签内。接下来,如果您的写作是以机构工作人员的身份完成的,请将其放置在 <inst> 标签内。

<and> 标签再次开始整个故事,就好像已经启动了第二个 author 标签一样。显然,这个标签是为合著者准备的。

Date 标签

如果您想用日期标记您的文档,可以使用 <date> 标签来做到这一点。

不会检查您是否真的在此处放置了有效日期,但请不要滥用它。

Abstract 标签

此标签旨在用于文档的摘要描述。不要将 <abstract> 标签与很可能放置在文档第一中的引言混淆(参见分节部分)。

Header 标签


<!element header - - (lhead, rhead) >
<!element lhead - o (%inline)>
<!element rhead - o (%inline)>

<header> 标签指定应在每页顶部打印的内容。它由左侧标题,即 <lhead>右侧标题,即 <rhead> 组成。如果使用了标题,则这两个元素都是必需的,但任何一个都可以留空,以便可以轻松实现仅具有左侧或右侧标题的效果。

正如我们将看到的,可以在标题页之后给出初始标题。之后,可以为每个新章节或部分给出新标题。页面上打印的标题是在当前页面末尾生效的标题。因此,标题将是页面上最后一个开始的部分的标题。

目录标签

如果您放置 <toc> 标签,将通过查找节标题并添加引用来生成目录

在超链接文档中,这可能是超链接,在 LaTeX 文档中,您将看到页码。
仅包含 sect3 的主要部分。

图表目录标签

如果您放置 <lof> 标签,将通过查找图表的标题并添加引用来生成图表目录

表格目录标签

如果您放置 <lot> 标签,将通过查找表格的标题并添加引用来生成表格目录

正文

您可以在此处放置各个部分,根据分节部分。没有 body tag。正文从第一个章节部分段落开始。

Appendix 标签

在文章的末尾,您可以放置 <appendix> 标签

真的你不应该想到有人(例如医学博士在这里用刀捅你的肚子。
,它开始一个附加部分的区域。appendix 标签意味着对以下节标签使用不同的节编号类型。

Bibliography 标签

它旨在收集您在文档中使用的所有 <cites><ncites><biblio> 标签将被替换为根据文档的映射类型的参考书目,可能是超链接,可能是节号,或任何可能有用的东西。

到目前为止,我还没有能够创建一个 .bbl 文件,所以我无法验证。

Footnote 标签

脚注可以放置在文档的任何位置。在文档中放置 <footnote> 标签的确切位置应该是呈现标记文本引用的位置。它应该用于附加信息,这些信息对于理解文档的主要目的不是必需的,但可能有用、有趣或有趣。

然而,即使你尝试,最后一种情况也并非总是如此。
文章中的任何位置。

4.2 Report 标签


<!element report - -
        (titlepag, header?, toc?, lof?, lot?, p*,
         chapt*, (appendix, chapt+)?, biblio?) +(footnote)>

report 是一种文档类,采用面向章节的方法。因此,在由 <report> 标签分类的文档中,顶层由 <chapt> 标签分组(参见分节)。其余结构与 articleArticle 标签相同。

4.3 Book 标签


<!element book  - -
        (titlepag, header?, toc?, lof?, lot?, p*, chapt*,
         (appendix, chapt+)?, biblio?) +(footnote) >

您会注意到 book 元素与 report Report 标签相同。因此,如果您使用 <book> 标签对文档进行分类,则任何在那里有效的内容也有效。

4.4 Letter 标签


<!entity  % addr "(address?, email?, phone?, fax?)" >

<!element letter - -
        (from, %addr, to, %addr, cc?, subject?, sref?, rref?,
         rdate?, opening, p+, closing, encl?, ps?)>

letter 文档类的目的也应该是不言自明的。如果您想写信,请放置 <letter> 标签。

信件的标签在表 信件中的标签中描述


标签
强制性是什么
发件人发件人
地址发件人地址
电子邮件发件人电子邮件
电话发件人电话
传真发件人传真
收件人收件人
地址收件人地址
电子邮件收件人电子邮件
电话收件人电话
传真收件人传真
抄送抄送
主题信件主题
发件人参考发件人参考
收件人参考收件人参考
接收日期接收日期?
开头开头
段落参见 段落
结尾结尾
附件附件
附言附言
信件中的标签

4.5 Telefax 标签


<!element telefax - -
        (from, %addr, to, address, email?,
         phone?, fax, cc?, subject?,
         opening, p+, closing, ps?)>

总体结构与 letter 类相同。唯一的区别是,使用 <telefax> 标签时,收件人的 <fax> 标签变为强制性。
原因应该很明显。

4.6 Slides 标签


<!element slides - - (slide*) >

slides 类旨在用于投影幻灯片和透明胶片。因此,由 <slides> 标签分类的文档结构非常简单。它包含由 <slide> 标签启动的单个幻灯片。仅此而已。如果未显式写入,则第一个幻灯片将隐式启动。

Slide 标签


<!element slide - o (title?, p+) >

<slide> 标签仅在 slides 文档类中允许。一个幻灯片可能包含

一个标题(参见标题标签部分)和一个或多个段落(参见段落部分)。仅此而已。

4.7 Note 标签


<!element notes - - (title?, p+) >

作为个人笔记的类,其结构甚至比 slides 文档类(参见 Slide 标签)更简化。在使用 <notes> 标签对文档进行分类后,仅允许标题(参见标题标签部分)和一个或多个段落(参见段落部分)。

4.8 Manual Page 标签


<!element manpage - - (sect1*)
        -(sect2 | f | %mathpar | figure | tabular |
          table | %xref | %thrm )>

此文档类旨在用于编写手册页,以满足 man 程序的需求。在由 <manpage> 标签分类的文档中,顶层节标签是 sect1 标签(参见分节部分),以便于将手册页粘贴到 articlebook 文档类中。此处与正常分节的例外是,只允许一个子节级别 (sect2)。


下一页 上一页 目录