19972013
Ericsson AB. All Rights Reserved.
The contents of this file are subject to the Erlang Public License,
Version 1.1, (the "License"); you may not use this file except in
compliance with the License. You should have received a copy of the
Erlang Public License along with this software. If not, it can be
retrieved online at http://www.erlang.org/.
Software distributed under the License is distributed on an "AS IS"
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
the License for the specific language governing rights and limitations
under the License.
User's Guide DTDs
user_guide_dtds.xml
The part DTD
The part DTD is intended for a "normal" document, like
the User's Guide or Release Notes. First are some paragraphs
introducing the main contents. After that follows chapters,
written in separate files with
the chapter DTD.
Example:
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE part SYSTEM "part.dtd">
<part>
<header>
<title>The chapter title</title>
<prepared>The author</prepared>
<docno/>
<date/>
<rev/>
</header>
<description>
<p>Some text..</p>
</description>
<include file="file1"></include>
<include file="file2"></include>
</part>
<part>
The top level tag of a part DTD.
Contains a
<header>,
an optional
<description>,
followed by one or more
<include>.
<description>
The introduction after the title and before the bulk of
included chapters/manual pages.
Contains any combination and any number
of block tags except
]]> and ]]>.
<include>
An empty tag. The attribute file specifies a file to
include. The .xml file extension should be omitted.
Example:
<include file="notes"></include>
The chapter DTD
The chapter DTD is intended for a chapter in a User's
Guide or similar with text divided into sections, which can be
nested.
Example:
<?xml version="1.0" encoding="latin1" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">
<chapter>
<header>
<title>Title on first level</title>
<prepared/>
<docno/>
<date/>
<rev/>
</header>
<p>Introduction...</p>
<section>
<title>Title on second level</title>
<p>First paragraph.</p>
<p>Second paragraph etc.</p>
<section>
<title>Title on third level</title>
<p>...</p>
</section>
</section>
...
</chapter>
<chapter>
The top level tag of a chapter DTD.
Contains a
<header>,
an optional introduction consisting of any combination of
block tags,
followed by one or more
<section>.
<section>
Subdivision of a chapter.
Contains an optional
<marker>,
a <title>,
followed by any combination and any number of
block tags and
]]>.
<title>
Section title, contains plain text.