aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer
diff options
context:
space:
mode:
authorGabor Kovesdan <gabor@FreeBSD.org>2013-11-07 15:39:28 +0000
committerGabor Kovesdan <gabor@FreeBSD.org>2013-11-07 15:39:28 +0000
commit24d129e8d1984a0b46a543bc523b63d216813bb0 (patch)
tree7dd0501c857c6f2139f4a71191c93bf19136412a /en_US.ISO8859-1/books/fdp-primer
parent35f1d6c78be90eb13320d655cd68f94333a0ab26 (diff)
downloaddoc-24d129e8d1984a0b46a543bc523b63d216813bb0.tar.gz
doc-24d129e8d1984a0b46a543bc523b63d216813bb0.zip
- Definitively upgrade to DocBook 5.0
Notes
Notes: svn path=/projects/db5/; revision=43125
Diffstat (limited to 'en_US.ISO8859-1/books/fdp-primer')
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/book.xml32
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml114
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml1316
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/editor-config/chapter.xml29
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml174
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml30
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml7
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/see-also/chapter.xml49
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.xml669
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml115
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml80
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml5
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml68
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml35
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml35
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml63
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml126
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml352
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml258
19 files changed, 1731 insertions, 1826 deletions
diff --git a/en_US.ISO8859-1/books/fdp-primer/book.xml b/en_US.ISO8859-1/books/fdp-primer/book.xml
index 7daf24e427..31c9c556f3 100644
--- a/en_US.ISO8859-1/books/fdp-primer/book.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/book.xml
@@ -1,10 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook XML V4.5-Based Extension//EN"
- "../../../share/xml/freebsd45.dtd" [
+<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN"
+ "../../../share/xml/freebsd50.dtd" [
<!ENTITY % chapters SYSTEM "chapters.ent"> %chapters;
<!-- ENTITY index SYSTEM "index.xml" -->
]>
-
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
Redistribution and use in source (SGML DocBook) and 'compiled' forms
@@ -36,13 +35,12 @@
$FreeBSD$
-->
-
-<book lang='en'>
- <bookinfo>
- <title>FreeBSD Documentation Project Primer for New
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
+ <info><title>FreeBSD Documentation Project Primer for New
Contributors</title>
+
- <corpauthor>The FreeBSD Documentation Project</corpauthor>
+ <author><orgname>The FreeBSD Documentation Project</orgname></author>
<copyright>
<year>1998</year>
@@ -84,12 +82,12 @@
<para>This is a work in progress. Corrections and
additions are always welcome.</para>
</abstract>
- </bookinfo>
+ </info>
- <preface id="preface">
+ <preface xml:id="preface">
<title>Preface</title>
- <sect1 id="preface-prompts">
+ <sect1 xml:id="preface-prompts">
<title>Shell Prompts</title>
<para>This table shows the default system prompt and
@@ -112,7 +110,7 @@
</row>
<row>
- <entry><username>root</username></entry>
+ <entry><systemitem class="username">root</systemitem></entry>
<entry>&prompt.root;</entry>
</row>
</tbody>
@@ -120,7 +118,7 @@
</informaltable>
</sect1>
- <sect1 id="preface-conventions">
+ <sect1 xml:id="preface-conventions">
<title>Typographic Conventions</title>
<para>This table describes the typographic conventions
@@ -167,7 +165,7 @@ The time is 09:18</screen></entry>
<row>
<entry>User and group names.</entry>
- <entry>Only <username>root</username> can do
+ <entry>Only <systemitem class="username">root</systemitem> can do
this.</entry>
</row>
@@ -183,7 +181,7 @@ The time is 09:18</screen></entry>
<entry>To search for a keyword in the manual pages, type
<command>man -k
- <replaceable>keyword</replaceable></command></entry>
+ keyword</command></entry>
</row>
<row>
@@ -196,7 +194,7 @@ The time is 09:18</screen></entry>
</informaltable>
</sect1>
- <sect1 id="preface-notes">
+ <sect1 xml:id="preface-notes">
<title>Notes, Tips, Important Information, Warnings, and
Examples</title>
@@ -238,7 +236,7 @@ The time is 09:18</screen></entry>
</example>
</sect1>
- <sect1 id="preface-acknowledgements">
+ <sect1 xml:id="preface-acknowledgements">
<title>Acknowledgments</title>
<para>My thanks to Sue Blake, Patrick Durusau, Jon Hamilton,
diff --git a/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml
index 95ab3e73a0..1f95722816 100644
--- a/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/doc-build/chapter.xml
@@ -30,14 +30,13 @@
$FreeBSD$
-->
-
-<chapter id="doc-build">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="doc-build">
<title>The Documentation Build Process</title>
<para>This chapter covers organization of the documentation build
process and how &man.make.1; is used to control it.</para>
- <sect1 id="doc-build-toolset">
+ <sect1 xml:id="doc-build-toolset">
<title>The &os; Documentation Build Toolset</title>
<para>These are the tools used to build and install the
@@ -67,7 +66,7 @@
</itemizedlist>
</sect1>
- <sect1 id="doc-build-makefiles">
+ <sect1 xml:id="doc-build-makefiles">
<title>Understanding <filename>Makefile</filename>s in the
Documentation Tree</title>
@@ -90,15 +89,14 @@
</listitem>
<listitem>
- <para><link
- linkend="make-includes"><application>Make</application>
+ <para><link linkend="make-includes"><application>Make</application>
includes</link> are the glue that perform the document
production, and are usually of the form
- <filename>doc.<replaceable>xxx</replaceable>.mk</filename>.</para>
+ <filename>doc.xxx.mk</filename>.</para>
</listitem>
</itemizedlist>
- <sect2 id="sub-make">
+ <sect2 xml:id="sub-make">
<title>Subdirectory <filename>Makefile</filename>s</title>
<para>These <filename>Makefile</filename>s usually take the form
@@ -113,40 +111,40 @@ DOC_PREFIX?= ${.CURDIR}/..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"</programlisting>
<para>The first four non-empty lines define the &man.make.1;
- variables <makevar>SUBDIR</makevar>,
- <makevar>COMPAT_SYMLINK</makevar>, and
- <makevar>DOC_PREFIX</makevar>.</para>
+ variables <varname>SUBDIR</varname>,
+ <varname>COMPAT_SYMLINK</varname>, and
+ <varname>DOC_PREFIX</varname>.</para>
- <para>The <makevar>SUBDIR</makevar> statement and
- <makevar>COMPAT_SYMLINK</makevar> statement show how to
+ <para>The <varname>SUBDIR</varname> statement and
+ <varname>COMPAT_SYMLINK</varname> statement show how to
assign a value to a variable, overriding any previous
value.</para>
- <para>The second <makevar>SUBDIR</makevar> statement shows how a
+ <para>The second <varname>SUBDIR</varname> statement shows how a
value is appended to the current value of a variable. The
- <makevar>SUBDIR</makevar> variable is now <literal>articles
+ <varname>SUBDIR</varname> variable is now <literal>articles
books</literal>.</para>
- <para>The <makevar>DOC_PREFIX</makevar> assignment shows how a
+ <para>The <varname>DOC_PREFIX</varname> assignment shows how a
value is assigned to the variable, but only if it is not
already defined. This is useful if
- <makevar>DOC_PREFIX</makevar> is not where this
+ <varname>DOC_PREFIX</varname> is not where this
<filename>Makefile</filename> thinks it is - the user can
override this and provide the correct value.</para>
- <para>What does it all mean? <makevar>SUBDIR</makevar>
+ <para>What does it all mean? <varname>SUBDIR</varname>
mentions which subdirectories below this one the build process
should pass any work on to.</para>
- <para><makevar>COMPAT_SYMLINK</makevar> is specific to
+ <para><varname>COMPAT_SYMLINK</varname> is specific to
compatibility symlinks (amazingly enough) for languages to
their official encoding (<filename>doc/en</filename> would
point to <filename>en_US.ISO-8859-1</filename>).</para>
- <para><makevar>DOC_PREFIX</makevar> is the path to the root of
+ <para><varname>DOC_PREFIX</varname> is the path to the root of
the &os; Document Project tree. This is not always that easy
to find, and is also easily overridden, to allow for
- flexibility. <makevar>.CURDIR</makevar> is a &man.make.1;
+ flexibility. <varname>.CURDIR</varname> is a &man.make.1;
builtin variable with the path to the current
directory.</para>
@@ -156,7 +154,7 @@ DOC_PREFIX?= ${.CURDIR}/..
converts these variables into build instructions.</para>
</sect2>
- <sect2 id="doc-make">
+ <sect2 xml:id="doc-make">
<title>Documentation <filename>Makefile</filename>s</title>
<para>These <filename>Makefile</filename>s set &man.make.1;
@@ -181,32 +179,32 @@ DOC_PREFIX?= ${.CURDIR}/../../..
.include "$(DOC_PREFIX)/share/mk/docproj.docbook.mk"</programlisting>
- <para>The <makevar>MAINTAINER</makevar> variable allows
+ <para>The <varname>MAINTAINER</varname> variable allows
committers to claim ownership of a document in the &os;
Documentation Project, and take responsibility for maintaining
it.</para>
- <para><makevar>DOC</makevar> is the name (sans the
+ <para><varname>DOC</varname> is the name (sans the
<filename>.xml</filename> extension) of the main document
- created by this directory. <makevar>SRCS</makevar> lists all
+ created by this directory. <varname>SRCS</varname> lists all
the individual files that make up the document. This should
also include important files in which a change should result
in a rebuild.</para>
- <para><makevar>FORMATS</makevar> indicates the default formats
+ <para><varname>FORMATS</varname> indicates the default formats
that should be built for this document.
- <makevar>INSTALL_COMPRESSED</makevar> is the default list of
+ <varname>INSTALL_COMPRESSED</varname> is the default list of
compression techniques that should be used in the document
- build. <makevar>INSTALL_ONLY_COMPRESS</makevar>, empty by
+ build. <varname>INSTALL_ONLY_COMPRESS</varname>, empty by
default, should be non-empty if only compressed documents are
desired in the build.</para>
- <para>The <makevar>DOC_PREFIX</makevar> and include statements
+ <para>The <varname>DOC_PREFIX</varname> and include statements
should be familiar already.</para>
</sect2>
</sect1>
- <sect1 id="make-includes">
+ <sect1 xml:id="make-includes">
<title>&os; Documentation Project
<application>Make</application> Includes</title>
@@ -233,8 +231,8 @@ DOC_PREFIX?= ${.CURDIR}/../../..
<listitem>
<para><filename>doc.docbook.mk</filename> is included if
- <makevar>DOCFORMAT</makevar> is <literal>docbook</literal>
- and <makevar>DOC</makevar> is set.</para>
+ <varname>DOCFORMAT</varname> is <literal>docbook</literal>
+ and <varname>DOC</varname> is set.</para>
</listitem>
</itemizedlist>
@@ -262,22 +260,22 @@ PRI_LANG?= en_US.ISO8859-1
<title>Variables</title>
- <para><makevar>DOCFORMAT</makevar> and
- <makevar>MAINTAINER</makevar> are assigned default values,
+ <para><varname>DOCFORMAT</varname> and
+ <varname>MAINTAINER</varname> are assigned default values,
if these are not set by the document make file.</para>
- <para><makevar>PREFIX</makevar> is the prefix under which the
+ <para><varname>PREFIX</varname> is the prefix under which the
<link linkend="tools">documentation building tools</link>
are installed. For normal package and port installation,
this is <filename>/usr/local</filename>.</para>
- <para><makevar>PRI_LANG</makevar> should be set to whatever
+ <para><varname>PRI_LANG</varname> should be set to whatever
language and encoding is natural amongst users these
documents are being built for. US English is the
default.</para>
<note>
- <para><makevar>PRI_LANG</makevar> does not affect which
+ <para><varname>PRI_LANG</varname> does not affect which
documents can, or even will, be built. Its main use is
creating links to commonly referenced documents into the
&os; documentation install root.</para>
@@ -294,7 +292,7 @@ PRI_LANG?= en_US.ISO8859-1
returns whether the variable given is defined or not.</para>
<para><literal>.if ${DOCFORMAT} == "docbook"</literal>, next,
- tests whether the <makevar>DOCFORMAT</makevar> variable is
+ tests whether the <varname>DOCFORMAT</varname> variable is
<literal>"docbook"</literal>, and in this case, includes
<filename>doc.docbook.mk</filename>.</para>
@@ -314,21 +312,21 @@ PRI_LANG?= en_US.ISO8859-1
<itemizedlist>
<listitem>
- <para><makevar>SUBDIR</makevar> is a list of
+ <para><varname>SUBDIR</varname> is a list of
subdirectories that the build process should go further
down into.</para>
</listitem>
<listitem>
- <para><makevar>ROOT_SYMLINKS</makevar> is the name of
+ <para><varname>ROOT_SYMLINKS</varname> is the name of
directories that should be linked to the document
install root from their actual locations, if the current
language is the primary language (specified by
- <makevar>PRI_LANG</makevar>).</para>
+ <varname>PRI_LANG</varname>).</para>
</listitem>
<listitem>
- <para><makevar>COMPAT_SYMLINK</makevar> is described in
+ <para><varname>COMPAT_SYMLINK</varname> is described in
the
<link linkend="sub-make">Subdirectory Makefile</link>
section.</para>
@@ -340,9 +338,9 @@ PRI_LANG?= en_US.ISO8859-1
<title>Targets and Macros</title>
<para>Dependencies are described by
- <literal><replaceable>target</replaceable>:
- <replaceable>dependency1 dependency2
- ...</replaceable></literal> tuples, where to build
+ <literal>target:
+ dependency1 dependency2
+ ...</literal> tuples, where to build
<literal>target</literal>, the given
dependencies must be built first.</para>
@@ -362,7 +360,7 @@ PRI_LANG?= en_US.ISO8859-1
${MAKE} ${.TARGET:S/realpackage/package/:S/realinstall/install/} DIRPRFX=${DIRPRFX}${entry}/ )
.endfor</programlisting>
- <para>In the above, <maketarget>_SUBDIRUSE</maketarget> is now
+ <para>In the above, <buildtarget>_SUBDIRUSE</buildtarget> is now
a macro which will execute the given commands when it is
listed as a dependency.</para>
@@ -370,18 +368,18 @@ PRI_LANG?= en_US.ISO8859-1
Basically, it is executed <emphasis>after</emphasis> the
instructions given in the build procedure it is listed as a
dependency to, and it does not adjust
- <makevar>.TARGET</makevar>, which is the variable which
+ <varname>.TARGET</varname>, which is the variable which
contains the name of the target currently being
built.</para>
<programlisting>clean: _SUBDIRUSE
rm -f ${CLEANFILES}</programlisting>
- <para>In the above, <maketarget>clean</maketarget> will use
- the <maketarget>_SUBDIRUSE</maketarget> macro after it has
+ <para>In the above, <buildtarget>clean</buildtarget> will use
+ the <buildtarget>_SUBDIRUSE</buildtarget> macro after it has
executed the instruction
<command>rm -f ${CLEANFILES}</command>. In effect, this
- causes <maketarget>clean</maketarget> to go further and
+ causes <buildtarget>clean</buildtarget> to go further and
further down the directory tree, deleting built files as it
goes <emphasis>down</emphasis>, not on the way back
up.</para>
@@ -391,20 +389,20 @@ PRI_LANG?= en_US.ISO8859-1
<itemizedlist>
<listitem>
- <para><maketarget>install</maketarget> and
- <maketarget>package</maketarget> both go down the
+ <para><buildtarget>install</buildtarget> and
+ <buildtarget>package</buildtarget> both go down the
directory tree calling the real versions of themselves
in the subdirectories
- (<maketarget>realinstall</maketarget> and
- <maketarget>realpackage</maketarget>
+ (<buildtarget>realinstall</buildtarget> and
+ <buildtarget>realpackage</buildtarget>
respectively).</para>
</listitem>
<listitem>
- <para><maketarget>clean</maketarget> removes files
+ <para><buildtarget>clean</buildtarget> removes files
created by the build process (and goes down the
directory tree too).
- <maketarget>cleandir</maketarget> does the same, and
+ <buildtarget>cleandir</buildtarget> does the same, and
also removes the object directory, if any.</para>
</listitem>
</itemizedlist>
@@ -449,11 +447,11 @@ PRI_LANG?= en_US.ISO8859-1
${MAKE} ${.TARGET:S/realpackage/package/:S/realinstall/install/} DIRPRFX=${DIRPRFX}${entry}/ )
.endfor</programlisting>
- <para>In the above, if <makevar>SUBDIR</makevar> is empty, no
+ <para>In the above, if <varname>SUBDIR</varname> is empty, no
action is taken; if it has one or more elements, the
instructions between <literal>.for</literal> and
<literal>.endfor</literal> would repeat for every element,
- with <makevar>entry</makevar> being replaced with the value
+ with <varname>entry</varname> being replaced with the value
of the current element.</para>
</sect3>
</sect2>
diff --git a/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
index dd987da928..46f1573f99 100644
--- a/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
@@ -30,11 +30,10 @@
$FreeBSD$
-->
-
-<chapter id="docbook-markup">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="docbook-markup">
<title>DocBook Markup</title>
- <sect1 id="docbook-markup-introduction">
+ <sect1 xml:id="docbook-markup-introduction">
<title>Introduction</title>
<para>This chapter is an introduction to DocBook as it is used for
@@ -49,12 +48,10 @@
O'Reilly &amp; Associates to be a Document Type Definition
(<acronym>DTD</acronym>) for writing technical documentation
<footnote><para>A short history
- can be found under <ulink
- url="http://www.oasis-open.org/docbook/intro.shtml#d0e41">
- http://www.oasis-open.org/docbook/intro.shtml#d0e41</ulink>.</para></footnote>.
- Since 1998 it is maintained by the <ulink
- url="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=docbook">
- DocBook Technical Committee</ulink>. As such, and unlike
+ can be found under <link xlink:href="http://www.oasis-open.org/docbook/intro.shtml#d0e41">
+ http://www.oasis-open.org/docbook/intro.shtml#d0e41</link>.</para></footnote>.
+ Since 1998 it is maintained by the <link xlink:href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=docbook">
+ DocBook Technical Committee</link>. As such, and unlike
LinuxDoc and <acronym>XHTML</acronym>, DocBook is very heavily
oriented towards markup that describes <emphasis>what</emphasis>
something is, rather than describing <emphasis>how</emphasis> it
@@ -62,9 +59,9 @@
<para>The DocBook <acronym>DTD</acronym> is available from the
Ports Collection in the
- <filename role="package">textproc/docbook-xml-450</filename>
+ <package>textproc/docbook-xml-450</package>
port. It is automatically installed as part of the
- <filename role="package">textproc/docproj</filename>
+ <package>textproc/docproj</package>
port.</para>
<note>
@@ -89,7 +86,7 @@
</note>
</sect1>
- <sect1 id="docbook-markup-freebsd-extensions">
+ <sect1 xml:id="docbook-markup-freebsd-extensions">
<title>&os; Extensions</title>
<para>The &os; Documentation Project has extended the
@@ -111,25 +108,24 @@
&a.doceng;.</para>
</note>
- <sect2 id="docbook-markup-freebsd-extensions-elements">
+ <sect2 xml:id="docbook-markup-freebsd-extensions-elements">
<title>&os; Elements</title>
<para>The additional &os; elements are not (currently) in the
Ports Collection. They are stored in the &os; Subversion
- tree, as <ulink
- url="http://svnweb.FreeBSD.org/doc/head/share/xml/freebsd.dtd">head/share/xml/freebsd.dtd</ulink>.</para>
+ tree, as <link xlink:href="http://svnweb.FreeBSD.org/doc/head/share/xml/freebsd.dtd">head/share/xml/freebsd.dtd</link>.</para>
<para>&os;-specific elements used in the examples below are
clearly marked.</para>
</sect2>
- <sect2 id="docbook-markup-freebsd-extensions-entities">
+ <sect2 xml:id="docbook-markup-freebsd-extensions-entities">
<title>&os; Entities</title>
<para>This table shows some of the most useful entities
available in the <acronym>FDP</acronym>. For a complete list,
see the <filename>*.ent</filename> files in
- <filename class="directory">doc/share/xml</filename>.</para>
+ <filename>doc/share/xml</filename>.</para>
<informaltable frame="none" pgwide="1">
<tgroup cols="3">
@@ -145,25 +141,25 @@
<row>
<entry><literal>&amp;os;</literal></entry>
<entry><literal>&os;</literal></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><literal>&amp;os.stable;</literal></entry>
<entry><literal>&os.stable;</literal></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><literal>&amp;os.current;</literal></entry>
<entry><literal>&os.current;</literal></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
- <entry></entry>
- <entry></entry>
- <entry></entry>
+ <entry/>
+ <entry/>
+ <entry/>
</row>
<row>
@@ -173,30 +169,29 @@
<row>
<entry><literal>&amp;man.ls.1;</literal></entry>
<entry>&man.ls.1;</entry>
- <entry>Usage: <literal>&amp;man.ls.1; is the manual page for <sgmltag class="starttag">command</sgmltag>ls<sgmltag class="endtag">command</sgmltag>.</literal></entry>
+ <entry>Usage: <literal>&amp;man.ls.1; is the manual page for commandlscommand.</literal></entry>
</row>
<row>
<entry><literal>&amp;man.cp.1;</literal></entry>
<entry>&man.cp.1;</entry>
- <entry>Usage: <literal>The manual page for <sgmltag class="starttag">command</sgmltag>cp<sgmltag class="endtag">command</sgmltag> is &amp;man.cp.1;.</literal></entry>
+ <entry>Usage: <literal>The manual page for commandcpcommand is &amp;man.cp.1;.</literal></entry>
</row>
<row>
- <entry><literal>&amp;man.<replaceable>command</replaceable>.<replaceable>sectionnumber</replaceable>;</literal></entry>
+ <entry><literal>&amp;man.command.sectionnumber;</literal></entry>
<entry><emphasis>link to
<replaceable>command</replaceable> manual page in
section
<replaceable>sectionnumber</replaceable></emphasis></entry>
- <entry>Entities are defined for all the <ulink
- url="&url.base;/cgi/man.cgi">&os; manual
- pages</ulink>.</entry>
+ <entry>Entities are defined for all the <link xlink:href="&url.base;/cgi/man.cgi">&os; manual
+ pages</link>.</entry>
</row>
<row>
- <entry></entry>
- <entry></entry>
- <entry></entry>
+ <entry/>
+ <entry/>
+ <entry/>
</row>
<row>
@@ -216,18 +211,17 @@
</row>
<row>
- <entry><literal>&amp;a.<replaceable>listname</replaceable>;</literal></entry>
+ <entry><literal>&amp;a.listname;</literal></entry>
<entry><emphasis>link to
<replaceable>listname</replaceable></emphasis></entry>
- <entry>Entities are defined for all the <ulink
- url="&url.books.handbook;/eresources.html#eresources-mail">&os;
- mailing lists</ulink>.</entry>
+ <entry>Entities are defined for all the <link xlink:href="&url.books.handbook;/eresources.html#eresources-mail">&os;
+ mailing lists</link>.</entry>
</row>
<row>
- <entry></entry>
- <entry></entry>
- <entry></entry>
+ <entry/>
+ <entry/>
+ <entry/>
</row>
<row>
@@ -237,45 +231,41 @@
<row>
<entry><literal>&amp;url.books.handbook;</literal></entry>
<entry><literal>&url.books.handbook;</literal></entry>
- <entry>Usage: <literal>A link to the <sgmltag
- class="starttag">ulink
- url="&amp;url.books.handbook;/advanced-networking.html"</sgmltag>Advanced
- Networking<sgmltag class="endtag">ulink</sgmltag>
+ <entry>Usage: <literal>A link to the ulink
+ url="&amp;url.books.handbook;/advanced-networking.html"Advanced
+ Networkingulink
chapter of the Handbook.</literal></entry>
</row>
<row>
- <entry><literal>&amp;url.books.<replaceable>bookname</replaceable>;</literal></entry>
+ <entry><literal>&amp;url.books.bookname;</literal></entry>
<entry><emphasis>relative path to
<replaceable>bookname</replaceable></emphasis></entry>
- <entry>Entities are defined for all the <ulink
- url="&url.doc.langbase;/books/">&os;
- books</ulink>.</entry>
+ <entry>Entities are defined for all the <link xlink:href="&url.doc.langbase;/books/">&os;
+ books</link>.</entry>
</row>
<row>
<entry><literal>&amp;url.articles.committers-guide;</literal></entry>
<entry><literal>&url.articles.committers-guide;</literal></entry>
- <entry>Usage: <literal>A link to the <sgmltag
- class="starttag">ulink
- url="&amp;url.articles.committers-guide;"</sgmltag>Committer's
- Guide<sgmltag class="endtag">ulink</sgmltag>
+ <entry>Usage: <literal>A link to the ulink
+ url="&amp;url.articles.committers-guide;"Committer's
+ Guideulink
article.</literal></entry>
</row>
<row>
- <entry><literal>&amp;url.articles.<replaceable>articlename</replaceable>;</literal></entry>
+ <entry><literal>&amp;url.articles.articlename;</literal></entry>
<entry><emphasis>relative path to
<replaceable>articlename</replaceable></emphasis></entry>
- <entry>Entities are defined for all the <ulink
- url="&url.doc.langbase;/articles/">&os;
- articles</ulink>.</entry>
+ <entry>Entities are defined for all the <link xlink:href="&url.doc.langbase;/articles/">&os;
+ articles</link>.</entry>
</row>
<row>
- <entry></entry>
- <entry></entry>
- <entry></entry>
+ <entry/>
+ <entry/>
+ <entry/>
</row>
<row>
@@ -301,9 +291,9 @@
</row>
<row>
- <entry></entry>
- <entry></entry>
- <entry></entry>
+ <entry/>
+ <entry/>
+ <entry/>
</row>
<row>
@@ -313,7 +303,7 @@
<row>
<entry><literal>&amp;prompt.root;</literal></entry>
<entry>&prompt.root;</entry>
- <entry>The <username>root</username> user
+ <entry>The <systemitem class="username">root</systemitem> user
prompt.</entry>
</row>
@@ -349,7 +339,7 @@
</sect2>
</sect1>
- <sect1 id="docbook-markup-fpi">
+ <sect1 xml:id="docbook-markup-fpi">
<title>Formal Public Identifier (FPI)</title>
<para>In compliance with the DocBook guidelines for writing
@@ -360,32 +350,32 @@
<programlisting>PUBLIC "-//FreeBSD//DTD DocBook V4.2-Based Extension//EN"</programlisting>
</sect1>
- <sect1 id="docbook-markup-document-structure">
+ <sect1 xml:id="docbook-markup-document-structure">
<title>Document Structure</title>
<para>DocBook allows structuring documentation in several ways.
The &os; Documentation Project uses two primary types of DocBook
document: the book and the article.</para>
- <para>Books are organized into <sgmltag>chapter</sgmltag>s.
+ <para>Books are organized into <tag>chapter</tag>s.
This is a mandatory requirement. There may be
- <sgmltag>part</sgmltag>s between the book and the chapter to
+ <tag>part</tag>s between the book and the chapter to
provide another layer of organization. For example, the
Handbook is arranged in this way.</para>
<para>A chapter may (or may not) contain one or more sections.
- These are indicated with the <sgmltag>sect1</sgmltag> element.
+ These are indicated with the <tag>sect1</tag> element.
If a section contains another section then use the
- <sgmltag>sect2</sgmltag> element, and so on, up to
- <sgmltag>sect5</sgmltag>.</para>
+ <tag>sect2</tag> element, and so on, up to
+ <tag>sect5</tag>.</para>
<para>Chapters and sections contain the remainder of the
content.</para>
<para>An article is simpler than a book, and does not use
chapters. Instead, the content of an article is organized into
- one or more sections, using the same <sgmltag>sect1</sgmltag>
- (and <sgmltag>sect2</sgmltag> and so on) elements that are used
+ one or more sections, using the same <tag>sect1</tag>
+ (and <tag>sect2</tag> and so on) elements that are used
in books.</para>
<para>The nature of the document being written should be used to
@@ -397,200 +387,200 @@
several chapters, possibly with appendices and similar content
as well.</para>
- <para>The <ulink url="&url.base;/docs.html">&os; tutorials</ulink>
+ <para>The <link xlink:href="&url.base;/docs.html">&os; tutorials</link>
are all marked up as articles, while this
document, the
- <ulink url="&url.books.faq;/index.html">FreeBSD FAQ</ulink>,
- and the <ulink url="&url.books.handbook;/index.html">FreeBSD
- Handbook</ulink> are all marked up as books, for
+ <link xlink:href="&url.books.faq;/index.html">FreeBSD FAQ</link>,
+ and the <link xlink:href="&url.books.handbook;/index.html">FreeBSD
+ Handbook</link> are all marked up as books, for
example.</para>
- <sect2 id="docbook-markup-starting-a-book">
+ <sect2 xml:id="docbook-markup-starting-a-book">
<title>Starting a Book</title>
<para>The content of a book is contained within the
- <sgmltag>book</sgmltag> element. As well as containing
+ <tag>book</tag> element. As well as containing
structural markup, this element can contain elements that
include additional information about the book. This is either
meta-information, used for reference purposes, or additional
content used to produce a title page.</para>
<para>This additional information is contained within
- <sgmltag>bookinfo</sgmltag>.</para>
+ <tag>bookinfo</tag>.</para>
<example>
- <title>Boilerplate <sgmltag>book</sgmltag> with
- <sgmltag>bookinfo</sgmltag></title>
+ <title>Boilerplate <tag>book</tag> with
+ <tag>bookinfo</tag></title>
<!-- Cannot put this in a marked section because of the
replaceable elements -->
- <programlisting><sgmltag class="starttag">book</sgmltag>
- <sgmltag class="starttag">bookinfo</sgmltag>
- <sgmltag class="starttag">title</sgmltag><replaceable>Your Title Here</replaceable><sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">book</tag>
+ <tag class="starttag">bookinfo</tag>
+ <tag class="starttag">title</tag><replaceable>Your Title Here</replaceable><tag class="endtag">title</tag>
- <sgmltag class="starttag">author</sgmltag>
- <sgmltag class="starttag">firstname</sgmltag><replaceable>Your first name</replaceable><sgmltag class="endtag">firstname</sgmltag>
- <sgmltag class="starttag">surname</sgmltag><replaceable>Your surname</replaceable><sgmltag class="endtag">surname</sgmltag>
- <sgmltag class="starttag">affiliation</sgmltag>
- <sgmltag class="starttag">address</sgmltag><sgmltag class="starttag">email</sgmltag><replaceable>Your email address</replaceable><sgmltag class="endtag">email</sgmltag><sgmltag class="endtag">address</sgmltag>
- <sgmltag class="endtag">affiliation</sgmltag>
- <sgmltag class="endtag">author</sgmltag>
+ <tag class="starttag">author</tag>
+ <tag class="starttag">firstname</tag><replaceable>Your first name</replaceable><tag class="endtag">firstname</tag>
+ <tag class="starttag">surname</tag><replaceable>Your surname</replaceable><tag class="endtag">surname</tag>
+ <tag class="starttag">affiliation</tag>
+ <tag class="starttag">address</tag><tag class="starttag">email</tag><replaceable>Your email address</replaceable><tag class="endtag">email</tag><tag class="endtag">address</tag>
+ <tag class="endtag">affiliation</tag>
+ <tag class="endtag">author</tag>
- <sgmltag class="starttag">copyright</sgmltag>
- <sgmltag class="starttag">year</sgmltag><replaceable>1998</replaceable><sgmltag class="endtag">year</sgmltag>
- <sgmltag class="starttag">holder role="mailto:<replaceable>your email address</replaceable>"</sgmltag><replaceable>Your name</replaceable><sgmltag class="endtag">holder</sgmltag>
- <sgmltag class="endtag">copyright</sgmltag>
+ <tag class="starttag">copyright</tag>
+ <tag class="starttag">year</tag><replaceable>1998</replaceable><tag class="endtag">year</tag>
+ <tag class="starttag">holder role="mailto:<replaceable>your email address</replaceable>"</tag><replaceable>Your name</replaceable><tag class="endtag">holder</tag>
+ <tag class="endtag">copyright</tag>
- <sgmltag class="starttag">releaseinfo</sgmltag>&dollar;&os;&dollar;<sgmltag class="endtag">releaseinfo</sgmltag>
+ <tag class="starttag">releaseinfo</tag>&dollar;&os;&dollar;<tag class="endtag">releaseinfo</tag>
- <sgmltag class="starttag">abstract</sgmltag>
- <sgmltag class="starttag">para</sgmltag><replaceable>Include an abstract of the book's contents here.</replaceable><sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">abstract</sgmltag>
- <sgmltag class="endtag">bookinfo</sgmltag>
+ <tag class="starttag">abstract</tag>
+ <tag class="starttag">para</tag><replaceable>Include an abstract of the book's contents here.</replaceable><tag class="endtag">para</tag>
+ <tag class="endtag">abstract</tag>
+ <tag class="endtag">bookinfo</tag>
&hellip;
-<sgmltag class="endtag">book</sgmltag></programlisting>
+<tag class="endtag">book</tag></programlisting>
</example>
</sect2>
- <sect2 id="docbook-markup-starting-an-article">
+ <sect2 xml:id="docbook-markup-starting-an-article">
<title>Starting an Article</title>
<para>The content of the article is contained within the
- <sgmltag>article</sgmltag> element. As well as containing
+ <tag>article</tag> element. As well as containing
structural markup, this element can contain elements that
include additional information about the article. This is
either meta-information, used for reference purposes, or
additional content used to produce a title page.</para>
<para>This additional information is contained within
- <sgmltag>articleinfo</sgmltag>.</para>
+ <tag>articleinfo</tag>.</para>
<example>
- <title>Boilerplate <sgmltag>article</sgmltag> with
- <sgmltag>articleinfo</sgmltag></title>
+ <title>Boilerplate <tag>article</tag> with
+ <tag>articleinfo</tag></title>
<!-- Cannot put this in a marked section because of the
replaceable elements -->
- <programlisting><sgmltag class="starttag">article</sgmltag>
- <sgmltag class="starttag">articleinfo</sgmltag>
- <sgmltag class="starttag">title</sgmltag><replaceable>Your title here</replaceable><sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">article</tag>
+ <tag class="starttag">articleinfo</tag>
+ <tag class="starttag">title</tag><replaceable>Your title here</replaceable><tag class="endtag">title</tag>
- <sgmltag class="starttag">author</sgmltag>
- <sgmltag class="starttag">firstname</sgmltag><replaceable>Your first name</replaceable><sgmltag class="endtag">firstname</sgmltag>
- <sgmltag class="starttag">surname</sgmltag><replaceable>Your surname</replaceable><sgmltag class="endtag">surname</sgmltag>
- <sgmltag class="starttag">affiliation</sgmltag>
- <sgmltag class="starttag">address</sgmltag><sgmltag class="starttag">email</sgmltag><replaceable>Your email address</replaceable><sgmltag class="endtag">email</sgmltag><sgmltag class="endtag">address</sgmltag>
- <sgmltag class="endtag">affiliation</sgmltag>
- <sgmltag class="endtag">author</sgmltag>
+ <tag class="starttag">author</tag>
+ <tag class="starttag">firstname</tag><replaceable>Your first name</replaceable><tag class="endtag">firstname</tag>
+ <tag class="starttag">surname</tag><replaceable>Your surname</replaceable><tag class="endtag">surname</tag>
+ <tag class="starttag">affiliation</tag>
+ <tag class="starttag">address</tag><tag class="starttag">email</tag><replaceable>Your email address</replaceable><tag class="endtag">email</tag><tag class="endtag">address</tag>
+ <tag class="endtag">affiliation</tag>
+ <tag class="endtag">author</tag>
- <sgmltag class="starttag">copyright</sgmltag>
- <sgmltag class="starttag">year</sgmltag><replaceable>1998</replaceable><sgmltag class="endtag">year</sgmltag>
- <sgmltag class="starttag">holder role="mailto:<replaceable>your email address</replaceable>"</sgmltag><replaceable>Your name</replaceable><sgmltag class="endtag">holder</sgmltag>
- <sgmltag class="endtag">copyright</sgmltag>
+ <tag class="starttag">copyright</tag>
+ <tag class="starttag">year</tag><replaceable>1998</replaceable><tag class="endtag">year</tag>
+ <tag class="starttag">holder role="mailto:<replaceable>your email address</replaceable>"</tag><replaceable>Your name</replaceable><tag class="endtag">holder</tag>
+ <tag class="endtag">copyright</tag>
- <sgmltag class="starttag">releaseinfo</sgmltag>&dollar;&os;&dollar;<sgmltag class="endtag">releaseinfo</sgmltag>
+ <tag class="starttag">releaseinfo</tag>&dollar;&os;&dollar;<tag class="endtag">releaseinfo</tag>
- <sgmltag class="starttag">abstract</sgmltag>
- <sgmltag class="starttag">para</sgmltag><replaceable>Include an abstract of the article's contents here.</replaceable><sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">abstract</sgmltag>
- <sgmltag class="endtag">articleinfo</sgmltag>
+ <tag class="starttag">abstract</tag>
+ <tag class="starttag">para</tag><replaceable>Include an abstract of the article's contents here.</replaceable><tag class="endtag">para</tag>
+ <tag class="endtag">abstract</tag>
+ <tag class="endtag">articleinfo</tag>
&hellip;
-<sgmltag class="endtag">article</sgmltag></programlisting>
+<tag class="endtag">article</tag></programlisting>
</example>
</sect2>
- <sect2 id="docbook-markup-indicating-chapters">
+ <sect2 xml:id="docbook-markup-indicating-chapters">
<title>Indicating Chapters</title>
- <para>Use <sgmltag>chapter</sgmltag> to mark up your chapters.
- Each chapter has a mandatory <sgmltag>title</sgmltag>.
+ <para>Use <tag>chapter</tag> to mark up your chapters.
+ Each chapter has a mandatory <tag>title</tag>.
Articles do not contain chapters, they are reserved for
books.</para>
<example>
<title>A Simple Chapter</title>
- <programlisting><sgmltag class="starttag">chapter</sgmltag>
- <sgmltag class="starttag">title</sgmltag>The Chapter's Title<sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">chapter</tag>
+ <tag class="starttag">title</tag>The Chapter's Title<tag class="endtag">title</tag>
...
-<sgmltag class="endtag">chapter</sgmltag></programlisting>
+<tag class="endtag">chapter</tag></programlisting>
</example>
<para>A chapter cannot be empty; it must contain elements in
- addition to <sgmltag>title</sgmltag>. If you need to
+ addition to <tag>title</tag>. If you need to
include an empty chapter then just use an empty
paragraph.</para>
<example>
<title>Empty Chapters</title>
- <programlisting><sgmltag class="starttag">chapter</sgmltag>
- <sgmltag class="starttag">title</sgmltag>This is An Empty Chapter<sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">chapter</tag>
+ <tag class="starttag">title</tag>This is An Empty Chapter<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag><sgmltag class="endtag">para</sgmltag>
-<sgmltag class="endtag">chapter</sgmltag></programlisting>
+ <tag class="starttag">para</tag><tag class="endtag">para</tag>
+<tag class="endtag">chapter</tag></programlisting>
</example>
</sect2>
- <sect2 id="docbook-markup-sections-below-chapters">
+ <sect2 xml:id="docbook-markup-sections-below-chapters">
<title>Sections Below Chapters</title>
<para>In books, chapters may (but do not need to) be broken up
into sections, subsections, and so on. In articles, sections
are the main structural element, and each article must contain
at least one section. Use the
- <sgmltag>sect<replaceable>n</replaceable></sgmltag> element.
+ <tag>sect<replaceable>n</replaceable></tag> element.
The <replaceable>n</replaceable> indicates the section number,
which identifies the section level.</para>
<para>The first
- <sgmltag>sect<replaceable>n</replaceable></sgmltag> is
- <sgmltag>sect1</sgmltag>. You can have one or more of these
+ <tag>sect<replaceable>n</replaceable></tag> is
+ <tag>sect1</tag>. You can have one or more of these
in a chapter. They can contain one or more
- <sgmltag>sect2</sgmltag> elements, and so on, down to
- <sgmltag>sect5</sgmltag>.</para>
+ <tag>sect2</tag> elements, and so on, down to
+ <tag>sect5</tag>.</para>
<example>
<title>Sections in Chapters</title>
- <programlisting><sgmltag class="starttag">chapter</sgmltag>
- <sgmltag class="starttag">title</sgmltag>A Sample Chapter<sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">chapter</tag>
+ <tag class="starttag">title</tag>A Sample Chapter<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>Some text in the chapter.<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">para</tag>Some text in the chapter.<tag class="endtag">para</tag>
- <sgmltag class="starttag">sect1</sgmltag>
- <sgmltag class="starttag">title</sgmltag>First Section<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect1</tag>
+ <tag class="starttag">title</tag>First Section<tag class="endtag">title</tag>
&hellip;
- <sgmltag class="endtag">sect1</sgmltag>
+ <tag class="endtag">sect1</tag>
- <sgmltag class="starttag">sect1</sgmltag>
- <sgmltag class="starttag">title</sgmltag>Second Section<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect1</tag>
+ <tag class="starttag">title</tag>Second Section<tag class="endtag">title</tag>
- <sgmltag class="starttag">sect2</sgmltag>
- <sgmltag class="starttag">title</sgmltag>First Sub-Section<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect2</tag>
+ <tag class="starttag">title</tag>First Sub-Section<tag class="endtag">title</tag>
- <sgmltag class="starttag">sect3</sgmltag>
- <sgmltag class="starttag">title</sgmltag>First Sub-Sub-Section<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect3</tag>
+ <tag class="starttag">title</tag>First Sub-Sub-Section<tag class="endtag">title</tag>
&hellip;
- <sgmltag class="endtag">sect3</sgmltag>
- <sgmltag class="endtag">sect2</sgmltag>
+ <tag class="endtag">sect3</tag>
+ <tag class="endtag">sect2</tag>
- <sgmltag class="starttag">sect2</sgmltag>
- <sgmltag class="starttag">title</sgmltag>Second Sub-Section (1.2.2)<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect2</tag>
+ <tag class="starttag">title</tag>Second Sub-Section (1.2.2)<tag class="endtag">title</tag>
&hellip;
- <sgmltag class="endtag">sect2</sgmltag>
- <sgmltag class="endtag">sect1</sgmltag>
-<sgmltag class="endtag">chapter</sgmltag></programlisting>
+ <tag class="endtag">sect2</tag>
+ <tag class="endtag">sect1</tag>
+<tag class="endtag">chapter</tag></programlisting>
</example>
<note>
@@ -623,64 +613,64 @@
</note>
</sect2>
- <sect2 id="docbook-markup-subdividing-part">
- <title>Subdividing Using <sgmltag>part</sgmltag>
+ <sect2 xml:id="docbook-markup-subdividing-part">
+ <title>Subdividing Using <tag>part</tag>
Elements</title>
- <para><sgmltag>part</sgmltag>s introduce another level of
- organization between <sgmltag>book</sgmltag> and
- <sgmltag>chapter</sgmltag> with one or more
- <sgmltag>part</sgmltag>s. This cannot be done in an
- <sgmltag>article</sgmltag>.</para>
+ <para><tag>part</tag>s introduce another level of
+ organization between <tag>book</tag> and
+ <tag>chapter</tag> with one or more
+ <tag>part</tag>s. This cannot be done in an
+ <tag>article</tag>.</para>
- <programlisting><sgmltag class="starttag">part</sgmltag>
- <sgmltag class="starttag">title</sgmltag>Introduction<sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">part</tag>
+ <tag class="starttag">title</tag>Introduction<tag class="endtag">title</tag>
- <sgmltag class="starttag">chapter</sgmltag>
- <sgmltag class="starttag">title</sgmltag>Overview<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">chapter</tag>
+ <tag class="starttag">title</tag>Overview<tag class="endtag">title</tag>
...
- <sgmltag class="endtag">chapter</sgmltag>
+ <tag class="endtag">chapter</tag>
- <sgmltag class="starttag">chapter</sgmltag>
- <sgmltag class="starttag">title</sgmltag>What is FreeBSD?<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">chapter</tag>
+ <tag class="starttag">title</tag>What is FreeBSD?<tag class="endtag">title</tag>
...
- <sgmltag class="endtag">chapter</sgmltag>
+ <tag class="endtag">chapter</tag>
- <sgmltag class="starttag">chapter</sgmltag>
- <sgmltag class="starttag">title</sgmltag>History<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">chapter</tag>
+ <tag class="starttag">title</tag>History<tag class="endtag">title</tag>
...
- <sgmltag class="endtag">chapter</sgmltag>
-<sgmltag class="endtag">part</sgmltag></programlisting>
+ <tag class="endtag">chapter</tag>
+<tag class="endtag">part</tag></programlisting>
</sect2>
</sect1>
- <sect1 id="docbook-markup-block-elements">
+ <sect1 xml:id="docbook-markup-block-elements">
<title>Block Elements</title>
- <sect2 id="docbook-markup-paragraphs">
+ <sect2 xml:id="docbook-markup-paragraphs">
<title>Paragraphs</title>
<para>DocBook supports three types of paragraphs:
- <sgmltag>formalpara</sgmltag>, <sgmltag>para</sgmltag>, and
- <sgmltag>simpara</sgmltag>.</para>
+ <tag>formalpara</tag>, <tag>para</tag>, and
+ <tag>simpara</tag>.</para>
<para>Almost all paragraphs in &os; documentation use
- <sgmltag>para</sgmltag>. <sgmltag>formalpara</sgmltag>
- includes a <sgmltag>title</sgmltag> element, and
- <sgmltag>simpara</sgmltag> disallows some elements from
- within <sgmltag>para</sgmltag>. Stick with
- <sgmltag>para</sgmltag>.</para>
+ <tag>para</tag>. <tag>formalpara</tag>
+ includes a <tag>title</tag> element, and
+ <tag>simpara</tag> disallows some elements from
+ within <tag>para</tag>. Stick with
+ <tag>para</tag>.</para>
<example>
- <title><sgmltag>para</sgmltag></title>
+ <title><tag>para</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>This is a paragraph. It can contain just about any
- other element.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>This is a paragraph. It can contain just about any
+ other element.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -689,7 +679,7 @@
</example>
</sect2>
- <sect2 id="docbook-markup-block-quotations">
+ <sect2 xml:id="docbook-markup-block-quotations">
<title>Block Quotations</title>
<para>A block quotation is an extended quotation from another
@@ -701,24 +691,24 @@
unattributed).</para>
<example>
- <title><sgmltag>blockquote</sgmltag></title>
+ <title><tag>blockquote</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>A small excerpt from the US Constitution:<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>A small excerpt from the US Constitution:<tag class="endtag">para</tag>
-<sgmltag class="starttag">blockquote</sgmltag>
- <sgmltag class="starttag">title</sgmltag>Preamble to the Constitution of the United States<sgmltag class="endtag">title</sgmltag>
+<tag class="starttag">blockquote</tag>
+ <tag class="starttag">title</tag>Preamble to the Constitution of the United States<tag class="endtag">title</tag>
- <sgmltag class="starttag">attribution</sgmltag>Copied from a web site somewhere<sgmltag class="endtag">attribution</sgmltag>
+ <tag class="starttag">attribution</tag>Copied from a web site somewhere<tag class="endtag">attribution</tag>
- <sgmltag class="starttag">para</sgmltag>We the People of the United States, in Order to form a more
+ <tag class="starttag">para</tag>We the People of the United States, in Order to form a more
perfect Union, establish Justice, insure domestic Tranquility,
provide for the common defence, promote the general Welfare, and
secure the Blessings of Liberty to ourselves and our Posterity, do
ordain and establish this Constitution for the United States of
- America.<sgmltag class="endtag">para</sgmltag>
-<sgmltag class="endtag">blockquote</sgmltag></programlisting>
+ America.<tag class="endtag">para</tag>
+<tag class="endtag">blockquote</tag></programlisting>
<para>Appearance:</para>
@@ -742,7 +732,7 @@
</example>
</sect2>
- <sect2 id="docbook-markup-tips-notes">
+ <sect2 xml:id="docbook-markup-tips-notes">
<title>Tips, Notes, Warnings, Cautions, Important Information
and Sidebars</title>
@@ -752,11 +742,11 @@
aware.</para>
<para>Depending on the nature of the information, one of
- <sgmltag>tip</sgmltag>, <sgmltag>note</sgmltag>,
- <sgmltag>warning</sgmltag>, <sgmltag>caution</sgmltag>, and
- <sgmltag>important</sgmltag> should be used. Alternatively,
+ <tag>tip</tag>, <tag>note</tag>,
+ <tag>warning</tag>, <tag>caution</tag>, and
+ <tag>important</tag> should be used. Alternatively,
if the information is related to the main text but is not
- one of the above, use <sgmltag>sidebar</sgmltag>.</para>
+ one of the above, use <tag>sidebar</tag>.</para>
<para>The circumstances in which to choose one of these
elements over another is loosely defined by the DocBook
@@ -784,14 +774,14 @@
</itemizedlist>
<example>
- <title><sgmltag>warning</sgmltag></title>
+ <title><tag>warning</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">warning</sgmltag>
- <sgmltag class="starttag">para</sgmltag>Installing FreeBSD may make you want to delete Windows from your
- hard disk.<sgmltag class="endtag">para</sgmltag>
-<sgmltag class="endtag">warning</sgmltag></programlisting>
+ <programlisting><tag class="starttag">warning</tag>
+ <tag class="starttag">para</tag>Installing FreeBSD may make you want to delete Windows from your
+ hard disk.<tag class="endtag">para</tag>
+<tag class="endtag">warning</tag></programlisting>
</example>
<para>Appearance:</para>
@@ -802,76 +792,76 @@
</warning>
</sect2>
- <sect2 id="docbook-markup-lists-and-procedures">
+ <sect2 xml:id="docbook-markup-lists-and-procedures">
<title>Lists and Procedures</title>
<para>Information often needs to be presented as lists, or as a
number of steps that must be carried out in order to
accomplish a particular goal.</para>
- <para>To do this, use <sgmltag>itemizedlist</sgmltag>,
- <sgmltag>orderedlist</sgmltag>, or
- <sgmltag>procedure</sgmltag><footnote><para>There are other
+ <para>To do this, use <tag>itemizedlist</tag>,
+ <tag>orderedlist</tag>, or
+ <tag>procedure</tag><footnote><para>There are other
types of list element in DocBook, but we are not
concerned with those at the
moment.</para></footnote></para>
- <para><sgmltag>itemizedlist</sgmltag> and
- <sgmltag>orderedlist</sgmltag> are similar to their
- counterparts in <acronym>HTML</acronym>, <sgmltag>ul</sgmltag>
- and <sgmltag>ol</sgmltag>. Each one consists of one or more
- <sgmltag>listitem</sgmltag> elements, and each
- <sgmltag>listitem</sgmltag> contains one or more block
- elements. The <sgmltag>listitem</sgmltag> elements are
- analogous to <acronym>HTML</acronym>'s <sgmltag>li</sgmltag>
+ <para><tag>itemizedlist</tag> and
+ <tag>orderedlist</tag> are similar to their
+ counterparts in <acronym>HTML</acronym>, <tag>ul</tag>
+ and <tag>ol</tag>. Each one consists of one or more
+ <tag>listitem</tag> elements, and each
+ <tag>listitem</tag> contains one or more block
+ elements. The <tag>listitem</tag> elements are
+ analogous to <acronym>HTML</acronym>'s <tag>li</tag>
tags. However, unlike HTML, they are required.</para>
- <para><sgmltag>procedure</sgmltag> is slightly different. It
- consists of <sgmltag>step</sgmltag>s, which may in turn
- consists of more <sgmltag>step</sgmltag>s or
- <sgmltag>substep</sgmltag>s. Each <sgmltag>step</sgmltag>
+ <para><tag>procedure</tag> is slightly different. It
+ consists of <tag>step</tag>s, which may in turn
+ consists of more <tag>step</tag>s or
+ <tag>substep</tag>s. Each <tag>step</tag>
contains block elements.</para>
<example>
- <title><sgmltag>itemizedlist</sgmltag>,
- <sgmltag>orderedlist</sgmltag>, and
- <sgmltag>procedure</sgmltag></title>
+ <title><tag>itemizedlist</tag>,
+ <tag>orderedlist</tag>, and
+ <tag>procedure</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">itemizedlist</sgmltag>
- <sgmltag class="starttag">listitem</sgmltag>
- <sgmltag class="starttag">para</sgmltag>This is the first itemized item.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">listitem</sgmltag>
+ <programlisting><tag class="starttag">itemizedlist</tag>
+ <tag class="starttag">listitem</tag>
+ <tag class="starttag">para</tag>This is the first itemized item.<tag class="endtag">para</tag>
+ <tag class="endtag">listitem</tag>
- <sgmltag class="starttag">listitem</sgmltag>
- <sgmltag class="starttag">para</sgmltag>This is the second itemized item.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">listitem</sgmltag>
-<sgmltag class="endtag">itemizedlist</sgmltag>
+ <tag class="starttag">listitem</tag>
+ <tag class="starttag">para</tag>This is the second itemized item.<tag class="endtag">para</tag>
+ <tag class="endtag">listitem</tag>
+<tag class="endtag">itemizedlist</tag>
-<sgmltag class="starttag">orderedlist</sgmltag>
- <sgmltag class="starttag">listitem</sgmltag>
- <sgmltag class="starttag">para</sgmltag>This is the first ordered item.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">listitem</sgmltag>
+<tag class="starttag">orderedlist</tag>
+ <tag class="starttag">listitem</tag>
+ <tag class="starttag">para</tag>This is the first ordered item.<tag class="endtag">para</tag>
+ <tag class="endtag">listitem</tag>
- <sgmltag class="starttag">listitem</sgmltag>
- <sgmltag class="starttag">para</sgmltag>This is the second ordered item.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">listitem</sgmltag>
-<sgmltag class="endtag">orderedlist</sgmltag>
+ <tag class="starttag">listitem</tag>
+ <tag class="starttag">para</tag>This is the second ordered item.<tag class="endtag">para</tag>
+ <tag class="endtag">listitem</tag>
+<tag class="endtag">orderedlist</tag>
-<sgmltag class="starttag">procedure</sgmltag>
- <sgmltag class="starttag">step</sgmltag>
- <sgmltag class="starttag">para</sgmltag>Do this.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">step</sgmltag>
+<tag class="starttag">procedure</tag>
+ <tag class="starttag">step</tag>
+ <tag class="starttag">para</tag>Do this.<tag class="endtag">para</tag>
+ <tag class="endtag">step</tag>
- <sgmltag class="starttag">step</sgmltag>
- <sgmltag class="starttag">para</sgmltag>Then do this.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">step</sgmltag>
+ <tag class="starttag">step</tag>
+ <tag class="starttag">para</tag>Then do this.<tag class="endtag">para</tag>
+ <tag class="endtag">step</tag>
- <sgmltag class="starttag">step</sgmltag>
- <sgmltag class="starttag">para</sgmltag>And now do this.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">step</sgmltag>
-<sgmltag class="endtag">procedure</sgmltag></programlisting>
+ <tag class="starttag">step</tag>
+ <tag class="starttag">para</tag>And now do this.<tag class="endtag">para</tag>
+ <tag class="endtag">step</tag>
+<tag class="endtag">procedure</tag></programlisting>
<para>Appearance:</para>
@@ -911,15 +901,15 @@
</example>
</sect2>
- <sect2 id="docbook-markup-showing-file-samples">
+ <sect2 xml:id="docbook-markup-showing-file-samples">
<title>Showing File Samples</title>
<para>Fragments of a file (or perhaps a complete file) are shown
- by wrapping them in the <sgmltag>programlisting</sgmltag>
+ by wrapping them in the <tag>programlisting</tag>
element.</para>
<para>White space and line breaks within
- <sgmltag>programlisting</sgmltag> <emphasis>are</emphasis>
+ <tag>programlisting</tag> <emphasis>are</emphasis>
significant. In particular, this means that the opening tag
should appear on the same line as the first line of the
output, and the closing tag should appear on the same line
@@ -927,20 +917,20 @@
lines may be included.</para>
<example>
- <title><sgmltag>programlisting</sgmltag></title>
+ <title><tag>programlisting</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>When finished, the program will look like
- this:<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>When finished, the program will look like
+ this:<tag class="endtag">para</tag>
-<sgmltag class="starttag">programlisting</sgmltag>#include &amp;lt;stdio.h&amp;gt;
+<tag class="starttag">programlisting</tag>#include &amp;lt;stdio.h&amp;gt;
int
main(void)
{
printf("hello, world\n");
-}<sgmltag class="endtag">programlisting</sgmltag></programlisting>
+}<tag class="endtag">programlisting</tag></programlisting>
<para>Notice how the angle brackets in the
<literal>#include</literal> line need to be referenced by
@@ -960,60 +950,60 @@ main(void)
</example>
</sect2>
- <sect2 id="docbook-markup-callouts">
+ <sect2 xml:id="docbook-markup-callouts">
<title>Callouts</title>
<para>A callout is a visual marker for referring to a
piece of text or specific position within an
example.</para>
- <para>Callouts are marked with the <sgmltag>co</sgmltag>
+ <para>Callouts are marked with the <tag>co</tag>
element. Each element must have a unique
<literal>id</literal> assigned to it. After the example,
- include a <sgmltag>calloutlist</sgmltag> that describes each
+ include a <tag>calloutlist</tag> that describes each
callout.</para>
<example>
- <title><sgmltag>co</sgmltag> and
- <sgmltag>calloutlist</sgmltag></title>
+ <title><tag>co</tag> and
+ <tag>calloutlist</tag></title>
- <programlisting><sgmltag class="starttag">para</sgmltag>When finished, the program will look like
- this:<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>When finished, the program will look like
+ this:<tag class="endtag">para</tag>
-<sgmltag class="starttag">programlisting</sgmltag>#include &amp;lt;stdio.h&amp;gt; <sgmltag class="emptytag">co id="co-ex-include"</sgmltag>
+<tag class="starttag">programlisting</tag>#include &amp;lt;stdio.h&amp;gt; <tag class="emptytag">co id="co-ex-include"</tag>
-int <sgmltag class="emptytag">co id="co-ex-return"</sgmltag>
+int <tag class="emptytag">co id="co-ex-return"</tag>
main(void)
{
- printf("hello, world\n"); <sgmltag class="emptytag">co id="co-ex-printf"</sgmltag>
-}<sgmltag class="endtag">programlisting</sgmltag>
+ printf("hello, world\n"); <tag class="emptytag">co id="co-ex-printf"</tag>
+}<tag class="endtag">programlisting</tag>
-<sgmltag class="starttag">calloutlist</sgmltag>
- <sgmltag class="starttag">callout arearefs="co-ex-include"</sgmltag>
- <sgmltag class="starttag">para</sgmltag>Includes the standard IO header file.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">callout</sgmltag>
+<tag class="starttag">calloutlist</tag>
+ <tag class="starttag">callout arearefs="co-ex-include"</tag>
+ <tag class="starttag">para</tag>Includes the standard IO header file.<tag class="endtag">para</tag>
+ <tag class="endtag">callout</tag>
- <sgmltag class="starttag">callout arearefs="co-ex-return"</sgmltag>
- <sgmltag class="starttag">para</sgmltag>Specifies that <sgmltag class="starttag">function</sgmltag>main()<sgmltag class="endtag">function</sgmltag> returns an
- int.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">callout</sgmltag>
+ <tag class="starttag">callout arearefs="co-ex-return"</tag>
+ <tag class="starttag">para</tag>Specifies that <tag class="starttag">function</tag>main()<tag class="endtag">function</tag> returns an
+ int.<tag class="endtag">para</tag>
+ <tag class="endtag">callout</tag>
- <sgmltag class="starttag">callout arearefs="co-ex-printf"</sgmltag>
- <sgmltag class="starttag">para</sgmltag>The <sgmltag class="starttag">function</sgmltag>printf()<sgmltag class="endtag">function</sgmltag> call that writes
- <sgmltag class="starttag">literal</sgmltag>hello, world<sgmltag class="endtag">literal</sgmltag> to standard output.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">callout</sgmltag>
-<sgmltag class="endtag">calloutlist</sgmltag></programlisting>
+ <tag class="starttag">callout arearefs="co-ex-printf"</tag>
+ <tag class="starttag">para</tag>The <tag class="starttag">function</tag>printf()<tag class="endtag">function</tag> call that writes
+ <tag class="starttag">literal</tag>hello, world<tag class="endtag">literal</tag> to standard output.<tag class="endtag">para</tag>
+ <tag class="endtag">callout</tag>
+<tag class="endtag">calloutlist</tag></programlisting>
<para>Appearance:</para>
<para>When finished, the program will look like this:</para>
- <programlisting>#include &lt;stdio.h&gt; <co id="co-ex-include"/>
+ <programlisting>#include &lt;stdio.h&gt; <co xml:id="co-ex-include"/>
-int <co id="co-ex-return"/>
+int <co xml:id="co-ex-return"/>
main(void)
{
- printf("hello, world\n"); <co id="co-ex-printf"/>
+ printf("hello, world\n"); <co xml:id="co-ex-printf"/>
}</programlisting>
<calloutlist>
@@ -1035,7 +1025,7 @@ main(void)
</example>
</sect2>
- <sect2 id="docbook-markup-tables">
+ <sect2 xml:id="docbook-markup-tables">
<title>Tables</title>
<para>Unlike <acronym>HTML</acronym>, DocBook does not need
@@ -1045,48 +1035,48 @@ main(void)
<para>In general terms (and see the DocBook documentation for
more detail) a table (which can be either formal or informal)
- consists of a <sgmltag>table</sgmltag> element. This contains
- at least one <sgmltag>tgroup</sgmltag> element, which
+ consists of a <tag>table</tag> element. This contains
+ at least one <tag>tgroup</tag> element, which
specifies (as an attribute) the number of columns in this
table group. Within the tablegroup there is one
- <sgmltag>thead</sgmltag> element, which contains elements for
+ <tag>thead</tag> element, which contains elements for
the table headings (column headings), and one
- <sgmltag>tbody</sgmltag> which contains the body of the
+ <tag>tbody</tag> which contains the body of the
table.</para>
- <para>Both <sgmltag>tgroup</sgmltag> and
- <sgmltag>thead</sgmltag> contain <sgmltag>row</sgmltag>
- elements, which in turn contain <sgmltag>entry</sgmltag>
- elements. Each <sgmltag>entry</sgmltag> element specifies
+ <para>Both <tag>tgroup</tag> and
+ <tag>thead</tag> contain <tag>row</tag>
+ elements, which in turn contain <tag>entry</tag>
+ elements. Each <tag>entry</tag> element specifies
one cell in the table.</para>
<example>
- <title><sgmltag>informaltable</sgmltag></title>
+ <title><tag>informaltable</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">informaltable pgwide="1"</sgmltag>
- <sgmltag class="starttag">tgroup cols="2"</sgmltag>
- <sgmltag class="starttag">thead</sgmltag>
- <sgmltag class="starttag">row</sgmltag>
- <sgmltag class="starttag">entry</sgmltag>This is Column Head 1<sgmltag class="endtag">entry</sgmltag>
- <sgmltag class="starttag">entry</sgmltag>This is Column Head 2<sgmltag class="endtag">entry</sgmltag>
- <sgmltag class="endtag">row</sgmltag>
- <sgmltag class="endtag">thead</sgmltag>
-
- <sgmltag class="starttag">tbody</sgmltag>
- <sgmltag class="starttag">row</sgmltag>
- <sgmltag class="starttag">entry</sgmltag>Row 1, column 1<sgmltag class="endtag">entry</sgmltag>
- <sgmltag class="starttag">entry</sgmltag>Row 1, column 2<sgmltag class="endtag">entry</sgmltag>
- <sgmltag class="endtag">row</sgmltag>
-
- <sgmltag class="starttag">row</sgmltag>
- <sgmltag class="starttag">entry</sgmltag>Row 2, column 1<sgmltag class="endtag">entry</sgmltag>
- <sgmltag class="starttag">entry</sgmltag>Row 2, column 2<sgmltag class="endtag">entry</sgmltag>
- <sgmltag class="endtag">row</sgmltag>
- <sgmltag class="endtag">tbody</sgmltag>
- <sgmltag class="endtag">tgroup</sgmltag>
-<sgmltag class="endtag">informaltable</sgmltag></programlisting>
+ <programlisting><tag class="starttag">informaltable pgwide="1"</tag>
+ <tag class="starttag">tgroup cols="2"</tag>
+ <tag class="starttag">thead</tag>
+ <tag class="starttag">row</tag>
+ <tag class="starttag">entry</tag>This is Column Head 1<tag class="endtag">entry</tag>
+ <tag class="starttag">entry</tag>This is Column Head 2<tag class="endtag">entry</tag>
+ <tag class="endtag">row</tag>
+ <tag class="endtag">thead</tag>
+
+ <tag class="starttag">tbody</tag>
+ <tag class="starttag">row</tag>
+ <tag class="starttag">entry</tag>Row 1, column 1<tag class="endtag">entry</tag>
+ <tag class="starttag">entry</tag>Row 1, column 2<tag class="endtag">entry</tag>
+ <tag class="endtag">row</tag>
+
+ <tag class="starttag">row</tag>
+ <tag class="starttag">entry</tag>Row 2, column 1<tag class="endtag">entry</tag>
+ <tag class="starttag">entry</tag>Row 2, column 2<tag class="endtag">entry</tag>
+ <tag class="endtag">row</tag>
+ <tag class="endtag">tbody</tag>
+ <tag class="endtag">tgroup</tag>
+<tag class="endtag">informaltable</tag></programlisting>
<para>Appearance:</para>
@@ -1116,15 +1106,15 @@ main(void)
<para>Always use the <literal>pgwide</literal> attribute with
a value of <literal>1</literal> with the
- <sgmltag>informaltable</sgmltag> element. A bug in Internet
+ <tag>informaltable</tag> element. A bug in Internet
Explorer can cause the table to render incorrectly if this
is omitted.</para>
<para>Table borders can be suppressed by setting the
<literal>frame</literal> attribute to <literal>none</literal>
- in the <sgmltag>informaltable</sgmltag> element. For example,
- <literal><sgmltag class="starttag">informaltable
- frame="none"</sgmltag></literal>.</para>
+ in the <tag>informaltable</tag> element. For example,
+ <literal>informaltable
+ frame="none"</literal>.</para>
<example>
<title>Tables Where <literal>frame="none"</literal></title>
@@ -1156,7 +1146,7 @@ main(void)
</example>
</sect2>
- <sect2 id="docbook-markup-examples">
+ <sect2 xml:id="docbook-markup-examples">
<title>Examples for the User to Follow</title>
<para>Examples for the user to follow are often necessary.
@@ -1169,20 +1159,20 @@ main(void)
<variablelist>
<varlistentry>
- <term><sgmltag>screen</sgmltag></term>
+ <term><tag>screen</tag></term>
<listitem>
<para>Everything the user sees in this example will be
on the computer screen, so the next element is
- <sgmltag>screen</sgmltag>.</para>
+ <tag>screen</tag>.</para>
- <para>Within <sgmltag>screen</sgmltag>, white space is
+ <para>Within <tag>screen</tag>, white space is
significant.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><sgmltag>prompt</sgmltag>,
+ <term><tag>prompt</tag>,
<literal>&amp;prompt.root;</literal> and
<literal>&amp;prompt.user;</literal></term>
@@ -1191,7 +1181,7 @@ main(void)
screen are prompts from the computer (either from the
operating system, command shell, or application). These
should be marked up using
- <sgmltag>prompt</sgmltag>.</para>
+ <tag>prompt</tag>.</para>
<para>As a special case, the two shell prompts for the
normal user and the root user have been provided as
@@ -1199,7 +1189,7 @@ main(void)
use one of <literal>&amp;prompt.root;</literal> and
<literal>&amp;prompt.user;</literal> as necessary. They
do not need to be inside
- <sgmltag>prompt</sgmltag>.</para>
+ <tag>prompt</tag>.</para>
<note>
<para><literal>&amp;prompt.root;</literal> and
@@ -1211,32 +1201,32 @@ main(void)
</varlistentry>
<varlistentry>
- <term><sgmltag>userinput</sgmltag></term>
+ <term><tag>userinput</tag></term>
<listitem>
<para>When displaying text that the user should type in,
- wrap it in <sgmltag>userinput</sgmltag> tags. It will
+ wrap it in <tag>userinput</tag> tags. It will
be displayed differently than system output text.</para>
</listitem>
</varlistentry>
</variablelist>
<example>
- <title><sgmltag>screen</sgmltag>, <sgmltag>prompt</sgmltag>,
- and <sgmltag>userinput</sgmltag></title>
+ <title><tag>screen</tag>, <tag>prompt</tag>,
+ and <tag>userinput</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">screen</sgmltag>&amp;prompt.user; <sgmltag class="starttag">userinput</sgmltag>ls -1<sgmltag class="endtag">userinput</sgmltag>
+ <programlisting><tag class="starttag">screen</tag>&amp;prompt.user; <tag class="starttag">userinput</tag>ls -1<tag class="endtag">userinput</tag>
foo1
foo2
foo3
-&amp;prompt.user; <sgmltag class="starttag">userinput</sgmltag>ls -1 | grep foo2<sgmltag class="endtag">userinput</sgmltag>
+&amp;prompt.user; <tag class="starttag">userinput</tag>ls -1 | grep foo2<tag class="endtag">userinput</tag>
foo2
-&amp;prompt.user; <sgmltag class="starttag">userinput</sgmltag>su<sgmltag class="endtag">userinput</sgmltag>
-<sgmltag class="starttag">prompt</sgmltag>Password: <sgmltag class="endtag">prompt</sgmltag>
-&amp;prompt.root; <sgmltag class="starttag">userinput</sgmltag>cat foo2<sgmltag class="endtag">userinput</sgmltag>
-This is the file called 'foo2'<sgmltag class="endtag">screen</sgmltag></programlisting>
+&amp;prompt.user; <tag class="starttag">userinput</tag>su<tag class="endtag">userinput</tag>
+<tag class="starttag">prompt</tag>Password: <tag class="endtag">prompt</tag>
+&amp;prompt.root; <tag class="starttag">userinput</tag>cat foo2<tag class="endtag">userinput</tag>
+This is the file called 'foo2'<tag class="endtag">screen</tag></programlisting>
<para>Appearance:</para>
@@ -1255,40 +1245,40 @@ This is the file called 'foo2'</screen>
<note>
<para>Even though we are displaying the contents of the file
<filename>foo2</filename>, it is <emphasis>not</emphasis>
- marked up as <sgmltag>programlisting</sgmltag>. Reserve
- <sgmltag>programlisting</sgmltag> for showing fragments of
+ marked up as <tag>programlisting</tag>. Reserve
+ <tag>programlisting</tag> for showing fragments of
files outside the context of user actions.</para>
</note>
</sect2>
</sect1>
- <sect1 id="docbook-markup-inline-elements">
+ <sect1 xml:id="docbook-markup-inline-elements">
<title>In-line Elements</title>
- <sect2 id="docbook-markup-inline-emphasizing">
+ <sect2 xml:id="docbook-markup-inline-emphasizing">
<title>Emphasizing Information</title>
<para>To emphasize a particular word or phrase, use
- <sgmltag>emphasis</sgmltag>. This may be presented as
+ <tag>emphasis</tag>. This may be presented as
italic, or bold, or might be spoken differently with a
text-to-speech system.</para>
<para>There is no way to change the presentation of the
emphasis within the document, no equivalent of
- <acronym>HTML</acronym>'s <sgmltag>b</sgmltag> and
- <sgmltag>i</sgmltag>. If the information being presented is
+ <acronym>HTML</acronym>'s <tag>b</tag> and
+ <tag>i</tag>. If the information being presented is
important, then consider presenting it in
- <sgmltag>important</sgmltag> rather than
- <sgmltag>emphasis</sgmltag>.</para>
+ <tag>important</tag> rather than
+ <tag>emphasis</tag>.</para>
<example>
- <title><sgmltag>emphasis</sgmltag></title>
+ <title><tag>emphasis</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>FreeBSD is without doubt <sgmltag class="starttag">emphasis</sgmltag>the<sgmltag class="endtag">emphasis</sgmltag>
+ <programlisting><tag class="starttag">para</tag>FreeBSD is without doubt <tag class="starttag">emphasis</tag>the<tag class="endtag">emphasis</tag>
premiere &amp;unix;-like operating system for the Intel
- architecture.<sgmltag class="endtag">para</sgmltag></programlisting>
+ architecture.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1298,13 +1288,13 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-acronyms">
+ <sect2 xml:id="docbook-markup-acronyms">
<title>Acronyms</title>
<para>Many computer terms are <emphasis>acronyms</emphasis>,
words formed from the first letter of each word in a
phrase. Acronyms are marked up into
- <sgmltag>acronym</sgmltag> elements. It is helpful to the
+ <tag>acronym</tag> elements. It is helpful to the
reader when an acronym is defined on the first use, as shown
in the example below.</para>
@@ -1313,11 +1303,11 @@ This is the file called 'foo2'</screen>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Request For Comments (<sgmltag class="starttag">acronym</sgmltag>RFC<sgmltag class="endtag">acronym</sgmltag>) 1149
+ <programlisting><tag class="starttag">para</tag>Request For Comments (<tag class="starttag">acronym</tag>RFC<tag class="endtag">acronym</tag>) 1149
defined the use of avian carriers for transmission of
- Internet Protocol (<sgmltag class="starttag">acronym</sgmltag>IP<sgmltag class="endtag">acronym</sgmltag>) data. The
- quantity of <sgmltag class="starttag">acronym</sgmltag>IP<sgmltag class="endtag">acronym</sgmltag> data currently
- transmitted in that manner is unknown.<sgmltag class="endtag">para</sgmltag></programlisting>
+ Internet Protocol (<tag class="starttag">acronym</tag>IP<tag class="endtag">acronym</tag>) data. The
+ quantity of <tag class="starttag">acronym</tag>IP<tag class="endtag">acronym</tag> data currently
+ transmitted in that manner is unknown.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1329,23 +1319,23 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-quotations">
+ <sect2 xml:id="docbook-markup-quotations">
<title>Quotations</title>
<para>To quote text from another document or source, or to
denote a phrase that is used figuratively, use
- <sgmltag>quote</sgmltag>. Most of the markup tags available
+ <tag>quote</tag>. Most of the markup tags available
for normal text are also available from within a
- <sgmltag>quote</sgmltag>.</para>
+ <tag>quote</tag>.</para>
<example>
<title>Quotations</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>However, make sure that the search does not go beyond the
- <sgmltag class="starttag">quote</sgmltag>boundary between local and public administration<sgmltag class="endtag">quote</sgmltag>,
- as <sgmltag class="starttag">acronym</sgmltag>RFC<sgmltag class="endtag">acronym</sgmltag> 1535 calls it.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>However, make sure that the search does not go beyond the
+ <tag class="starttag">quote</tag>boundary between local and public administration<tag class="endtag">quote</tag>,
+ as <tag class="starttag">acronym</tag>RFC<tag class="endtag">acronym</tag> 1535 calls it.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1356,16 +1346,16 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-keys">
+ <sect2 xml:id="docbook-markup-keys">
<title>Keys, Mouse Buttons, and Combinations</title>
<para>To refer to a specific key on the keyboard, use
- <sgmltag>keycap</sgmltag>. To refer to a mouse button, use
- <sgmltag>mousebutton</sgmltag>. And to refer to
+ <tag>keycap</tag>. To refer to a mouse button, use
+ <tag>mousebutton</tag>. And to refer to
combinations of key presses or mouse clicks, wrap them all
- in <sgmltag>keycombo</sgmltag>.</para>
+ in <tag>keycombo</tag>.</para>
- <para><sgmltag>keycombo</sgmltag> has an attribute called
+ <para><tag>keycombo</tag> has an attribute called
<literal>action</literal>, which may be one of
<literal>click</literal>, <literal>double-click</literal>,
<literal>other</literal>, <literal>press</literal>,
@@ -1375,25 +1365,25 @@ This is the file called 'foo2'</screen>
<para>The stylesheets automatically add any connecting
symbols, such as <literal>+</literal>, between the key
- names, when wrapped in <sgmltag>keycombo</sgmltag>.</para>
+ names, when wrapped in <tag>keycombo</tag>.</para>
<example>
<title>Keys, Mouse Buttons, and Combinations</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>To switch to the second virtual terminal, press
- <sgmltag class="starttag">keycombo action="simul"</sgmltag><sgmltag class="starttag">keycap</sgmltag>Alt<sgmltag class="endtag">keycap</sgmltag>
- <sgmltag class="starttag">keycap</sgmltag>F1<sgmltag class="endtag">keycap</sgmltag><sgmltag class="endtag">keycombo</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>To switch to the second virtual terminal, press
+ <tag class="starttag">keycombo action="simul"</tag><tag class="starttag">keycap</tag>Alt<tag class="endtag">keycap</tag>
+ <tag class="starttag">keycap</tag>F1<tag class="endtag">keycap</tag><tag class="endtag">keycombo</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>To exit <sgmltag class="starttag">command</sgmltag>vi<sgmltag class="endtag">command</sgmltag> without saving changes, type
- <sgmltag class="starttag">keycombo action="seq"</sgmltag><sgmltag class="starttag">keycap</sgmltag>Esc<sgmltag class="endtag">keycap</sgmltag><sgmltag class="starttag">keycap</sgmltag>:<sgmltag class="endtag">keycap</sgmltag>
- <sgmltag class="starttag">keycap</sgmltag>q<sgmltag class="endtag">keycap</sgmltag><sgmltag class="starttag">keycap</sgmltag>!<sgmltag class="endtag">keycap</sgmltag><sgmltag class="endtag">keycombo</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+<tag class="starttag">para</tag>To exit <tag class="starttag">command</tag>vi<tag class="endtag">command</tag> without saving changes, type
+ <tag class="starttag">keycombo action="seq"</tag><tag class="starttag">keycap</tag>Esc<tag class="endtag">keycap</tag><tag class="starttag">keycap</tag>:<tag class="endtag">keycap</tag>
+ <tag class="starttag">keycap</tag>q<tag class="endtag">keycap</tag><tag class="starttag">keycap</tag>!<tag class="endtag">keycap</tag><tag class="endtag">keycombo</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>My window manager is configured so that
- <sgmltag class="starttag">keycombo action="simul"</sgmltag><sgmltag class="starttag">keycap</sgmltag>Alt<sgmltag class="endtag">keycap</sgmltag>
- <sgmltag class="starttag">mousebutton</sgmltag>right<sgmltag class="endtag">mousebutton</sgmltag>
- <sgmltag class="endtag">keycombo</sgmltag> mouse button is used to move windows.<sgmltag class="endtag">para</sgmltag></programlisting>
+<tag class="starttag">para</tag>My window manager is configured so that
+ <tag class="starttag">keycombo action="simul"</tag><tag class="starttag">keycap</tag>Alt<tag class="endtag">keycap</tag>
+ <tag class="starttag">mousebutton</tag>right<tag class="endtag">mousebutton</tag>
+ <tag class="endtag">keycombo</tag> mouse button is used to move windows.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1416,7 +1406,7 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-applications">
+ <sect2 xml:id="docbook-markup-applications">
<title>Applications, Commands, Options, and Cites</title>
<para>Both applications and commands are frequently referred to
@@ -1434,23 +1424,23 @@ This is the file called 'foo2'</screen>
format so common in Unix manuals.</para>
<para>Mark up application names with
- <sgmltag>application</sgmltag>.</para>
+ <tag>application</tag>.</para>
<para>To list a command with its manual section
number (which should be most of the time) the DocBook
- element is <sgmltag>citerefentry</sgmltag>. This will
+ element is <tag>citerefentry</tag>. This will
contain a further two elements,
- <sgmltag>refentrytitle</sgmltag> and
- <sgmltag>manvolnum</sgmltag>. The content of
- <sgmltag>refentrytitle</sgmltag> is the name of the command,
- and the content of <sgmltag>manvolnum</sgmltag> is the
+ <tag>refentrytitle</tag> and
+ <tag>manvolnum</tag>. The content of
+ <tag>refentrytitle</tag> is the name of the command,
+ and the content of <tag>manvolnum</tag> is the
manual page section.</para>
<para>This can be cumbersome to write, and so a series of
<link linkend="xml-primer-general-entities">general
entities</link> have been created to make this easier.
Each entity takes the form
- <literal>&amp;man.<replaceable>manual-page</replaceable>.<replaceable>manual-section</replaceable>;</literal>.</para>
+ <literal>&amp;man.manual-page.manual-section;</literal>.</para>
<para>The file that contains these entities is in
<filename>doc/share/xml/man-refs.ent</filename>, and can be
@@ -1470,18 +1460,18 @@ This is the file called 'foo2'</screen>
]&gt;</programlisting>
- <para>Use <sgmltag>command</sgmltag> when to include a command
+ <para>Use <tag>command</tag> when to include a command
name <quote>in-line</quote> but present it as something the
user should type in.</para>
- <para>Use <sgmltag>option</sgmltag> to mark up the options
+ <para>Use <tag>option</tag> to mark up the options
which will be passed to a command.</para>
<para>When referring to the same command multiple times in
close proximity, it is preferred to use the
- <literal>&amp;man.<replaceable>command</replaceable>.<replaceable>section</replaceable>;</literal>
+ <literal>&amp;man.command.section;</literal>
notation to markup the first reference and use
- <sgmltag>command</sgmltag> to markup subsequent references.
+ <tag>command</tag> to markup subsequent references.
This makes the generated output, especially
<acronym>HTML</acronym>, appear visually better.</para>
@@ -1490,22 +1480,22 @@ This is the file called 'foo2'</screen>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag><sgmltag class="starttag">application</sgmltag>Sendmail<sgmltag class="endtag">application</sgmltag> is the most
- widely used Unix mail application.<sgmltag class="starttag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag><tag class="starttag">application</tag>Sendmail<tag class="endtag">application</tag> is the most
+ widely used Unix mail application.<tag class="starttag">para</tag>
-<sgmltag class="starttag">para</sgmltag><sgmltag class="starttag">application</sgmltag>Sendmail<sgmltag class="endtag">application</sgmltag> includes the
- <sgmltag class="starttag">citerefentry</sgmltag>
- <sgmltag class="starttag">refentrytitle</sgmltag>sendmail<sgmltag class="endtag">refentrytitle</sgmltag>
- <sgmltag class="starttag">manvolnum</sgmltag>8<sgmltag class="endtag">manvolnum</sgmltag>
- <sgmltag class="endtag">citerefentry</sgmltag>, &amp;man.mailq.1;, and &amp;man.newaliases.1;
- programs.<sgmltag class="endtag">para</sgmltag>
+<tag class="starttag">para</tag><tag class="starttag">application</tag>Sendmail<tag class="endtag">application</tag> includes the
+ <tag class="starttag">citerefentry</tag>
+ <tag class="starttag">refentrytitle</tag>sendmail<tag class="endtag">refentrytitle</tag>
+ <tag class="starttag">manvolnum</tag>8<tag class="endtag">manvolnum</tag>
+ <tag class="endtag">citerefentry</tag>, &amp;man.mailq.1;, and &amp;man.newaliases.1;
+ programs.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>One of the command line parameters to <sgmltag class="starttag">citerefentry</sgmltag>
- <sgmltag class="starttag">refentrytitle</sgmltag>sendmail<sgmltag class="endtag">refentrytitle</sgmltag>
- <sgmltag class="starttag">manvolnum</sgmltag>8<sgmltag class="endtag">manvolnum</sgmltag>
- <sgmltag class="endtag">citerefentry</sgmltag>, <sgmltag class="starttag">option</sgmltag>-bp<sgmltag class="endtag">option</sgmltag>, will display the current
+<tag class="starttag">para</tag>One of the command line parameters to <tag class="starttag">citerefentry</tag>
+ <tag class="starttag">refentrytitle</tag>sendmail<tag class="endtag">refentrytitle</tag>
+ <tag class="starttag">manvolnum</tag>8<tag class="endtag">manvolnum</tag>
+ <tag class="endtag">citerefentry</tag>, <tag class="starttag">option</tag>-bp<tag class="endtag">option</tag>, will display the current
status of messages in the mail queue. Check this on the command
- line by running <sgmltag class="starttag">command</sgmltag>sendmail -bp<sgmltag class="endtag">command</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+ line by running <tag class="starttag">command</tag>sendmail -bp<tag class="endtag">command</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1531,28 +1521,28 @@ This is the file called 'foo2'</screen>
<note>
<para>Notice how the
- <literal>&amp;man.<replaceable>command</replaceable>.<replaceable>section</replaceable>;</literal>
+ <literal>&amp;man.command.section;</literal>
notation is easier to follow.</para>
</note>
</sect2>
- <sect2 id="docbook-markup-files">
+ <sect2 xml:id="docbook-markup-files">
<title>Files, Directories, Extensions</title>
<para>To refer to the name of a file, a directory, or a file
- extension, use <sgmltag>filename</sgmltag>.</para>
+ extension, use <tag>filename</tag>.</para>
<example>
- <title><sgmltag>filename</sgmltag></title>
+ <title><tag>filename</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>The XML source for the Handbook in English is
- found in <sgmltag class="starttag">filename class="directory"</sgmltag>/usr/doc/en_US.ISO8859-1/books/handbook/<sgmltag class="endtag">filename</sgmltag>. The first
- file is called <sgmltag class="starttag">filename</sgmltag>book.xml<sgmltag class="endtag">filename</sgmltag> in that
- directory. There is also a <sgmltag class="starttag">filename</sgmltag>Makefile<sgmltag class="endtag">filename</sgmltag>
- and a number of files with a <sgmltag class="starttag">filename</sgmltag>.ent<sgmltag class="endtag">filename</sgmltag>
- extension.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>The XML source for the Handbook in English is
+ found in <tag class="starttag">filename class="directory"</tag>/usr/doc/en_US.ISO8859-1/books/handbook/<tag class="endtag">filename</tag>. The first
+ file is called <tag class="starttag">filename</tag>book.xml<tag class="endtag">filename</tag> in that
+ directory. There is also a <tag class="starttag">filename</tag>Makefile<tag class="endtag">filename</tag>
+ and a number of files with a <tag class="starttag">filename</tag>.ent<tag class="endtag">filename</tag>
+ extension.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1565,7 +1555,7 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-name-of-ports">
+ <sect2 xml:id="docbook-markup-name-of-ports">
<title>The Name of Ports</title>
<note>
@@ -1578,7 +1568,7 @@ This is the file called 'foo2'</screen>
<para>To include the name of a program from the &os;
Ports Collection in the document, use the
- <sgmltag>filename</sgmltag> tag with the
+ <tag>filename</tag> tag with the
<literal>role</literal> attribute set to
<literal>package</literal>. Since ports can be installed in
any number of locations, only include the category and the
@@ -1586,22 +1576,21 @@ This is the file called 'foo2'</screen>
<filename>/usr/ports</filename>.</para>
<example>
- <title><sgmltag>filename</sgmltag> Tag with
+ <title><tag>filename</tag> Tag with
<literal>package</literal> Role</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Install the <sgmltag class="starttag">filename role="package"</sgmltag>net/wireshark<sgmltag class="endtag">filename</sgmltag> port to view network traffic.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>Install the <tag class="starttag">filename role="package"</tag>net/wireshark<tag class="endtag">filename</tag> port to view network traffic.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
- <para>Install the <filename
- role="package">net/wireshark</filename> port to view
+ <para>Install the <package>net/wireshark</package> port to view
network traffic.</para>
</example>
</sect2>
- <sect2 id="docbook-markup-devices">
+ <sect2 xml:id="docbook-markup-devices">
<title>Devices</title>
<note>
@@ -1615,7 +1604,7 @@ This is the file called 'foo2'</screen>
<para>There are two names for devices: the device name as it
appears in <filename>/dev</filename>, or the name of the
device as it appears in the kernel. For this latter course,
- use <sgmltag>devicename</sgmltag>.</para>
+ use <tag>devicename</tag>.</para>
<para>Sometimes there is no choice. Some devices, such as
network cards, do not have entries in
@@ -1623,42 +1612,42 @@ This is the file called 'foo2'</screen>
different from their kernel device names.</para>
<example>
- <title><sgmltag>devicename</sgmltag></title>
+ <title><tag>devicename</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag><sgmltag class="starttag">devicename</sgmltag>sio<sgmltag class="endtag">devicename</sgmltag> is used for serial
- communication in FreeBSD. <sgmltag class="starttag">devicename</sgmltag>sio<sgmltag class="endtag">devicename</sgmltag> manifests
- through a number of entries in <sgmltag class="starttag">filename</sgmltag>/dev<sgmltag class="endtag">filename</sgmltag>, including
- <sgmltag class="starttag">filename</sgmltag>/dev/ttyd0<sgmltag class="endtag">filename</sgmltag> and <sgmltag class="starttag">filename</sgmltag>/dev/cuaa0<sgmltag class="endtag">filename</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag><tag class="starttag">devicename</tag>sio<tag class="endtag">devicename</tag> is used for serial
+ communication in FreeBSD. <tag class="starttag">devicename</tag>sio<tag class="endtag">devicename</tag> manifests
+ through a number of entries in <tag class="starttag">filename</tag>/dev<tag class="endtag">filename</tag>, including
+ <tag class="starttag">filename</tag>/dev/ttyd0<tag class="endtag">filename</tag> and <tag class="starttag">filename</tag>/dev/cuaa0<tag class="endtag">filename</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>By contrast, network devices such as
- <sgmltag class="starttag">devicename</sgmltag>ed0<sgmltag class="endtag">devicename</sgmltag> do not appear in <sgmltag class="starttag">filename</sgmltag>/dev<sgmltag class="endtag">filename</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+<tag class="starttag">para</tag>By contrast, network devices such as
+ <tag class="starttag">devicename</tag>ed0<tag class="endtag">devicename</tag> do not appear in <tag class="starttag">filename</tag>/dev<tag class="endtag">filename</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>In MS-DOS, the first floppy drive is referred to as
- <sgmltag class="starttag">devicename</sgmltag>a:<sgmltag class="endtag">devicename</sgmltag>. In FreeBSD it is
- <sgmltag class="starttag">filename</sgmltag>/dev/fd0<sgmltag class="endtag">filename</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+<tag class="starttag">para</tag>In MS-DOS, the first floppy drive is referred to as
+ <tag class="starttag">devicename</tag>a:<tag class="endtag">devicename</tag>. In FreeBSD it is
+ <tag class="starttag">filename</tag>/dev/fd0<tag class="endtag">filename</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
- <para><devicename>sio</devicename> is used for serial
- communication in FreeBSD. <devicename>sio</devicename>
+ <para><filename>sio</filename> is used for serial
+ communication in FreeBSD. <filename>sio</filename>
manifests through a number of entries in
<filename>/dev</filename>, including
<filename>/dev/ttyd0</filename> and
<filename>/dev/cuaa0</filename>.</para>
<para>By contrast, network devices such as
- <devicename>ed0</devicename> do not appear in
+ <filename>ed0</filename> do not appear in
<filename>/dev</filename>.</para>
<para>In MS-DOS, the first floppy drive is referred to as
- <devicename>a:</devicename>. In FreeBSD it is
+ <filename>a:</filename>. In FreeBSD it is
<filename>/dev/fd0</filename>.</para>
</example>
</sect2>
- <sect2 id="docbook-markup-hosts">
+ <sect2 xml:id="docbook-markup-hosts">
<title>Hosts, Domains, IP Addresses, and So Forth</title>
<note>
@@ -1671,7 +1660,7 @@ This is the file called 'foo2'</screen>
<para>Identification information for networked computers (hosts)
can be marked up in several ways, depending on the nature of
- the information. All of them use <sgmltag>hostid</sgmltag> as
+ the information. All of them use <tag>hostid</tag> as
the element, with the <literal>role</literal> attribute
selecting the type of the marked up information.</para>
@@ -1682,7 +1671,7 @@ This is the file called 'foo2'</screen>
<listitem>
<para>With no <literal>role</literal> attribute (i.e.,
- <sgmltag>hostid</sgmltag>...<sgmltag>/hostid</sgmltag>)
+ <tag>hostid</tag>...<tag>/hostid</tag>)
the marked up information is the simple hostname, such
as <literal>freefall</literal> or
<literal>wcarchive</literal>. The hostname can be
@@ -1752,57 +1741,57 @@ This is the file called 'foo2'</screen>
</variablelist>
<example>
- <title><sgmltag>hostid</sgmltag> and Roles</title>
+ <title><tag>hostid</tag> and Roles</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>The local machine can always be referred to by the
- name <sgmltag class="starttag">hostid</sgmltag>localhost<sgmltag class="endtag">hostid</sgmltag>, which will have the IP
- address <sgmltag class="starttag">hostid role="ipaddr"</sgmltag>127.0.0.1<sgmltag class="endtag">hostid</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>The local machine can always be referred to by the
+ name <tag class="starttag">hostid</tag>localhost<tag class="endtag">hostid</tag>, which will have the IP
+ address <tag class="starttag">hostid role="ipaddr"</tag>127.0.0.1<tag class="endtag">hostid</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>The <sgmltag class="starttag">hostid role="domainname"</sgmltag>FreeBSD.org<sgmltag class="endtag">hostid</sgmltag>
+<tag class="starttag">para</tag>The <tag class="starttag">hostid role="domainname"</tag>FreeBSD.org<tag class="endtag">hostid</tag>
domain contains a number of different hosts, including
- <sgmltag class="starttag">hostid role="fqdn"</sgmltag>freefall.FreeBSD.org<sgmltag class="endtag">hostid</sgmltag> and
- <sgmltag class="starttag">hostid role="fqdn"</sgmltag>bento.FreeBSD.org<sgmltag class="endtag">hostid</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">hostid role="fqdn"</tag>freefall.FreeBSD.org<tag class="endtag">hostid</tag> and
+ <tag class="starttag">hostid role="fqdn"</tag>bento.FreeBSD.org<tag class="endtag">hostid</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>When adding an <sgmltag class="starttag">acronym</sgmltag>IP<sgmltag class="endtag">acronym</sgmltag> alias to an
- interface (using <sgmltag class="starttag">command</sgmltag>ifconfig<sgmltag class="endtag">command</sgmltag>)
- <sgmltag class="starttag">emphasis</sgmltag>always<sgmltag class="endtag">emphasis</sgmltag> use a netmask of
- <sgmltag class="starttag">hostid role="netmask"</sgmltag>255.255.255.255<sgmltag class="endtag">hostid</sgmltag> (which can
+<tag class="starttag">para</tag>When adding an <tag class="starttag">acronym</tag>IP<tag class="endtag">acronym</tag> alias to an
+ interface (using <tag class="starttag">command</tag>ifconfig<tag class="endtag">command</tag>)
+ <tag class="starttag">emphasis</tag>always<tag class="endtag">emphasis</tag> use a netmask of
+ <tag class="starttag">hostid role="netmask"</tag>255.255.255.255<tag class="endtag">hostid</tag> (which can
also be expressed as
- <sgmltag class="starttag">hostid role="netmask"</sgmltag>0xffffffff<sgmltag class="endtag">hostid</sgmltag>).<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">hostid role="netmask"</tag>0xffffffff<tag class="endtag">hostid</tag>).<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>The <sgmltag class="starttag">acronym</sgmltag>MAC<sgmltag class="endtag">acronym</sgmltag> address uniquely identifies
+<tag class="starttag">para</tag>The <tag class="starttag">acronym</tag>MAC<tag class="endtag">acronym</tag> address uniquely identifies
every network card in existence. A typical
- <sgmltag class="starttag">acronym</sgmltag>MAC<sgmltag class="endtag">acronym</sgmltag> address looks like
- <sgmltag class="starttag">hostid role="mac"</sgmltag>08:00:20:87:ef:d0<sgmltag class="endtag">hostid</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <tag class="starttag">acronym</tag>MAC<tag class="endtag">acronym</tag> address looks like
+ <tag class="starttag">hostid role="mac"</tag>08:00:20:87:ef:d0<tag class="endtag">hostid</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
<para>The local machine can always be referred to by the
- name <hostid>localhost</hostid>, which will have the IP
- address <hostid role="ipaddr">127.0.0.1</hostid>.</para>
+ name <systemitem>localhost</systemitem>, which will have the IP
+ address <systemitem class="ipaddress">127.0.0.1</systemitem>.</para>
- <para>The <hostid role="domainname">FreeBSD.org</hostid>
+ <para>The <systemitem class="fqdomainname">FreeBSD.org</systemitem>
domain contains a number of different hosts, including
- <hostid role="fqdn">freefall.FreeBSD.org</hostid> and
- <hostid role="fqdn">bento.FreeBSD.org</hostid>.</para>
+ <systemitem class="fqdomainname">freefall.FreeBSD.org</systemitem> and
+ <systemitem class="fqdomainname">bento.FreeBSD.org</systemitem>.</para>
<para>When adding an <acronym>IP</acronym> alias to an
interface (using <command>ifconfig</command>)
<emphasis>always</emphasis> use a netmask of
- <hostid role="netmask">255.255.255.255</hostid> (which can
+ <systemitem class="netmask">255.255.255.255</systemitem> (which can
also be expressed as
- <hostid role="netmask">0xffffffff</hostid>).</para>
+ <systemitem class="netmask">0xffffffff</systemitem>).</para>
<para>The <acronym>MAC</acronym> address uniquely identifies
every network card in existence. A typical
<acronym>MAC</acronym> address looks like
- <hostid role="mac">08:00:20:87:ef:d0</hostid>.</para>
+ <systemitem class="etheraddress">08:00:20:87:ef:d0</systemitem>.</para>
</example>
</sect2>
- <sect2 id="docbook-markup-usernames">
+ <sect2 xml:id="docbook-markup-usernames">
<title>Usernames</title>
<note>
@@ -1815,40 +1804,40 @@ This is the file called 'foo2'</screen>
<para>To refer to a specific username, such as
<literal>root</literal> or <literal>bin</literal>, use
- <sgmltag>username</sgmltag>.</para>
+ <tag>username</tag>.</para>
<example>
- <title><sgmltag>username</sgmltag></title>
+ <title><tag>username</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>To carry out most system administration functions
- requires logging in as <sgmltag class="starttag">username</sgmltag>root<sgmltag class="endtag">username</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>To carry out most system administration functions
+ requires logging in as <tag class="starttag">username</tag>root<tag class="endtag">username</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
<para>To carry out most system administration functions
- requires logging in as <username>root</username>.</para>
+ requires logging in as <systemitem class="username">root</systemitem>.</para>
</example>
</sect2>
- <sect2 id="docbook-markup-email-addresses">
+ <sect2 xml:id="docbook-markup-email-addresses">
<title>Email Addresses</title>
- <para>Email addresses are marked up as <sgmltag>email</sgmltag>
+ <para>Email addresses are marked up as <tag>email</tag>
elements. In the <acronym>HTML</acronym> output format, the
wrapped text becomes a hyperlink to the email address. Other
output formats that support hyperlinks may also make the email
address into a link.</para>
<example>
- <title><sgmltag>email</sgmltag> with a Hyperlink</title>
+ <title><tag>email</tag> with a Hyperlink</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>An email address that does not actually exist, like
- <sgmltag class="starttag">email</sgmltag>notreal@example.com<sgmltag class="endtag">email</sgmltag>, can be used as an
- example.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>An email address that does not actually exist, like
+ <tag class="starttag">email</tag>notreal@example.com<tag class="endtag">email</tag>, can be used as an
+ example.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1863,13 +1852,13 @@ This is the file called 'foo2'</screen>
address.</para>
<example>
- <title><sgmltag>email</sgmltag> Without a Hyperlink</title>
+ <title><tag>email</tag> Without a Hyperlink</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Sometimes a link to an email address like
- <sgmltag class="starttag">email role="nolink"</sgmltag>notreal@example.com<sgmltag class="endtag">email</sgmltag> is not
- desired.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>Sometimes a link to an email address like
+ <tag class="starttag">email role="nolink"</tag>notreal@example.com<tag class="endtag">email</tag> is not
+ desired.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1879,7 +1868,7 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-describing-makefiles">
+ <sect2 xml:id="docbook-markup-describing-makefiles">
<title>Describing <filename>Makefile</filename>s</title>
<note>
@@ -1891,57 +1880,57 @@ This is the file called 'foo2'</screen>
</note>
<para>Two elements exist to describe parts of
- <filename>Makefile</filename>s, <sgmltag>maketarget</sgmltag>
- and <sgmltag>makevar</sgmltag>.</para>
+ <filename>Makefile</filename>s, <tag>maketarget</tag>
+ and <tag>makevar</tag>.</para>
- <para><sgmltag>maketarget</sgmltag> identifies a build target
+ <para><tag>maketarget</tag> identifies a build target
exported by a <filename>Makefile</filename> that can be
given as a parameter to <command>make</command>.
- <sgmltag>makevar</sgmltag> identifies a variable that can be
+ <tag>makevar</tag> identifies a variable that can be
set (in the environment, on the command line with
<command>make</command>, or within the
<filename>Makefile</filename>) to influence the
process.</para>
<example>
- <title><sgmltag>maketarget</sgmltag> and
- <sgmltag>makevar</sgmltag></title>
+ <title><tag>maketarget</tag> and
+ <tag>makevar</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Two common targets in a <sgmltag class="starttag">filename</sgmltag>Makefile<sgmltag class="endtag">filename</sgmltag>
- are <sgmltag class="starttag">maketarget</sgmltag>all<sgmltag class="endtag">maketarget</sgmltag> and
- <sgmltag class="starttag">maketarget</sgmltag>clean<sgmltag class="endtag">maketarget</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>Two common targets in a <tag class="starttag">filename</tag>Makefile<tag class="endtag">filename</tag>
+ are <tag class="starttag">maketarget</tag>all<tag class="endtag">maketarget</tag> and
+ <tag class="starttag">maketarget</tag>clean<tag class="endtag">maketarget</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>Typically, invoking <sgmltag class="starttag">maketarget</sgmltag>all<sgmltag class="endtag">maketarget</sgmltag> will
+<tag class="starttag">para</tag>Typically, invoking <tag class="starttag">maketarget</tag>all<tag class="endtag">maketarget</tag> will
rebuild the application, and invoking
- <sgmltag class="starttag">maketarget</sgmltag>clean<sgmltag class="endtag">maketarget</sgmltag> will remove the temporary
- files (<sgmltag class="starttag">filename</sgmltag>.o<sgmltag class="endtag">filename</sgmltag> for example) created by the
- build process.<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">maketarget</tag>clean<tag class="endtag">maketarget</tag> will remove the temporary
+ files (<tag class="starttag">filename</tag>.o<tag class="endtag">filename</tag> for example) created by the
+ build process.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag><sgmltag class="starttag">maketarget</sgmltag>clean<sgmltag class="endtag">maketarget</sgmltag> may be controlled by a
- number of variables, including <sgmltag class="starttag">makevar</sgmltag>CLOBBER<sgmltag class="endtag">makevar</sgmltag>
- and <sgmltag class="starttag">makevar</sgmltag>RECURSE<sgmltag class="endtag">makevar</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+<tag class="starttag">para</tag><tag class="starttag">maketarget</tag>clean<tag class="endtag">maketarget</tag> may be controlled by a
+ number of variables, including <tag class="starttag">makevar</tag>CLOBBER<tag class="endtag">makevar</tag>
+ and <tag class="starttag">makevar</tag>RECURSE<tag class="endtag">makevar</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
<para>Two common targets in a <filename>Makefile</filename>
- are <maketarget>all</maketarget> and
- <maketarget>clean</maketarget>.</para>
+ are <buildtarget>all</buildtarget> and
+ <buildtarget>clean</buildtarget>.</para>
- <para>Typically, invoking <maketarget>all</maketarget> will
+ <para>Typically, invoking <buildtarget>all</buildtarget> will
rebuild the application, and invoking
- <maketarget>clean</maketarget> will remove the temporary
+ <buildtarget>clean</buildtarget> will remove the temporary
files (<filename>.o</filename> for example) created by the
build process.</para>
- <para><maketarget>clean</maketarget> may be controlled by a
- number of variables, including <makevar>CLOBBER</makevar>
- and <makevar>RECURSE</makevar>.</para>
+ <para><buildtarget>clean</buildtarget> may be controlled by a
+ number of variables, including <varname>CLOBBER</varname>
+ and <varname>RECURSE</varname>.</para>
</example>
</sect2>
- <sect2 id="docbook-markup-literal-text">
+ <sect2 xml:id="docbook-markup-literal-text">
<title>Literal Text</title>
<para>Literal text, or text which should be entered verbatim, is
@@ -1949,25 +1938,25 @@ This is the file called 'foo2'</screen>
from another file, or which should be copied exactly as shown
from the documentation into another file.</para>
- <para>Some of the time, <sgmltag>programlisting</sgmltag> will
+ <para>Some of the time, <tag>programlisting</tag> will
be sufficient to denote this text. But
- <sgmltag>programlisting</sgmltag> is not always appropriate,
+ <tag>programlisting</tag> is not always appropriate,
particularly when you want to include a portion of a file
<quote>in-line</quote> with the rest of the
paragraph.</para>
<para>On these occasions, use
- <sgmltag>literal</sgmltag>.</para>
+ <tag>literal</tag>.</para>
<example>
- <title><sgmltag>literal</sgmltag></title>
+ <title><tag>literal</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>The <sgmltag class="starttag">literal</sgmltag>maxusers 10<sgmltag class="endtag">literal</sgmltag> line in the kernel
+ <programlisting><tag class="starttag">para</tag>The <tag class="starttag">literal</tag>maxusers 10<tag class="endtag">literal</tag> line in the kernel
configuration file determines the size of many system tables, and is
a rough guide to how many simultaneous logins the system will
- support.<sgmltag class="endtag">para</sgmltag></programlisting>
+ support.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1978,7 +1967,7 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-replaceable">
+ <sect2 xml:id="docbook-markup-replaceable">
<title>Showing Items That the User <emphasis>Must</emphasis>
Fill In</title>
@@ -1987,45 +1976,45 @@ This is the file called 'foo2'</screen>
cannot simply copy the example provided. Instead, they
must supply some information themselves.</para>
- <para><sgmltag>replaceable</sgmltag> is designed for this
+ <para><tag>replaceable</tag> is designed for this
eventuality. Use it <emphasis>inside</emphasis> other
elements to indicate parts of that element's content that
the user must replace.</para>
<example>
- <title><sgmltag>replaceable</sgmltag></title>
+ <title><tag>replaceable</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">screen</sgmltag>&amp;prompt.user; <sgmltag class="starttag">userinput</sgmltag>man <sgmltag class="starttag">replaceable</sgmltag>command<sgmltag class="endtag">replaceable</sgmltag><sgmltag class="endtag">userinput</sgmltag><sgmltag class="endtag">screen</sgmltag></programlisting>
+ <programlisting><tag class="starttag">screen</tag>&amp;prompt.user; <tag class="starttag">userinput</tag>man <tag class="starttag">replaceable</tag>command<tag class="endtag">replaceable</tag><tag class="endtag">userinput</tag><tag class="endtag">screen</tag></programlisting>
<para>Appearance:</para>
<informalexample>
- <screen>&prompt.user; <userinput>man <replaceable>command</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>man command</userinput></screen>
</informalexample>
- <para><sgmltag>replaceable</sgmltag> can be used in many
- different elements, including <sgmltag>literal</sgmltag>.
- This example also shows that <sgmltag>replaceable</sgmltag>
+ <para><tag>replaceable</tag> can be used in many
+ different elements, including <tag>literal</tag>.
+ This example also shows that <tag>replaceable</tag>
should only be wrapped around the content that the user
<emphasis>is</emphasis> meant to provide. The other content
should be left alone.</para>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>The <sgmltag class="starttag">literal</sgmltag>maxusers <sgmltag class="starttag">replaceable</sgmltag>n<sgmltag class="endtag">replaceable</sgmltag><sgmltag class="endtag">literal</sgmltag>
+ <programlisting><tag class="starttag">para</tag>The <tag class="starttag">literal</tag>maxusers <tag class="starttag">replaceable</tag>n<tag class="endtag">replaceable</tag><tag class="endtag">literal</tag>
line in the kernel configuration file determines the size of many system
tables, and is a rough guide to how many simultaneous logins the system will
- support.<sgmltag class="endtag">para</sgmltag>
+ support.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>For a desktop workstation, <sgmltag class="starttag">literal</sgmltag>32<sgmltag class="endtag">literal</sgmltag> is a good value
- for <sgmltag class="starttag">replaceable</sgmltag>n<sgmltag class="endtag">replaceable</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+<tag class="starttag">para</tag>For a desktop workstation, <tag class="starttag">literal</tag>32<tag class="endtag">literal</tag> is a good value
+ for <tag class="starttag">replaceable</tag>n<tag class="endtag">replaceable</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
<para>The
- <literal>maxusers <replaceable>n</replaceable></literal>
+ <literal>maxusers n</literal>
line in the kernel configuration file determines the size
of many system tables, and is a rough guide to how many
simultaneous logins the system will support.</para>
@@ -2035,22 +2024,22 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-gui-buttons">
+ <sect2 xml:id="docbook-markup-gui-buttons">
<title>Showing <acronym>GUI</acronym> Buttons</title>
<para>Buttons presented by a graphical user interface are marked
- with <sgmltag>guibutton</sgmltag>. To make the text look more
+ with <tag>guibutton</tag>. To make the text look more
like a graphical button, brackets and non-breaking spaces are
added surrounding the text.</para>
<example>
- <title><sgmltag>guibutton</sgmltag></title>
+ <title><tag>guibutton</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Edit the file, then click
- <sgmltag class="starttag">guibutton</sgmltag>[&amp;nbsp;Save&amp;nbsp;]<sgmltag class="endtag">guibutton</sgmltag> to save the
- changes.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>Edit the file, then click
+ <tag class="starttag">guibutton</tag>[&amp;nbsp;Save&amp;nbsp;]<tag class="endtag">guibutton</tag> to save the
+ changes.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -2060,19 +2049,19 @@ This is the file called 'foo2'</screen>
</example>
</sect2>
- <sect2 id="docbook-markup-system-errors">
+ <sect2 xml:id="docbook-markup-system-errors">
<title>Quoting System Errors</title>
<para>System errors generated by &os; are marked with
- <sgmltag>errorname</sgmltag>. This indicates the exact error
+ <tag>errorname</tag>. This indicates the exact error
that appears.</para>
<example>
- <title><sgmltag>errorname</sgmltag></title>
+ <title><tag>errorname</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">screen</sgmltag><sgmltag class="starttag">errorname</sgmltag>Panic: cannot mount root<sgmltag class="endtag">errorname</sgmltag><sgmltag class="endtag">screen</sgmltag></programlisting>
+ <programlisting><tag class="starttag">screen</tag><tag class="starttag">errorname</tag>Panic: cannot mount root<tag class="endtag">errorname</tag><tag class="endtag">screen</tag></programlisting>
<para>Appearance:</para>
@@ -2083,7 +2072,7 @@ This is the file called 'foo2'</screen>
</sect2>
</sect1>
- <sect1 id="docbook-markup-images">
+ <sect1 xml:id="docbook-markup-images">
<title>Images</title>
<important>
@@ -2092,9 +2081,9 @@ This is the file called 'foo2'</screen>
change, but that is not guaranteed.</para>
<para>To provide conversion between different image formats, the
- <filename role="package">graphics/ImageMagick</filename>
+ <package>graphics/ImageMagick</package>
port must be installed. This port is not included in the
- <filename role="package">textproc/docproj</filename> meta
+ <package>textproc/docproj</package> meta
port, and must be installed separately.</para>
<para>A good example of the use of images is the
@@ -2105,7 +2094,7 @@ This is the file called 'foo2'</screen>
in the rendered document.</para>
</important>
- <sect2 id="docbook-markup-image-formats">
+ <sect2 xml:id="docbook-markup-image-formats">
<title>Image Formats</title>
<para>Two image formats are currently supported. The type of
@@ -2143,7 +2132,7 @@ This is the file called 'foo2'</screen>
</important>
</sect2>
- <sect2 id="docbook-markup-image-file-locations">
+ <sect2 xml:id="docbook-markup-image-file-locations">
<title>Image File Locations</title>
<para>Image files can be stored in one of several locations,
@@ -2165,15 +2154,14 @@ This is the file called 'foo2'</screen>
main document directory, the subdirectory name must be
included in their paths in the
<filename>Makefile</filename> and the
- <sgmltag>imagedata</sgmltag> element.</para>
+ <tag>imagedata</tag> element.</para>
</listitem>
<listitem>
<para>In a subdirectory of
- <filename class="directory">doc/share/images</filename>
+ <filename>doc/share/images</filename>
named after the document. For example, images for the
- Handbook are stored in <filename
- class="directory">doc/share/images/books/handbook</filename>.
+ Handbook are stored in <filename>doc/share/images/books/handbook</filename>.
Images that work for multiple translations are stored in
this upper level of the documentation file tree.
Generally, these are images that can be used unchanged in
@@ -2182,21 +2170,21 @@ This is the file called 'foo2'</screen>
</itemizedlist>
</sect2>
- <sect2 id="docbook-markup-image-markup">
+ <sect2 xml:id="docbook-markup-image-markup">
<title>Image Markup</title>
<para>Images are included as part of a
- <sgmltag>mediaobject</sgmltag>. The
- <sgmltag>mediaobject</sgmltag> can contain other, more
+ <tag>mediaobject</tag>. The
+ <tag>mediaobject</tag> can contain other, more
specific objects. We are concerned with two, the
- <sgmltag>imageobject</sgmltag> and the
- <sgmltag>textobject</sgmltag>.</para>
+ <tag>imageobject</tag> and the
+ <tag>textobject</tag>.</para>
- <para>Include one <sgmltag>imageobject</sgmltag>, and two
- <sgmltag>textobject</sgmltag> elements. The
- <sgmltag>imageobject</sgmltag> will point to the name of the
+ <para>Include one <tag>imageobject</tag>, and two
+ <tag>textobject</tag> elements. The
+ <tag>imageobject</tag> will point to the name of the
image file without the extension. The
- <sgmltag>textobject</sgmltag> elements contain information
+ <tag>textobject</tag> elements contain information
that will be presented to the user as well as, or instead of,
the image itself.</para>
@@ -2212,26 +2200,26 @@ This is the file called 'foo2'</screen>
<filename>fig1.png</filename> in a document. The image is a
rectangle with an A inside it:</para>
- <programlisting><sgmltag class="starttag">mediaobject</sgmltag>
- <sgmltag class="starttag">imageobject</sgmltag>
- <sgmltag class="starttag">imagedata fileref="fig1"</sgmltag> <co id="co-image-ext"/>
- <sgmltag class="endtag">imageobject</sgmltag>
+ <programlisting><tag class="starttag">mediaobject</tag>
+ <tag class="starttag">imageobject</tag>
+ <tag class="starttag">imagedata fileref="fig1"</tag> <co xml:id="co-image-ext"/>
+ <tag class="endtag">imageobject</tag>
- <sgmltag class="starttag">textobject</sgmltag>
- <sgmltag class="starttag">literallayout class="monospaced"</sgmltag>+---------------+ <co id="co-image-literal"/>
+ <tag class="starttag">textobject</tag>
+ <tag class="starttag">literallayout class="monospaced"</tag>+---------------+ <co xml:id="co-image-literal"/>
| A |
-+---------------+<sgmltag class="endtag">literallayout</sgmltag>
- <sgmltag class="endtag">textobject</sgmltag>
++---------------+<tag class="endtag">literallayout</tag>
+ <tag class="endtag">textobject</tag>
- <sgmltag class="starttag">textobject</sgmltag>
- <sgmltag class="starttag">phrase</sgmltag>A picture<sgmltag class="endtag">phrase</sgmltag> <co id="co-image-phrase"/>
- <sgmltag class="endtag">textobject</sgmltag>
-<sgmltag class="endtag">mediaobject</sgmltag></programlisting>
+ <tag class="starttag">textobject</tag>
+ <tag class="starttag">phrase</tag>A picture<tag class="endtag">phrase</tag> <co xml:id="co-image-phrase"/>
+ <tag class="endtag">textobject</tag>
+<tag class="endtag">mediaobject</tag></programlisting>
<calloutlist>
<callout arearefs="co-image-ext">
- <para>Include an <sgmltag>imagedata</sgmltag> element
- inside the <sgmltag>imageobject</sgmltag> element. The
+ <para>Include an <tag>imagedata</tag> element
+ inside the <tag>imageobject</tag> element. The
<literal>fileref</literal> attribute should contain the
filename of the image to include, without the extension.
The stylesheets will work out which extension should be
@@ -2240,8 +2228,8 @@ This is the file called 'foo2'</screen>
<callout arearefs="co-image-literal">
- <para>The first <sgmltag>textobject</sgmltag> contains a
- <sgmltag>literallayout</sgmltag> element, where the
+ <para>The first <tag>textobject</tag> contains a
+ <tag>literallayout</tag> element, where the
<literal>class</literal> attribute is set to
<literal>monospaced</literal>. This is an opportunity to
demonstrate <acronym>ASCII</acronym> art skills. This
@@ -2249,14 +2237,14 @@ This is the file called 'foo2'</screen>
text.</para>
<para>Notice how the first and last lines of the content
- of the <sgmltag>literallayout</sgmltag> element butt up
+ of the <tag>literallayout</tag> element butt up
next to the element's tags. This ensures no extraneous
white space is included.</para>
</callout>
<callout arearefs="co-image-phrase">
- <para>The second <sgmltag>textobject</sgmltag> contains a
- single <sgmltag>phrase</sgmltag> element. The contents of
+ <para>The second <tag>textobject</tag> contains a
+ single <tag>phrase</tag> element. The contents of
this phrase will become the <literal>alt</literal>
attribute for the image when this document is converted to
<acronym>HTML</acronym>.</para>
@@ -2264,11 +2252,11 @@ This is the file called 'foo2'</screen>
</calloutlist>
</sect2>
- <sect2 id="docbook-markup-image-makefile-entries">
+ <sect2 xml:id="docbook-markup-image-makefile-entries">
<title>Image <filename>Makefile</filename> Entries</title>
<para>Images must be listed in the <filename>Makefile</filename>
- in the <makevar>IMAGES</makevar> variable. This variable must
+ in the <varname>IMAGES</varname> variable. This variable must
contain the names of all the <emphasis>source</emphasis>
images. For example, if there are three figures,
<filename>fig1.eps</filename>, <filename>fig2.png</filename>,
@@ -2294,12 +2282,11 @@ IMAGES+= fig3.png
provided.</para>
</sect2>
- <sect2 id="docbook-markup-images-in-subdirectories">
+ <sect2 xml:id="docbook-markup-images-in-subdirectories">
<title>Images and Chapters in Subdirectories</title>
<para>Be careful when separating documentation into smaller
- files in different directories (see <xref
- linkend="xml-primer-include-using-gen-entities"/>).</para>
+ files in different directories (see <xref linkend="xml-primer-include-using-gen-entities"/>).</para>
<para>Suppose there is a book with three chapters, and the
chapters are stored in their own directories, called
@@ -2313,10 +2300,10 @@ IMAGES+= fig3.png
<filename>chapter3/</filename>).</para>
<para>However, doing this requires including the directory
- names in the <makevar>IMAGES</makevar> variable in the
+ names in the <varname>IMAGES</varname> variable in the
<filename>Makefile</filename>, <emphasis>and</emphasis>
including the directory name in the
- <sgmltag>imagedata</sgmltag> element in the document
+ <tag>imagedata</tag> element in the document
document.</para>
<para>For example, if the book has
@@ -2324,14 +2311,14 @@ IMAGES+= fig3.png
<filename>chapter1/chapter.xml</filename> should
contain:</para>
- <programlisting><sgmltag class="starttag">mediaobject</sgmltag>
- <sgmltag class="starttag">imageobject</sgmltag>
- <sgmltag class="emptytag">imagedata fileref="chapter1/fig1"</sgmltag> <co id="co-image-dir"/>
- <sgmltag class="endtag">imageobject</sgmltag>
+ <programlisting><tag class="starttag">mediaobject</tag>
+ <tag class="starttag">imageobject</tag>
+ <tag class="emptytag">imagedata fileref="chapter1/fig1"</tag> <co xml:id="co-image-dir"/>
+ <tag class="endtag">imageobject</tag>
&hellip;
-<sgmltag class="endtag">mediaobject</sgmltag></programlisting>
+<tag class="endtag">mediaobject</tag></programlisting>
<calloutlist>
<callout arearefs="co-image-dir">
@@ -2348,14 +2335,14 @@ IMAGES= chapter1/fig1.png
</sect2>
</sect1>
- <sect1 id="docbook-markup-links">
+ <sect1 xml:id="docbook-markup-links">
<title>Links</title>
<note>
<para>Links are also in-line elements.</para>
</note>
- <sect2 id="docbook-markup-links-ids">
+ <sect2 xml:id="docbook-markup-links-ids">
<title><literal>id</literal> Attributes</title>
<para>Most DocBook elements accept an <literal>id</literal>
@@ -2375,18 +2362,18 @@ IMAGES= chapter1/fig1.png
<title><literal>id</literal> on Chapters and
Sections</title>
- <programlisting><sgmltag class="starttag">chapter id="introduction"</sgmltag>
- <sgmltag class="starttag">title</sgmltag>Introduction<sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">chapter id="introduction"</tag>
+ <tag class="starttag">title</tag>Introduction<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>This is the introduction. It contains a subsection,
- which is identified as well.<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">para</tag>This is the introduction. It contains a subsection,
+ which is identified as well.<tag class="endtag">para</tag>
- <sgmltag class="starttag">sect1 id="introduction-moredetails"</sgmltag>
- <sgmltag class="starttag">title</sgmltag>More Details<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect1 id="introduction-moredetails"</tag>
+ <tag class="starttag">title</tag>More Details<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>This is a subsection.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">sect1</sgmltag>
-<sgmltag class="endtag">chapter</sgmltag></programlisting>
+ <tag class="starttag">para</tag>This is a subsection.<tag class="endtag">para</tag>
+ <tag class="endtag">sect1</tag>
+<tag class="endtag">chapter</tag></programlisting>
</example>
<para>Use descriptive values for <literal>id</literal> names.
@@ -2401,40 +2388,40 @@ IMAGES= chapter1/fig1.png
<para>To allow the user to jump into a specific portion of the
document, even in the middle of a paragraph or an example, use
- <sgmltag>anchor</sgmltag>. This element has no content, but
+ <tag>anchor</tag>. This element has no content, but
takes an <literal>id</literal> attribute.</para>
<example>
- <title><sgmltag>anchor</sgmltag></title>
+ <title><tag>anchor</tag></title>
- <programlisting><sgmltag class="starttag">para</sgmltag>This paragraph has an embedded
- <sgmltag class="emptytag">anchor id="para1"</sgmltag>link target in it. It will not
- show up in the document.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>This paragraph has an embedded
+ <tag class="emptytag">anchor id="para1"</tag>link target in it. It will not
+ show up in the document.<tag class="endtag">para</tag></programlisting>
</example>
</sect2>
- <sect2 id="docbook-markup-links-crossreferences">
+ <sect2 xml:id="docbook-markup-links-crossreferences">
<title>Crossreferences with <literal>xref</literal></title>
- <para><sgmltag>xref</sgmltag> provides the reader with a link to
+ <para><tag>xref</tag> provides the reader with a link to
jump to another section of the document. The target
<literal>id</literal> is specified in the
<literal>linkend</literal> attribute, and
- <sgmltag>xref</sgmltag> generates the link text
+ <tag>xref</tag> generates the link text
automatically.</para>
<example>
- <title>Using <sgmltag>xref</sgmltag></title>
+ <title>Using <tag>xref</tag></title>
<para>Assume that this fragment appears somewhere in a
document that includes the <literal>id</literal>
example shown above:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>More information can be found
- in <sgmltag class="emptytag">xref linkend="introduction"</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>More information can be found
+ in <tag class="emptytag">xref linkend="introduction"</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>More specific information can be found
- in <sgmltag class="emptytag">xref linkend="introduction-moredetails"</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+<tag class="starttag">para</tag>More specific information can be found
+ in <tag class="emptytag">xref linkend="introduction-moredetails"</tag>.<tag class="endtag">para</tag></programlisting>
<para>The link text will be generated automatically, looking
like (<emphasis>emphasized</emphasis> text indicates the
@@ -2455,16 +2442,16 @@ IMAGES= chapter1/fig1.png
elements.</para>
<note>
- <para><sgmltag>xref</sgmltag> cannot link to an
+ <para><tag>xref</tag> cannot link to an
<literal>id</literal> attribute on an
- <sgmltag>anchor</sgmltag> element. The
- <sgmltag>anchor</sgmltag> has no content, so the
- <sgmltag>xref</sgmltag> cannot generate the link
+ <tag>anchor</tag> element. The
+ <tag>anchor</tag> has no content, so the
+ <tag>xref</tag> cannot generate the link
text.</para>
</note>
</sect2>
- <sect2 id="docbook-markup-links-to-same-or-web-documents">
+ <sect2 xml:id="docbook-markup-links-to-same-or-web-documents">
<title>Linking to the Same Document or Other Documents on the
Web</title>
@@ -2477,28 +2464,28 @@ IMAGES= chapter1/fig1.png
text is not descriptive enough, the reader may not be able to
locate the linked section.</para>
- <sect3 id="docbook-markup-links-to-same-document">
+ <sect3 xml:id="docbook-markup-links-to-same-document">
<title>Links to the Same Document</title>
- <para><sgmltag>link</sgmltag> is used to create a link
+ <para><tag>link</tag> is used to create a link
within the same document. The target <literal>id</literal>
is specified in the <literal>linkend</literal> attribute.
This element wraps content, which is used for the link
text.</para>
<example>
- <title>Using <sgmltag>link</sgmltag></title>
+ <title>Using <tag>link</tag></title>
<para>Assume that this fragment appears somewhere in a
document that includes the <literal>id</literal>
example.</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>More information can be found in the
- <sgmltag class="starttag">link linkend="introduction"</sgmltag>sample introduction<sgmltag class="endtag">link</sgmltag>.<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>More information can be found in the
+ <tag class="starttag">link linkend="introduction"</tag>sample introduction<tag class="endtag">link</tag>.<tag class="endtag">para</tag>
-<sgmltag class="starttag">para</sgmltag>More specific information can be found in the
- <sgmltag class="starttag">link linkend="introduction-moredetails"</sgmltag>sample introduction with more
- details<sgmltag class="endtag">link</sgmltag> section.<sgmltag class="endtag">para</sgmltag></programlisting>
+<tag class="starttag">para</tag>More specific information can be found in the
+ <tag class="starttag">link linkend="introduction-moredetails"</tag>sample introduction with more
+ details<tag class="endtag">link</tag> section.<tag class="endtag">para</tag></programlisting>
<para>This output will be generated
(<emphasis>emphasized</emphasis> text is used to show the
@@ -2515,25 +2502,25 @@ IMAGES= chapter1/fig1.png
</example>
<note>
- <para><sgmltag>link</sgmltag> can be used to include links
+ <para><tag>link</tag> can be used to include links
to the <literal>id</literal> of an
- <sgmltag>anchor</sgmltag> element, since the
- <sgmltag>link</sgmltag> content defines the link
+ <tag>anchor</tag> element, since the
+ <tag>link</tag> content defines the link
text.</para>
</note>
</sect3>
- <sect3 id="docbook-markup-links-to-web-documents">
+ <sect3 xml:id="docbook-markup-links-to-web-documents">
<title>Linking to Other Documents on the Web</title>
- <para>The <sgmltag>ulink</sgmltag> is used to link to
+ <para>The <tag>ulink</tag> is used to link to
external documents on the web. The <literal>url</literal>
attribute is the <acronym>URL</acronym> of the page that the
link points to, and the content of the element is the text
that will be displayed for the user to activate.</para>
<example>
- <title><sgmltag>ulink</sgmltag> to a &os; Documentation Web
+ <title><tag>ulink</tag> to a &os; Documentation Web
Page</title>
<para>Link to the book or article <acronym>URL</acronym>
@@ -2547,81 +2534,76 @@ IMAGES= chapter1/fig1.png
<para>Usage for book links:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Read the <sgmltag class="starttag">ulink
- url="&amp;url.books.handbook;/svn.html#svn-intro"</sgmltag>SVN
- introduction<sgmltag class="endtag">ulink</sgmltag>, then pick the nearest mirror from
- the list of <sgmltag class="starttag">ulink
- url="&amp;url.books.handbook;/svn-mirrors.html"</sgmltag>Subversion
- mirror sites<sgmltag class="endtag">ulink</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>Read the <tag class="starttag">ulink
+ url="&amp;url.books.handbook;/svn.html#svn-intro"</tag>SVN
+ introduction<tag class="endtag">ulink</tag>, then pick the nearest mirror from
+ the list of <tag class="starttag">ulink
+ url="&amp;url.books.handbook;/svn-mirrors.html"</tag>Subversion
+ mirror sites<tag class="endtag">ulink</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
- <para>Read the <ulink
- url="&url.books.handbook;/svn.html#svn-intro">SVN
- introduction</ulink>, then pick the nearest mirror from
- the list of <ulink
- url="&url.books.handbook;/svn-mirrors.html">Subversion
- mirror sites</ulink>.</para>
+ <para>Read the <link xlink:href="&url.books.handbook;/svn.html#svn-intro">SVN
+ introduction</link>, then pick the nearest mirror from
+ the list of <link xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion
+ mirror sites</link>.</para>
<para>Usage for article links:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Read this
- <sgmltag class="starttag">ulink url="&amp;url.articles.bsdl-gpl;"</sgmltag>article
- about the BSD license<sgmltag class="endtag">ulink</sgmltag>, or just the
- <sgmltag class="starttag">ulink url="&amp;url.articles.bsdl-gpl;#intro"</sgmltag>introduction<sgmltag class="endtag">ulink</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>Read this
+ <tag class="starttag">ulink url="&amp;url.articles.bsdl-gpl;"</tag>article
+ about the BSD license<tag class="endtag">ulink</tag>, or just the
+ <tag class="starttag">ulink url="&amp;url.articles.bsdl-gpl;#intro"</tag>introduction<tag class="endtag">ulink</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
- <para>Read this <ulink url="&url.articles.bsdl-gpl;">article
- about the BSD license</ulink>, or just the <ulink
- url="&url.articles.bsdl-gpl;#intro">introduction</ulink>.</para>
+ <para>Read this <link xlink:href="&url.articles.bsdl-gpl;">article
+ about the BSD license</link>, or just the <link xlink:href="&url.articles.bsdl-gpl;#intro">introduction</link>.</para>
</example>
<example>
- <title><sgmltag>ulink</sgmltag> to a &os; Web Page</title>
+ <title><tag>ulink</tag> to a &os; Web Page</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Of course, you could stop reading this document and go to the
- <sgmltag class="starttag">ulink url="&amp;url.base;/index.html"</sgmltag>FreeBSD home page<sgmltag class="endtag">ulink</sgmltag> instead.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>Of course, you could stop reading this document and go to the
+ <tag class="starttag">ulink url="&amp;url.base;/index.html"</tag>FreeBSD home page<tag class="endtag">ulink</tag> instead.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
<para>Of course, you could stop reading this document and go
- to the <ulink url="&url.base;/index.html">FreeBSD home
- page</ulink> instead.</para>
+ to the <link xlink:href="&url.base;/index.html">FreeBSD home
+ page</link> instead.</para>
</example>
<example>
- <title><sgmltag>ulink</sgmltag> to an External Web
+ <title><tag>ulink</tag> to an External Web
Page</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Wikipedia has an excellent reference on
- <sgmltag class="starttag">ulink
- url="http://en.wikipedia.org/wiki/GUID_Partition_Table"</sgmltag>GUID
- Partition Tables<sgmltag class="endtag">ulink</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>Wikipedia has an excellent reference on
+ <tag class="starttag">ulink
+ url="http://en.wikipedia.org/wiki/GUID_Partition_Table"</tag>GUID
+ Partition Tables<tag class="endtag">ulink</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
<para>Wikipedia has an excellent reference on
- <ulink
- url="http://en.wikipedia.org/wiki/GUID_Partition_Table">GUID
- Partition Tables</ulink>.</para>
+ <link xlink:href="http://en.wikipedia.org/wiki/GUID_Partition_Table">GUID
+ Partition Tables</link>.</para>
<para>The link text can be omitted to show the actual
URL:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>Wikipedia has an excellent reference on
- GUID Partition Tables: <sgmltag class="starttag">ulink
- url="http://en.wikipedia.org/wiki/GUID_Partition_Table"</sgmltag><sgmltag class="endtag">ulink</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>Wikipedia has an excellent reference on
+ GUID Partition Tables: <tag class="starttag">ulink
+ url="http://en.wikipedia.org/wiki/GUID_Partition_Table"</tag><tag class="endtag">ulink</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
<para>Wikipedia has an excellent reference on
- GUID Partition Tables: <ulink
- url="http://en.wikipedia.org/wiki/GUID_Partition_Table"></ulink>.</para>
+ GUID Partition Tables: <uri xlink:href="http://en.wikipedia.org/wiki/GUID_Partition_Table">http://en.wikipedia.org/wiki/GUID_Partition_Table</uri>.</para>
</example>
</sect3>
</sect2>
diff --git a/en_US.ISO8859-1/books/fdp-primer/editor-config/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/editor-config/chapter.xml
index 485ec0a3b1..2f41229243 100644
--- a/en_US.ISO8859-1/books/fdp-primer/editor-config/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/editor-config/chapter.xml
@@ -27,19 +27,18 @@
$FreeBSD$
-->
-
-<chapter id="editor-config">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="editor-config">
<title>Editor Configuration</title>
<para>Adjusting text editor configuration can make working on
document files quicker and easier, and help documents conform to
<acronym>FDP</acronym> guidelines.</para>
- <sect1 id="editor-config-vim">
+ <sect1 xml:id="editor-config-vim">
<title><application>Vim</application></title>
- <para>Install from <filename role="package">editors/vim</filename>
- or <filename role="package">editors/vim-lite</filename>.</para>
+ <para>Install from <package>editors/vim</package>
+ or <package>editors/vim-lite</package>.</para>
<para>Edit <filename>~/.vimrc</filename>, adding these
lines:</para>
@@ -55,12 +54,12 @@ augroup END</programlisting>
</sect1>
- <sect1 id="editor-config-emacs">
+ <sect1 xml:id="editor-config-emacs">
<title><application>Emacs</application></title>
<para>Install from
- <filename role="package">editors/emacs</filename>
- or <filename role="package">editors/xemacs</filename>.</para>
+ <package>editors/emacs</package>
+ or <package>editors/xemacs</package>.</para>
<para>Edit <filename>~/.emacs</filename>, adding these
lines:</para>
@@ -77,14 +76,14 @@ augroup END</programlisting>
'(lambda () (local-psgml-mode-hook)))</programlisting>
</sect1>
- <sect1 id="editor-config-nano">
+ <sect1 xml:id="editor-config-nano">
<title><application>nano</application></title>
<para>Install from
- <filename role="package">editors/nano</filename> or
- <filename role="package">editors/nano-devel</filename>.</para>
+ <package>editors/nano</package> or
+ <package>editors/nano-devel</package>.</para>
- <sect2 id="editor-config-nano-config">
+ <sect2 xml:id="editor-config-nano-config">
<title>Configuration</title>
<para>Copy the sample <acronym>XML</acronym> syntax highlight
@@ -112,13 +111,13 @@ color ,yellow "^(.{71})|(TAB.{63})|(TAB{2}.{55})|(TAB{3}.{47}).+$"</programlisti
<screen>&prompt.user; <userinput>perl -i'' -pe 's/TAB/\t/g' ~/.nanorc</userinput></screen>
</sect2>
- <sect2 id="editor-config-nano-use">
+ <sect2 xml:id="editor-config-nano-use">
<title>Use</title>
<para>Specify additional helpful options when running the
editor:</para>
- <screen>&prompt.user; <userinput>nano -AKipwz -r 70 -T8 <replaceable>chapter.xml</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>nano -AKipwz -r 70 -T8 chapter.xml</userinput></screen>
<para>Users of &man.csh.1; can define an alias in
<filename>~/.cshrc</filename> to automate these
@@ -129,7 +128,7 @@ color ,yellow "^(.{71})|(TAB.{63})|(TAB{2}.{55})|(TAB{3}.{47}).+$"</programlisti
<para>After the alias is defined, the options will be added
automatically:</para>
- <screen>&prompt.user; <userinput>nano <replaceable>chapter.xml</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>nano chapter.xml</userinput></screen>
</sect2>
</sect1>
</chapter>
diff --git a/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml b/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml
index f8a98e33fc..6b6ea42ca9 100644
--- a/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/examples/appendix.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<appendix id="examples">
+<appendix xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="examples">
<title>Examples</title>
<para>This appendix contains example <acronym>XML</acronym> files
@@ -46,7 +45,7 @@
examine the <acronym>XML</acronym> source for this and other
documents available in the <application>svn</application>
<literal>doc</literal> repository, or available online starting at
- <ulink url="http://svnweb.FreeBSD.org/doc/"></ulink>.</para>
+ <uri xlink:href="http://svnweb.FreeBSD.org/doc/">http://svnweb.FreeBSD.org/doc/</uri>.</para>
<para>To avoid confusion, these examples use the standard DocBook
4.1 <acronym>DTD</acronym> rather than the &os; extension. They
@@ -55,106 +54,106 @@
Documentation Project. This makes them more useful as generic
DocBook examples.</para>
- <sect1 id="examples-docbook-book">
- <title>DocBook <sgmltag>book</sgmltag></title>
+ <sect1 xml:id="examples-docbook-book">
+ <title>DocBook <tag>book</tag></title>
<example>
- <title>DocBook <sgmltag>book</sgmltag></title>
+ <title>DocBook <tag>book</tag></title>
<programlisting>&lt;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"&gt;
-<sgmltag class="starttag">book lang='en'</sgmltag>
- <sgmltag class="starttag">bookinfo</sgmltag>
- <sgmltag class="starttag">title</sgmltag>An Example Book<sgmltag class="endtag">title</sgmltag>
+<tag class="starttag">book lang='en'</tag>
+ <tag class="starttag">bookinfo</tag>
+ <tag class="starttag">title</tag>An Example Book<tag class="endtag">title</tag>
- <sgmltag class="starttag">author</sgmltag>
- <sgmltag class="starttag">firstname</sgmltag>Your first name<sgmltag class="endtag">firstname</sgmltag>
- <sgmltag class="starttag">surname</sgmltag>Your surname<sgmltag class="endtag">surname</sgmltag>
- <sgmltag class="starttag">affiliation</sgmltag>
- <sgmltag class="starttag">address</sgmltag><sgmltag class="starttag">email</sgmltag>foo@example.com<sgmltag class="endtag">email</sgmltag><sgmltag class="endtag">address</sgmltag>
- <sgmltag class="endtag">affiliation</sgmltag>
- <sgmltag class="endtag">author</sgmltag>
+ <tag class="starttag">author</tag>
+ <tag class="starttag">firstname</tag>Your first name<tag class="endtag">firstname</tag>
+ <tag class="starttag">surname</tag>Your surname<tag class="endtag">surname</tag>
+ <tag class="starttag">affiliation</tag>
+ <tag class="starttag">address</tag><tag class="starttag">email</tag>foo@example.com<tag class="endtag">email</tag><tag class="endtag">address</tag>
+ <tag class="endtag">affiliation</tag>
+ <tag class="endtag">author</tag>
- <sgmltag class="starttag">copyright</sgmltag>
- <sgmltag class="starttag">year</sgmltag>2000<sgmltag class="endtag">year</sgmltag>
- <sgmltag class="starttag">holder</sgmltag>Copyright string here<sgmltag class="endtag">holder</sgmltag>
- <sgmltag class="endtag">copyright</sgmltag>
+ <tag class="starttag">copyright</tag>
+ <tag class="starttag">year</tag>2000<tag class="endtag">year</tag>
+ <tag class="starttag">holder</tag>Copyright string here<tag class="endtag">holder</tag>
+ <tag class="endtag">copyright</tag>
- <sgmltag class="starttag">abstract</sgmltag>
- <sgmltag class="starttag">para</sgmltag>If your book has an abstract then it should go here.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">abstract</sgmltag>
- <sgmltag class="endtag">bookinfo</sgmltag>
+ <tag class="starttag">abstract</tag>
+ <tag class="starttag">para</tag>If your book has an abstract then it should go here.<tag class="endtag">para</tag>
+ <tag class="endtag">abstract</tag>
+ <tag class="endtag">bookinfo</tag>
- <sgmltag class="starttag">preface</sgmltag>
- <sgmltag class="starttag">title</sgmltag>Preface<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">preface</tag>
+ <tag class="starttag">title</tag>Preface<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>Your book may have a preface, in which case it should be placed
- here.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">preface</sgmltag>
+ <tag class="starttag">para</tag>Your book may have a preface, in which case it should be placed
+ here.<tag class="endtag">para</tag>
+ <tag class="endtag">preface</tag>
- <sgmltag class="starttag">chapter</sgmltag>
- <sgmltag class="starttag">title</sgmltag>My First Chapter<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">chapter</tag>
+ <tag class="starttag">title</tag>My First Chapter<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>This is the first chapter in my book.<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">para</tag>This is the first chapter in my book.<tag class="endtag">para</tag>
- <sgmltag class="starttag">sect1</sgmltag>
- <sgmltag class="starttag">title</sgmltag>My First Section<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect1</tag>
+ <tag class="starttag">title</tag>My First Section<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>This is the first section in my book.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">sect1</sgmltag>
- <sgmltag class="endtag">chapter</sgmltag>
-<sgmltag class="endtag">book</sgmltag></programlisting>
+ <tag class="starttag">para</tag>This is the first section in my book.<tag class="endtag">para</tag>
+ <tag class="endtag">sect1</tag>
+ <tag class="endtag">chapter</tag>
+<tag class="endtag">book</tag></programlisting>
</example>
</sect1>
- <sect1 id="examples-docbook-article">
- <title>DocBook <sgmltag>article</sgmltag></title>
+ <sect1 xml:id="examples-docbook-article">
+ <title>DocBook <tag>article</tag></title>
<example>
- <title>DocBook <sgmltag>article</sgmltag></title>
+ <title>DocBook <tag>article</tag></title>
<programlisting>&lt;!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"&gt;
-<sgmltag class="starttag">article lang='en'</sgmltag>
- <sgmltag class="starttag">articleinfo</sgmltag>
- <sgmltag class="starttag">title</sgmltag>An Example Article<sgmltag class="endtag">title</sgmltag>
+<tag class="starttag">article lang='en'</tag>
+ <tag class="starttag">articleinfo</tag>
+ <tag class="starttag">title</tag>An Example Article<tag class="endtag">title</tag>
- <sgmltag class="starttag">author</sgmltag>
- <sgmltag class="starttag">firstname</sgmltag>Your first name<sgmltag class="endtag">firstname</sgmltag>
- <sgmltag class="starttag">surname</sgmltag>Your surname<sgmltag class="endtag">surname</sgmltag>
- <sgmltag class="starttag">affiliation</sgmltag>
- <sgmltag class="starttag">address</sgmltag><sgmltag class="starttag">email</sgmltag>foo@example.com<sgmltag class="endtag">email</sgmltag><sgmltag class="endtag">address</sgmltag>
- <sgmltag class="endtag">affiliation</sgmltag>
- <sgmltag class="endtag">author</sgmltag>
+ <tag class="starttag">author</tag>
+ <tag class="starttag">firstname</tag>Your first name<tag class="endtag">firstname</tag>
+ <tag class="starttag">surname</tag>Your surname<tag class="endtag">surname</tag>
+ <tag class="starttag">affiliation</tag>
+ <tag class="starttag">address</tag><tag class="starttag">email</tag>foo@example.com<tag class="endtag">email</tag><tag class="endtag">address</tag>
+ <tag class="endtag">affiliation</tag>
+ <tag class="endtag">author</tag>
- <sgmltag class="starttag">copyright</sgmltag>
- <sgmltag class="starttag">year</sgmltag>2000<sgmltag class="endtag">year</sgmltag>
- <sgmltag class="starttag">holder</sgmltag>Copyright string here<sgmltag class="endtag">holder</sgmltag>
- <sgmltag class="endtag">copyright</sgmltag>
+ <tag class="starttag">copyright</tag>
+ <tag class="starttag">year</tag>2000<tag class="endtag">year</tag>
+ <tag class="starttag">holder</tag>Copyright string here<tag class="endtag">holder</tag>
+ <tag class="endtag">copyright</tag>
- <sgmltag class="starttag">abstract</sgmltag>
- <sgmltag class="starttag">para</sgmltag>If your article has an abstract then it should go here.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">abstract</sgmltag>
- <sgmltag class="endtag">articleinfo</sgmltag>
+ <tag class="starttag">abstract</tag>
+ <tag class="starttag">para</tag>If your article has an abstract then it should go here.<tag class="endtag">para</tag>
+ <tag class="endtag">abstract</tag>
+ <tag class="endtag">articleinfo</tag>
- <sgmltag class="starttag">sect1</sgmltag>
- <sgmltag class="starttag">title</sgmltag>My First Section<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect1</tag>
+ <tag class="starttag">title</tag>My First Section<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>This is the first section in my article.<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">para</tag>This is the first section in my article.<tag class="endtag">para</tag>
- <sgmltag class="starttag">sect2</sgmltag>
- <sgmltag class="starttag">title</sgmltag>My First Sub-Section<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect2</tag>
+ <tag class="starttag">title</tag>My First Sub-Section<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>This is the first sub-section in my article.<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">sect2</sgmltag>
- <sgmltag class="endtag">sect1</sgmltag>
-<sgmltag class="endtag">article</sgmltag></programlisting>
+ <tag class="starttag">para</tag>This is the first sub-section in my article.<tag class="endtag">para</tag>
+ <tag class="endtag">sect2</tag>
+ <tag class="endtag">sect1</tag>
+<tag class="endtag">article</tag></programlisting>
</example>
</sect1>
- <sect1 id="examples-formatted">
+ <sect1 xml:id="examples-formatted">
<title>Producing Formatted Output</title>
<para>Before using these examples, install the required tools as
@@ -167,12 +166,12 @@
<title>Converting DocBook to <acronym>XHTML</acronym> (One
Large File)</title>
- <screen>&prompt.user; <userinput>jade -V nochunks \ <co id="examples-co-jade-1-nochunks"/>
- -c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co id="examples-co-jade-1-catalog"/>
+ <screen>&prompt.user; <userinput>jade -V nochunks \ <co xml:id="examples-co-jade-1-nochunks"/>
+ -c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co xml:id="examples-co-jade-1-catalog"/>
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
- -d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \<co id="examples-co-jade-1-dsssl"/>
- -t sgml <co id="examples-co-jade-1-transform"/> <replaceable>file</replaceable>.xml &gt; <replaceable>file</replaceable>.html <co id="examples-co-jade-1-filename"/></userinput></screen>
+ -d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \<co xml:id="examples-co-jade-1-dsssl"/>
+ -t sgml <co xml:id="examples-co-jade-1-transform"/> file.xml &gt; file.html <co xml:id="examples-co-jade-1-filename"/></userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-1-nochunks">
@@ -223,11 +222,11 @@
Small Files)</title>
<screen>&prompt.user; <userinput>jade \
- -c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co id="examples-co-jade-2-catalog"/>
+ -c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co xml:id="examples-co-jade-2-catalog"/>
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
- -d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \<co id="examples-co-jade-2-dsssl"/>
- -t sgml <co id="examples-co-jade-2-transform"/> <replaceable>file</replaceable>.xml <co id="examples-co-jade-2-filename"/></userinput></screen>
+ -d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \<co xml:id="examples-co-jade-2-dsssl"/>
+ -t sgml <co xml:id="examples-co-jade-2-transform"/> file.xml <co xml:id="examples-co-jade-2-filename"/></userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-2-catalog">
@@ -273,18 +272,18 @@
for splitting output.</para>
</example>
- <example id="examples-docbook-postscript">
+ <example xml:id="examples-docbook-postscript">
<title>Converting DocBook to &postscript;</title>
<para>The source <acronym>XML</acronym> file must be converted
to a &tex; file.</para>
- <screen>&prompt.user; <userinput>jade -V tex-backend \ <co id="examples-co-jade-3-tex-backend"/>
- -c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co id="examples-co-jade-3-catalog"/>
+ <screen>&prompt.user; <userinput>jade -V tex-backend \ <co xml:id="examples-co-jade-3-tex-backend"/>
+ -c /usr/local/share/xml/docbook/dsssl/modular/catalog \ <co xml:id="examples-co-jade-3-catalog"/>
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
- -d /usr/local/share/xml/docbook/dsssl/modular/print/docbook.dsl \<co id="examples-co-jade-3-dsssl"/>
- -t tex <co id="examples-co-jade-3-tex"/> <replaceable>file</replaceable>.xml</userinput></screen>
+ -d /usr/local/share/xml/docbook/dsssl/modular/print/docbook.dsl \<co xml:id="examples-co-jade-3-dsssl"/>
+ -t tex <co xml:id="examples-co-jade-3-tex"/> file.xml</userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-3-tex-backend">
@@ -320,7 +319,7 @@
run through <command>tex</command>, specifying the
<literal>&amp;jadetex</literal> macro package.</para>
- <screen>&prompt.user; <userinput>tex "&amp;jadetex" <replaceable>file</replaceable>.tex</userinput></screen>
+ <screen>&prompt.user; <userinput>tex "&amp;jadetex" file.tex</userinput></screen>
<para><command>tex</command> commands must be run
<emphasis>at least</emphasis> three times. The first run
@@ -342,12 +341,12 @@
necessary.</para>
<para>The output from this stage will be
- <filename><replaceable>file</replaceable>.dvi</filename>.</para>
+ <filename>file.dvi</filename>.</para>
<para>Finally, run <command>dvips</command> to convert the
<filename>.dvi</filename> file to &postscript;.</para>
- <screen>&prompt.user; <userinput>dvips -o <replaceable>file</replaceable>.ps <replaceable>file.dvi</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>dvips -o file.ps file.dvi</userinput></screen>
</example>
<example>
@@ -355,20 +354,19 @@
<para>The first part of this process is identical to that of
converting DocBook to &postscript;, using the same
- <command>jade</command> command line (<xref
- linkend="examples-docbook-postscript"/>).</para>
+ <command>jade</command> command line (<xref linkend="examples-docbook-postscript"/>).</para>
<para>After the <filename>.tex</filename> file has been
generated, run <application>pdfTeX</application>.
However, use the <literal>&amp;pdfjadetex</literal> macro
package instead.</para>
- <screen>&prompt.user; <userinput>pdftex "&amp;pdfjadetex" <replaceable>file</replaceable>.tex</userinput></screen>
+ <screen>&prompt.user; <userinput>pdftex "&amp;pdfjadetex" file.tex</userinput></screen>
<para>Again, run this command three times.</para>
<para>This will generate
- <filename><replaceable>file</replaceable>.pdf</filename>,
+ <filename>file.pdf</filename>,
which does not need to be processed any further.</para>
</example>
</sect2>
diff --git a/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
index 66eb8593f2..b0cf2cc198 100644
--- a/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<chapter id="overview">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="overview">
<title>Overview</title>
<para>Welcome to the &os; Documentation Project
@@ -69,7 +68,7 @@
</listitem>
</itemizedlist>
- <sect1 id="overview-doc">
+ <sect1 xml:id="overview-doc">
<title>The &os; Documentation Set</title>
<para>The <acronym>FDP</acronym> is responsible for four
@@ -101,8 +100,7 @@
<listitem>
<para><emphasis>Web site</emphasis>: This is the main &os;
- presence on the web, visible at <ulink
- url="http://www.freebsd.org/index.html">http://www.FreeBSD.org/</ulink>
+ presence on the web, visible at <link xlink:href="http://www.freebsd.org/index.html">http://www.FreeBSD.org/</link>
and many mirrors around the world. The web site is
typically a new user's first exposure to &os;.</para>
</listitem>
@@ -123,7 +121,7 @@
<para>Documentation commit messages are visible with
<command>svn log</command>. Commit messages are also
- archived at <ulink url="&a.svn-doc-all.url;"></ulink>.</para>
+ archived at <uri xlink:href="&a.svn-doc-all.url;">&a.svn-doc-all.url;</uri>.</para>
<para>Many people have written tutorials or how-to articles about
&os;. Some are stored as part of the <acronym>FDP</acronym>
@@ -133,21 +131,21 @@
possible.</para>
</sect1>
- <sect1 id="overview-quick-start">
+ <sect1 xml:id="overview-quick-start">
<title>Quick Start</title>
<para>Some preparatory steps must be taken before editing the &os;
documentation. First, subscribe to the &a.doc;. Some team
members also interact on the <literal>#bsddocs</literal>
<acronym>IRC</acronym> channel on
- <ulink url="http://www.efnet.org/">EFnet</ulink>. These people
+ <link xlink:href="http://www.efnet.org/">EFnet</link>. These people
can help with questions or problems involving the
documentation.</para>
<procedure>
<step>
<para>Install the
- <filename role="package">textproc/docproj</filename>
+ <package>textproc/docproj</package>
package or port. This meta-port installs all of the
software needed to edit and build &os; documentation.</para>
</step>
@@ -155,10 +153,10 @@
<step>
<para>Install a local working copy of the documentation from a
mirror of the &os; repository in
- <filename class="directory">~/doc</filename> (see
+ <filename>~/doc</filename> (see
<xref linkend="working-copy"/>).</para>
- <screen>&prompt.user; <userinput>svn checkout https://<replaceable>svn0.us-west.FreeBSD.org</replaceable>/doc/head <replaceable>~/doc</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc</userinput></screen>
</step>
<step>
@@ -186,7 +184,7 @@
<step>
<para>Update the local working copy:</para>
- <screen>&prompt.user; <userinput>svn up <replaceable>~/doc</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>svn up ~/doc</userinput></screen>
</step>
<step>
@@ -226,18 +224,18 @@
<quote>diff file</quote>:</para>
<screen>&prompt.user; <userinput>cd /usr/doc</userinput>
-&prompt.user; <userinput>svn diff > <replaceable>bsdinstall</replaceable>.diff.txt</userinput></screen>
+&prompt.user; <userinput>svn diff &gt; bsdinstall.diff.txt</userinput></screen>
<para>Give the diff file a descriptive name. In the example
above, changes have been made to the
- <filename class="directory">bsdinstall</filename> portion of
+ <filename>bsdinstall</filename> portion of
the Handbook.</para>
</step>
<step>
<para>Submit the diff file using the web-based
- <ulink url="&url.base;/support.html#gnats">Problem
- Report</ulink> system or with &man.send-pr.1;. If using
+ <link xlink:href="&url.base;/support.html#gnats">Problem
+ Report</link> system or with &man.send-pr.1;. If using
the web form, enter a synopsis of
<emphasis>[patch] <replaceable>short description of
problem</replaceable></emphasis>. Select the category
diff --git a/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml
index 6e8dd4ef35..03c12c8545 100644
--- a/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml
@@ -30,15 +30,14 @@
$FreeBSD$
-->
-
-<chapter id="psgml-mode">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="psgml-mode">
<title>Using <literal>sgml-mode</literal> with
<application>Emacs</application></title>
<para>Recent versions of <application>Emacs</application> or
<application>XEmacs</application> (available from the Ports
Collection) contain a very useful package called PSGML (can be
- installed from <filename role="package">editors/psgml</filename>).
+ installed from <package>editors/psgml</package>).
Automatically invoked when a file with the
<filename>.xml</filename> extension is loaded, or by typing
<command>M-x sgml-mode</command>, it is a major mode for dealing
@@ -109,7 +108,7 @@
recursively fill (i.e., reformat) content from the current
element in. The filling <emphasis>will</emphasis> affect
content in which whitespace is significant, such as within
- <sgmltag>programlisting</sgmltag> elements, so run this
+ <tag>programlisting</tag> elements, so run this
command with care.</para>
</listitem>
</varlistentry>
diff --git a/en_US.ISO8859-1/books/fdp-primer/see-also/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/see-also/chapter.xml
index 65f4df3962..88bbc9491e 100644
--- a/en_US.ISO8859-1/books/fdp-primer/see-also/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/see-also/chapter.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<chapter id="see-also">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="see-also">
<title>See Also</title>
<para>This document is deliberately not an exhaustive discussion of
@@ -39,80 +38,80 @@
more information about these, you are encouraged to see the
following web sites.</para>
- <sect1 id="see-also-fdp">
+ <sect1 xml:id="see-also-fdp">
<title>The FreeBSD Documentation Project</title>
<itemizedlist>
<listitem>
- <para><ulink url="&url.base;/docproj/index.html">The FreeBSD
- Documentation Project web pages</ulink></para>
+ <para><link xlink:href="&url.base;/docproj/index.html">The FreeBSD
+ Documentation Project web pages</link></para>
</listitem>
<listitem>
- <para><ulink url="&url.books.handbook;/index.html">The FreeBSD
- Handbook</ulink></para>
+ <para><link xlink:href="&url.books.handbook;/index.html">The FreeBSD
+ Handbook</link></para>
</listitem>
</itemizedlist>
</sect1>
- <sect1 id="see-also-xml">
+ <sect1 xml:id="see-also-xml">
<title>XML</title>
<itemizedlist>
<listitem>
- <para><ulink url="http://www.w3.org/XML/">W3C's XML page
- SGML/XML web page</ulink></para>
+ <para><link xlink:href="http://www.w3.org/XML/">W3C's XML page
+ SGML/XML web page</link></para>
</listitem>
</itemizedlist>
</sect1>
- <sect1 id="see-also-html">
+ <sect1 xml:id="see-also-html">
<title>HTML</title>
<itemizedlist>
<listitem>
- <para><ulink url="http://www.w3.org/">The World Wide Web
- Consortium</ulink></para>
+ <para><link xlink:href="http://www.w3.org/">The World Wide Web
+ Consortium</link></para>
</listitem>
<listitem>
- <para><ulink url="http://www.w3.org/TR/REC-html40/">The HTML
- 4.0 specification</ulink></para>
+ <para><link xlink:href="http://www.w3.org/TR/REC-html40/">The HTML
+ 4.0 specification</link></para>
</listitem>
</itemizedlist>
</sect1>
- <sect1 id="see-also-docbook">
+ <sect1 xml:id="see-also-docbook">
<title>DocBook</title>
<itemizedlist>
<listitem>
- <para><ulink url="http://www.oasis-open.org/docbook/">The
- DocBook Technical Committee</ulink>, maintainers of the
+ <para><link xlink:href="http://www.oasis-open.org/docbook/">The
+ DocBook Technical Committee</link>, maintainers of the
DocBook DTD</para>
</listitem>
<listitem>
- <para><ulink url="http://www.docbook.org/">DocBook: The
- Definitive Guide</ulink>, the online documentation for the
+ <para><link xlink:href="http://www.docbook.org/">DocBook: The
+ Definitive Guide</link>, the online documentation for the
DocBook DTD</para>
</listitem>
<listitem>
- <para><ulink url="http://docbook.sourceforge.net/">The DocBook
- Open Repository</ulink> contains DSSSL stylesheets and
+ <para><link xlink:href="http://docbook.sourceforge.net/">The DocBook
+ Open Repository</link> contains DSSSL stylesheets and
other resources for people using DocBook</para>
</listitem>
</itemizedlist>
</sect1>
- <sect1 id="see-also-linuxdoc">
+ <sect1 xml:id="see-also-linuxdoc">
<title>The Linux Documentation Project</title>
<itemizedlist>
<listitem>
- <para><ulink url="http://www.tldp.org/">The Linux
- Documentation Project web pages</ulink></para>
+ <para><link xlink:href="http://www.tldp.org/">The Linux
+ Documentation Project web pages</link></para>
</listitem>
</itemizedlist>
</sect1>
diff --git a/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.xml
index 6b8f2852c8..d83b9f788d 100644
--- a/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<chapter id="xml-markup">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="xml-markup">
<title>XML Markup</title>
<para>This chapter describes the two markup languages you will
@@ -63,13 +62,13 @@
line break (and other processing) when it is encountered.</para>
</note>
- <sect1 id="xml-markup-xhtml">
+ <sect1 xml:id="xml-markup-xhtml">
<title>XHTML</title>
<para>XHTML is the XML version of the HyperText Markup Language,
which is the markup language
of choice on the World Wide Web. More information can be found
- at <ulink url="http://www.w3.org/"></ulink>.</para>
+ at <uri xlink:href="http://www.w3.org/">http://www.w3.org/</uri>.</para>
<para>XHTML is used to markup pages on the FreeBSD web site. It
should not (generally) be used to mark up other documentation,
@@ -85,9 +84,8 @@
variants).</para>
<para>The XHTML DTDs are available from the Ports&nbsp;Collection
- in the <filename role="package">textproc/xhtml</filename> port.
- They are automatically installed as part of the <filename
- role="package">textproc/docproj</filename> port.</para>
+ in the <package>textproc/xhtml</package> port.
+ They are automatically installed as part of the <package>textproc/docproj</package> port.</para>
<sect2>
<title>Formal Public Identifier (FPI)</title>
@@ -112,25 +110,25 @@
second section, the <emphasis>body</emphasis>, contains the
content that will be displayed to the user.</para>
- <para>These sections are indicated with <sgmltag>head</sgmltag>
- and <sgmltag>body</sgmltag> elements respectively. These
+ <para>These sections are indicated with <tag>head</tag>
+ and <tag>body</tag> elements respectively. These
elements are contained within the top-level
- <sgmltag>html</sgmltag> element.</para>
+ <tag>html</tag> element.</para>
<example>
<title>Normal XHTML Document Structure</title>
- <programlisting>&lt;html xmlns="http://www.w3.org/1999/xhtml">
- &lt;head>
- &lt;title><replaceable>The Document's Title</replaceable>&lt;/title>
- &lt;/head>
+ <programlisting>&lt;html xmlns="http://www.w3.org/1999/xhtml"&gt;
+ &lt;head&gt;
+ &lt;title&gt;<replaceable>The Document's Title</replaceable>&lt;/title&gt;
+ &lt;/head&gt;
- &lt;body>
+ &lt;body&gt;
&hellip;
- &lt;/body>
-&lt;/html></programlisting>
+ &lt;/body&gt;
+&lt;/html&gt;</programlisting>
</example>
</sect2>
@@ -144,13 +142,13 @@
up to six different levels.</para>
<para>The largest and most prominent heading is
- <sgmltag>h1</sgmltag>, then <sgmltag>h2</sgmltag>,
- continuing down to <sgmltag>h6</sgmltag>.</para>
+ <tag>h1</tag>, then <tag>h2</tag>,
+ continuing down to <tag>h6</tag>.</para>
<para>The element's content is the text of the heading.</para>
<example>
- <title><sgmltag>h1</sgmltag>, <sgmltag>h2</sgmltag>,
+ <title><tag>h1</tag>, <tag>h2</tag>,
and Other Header Tags</title>
<para>Use:</para>
@@ -173,17 +171,17 @@
</example>
<para>Generally, an XHTML page should have one first level
- heading (<sgmltag>h1</sgmltag>). This can contain many
- second level headings (<sgmltag>h2</sgmltag>), which can in
+ heading (<tag>h1</tag>). This can contain many
+ second level headings (<tag>h2</tag>), which can in
turn contain many third level headings. Each
- <sgmltag>h<replaceable>n</replaceable></sgmltag> element
+ <tag>h<replaceable>n</replaceable></tag> element
should have the same element, but one further up the
hierarchy, preceding it. Leaving gaps in the numbering is
to be avoided.</para>
<example>
<title>Bad Ordering of
- <sgmltag>h<replaceable>n</replaceable></sgmltag>
+ <tag>h<replaceable>n</replaceable></tag>
Elements</title>
<para>Use:</para>
@@ -202,10 +200,10 @@
<title>Paragraphs</title>
<para>XHTML supports a single paragraph element,
- <sgmltag>p</sgmltag>.</para>
+ <tag>p</tag>.</para>
<example>
- <title><sgmltag>p</sgmltag></title>
+ <title><tag>p</tag></title>
<para>Use:</para>
@@ -222,7 +220,7 @@
paragraph.</para>
<example>
- <title><sgmltag>blockquote</sgmltag></title>
+ <title><tag>blockquote</tag></title>
<para>Use:</para>
@@ -250,25 +248,25 @@
term being defined, and the second section is the definition
of the term.</para>
- <para>Ordered lists are indicated by the <sgmltag>ol</sgmltag>
- element, unordered lists by the <sgmltag>ul</sgmltag>
- element, and definition lists by the <sgmltag>dl</sgmltag>
+ <para>Ordered lists are indicated by the <tag>ol</tag>
+ element, unordered lists by the <tag>ul</tag>
+ element, and definition lists by the <tag>dl</tag>
element.</para>
<para>Ordered and unordered lists contain listitems, indicated
- by the <sgmltag>li</sgmltag> element. A listitem can
+ by the <tag>li</tag> element. A listitem can
contain textual content, or it may be further wrapped in one
- or more <sgmltag>p</sgmltag> elements.</para>
+ or more <tag>p</tag> elements.</para>
<para>Definition lists contain definition terms
- (<sgmltag>dt</sgmltag>) and definition descriptions
- (<sgmltag>dd</sgmltag>). A definition term can only contain
+ (<tag>dt</tag>) and definition descriptions
+ (<tag>dd</tag>). A definition term can only contain
inline elements. A definition description can contain other
block elements.</para>
<example>
- <title><sgmltag>ul</sgmltag> and
- <sgmltag>ol</sgmltag></title>
+ <title><tag>ul</tag> and
+ <tag>ol</tag></title>
<para>Use:</para>
@@ -300,7 +298,7 @@
</example>
<example>
- <title>Definition Lists with <sgmltag>dl</sgmltag></title>
+ <title>Definition Lists with <tag>dl</tag></title>
<para>Use:</para>
@@ -332,12 +330,12 @@
significant.</para>
<para>In order to do this, wrap the content in the
- <sgmltag>pre</sgmltag> element.</para>
+ <tag>pre</tag> element.</para>
<example>
- <title><sgmltag>pre</sgmltag></title>
+ <title><tag>pre</tag></title>
- <para>You could use <sgmltag>pre</sgmltag> to mark up an
+ <para>You could use <tag>pre</tag> to mark up an
email message:</para>
<programlisting><![CDATA[<pre> From: nik@FreeBSD.org
@@ -377,17 +375,17 @@
</note>
<para>Mark up tabular information using the
- <sgmltag>table</sgmltag> element. A table consists of one
- or more table rows (<sgmltag>tr</sgmltag>), each containing
- one or more cells of table data (<sgmltag>td</sgmltag>).
+ <tag>table</tag> element. A table consists of one
+ or more table rows (<tag>tr</tag>), each containing
+ one or more cells of table data (<tag>td</tag>).
Each cell can contain other block elements, such as
paragraphs or lists. It can also contain another table
(this nesting can repeat indefinitely). If the cell only
contains one paragraph then you do not need to include the
- <sgmltag>p</sgmltag> element.</para>
+ <tag>p</tag> element.</para>
<example>
- <title>Simple Use of <sgmltag>table</sgmltag></title>
+ <title>Simple Use of <tag>table</tag></title>
<para>Use:</para>
@@ -493,13 +491,13 @@
<title>Emphasizing Information</title>
<para>You have two levels of emphasis available in XHTML,
- <sgmltag>em</sgmltag> and <sgmltag>strong</sgmltag>.
- <sgmltag>em</sgmltag> is for a normal level of emphasis and
- <sgmltag>strong</sgmltag> indicates stronger
+ <tag>em</tag> and <tag>strong</tag>.
+ <tag>em</tag> is for a normal level of emphasis and
+ <tag>strong</tag> indicates stronger
emphasis.</para>
- <para>Typically, <sgmltag>em</sgmltag> is rendered in italic
- and <sgmltag>strong</sgmltag> is rendered in bold. This is
+ <para>Typically, <tag>em</tag> is rendered in italic
+ and <tag>strong</tag> is rendered in bold. This is
not always the case, however, and you should not rely on
it. According to best practices, webpages only hold
structural and semantical information and stylesheets are
@@ -507,8 +505,8 @@
semantics not formatting when using these tags.</para>
<example>
- <title><sgmltag>em</sgmltag> and
- <sgmltag>strong</sgmltag></title>
+ <title><tag>em</tag> and
+ <tag>strong</tag></title>
<para>Use:</para>
@@ -521,11 +519,11 @@
<title>Indicating Fixed-Pitch Text</title>
<para>If you have content that should be rendered in a fixed
- pitch (typewriter) typeface, use <sgmltag>tt</sgmltag> (for
+ pitch (typewriter) typeface, use <tag>tt</tag> (for
<quote>teletype</quote>).</para>
<example>
- <title><sgmltag>tt</sgmltag></title>
+ <title><tag>tt</tag></title>
<para>Use:</para>
@@ -550,7 +548,7 @@
WWW you must know the URL of the document you want to link
to.</para>
- <para>The link is indicated with <sgmltag>a</sgmltag>, and the
+ <para>The link is indicated with <tag>a</tag>, and the
<literal>href</literal> attribute contains the URL of the
target document. The content of the element becomes the
link, and is normally indicated to the user in some way
@@ -577,7 +575,7 @@
the same document) requires that the document author include
anchors that you can link to.</para>
- <para>Anchors are indicated with <sgmltag>a</sgmltag> and the
+ <para>Anchors are indicated with <tag>a</tag> and the
<literal>id</literal> attribute instead of
<literal>href</literal>.</para>
@@ -625,18 +623,16 @@
</sect2>
</sect1>
- <sect1 id="xml-markup-docbook">
+ <sect1 xml:id="xml-markup-docbook">
<title>DocBook</title>
<para>DocBook was originally developed by HaL Computer Systems and
O'Reilly &amp; Associates to be a DTD for writing technical
documentation <footnote><para>A short history can be found under
- <ulink
- url="http://www.oasis-open.org/docbook/intro.shtml#d0e41">
- http://www.oasis-open.org/docbook/intro.shtml#d0e41</ulink>.</para></footnote>.
- Since 1998 it is maintained by the <ulink
- url="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=docbook">
- DocBook Technical Committee</ulink>. As such, and unlike
+ <link xlink:href="http://www.oasis-open.org/docbook/intro.shtml#d0e41">
+ http://www.oasis-open.org/docbook/intro.shtml#d0e41</link>.</para></footnote>.
+ Since 1998 it is maintained by the <link xlink:href="http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=docbook">
+ DocBook Technical Committee</link>. As such, and unlike
LinuxDoc and XHTML, DocBook is very heavily oriented towards
markup that describes <emphasis>what</emphasis> something is,
rather than describing <emphasis>how</emphasis> it should be
@@ -653,9 +649,8 @@
</note>
<para>The DocBook DTD is available from the Ports&nbsp;Collection
- in the <filename role="package">textproc/docbook-xml-450</filename>
- port. It is automatically installed as part of the <filename
- role="package">textproc/docproj</filename> port.</para>
+ in the <package>textproc/docbook-xml-450</package>
+ port. It is automatically installed as part of the <package>textproc/docproj</package> port.</para>
<sect2>
<title>&os; Extensions</title>
@@ -683,8 +678,7 @@
<para>The &os; extensions are not (currently) in the
Ports&nbsp;Collection. They are stored in the &os; Subversion
- tree, as <ulink
- url="http://svnweb.FreeBSD.org/doc/head/share/xml/freebsd.dtd">head/share/xml/freebsd.dtd</ulink>.</para>
+ tree, as <link xlink:href="http://svnweb.FreeBSD.org/doc/head/share/xml/freebsd.dtd">head/share/xml/freebsd.dtd</link>.</para>
</sect2>
<sect2>
@@ -705,17 +699,17 @@
using two primary types of DocBook document: the book and the
article.</para>
- <para>A book is organized into <sgmltag>chapter</sgmltag>s.
+ <para>A book is organized into <tag>chapter</tag>s.
This is a mandatory requirement. There may be
- <sgmltag>part</sgmltag>s between the book and the chapter to
+ <tag>part</tag>s between the book and the chapter to
provide another layer of organization. For example, the
Handbook is arranged in this way.</para>
<para>A chapter may (or may not) contain one or more sections.
- These are indicated with the <sgmltag>sect1</sgmltag> element.
+ These are indicated with the <tag>sect1</tag> element.
If a section contains another section then use the
- <sgmltag>sect2</sgmltag> element, and so on, up to
- <sgmltag>sect5</sgmltag>.</para>
+ <tag>sect2</tag> element, and so on, up to
+ <tag>sect5</tag>.</para>
<para>Chapters and sections contain the remainder of the
content.</para>
@@ -723,7 +717,7 @@
<para>An article is simpler than a book, and does not use
chapters. Instead, the content of an article is organized
into one or more sections, using the same
- <sgmltag>sect1</sgmltag> (and <sgmltag>sect2</sgmltag> and so
+ <tag>sect1</tag> (and <tag>sect2</tag> and so
on) elements that are used in books.</para>
<para>Obviously, you should consider the nature of the
@@ -735,61 +729,61 @@
to information that can be broken up into several chapters,
possibly with appendices and similar content as well.</para>
- <para>The <ulink url="&url.base;/docs.html">FreeBSD
- tutorials</ulink> are all marked up as articles, while this
+ <para>The <link xlink:href="&url.base;/docs.html">FreeBSD
+ tutorials</link> are all marked up as articles, while this
document, the
- <ulink url="&url.books.faq;/index.html">FreeBSD FAQ</ulink>,
- and the <ulink url="&url.books.handbook;/index.html">FreeBSD
- Handbook</ulink> are all marked up as books, for
+ <link xlink:href="&url.books.faq;/index.html">FreeBSD FAQ</link>,
+ and the <link xlink:href="&url.books.handbook;/index.html">FreeBSD
+ Handbook</link> are all marked up as books, for
example.</para>
<sect3>
<title>Starting a Book</title>
<para>The content of the book is contained within the
- <sgmltag>book</sgmltag> element. As well as containing
+ <tag>book</tag> element. As well as containing
structural markup, this element can contain elements that
include additional information about the book. This is
either meta-information, used for reference purposes, or
additional content used to produce a title page.</para>
<para>This additional information should be contained within
- <sgmltag>bookinfo</sgmltag>.</para>
+ <tag>bookinfo</tag>.</para>
<example>
- <title>Boilerplate <sgmltag>book</sgmltag> with
- <sgmltag>bookinfo</sgmltag></title>
+ <title>Boilerplate <tag>book</tag> with
+ <tag>bookinfo</tag></title>
<!-- Can't put this in a marked section because of the
replaceable elements -->
- <programlisting>&lt;book>
- &lt;bookinfo>
- &lt;title><replaceable>Your Title Here</replaceable>&lt;/title>
+ <programlisting>&lt;book&gt;
+ &lt;bookinfo&gt;
+ &lt;title&gt;<replaceable>Your Title Here</replaceable>&lt;/title&gt;
- &lt;author>
- &lt;firstname><replaceable>Your first name</replaceable>&lt;/firstname>
- &lt;surname><replaceable>Your surname</replaceable>&lt;/surname>
- &lt;affiliation>
- &lt;address>&lt;email><replaceable>Your email address</replaceable>&lt;/email>&lt;/address>
- &lt;/affiliation>
- &lt;/author>
+ &lt;author&gt;
+ &lt;firstname&gt;<replaceable>Your first name</replaceable>&lt;/firstname&gt;
+ &lt;surname&gt;<replaceable>Your surname</replaceable>&lt;/surname&gt;
+ &lt;affiliation&gt;
+ &lt;address&gt;&lt;email&gt;<replaceable>Your email address</replaceable>&lt;/email&gt;&lt;/address&gt;
+ &lt;/affiliation&gt;
+ &lt;/author&gt;
- &lt;copyright>
- &lt;year><replaceable>1998</replaceable>&lt;/year>
- &lt;holder role="mailto:<replaceable>your email address</replaceable>"><replaceable>Your name</replaceable>&lt;/holder>
- &lt;/copyright>
+ &lt;copyright&gt;
+ &lt;year&gt;<replaceable>1998</replaceable>&lt;/year&gt;
+ &lt;holder role="mailto:<replaceable>your email address</replaceable>"&gt;<replaceable>Your name</replaceable>&lt;/holder&gt;
+ &lt;/copyright&gt;
- &lt;releaseinfo>&#36;FreeBSD&#36;&lt;/releaseinfo>
+ &lt;releaseinfo&gt;&#36;FreeBSD&#36;&lt;/releaseinfo&gt;
- &lt;abstract>
- &lt;para><replaceable>Include an abstract of the book's contents here.</replaceable>&lt;/para>
- &lt;/abstract>
- &lt;/bookinfo>
+ &lt;abstract&gt;
+ &lt;para&gt;<replaceable>Include an abstract of the book's contents here.</replaceable>&lt;/para&gt;
+ &lt;/abstract&gt;
+ &lt;/bookinfo&gt;
&hellip;
-&lt;/book></programlisting>
+&lt;/book&gt;</programlisting>
</example>
</sect3>
@@ -797,57 +791,57 @@
<title>Starting an Article</title>
<para>The content of the article is contained within the
- <sgmltag>article</sgmltag> element. As well as containing
+ <tag>article</tag> element. As well as containing
structural markup, this element can contain elements that
include additional information about the article. This is
either meta-information, used for reference purposes, or
additional content used to produce a title page.</para>
<para>This additional information should be contained within
- <sgmltag>articleinfo</sgmltag>.</para>
+ <tag>articleinfo</tag>.</para>
<example>
- <title>Boilerplate <sgmltag>article</sgmltag> with
- <sgmltag>articleinfo</sgmltag></title>
+ <title>Boilerplate <tag>article</tag> with
+ <tag>articleinfo</tag></title>
<!-- Can't put this in a marked section because of the
replaceable elements -->
- <programlisting>&lt;article>
- &lt;articleinfo>
- &lt;title><replaceable>Your title here</replaceable>&lt;/title>
+ <programlisting>&lt;article&gt;
+ &lt;articleinfo&gt;
+ &lt;title&gt;<replaceable>Your title here</replaceable>&lt;/title&gt;
- &lt;author>
- &lt;firstname><replaceable>Your first name</replaceable>&lt;/firstname>
- &lt;surname><replaceable>Your surname</replaceable>&lt;/surname>
- &lt;affiliation>
- &lt;address>&lt;email><replaceable>Your email address</replaceable>&lt;/email>&lt;/address>
- &lt;/affiliation>
- &lt;/author>
+ &lt;author&gt;
+ &lt;firstname&gt;<replaceable>Your first name</replaceable>&lt;/firstname&gt;
+ &lt;surname&gt;<replaceable>Your surname</replaceable>&lt;/surname&gt;
+ &lt;affiliation&gt;
+ &lt;address&gt;&lt;email&gt;<replaceable>Your email address</replaceable>&lt;/email&gt;&lt;/address&gt;
+ &lt;/affiliation&gt;
+ &lt;/author&gt;
- &lt;copyright>
- &lt;year><replaceable>1998</replaceable>&lt;/year>
- &lt;holder role="mailto:<replaceable>your email address</replaceable>"><replaceable>Your name</replaceable>&lt;/holder>
- &lt;/copyright>
+ &lt;copyright&gt;
+ &lt;year&gt;<replaceable>1998</replaceable>&lt;/year&gt;
+ &lt;holder role="mailto:<replaceable>your email address</replaceable>"&gt;<replaceable>Your name</replaceable>&lt;/holder&gt;
+ &lt;/copyright&gt;
- &lt;releaseinfo>&#36;FreeBSD&#36;&lt;/releaseinfo>
+ &lt;releaseinfo&gt;&#36;FreeBSD&#36;&lt;/releaseinfo&gt;
- &lt;abstract>
- &lt;para><replaceable>Include an abstract of the article's contents here.</replaceable>&lt;/para>
- &lt;/abstract>
- &lt;/articleinfo>
+ &lt;abstract&gt;
+ &lt;para&gt;<replaceable>Include an abstract of the article's contents here.</replaceable>&lt;/para&gt;
+ &lt;/abstract&gt;
+ &lt;/articleinfo&gt;
&hellip;
-&lt;/article></programlisting>
+&lt;/article&gt;</programlisting>
</example>
</sect3>
<sect3>
<title>Indicating Chapters</title>
- <para>Use <sgmltag>chapter</sgmltag> to mark up your chapters.
- Each chapter has a mandatory <sgmltag>title</sgmltag>.
+ <para>Use <tag>chapter</tag> to mark up your chapters.
+ Each chapter has a mandatory <tag>title</tag>.
Articles do not contain chapters, they are reserved for
books.</para>
@@ -862,7 +856,7 @@
</example>
<para>A chapter cannot be empty; it must contain elements in
- addition to <sgmltag>title</sgmltag>. If you need to
+ addition to <tag>title</tag>. If you need to
include an empty chapter then just use an empty
paragraph.</para>
@@ -884,16 +878,16 @@
into sections, subsections, and so on. In articles,
sections are the main structural element, and each article
must contain at least one section. Use the
- <sgmltag>sect<replaceable>n</replaceable></sgmltag> element.
+ <tag>sect<replaceable>n</replaceable></tag> element.
The <replaceable>n</replaceable> indicates the section
number, which identifies the section level.</para>
<para>The first
- <sgmltag>sect<replaceable>n</replaceable></sgmltag> is
- <sgmltag>sect1</sgmltag>. You can have one or more of these
+ <tag>sect<replaceable>n</replaceable></tag> is
+ <tag>sect1</tag>. You can have one or more of these
in a chapter. They can contain one or more
- <sgmltag>sect2</sgmltag> elements, and so on, down to
- <sgmltag>sect5</sgmltag>.</para>
+ <tag>sect2</tag> elements, and so on, down to
+ <tag>sect5</tag>.</para>
<example>
<title>Sections in Chapters</title>
@@ -941,13 +935,13 @@
</sect3>
<sect3>
- <title>Subdividing Using <sgmltag>part</sgmltag>
+ <title>Subdividing Using <tag>part</tag>
Elements</title>
<para>You can introduce another layer of organization between
- <sgmltag>book</sgmltag> and <sgmltag>chapter</sgmltag> with
- one or more <sgmltag>part</sgmltag>s. This cannot be done
- in an <sgmltag>article</sgmltag>.</para>
+ <tag>book</tag> and <tag>chapter</tag> with
+ one or more <tag>part</tag>s. This cannot be done
+ in an <tag>article</tag>.</para>
<programlisting><![CDATA[<part>
<title>Introduction</title>
@@ -980,18 +974,18 @@
<title>Paragraphs</title>
<para>DocBook supports three types of paragraphs:
- <sgmltag>formalpara</sgmltag>, <sgmltag>para</sgmltag>, and
- <sgmltag>simpara</sgmltag>.</para>
+ <tag>formalpara</tag>, <tag>para</tag>, and
+ <tag>simpara</tag>.</para>
<para>Most of the time you will only need to use
- <sgmltag>para</sgmltag>. <sgmltag>formalpara</sgmltag>
- includes a <sgmltag>title</sgmltag> element, and
- <sgmltag>simpara</sgmltag> disallows some elements from
- within <sgmltag>para</sgmltag>. Stick with
- <sgmltag>para</sgmltag>.</para>
+ <tag>para</tag>. <tag>formalpara</tag>
+ includes a <tag>title</tag> element, and
+ <tag>simpara</tag> disallows some elements from
+ within <tag>para</tag>. Stick with
+ <tag>para</tag>.</para>
<example>
- <title><sgmltag>para</sgmltag></title>
+ <title><tag>para</tag></title>
<para>Use:</para>
@@ -1018,7 +1012,7 @@
unattributed).</para>
<example>
- <title><sgmltag>blockquote</sgmltag></title>
+ <title><tag>blockquote</tag></title>
<para>Use:</para>
@@ -1068,11 +1062,11 @@
aware of.</para>
<para>Depending on the nature of the information, one of
- <sgmltag>tip</sgmltag>, <sgmltag>note</sgmltag>,
- <sgmltag>warning</sgmltag>, <sgmltag>caution</sgmltag>, and
- <sgmltag>important</sgmltag> should be used. Alternatively,
+ <tag>tip</tag>, <tag>note</tag>,
+ <tag>warning</tag>, <tag>caution</tag>, and
+ <tag>important</tag> should be used. Alternatively,
if the information is related to the main text but is not
- one of the above, use <sgmltag>sidebar</sgmltag>.</para>
+ one of the above, use <tag>sidebar</tag>.</para>
<para>The circumstances in which to choose one of these
elements over another is unclear. The DocBook documentation
@@ -1100,7 +1094,7 @@
</itemizedlist>
<example>
- <title><sgmltag>warning</sgmltag></title>
+ <title><tag>warning</tag></title>
<para>Use:</para>
@@ -1126,33 +1120,33 @@
carried out in order to accomplish a particular goal.</para>
<para>In order to do this, use
- <sgmltag>itemizedlist</sgmltag>,
- <sgmltag>orderedlist</sgmltag>, or
- <sgmltag>procedure</sgmltag><footnote><para>There are other
+ <tag>itemizedlist</tag>,
+ <tag>orderedlist</tag>, or
+ <tag>procedure</tag><footnote><para>There are other
types of list element in DocBook, but we are not
concerned with those at the
moment.</para></footnote></para>
- <para><sgmltag>itemizedlist</sgmltag> and
- <sgmltag>orderedlist</sgmltag> are similar to their
- counterparts in HTML, <sgmltag>ul</sgmltag> and
- <sgmltag>ol</sgmltag>. Each one consists of one or more
- <sgmltag>listitem</sgmltag> elements, and each
- <sgmltag>listitem</sgmltag> contains one or more block
- elements. The <sgmltag>listitem</sgmltag> elements are
- analogous to HTML's <sgmltag>li</sgmltag> tags. However,
+ <para><tag>itemizedlist</tag> and
+ <tag>orderedlist</tag> are similar to their
+ counterparts in HTML, <tag>ul</tag> and
+ <tag>ol</tag>. Each one consists of one or more
+ <tag>listitem</tag> elements, and each
+ <tag>listitem</tag> contains one or more block
+ elements. The <tag>listitem</tag> elements are
+ analogous to HTML's <tag>li</tag> tags. However,
unlike HTML, they are required.</para>
- <para><sgmltag>procedure</sgmltag> is slightly different. It
- consists of <sgmltag>step</sgmltag>s, which may in turn
- consists of more <sgmltag>step</sgmltag>s or
- <sgmltag>substep</sgmltag>s. Each <sgmltag>step</sgmltag>
+ <para><tag>procedure</tag> is slightly different. It
+ consists of <tag>step</tag>s, which may in turn
+ consists of more <tag>step</tag>s or
+ <tag>substep</tag>s. Each <tag>step</tag>
contains block elements.</para>
<example>
- <title><sgmltag>itemizedlist</sgmltag>,
- <sgmltag>orderedlist</sgmltag>, and
- <sgmltag>procedure</sgmltag></title>
+ <title><tag>itemizedlist</tag>,
+ <tag>orderedlist</tag>, and
+ <tag>procedure</tag></title>
<para>Use:</para>
@@ -1235,10 +1229,10 @@
<para>If you want to show a fragment of a file (or perhaps a
complete file) to the user, wrap it in the
- <sgmltag>programlisting</sgmltag> element.</para>
+ <tag>programlisting</tag> element.</para>
<para>White space and line breaks within
- <sgmltag>programlisting</sgmltag> <emphasis>are</emphasis>
+ <tag>programlisting</tag> <emphasis>are</emphasis>
significant. In particular, this means that the opening tag
should appear on the same line as the first line of the
output, and the closing tag should appear on the same line
@@ -1246,7 +1240,7 @@
lines may be included.</para>
<example>
- <title><sgmltag>programlisting</sgmltag></title>
+ <title><tag>programlisting</tag></title>
<para>Use:</para>
@@ -1288,17 +1282,17 @@ main(void)
example without linking to it within the text.</para>
<para>To do this, mark areas of interest in your example
- (<sgmltag>programlisting</sgmltag>,
- <sgmltag>literallayout</sgmltag>, or whatever) with the
- <sgmltag>co</sgmltag> element. Each element must have a
+ (<tag>programlisting</tag>,
+ <tag>literallayout</tag>, or whatever) with the
+ <tag>co</tag> element. Each element must have a
unique <literal>id</literal> assigned to it. After the
- example include a <sgmltag>calloutlist</sgmltag> that refers
+ example include a <tag>calloutlist</tag> that refers
back to the example and provides additional
commentary.</para>
<example>
- <title><sgmltag>co</sgmltag> and
- <sgmltag>calloutlist</sgmltag></title>
+ <title><tag>co</tag> and
+ <tag>calloutlist</tag></title>
<programlisting><![CDATA[<para>When you have finished, your program should look like
this:</para>
@@ -1332,12 +1326,12 @@ main(void)
<para>When you have finished, your program should look like
this:</para>
- <programlisting>#include &lt;stdio.h&gt; <co id="co-ex-include"/>
+ <programlisting>#include &lt;stdio.h&gt; <co xml:id="co-ex-include"/>
-int <co id="co-ex-return"/>
+int <co xml:id="co-ex-return"/>
main(void)
{
- printf("hello, world\n"); <co id="co-ex-printf"/>
+ printf("hello, world\n"); <co xml:id="co-ex-printf"/>
}</programlisting>
<calloutlist>
@@ -1368,23 +1362,23 @@ main(void)
<para>In general terms (and see the DocBook documentation for
more detail) a table (which can be either formal or
- informal) consists of a <sgmltag>table</sgmltag> element.
- This contains at least one <sgmltag>tgroup</sgmltag>
+ informal) consists of a <tag>table</tag> element.
+ This contains at least one <tag>tgroup</tag>
element, which specifies (as an attribute) the number of
columns in this table group. Within the tablegroup you can
- then have one <sgmltag>thead</sgmltag> element, which
+ then have one <tag>thead</tag> element, which
contains elements for the table headings (column headings),
- and one <sgmltag>tbody</sgmltag> which contains the body of
+ and one <tag>tbody</tag> which contains the body of
the table.</para>
- <para>Both <sgmltag>tgroup</sgmltag> and
- <sgmltag>thead</sgmltag> contain <sgmltag>row</sgmltag>
- elements, which in turn contain <sgmltag>entry</sgmltag>
- elements. Each <sgmltag>entry</sgmltag> element specifies
+ <para>Both <tag>tgroup</tag> and
+ <tag>thead</tag> contain <tag>row</tag>
+ elements, which in turn contain <tag>entry</tag>
+ elements. Each <tag>entry</tag> element specifies
one cell in the table.</para>
<example>
- <title><sgmltag>informaltable</sgmltag></title>
+ <title><tag>informaltable</tag></title>
<para>Use:</para>
@@ -1439,13 +1433,13 @@ main(void)
<para>Always use the <literal>pgwide</literal> attribute with
a value of <literal>1</literal> with the
- <sgmltag>informaltable</sgmltag> element. A bug in Internet
+ <tag>informaltable</tag> element. A bug in Internet
Explorer can cause the table to render incorrectly if this
is omitted.</para>
<para>If you do not want a border around the table the
<literal>frame</literal> attribute can be added to the
- <sgmltag>informaltable</sgmltag> element with a value of
+ <tag>informaltable</tag> element with a value of
<literal>none</literal> (i.e., <literal>&lt;informaltable
frame="none"&gt;</literal>).</para>
@@ -1493,20 +1487,20 @@ main(void)
<variablelist>
<varlistentry>
- <term><sgmltag>screen</sgmltag></term>
+ <term><tag>screen</tag></term>
<listitem>
<para>Everything the user sees in this example will be
on the computer screen, so the next element is
- <sgmltag>screen</sgmltag>.</para>
+ <tag>screen</tag>.</para>
- <para>Within <sgmltag>screen</sgmltag>, white space is
+ <para>Within <tag>screen</tag>, white space is
significant.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><sgmltag>prompt</sgmltag>,
+ <term><tag>prompt</tag>,
<literal>&amp;prompt.root;</literal> and
<literal>&amp;prompt.user;</literal></term>
@@ -1515,7 +1509,7 @@ main(void)
screen are prompts from the computer (either from the
operating system, command shell, or application).
These should be marked up using
- <sgmltag>prompt</sgmltag>.</para>
+ <tag>prompt</tag>.</para>
<para>As a special case, the two shell prompts for the
normal user and the root user have been provided as
@@ -1524,7 +1518,7 @@ main(void)
<literal>&amp;prompt.root;</literal> and
<literal>&amp;prompt.user;</literal> as necessary.
They do not need to be inside
- <sgmltag>prompt</sgmltag>.</para>
+ <tag>prompt</tag>.</para>
<note>
<para><literal>&amp;prompt.root;</literal> and
@@ -1536,19 +1530,19 @@ main(void)
</varlistentry>
<varlistentry>
- <term><sgmltag>userinput</sgmltag></term>
+ <term><tag>userinput</tag></term>
<listitem>
<para>When displaying text that the user should type in,
- wrap it in <sgmltag>userinput</sgmltag> tags. It will
+ wrap it in <tag>userinput</tag> tags. It will
probably be displayed differently to the user.</para>
</listitem>
</varlistentry>
</variablelist>
<example>
- <title><sgmltag>screen</sgmltag>, <sgmltag>prompt</sgmltag>,
- and <sgmltag>userinput</sgmltag></title>
+ <title><tag>screen</tag>, <tag>prompt</tag>,
+ and <tag>userinput</tag></title>
<para>Use:</para>
@@ -1580,8 +1574,8 @@ This is the file called 'foo2'</screen>
<note>
<para>Even though we are displaying the contents of the file
<filename>foo2</filename>, it is <emphasis>not</emphasis>
- marked up as <sgmltag>programlisting</sgmltag>. Reserve
- <sgmltag>programlisting</sgmltag> for showing fragments of
+ marked up as <tag>programlisting</tag>. Reserve
+ <tag>programlisting</tag> for showing fragments of
files outside the context of user actions.</para>
</note>
</sect3>
@@ -1594,19 +1588,19 @@ This is the file called 'foo2'</screen>
<title>Emphasizing Information</title>
<para>When you want to emphasize a particular word or phrase,
- use <sgmltag>emphasis</sgmltag>. This may be presented as
+ use <tag>emphasis</tag>. This may be presented as
italic, or bold, or might be spoken differently with a
text-to-speech system.</para>
<para>There is no way to change the presentation of the
emphasis within your document, no equivalent of HTML's
- <sgmltag>b</sgmltag> and <sgmltag>i</sgmltag>. If the
+ <tag>b</tag> and <tag>i</tag>. If the
information you are presenting is important then consider
- presenting it in <sgmltag>important</sgmltag> rather than
- <sgmltag>emphasis</sgmltag>.</para>
+ presenting it in <tag>important</tag> rather than
+ <tag>emphasis</tag>.</para>
<example>
- <title><sgmltag>emphasis</sgmltag></title>
+ <title><tag>emphasis</tag></title>
<para>Use:</para>
@@ -1626,7 +1620,7 @@ This is the file called 'foo2'</screen>
<para>To quote text from another document or source, or to
denote a phrase that is used figuratively, use
- <sgmltag>quote</sgmltag>. Within a <sgmltag>quote</sgmltag>
+ <tag>quote</tag>. Within a <tag>quote</tag>
tag, you may use most of the markup tags available for
normal text.</para>
@@ -1651,12 +1645,12 @@ This is the file called 'foo2'</screen>
<title>Keys, Mouse Buttons, and Combinations</title>
<para>To refer to a specific key on the keyboard, use
- <sgmltag>keycap</sgmltag>. To refer to a mouse button, use
- <sgmltag>mousebutton</sgmltag>. And to refer to
+ <tag>keycap</tag>. To refer to a mouse button, use
+ <tag>mousebutton</tag>. And to refer to
combinations of key presses or mouse clicks, wrap them all
- in <sgmltag>keycombo</sgmltag>.</para>
+ in <tag>keycombo</tag>.</para>
- <para><sgmltag>keycombo</sgmltag> has an attribute called
+ <para><tag>keycombo</tag> has an attribute called
<literal>action</literal>, which may be one of
<literal>click</literal>, <literal>double-click</literal>,
<literal>other</literal>, <literal>press</literal>,
@@ -1666,7 +1660,7 @@ This is the file called 'foo2'</screen>
<para>The stylesheets automatically add any connecting
symbols, such as <literal>+</literal>, between the key
- names, when wrapped in <sgmltag>keycombo</sgmltag>.</para>
+ names, when wrapped in <tag>keycombo</tag>.</para>
<example>
<title>Keys, Mouse Buttons, and Combinations</title>
@@ -1725,23 +1719,23 @@ This is the file called 'foo2'</screen>
format so common in Unix manuals.</para>
<para>Mark up application names with
- <sgmltag>application</sgmltag>.</para>
+ <tag>application</tag>.</para>
<para>When you want to list a command with its manual section
number (which should be most of the time) the DocBook
- element is <sgmltag>citerefentry</sgmltag>. This will
+ element is <tag>citerefentry</tag>. This will
contain a further two elements,
- <sgmltag>refentrytitle</sgmltag> and
- <sgmltag>manvolnum</sgmltag>. The content of
- <sgmltag>refentrytitle</sgmltag> is the name of the command,
- and the content of <sgmltag>manvolnum</sgmltag> is the
+ <tag>refentrytitle</tag> and
+ <tag>manvolnum</tag>. The content of
+ <tag>refentrytitle</tag> is the name of the command,
+ and the content of <tag>manvolnum</tag> is the
manual page section.</para>
<para>This can be cumbersome to write, and so a series of
<link linkend="xml-primer-general-entities">general
entities</link> have been created to make this easier.
Each entity takes the form
- <literal>&amp;man.<replaceable>manual-page</replaceable>.<replaceable>manual-section</replaceable>;</literal>.</para>
+ <literal>&amp;man.manual-page.manual-section;</literal>.</para>
<para>The file that contains these entities is in
<filename>doc/share/xml/man-refs.ent</filename>, and can be
@@ -1761,18 +1755,18 @@ This is the file called 'foo2'</screen>
]&gt;</programlisting>
- <para>Use <sgmltag>command</sgmltag> when you want to include
+ <para>Use <tag>command</tag> when you want to include
a command name <quote>in-line</quote> but present it as
something the user should type in.</para>
- <para>Use <sgmltag>option</sgmltag> to mark up the options
+ <para>Use <tag>option</tag> to mark up the options
which will be passed to a command.</para>
<para>When referring to the same command multiple times in
close proximity it is preferred to use the
- <literal>&amp;man.<replaceable>command</replaceable>.<replaceable>section</replaceable>;</literal>
+ <literal>&amp;man.command.section;</literal>
notation to markup the first reference and use
- <sgmltag>command</sgmltag> to markup subsequent references.
+ <tag>command</tag> to markup subsequent references.
This makes the generated output, especially HTML, appear
visually better.</para>
@@ -1826,7 +1820,7 @@ This is the file called 'foo2'</screen>
<note>
<para>Notice how the
- <literal>&amp;man.<replaceable>command</replaceable>.<replaceable>section</replaceable>;</literal>
+ <literal>&amp;man.command.section;</literal>
notation is easier to follow.</para>
</note>
</sect3>
@@ -1836,10 +1830,10 @@ This is the file called 'foo2'</screen>
<para>Whenever you wish to refer to the name of a file, a
directory, or a file extension, use
- <sgmltag>filename</sgmltag>.</para>
+ <tag>filename</tag>.</para>
<example>
- <title><sgmltag>filename</sgmltag></title>
+ <title><tag>filename</tag></title>
<para>Use:</para>
@@ -1874,7 +1868,7 @@ This is the file called 'foo2'</screen>
<para>You might need to include the name of a program from the
FreeBSD Ports Collection in the documentation. Use the
- <sgmltag>filename</sgmltag> tag with the
+ <tag>filename</tag> tag with the
<literal>role</literal> attribute set to
<literal>package</literal> to identify these. Since ports
can be installed in any number of locations, only include
@@ -1882,7 +1876,7 @@ This is the file called 'foo2'</screen>
<filename>/usr/ports</filename>.</para>
<example>
- <title><sgmltag>filename</sgmltag> Tag with
+ <title><tag>filename</tag> Tag with
<literal>package</literal> Role</title>
<para>Use:</para>
@@ -1891,8 +1885,7 @@ This is the file called 'foo2'</screen>
<para>Appearance:</para>
- <para>Install the <filename
- role="package">net/ethereal</filename> port to view
+ <para>Install the <package>net/ethereal</package> port to view
network traffic.</para>
</example>
</sect3>
@@ -1912,7 +1905,7 @@ This is the file called 'foo2'</screen>
either refer to the device as it appears in
<filename>/dev</filename>, or you can use the name of the
device as it appears in the kernel. For this latter course,
- use <sgmltag>devicename</sgmltag>.</para>
+ use <tag>devicename</tag>.</para>
<para>Sometimes you will not have a choice. Some devices,
such as networking cards, do not have entries in
@@ -1920,7 +1913,7 @@ This is the file called 'foo2'</screen>
different from those entries.</para>
<example>
- <title><sgmltag>devicename</sgmltag></title>
+ <title><tag>devicename</tag></title>
<para>Use:</para>
@@ -1938,19 +1931,19 @@ This is the file called 'foo2'</screen>
<para>Appearance:</para>
- <para><devicename>sio</devicename> is used for serial
- communication in FreeBSD. <devicename>sio</devicename>
+ <para><filename>sio</filename> is used for serial
+ communication in FreeBSD. <filename>sio</filename>
manifests through a number of entries in
<filename>/dev</filename>, including
<filename>/dev/ttyd0</filename> and
<filename>/dev/cuaa0</filename>.</para>
<para>By contrast, the networking devices, such as
- <devicename>ed0</devicename> do not appear in
+ <filename>ed0</filename> do not appear in
<filename>/dev</filename>.</para>
<para>In MS-DOS, the first floppy drive is referred to as
- <devicename>a:</devicename>. In FreeBSD it is
+ <filename>a:</filename>. In FreeBSD it is
<filename>/dev/fd0</filename>.</para>
</example>
</sect3>
@@ -1969,7 +1962,7 @@ This is the file called 'foo2'</screen>
<para>You can markup identification information for networked
computers (hosts) in several ways, depending on the nature
of the information. All of them use
- <sgmltag>hostid</sgmltag> as the element, with the
+ <tag>hostid</tag> as the element, with the
<literal>role</literal> attribute selecting the type of the
marked up information.</para>
@@ -1980,7 +1973,7 @@ This is the file called 'foo2'</screen>
<listitem>
<para>With no <literal>role</literal> attribute (i.e.,
- <sgmltag>hostid</sgmltag>...<sgmltag>/hostid</sgmltag>)
+ <tag>hostid</tag>...<tag>/hostid</tag>)
the marked up information is the simple hostname, such
as <literal>freefall</literal> or
<literal>wcarchive</literal>. You can explicitly
@@ -2048,7 +2041,7 @@ This is the file called 'foo2'</screen>
</variablelist>
<example>
- <title><sgmltag>hostid</sgmltag> and Roles</title>
+ <title><tag>hostid</tag> and Roles</title>
<para>Use:</para>
@@ -2074,24 +2067,22 @@ This is the file called 'foo2'</screen>
<para>Appearance:</para>
<para>The local machine can always be referred to by the
- name <hostid>localhost</hostid>, which will have the IP
- address <hostid role="ipaddr">127.0.0.1</hostid>.</para>
+ name <systemitem>localhost</systemitem>, which will have the IP
+ address <systemitem class="ipaddress">127.0.0.1</systemitem>.</para>
- <para>The <hostid role="domainname">FreeBSD.org</hostid>
+ <para>The <systemitem class="fqdomainname">FreeBSD.org</systemitem>
domain contains a number of different hosts, including
- <hostid role="fqdn">freefall.FreeBSD.org</hostid> and
- <hostid role="fqdn">bento.FreeBSD.org</hostid>.</para>
+ <systemitem class="fqdomainname">freefall.FreeBSD.org</systemitem> and
+ <systemitem class="fqdomainname">bento.FreeBSD.org</systemitem>.</para>
<para>When adding an IP alias to an interface (using
<command>ifconfig</command>) <emphasis>always</emphasis>
use a netmask of
- <hostid role="netmask">255.255.255.255</hostid>
- (which can also be expressed as <hostid
- role="netmask">0xffffffff</hostid>).</para>
+ <systemitem class="netmask">255.255.255.255</systemitem>
+ (which can also be expressed as <systemitem class="netmask">0xffffffff</systemitem>).</para>
<para>The MAC address uniquely identifies every network card
- in existence. A typical MAC address looks like <hostid
- role="mac">08:00:20:87:ef:d0</hostid>.</para>
+ in existence. A typical MAC address looks like <systemitem class="etheraddress">08:00:20:87:ef:d0</systemitem>.</para>
</example>
</sect3>
@@ -2108,10 +2099,10 @@ This is the file called 'foo2'</screen>
<para>When you need to refer to a specific username, such as
<literal>root</literal> or <literal>bin</literal>, use
- <sgmltag>username</sgmltag>.</para>
+ <tag>username</tag>.</para>
<example>
- <title><sgmltag>username</sgmltag></title>
+ <title><tag>username</tag></title>
<para>Use:</para>
@@ -2121,7 +2112,7 @@ This is the file called 'foo2'</screen>
<para>Appearance:</para>
<para>To carry out most system administration functions you
- will need to be <username>root</username>.</para>
+ will need to be <systemitem class="username">root</systemitem>.</para>
</example>
</sect3>
@@ -2138,20 +2129,20 @@ This is the file called 'foo2'</screen>
<para>Two elements exist to describe parts of
<filename>Makefile</filename>s,
- <sgmltag>maketarget</sgmltag> and
- <sgmltag>makevar</sgmltag>.</para>
+ <tag>maketarget</tag> and
+ <tag>makevar</tag>.</para>
- <para><sgmltag>maketarget</sgmltag> identifies a build target
+ <para><tag>maketarget</tag> identifies a build target
exported by a <filename>Makefile</filename> that can be
given as a parameter to <command>make</command>.
- <sgmltag>makevar</sgmltag> identifies a variable that can be
+ <tag>makevar</tag> identifies a variable that can be
set (in the environment, on the <command>make</command>
command line, or within the <filename>Makefile</filename>)
to influence the process.</para>
<example>
- <title><sgmltag>maketarget</sgmltag> and
- <sgmltag>makevar</sgmltag></title>
+ <title><tag>maketarget</tag> and
+ <tag>makevar</tag></title>
<para>Use:</para>
@@ -2170,18 +2161,18 @@ This is the file called 'foo2'</screen>
<para>Appearance:</para>
<para>Two common targets in a <filename>Makefile</filename>
- are <maketarget>all</maketarget> and
- <maketarget>clean</maketarget>.</para>
+ are <buildtarget>all</buildtarget> and
+ <buildtarget>clean</buildtarget>.</para>
- <para>Typically, invoking <maketarget>all</maketarget> will
+ <para>Typically, invoking <buildtarget>all</buildtarget> will
rebuild the application, and invoking
- <maketarget>clean</maketarget> will remove the temporary
+ <buildtarget>clean</buildtarget> will remove the temporary
files (<filename>.o</filename> for example) created by the
build process.</para>
- <para><maketarget>clean</maketarget> may be controlled by a
- number of variables, including <makevar>CLOBBER</makevar>
- and <makevar>RECURSE</makevar>.</para>
+ <para><buildtarget>clean</buildtarget> may be controlled by a
+ number of variables, including <varname>CLOBBER</varname>
+ and <varname>RECURSE</varname>.</para>
</example>
</sect3>
@@ -2193,18 +2184,18 @@ This is the file called 'foo2'</screen>
from another file, or which should be copied from the
documentation into another file verbatim.</para>
- <para>Some of the time, <sgmltag>programlisting</sgmltag> will
+ <para>Some of the time, <tag>programlisting</tag> will
be sufficient to denote this text.
- <sgmltag>programlisting</sgmltag> is not always appropriate,
+ <tag>programlisting</tag> is not always appropriate,
particularly when you want to include a portion of a file
<quote>in-line</quote> with the rest of the
paragraph.</para>
<para>On these occasions, use
- <sgmltag>literal</sgmltag>.</para>
+ <tag>literal</tag>.</para>
<example>
- <title><sgmltag>literal</sgmltag></title>
+ <title><tag>literal</tag></title>
<para>Use:</para>
@@ -2232,13 +2223,13 @@ This is the file called 'foo2'</screen>
provide, but must instead include some information
themselves.</para>
- <para><sgmltag>replaceable</sgmltag> is designed for this
+ <para><tag>replaceable</tag> is designed for this
eventuality. Use it <emphasis>inside</emphasis> other
elements to indicate parts of that element's content that
the user must replace.</para>
<example>
- <title><sgmltag>replaceable</sgmltag></title>
+ <title><tag>replaceable</tag></title>
<para>Use:</para>
@@ -2247,13 +2238,13 @@ This is the file called 'foo2'</screen>
<para>Appearance:</para>
<informalexample>
- <screen>&prompt.user; <userinput>man <replaceable>command</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>man command</userinput></screen>
</informalexample>
- <para><sgmltag>replaceable</sgmltag> can be used in many
- different elements, including <sgmltag>literal</sgmltag>.
+ <para><tag>replaceable</tag> can be used in many
+ different elements, including <tag>literal</tag>.
This example also shows that
- <sgmltag>replaceable</sgmltag> should only be wrapped
+ <tag>replaceable</tag> should only be wrapped
around the content that the user <emphasis>is</emphasis>
meant to provide. The other content should be left
alone.</para>
@@ -2271,7 +2262,7 @@ This is the file called 'foo2'</screen>
<para>Appearance:</para>
<para>The
- <literal>maxusers <replaceable>n</replaceable></literal>
+ <literal>maxusers n</literal>
line in the kernel configuration file determines the size
of many system tables, and is a rough guide to how many
simultaneous logins the system will support.</para>
@@ -2285,11 +2276,11 @@ This is the file called 'foo2'</screen>
<title>Quoting System Errors</title>
<para>You might want to show errors generated by FreeBSD.
- Mark these with <sgmltag>errorname</sgmltag>. This
+ Mark these with <tag>errorname</tag>. This
indicates the exact error that appears.</para>
<example>
- <title><sgmltag>errorname</sgmltag></title>
+ <title><tag>errorname</tag></title>
<para>Use:</para>
@@ -2316,13 +2307,13 @@ This is the file called 'foo2'</screen>
unlikely to change, but that is not guaranteed.</para>
<para>You will also need to install the
- <filename role="package">graphics/ImageMagick</filename>
+ <package>graphics/ImageMagick</package>
port, which is used to convert between the different image
formats. This is a big port, and most of it is not
required. However, while we are working on the
<filename>Makefile</filename>s and other infrastructure it
makes things easier. This port is <emphasis>not</emphasis>
- in the <filename role="package">textproc/docproj</filename>
+ in the <package>textproc/docproj</package>
meta port, you must install it by hand.</para>
<para>The best example of what follows in practice is the
@@ -2374,17 +2365,17 @@ This is the file called 'foo2'</screen>
<title>Markup</title>
<para>The markup for an image is relatively simple. First,
- markup a <sgmltag>mediaobject</sgmltag>. The
- <sgmltag>mediaobject</sgmltag> can contain other, more
+ markup a <tag>mediaobject</tag>. The
+ <tag>mediaobject</tag> can contain other, more
specific objects. We are concerned with two, the
- <sgmltag>imageobject</sgmltag> and the
- <sgmltag>textobject</sgmltag>.</para>
+ <tag>imageobject</tag> and the
+ <tag>textobject</tag>.</para>
- <para>You should include one <sgmltag>imageobject</sgmltag>,
- and two <sgmltag>textobject</sgmltag> elements. The
- <sgmltag>imageobject</sgmltag> will point to the name of the
+ <para>You should include one <tag>imageobject</tag>,
+ and two <tag>textobject</tag> elements. The
+ <tag>imageobject</tag> will point to the name of the
image file that will be used (without the extension). The
- <sgmltag>textobject</sgmltag> elements contain information
+ <tag>textobject</tag> elements contain information
that will be presented to the user as well as, or instead
of, the image.</para>
@@ -2413,26 +2404,26 @@ This is the file called 'foo2'</screen>
document. This image is of a rectangle with an A inside it.
The markup for this would be as follows.</para>
- <programlisting>&lt;mediaobject>
- &lt;imageobject>
- &lt;imagedata fileref="fig1"> <co id="co-image-ext"/>
- &lt;/imageobject>
+ <programlisting>&lt;mediaobject&gt;
+ &lt;imageobject&gt;
+ &lt;imagedata fileref="fig1"&gt; <co xml:id="co-image-ext"/>
+ &lt;/imageobject&gt;
- &lt;textobject>
- &lt;literallayout class="monospaced">+---------------+ <co id="co-image-literal"/>
+ &lt;textobject&gt;
+ &lt;literallayout class="monospaced"&gt;+---------------+ <co xml:id="co-image-literal"/>
| A |
-+---------------+&lt;/literallayout>
- &lt;/textobject>
++---------------+&lt;/literallayout&gt;
+ &lt;/textobject&gt;
- &lt;textobject>
- &lt;phrase>A picture&lt;/phrase> <co id="co-image-phrase"/>
- &lt;/textobject>
-&lt;/mediaobject></programlisting>
+ &lt;textobject&gt;
+ &lt;phrase&gt;A picture&lt;/phrase&gt; <co xml:id="co-image-phrase"/>
+ &lt;/textobject&gt;
+&lt;/mediaobject&gt;</programlisting>
<calloutlist>
<callout arearefs="co-image-ext">
- <para>Include an <sgmltag>imagedata</sgmltag> element
- inside the <sgmltag>imageobject</sgmltag> element. The
+ <para>Include an <tag>imagedata</tag> element
+ inside the <tag>imageobject</tag> element. The
<literal>fileref</literal> attribute should contain the
filename of the image to include, without the extension.
The stylesheets will work out which extension should be
@@ -2441,8 +2432,8 @@ This is the file called 'foo2'</screen>
<callout arearefs="co-image-literal">
- <para>The first <sgmltag>textobject</sgmltag> should
- contain a <sgmltag>literallayout</sgmltag> element,
+ <para>The first <tag>textobject</tag> should
+ contain a <tag>literallayout</tag> element,
where the <literal>class</literal> attribute is set to
<literal>monospaced</literal>. This is your opportunity
to demonstrate your ASCII art skills. This content will
@@ -2450,14 +2441,14 @@ This is the file called 'foo2'</screen>
text.</para>
<para>Notice how the first and last lines of the content
- of the <sgmltag>literallayout</sgmltag> element butt up
+ of the <tag>literallayout</tag> element butt up
next to the element's tags. This ensures no extraneous
white space is included.</para>
</callout>
<callout arearefs="co-image-phrase">
- <para>The second <sgmltag>textobject</sgmltag> should
- contain a single <sgmltag>phrase</sgmltag> element. The
+ <para>The second <tag>textobject</tag> should
+ contain a single <tag>phrase</tag> element. The
contents of this will become the <literal>alt</literal>
attribute for the image when this document is converted
to HTML.</para>
@@ -2470,7 +2461,7 @@ This is the file called 'foo2'</screen>
<para>Your images must be listed in the
<filename>Makefile</filename> in the
- <makevar>IMAGES</makevar> variable. This variable should
+ <varname>IMAGES</varname> variable. This variable should
contain the name of all your <emphasis>source</emphasis>
images. For example, if you have created three figures,
<filename>fig1.eps</filename>,
@@ -2517,10 +2508,10 @@ IMAGES+= fig3.png
<filename>chapter3/</filename>).</para>
<para>However, if you do this you must include the directory
- names in the <makevar>IMAGES</makevar> variable in the
+ names in the <varname>IMAGES</varname> variable in the
<filename>Makefile</filename>, <emphasis>and</emphasis> you
must include the directory name in the
- <sgmltag>imagedata</sgmltag> element in your
+ <tag>imagedata</tag> element in your
document.</para>
<para>For example, if you have
@@ -2528,14 +2519,14 @@ IMAGES+= fig3.png
<filename>chapter1/chapter.xml</filename> should
contain:</para>
- <programlisting>&lt;mediaobject>
- &lt;imageobject>
- &lt;imagedata fileref="chapter1/fig1"> <co id="co-image-dir"/>
- &lt;/imageobject>
+ <programlisting>&lt;mediaobject&gt;
+ &lt;imageobject&gt;
+ &lt;imagedata fileref="chapter1/fig1"&gt; <co xml:id="co-image-dir"/>
+ &lt;/imageobject&gt;
&hellip;
-&lt;/mediaobject></programlisting>
+&lt;/mediaobject&gt;</programlisting>
<calloutlist>
<callout arearefs="co-image-dir">
@@ -2608,12 +2599,12 @@ IMAGES= chapter1/fig1.png
<para>If you want to allow the user to jump into a specific
portion of the document (possibly in the middle of a
- paragraph or an example), use <sgmltag>anchor</sgmltag>.
+ paragraph or an example), use <tag>anchor</tag>.
This element has no content, but takes an
<literal>id</literal> attribute.</para>
<example>
- <title><sgmltag>anchor</sgmltag></title>
+ <title><tag>anchor</tag></title>
<programlisting><![CDATA[<para>This paragraph has an embedded
<anchor id="para1">link target in it. It will not show up in
@@ -2623,8 +2614,8 @@ IMAGES= chapter1/fig1.png
<para>When you want to provide the user with a link they can
activate (probably by clicking) to go to a section of the
document that has an <literal>id</literal> attribute, you
- can use either <sgmltag>xref</sgmltag> or
- <sgmltag>link</sgmltag>.</para>
+ can use either <tag>xref</tag> or
+ <tag>link</tag>.</para>
<para>Both of these elements have a <literal>linkend</literal>
attribute. The value of this attribute should be the value
@@ -2633,12 +2624,12 @@ IMAGES= chapter1/fig1.png
document; this will work for forward links as well as
backward links).</para>
- <para>If you use <sgmltag>xref</sgmltag> then you have no
+ <para>If you use <tag>xref</tag> then you have no
control over the text of the link. It will be generated for
you.</para>
<example>
- <title>Using <sgmltag>xref</sgmltag></title>
+ <title>Using <tag>xref</tag></title>
<para>Assume that this fragment appears somewhere in a
document that includes the <literal>id</literal>
@@ -2669,20 +2660,20 @@ IMAGES= chapter1/fig1.png
<note>
<para>This means that you <emphasis>cannot</emphasis> use
- <sgmltag>xref</sgmltag> to link to an
+ <tag>xref</tag> to link to an
<literal>id</literal> attribute on an
- <sgmltag>anchor</sgmltag> element. The
- <sgmltag>anchor</sgmltag> has no content, so the
- <sgmltag>xref</sgmltag> cannot generate the text for the
+ <tag>anchor</tag> element. The
+ <tag>anchor</tag> has no content, so the
+ <tag>xref</tag> cannot generate the text for the
link.</para>
</note>
<para>If you want to control the text of the link then use
- <sgmltag>link</sgmltag>. This element wraps content, and
+ <tag>link</tag>. This element wraps content, and
the content will be used for the link.</para>
<example>
- <title>Using <sgmltag>link</sgmltag></title>
+ <title>Using <tag>link</tag></title>
<para>Assume that this fragment appears somewhere in a
document that includes the <literal>id</literal>
@@ -2717,9 +2708,9 @@ IMAGES= chapter1/fig1.png
<note>
<para>You <emphasis>can</emphasis> use
- <sgmltag>link</sgmltag> to include a link to an
- <literal>id</literal> on an <sgmltag>anchor</sgmltag>
- element, since the <sgmltag>link</sgmltag> content defines
+ <tag>link</tag> to include a link to an
+ <literal>id</literal> on an <tag>anchor</tag>
+ element, since the <tag>link</tag> content defines
the text that will be used for the link.</para>
</note>
</sect3>
@@ -2729,13 +2720,13 @@ IMAGES= chapter1/fig1.png
<para>Linking to external documents is much simpler, as long
as you know the URL of the document you want to link to.
- Use <sgmltag>ulink</sgmltag>. The <literal>url</literal>
+ Use <tag>ulink</tag>. The <literal>url</literal>
attribute is the URL of the page that the link points to,
and the content of the element is the text that will be
displayed for the user to activate.</para>
<example>
- <title><sgmltag>ulink</sgmltag></title>
+ <title><tag>ulink</tag></title>
<para>Use:</para>
@@ -2746,8 +2737,8 @@ IMAGES= chapter1/fig1.png
<para>Appearance:</para>
<para>Of course, you could stop reading this document and go
- to the <ulink url="&url.base;/index.html">FreeBSD home
- page</ulink> instead.</para>
+ to the <link xlink:href="&url.base;/index.html">FreeBSD home
+ page</link> instead.</para>
</example>
</sect3>
</sect2>
diff --git a/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml
index 9072cb4999..51336b2eb3 100644
--- a/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<chapter id="xml-primer">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="xml-primer">
<title>XML Primer</title>
<para>The majority of FDP documentation is written in applications
@@ -40,10 +39,10 @@
of XML tricks you will see used in the documentation.</para>
<para>Portions of this section were inspired by Mark Galassi's
- <ulink url="http://www.galassi.org/mark/mydocs/docbook-intro/docbook-intro.html">Get
- Going With DocBook</ulink>.</para>
+ <link xlink:href="http://www.galassi.org/mark/mydocs/docbook-intro/docbook-intro.html">Get
+ Going With DocBook</link>.</para>
- <sect1 id="xml-primer-overview">
+ <sect1 xml:id="xml-primer-overview">
<title>Overview</title>
<para>Way back when, electronic text was simple to deal with.
@@ -140,7 +139,7 @@
whether some markup can be used inside other markup) and related
information.</para>
- <para id="xml-primer-validating">A schema is a
+ <para xml:id="xml-primer-validating">A schema is a
<emphasis>complete</emphasis> specification of all the elements
that are allowed to appear, the order in which they should
appear, which elements are mandatory, which are optional, and so
@@ -171,7 +170,7 @@
vocabulary.</para>
</sect1>
- <sect1 id="xml-primer-elements">
+ <sect1 xml:id="xml-primer-elements">
<title>Elements, Tags, and Attributes</title>
<para>All the vocabularies written in XML share certain characteristics.
@@ -223,16 +222,16 @@
<para>For an element called
<replaceable>element-name</replaceable> the start tag will
normally look like
- <sgmltag><replaceable>element-name</replaceable></sgmltag>. The
+ <tag><replaceable>element-name</replaceable></tag>. The
corresponding closing tag for this element is
- <sgmltag>/<replaceable>element-name</replaceable></sgmltag>.</para>
+ <tag>/<replaceable>element-name</replaceable></tag>.</para>
<example>
<title>Using an Element (Start and End Tags)</title>
<para>XHTML has an element for indicating that the content
enclosed by the element is a paragraph, called
- <sgmltag>p</sgmltag>.</para>
+ <tag>p</tag>.</para>
<programlisting><![CDATA[<p>This is a paragraph. It starts with the start tag for
the 'p' element, and it will end with the end tag for the 'p'
@@ -255,7 +254,7 @@
<title>Using an Element (Without Content)</title>
<para>XHTML has an element for indicating a horizontal rule,
- called <sgmltag>hr</sgmltag>. This element does not wrap
+ called <tag>hr</tag>. This element does not wrap
content, so it looks like this.</para>
<programlisting><![CDATA[<p>One paragraph.</p>
@@ -281,7 +280,7 @@
the paragraph elements, and so on.</para>
<example>
- <title>Elements within Elements; <sgmltag>em</sgmltag></title>
+ <title>Elements within Elements; <tag>em</tag></title>
<programlisting><![CDATA[<p>This is a simple <em>paragraph</em> where some
of the <em>words</em> have been <em>emphasized</em>.</p>]]></programlisting>
@@ -301,11 +300,11 @@
element starts and end.</para>
<para>When this document (or anyone else knowledgeable about
- XML) refers to <quote>the <sgmltag>p</sgmltag> tag</quote>
+ XML) refers to <quote>the <tag>p</tag> tag</quote>
they mean the literal text consisting of the three characters
<literal>&lt;</literal>, <literal>p</literal>, and
<literal>&gt;</literal>. But the phrase <quote>the
- <sgmltag>p</sgmltag> element</quote> refers to the whole
+ <tag>p</tag> element</quote> refers to the whole
element.</para>
<para>This distinction <emphasis>is</emphasis> very subtle. But
@@ -321,11 +320,11 @@
<para>An element's attributes are written
<emphasis>inside</emphasis> the start tag for that element, and
take the form
- <literal><replaceable>attribute-name</replaceable>="<replaceable>attribute-value</replaceable>"</literal>.</para>
+ <literal>attribute-name="attribute-value"</literal>.</para>
<para>In XHTML, the
- <sgmltag>p</sgmltag> element has an attribute called
- <sgmltag>align</sgmltag>, which suggests an alignment
+ <tag>p</tag> element has an attribute called
+ <tag>align</tag>, which suggests an alignment
(justification) for the paragraph to the program displaying the
XHTML.</para>
@@ -363,7 +362,7 @@
<para>The information on attributes, elements, and tags is stored
in XML catalogs. The various Documentation Project tools use
these catalog files to validate your work. The tools in
- <filename role="package">textproc/docproj</filename> include a
+ <package>textproc/docproj</package> include a
variety of XML catalog files. The FreeBSD Documentation
Project includes its own set of catalog files. Your tools need
to know about both sorts of catalog files.</para>
@@ -378,7 +377,7 @@
<procedure>
<step>
<para>Download and install
- <filename role="package">textproc/docproj</filename> from
+ <package>textproc/docproj</package> from
the FreeBSD ports system. This is a
<emphasis>meta-port</emphasis> that should download and
install all of the programs and supporting files that are
@@ -392,7 +391,7 @@
to substitute the correct directory for your
language.)</para>
- <example id="xml-primer-envars">
+ <example xml:id="xml-primer-envars">
<title><filename>.profile</filename>, for &man.sh.1; and
&man.bash.1; Users</title>
@@ -451,7 +450,7 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/xml/catalog:$SGML_CATAL
<para>Try to validate this file using an XML parser.</para>
<para>Part of
- <filename role="package">textproc/docproj</filename> is
+ <package>textproc/docproj</package> is
the <command>xmllint</command>
<link linkend="xml-primer-validating">validating
parser</link>.</para>
@@ -468,8 +467,8 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/xml/catalog:$SGML_CATAL
<step>
<para>See what happens when required elements are omitted.
- Try removing the <sgmltag>title</sgmltag> and
- <sgmltag>/title</sgmltag> tags, and re-run the
+ Try removing the <tag>title</tag> and
+ <tag>/title</tag> tags, and re-run the
validation.</para>
<screen>&prompt.user; <userinput>xmllint --valid --noout example.xml</userinput>
@@ -478,7 +477,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<para>This line tells you that the validation error comes from
the <replaceable>fifth</replaceable> line of the
<replaceable>example.xml</replaceable> file and that the
- content of the <sgmltag>head</sgmltag> is the part, which
+ content of the <tag>head</tag> is the part, which
does not follow the rules described by the XHTML grammar.</para>
<para>Below this line <command>xmllint</command> will show you
@@ -487,14 +486,14 @@ example.xml:5: element head: validity error : Element head content does not foll
</step>
<step>
- <para>Put the <sgmltag>title</sgmltag> element back
+ <para>Put the <tag>title</tag> element back
in.</para>
</step>
</procedure>
</sect2>
</sect1>
- <sect1 id="xml-primer-doctype-declaration">
+ <sect1 xml:id="xml-primer-doctype-declaration">
<title>The DOCTYPE Declaration</title>
<para>The beginning of each document that you write may specify
@@ -556,8 +555,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<para><literal>PUBLIC</literal> is not a part of the FPI,
but indicates to the XML processor how to find the DTD
referenced in the FPI. Other ways of telling the XML
- parser how to find the DTD are shown <link
- linkend="xml-primer-fpi-alternatives">later</link>.</para>
+ parser how to find the DTD are shown <link linkend="xml-primer-fpi-alternatives">later</link>.</para>
</listitem>
</varlistentry>
@@ -612,9 +610,9 @@ example.xml:5: element head: validity error : Element head content does not foll
(and a superset) of XML.</para>
<para>Otherwise, this string will either look like
- <literal>-//<replaceable>Owner</replaceable></literal>
+ <literal>-//Owner</literal>
or
- <literal>+//<replaceable>Owner</replaceable></literal>
+ <literal>+//Owner</literal>
(notice the only difference is the leading
<literal>+</literal> or <literal>-</literal>).</para>
@@ -703,8 +701,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<para>Look at the contents of
<filename>/usr/local/share/xml/dtd/xhtml/catalog.xml</filename>.
This is the catalog file for the XHTML DTDs that will have
- been installed as part of the <filename
- role="package">textproc/docproj</filename> port.</para>
+ been installed as part of the <package>textproc/docproj</package> port.</para>
</sect3>
<sect3>
@@ -747,7 +744,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect3>
</sect2>
- <sect2 id="xml-primer-fpi-alternatives">
+ <sect2 xml:id="xml-primer-fpi-alternatives">
<title>Alternatives to FPIs</title>
<para>Instead of using an FPI to indicate the DTD that the
@@ -772,7 +769,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-xml-escape">
+ <sect1 xml:id="xml-primer-xml-escape">
<title>Escaping Back to SGML</title>
<para>As mentioned earlier, XML is only used when writing a DTD.
@@ -798,7 +795,7 @@ example.xml:5: element head: validity error : Element head content does not foll
to include in your document&hellip;</para>
</sect1>
- <sect1 id="xml-primer-comments">
+ <sect1 xml:id="xml-primer-comments">
<title>Comments</title>
<para>Comments are an XML construction, and are normally only
@@ -813,7 +810,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<example>
<title>XML Generic Comment</title>
- <programlisting>&lt;!-- test comment --></programlisting>
+ <programlisting>&lt;!-- test comment --&gt;</programlisting>
<programlisting>
&lt;!&hyphen;- This is inside the comment -&hyphen;&gt;
@@ -887,7 +884,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-entities">
+ <sect1 xml:id="xml-primer-entities">
<title>Entities</title>
<para>Entities are a mechanism for assigning names to chunks of
@@ -904,19 +901,18 @@ example.xml:5: element head: validity error : Element head content does not foll
different situations; <emphasis>general entities</emphasis> and
<emphasis>parameter entities</emphasis>.</para>
- <sect2 id="xml-primer-general-entities">
+ <sect2 xml:id="xml-primer-general-entities">
<title>General Entities</title>
<para>You cannot use general entities in an XML context
(although you define them in one). They can only be used in
- your document. Contrast this with <link
- linkend="xml-primer-parameter-entities">parameter
+ your document. Contrast this with <link linkend="xml-primer-parameter-entities">parameter
entities</link>.</para>
<para>Each general entity has a name. When you want to
reference a general entity (and therefore include whatever
text it represents in your document), you write
- <literal>&amp;<replaceable>entity-name</replaceable>;</literal>.
+ <literal>&amp;entity-name;</literal>.
For example, suppose you had an entity called
<literal>current.version</literal> which expanded to the
current version number of your product. You could
@@ -967,22 +963,21 @@ example.xml:5: element head: validity error : Element head content does not foll
</example>
</sect2>
- <sect2 id="xml-primer-parameter-entities">
+ <sect2 xml:id="xml-primer-parameter-entities">
<title>Parameter Entities</title>
<para>Like <link linkend="xml-primer-general-entities">general
entities</link>, parameter entities are used to assign names
to reusable chunks of text. However, whereas general entities
can only be used within your document, parameter entities can
- only be used within an <link
- linkend="xml-primer-xml-escape">XML
+ only be used within an <link linkend="xml-primer-xml-escape">XML
context</link>.</para>
<para>Parameter entities are defined in a similar way to general
entities. However, instead of using
- <literal>&amp;<replaceable>entity-name</replaceable>;</literal>
+ <literal>&amp;entity-name;</literal>
to refer to them, use
- <literal>%<replaceable>entity-name</replaceable>;</literal>
+ <literal>%entity-name;</literal>
<footnote><para><emphasis>P</emphasis>arameter entities use
the <emphasis>P</emphasis>ercent
symbol.</para></footnote>. The definition also includes
@@ -1078,7 +1073,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-include">
+ <sect1 xml:id="xml-primer-include">
<title>Using Entities to Include Files</title>
<para>Entities (both
@@ -1087,7 +1082,7 @@ example.xml:5: element head: validity error : Element head content does not foll
are particularly useful when used to include one file inside
another.</para>
- <sect2 id="xml-primer-include-using-gen-entities">
+ <sect2 xml:id="xml-primer-include-using-gen-entities">
<title>Using General Entities to Include Files</title>
<para>Suppose you have some content for an XML book organized
@@ -1239,7 +1234,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<step>
<para>Load <filename>example.html</filename> into your web
browser, and confirm that the
- <filename>para<replaceable>n</replaceable>.xml</filename>
+ <filename>paran.xml</filename>
files have been included in
<filename>example.html</filename>.</para>
</step>
@@ -1299,7 +1294,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<step>
<para>Load <filename>example.html</filename> into your web
browser, and confirm that the
- <filename>para<replaceable>n</replaceable>.xml</filename>
+ <filename>paran.xml</filename>
files have been included in
<filename>example.html</filename>.</para>
</step>
@@ -1308,7 +1303,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-marked-sections">
+ <sect1 xml:id="xml-primer-marked-sections">
<title>Marked Sections</title>
<para>XML provides a mechanism to indicate that particular pieces
@@ -1383,13 +1378,13 @@ example.xml:5: element head: validity error : Element head content does not foll
<title>Using a <literal>CDATA</literal> Marked
Section</title>
- <programlisting>&lt;para>Here is an example of how you would include some text
- that contained many &lt;literal>&amp;lt;&lt;/literal>
- and &lt;literal>&amp;amp;&lt;/literal> symbols. The sample
- text is a fragment of XHTML. The surrounding text (&lt;para> and
- &lt;programlisting>) are from DocBook.&lt;/para>
+ <programlisting>&lt;para&gt;Here is an example of how you would include some text
+ that contained many &lt;literal&gt;&amp;lt;&lt;/literal&gt;
+ and &lt;literal&gt;&amp;amp;&lt;/literal&gt; symbols. The sample
+ text is a fragment of XHTML. The surrounding text (&lt;para&gt; and
+ &lt;programlisting&gt;) are from DocBook.&lt;/para&gt;
-&lt;programlisting>
+&lt;programlisting&gt;
&lt;![CDATA[<![CDATA[
<p>This is a sample that shows you some of the elements within
XHTML. Since the angle brackets are used so many times, it is
@@ -1405,7 +1400,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<p>This is the end of the example.</p>]]>
]]&gt;
-&lt;/programlisting></programlisting>
+&lt;/programlisting&gt;</programlisting>
<para>If you look at the source for this document you will
see this technique used throughout.</para>
@@ -1471,7 +1466,7 @@ example.xml:5: element head: validity error : Element head content does not foll
Section</title>
<programlisting>
-&lt;!ENTITY % electronic.copy "INCLUDE">
+&lt;!ENTITY % electronic.copy "INCLUDE"&gt;
&lt;![%electronic.copy;[
&lt;!ENTITY chap.preface SYSTEM "preface.xml"&gt;
@@ -1522,7 +1517,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-conclusion">
+ <sect1 xml:id="xml-primer-conclusion">
<title>Conclusion</title>
<para>That is the conclusion of this XML primer. For reasons of
diff --git a/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml
index ad0cd93676..1c4d177084 100644
--- a/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/structure/chapter.xml
@@ -30,12 +30,11 @@
$FreeBSD$
-->
-
-<chapter id="structure">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="structure">
<title>Documentation Directory Structure</title>
<para>Files and directories in the
- <filename class="directory">doc/</filename> tree follow a
+ <filename>doc/</filename> tree follow a
structure meant to:</para>
<orderedlist>
@@ -61,12 +60,12 @@
important that the documentation tree structure does not enforce
any particular defaults or cultural preferences.</para>
- <sect1 id="structure-top">
+ <sect1 xml:id="structure-top">
<title>The Top Level,
- <filename class="directory">doc/</filename></title>
+ <filename>doc/</filename></title>
<para>There are two types of directory under
- <filename class="directory">doc/</filename>, each with very
+ <filename>doc/</filename>, each with very
specific directory names and meanings.</para>
<informaltable pgwide="1" frame="none">
@@ -81,28 +80,26 @@
<tbody>
<row>
<entry valign="top">
- <filename class="directory">share</filename></entry>
+ <filename>share</filename></entry>
<entry>Contains files that are not specific to the various
translations and encodings of the documentation.
Contains subdirectories to further categorize the
information. For example, the files that comprise the
&man.make.1; infrastructure are in
- <filename class="directory">share/mk</filename>, while
+ <filename>share/mk</filename>, while
the additional <acronym>XML</acronym> support files
(such as the &os; extended DocBook
- <acronym>DTD</acronym>) are in <filename
- class="directory">share/xml</filename>.</entry>
+ <acronym>DTD</acronym>) are in <filename>share/xml</filename>.</entry>
</row>
<row>
- <entry valign="top"><filename
- class="directory"><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename></entry>
+ <entry valign="top"><filename>lang.encoding</filename></entry>
<entry>One directory exists for each available translation
and encoding of the documentation, for example
- <filename class="directory">en_US.ISO8859-1/</filename>
- and <filename class="directory">zh_TW.Big5/</filename>.
+ <filename>en_US.ISO8859-1/</filename>
+ and <filename>zh_TW.Big5/</filename>.
The names are long, but by fully specifying the language
and encoding we prevent any future headaches when a
translation team wants to provide documentation in the
@@ -115,9 +112,9 @@
</informaltable>
</sect1>
- <sect1 id="structure-locale">
+ <sect1 xml:id="structure-locale">
<title>The
- <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename>
+ <filename>lang.encoding/</filename>
Directories</title>
<para>These directories contain the documents themselves. The
@@ -136,10 +133,10 @@
<tbody>
<row>
<entry valign="top">
- <filename class="directory">articles</filename></entry>
+ <filename>articles</filename></entry>
<entry>Documentation marked up as a DocBook
- <sgmltag>article</sgmltag> (or equivalent). Reasonably
+ <tag>article</tag> (or equivalent). Reasonably
short, and broken up into sections. Normally only
available as one <acronym>XHTML</acronym> file.</entry>
</row>
@@ -148,7 +145,7 @@
<entry valign="top"><filename>books</filename></entry>
<entry>Documentation marked up as a DocBook
- <sgmltag>book</sgmltag> (or equivalent). Book length,
+ <tag>book</tag> (or equivalent). Book length,
and broken up into chapters. Normally available as both
one large <acronym>XHTML</acronym> file (for people with
fast connections, or who want to print it easily from a
@@ -158,11 +155,10 @@
<row>
<entry valign="top">
- <filename class="directory">man</filename></entry>
+ <filename>man</filename></entry>
<entry>For translations of the system manual pages. This
- directory will contain one or more <filename
- class="directory">man<replaceable>n</replaceable></filename>
+ directory will contain one or more <filename>mann</filename>
directories, corresponding to the sections that have
been translated.</entry>
</row>
@@ -170,14 +166,13 @@
</tgroup>
</informaltable>
- <para>Not every <filename
- class="directory"><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename>
+ <para>Not every <filename>lang.encoding</filename>
directory will have all of these subdirectories. It depends
on how much translation has been accomplished by that
translation team.</para>
</sect1>
- <sect1 id="structure-document">
+ <sect1 xml:id="structure-document">
<title>Document-Specific Information</title>
<para>This section contains specific notes about particular
@@ -192,12 +187,12 @@
using the &os; DocBook extended <acronym>DTD</acronym>.</para>
<para>The Handbook is organized as a DocBook
- <sgmltag>book</sgmltag>. The book is divided into
- <sgmltag>part</sgmltag>s, each of which contains several
- <sgmltag>chapter</sgmltag>s. <sgmltag>chapter</sgmltag>s are
- further subdivided into sections (<sgmltag>sect1</sgmltag>)
- and subsections (<sgmltag>sect2</sgmltag>,
- <sgmltag>sect3</sgmltag>) and so on.</para>
+ <tag>book</tag>. The book is divided into
+ <tag>part</tag>s, each of which contains several
+ <tag>chapter</tag>s. <tag>chapter</tag>s are
+ further subdivided into sections (<tag>sect1</tag>)
+ and subsections (<tag>sect2</tag>,
+ <tag>sect3</tag>) and so on.</para>
<sect3>
<title>Physical Organization</title>
@@ -228,38 +223,34 @@
<title><filename>book.xml</filename></title>
<para>This is the top level document in the Handbook. It
- contains the Handbook's <link
- linkend="xml-primer-doctype-declaration">DOCTYPE
+ contains the Handbook's <link linkend="xml-primer-doctype-declaration">DOCTYPE
declaration</link>, as well as the elements that
describe the Handbook's structure.</para>
- <para><filename>book.xml</filename> uses <link
- linkend="xml-primer-parameter-entities">parameter
+ <para><filename>book.xml</filename> uses <link linkend="xml-primer-parameter-entities">parameter
entities</link> to load in the files with the
<filename>.ent</filename> extension. These files
- (described later) then define <link
- linkend="xml-primer-general-entities">general
+ (described later) then define <link linkend="xml-primer-general-entities">general
entities</link> that are used throughout the rest of the
Handbook.</para>
</sect4>
<sect4>
- <title><filename
- class="directory"><replaceable>directory</replaceable>/chapter.xml</filename></title>
+ <title><filename>directory/chapter.xml</filename></title>
<para>Each chapter in the Handbook is stored in a file
called <filename>chapter.xml</filename> in a separate
directory from the other chapters. Each directory is
named after the value of the <literal>id</literal>
- attribute on the <sgmltag>chapter</sgmltag>
+ attribute on the <tag>chapter</tag>
element.</para>
<para>For example, if one of the chapter files
contains:</para>
- <programlisting><sgmltag class="starttag">chapter id="kernelconfig"</sgmltag>
+ <programlisting><tag class="starttag">chapter id="kernelconfig"</tag>
...
-<sgmltag class="endtag">chapter</sgmltag></programlisting>
+<tag class="endtag">chapter</tag></programlisting>
<para>Then it will be called
<filename>chapter.xml</filename> in the
@@ -277,10 +268,9 @@
stored in the same directory as
<filename>book.xml</filename>, and named after the value
of the <literal>id</literal> attribute on the file's
- <sgmltag>chapter</sgmltag> element. Now, it is possible
+ <tag>chapter</tag> element. Now, it is possible
to include images in each chapter. Images for each
- Handbook chapter are stored within <filename
- class="directory">share/images/books/handbook</filename>.
+ Handbook chapter are stored within <filename>share/images/books/handbook</filename>.
The localized version of these images should be
placed in the same directory as the <acronym>XML</acronym>
sources for each chapter. Namespace collisions are
diff --git a/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml
index a9905d4cf3..d8d48f16ae 100644
--- a/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<chapter id="stylesheets">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="stylesheets">
<title>Style Sheets</title>
<para><acronym>XML</acronym> is concerned with content, and says
@@ -51,7 +50,7 @@
<acronym>DSSSL</acronym> stylesheets, but this will probably
change in the future.</para>
- <sect1 id="stylesheets-css">
+ <sect1 xml:id="stylesheets-css">
<title><acronym>CSS</acronym></title>
<para>Cascading Style Sheets (<acronym>CSS</acronym>) are a
diff --git a/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
index e95a3ca560..a62fdbd2c0 100644
--- a/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml
@@ -30,57 +30,53 @@
$FreeBSD$
-->
-
-<chapter id="the-website">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="the-website">
<title>The Website</title>
- <sect1 id="the-website-build">
+ <sect1 xml:id="the-website-build">
<title>Build the Web Pages</title>
<para>Having obtained the documentation and web site source files,
the web site can be built. In this example, the build directory
- is <filename
- class="directory"><replaceable>~/doc</replaceable></filename>
+ is <filename>~/doc</filename>
and all the required files are already in place.</para>
<para>The web site is built from the
- <filename class="directory">en_US.ISO8859-1/htdocs</filename>
+ <filename>en_US.ISO8859-1/htdocs</filename>
subdirectory of the document tree directory,
- <filename class="directory">~/doc</filename> in this example.
+ <filename>~/doc</filename> in this example.
Change to the build directory and start the build by executing
<command>make all</command>.</para>
- <screen>&prompt.user; <userinput><command>cd</command> ~/doc/en_US.ISO8859-1/htdocs</userinput>
-&prompt.user; <userinput><command>make</command> <maketarget>all</maketarget></userinput></screen>
+ <screen>&prompt.user; <userinput>cd ~/doc/en_US.ISO8859-1/htdocs</userinput>
+&prompt.user; <userinput>make all</userinput></screen>
<tip>
<para>The web site build uses the <filename>INDEX</filename>
from the Ports Collection and may fail if that file or
- <filename class="directory">/usr/ports</filename> is not
- present. The simplest approach is to install the <ulink
- url="&url.books.handbook;/ports.html#ports-tree">Ports
- Collection</ulink>.</para>
+ <filename>/usr/ports</filename> is not
+ present. The simplest approach is to install the <link xlink:href="&url.books.handbook;/ports.html#ports-tree">Ports
+ Collection</link>.</para>
</tip>
</sect1>
- <sect1 id="the-website-install">
+ <sect1 xml:id="the-website-install">
<title>Install the Web Pages</title>
<para>Run <command>make install</command>, setting
- <makevar>DESTDIR</makevar> to the target directory for the web
+ <varname>DESTDIR</varname> to the target directory for the web
site files. The files will be installed in
- <filename class="directory">$DESTDIR/data</filename>, which is
+ <filename>$DESTDIR/data</filename>, which is
expected to be the web server's document root.</para>
- <para>This installation is run as the <username>root</username>
+ <para>This installation is run as the <systemitem class="username">root</systemitem>
user because the permissions on the web server directory will
not allow files to be installed by an unprivileged user. In
this example, the web site files were built by user
- <username>jru</username> in their home directory, <filename
- class="directory">/usr/home/jru/doc</filename>.</para>
+ <systemitem class="username">jru</systemitem> in their home directory, <filename>/usr/home/jru/doc</filename>.</para>
- <screen>&prompt.root; <userinput><command>cd</command> /home/jru/doc/en_US.ISO8859-1/htdocs</userinput>
-&prompt.root; <userinput><command>env</command> <makevar>DESTDIR</makevar>=<replaceable>/usr/local/www</replaceable> <command>make</command> <maketarget>install</maketarget></userinput></screen>
+ <screen>&prompt.root; <userinput>cd /home/jru/doc/en_US.ISO8859-1/htdocs</userinput>
+&prompt.root; <userinput>env DESTDIR=/usr/local/www make install</userinput></screen>
<para>The install process will not delete any old or outdated
files that existed previously in the same directory. If a new
@@ -88,54 +84,52 @@
will find and delete all files that have not been updated in
three days.</para>
- <screen>&prompt.root; <userinput><command>find</command> <replaceable>/usr/local/www</replaceable> <option>-ctime</option> 3 <option>-delete</option></userinput></screen>
+ <screen>&prompt.root; <userinput>find /usr/local/www -ctime 3 -delete</userinput></screen>
</sect1>
- <sect1 id="the-website-env">
+ <sect1 xml:id="the-website-env">
<title>Environment Variables</title>
<variablelist>
<varlistentry>
- <term><makevar>ENGLISH_ONLY</makevar></term>
+ <term><varname>ENGLISH_ONLY</varname></term>
<listitem>
<para>If set and not empty, only the English documents will
be built or installed. All translations will be ignored.
E.g.:</para>
- <screen>&prompt.root; <userinput><command>make</command> <makevar>ENGLISH_ONLY=YES</makevar> <maketarget>all</maketarget> <maketarget>install</maketarget></userinput></screen>
+ <screen>&prompt.root; <userinput>make ENGLISH_ONLY=YES all install</userinput></screen>
<para>To unset the variable and build all pages, including
- translations, set <makevar>ENGLISH_ONLY</makevar> to an
+ translations, set <varname>ENGLISH_ONLY</varname> to an
empty value:</para>
- <screen>&prompt.root; <userinput><command>make</command> <makevar>ENGLISH_ONLY=""</makevar> <maketarget>all</maketarget> <maketarget>install</maketarget> <maketarget>clean</maketarget></userinput></screen>
+ <screen>&prompt.root; <userinput>make ENGLISH_ONLY="" all install clean</userinput></screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><makevar>WEB_ONLY</makevar></term>
+ <term><varname>WEB_ONLY</varname></term>
<listitem>
<para>If set and not empty, only the <acronym>HTML</acronym>
- pages from the <filename
- class="directory">en_US.ISO8859-1/htdocs</filename>
+ pages from the <filename>en_US.ISO8859-1/htdocs</filename>
directory will be built or installed. All other
directories within
- <filename class="directory">en_US.ISO8859-1</filename>
+ <filename>en_US.ISO8859-1</filename>
(Handbook, FAQ, Tutorials) will be ignored. E.g.:</para>
- <screen>&prompt.root; <userinput><command>make</command> <makevar>WEB_ONLY=YES</makevar> <maketarget>all</maketarget> <maketarget>install</maketarget></userinput></screen>
+ <screen>&prompt.root; <userinput>make WEB_ONLY=YES all install</userinput></screen>
</listitem>
</varlistentry>
<varlistentry>
- <term><makevar>WEB_LANG</makevar></term>
+ <term><varname>WEB_LANG</varname></term>
<listitem>
<para>If set, build or install only for the languages
- specified by this variable inside the <filename
- class="directory"><replaceable>~/doc</replaceable></filename>
+ specified by this variable inside the <filename>~/doc</filename>
directory. All other languages except English will be
ignored. E.g.:</para>
@@ -144,8 +138,8 @@
</varlistentry>
</variablelist>
- <para><makevar>WEB_ONLY</makevar>, <makevar>WEB_LANG</makevar>,
- and <makevar>ENGLISH_ONLY</makevar> are &man.make.1; variables
+ <para><varname>WEB_ONLY</varname>, <varname>WEB_LANG</varname>,
+ and <varname>ENGLISH_ONLY</varname> are &man.make.1; variables
and can be set in <filename>/etc/make.conf</filename>,
<filename>Makefile.inc</filename>, as environment variables on
the command line, or in dot files.</para>
diff --git a/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml
index 7c14882085..c6a70729e3 100644
--- a/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<chapter id="tools">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="tools">
<title>Tools</title>
<para>Several software tools are used to manage the FreeBSD
@@ -41,11 +40,11 @@
optional, adding capabilities or making the job of creating
documentation less demanding.</para>
- <sect1 id="tools-required">
+ <sect1 xml:id="tools-required">
<title>Required Tools</title>
<para>Install
- <filename role="package">textproc/docproj</filename> from the
+ <package>textproc/docproj</package> from the
Ports Collection. This <emphasis>meta-port</emphasis> installs
all the applications required to do useful work with the &os;
documentation. Some further notes on particular components are
@@ -58,14 +57,13 @@
<para>&os; documentation uses several Document Type Definitions
(<acronym>DTD</acronym>s) and sets of <acronym>XML</acronym>
entities. These are all installed by the
- <filename role="package">textproc/docproj</filename>
+ <package>textproc/docproj</package>
port.</para>
<variablelist>
<varlistentry>
<term><acronym>XHTML</acronym> <acronym>DTD</acronym>
- (<filename
- role="package">textproc/xhtml</filename>)</term>
+ (<package>textproc/xhtml</package>)</term>
<listitem>
<para><acronym>XHTML</acronym> is the markup language of
@@ -75,8 +73,7 @@
</varlistentry>
<varlistentry>
- <term>DocBook <acronym>DTD</acronym> (<filename
- role="package">textproc/docbook-xml-450</filename>)</term>
+ <term>DocBook <acronym>DTD</acronym> (<package>textproc/docbook-xml-450</package>)</term>
<listitem>
<para>DocBook is designed for marking up technical
@@ -87,8 +84,7 @@
<varlistentry>
<term>ISO 8879 entities
- (<filename
- role="package">textproc/iso8879</filename>)</term>
+ (<package>textproc/iso8879</package>)</term>
<listitem>
<para>Character entities from the ISO 8879:1986 standard
@@ -102,7 +98,7 @@
</sect2>
</sect1>
- <sect1 id="tools-optional">
+ <sect1 xml:id="tools-optional">
<title>Optional Tools</title>
<para>These applications are not required, but can make working on
@@ -116,10 +112,9 @@
<term><application>JadeTeX</application>,
<application>teTeX</application> and Modular DocBook
Stylesheets
- (<filename role="package">print/jadetex</filename>,
- <filename role="package">print/teTeX</filename> and
- <filename
- role="package">textproc/dsssl-docbook-modular</filename>)</term>
+ (<package>print/jadetex</package>,
+ <package>print/teTeX</package> and
+ <package>textproc/dsssl-docbook-modular</package>)</term>
<listitem>
<para><application>Jade</application>,
@@ -132,14 +127,14 @@
<para>If <acronym>XHTML</acronym> and plain text output
formats are adequate, then this program is not needed
and the option to install it from the
- <filename role="package">textproc/docproj</filename>
+ <package>textproc/docproj</package>
configuration screen can be disabled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Vim</application>
- (<filename role="package">editors/vim</filename>)</term>
+ (<package>editors/vim</package>)</term>
<listitem>
<para>A popular editor for working with
@@ -151,8 +146,8 @@
<varlistentry>
<term><application>Emacs</application> or
<application>XEmacs</application>
- (<filename role="package">editors/emacs</filename> or
- <filename role="package">editors/xemacs</filename>)</term>
+ (<package>editors/emacs</package> or
+ <package>editors/xemacs</package>)</term>
<listitem>
<para>Both of these editors include a special mode for
diff --git a/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml
index 056b41ffce..be0b247ff9 100644
--- a/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/translations/chapter.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<chapter id="translations">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="translations">
<title>Translations</title>
<para>This is the FAQ for people translating the FreeBSD
@@ -87,9 +86,8 @@
<answer>
<para>Yes. Different translation groups have their own
- mailing lists. The <ulink
- url="http://www.freebsd.org/docproj/translations.html">list
- of translation projects</ulink> has more information about
+ mailing lists. The <link xlink:href="http://www.freebsd.org/docproj/translations.html">list
+ of translation projects</link> has more information about
the mailing lists and web sites run by each translation
project.</para>
</answer>
@@ -137,19 +135,16 @@
copy of the FreeBSD Subversion repository (at least the
documentation part). This can be done by running:</para>
- <screen>&prompt.user; <userinput><command>svn</command> checkout <replaceable>https://svn0.us-east.FreeBSD.org</replaceable>/doc/head/ head</userinput></screen>
+ <screen>&prompt.user; <userinput>svn checkout https://svn0.us-east.FreeBSD.org/doc/head/ head</userinput></screen>
- <para><ulink
- url="https://svn0.us-east.FreeBSD.org/">svn0.us-east.FreeBSD.org</ulink>
+ <para><link xlink:href="https://svn0.us-east.FreeBSD.org/">svn0.us-east.FreeBSD.org</link>
is a public <literal>SVN</literal> server.
Select the closest mirror and verify the mirror server
- certificate from the list of <ulink
- url="&url.books.handbook;/svn-mirrors.html">Subversion
- mirror sites</ulink>.</para>
+ certificate from the list of <link xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion
+ mirror sites</link>.</para>
<note>
- <para>This will require the <filename
- role="package">devel/subversion</filename> package to
+ <para>This will require the <package>devel/subversion</package> package to
be installed.</para>
</note>
@@ -163,7 +158,7 @@
<filename>en_US.ISO8859-1/books/fdp-primer/book.xml</filename>,
run:</para>
- <screen>&prompt.user; <userinput><command>svn</command> diff -r<replaceable>33733</replaceable>:<replaceable>33734</replaceable> <filename>en_US.ISO8859-1/books/fdp-primer/book.xml</filename></userinput></screen>
+ <screen>&prompt.user; <userinput>svn diff -r33733:33734 en_US.ISO8859-1/books/fdp-primer/book.xml</userinput></screen>
</answer>
</qandaentry>
@@ -174,9 +169,8 @@
</question>
<answer>
- <para>The <ulink
- url="http://www.FreeBSD.org/docproj/translations.html">Documentation
- Project translations page</ulink> lists the translation
+ <para>The <link xlink:href="http://www.FreeBSD.org/docproj/translations.html">Documentation
+ Project translations page</link> lists the translation
efforts that are currently known about. If others are
already working on translating documentation to your
language, please do not duplicate their efforts. Instead,
@@ -290,7 +284,7 @@
<para><literal>sv_SE.ISO8859-1</literal> is the name of the
translation, in
- <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename>
+ <filename>lang.encoding</filename>
form. Note the two Makefiles, which will be used to build
the documentation.</para>
@@ -389,8 +383,7 @@
of the entity, and a semi-colon (;).</para>
<para>The entity names are defined in ISO8879, which is in the
- ports tree as <filename
- role="package">textproc/iso8879</filename>.</para>
+ ports tree as <package>textproc/iso8879</package>.</para>
<para>A few examples include:</para>
@@ -472,7 +465,7 @@
<para>Your translated documents should include their own
&dollar;FreeBSD&dollar; line, and change the
<literal>FreeBSD Documentation Project</literal> line to
- <literal>The FreeBSD <replaceable>language</replaceable>
+ <literal>The FreeBSD language
Documentation Project</literal>.</para>
<para>In addition, you should add a third line which indicates
diff --git a/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml
index bc725c1544..007a6cb061 100644
--- a/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml
@@ -27,8 +27,7 @@
$FreeBSD$
-->
-
-<chapter id="working-copy">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="working-copy">
<title>The Working Copy</title>
<para>The <emphasis>working copy</emphasis> is a copy of the &os;
@@ -42,13 +41,12 @@
for temporary files and test versions of various output
formats.</para>
- <para><ulink
- url="&url.books.handbook;/svn.html"><application>Subversion</application></ulink>
+ <para><link xlink:href="&url.books.handbook;/svn.html"><application>Subversion</application></link>
is used to manage the &os; documentation files. It is installed
- by <filename role="package">textproc/docproj</filename> as one of
+ by <package>textproc/docproj</package> as one of
the required applications.</para>
- <sect1 id="working-copy-doc-and-src">
+ <sect1 xml:id="working-copy-doc-and-src">
<title>Documentation and Manual Pages</title>
<para>&os; documentation is not just books and articles. Manual
@@ -65,34 +63,33 @@
to the latest version, called <literal>head</literal>.</para>
</sect1>
- <sect1 id="working-copy-choosing-mirror">
+ <sect1 xml:id="working-copy-choosing-mirror">
<title>Choosing a Mirror</title>
<para>To increase speed and reduce download time, select a mirror
- from the list of <ulink
- url="&url.books.handbook;/svn-mirrors.html">Subversion
- mirror sites</ulink> that is close to your location.
+ from the list of <link xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion
+ mirror sites</link> that is close to your location.
Substitute the chosen mirror <acronym>URL</acronym> for the
<replaceable>https://svn0.us-west.FreeBSD.org/</replaceable>
used in these examples.</para>
</sect1>
- <sect1 id="working-copy-choosing-directory">
+ <sect1 xml:id="working-copy-choosing-directory">
<title>Choosing a Directory</title>
<para>&os; documentation is traditionally stored in
- <filename class="directory">/usr/doc/</filename>, and system
+ <filename>/usr/doc/</filename>, and system
source code with manual pages in
- <filename class="directory">/usr/src/</filename>. These
+ <filename>/usr/src/</filename>. These
directory trees are relocatable, and users may want to put the
working copies in other locations to avoid interfering with
existing information in the main directories. The examples
- that follow use <filename class="directory">~/doc</filename>
- and <filename class="directory">~/src</filename>, both
+ that follow use <filename>~/doc</filename>
+ and <filename>~/src</filename>, both
subdirectories of the user's home directory.</para>
</sect1>
- <sect1 id="working-copy-checking-out">
+ <sect1 xml:id="working-copy-checking-out">
<title>Checking Out a Copy</title>
<para>A download of a working copy from the repository is called
@@ -101,15 +98,15 @@
copy of the latest version (<literal>head</literal>) of
the main documentation tree:</para>
- <screen>&prompt.user; <userinput>svn checkout <replaceable>https://svn0.us-west.FreeBSD.org/doc/head</replaceable> <replaceable>~/doc</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc</userinput></screen>
<para>A checkout of the source code to work on manual pages is
very similar:</para>
- <screen>&prompt.user; <userinput>svn checkout <replaceable>https://svn0.us-west.FreeBSD.org/base/head</replaceable> <replaceable>~/src</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>svn checkout https://svn0.us-west.FreeBSD.org/base/head ~/src</userinput></screen>
</sect1>
- <sect1 id="working-copy-updating">
+ <sect1 xml:id="working-copy-updating">
<title>Updating a Working Copy</title>
<para>The documents and files in the &os; repository change daily.
@@ -121,7 +118,7 @@
<command>svn update</command> on the directory containing the
local working copy:</para>
- <screen>&prompt.user; <userinput>svn update <replaceable>~/doc</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>svn update ~/doc</userinput></screen>
<para>Get in the protective habit of using
<command>svn update</command> before editing document files.
@@ -132,7 +129,7 @@
the newer version from the repository.</para>
</sect1>
- <sect1 id="working-copy-revert">
+ <sect1 xml:id="working-copy-revert">
<title>Reverting Changes</title>
<para>Sometimes it turns out that changes were
@@ -145,7 +142,7 @@
<screen>&prompt.user; <userinput>svn revert chapter.xml</userinput></screen>
</sect1>
- <sect1 id="working-copy-making-diff">
+ <sect1 xml:id="working-copy-making-diff">
<title>Making a Diff</title>
<para>After edits to a file or group of files are completed, the
@@ -155,16 +152,16 @@
by redirecting the output of <command>svn diff</command> into a
file:</para>
- <screen>&prompt.user; <userinput>cd <replaceable>~/doc</replaceable></userinput>
-&prompt.user; <userinput>svn diff &gt; <replaceable>doc-fix-spelling.diff</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>cd ~/doc</userinput>
+&prompt.user; <userinput>svn diff &gt; doc-fix-spelling.diff</userinput></screen>
<para>Give the file a meaningful name that identifies the
contents. The example above is for spelling fixes to the whole
documentation tree.</para>
<para>If the diff file is to be submitted with the web
- <quote><ulink url="&url.base;/send-pr.html">Submit a &os;
- problem report</ulink></quote> interface, add a
+ <quote><link xlink:href="&url.base;/send-pr.html">Submit a &os;
+ problem report</link></quote> interface, add a
<filename>.txt</filename> extension to give the earnest and
simple-minded web form a clue that the contents are plain
text.</para>
@@ -175,19 +172,17 @@
be submitted yet, provide a list of only the files that are to
be included:</para>
- <screen>&prompt.user; <userinput>cd <replaceable>~/doc</replaceable></userinput>
-&prompt.user; <userinput>svn diff <replaceable>disks/chapter.xml printers/chapter.xml</replaceable> &gt; <replaceable>disks-printers.diff</replaceable></userinput></screen>
+ <screen>&prompt.user; <userinput>cd ~/doc</userinput>
+&prompt.user; <userinput>svn diff disks/chapter.xml printers/chapter.xml &gt; disks-printers.diff</userinput></screen>
</sect1>
- <sect1 id="working-copy-subversion-references">
+ <sect1 xml:id="working-copy-subversion-references">
<title><application>Subversion</application> References</title>
<para>These examples show very basic usage of
<application>Subversion</application>. More detail is available
- in the <ulink
- url="http://svnbook.red-bean.com/">Subversion Book</ulink>
- and the <ulink
- url="http://subversion.apache.org/docs/">Subversion
- documentation</ulink>.</para>
+ in the <link xlink:href="http://svnbook.red-bean.com/">Subversion Book</link>
+ and the <link xlink:href="http://subversion.apache.org/docs/">Subversion
+ documentation</link>.</para>
</sect1>
</chapter>
diff --git a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml
index d492ffde43..b461547327 100644
--- a/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml
@@ -30,11 +30,10 @@
$FreeBSD$
-->
-
-<chapter id="writing-style">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="writing-style">
<title>Writing Style</title>
- <sect1 id="writing-style-tips">
+ <sect1 xml:id="writing-style-tips">
<title>Tips</title>
<para>Technical documentation can be improved by consistent use of
@@ -45,7 +44,7 @@
each other. Good writing consists of a balance between
them.</para>
- <sect2 id="writing-style-be-clear">
+ <sect2 xml:id="writing-style-be-clear">
<title>Be Clear</title>
<para>Clarity is extremely important. The reader may be a
@@ -91,7 +90,7 @@
<quote>do this</quote>.</para>
</sect2>
- <sect2 id="writing-style-be-complete">
+ <sect2 xml:id="writing-style-be-complete">
<title>Be Complete</title>
<para>Do not make assumptions about the reader's abilities or
@@ -102,7 +101,7 @@
them.</para>
</sect2>
- <sect2 id="writing-style-be-concise">
+ <sect2 xml:id="writing-style-be-concise">
<title>Be Concise</title>
<para>While features should be documented completely, sometimes
@@ -115,7 +114,7 @@
</sect2>
</sect1>
- <sect1 id="writing-style-guidelines">
+ <sect1 xml:id="writing-style-guidelines">
<title>Guidelines</title>
<para>To promote consistency between the myriad authors of the
@@ -219,7 +218,7 @@
</informalexample>
<para>Manual page references (the second example uses
- <sgmltag>citerefentry</sgmltag> with the
+ <tag>citerefentry</tag> with the
<literal>&amp;man.csh.1;</literal> entity):.</para>
<informalexample>
@@ -250,12 +249,11 @@
</varlistentry>
</variablelist>
- <para>For more information about writing style, see <ulink
- url="http://www.bartleby.com/141/">Elements of
- Style</ulink>, by William Strunk.</para>
+ <para>For more information about writing style, see <link xlink:href="http://www.bartleby.com/141/">Elements of
+ Style</link>, by William Strunk.</para>
</sect1>
- <sect1 id="writing-style-guide">
+ <sect1 xml:id="writing-style-guide">
<title>Style Guide</title>
<para>To keep the source for the documentation consistent when
@@ -265,8 +263,8 @@
<sect2>
<title>Letter Case</title>
- <para>Tags are entered in lower case, <sgmltag>para</sgmltag>,
- <emphasis>not</emphasis> <sgmltag>PARA</sgmltag>.</para>
+ <para>Tags are entered in lower case, <tag>para</tag>,
+ <emphasis>not</emphasis> <tag>PARA</tag>.</para>
<para>Text that appears in SGML contexts is generally written in
upper case, <literal>&lt;!ENTITY&hellip;&gt;</literal>, and
@@ -276,7 +274,7 @@
<literal>&lt;!doctype&hellip;&gt;</literal>.</para>
</sect2>
- <sect2 id="writing-style-acronyms">
+ <sect2 xml:id="writing-style-acronyms">
<title>Acronyms</title>
<para>Acronyms should be defined the first time they appear in a
@@ -288,10 +286,10 @@
document.</para>
<para>All acronyms should be enclosed in
- <sgmltag>acronym</sgmltag> tags.</para>
+ <tag>acronym</tag> tags.</para>
</sect2>
- <sect2 id="writing-style-indentation">
+ <sect2 xml:id="writing-style-indentation">
<title>Indentation</title>
<para>The first line in each file starts with no indentation,
@@ -309,33 +307,33 @@
<para>For example, the source for this section looks like
this:</para>
- <programlisting><sgmltag class="starttag">chapter</sgmltag>
- <sgmltag class="starttag">title</sgmltag>...<sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">chapter</tag>
+ <tag class="starttag">title</tag>...<tag class="endtag">title</tag>
- <sgmltag class="starttag">sect1</sgmltag>
- <sgmltag class="starttag">title</sgmltag>...<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect1</tag>
+ <tag class="starttag">title</tag>...<tag class="endtag">title</tag>
- <sgmltag class="starttag">sect2</sgmltag>
- <sgmltag class="starttag">title</sgmltag>Indentation<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect2</tag>
+ <tag class="starttag">title</tag>Indentation<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>The first line in each file starts with no indentation,
- <sgmltag class="starttag">emphasis</sgmltag>regardless<sgmltag class="endtag">emphasis</sgmltag> of the indentation level of
- the file which might contain the current file.<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">para</tag>The first line in each file starts with no indentation,
+ <tag class="starttag">emphasis</tag>regardless<tag class="endtag">emphasis</tag> of the indentation level of
+ the file which might contain the current file.<tag class="endtag">para</tag>
...
- <sgmltag class="endtag">sect2</sgmltag>
- <sgmltag class="endtag">sect1</sgmltag>
-<sgmltag class="endtag">chapter</sgmltag></programlisting>
+ <tag class="endtag">sect2</tag>
+ <tag class="endtag">sect1</tag>
+<tag class="endtag">chapter</tag></programlisting>
<para>Configurations to help various text editors conform to
these guidelines can be found in
<xref linkend="editor-config"/>.</para>
</sect2>
- <sect2 id="writing-style-tag-style">
+ <sect2 xml:id="writing-style-tag-style">
<title>Tag Style</title>
- <sect3 id="writing-style-tag-style-spacing">
+ <sect3 xml:id="writing-style-tag-style-spacing">
<title>Tag Spacing</title>
<para>Tags that start at the same indent as a previous tag
@@ -343,44 +341,44 @@
at the same indent as a previous tag should not:</para>
<informalexample>
- <programlisting><sgmltag class="starttag">article lang='en'</sgmltag>
- <sgmltag class="starttag">articleinfo</sgmltag>
- <sgmltag class="starttag">title</sgmltag>NIS<sgmltag class="endtag">title</sgmltag>
+ <programlisting><tag class="starttag">article lang='en'</tag>
+ <tag class="starttag">articleinfo</tag>
+ <tag class="starttag">title</tag>NIS<tag class="endtag">title</tag>
- <sgmltag class="starttag">pubdate</sgmltag>October 1999<sgmltag class="endtag">pubdate</sgmltag>
+ <tag class="starttag">pubdate</tag>October 1999<tag class="endtag">pubdate</tag>
- <sgmltag class="starttag">abstract</sgmltag>
- <sgmltag class="starttag">para</sgmltag>...
+ <tag class="starttag">abstract</tag>
+ <tag class="starttag">para</tag>...
...
- ...<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">abstract</sgmltag>
- <sgmltag class="endtag">articleinfo</sgmltag>
+ ...<tag class="endtag">para</tag>
+ <tag class="endtag">abstract</tag>
+ <tag class="endtag">articleinfo</tag>
- <sgmltag class="starttag">sect1</sgmltag>
- <sgmltag class="starttag">title</sgmltag>...<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect1</tag>
+ <tag class="starttag">title</tag>...<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>...<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">sect1</sgmltag>
+ <tag class="starttag">para</tag>...<tag class="endtag">para</tag>
+ <tag class="endtag">sect1</tag>
- <sgmltag class="starttag">sect1</sgmltag>
- <sgmltag class="starttag">title</sgmltag>...<sgmltag class="endtag">title</sgmltag>
+ <tag class="starttag">sect1</tag>
+ <tag class="starttag">title</tag>...<tag class="endtag">title</tag>
- <sgmltag class="starttag">para</sgmltag>...<sgmltag class="endtag">para</sgmltag>
- <sgmltag class="endtag">sect1</sgmltag>
-<sgmltag class="endtag">article</sgmltag></programlisting>
+ <tag class="starttag">para</tag>...<tag class="endtag">para</tag>
+ <tag class="endtag">sect1</tag>
+<tag class="endtag">article</tag></programlisting>
</informalexample>
</sect3>
- <sect3 id="writing-style-tag-style-separating">
+ <sect3 xml:id="writing-style-tag-style-separating">
<title>Separating Tags</title>
- <para>Tags like <sgmltag>itemizedlist</sgmltag> which will
+ <para>Tags like <tag>itemizedlist</tag> which will
always have further tags inside them, and in fact do not
take character data themselves, are always on a line by
themselves.</para>
- <para>Tags like <sgmltag>para</sgmltag> and
- <sgmltag>term</sgmltag> do not need other tags to contain
+ <para>Tags like <tag>para</tag> and
+ <tag>term</tag> do not need other tags to contain
normal character data, and their contents begin immediately
after the tag, <emphasis>on the same line</emphasis>.</para>
@@ -401,7 +399,7 @@
</sect3>
</sect2>
- <sect2 id="writing-style-whitespace-changes">
+ <sect2 xml:id="writing-style-whitespace-changes">
<title>Whitespace Changes</title>
<para><emphasis>Do not commit changes
@@ -421,7 +419,7 @@
ignored by translators.</para>
</sect2>
- <sect2 id="writing-style-nonbreaking-space">
+ <sect2 xml:id="writing-style-nonbreaking-space">
<title>Non-Breaking Space</title>
<para>Avoid line breaks in places where they look ugly or make
@@ -459,7 +457,7 @@ GB. Hardware compression &hellip;</literallayout>
</sect2>
</sect1>
- <sect1 id="writing-style-word-list">
+ <sect1 xml:id="writing-style-word-list">
<title>Word List</title>
<para>This list of words shows the correct spelling and
@@ -480,16 +478,12 @@ GB. Hardware compression &hellip;</literallayout>
<row>
<entry>CD-ROM</entry>
- <entry><sgmltag
- class="starttag">acronym</sgmltag><literal>CD-ROM</literal><sgmltag
- class="endtag">acronym</sgmltag></entry>
+ <entry><tag class="starttag">acronym</tag><literal>CD-ROM</literal><tag class="endtag">acronym</tag></entry>
</row>
<row>
<entry>DoS (Denial of Service)</entry>
- <entry><sgmltag
- class="starttag">acronym</sgmltag><literal>DoS</literal><sgmltag
- class="endtag">acronym</sgmltag></entry>
+ <entry><tag class="starttag">acronym</tag><literal>DoS</literal><tag class="endtag">acronym</tag></entry>
</row>
<row>
@@ -535,14 +529,10 @@ GB. Hardware compression &hellip;</literallayout>
<row>
<entry>Subversion</entry>
- <entry><sgmltag
- class="starttag">application</sgmltag><literal>Subversion</literal><sgmltag
- class="endtag">application</sgmltag></entry>
+ <entry><tag class="starttag">application</tag><literal>Subversion</literal><tag class="endtag">application</tag></entry>
<entry>Do not refer to the Subversion application as
<literal>SVN</literal> in upper case. To refer to the
- command, use <sgmltag
- class="starttag">command</sgmltag><literal>svn</literal><sgmltag
- class="endtag">command</sgmltag>.</entry>
+ command, use <tag class="starttag">command</tag><literal>svn</literal><tag class="endtag">command</tag>.</entry>
</row>
<row>
diff --git a/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml
index eded9cac18..f0894d63fe 100644
--- a/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml
@@ -30,11 +30,10 @@
$FreeBSD$
-->
-
-<chapter id="xhtml-markup">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="xhtml-markup">
<title><acronym>XHTML</acronym> Markup</title>
- <sect1 id="xhtml-markup-introduction">
+ <sect1 xml:id="xhtml-markup-introduction">
<title>Introduction</title>
<para>This chapter describes usage of the <acronym>XHTML</acronym>
@@ -43,7 +42,7 @@
<para><acronym>XHTML</acronym> is the <acronym>XML</acronym>
version of the HyperText Markup Language, the markup language of
choice on the World Wide Web. More information can be found at
- <ulink url="http://www.w3.org/"></ulink>.</para>
+ <uri xlink:href="http://www.w3.org/">http://www.w3.org/</uri>.</para>
<para><acronym>XHTML</acronym> is used to mark up pages on the
&os; web site. It is usually not used to mark up other
@@ -61,9 +60,8 @@
<para>The <acronym>XHTML</acronym> <acronym>DTDs</acronym> are
available from the Ports Collection in
- <filename role="package">textproc/xhtml</filename>. They are
- automatically installed by the <filename
- role="package">textproc/docproj</filename> port.</para>
+ <package>textproc/xhtml</package>. They are
+ automatically installed by the <package>textproc/docproj</package> port.</para>
<note>
<para>This is <emphasis>not</emphasis> an exhaustive list of
@@ -85,7 +83,7 @@
</note>
</sect1>
- <sect1 id="xhtml-markup-fpi">
+ <sect1 xml:id="xhtml-markup-fpi">
<title>Formal Public Identifier (<acronym>FPI</acronym>)</title>
<para>There are a number of <acronym>XHTML</acronym>
@@ -98,7 +96,7 @@
<programlisting>PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"</programlisting>
</sect1>
- <sect1 id="xhtml-markup-sectional-elements">
+ <sect1 xml:id="xhtml-markup-sectional-elements">
<title>Sectional Elements</title>
<para>An <acronym>XHTML</acronym> document is normally split into
@@ -109,113 +107,113 @@
<emphasis>body</emphasis>, contains content that will be
displayed to the user.</para>
- <para>These sections are indicated with <sgmltag>head</sgmltag>
- and <sgmltag>body</sgmltag> elements respectively. These
+ <para>These sections are indicated with <tag>head</tag>
+ and <tag>body</tag> elements respectively. These
elements are contained within the top-level
- <sgmltag>html</sgmltag> element.</para>
+ <tag>html</tag> element.</para>
<example>
<title>Normal <acronym>XHTML</acronym> Document
Structure</title>
- <programlisting><sgmltag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</sgmltag>
- <sgmltag class="starttag">head</sgmltag>
- <sgmltag class="starttag">title</sgmltag><replaceable>The Document's Title</replaceable><sgmltag class="endtag">title</sgmltag>
- <sgmltag class="endtag">head</sgmltag>
+ <programlisting><tag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</tag>
+ <tag class="starttag">head</tag>
+ <tag class="starttag">title</tag><replaceable>The Document's Title</replaceable><tag class="endtag">title</tag>
+ <tag class="endtag">head</tag>
- <sgmltag class="starttag">body</sgmltag>
+ <tag class="starttag">body</tag>
&hellip;
- <sgmltag class="endtag">body</sgmltag>
-<sgmltag class="endtag">html</sgmltag></programlisting>
+ <tag class="endtag">body</tag>
+<tag class="endtag">html</tag></programlisting>
</example>
</sect1>
- <sect1 id="xhtml-markup-block-elements">
+ <sect1 xml:id="xhtml-markup-block-elements">
<title>Block Elements</title>
- <sect2 id="xhtml-markup-block-elements-headings">
+ <sect2 xml:id="xhtml-markup-block-elements-headings">
<title>Headings</title>
<para><acronym>XHTML</acronym> has tags to denote headings in
the document at up to six different levels.</para>
<para>The largest and most prominent heading is
- <sgmltag>h1</sgmltag>, then <sgmltag>h2</sgmltag>,
- continuing down to <sgmltag>h6</sgmltag>.</para>
+ <tag>h1</tag>, then <tag>h2</tag>,
+ continuing down to <tag>h6</tag>.</para>
<para>The element's content is the text of the heading.</para>
<example>
- <title><sgmltag>h1</sgmltag>, <sgmltag>h2</sgmltag>,
+ <title><tag>h1</tag>, <tag>h2</tag>,
and Other Header Tags</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">h1</sgmltag>First section<sgmltag class="endtag">h1</sgmltag>
+ <programlisting><tag class="starttag">h1</tag>First section<tag class="endtag">h1</tag>
&lt;!-- Document introduction goes here --&gt;
-<sgmltag class="starttag">h2</sgmltag>This is the heading for the first section<sgmltag class="endtag">h2</sgmltag>
+<tag class="starttag">h2</tag>This is the heading for the first section<tag class="endtag">h2</tag>
&lt;!-- Content for the first section goes here --&gt;
-<sgmltag class="starttag">h3</sgmltag>This is the heading for the first sub-section<sgmltag class="endtag">h3</sgmltag>
+<tag class="starttag">h3</tag>This is the heading for the first sub-section<tag class="endtag">h3</tag>
&lt;!-- Content for the first sub-section goes here --&gt;
-<sgmltag class="starttag">h2</sgmltag>This is the heading for the second section<sgmltag class="endtag">h2</sgmltag>
+<tag class="starttag">h2</tag>This is the heading for the second section<tag class="endtag">h2</tag>
&lt;!-- Content for the second section goes here --&gt;</programlisting>
</example>
<para>Generally, an <acronym>XHTML</acronym> page should have
- one first level heading (<sgmltag>h1</sgmltag>). This can
- contain many second level headings (<sgmltag>h2</sgmltag>),
+ one first level heading (<tag>h1</tag>). This can
+ contain many second level headings (<tag>h2</tag>),
which can in turn contain many third level headings. Do not
leave gaps in the numbering.</para>
</sect2>
- <sect2 id="xhtml-markup-block-elements-paragraphs">
+ <sect2 xml:id="xhtml-markup-block-elements-paragraphs">
<title>Paragraphs</title>
<para><acronym>XHTML</acronym> supports a single paragraph
- element, <sgmltag>p</sgmltag>.</para>
+ element, <tag>p</tag>.</para>
<example>
- <title><sgmltag>p</sgmltag></title>
+ <title><tag>p</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>This is a paragraph. It can contain just about any
- other element.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p</tag>This is a paragraph. It can contain just about any
+ other element.<tag class="endtag">p</tag></programlisting>
</example>
</sect2>
- <sect2 id="xhtml-markup-block-elements-block-quotations">
+ <sect2 xml:id="xhtml-markup-block-elements-block-quotations">
<title>Block Quotations</title>
<para>A block quotation is an extended quotation from another
document that will appear in a separate paragraph.</para>
<example>
- <title><sgmltag>blockquote</sgmltag></title>
+ <title><tag>blockquote</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>A small excerpt from the US Constitution:<sgmltag class="endtag">p</sgmltag>
+ <programlisting><tag class="starttag">p</tag>A small excerpt from the US Constitution:<tag class="endtag">p</tag>
-<sgmltag class="starttag">blockquote</sgmltag>We the People of the United States, in Order to form
+<tag class="starttag">blockquote</tag>We the People of the United States, in Order to form
a more perfect Union, establish Justice, insure domestic
Tranquility, provide for the common defence, promote the general
Welfare, and secure the Blessings of Liberty to ourselves and our
Posterity, do ordain and establish this Constitution for the
- United States of America.<sgmltag class="endtag">blockquote</sgmltag></programlisting>
+ United States of America.<tag class="endtag">blockquote</tag></programlisting>
</example>
</sect2>
- <sect2 id="xhtml-markup-block-elements-lists">
+ <sect2 xml:id="xhtml-markup-block-elements-lists">
<title>Lists</title>
<para><acronym>XHTML</acronym> can present the user with three
@@ -227,79 +225,79 @@
section is the term being defined, and the second section is
the definition.</para>
- <para>Ordered lists are indicated by the <sgmltag>ol</sgmltag>
- element, unordered lists by the <sgmltag>ul</sgmltag>
- element, and definition lists by the <sgmltag>dl</sgmltag>
+ <para>Ordered lists are indicated by the <tag>ol</tag>
+ element, unordered lists by the <tag>ul</tag>
+ element, and definition lists by the <tag>dl</tag>
element.</para>
<para>Ordered and unordered lists contain listitems, indicated
- by the <sgmltag>li</sgmltag> element. A listitem can
+ by the <tag>li</tag> element. A listitem can
contain textual content, or it may be further wrapped in one
- or more <sgmltag>p</sgmltag> elements.</para>
+ or more <tag>p</tag> elements.</para>
<para>Definition lists contain definition terms
- (<sgmltag>dt</sgmltag>) and definition descriptions
- (<sgmltag>dd</sgmltag>). A definition term can only contain
+ (<tag>dt</tag>) and definition descriptions
+ (<tag>dd</tag>). A definition term can only contain
inline elements. A definition description can contain other
block elements.</para>
<example>
- <title><sgmltag>ul</sgmltag> and
- <sgmltag>ol</sgmltag></title>
+ <title><tag>ul</tag> and
+ <tag>ol</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>An unordered list. Listitems will probably be
- preceded by bullets.<sgmltag class="endtag">p</sgmltag>
+ <programlisting><tag class="starttag">p</tag>An unordered list. Listitems will probably be
+ preceded by bullets.<tag class="endtag">p</tag>
-<sgmltag class="starttag">ul</sgmltag>
- <sgmltag class="starttag">li</sgmltag>First item<sgmltag class="endtag">li</sgmltag>
+<tag class="starttag">ul</tag>
+ <tag class="starttag">li</tag>First item<tag class="endtag">li</tag>
- <sgmltag class="starttag">li</sgmltag>Second item<sgmltag class="endtag">li</sgmltag>
+ <tag class="starttag">li</tag>Second item<tag class="endtag">li</tag>
- <sgmltag class="starttag">li</sgmltag>Third item<sgmltag class="endtag">li</sgmltag>
-<sgmltag class="endtag">ul</sgmltag>
+ <tag class="starttag">li</tag>Third item<tag class="endtag">li</tag>
+<tag class="endtag">ul</tag>
-<sgmltag class="starttag">p</sgmltag>An ordered list, with list items consisting of multiple
+<tag class="starttag">p</tag>An ordered list, with list items consisting of multiple
paragraphs. Each item (note: not each paragraph) will be
- numbered.<sgmltag class="endtag">p</sgmltag>
+ numbered.<tag class="endtag">p</tag>
-<sgmltag class="starttag">ol</sgmltag>
- <sgmltag class="starttag">li</sgmltag><sgmltag class="starttag">p</sgmltag>This is the first item. It only has one paragraph.<sgmltag class="endtag">p</sgmltag><sgmltag class="endtag">li</sgmltag>
+<tag class="starttag">ol</tag>
+ <tag class="starttag">li</tag><tag class="starttag">p</tag>This is the first item. It only has one paragraph.<tag class="endtag">p</tag><tag class="endtag">li</tag>
- <sgmltag class="starttag">li</sgmltag><sgmltag class="starttag">p</sgmltag>This is the first paragraph of the second item.<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">li</tag><tag class="starttag">p</tag>This is the first paragraph of the second item.<tag class="endtag">p</tag>
- <sgmltag class="starttag">p</sgmltag>This is the second paragraph of the second item.<sgmltag class="endtag">p</sgmltag><sgmltag class="endtag">li</sgmltag>
+ <tag class="starttag">p</tag>This is the second paragraph of the second item.<tag class="endtag">p</tag><tag class="endtag">li</tag>
- <sgmltag class="starttag">li</sgmltag><sgmltag class="starttag">p</sgmltag>This is the first and only paragraph of the third
- item.<sgmltag class="endtag">p</sgmltag><sgmltag class="endtag">li</sgmltag>
-<sgmltag class="endtag">ol</sgmltag></programlisting>
+ <tag class="starttag">li</tag><tag class="starttag">p</tag>This is the first and only paragraph of the third
+ item.<tag class="endtag">p</tag><tag class="endtag">li</tag>
+<tag class="endtag">ol</tag></programlisting>
</example>
<example>
- <title>Definition Lists with <sgmltag>dl</sgmltag></title>
+ <title>Definition Lists with <tag>dl</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">dl</sgmltag>
- <sgmltag class="starttag">dt</sgmltag>Term 1<sgmltag class="endtag">dt</sgmltag>
+ <programlisting><tag class="starttag">dl</tag>
+ <tag class="starttag">dt</tag>Term 1<tag class="endtag">dt</tag>
- <sgmltag class="starttag">dd</sgmltag><sgmltag class="starttag">p</sgmltag>Paragraph 1 of definition 1.<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">dd</tag><tag class="starttag">p</tag>Paragraph 1 of definition 1.<tag class="endtag">p</tag>
- <sgmltag class="starttag">p</sgmltag>Paragraph 2 of definition 1.<sgmltag class="endtag">p</sgmltag><sgmltag class="endtag">dd</sgmltag>
+ <tag class="starttag">p</tag>Paragraph 2 of definition 1.<tag class="endtag">p</tag><tag class="endtag">dd</tag>
- <sgmltag class="starttag">dt</sgmltag>Term 2<sgmltag class="endtag">dt</sgmltag>
+ <tag class="starttag">dt</tag>Term 2<tag class="endtag">dt</tag>
- <sgmltag class="starttag">dd</sgmltag><sgmltag class="starttag">p</sgmltag>Paragraph 1 of definition 2.<sgmltag class="endtag">p</sgmltag><sgmltag class="endtag">dd</sgmltag>
+ <tag class="starttag">dd</tag><tag class="starttag">p</tag>Paragraph 1 of definition 2.<tag class="endtag">p</tag><tag class="endtag">dd</tag>
- <sgmltag class="starttag">dt</sgmltag>Term 3<sgmltag class="endtag">dt</sgmltag>
+ <tag class="starttag">dt</tag>Term 3<tag class="endtag">dt</tag>
- <sgmltag class="starttag">dd</sgmltag><sgmltag class="starttag">p</sgmltag>Paragraph 1 of definition 3.<sgmltag class="endtag">p</sgmltag><sgmltag class="endtag">dd</sgmltag>
-<sgmltag class="endtag">dl</sgmltag></programlisting>
+ <tag class="starttag">dd</tag><tag class="starttag">p</tag>Paragraph 1 of definition 3.<tag class="endtag">p</tag><tag class="endtag">dd</tag>
+<tag class="endtag">dl</tag></programlisting>
</example>
</sect2>
- <sect2 id="xhtml-markup-block-elements-preformatted-text">
+ <sect2 xml:id="xhtml-markup-block-elements-preformatted-text">
<title>Pre-formatted Text</title>
<para>Pre-formatted text is shown to the user exactly as it is
@@ -307,16 +305,16 @@
and line breaks are shown exactly as they are in the
file.</para>
- <para>Wrap pre-formatted text in the <sgmltag>pre</sgmltag>
+ <para>Wrap pre-formatted text in the <tag>pre</tag>
element.</para>
<example>
- <title><sgmltag>pre</sgmltag></title>
+ <title><tag>pre</tag></title>
- <para>For example, the <sgmltag>pre</sgmltag> tags could be
+ <para>For example, the <tag>pre</tag> tags could be
used to mark up an email message:</para>
- <programlisting><sgmltag class="starttag">pre</sgmltag> From: nik@FreeBSD.org
+ <programlisting><tag class="starttag">pre</tag> From: nik@FreeBSD.org
To: freebsd-doc@FreeBSD.org
Subject: New documentation available
@@ -327,7 +325,7 @@
Comments appreciated.
- N<sgmltag class="endtag">pre</sgmltag></programlisting>
+ N<tag class="endtag">pre</tag></programlisting>
<para>Keep in mind that <literal>&lt;</literal> and
<literal>&amp;</literal> still are recognized as special
@@ -341,139 +339,139 @@
</example>
</sect2>
- <sect2 id="xhtml-markup-block-elements-tables">
+ <sect2 xml:id="xhtml-markup-block-elements-tables">
<title>Tables</title>
<para>Mark up tabular information using the
- <sgmltag>table</sgmltag> element. A table consists of one or
- more table rows (<sgmltag>tr</sgmltag>), each containing one
- or more cells of table data (<sgmltag>td</sgmltag>). Each
+ <tag>table</tag> element. A table consists of one or
+ more table rows (<tag>tr</tag>), each containing one
+ or more cells of table data (<tag>td</tag>). Each
cell can contain other block elements, such as paragraphs or
lists. It can also contain another table (this nesting can
repeat indefinitely). If the cell only contains one paragraph
- then the <sgmltag>p</sgmltag>element is not needed.</para>
+ then the <tag>p</tag>element is not needed.</para>
<example>
- <title>Simple Use of <sgmltag>table</sgmltag></title>
+ <title>Simple Use of <tag>table</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>This is a simple 2x2 table.<sgmltag class="endtag">p</sgmltag>
+ <programlisting><tag class="starttag">p</tag>This is a simple 2x2 table.<tag class="endtag">p</tag>
-<sgmltag class="starttag">table</sgmltag>
- <sgmltag class="starttag">tr</sgmltag>
- <sgmltag class="starttag">td</sgmltag>Top left cell<sgmltag class="endtag">td</sgmltag>
+<tag class="starttag">table</tag>
+ <tag class="starttag">tr</tag>
+ <tag class="starttag">td</tag>Top left cell<tag class="endtag">td</tag>
- <sgmltag class="starttag">td</sgmltag>Top right cell<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
+ <tag class="starttag">td</tag>Top right cell<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
- <sgmltag class="starttag">tr</sgmltag>
- <sgmltag class="starttag">td</sgmltag>Bottom left cell<sgmltag class="endtag">td</sgmltag>
+ <tag class="starttag">tr</tag>
+ <tag class="starttag">td</tag>Bottom left cell<tag class="endtag">td</tag>
- <sgmltag class="starttag">td</sgmltag>Bottom right cell<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
-<sgmltag class="endtag">table</sgmltag></programlisting>
+ <tag class="starttag">td</tag>Bottom right cell<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
+<tag class="endtag">table</tag></programlisting>
</example>
<para>A cell can span multiple rows and columns by adding the
- <sgmltag class="attribute">rowspan</sgmltag> or
- <sgmltag class="attribute">colspan</sgmltag> attributes with
+ <tag class="attribute">rowspan</tag> or
+ <tag class="attribute">colspan</tag> attributes with
values for the number of rows or columns to be spanned.</para>
<example>
<title>Using
- <sgmltag class="attribute">rowspan</sgmltag></title>
+ <tag class="attribute">rowspan</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>One tall thin cell on the left, two short cells next to
- it on the right.<sgmltag class="endtag">p</sgmltag>
+ <programlisting><tag class="starttag">p</tag>One tall thin cell on the left, two short cells next to
+ it on the right.<tag class="endtag">p</tag>
-<sgmltag class="starttag">table</sgmltag>
- <sgmltag class="starttag">tr</sgmltag>
- <sgmltag class="starttag">td rowspan="2"</sgmltag>Long and thin<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
+<tag class="starttag">table</tag>
+ <tag class="starttag">tr</tag>
+ <tag class="starttag">td rowspan="2"</tag>Long and thin<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
- <sgmltag class="starttag">tr</sgmltag>
- <sgmltag class="starttag">td</sgmltag>Top cell<sgmltag class="endtag">td</sgmltag>
+ <tag class="starttag">tr</tag>
+ <tag class="starttag">td</tag>Top cell<tag class="endtag">td</tag>
- <sgmltag class="starttag">td</sgmltag>Bottom cell<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
-<sgmltag class="endtag">table</sgmltag></programlisting>
+ <tag class="starttag">td</tag>Bottom cell<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
+<tag class="endtag">table</tag></programlisting>
</example>
<example>
<title>Using
- <sgmltag class="attribute">colspan</sgmltag></title>
+ <tag class="attribute">colspan</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>One long cell on top, two short cells below it.<sgmltag class="endtag">p</sgmltag>
+ <programlisting><tag class="starttag">p</tag>One long cell on top, two short cells below it.<tag class="endtag">p</tag>
-<sgmltag class="starttag">table</sgmltag>
- <sgmltag class="starttag">tr</sgmltag>
- <sgmltag class="starttag">td colspan="2"</sgmltag>Top cell<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
+<tag class="starttag">table</tag>
+ <tag class="starttag">tr</tag>
+ <tag class="starttag">td colspan="2"</tag>Top cell<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
- <sgmltag class="starttag">tr</sgmltag>
- <sgmltag class="starttag">td</sgmltag>Bottom left cell<sgmltag class="endtag">td</sgmltag>
+ <tag class="starttag">tr</tag>
+ <tag class="starttag">td</tag>Bottom left cell<tag class="endtag">td</tag>
- <sgmltag class="starttag">td</sgmltag>Bottom right cell<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
-<sgmltag class="endtag">table</sgmltag></programlisting>
+ <tag class="starttag">td</tag>Bottom right cell<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
+<tag class="endtag">table</tag></programlisting>
</example>
<example>
- <title>Using <sgmltag class="attribute">rowspan</sgmltag> and
- <sgmltag class="attribute">colspan</sgmltag>
+ <title>Using <tag class="attribute">rowspan</tag> and
+ <tag class="attribute">colspan</tag>
Together</title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>On a 3x3 grid, the top left block is a 2x2 set of
- cells merged into one. The other cells are normal.<sgmltag class="endtag">p</sgmltag>
+ <programlisting><tag class="starttag">p</tag>On a 3x3 grid, the top left block is a 2x2 set of
+ cells merged into one. The other cells are normal.<tag class="endtag">p</tag>
-<sgmltag class="starttag">table</sgmltag>
- <sgmltag class="starttag">tr</sgmltag>
- <sgmltag class="starttag">td colspan="2" rowspan="2"</sgmltag>Top left large cell<sgmltag class="endtag">td</sgmltag>
+<tag class="starttag">table</tag>
+ <tag class="starttag">tr</tag>
+ <tag class="starttag">td colspan="2" rowspan="2"</tag>Top left large cell<tag class="endtag">td</tag>
- <sgmltag class="starttag">td</sgmltag>Top right cell<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
+ <tag class="starttag">td</tag>Top right cell<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
- <sgmltag class="starttag">tr</sgmltag>
+ <tag class="starttag">tr</tag>
&lt;!-- Because the large cell on the left merges into
this row, the first &lt;td&gt; will occur on its
right --&gt;
- <sgmltag class="starttag">td</sgmltag>Middle right cell<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
+ <tag class="starttag">td</tag>Middle right cell<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
- <sgmltag class="starttag">tr</sgmltag>
- <sgmltag class="starttag">td</sgmltag>Bottom left cell<sgmltag class="endtag">td</sgmltag>
+ <tag class="starttag">tr</tag>
+ <tag class="starttag">td</tag>Bottom left cell<tag class="endtag">td</tag>
- <sgmltag class="starttag">td</sgmltag>Bottom middle cell<sgmltag class="endtag">td</sgmltag>
+ <tag class="starttag">td</tag>Bottom middle cell<tag class="endtag">td</tag>
- <sgmltag class="starttag">td</sgmltag>Bottom right cell<sgmltag class="endtag">td</sgmltag>
- <sgmltag class="endtag">tr</sgmltag>
-<sgmltag class="endtag">table</sgmltag></programlisting>
+ <tag class="starttag">td</tag>Bottom right cell<tag class="endtag">td</tag>
+ <tag class="endtag">tr</tag>
+<tag class="endtag">table</tag></programlisting>
</example>
</sect2>
</sect1>
- <sect1 id="xhtml-markup-inline-elements">
+ <sect1 xml:id="xhtml-markup-inline-elements">
<title>In-line Elements</title>
- <sect2 id="xhtml-markup-inline-elements-emphasizing-information">
+ <sect2 xml:id="xhtml-markup-inline-elements-emphasizing-information">
<title>Emphasizing Information</title>
<para>Two levels of emphasis are available in
- <acronym>XHTML</acronym>, <sgmltag>em</sgmltag> and
- <sgmltag>strong</sgmltag>. <sgmltag>em</sgmltag> is for a
- normal level of emphasis and <sgmltag>strong</sgmltag>
+ <acronym>XHTML</acronym>, <tag>em</tag> and
+ <tag>strong</tag>. <tag>em</tag> is for a
+ normal level of emphasis and <tag>strong</tag>
indicates stronger emphasis.</para>
- <para><sgmltag>em</sgmltag> is typically rendered in italic
- and <sgmltag>strong</sgmltag> is rendered in bold. This is
+ <para><tag>em</tag> is typically rendered in italic
+ and <tag>strong</tag> is rendered in bold. This is
not always the case, and should not be relied upon. According
to best practices, web pages only hold structural and
semantical information, and stylesheets are later applied to
@@ -481,47 +479,47 @@
tags.</para>
<example>
- <title><sgmltag>em</sgmltag> and
- <sgmltag>strong</sgmltag></title>
+ <title><tag>em</tag> and
+ <tag>strong</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag><sgmltag class="starttag">em</sgmltag>This<sgmltag class="endtag">em</sgmltag> has been emphasized, while
- <sgmltag class="starttag">strong</sgmltag>this<sgmltag class="endtag">strong</sgmltag> has been strongly emphasized.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p</tag><tag class="starttag">em</tag>This<tag class="endtag">em</tag> has been emphasized, while
+ <tag class="starttag">strong</tag>this<tag class="endtag">strong</tag> has been strongly emphasized.<tag class="endtag">p</tag></programlisting>
</example>
</sect2>
- <sect2 id="xhtml-markup-inline-elements-fixed-pitch-text">
+ <sect2 xml:id="xhtml-markup-inline-elements-fixed-pitch-text">
<title>Indicating Fixed-Pitch Text</title>
<para>Content that should be rendered in a fixed pitch
- (typewriter) typeface is tagged with <sgmltag>tt</sgmltag>
+ (typewriter) typeface is tagged with <tag>tt</tag>
(for <quote>teletype</quote>).</para>
<example>
- <title><sgmltag>tt</sgmltag></title>
+ <title><tag>tt</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>Many system settings are stored in
- <sgmltag class="starttag">tt</sgmltag>/etc<sgmltag class="endtag">tt</sgmltag>.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p</tag>Many system settings are stored in
+ <tag class="starttag">tt</tag>/etc<tag class="endtag">tt</tag>.<tag class="endtag">p</tag></programlisting>
</example>
</sect2>
- <sect2 id="xhtml-markup-inline-elements-links">
+ <sect2 xml:id="xhtml-markup-inline-elements-links">
<title>Links</title>
<note>
<para>Links are also inline elements.</para>
</note>
- <sect3 id="xhtml-markup-inline-elements-linking">
+ <sect3 xml:id="xhtml-markup-inline-elements-linking">
<title>Linking to Other Documents on the Web</title>
<para>A link points to the <acronym>URL</acronym> of a
document on the web. The link is indicated with
- <sgmltag>a</sgmltag>, and the
- <sgmltag class="attribute">href</sgmltag> attribute contains
+ <tag>a</tag>, and the
+ <tag class="attribute">href</tag> attribute contains
the <acronym>URL</acronym> of the target document. The
content of the element becomes the link, indicated to the
user by showing it in a different color or with an
@@ -529,28 +527,28 @@
<example>
<title>Using
- <sgmltag class="starttag">a href="..."</sgmltag></title>
+ <tag class="starttag">a href="..."</tag></title>
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>More information is available at the
- <sgmltag class="starttag">a href="http://www.&amp;os;.org/"</sgmltag>&amp;os; web site<sgmltag class="endtag">a</sgmltag>.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p</tag>More information is available at the
+ <tag class="starttag">a href="http://www.&amp;os;.org/"</tag>&amp;os; web site<tag class="endtag">a</tag>.<tag class="endtag">p</tag></programlisting>
</example>
<para>This link always takes the user to the top of the linked
document.</para>
</sect3>
- <sect3 id="xhtml-markup-inline-elements-specific-parts">
+ <sect3 xml:id="xhtml-markup-inline-elements-specific-parts">
<title>Linking to Specific Parts of Documents</title>
<para>To link to a specific point within a document, that
document must include an <emphasis>anchor</emphasis> at the
desired point. Anchors are included by setting the
- <sgmltag class="attribute">id</sgmltag> attribute of an
+ <tag class="attribute">id</tag> attribute of an
element to a name. This example creates an anchor by
- setting the <sgmltag class="attribute">id</sgmltag>
- attribute of a <sgmltag class="element">p</sgmltag>
+ setting the <tag class="attribute">id</tag>
+ attribute of a <tag class="element">p</tag>
element.</para>
<example>
@@ -558,8 +556,8 @@
<para>Usage:</para>
- <programlisting><sgmltag class="starttag">p id="samplepara"</sgmltag>This paragraph can be referenced
- in other links with the name <sgmltag class="starttag">tt</sgmltag>samplepara<sgmltag class="endtag">tt</sgmltag>.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p id="samplepara"</tag>This paragraph can be referenced
+ in other links with the name <tag class="starttag">tt</tag>samplepara<tag class="endtag">tt</tag>.<tag class="endtag">p</tag></programlisting>
</example>
<para>Links to anchors are similar to plain links, but include
@@ -576,9 +574,9 @@
that specific paragraph in the document is constructed in
this example.</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>More information can be found in the
- <sgmltag class="starttag">a href="foo.html#samplepara"</sgmltag>sample paragraph<sgmltag class="endtag">a</sgmltag> of
- <sgmltag class="starttag">tt</sgmltag>foo.html<sgmltag class="endtag">tt</sgmltag>.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p</tag>More information can be found in the
+ <tag class="starttag">a href="foo.html#samplepara"</tag>sample paragraph<tag class="endtag">a</tag> of
+ <tag class="starttag">tt</tag>foo.html<tag class="endtag">tt</tag>.<tag class="endtag">p</tag></programlisting>
</example>
<para>To link to a named anchor within the same document, omit
@@ -592,9 +590,9 @@
<para>The <literal>samplepara</literal> example
resides in this document. To link to it:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>More information can be found in the
- <sgmltag class="starttag">a href="#samplepara"</sgmltag>sample paragraph<sgmltag class="endtag">a</sgmltag> of this
- document.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p</tag>More information can be found in the
+ <tag class="starttag">a href="#samplepara"</tag>sample paragraph<tag class="endtag">a</tag> of this
+ document.<tag class="endtag">p</tag></programlisting>
</example>
</sect3>
</sect2>
diff --git a/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml
index 1a436f380b..b25fc313a5 100644
--- a/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml
@@ -30,8 +30,7 @@
$FreeBSD$
-->
-
-<chapter id="xml-primer">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="xml-primer">
<title>XML Primer</title>
<para>Most <acronym>FDP</acronym> documentation is written with
@@ -41,11 +40,10 @@
used.</para>
<para>Portions of this section were inspired by Mark Galassi's
- <ulink
- url="http://www.galassi.org/mark/mydocs/docbook-intro/docbook-intro.html">Get
- Going With DocBook</ulink>.</para>
+ <link xlink:href="http://www.galassi.org/mark/mydocs/docbook-intro/docbook-intro.html">Get
+ Going With DocBook</link>.</para>
- <sect1 id="xml-primer-overview">
+ <sect1 xml:id="xml-primer-overview">
<title>Overview</title>
<para>In the original days of computers, electronic text was
@@ -108,9 +106,9 @@
<para>The previous example is actually represented in this
document like this:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>To remove <sgmltag class="starttag">filename</sgmltag>/tmp/foo<sgmltag class="endtag">filename</sgmltag>, use &amp;man.rm.1;.<sgmltag class="endtag">para</sgmltag>
+ <programlisting><tag class="starttag">para</tag>To remove <tag class="starttag">filename</tag>/tmp/foo<tag class="endtag">filename</tag>, use &amp;man.rm.1;.<tag class="endtag">para</tag>
-<sgmltag class="starttag">screen</sgmltag>&amp;prompt.user; <sgmltag class="starttag">userinput</sgmltag>rm /tmp/foo<sgmltag class="endtag">userinput</sgmltag><sgmltag class="endtag">screen</sgmltag></programlisting>
+<tag class="starttag">screen</tag>&amp;prompt.user; <tag class="starttag">userinput</tag>rm /tmp/foo<tag class="endtag">userinput</tag><tag class="endtag">screen</tag></programlisting>
<para>The markup is clearly separate from the content.</para>
@@ -137,7 +135,7 @@
specify an <acronym>XML</acronym> grammar, or
<emphasis>schema</emphasis>.</para>
- <para id="xml-primer-validating">A schema is a
+ <para xml:id="xml-primer-validating">A schema is a
<emphasis>complete</emphasis> specification of all the elements
that are allowed to appear, the order in which they should
appear, which elements are mandatory, which are optional, and so
@@ -169,7 +167,7 @@
to write a vocabulary.</para>
</sect1>
- <sect1 id="xml-primer-elements">
+ <sect1 xml:id="xml-primer-elements">
<title>Elements, Tags, and Attributes</title>
<para>All the vocabularies written in <acronym>XML</acronym> share
@@ -222,23 +220,21 @@
<para>For an element called
<replaceable>element-name</replaceable> the start tag will
- normally look like <sgmltag
- class="starttag"><replaceable>element-name</replaceable></sgmltag>.
- The corresponding closing tag for this element is <sgmltag
- class="endtag"><replaceable>element-name</replaceable></sgmltag>.</para>
+ normally look like <tag class="starttag"><replaceable>element-name</replaceable></tag>.
+ The corresponding closing tag for this element is <tag class="endtag"><replaceable>element-name</replaceable></tag>.</para>
<example>
<title>Using an Element (Start and End Tags)</title>
<para><acronym>XHTML</acronym> has an element for indicating
that the content enclosed by the element is a paragraph,
- called <sgmltag>p</sgmltag>.</para>
+ called <tag>p</tag>.</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>This is a paragraph. It starts with the start tag for
+ <programlisting><tag class="starttag">p</tag>This is a paragraph. It starts with the start tag for
the 'p' element, and it will end with the end tag for the 'p'
- element.<sgmltag class="endtag">p</sgmltag>
+ element.<tag class="endtag">p</tag>
-<sgmltag class="starttag">p</sgmltag>This is another paragraph. But this one is much shorter.<sgmltag class="endtag">p</sgmltag></programlisting>
+<tag class="starttag">p</tag>This is another paragraph. But this one is much shorter.<tag class="endtag">p</tag></programlisting>
</example>
<para>Some elements have no content. For example, in
@@ -251,22 +247,22 @@
<title>Using an Element Without Content</title>
<para><acronym>XHTML</acronym> has an element for indicating a
- horizontal rule, called <sgmltag>hr</sgmltag>. This element
+ horizontal rule, called <tag>hr</tag>. This element
does not wrap content, so it looks like this:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>One paragraph.<sgmltag class="endtag">p</sgmltag>
-<sgmltag class="starttag">hr</sgmltag><sgmltag class="endtag">hr</sgmltag>
+ <programlisting><tag class="starttag">p</tag>One paragraph.<tag class="endtag">p</tag>
+<tag class="starttag">hr</tag><tag class="endtag">hr</tag>
-<sgmltag class="starttag">p</sgmltag>This is another paragraph. A horizontal rule separates this
- from the previous paragraph.<sgmltag class="endtag">p</sgmltag></programlisting>
+<tag class="starttag">p</tag>This is another paragraph. A horizontal rule separates this
+ from the previous paragraph.<tag class="endtag">p</tag></programlisting>
<para>The shorthand version consists of a single tag:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>One paragraph.<sgmltag class="endtag">p</sgmltag>
-<sgmltag class="emptytag">hr</sgmltag>
+ <programlisting><tag class="starttag">p</tag>One paragraph.<tag class="endtag">p</tag>
+<tag class="emptytag">hr</tag>
-<sgmltag class="starttag">p</sgmltag>This is another paragraph. A horizontal rule separates this
- from the previous paragraph.<sgmltag class="endtag">p</sgmltag></programlisting>
+<tag class="starttag">p</tag>This is another paragraph. A horizontal rule separates this
+ from the previous paragraph.<tag class="endtag">p</tag></programlisting>
</example>
<para>As shown above, elements can contain other elements. In the
@@ -275,10 +271,10 @@
and so on.</para>
<example>
- <title>Elements Within Elements; <sgmltag>em</sgmltag></title>
+ <title>Elements Within Elements; <tag>em</tag></title>
- <programlisting><sgmltag class="starttag">p</sgmltag>This is a simple <sgmltag class="starttag">em</sgmltag>paragraph<sgmltag class="endtag">em</sgmltag> where some
- of the <sgmltag class="starttag">em</sgmltag>words<sgmltag class="endtag">em</sgmltag> have been <sgmltag class="starttag">em</sgmltag>emphasized<sgmltag class="endtag">em</sgmltag>.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p</tag>This is a simple <tag class="starttag">em</tag>paragraph<tag class="endtag">em</tag> where some
+ of the <tag class="starttag">em</tag>words<tag class="endtag">em</tag> have been <tag class="starttag">em</tag>emphasized<tag class="endtag">em</tag>.<tag class="endtag">p</tag></programlisting>
</example>
<para>The grammar consists of rules that describe which elements
@@ -296,11 +292,11 @@
<para>When this document (or anyone else knowledgeable about
<acronym>XML</acronym>) refers to
- <quote>the <sgmltag class="starttag">p</sgmltag> tag</quote>
+ <quote>the <tag class="starttag">p</tag> tag</quote>
they mean the literal text consisting of the three characters
<literal>&lt;</literal>, <literal>p</literal>, and
<literal>&gt;</literal>. But the phrase
- <quote>the <sgmltag>p</sgmltag> element</quote> refers to the
+ <quote>the <tag>p</tag> element</quote> refers to the
whole element.</para>
<para>This distinction <emphasis>is</emphasis> very subtle. But
@@ -316,15 +312,15 @@
<para>An element's attributes are written
<emphasis>inside</emphasis> the start tag for that element, and
take the form
- <literal><replaceable>attribute-name</replaceable>="<replaceable>attribute-value</replaceable>"</literal>.</para>
+ <literal>attribute-name="attribute-value"</literal>.</para>
- <para>In <acronym>XHTML</acronym>, the <sgmltag>p</sgmltag>
+ <para>In <acronym>XHTML</acronym>, the <tag>p</tag>
element has an attribute called
- <sgmltag class="attribute">align</sgmltag>, which suggests an
+ <tag class="attribute">align</tag>, which suggests an
alignment (justification) for the paragraph to the program
displaying the <acronym>XHTML</acronym>.</para>
- <para>The <sgmltag class="attribute">align</sgmltag> attribute can
+ <para>The <tag class="attribute">align</tag> attribute can
take one of four defined values, <literal>left</literal>,
<literal>center</literal>, <literal>right</literal> and
<literal>justify</literal>. If the attribute is not specified
@@ -333,10 +329,10 @@
<example>
<title>Using an Element with an Attribute</title>
- <programlisting><sgmltag class="starttag">p align="left"</sgmltag>The inclusion of the align attribute
- on this paragraph was superfluous, since the default is left.<sgmltag class="endtag">p</sgmltag>
+ <programlisting><tag class="starttag">p align="left"</tag>The inclusion of the align attribute
+ on this paragraph was superfluous, since the default is left.<tag class="endtag">p</tag>
-<sgmltag class="starttag">p align="center"</sgmltag>This may appear in the center.<sgmltag class="endtag">p</sgmltag></programlisting>
+<tag class="starttag">p align="center"</tag>This may appear in the center.<tag class="endtag">p</tag></programlisting>
</example>
<para>Some attributes only take specific values, such as
@@ -346,7 +342,7 @@
<example>
<title>Single Quotes Around Attributes</title>
- <programlisting><sgmltag class="starttag">p align='right'</sgmltag>I am on the right!<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p align='right'</tag>I am on the right!<tag class="endtag">p</tag></programlisting>
</example>
<para>Attribute values in <acronym>XML</acronym> must be enclosed
@@ -371,7 +367,7 @@
<procedure>
<step>
<para>Install
- <filename role="package">textproc/docproj</filename> from
+ <package>textproc/docproj</package> from
the &os; Ports Collection. This is a
<emphasis>meta-port</emphasis> that downloads and installs
the standard programs and supporting files needed by the
@@ -385,7 +381,7 @@
<replaceable>en_US.ISO8859-1</replaceable> with the
appropriate directory for the target language.</para>
- <example id="xml-primer-envars">
+ <example xml:id="xml-primer-envars">
<title><filename>.profile</filename>, for &man.sh.1; and
&man.bash.1; Users</title>
@@ -423,28 +419,28 @@ setenv SGML_CATALOG_FILES /usr/doc/<replaceable>en_US.ISO8859-1</replaceable>/sh
<para>Create <filename>example.xml</filename>, and enter
this text:</para>
- <programlisting><sgmltag class="starttag">!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"</sgmltag>
+ <programlisting><tag class="starttag">!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"</tag>
-<sgmltag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</sgmltag>
- <sgmltag class="starttag">head</sgmltag>
- <sgmltag class="starttag">title</sgmltag>An Example XHTML File<sgmltag class="endtag">title</sgmltag>
- <sgmltag class="endtag">head</sgmltag>
+<tag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</tag>
+ <tag class="starttag">head</tag>
+ <tag class="starttag">title</tag>An Example XHTML File<tag class="endtag">title</tag>
+ <tag class="endtag">head</tag>
- <sgmltag class="starttag">body</sgmltag>
- <sgmltag class="starttag">p</sgmltag>This is a paragraph containing some text.<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">body</tag>
+ <tag class="starttag">p</tag>This is a paragraph containing some text.<tag class="endtag">p</tag>
- <sgmltag class="starttag">p</sgmltag>This paragraph contains some more text.<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">p</tag>This paragraph contains some more text.<tag class="endtag">p</tag>
- <sgmltag class="starttag">p align="right"</sgmltag>This paragraph might be right-justified.<sgmltag class="endtag">p</sgmltag>
- <sgmltag class="endtag">body</sgmltag>
-<sgmltag class="endtag">html</sgmltag></programlisting>
+ <tag class="starttag">p align="right"</tag>This paragraph might be right-justified.<tag class="endtag">p</tag>
+ <tag class="endtag">body</tag>
+<tag class="endtag">html</tag></programlisting>
</step>
<step>
<para>Try to validate this file using an
<acronym>XML</acronym> parser.</para>
- <para><filename role="package">textproc/docproj</filename>
+ <para><package>textproc/docproj</package>
includes the <command>xmllint</command>
<link linkend="xml-primer-validating">validating
parser</link>.</para>
@@ -462,8 +458,8 @@ setenv SGML_CATALOG_FILES /usr/doc/<replaceable>en_US.ISO8859-1</replaceable>/sh
<step>
<para>See what happens when required elements are omitted.
Delete the line with the
- <sgmltag class="starttag">title</sgmltag> and
- <sgmltag class="endtag">/title</sgmltag> tags, and re-run
+ <tag class="starttag">title</tag> and
+ <tag class="endtag">/title</tag> tags, and re-run
the validation.</para>
<screen>&prompt.user; <userinput>xmllint --valid --noout example.xml</userinput>
@@ -472,7 +468,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<para>This shows that the validation error comes from the
<replaceable>fifth</replaceable> line of the
<replaceable>example.xml</replaceable> file and that the
- content of the <sgmltag class="starttag">head</sgmltag> is
+ content of the <tag class="starttag">head</tag> is
the part which does not follow the rules of the
<acronym>XHTML</acronym> grammar.</para>
@@ -482,13 +478,13 @@ example.xml:5: element head: validity error : Element head content does not foll
</step>
<step>
- <para>Replace the <sgmltag>title</sgmltag> element.</para>
+ <para>Replace the <tag>title</tag> element.</para>
</step>
</procedure>
</sect2>
</sect1>
- <sect1 id="xml-primer-doctype-declaration">
+ <sect1 xml:id="xml-primer-doctype-declaration">
<title>The DOCTYPE Declaration</title>
<para>The beginning of each document can specify the name of the
@@ -501,7 +497,7 @@ example.xml:5: element head: validity error : Element head content does not foll
version 1.0 of the <acronym>XHTML</acronym>
<acronym>DTD</acronym> looks like this:</para>
- <programlisting><sgmltag class="starttag">!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"</sgmltag></programlisting>
+ <programlisting><tag class="starttag">!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"</tag></programlisting>
<para>That line contains a number of different components.</para>
@@ -555,8 +551,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<acronym>DTD</acronym> referenced in the
<acronym>FPI</acronym>. Other ways of telling the
<acronym>XML</acronym> parser how to find the
- <acronym>DTD</acronym> are shown <link
- linkend="xml-primer-fpi-alternatives">later</link>.</para>
+ <acronym>DTD</acronym> are shown <link linkend="xml-primer-fpi-alternatives">later</link>.</para>
</listitem>
</varlistentry>
@@ -620,9 +615,9 @@ example.xml:5: element head: validity error : Element head content does not foll
superset) of <acronym>XML</acronym>.</para>
<para>Otherwise, this string will either look like
- <literal>-//<replaceable>Owner</replaceable></literal>
+ <literal>-//Owner</literal>
or
- <literal>+//<replaceable>Owner</replaceable></literal>
+ <literal>+//Owner</literal>
(notice the only difference is the leading
<literal>+</literal> or <literal>-</literal>).</para>
@@ -714,8 +709,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<filename>/usr/local/share/xml/dtd/xhtml/catalog.xml</filename>.
This is the catalog file for the <acronym>XHTML</acronym>
<acronym>DTD</acronym>s that were installed as part of the
- <filename
- role="package">textproc/docproj</filename> port.</para>
+ <package>textproc/docproj</package> port.</para>
</sect3>
<sect3>
@@ -756,7 +750,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect3>
</sect2>
- <sect2 id="xml-primer-fpi-alternatives">
+ <sect2 xml:id="xml-primer-fpi-alternatives">
<title>Alternatives to <acronym>FPI</acronym>s</title>
<para>Instead of using an <acronym>FPI</acronym> to indicate the
@@ -767,7 +761,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<para>The syntax is slightly different:</para>
- <programlisting><sgmltag class="starttag">!DOCTYPE html SYSTEM "/path/to/file.dtd"</sgmltag></programlisting>
+ <programlisting><tag class="starttag">!DOCTYPE html SYSTEM "/path/to/file.dtd"</tag></programlisting>
<para>The <literal>SYSTEM</literal> keyword indicates that the
<acronym>XML</acronym> processor should locate the
@@ -782,7 +776,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-xml-escape">
+ <sect1 xml:id="xml-primer-xml-escape">
<title>Escaping Back to <acronym>XML</acronym></title>
<para>Some of the underlying <acronym>XML</acronym> syntax can be
@@ -802,7 +796,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect1>
- <sect1 id="xml-primer-comments">
+ <sect1 xml:id="xml-primer-comments">
<title>Comments</title>
<para>Comments are an <acronym>XML</acronym> construct, and are
@@ -877,7 +871,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-entities">
+ <sect1 xml:id="xml-primer-entities">
<title>Entities</title>
<para>Entities are a mechanism for assigning names to chunks of
@@ -894,7 +888,7 @@ example.xml:5: element head: validity error : Element head content does not foll
situations: <emphasis>general entities</emphasis> and
<emphasis>parameter entities</emphasis>.</para>
- <sect2 id="xml-primer-general-entities">
+ <sect2 xml:id="xml-primer-general-entities">
<title>General Entities</title>
<para>General entities are used to assign names to reusable
@@ -904,14 +898,14 @@ example.xml:5: element head: validity error : Element head content does not foll
<para>To include the text of a general entity in the document,
include
- <literal>&amp;<replaceable>entity-name</replaceable>;</literal>
+ <literal>&amp;entity-name;</literal>
in the text. For example, consider a general entity called
<literal>current.version</literal> which expands to the
current version number of a product. To use it in the
document, write:</para>
- <programlisting><sgmltag class="starttag">para</sgmltag>The current version of our product is
- &amp;current.version;.<sgmltag class="endtag">para</sgmltag></programlisting>
+ <programlisting><tag class="starttag">para</tag>The current version of our product is
+ &amp;current.version;.<tag class="endtag">para</tag></programlisting>
<para>When the version number changes, edit the definition of
the general entity, replacing the value. Then reprocess the
@@ -955,7 +949,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</example>
</sect2>
- <sect2 id="xml-primer-parameter-entities">
+ <sect2 xml:id="xml-primer-parameter-entities">
<title>Parameter Entities</title>
<para>Parameter entities, like
@@ -968,7 +962,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<para>Parameter entity definitons are similar to those for
general entities. However, parameter entries are included
with
- <literal>%<replaceable>entity-name</replaceable>;</literal>.
+ <literal>%entity-name;</literal>.
The definition also includes the <literal>%</literal> between
the <literal>ENTITY</literal> keyword and the name of the
entity.</para>
@@ -1004,23 +998,23 @@ example.xml:5: element head: validity error : Element head content does not foll
&lt;!ENTITY version "1.1"&gt;
]&gt;
-<sgmltag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</sgmltag>
- <sgmltag class="starttag">head</sgmltag>
- <sgmltag class="starttag">title</sgmltag>An Example XHTML File<sgmltag class="endtag">title</sgmltag>
- <sgmltag class="endtag">head</sgmltag>
+<tag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</tag>
+ <tag class="starttag">head</tag>
+ <tag class="starttag">title</tag>An Example XHTML File<tag class="endtag">title</tag>
+ <tag class="endtag">head</tag>
&lt;!-- There may be some comments in here as well --&gt;
- <sgmltag class="starttag">body</sgmltag>
- <sgmltag class="starttag">p</sgmltag>This is a paragraph containing some text.<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">body</tag>
+ <tag class="starttag">p</tag>This is a paragraph containing some text.<tag class="endtag">p</tag>
- <sgmltag class="starttag">p</sgmltag>This paragraph contains some more text.<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">p</tag>This paragraph contains some more text.<tag class="endtag">p</tag>
- <sgmltag class="starttag">p align="right"</sgmltag>This paragraph might be right-justified.<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">p align="right"</tag>This paragraph might be right-justified.<tag class="endtag">p</tag>
- <sgmltag class="starttag">p</sgmltag>The current version of this document is: &amp;version;<sgmltag class="endtag">p</sgmltag>
- <sgmltag class="endtag">body</sgmltag>
-<sgmltag class="endtag">html</sgmltag></programlisting>
+ <tag class="starttag">p</tag>The current version of this document is: &amp;version;<tag class="endtag">p</tag>
+ <tag class="endtag">body</tag>
+<tag class="endtag">html</tag></programlisting>
</step>
<step>
@@ -1068,7 +1062,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-include">
+ <sect1 xml:id="xml-primer-include">
<title>Using Entities to Include Files</title>
<para>Both
@@ -1077,7 +1071,7 @@ example.xml:5: element head: validity error : Element head content does not foll
entities are particularly useful for including one file inside
another.</para>
- <sect2 id="xml-primer-include-using-gen-entities">
+ <sect2 xml:id="xml-primer-include-using-gen-entities">
<title>Using General Entities to Include Files</title>
<para>Consider some content for an <acronym>XML</acronym> book
@@ -1104,13 +1098,13 @@ example.xml:5: element head: validity error : Element head content does not foll
&lt;!-- And so forth --&gt;
]&gt;
-<sgmltag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</sgmltag>
+<tag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</tag>
&lt;!-- Use the entities to load in the chapters --&gt;
&amp;chapter.1;
&amp;chapter.2;
&amp;chapter.3;
-<sgmltag class="endtag">html</sgmltag></programlisting>
+<tag class="endtag">html</tag></programlisting>
</example>
<warning>
@@ -1170,11 +1164,11 @@ example.xml:5: element head: validity error : Element head content does not foll
%chapters;
]&gt;
-<sgmltag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</sgmltag>
+<tag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</tag>
&amp;chapter.1;
&amp;chapter.2;
&amp;chapter.3;
-<sgmltag class="endtag">html</sgmltag></programlisting>
+<tag class="endtag">html</tag></programlisting>
</example>
</sect2>
@@ -1192,7 +1186,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<para>Put content like this in each file:</para>
- <programlisting><sgmltag class="starttag">p</sgmltag>This is the first paragraph.<sgmltag class="endtag">p</sgmltag></programlisting>
+ <programlisting><tag class="starttag">p</tag>This is the first paragraph.<tag class="endtag">p</tag></programlisting>
</step>
<step>
@@ -1207,19 +1201,19 @@ example.xml:5: element head: validity error : Element head content does not foll
&lt;!ENTITY para3 SYSTEM "para3.xml"&gt;
]&gt;
-<sgmltag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</sgmltag>
- <sgmltag class="starttag">head</sgmltag>
- <sgmltag class="starttag">title</sgmltag>An Example XHTML File<sgmltag class="endtag">title</sgmltag>
- <sgmltag class="endtag">head</sgmltag>
+<tag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</tag>
+ <tag class="starttag">head</tag>
+ <tag class="starttag">title</tag>An Example XHTML File<tag class="endtag">title</tag>
+ <tag class="endtag">head</tag>
- <sgmltag class="starttag">body</sgmltag>
- <sgmltag class="starttag">p</sgmltag>The current version of this document is: &amp;version;<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">body</tag>
+ <tag class="starttag">p</tag>The current version of this document is: &amp;version;<tag class="endtag">p</tag>
&amp;para1;
&amp;para2;
&amp;para3;
- <sgmltag class="endtag">body</sgmltag>
-<sgmltag class="endtag">html</sgmltag></programlisting>
+ <tag class="endtag">body</tag>
+<tag class="endtag">html</tag></programlisting>
</step>
<step>
@@ -1232,7 +1226,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<step>
<para>Load <filename>example.html</filename> into the web
browser and confirm that the
- <filename>para<replaceable>n</replaceable>.xml</filename>
+ <filename>paran.xml</filename>
files have been included in
<filename>example.html</filename>.</para>
</step>
@@ -1257,19 +1251,19 @@ example.xml:5: element head: validity error : Element head content does not foll
&lt;!ENTITY % entities SYSTEM "entities.ent"&gt; %entities;
]&gt;
-<sgmltag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</sgmltag>
- <sgmltag class="starttag">head</sgmltag>
- <sgmltag class="starttag">title</sgmltag>An Example XHTML File<sgmltag class="endtag">title</sgmltag>
- <sgmltag class="endtag">head</sgmltag>
+<tag class="starttag">html xmlns="http://www.w3.org/1999/xhtml"</tag>
+ <tag class="starttag">head</tag>
+ <tag class="starttag">title</tag>An Example XHTML File<tag class="endtag">title</tag>
+ <tag class="endtag">head</tag>
- <sgmltag class="starttag">body</sgmltag>
- <sgmltag class="starttag">p</sgmltag>The current version of this document is: &amp;version;<sgmltag class="endtag">p</sgmltag>
+ <tag class="starttag">body</tag>
+ <tag class="starttag">p</tag>The current version of this document is: &amp;version;<tag class="endtag">p</tag>
&amp;para1;
&amp;para2;
&amp;para3;
- <sgmltag class="endtag">body</sgmltag>
-<sgmltag class="endtag">html</sgmltag></programlisting>
+ <tag class="endtag">body</tag>
+<tag class="endtag">html</tag></programlisting>
</step>
<step>
@@ -1293,7 +1287,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<step>
<para>Load <filename>example.html</filename> into the web
browser and confirm that the
- <filename>para<replaceable>n</replaceable>.xml</filename>
+ <filename>paran.xml</filename>
files have been included in
<filename>example.html</filename>.</para>
</step>
@@ -1302,7 +1296,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-marked-sections">
+ <sect1 xml:id="xml-primer-marked-sections">
<title>Marked Sections</title>
<para><acronym>XML</acronym> provides a mechanism to indicate that
@@ -1334,10 +1328,10 @@ example.xml:5: element head: validity error : Element head content does not foll
<acronym>XML</acronym> context with
<literal>&gt;</literal>.</para>
- <sect2 id="xml-primer-marked-section-keywords">
+ <sect2 xml:id="xml-primer-marked-section-keywords">
<title>Marked Section Keywords</title>
- <sect3 id="xml-primer-cdata">
+ <sect3 xml:id="xml-primer-cdata">
<title><literal>CDATA</literal></title>
<para>These keywords denote the marked sections
@@ -1376,29 +1370,29 @@ example.xml:5: element head: validity error : Element head content does not foll
<title>Using a <literal>CDATA</literal> Marked
Section</title>
- <programlisting><sgmltag class="starttag">para</sgmltag>Here is an example of how to include some text that contains
- many <sgmltag class="starttag">literal</sgmltag>&amp;lt;<sgmltag class="endtag">literal</sgmltag> and <sgmltag class="starttag">literal</sgmltag>&amp;amp;<sgmltag class="endtag">literal</sgmltag>
+ <programlisting><tag class="starttag">para</tag>Here is an example of how to include some text that contains
+ many <tag class="starttag">literal</tag>&amp;lt;<tag class="endtag">literal</tag> and <tag class="starttag">literal</tag>&amp;amp;<tag class="endtag">literal</tag>
symbols. The sample text is a fragment of
- <sgmltag class="starttag">acronym</sgmltag>XHTML<sgmltag class="endtag">acronym</sgmltag>. The surrounding text (<sgmltag class="starttag">para</sgmltag> and
- <sgmltag class="starttag">programlisting</sgmltag>) are from DocBook.<sgmltag class="endtag">para</sgmltag>
+ <tag class="starttag">acronym</tag>XHTML<tag class="endtag">acronym</tag>. The surrounding text (<tag class="starttag">para</tag> and
+ <tag class="starttag">programlisting</tag>) are from DocBook.<tag class="endtag">para</tag>
-<sgmltag class="starttag">programlisting</sgmltag>&lt;![CDATA[<sgmltag class="starttag">p</sgmltag>This is a sample that shows some of the
- elements within <sgmltag class="starttag">acronym</sgmltag>XHTML<sgmltag class="endtag">acronym</sgmltag>. Since the angle
+<tag class="starttag">programlisting</tag>&lt;![CDATA[<tag class="starttag">p</tag>This is a sample that shows some of the
+ elements within <tag class="starttag">acronym</tag>XHTML<tag class="endtag">acronym</tag>. Since the angle
brackets are used so many times, it is simpler to say the whole
example is a CDATA marked section than to use the entity names for
- the left and right angle brackets throughout.<sgmltag class="endtag">p</sgmltag>
+ the left and right angle brackets throughout.<tag class="endtag">p</tag>
- <sgmltag class="starttag">ul</sgmltag>
- <sgmltag class="starttag">li</sgmltag>This is a listitem<sgmltag class="endtag">li</sgmltag>
- <sgmltag class="starttag">li</sgmltag>This is a second listitem<sgmltag class="endtag">li</sgmltag>
- <sgmltag class="starttag">li</sgmltag>This is a third listitem<sgmltag class="endtag">li</sgmltag>
- <sgmltag class="endtag">ul</sgmltag>
+ <tag class="starttag">ul</tag>
+ <tag class="starttag">li</tag>This is a listitem<tag class="endtag">li</tag>
+ <tag class="starttag">li</tag>This is a second listitem<tag class="endtag">li</tag>
+ <tag class="starttag">li</tag>This is a third listitem<tag class="endtag">li</tag>
+ <tag class="endtag">ul</tag>
- <sgmltag class="starttag">p</sgmltag>This is the end of the example.<sgmltag class="endtag">p</sgmltag>]]&gt;<sgmltag class="endtag">programlisting</sgmltag></programlisting>
+ <tag class="starttag">p</tag>This is the end of the example.<tag class="endtag">p</tag>]]&gt;<tag class="endtag">programlisting</tag></programlisting>
</example>
</sect3>
- <sect3 id="xml-primer-include-ignore">
+ <sect3 xml:id="xml-primer-include-ignore">
<title><literal>INCLUDE</literal> and
<literal>IGNORE</literal></title>
@@ -1455,7 +1449,7 @@ example.xml:5: element head: validity error : Element head content does not foll
<title>Using a Parameter Entity to Control a Marked
Section</title>
- <programlisting>&lt;!ENTITY % electronic.copy "INCLUDE">
+ <programlisting>&lt;!ENTITY % electronic.copy "INCLUDE"&gt;
&lt;![%electronic.copy;[
&lt;!ENTITY chap.preface SYSTEM "preface.xml"&gt;
@@ -1507,7 +1501,7 @@ example.xml:5: element head: validity error : Element head content does not foll
</sect2>
</sect1>
- <sect1 id="xml-primer-conclusion">
+ <sect1 xml:id="xml-primer-conclusion">
<title>Conclusion</title>
<para>That is the conclusion of this <acronym>XML</acronym>