summaryrefslogtreecommitdiffstats
path: root/en_US/writing-guidelines.xml
diff options
context:
space:
mode:
authorKarsten Wade <kwade@redhat.com>2007-02-03 22:29:37 +0000
committerKarsten Wade <kwade@redhat.com>2007-02-03 22:29:37 +0000
commit5a8bab8c4395f0de72adc2efc7834f5751b05371 (patch)
treee0f5e4514c111b52d8ae9451781070d7f8c767d6 /en_US/writing-guidelines.xml
parent7648e2b3c70a76ab2f751b60813458a5261e3373 (diff)
downloaddocumentation-guide-5a8bab8c4395f0de72adc2efc7834f5751b05371.tar.gz
documentation-guide-5a8bab8c4395f0de72adc2efc7834f5751b05371.tar.xz
documentation-guide-5a8bab8c4395f0de72adc2efc7834f5751b05371.zip
updating all section usage and associated ID tags
Diffstat (limited to 'en_US/writing-guidelines.xml')
-rw-r--r--en_US/writing-guidelines.xml40
1 files changed, 20 insertions, 20 deletions
diff --git a/en_US/writing-guidelines.xml b/en_US/writing-guidelines.xml
index 64f2736..32ed5aa 100644
--- a/en_US/writing-guidelines.xml
+++ b/en_US/writing-guidelines.xml
@@ -29,7 +29,7 @@
<para>Please read this chapter carefully. This chapter describes the
guidelines that must be followed such as naming conventions.</para>
- <sect1 id="s1-xml-guidelines-naming">
+ <section id="sn-xml-guidelines-naming">
<title>ID Naming Conventions</title>
<indexterm>
@@ -87,7 +87,7 @@
name (minus the <command>"ch-"</command>) in its ID. For example,
you are working with the <command>"ch-intro"</command> chapter and
need to create your first section on disk partitions. That section
- ID would look similar to <command>"s1-intro-partition"</command>
+ ID would look similar to <command>"sn-intro-partition"</command>
which contains the section number, the main chapter ID, and a
unique ID for that section.</para>
@@ -117,12 +117,12 @@
<entry><computeroutput>sn-</computeroutput></entry>
</row>
<row>
- <entry><command>sect1</command></entry>
- <entry><computeroutput>s1-</computeroutput></entry>
+ <entry><command>section</command></entry>
+ <entry><computeroutput>sn-</computeroutput></entry>
</row>
<row>
- <entry><command>sect2</command></entry>
- <entry><computeroutput>s2-</computeroutput></entry>
+ <entry><command>section</command></entry>
+ <entry><computeroutput>sn-</computeroutput></entry>
</row>
<row>
<entry><command>sect3</command></entry>
@@ -156,9 +156,9 @@
</tgroup>
</table>
- </sect1>
+ </section>
- <sect1 id="s1-xml-guidelines-header">
+ <section id="sn-xml-guidelines-header">
<title>File Header</title>
<para>All the files must contain the CVS Id header. If you create a
@@ -170,11 +170,11 @@
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.1 2007/02/03 22:21:58 kwade Exp $ -->]]></screen>
+ <screen><![CDATA[<!-- $Id: writing-guidelines.xml,v 1.2 2007/02/03 22:29:37 kwade Exp $ -->]]></screen>
- </sect1>
+ </section>
- <sect1 id="s1-xml-admon">
+ <section id="sn-xml-admon">
<title>Admonitions</title>
<indexterm>
@@ -244,7 +244,7 @@
mandate that Warnings be reserved for cases where bodily harm can
result.</para>
- <sect2 id="s2-xml-notesetc">
+ <section id="sn-xml-notesetc">
<title>Creating Notes, Tips, Cautions, Importants, and
Warnings</title>
@@ -342,11 +342,11 @@
<title>Warning</title>
<para>Body of text goes here.</para>
</warning>
- </sect2>
+ </section>
- </sect1>
+ </section>
- <sect1 id="s1-screenshots">
+ <section id="sn-screenshots">
<title>Screenshots</title>
<indexterm>
@@ -453,7 +453,7 @@
</step>
</procedure>
<para>For more information about calling the images from the
- XML, refer to <xref linkend="s1-xml-tags-figure"/>.</para>
+ XML, refer to <xref linkend="sn-xml-tags-figure"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -500,14 +500,14 @@
8032 pts/1 S 0:00 ssh root@backup.example.com</computeroutput></screen>
</example>
<para>For more information about using screen, refer to <xref
- linkend="s1-xml-tags-screen"/>.</para>
+ linkend="sn-xml-tags-screen"/>.</para>
</listitem>
</varlistentry>
</variablelist>
- </sect1>
+ </section>
<!--
- <sect1 id="s1-diagrams-images">
+ <section id="sn-diagrams-images">
<title>Diagrams and Images</title>
<indexterm>
@@ -522,7 +522,7 @@
To be written
</para>
- </sect1>
+ </section>
-->
</chapter>