[ 上一页 ] [ 版权声明 ] [ 目录 ] [ 下一页 ]

DebianDoc-SGML 手册
章 4 标记文本和特殊字符标记


普通文本(本文中称为“内嵌文本”inline text)可以包含一个特殊格式和交叉引用元素。内嵌文本可以出现在章节,附录和节的标题,以及版权声明,段落内部等地方。


4.1 特殊字符标记

DebianDoc SGML中定义了一些特殊元素来描述特别重要的文字。如果使用了特殊字符标记,要记得所有的特征标记必需有配对的结束标记,即必须明确的用<element>,或者用简略方式/表示内嵌元素的结束(参见SGML标记和元字符, 章 1)。

<em> - 强调
表示所包含的文字比较重要。

通常,用斜体字或者粗体字或者带下划线字来表示强调的文字。在纯文本格式中,一般在包含的文字两边加“*”表示,例如*this*。

<strong> - 特别强调
表示所包含的文字比较重要。

通常用粗体字表示。在纯文本格式中,一般在包含的文字两边加“*”表示,例如*this*。

<var> - 语法名词(metasyntactic variable)
表示所饱含的文字是一个语法名词。例如,是一个物体的名字,或者是一个语法上的占位名词。

语法名词通常用斜体字显示。在纯文本格式中,用尖括号包围文字,就象<this>。如果几个语法名词连在一起出现,每个都会如此显示。

<package> - 软件包的名字
表示所包含的文字为Debian软件包的名字。

通常用固定宽度文字显示;在纯文本格式中,可能用引号括起包名。

<prgn> - 程序名或者周知的文件名
这表示一个程序,周知的文件(通常不带路径),函数或者计算机中大家都比较熟悉的什么东西。

这通常用固定宽度文字显示。在纯文本格式中则不作特殊处理。

<file> - 完整的文件或者路径名
表示一个文件,缓冲区或者目录等的全路径名。

这通常用固定宽度文字显示。在纯文本格式中,通常用引号括起路径名。

<tt> - 代码行或者输出结果,命令字符串
表示所包含的文字用于计算机的输入或者输出,通常用于表示计算机命令或者程序的代码等(参见举例, 节 5.2,那里有另外的办法)。在这中表示方式中经常需要引入“语法名词”,如此应该把“语法名词”用<tt>限定。

这通常用固定宽度文字显示。在纯文本格式中,通常用引号括起路径名。

<qref id="refid"> - “静悄悄”的引用
Produces a `quiet reference' to the named reference id (see 交叉引用, 节 4.2). This should be used where a cross-reference would be useful if not intrusive, but where it is not essential and should be left out if it would need to intrude on the text. 所谓“静悄悄”的引用,是指.....

In formats where cross-references can be made non-intrusively by making a region of text a hyperlink without introducing in-line text this element will cause its contained text to become a hyperlink to the target of the cross-reference. In other formats this element will not have any effect.



4.2 交叉引用

交叉引用是引用本文档或者其他文档的某一部分的元素。

同一文件内的交叉引用是基于引用id的。每一章节,附录,节或者子节都可以有一个id属性,这个id属性可以作为被引用的依据。例如,<chapt id="spong">表示这个章节有一个id属性spong。这个引用id可以在文中的其他部分用特别的交叉引用元素来引用。

引用标识符也将用于在HTML文档中产生正确的文件名和引用名。如果没有定义引用id,则使用章节和附录等的章节号。每一章和每一节和每一个附录都定义一个引用id是一个好主意,这样,交叉引用中显示的文件名不会因为章节的次序而改变。

<ref id="refid"> - 文内交叉引用
这将产生一个同一文档内的交叉引用refid

标记<ref>本身没有任何内容;章节、附录的序号和页码等将自动插入到标记的位置。

交叉引用通常是个名词,适合象下面的场合:(参见 <ref id="...">) 或者 更详细的说明在 <ref id="...">..

<manref name="name" section="section"> - man手册页
产生一个手册页名字为name节号为section的交叉引用。这个交叉引用本身不包含任何内容,标记处将自动插入所引用的手册页内容。
<email> - 电子邮件地址
表示一个电子邮件地址。其内容应该是电子邮件地址本身,不要在上面再增加其他的标记和交叉引用。通常,地址的结束标志</email>不能省略,但是一个例外是当电子邮件地址用于<author>元素时,可以省略结束标志,下一个元素将自动结束电子邮件地址。

在一些格式中,这将产生真正的交叉引用,例如电子邮件地址的链接。另外一些格式中,经常只是用尖括号括起来而已。

<ftpsite> - 匿名FTP站点名
<ftppath> - 刚刚说明的FTP站点的路径
<ftpsite> 表示一个FTP站点。<ftppath> 是该站点上的一个路径。这两个元素不能再使用其他的修饰元素和交叉引用。

这两个元素通常用固定宽度字符显示。如果可能,<ftppath>将表示为一个<ftpsite>上的一个路径的超级链接。

在一个章节或者附录中,<ftppath>的定义必须在<ftpsite>之后。但是,一旦定义了一个站点,则可以定义该站点的几个路径。

<httpsite> - HTTP站点名
<httppath> - HTTP站点路径
<httpsite> 表示一个HTTP站点。<httppath> 是该站点上的一个路径。这两个元素不能再使用其他的修饰元素和交叉引用。

这两个元素通常用固定宽度字符显示。如果可能,<httppath>将表示为一个<httpsite>上的一个路径的超级链接。

在一个章节或者附录中,<httppath>的定义必须在<httpsite>之后。但是,一旦定义了一个站点,则可以定义该站点的几个路径。

<url id="id" name="name"> - URL
产生一个对应于id的URL,文字说明为name

通常这个元素用固定宽度文字显示;如果可能,name将作为id的超级链接显示。



4.3 脚注

脚注可以用于文档的大多数位置,用如下的元素表示:<footnote>...</footnote>。脚注内的文字不会显示在指定的位置,而是代之以一个交叉引用或者超级链接,真正的内容将根据格式的不同放到不同的位置。

脚注的内容可以是一个或者多个段落。第一个段落不必用<p>标记出来。值得注意的是,脚注内的文字不能使用其他的修饰元素。

脚注也可以嵌套,但这应该尽量避免。


[ 上一页 ] [ 版权声明 ] [ 目录 ] [ 下一页 ]
DebianDoc-SGML 手册
14 二月 2002
Ardo van Rangelrooij ardo@debian.org
Ian Jackson ijackson@gnu.ai.mit.edu
宿宝臣(翻译) linuxman@sd163.net