diff options
Diffstat (limited to 'en_US/writing-guidelines.xml')
| -rw-r--r-- | en_US/writing-guidelines.xml | 87 |
1 files changed, 48 insertions, 39 deletions
diff --git a/en_US/writing-guidelines.xml b/en_US/writing-guidelines.xml index f6bf7ed..0691825 100644 --- a/en_US/writing-guidelines.xml +++ b/en_US/writing-guidelines.xml @@ -34,6 +34,26 @@ <ulink url="http://www.docbook.org/tdg/en/html/docbook.html"/>. </para> + <section id="sn-xml-guidelines-header"> + <title>File Header</title> + <section id="sn-xml-header-xml"> + <title>XML Header</title> + <para>In accordance with good XML practices, the first line in any + DocBook XML source files should identify the file as XML. Use + the following line as the first line of any new XML file:</para> + <screen><![CDATA[<?xml version="1.0" encoding="UTF-8"?>]]></screen> + </section> + <section id="sn-xml-header-cvs"> + <title>CVS Id Header</title> + <para>All the files must contain the CVS Id header. Use the + following line as the second line of any new XML file:</para> + <screen><![CDATA[<!-- $Id: -->]]></screen> + <para>Any time the file is committed to CVS, the line is updated + automatically to include information about the file. For + example:</para> + <screen><![CDATA[<!-- $Id: writing-guidelines.xml,v 1.8 2007/06/29 00:10:59 pfrields Exp $ -->]]></screen> + </section> + </section> <section id="sn-id-naming-conventions"> <title>ID Naming Conventions</title> @@ -132,7 +152,9 @@ <title>How To Fold Laundry</title> <section id="sn-folding-shirts"> <title>Folding Shirts</title>]]></screen> - + </section> + <section id="sn-xml-tags"> + <title>XML Tags</title> <indexterm> <primary>xml tags</primary> <secondary>caveats</secondary> @@ -157,28 +179,31 @@ cannot be changed via the stylesheet.</para> <para>Instead, use the <sgmltag>trademark</sgmltag> tag and its - associates classes as follows: - </para> - <itemizedlist> - <listitem> - <para><sgmltag - class="starttag">trademark</sgmltag>trademark symbol after - me<sgmltag class="endtag">trademark</sgmltag> - </para> - </listitem> - <listitem> - <para><sgmltag class="starttag">trademark - class="registered"</sgmltag>registered trademark symbol - after me<sgmltag class="endtag">trademark</sgmltag> - </para> - </listitem> - <listitem> - <para><sgmltag class="starttag">trademark - class="copyright"</sgmltag>copyright symbol after - me<sgmltag class="endtag">trademark</sgmltag></para> - </listitem> - </itemizedlist> - </listitem> + associates classes as follows:</para> + <segmentedlist> + <segtitle>DocBook XML source</segtitle> + <segtitle>Rendered content</segtitle> + <seglistitem> + <seg><code><![CDATA[<trademark>trademark symbol after + me</trademark>]]></code></seg> + <seg><trademark>trademark symbol after + me</trademark></seg> + </seglistitem> + <seglistitem> + <seg><code><![CDATA[<trademark + class="registered">registered trademark symbol after + me</trademark>]]></code></seg> + <seg><trademark class="registered">registered trademark + symbol after me</trademark></seg> + </seglistitem> + <seglistitem> + <seg><code><![CDATA[<trademark class="copyright">copyright + symbol after me</trademark>]]></code></seg> + <seg><trademark class="copyright">copyright symbol after + me</trademark></seg> + </seglistitem> + </segmentedlist> + </listitem> </varlistentry> <varlistentry> <term>Content inside <sgmltag>para</sgmltag> tags</term> @@ -239,22 +264,6 @@ </section> - <section id="sn-xml-guidelines-header"> - <title>File Header</title> - - <para>All the files must contain the CVS Id header. If you create a - new file, the first line must be:</para> - - <screen><![CDATA[<!-- $Id: -->]]></screen> - - <para>The first time it is committed to CVS (and every time it is - committed to CVS) the line is updated automatically to include - information about the file. For example:</para> - - <screen><![CDATA[<!-- $Id: writing-guidelines.xml,v 1.7 2007/03/08 03:00:44 pfrields Exp $ -->]]></screen> - - </section> - <section id="sn-xml-admon"> <title>Admonitions</title> |