summaryrefslogtreecommitdiffstats
path: root/en_US
diff options
context:
space:
mode:
authorPaul W. Frields <stickster@gmail.com>2007-03-08 03:00:44 +0000
committerPaul W. Frields <stickster@gmail.com>2007-03-08 03:00:44 +0000
commitdef7fb2d8cb5b6d1a81187da58eae448885d2ee5 (patch)
tree1b59bf2ef26ab8c7ddcbf21508480de4b76b2e57 /en_US
parent9971c4fb180b8c5a744b48ebef5642989a62c589 (diff)
downloaddocumentation-guide-def7fb2d8cb5b6d1a81187da58eae448885d2ee5.tar.gz
documentation-guide-def7fb2d8cb5b6d1a81187da58eae448885d2ee5.tar.xz
documentation-guide-def7fb2d8cb5b6d1a81187da58eae448885d2ee5.zip
Use segmentedlist instead of tables -- separating appearance from content, yay DocBook!
Diffstat (limited to 'en_US')
-rw-r--r--en_US/emacs.xml287
-rw-r--r--en_US/writing-guidelines.xml85
2 files changed, 175 insertions, 197 deletions
diff --git a/en_US/emacs.xml b/en_US/emacs.xml
index 64cd81b..b97e085 100644
--- a/en_US/emacs.xml
+++ b/en_US/emacs.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Id: emacs.xml,v 1.3 2007/02/06 01:09:59 pfrields Exp $ -->
+<!-- $Id: emacs.xml,v 1.4 2007/03/08 03:00:44 pfrields Exp $ -->
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
@@ -409,155 +409,144 @@ emacs.geometry: 90x25
The <keycap>Meta</keycap> key is usually the <keycap>Alt</keycap> key.
</para>
- <table frame="all" rowsep="1" colsep="1" id="tb-emacs-commands">
- <title>Emacs Commands</title>
- <tgroup rowsep="1" colsep="1" cols="2">
- <colspec colnum="1" colname="shortcut" colwidth="170"/>
- <colspec colnum="2" colname="description" colwidth="300"/>
-
- <thead>
- <row>
- <entry rowsep="1" colsep="1">Shortcut</entry>
- <entry rowsep="1" colsep="1">Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry rowsep="1" colsep="1"><keycombo>
- <keycap>Meta</keycap><keycap>x</keycap></keycombo>
- sgml-parse-prolog, <keycap>Enter</keycap></entry>
- <entry>Parse DTD</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Meta</keycap><keycap>x</keycap>
- </keycombo>sgml-save-dtd, <keycap>Enter</keycap></entry>
- <entry>Save the Parse DTD</entry>
- </row>
- <row>
- <entry><keycombo> <keycap>Meta</keycap><keycap>x</keycap>
- </keycombo>sgml-load-dtd, <keycap>Enter</keycap></entry>
- <entry>Load DTD</entry>
- </row>
- <row>
- <entry><keycombo> <keycap>Ctrl</keycap> <keycap>c</keycap>
- </keycombo>, <keycombo> <keycap>Shift</keycap>
- <keycap></keycap></keycombo>, <keycap>Tab</keycap></entry>
- <entry>Display list of valid tags</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap> <keycap>c</keycap>
- </keycombo>, <keycombo> <keycap>Shift</keycap>
- <keycap></keycap> </keycombo>, type beginning of tag,
- <keycap>Tab</keycap></entry>
- <entry>Complete the tag</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap> <keycap>g</keycap>
- </keycombo></entry>
- <entry>Cancel a command in the minibuffer</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap> <keycap>c</keycap>
- </keycombo>, <keycap>/</keycap></entry>
- <entry>Close tag</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap> <keycap>a</keycap>
- </keycombo></entry>
- <entry>Move cursor to beginning of line</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>e</keycap>
- </keycombo></entry>
- <entry>Move cursor to the end of the line</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>Home</keycap>
- </keycombo></entry>
- <entry>Move cursor to the beginning of the file</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>End</keycap>
- </keycombo></entry>
- <entry>Move cursor to the end of the file</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>k</keycap>
- </keycombo></entry>
- <entry>Cut line</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap> <keycap>y</keycap>
- </keycombo></entry>
- <entry>Paste line</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap> <keycap>s</keycap>
- </keycombo></entry>
- <entry>Search forward in the file</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>r</keycap>
- </keycombo></entry>
- <entry>Search backwards in the file</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Meta</keycap><keycap>$</keycap>
- </keycombo></entry>
- <entry>Check spelling of current word</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Meta</keycap><keycap>x</keycap>
- </keycombo> ispell-word, <keycap>Enter</keycap></entry>
- <entry>Check spelling of current word</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Meta</keycap><keycap>x</keycap>
- </keycombo> ispell-buffer, <keycap>Enter</keycap></entry>
- <entry>Check spelling of current buffer</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>x</keycap>
- </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>f</keycap>
- </keycombo></entry>
- <entry>Open file</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>x</keycap>
- </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>s</keycap>
- </keycombo></entry>
- <entry>Save file</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>x</keycap>
- </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>c</keycap>
- </keycombo></entry>
- <entry>Exit <application>Emacs</application> and prompt to save
- files if necessary</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Meta</keycap> <keycap>q</keycap>
- </keycombo></entry>
- <entry>Fill paragraph</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap><keycap>c</keycap>
- </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>a</keycap>
- </keycombo></entry>
- <entry>Edit attributes for a tag (for example, you can edit the
- <computeroutput>url</computeroutput> attribute of the
- <computeroutput>ulink</computeroutput> tag)</entry>
- </row>
- <row>
- <entry><keycombo><keycap>Ctrl</keycap> <keycap>c</keycap>
+ <segmentedlist id="tb-emacs-commands">
+ <title>Emacs Commands</title>
+ <segtitle>Shortcut</segtitle>
+ <segtitle>Description</segtitle>
+ <seglistitem>
+ <seg><keycombo>
+ <keycap>Meta</keycap><keycap>x</keycap></keycombo>
+ sgml-parse-prolog, <keycap>Enter</keycap></seg>
+ <seg>Parse DTD</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Meta</keycap><keycap>x</keycap>
+ </keycombo>sgml-save-dtd, <keycap>Enter</keycap></seg>
+ <seg>Save the Parse DTD</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo> <keycap>Meta</keycap><keycap>x</keycap>
+ </keycombo>sgml-load-dtd, <keycap>Enter</keycap></seg>
+ <seg>Load DTD</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo> <keycap>Ctrl</keycap> <keycap>c</keycap>
+ </keycombo>, <keycombo> <keycap>Shift</keycap>
+ <keycap></keycap></keycombo>, <keycap>Tab</keycap></seg>
+ <seg>Display list of valid tags</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap> <keycap>c</keycap>
+ </keycombo>, <keycombo> <keycap>Shift</keycap>
+ <keycap></keycap> </keycombo>, type beginning of tag,
+ <keycap>Tab</keycap></seg>
+ <seg>Complete the tag</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap> <keycap>g</keycap>
+ </keycombo></seg>
+ <seg>Cancel a command in the minibuffer</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap> <keycap>c</keycap>
+ </keycombo>, <keycap>/</keycap></seg>
+ <seg>Close tag</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap> <keycap>a</keycap>
+ </keycombo></seg>
+ <seg>Move cursor to beginning of line</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>e</keycap>
+ </keycombo></seg>
+ <seg>Move cursor to the end of the line</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>Home</keycap>
+ </keycombo></seg>
+ <seg>Move cursor to the beginning of the file</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>End</keycap>
+ </keycombo></seg>
+ <seg>Move cursor to the end of the file</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>k</keycap>
+ </keycombo></seg>
+ <seg>Cut line</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap> <keycap>y</keycap>
+ </keycombo></seg>
+ <seg>Paste line</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap> <keycap>s</keycap>
+ </keycombo></seg>
+ <seg>Search forward in the file</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>r</keycap>
+ </keycombo></seg>
+ <seg>Search backwards in the file</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Meta</keycap><keycap>$</keycap>
+ </keycombo></seg>
+ <seg>Check spelling of current word</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Meta</keycap><keycap>x</keycap>
+ </keycombo> ispell-word, <keycap>Enter</keycap></seg>
+ <seg>Check spelling of current word</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Meta</keycap><keycap>x</keycap>
+ </keycombo> ispell-buffer, <keycap>Enter</keycap></seg>
+ <seg>Check spelling of current buffer</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>x</keycap>
+ </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>f</keycap>
+ </keycombo></seg>
+ <seg>Open file</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>x</keycap>
+ </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>s</keycap>
+ </keycombo></seg>
+ <seg>Save file</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>x</keycap>
+ </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>c</keycap>
+ </keycombo></seg>
+ <seg>Exit <application>Emacs</application> and prompt to save
+ files if necessary</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Meta</keycap> <keycap>q</keycap>
+ </keycombo></seg>
+ <seg>Fill paragraph</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap><keycap>c</keycap>
+ </keycombo>, <keycombo><keycap>Ctrl</keycap><keycap>a</keycap>
+ </keycombo></seg>
+ <seg>Edit attributes for a tag (for example, you can edit the
+ <computeroutput>url</computeroutput> attribute of the
+ <computeroutput>ulink</computeroutput> tag)</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><keycombo><keycap>Ctrl</keycap> <keycap>c</keycap>
</keycombo>,
- <keycombo><keycap>Ctrl</keycap><keycap>c</keycap>
- </keycombo></entry>
- <entry>Exit edit attributes</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
+ <keycombo><keycap>Ctrl</keycap><keycap>c</keycap>
+ </keycombo></seg>
+ <seg>Exit edit attributes</seg>
+ </seglistitem>
+ </segmentedlist>
</section>
diff --git a/en_US/writing-guidelines.xml b/en_US/writing-guidelines.xml
index 6249a11..f6bf7ed 100644
--- a/en_US/writing-guidelines.xml
+++ b/en_US/writing-guidelines.xml
@@ -87,54 +87,43 @@
<figure id="fig-redhat-config-kickstart-basic">]]></screen>
</example>
- <table id="tb-id-two-char-naming-conventions">
+ <segmentedlist id="sg-id-two-char-naming-conventions">
<title>Two-Character Naming Conventions</title>
-
- <tgroup cols="2">
- <colspec colnum="1" colname="tag"/>
- <colspec colnum="2" colname="prefix"/>
- <thead>
- <row>
- <entry>Tag</entry>
- <entry>Prefix</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><sgmltag class="element">preface</sgmltag></entry>
- <entry><literal>pr-</literal></entry>
- </row>
- <row>
- <entry><sgmltag class="element">chapter</sgmltag></entry>
- <entry><literal>ch-</literal></entry>
- </row>
- <row>
- <entry><sgmltag class="element">section</sgmltag></entry>
- <entry><literal>sn-</literal></entry>
- </row>
- <row>
- <entry><sgmltag class="element">figure</sgmltag></entry>
- <entry><literal>fig-</literal></entry>
- </row>
- <row>
- <entry><sgmltag class="element">table</sgmltag></entry>
- <entry><literal>tb-</literal></entry>
- </row>
- <row>
- <entry><sgmltag class="element">appendix</sgmltag></entry>
- <entry><literal>ap-</literal></entry>
- </row>
- <row>
- <entry><sgmltag class="element">part</sgmltag></entry>
- <entry><literal>pt-</literal></entry>
- </row>
- <row>
- <entry><sgmltag class="element">example</sgmltag></entry>
- <entry><literal>ex-</literal></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
+ <segtitle>Tag</segtitle>
+ <segtitle>Prefix</segtitle>
+ <seglistitem>
+ <seg><sgmltag class="element">preface</sgmltag></seg>
+ <seg><literal>pr-</literal></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><sgmltag class="element">chapter</sgmltag></seg>
+ <seg><literal>ch-</literal></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><sgmltag class="element">section</sgmltag></seg>
+ <seg><literal>sn-</literal></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><sgmltag class="element">figure</sgmltag></seg>
+ <seg><literal>fig-</literal></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><sgmltag class="element">table</sgmltag></seg>
+ <seg><literal>tb-</literal></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><sgmltag class="element">appendix</sgmltag></seg>
+ <seg><literal>ap-</literal></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><sgmltag class="element">part</sgmltag></seg>
+ <seg><literal>pt-</literal></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><sgmltag class="element">example</sgmltag></seg>
+ <seg><literal>ex-</literal></seg>
+ </seglistitem>
+ </segmentedlist>
<para>Use the title of the item as the ID. Make your titles unique
within a document to prevent conflicts. For example:</para>
@@ -262,7 +251,7 @@
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.6 2007/02/18 22:59:19 pfrields Exp $ -->]]></screen>
+ <screen><![CDATA[<!-- $Id: writing-guidelines.xml,v 1.7 2007/03/08 03:00:44 pfrields Exp $ -->]]></screen>
</section>