docs-commits March 2007

docs-commits@lists.fedoraproject.org

1 participants
167 discussions

about-fedora/devel Makefile,1.2,1.3
by fedora-docs-commits＠redhat.com 08 Mar '07

08 Mar '07

Author: pfrields Update of /cvs/docs/about-fedora/devel In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv9385/about-fedora/devel Modified Files: Makefile Log Message: Match other versions for now Index: Makefile =================================================================== RCS file: /cvs/docs/about-fedora/devel/Makefile,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- Makefile 7 Feb 2007 10:50:15 -0000 1.2 +++ Makefile 8 Mar 2007 23:58:44 -0000 1.3 @@ -13,7 +13,7 @@ PKGNAME = ${DOCBASE} # Set this locally -VERSION = 6 +VERSION = 6.91 define XMLFILES_template XMLFILES-${1}= ${1}/${DOCBASE}.xml

1 0

documentation-guide/en_US emacs.xml, 1.3, 1.4 writing-guidelines.xml, 1.6, 1.7
by fedora-docs-commits＠redhat.com 07 Mar '07

07 Mar '07

Author: pfrields Update of /cvs/docs/documentation-guide/en_US In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv10430 Modified Files: emacs.xml writing-guidelines.xml Log Message: Use segmentedlist instead of tables -- separating appearance from content, yay DocBook! Index: emacs.xml =================================================================== RCS file: /cvs/docs/documentation-guide/en_US/emacs.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- emacs.xml 6 Feb 2007 01:09:59 -0000 1.3 +++ emacs.xml 8 Mar 2007 03:00:44 -0000 1.4 @@ -409,155 +409,144 @@ 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> Index: writing-guidelines.xml =================================================================== RCS file: /cvs/docs/documentation-guide/en_US/writing-guidelines.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- writing-guidelines.xml 18 Feb 2007 22:59:19 -0000 1.6 +++ writing-guidelines.xml 8 Mar 2007 03:00:44 -0000 1.7 @@ -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>

1 0

docs-common/xsl html-common.xsl,1.12,1.13
by fedora-docs-commits＠redhat.com 07 Mar '07

07 Mar '07

Author: pfrields Update of /cvs/docs/docs-common/xsl In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv10377 Modified Files: html-common.xsl Log Message: Set segmented lists to default to table rendering Index: html-common.xsl =================================================================== RCS file: /cvs/docs/docs-common/xsl/html-common.xsl,v retrieving revision 1.12 retrieving revision 1.13 diff -u -r1.12 -r1.13 --- html-common.xsl 10 Sep 2006 23:58:38 -0000 1.12 +++ html-common.xsl 8 Mar 2007 02:58:27 -0000 1.13 @@ -33,6 +33,6 @@  <xsl:param name="phrase.propagates.style" select="1"></xsl:param> <xsl:param name="generate.id.attributes" select="1"></xsl:param> - +<xsl:param name="segmentedlist.as.table" select="1"></xsl:param> </xsl:stylesheet>

1 0

docs-common/css fedora-draft.css,1.7,1.8 fedora-plain.css,1.6,1.7
by fedora-docs-commits＠redhat.com 04 Mar '07

04 Mar '07

Author: pfrields Update of /cvs/docs/docs-common/css In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv9394 Modified Files: fedora-draft.css fedora-plain.css Log Message: Sorry, should have worked this out better before the first commit. This is it for a bit. Index: fedora-draft.css =================================================================== RCS file: /cvs/docs/docs-common/css/fedora-draft.css,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- fedora-draft.css 5 Mar 2007 01:22:56 -0000 1.7 +++ fedora-draft.css 5 Mar 2007 01:47:16 -0000 1.8 @@ -88,7 +88,6 @@ } .segmentedlist table { border-collapse: collapse; - width: 70%; } .segmentedlist tr { border: 1px solid #22437f; @@ -100,10 +99,10 @@ } .segmentedlist th { text-align: left; - padding: 0.2em 3em 0.2em 0.5em; + padding: 0.2em 5em 0.2em 0.5em; } .segmentedlist td { - padding: 0.2em 0.5em 0.2em 0.5em; + padding: 0.2em 5em 0.2em 0.5em; } hr { Index: fedora-plain.css =================================================================== RCS file: /cvs/docs/docs-common/css/fedora-plain.css,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- fedora-plain.css 5 Mar 2007 01:22:56 -0000 1.6 +++ fedora-plain.css 5 Mar 2007 01:47:16 -0000 1.7 @@ -86,7 +86,6 @@ } .segmentedlist table { border-collapse: collapse; - width: 70%; } .segmentedlist tr { border: 1px solid #22437f; @@ -98,10 +97,10 @@ } .segmentedlist th { text-align: left; - padding: 0.2em 3em 0.2em 0.5em; + padding: 0.2em 5em 0.2em 0.5em; } .segmentedlist td { - padding: 0.2em 0.5em 0.2em 0.5em; + padding: 0.2em 5em 0.2em 0.5em; } hr {

1 0

docs-common/css fedora-draft.css,1.6,1.7 fedora-plain.css,1.5,1.6
by fedora-docs-commits＠redhat.com 04 Mar '07

04 Mar '07

Author: pfrields Update of /cvs/docs/docs-common/css In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv8881 Modified Files: fedora-draft.css fedora-plain.css Log Message: Turn down the font a little so as not to stick out. Index: fedora-draft.css =================================================================== RCS file: /cvs/docs/docs-common/css/fedora-draft.css,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- fedora-draft.css 5 Mar 2007 00:30:41 -0000 1.6 +++ fedora-draft.css 5 Mar 2007 01:22:56 -0000 1.7 @@ -97,14 +97,13 @@ background: #33649f; color: #fefefe; font-weight: bold; - font-size: 110%; } .segmentedlist th { text-align: left; padding: 0.2em 3em 0.2em 0.5em; } .segmentedlist td { - padding: 0.2em 0.5em 0.2em 0.55em; + padding: 0.2em 0.5em 0.2em 0.5em; } hr { Index: fedora-plain.css =================================================================== RCS file: /cvs/docs/docs-common/css/fedora-plain.css,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- fedora-plain.css 5 Mar 2007 00:30:41 -0000 1.5 +++ fedora-plain.css 5 Mar 2007 01:22:56 -0000 1.6 @@ -95,14 +95,13 @@ background: #33649f; color: #fefefe; font-weight: bold; - font-size: 110%; } .segmentedlist th { text-align: left; padding: 0.2em 3em 0.2em 0.5em; } .segmentedlist td { - padding: 0.2em 0.5em 0.2em 0.55em; + padding: 0.2em 0.5em 0.2em 0.5em; } hr {

1 0

docs-common/css fedora-draft.css,1.5,1.6 fedora-plain.css,1.4,1.5
by fedora-docs-commits＠redhat.com 04 Mar '07

04 Mar '07

Author: pfrields Update of /cvs/docs/docs-common/css In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv4271 Modified Files: fedora-draft.css fedora-plain.css Log Message: Add simple segmented list formatting that complements the rest of our theme Index: fedora-draft.css =================================================================== RCS file: /cvs/docs/docs-common/css/fedora-draft.css,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- fedora-draft.css 18 Feb 2007 20:53:16 -0000 1.5 +++ fedora-draft.css 5 Mar 2007 00:30:41 -0000 1.6 @@ -84,6 +84,29 @@ .qandaset tr.question td, .qandaset tr.answer td { } +.segmentedlist { +} +.segmentedlist table { + border-collapse: collapse; + width: 70%; +} +.segmentedlist tr { + border: 1px solid #22437f; +} +.segmentedlist tr.segtitle { + background: #33649f; + color: #fefefe; + font-weight: bold; + font-size: 110%; +} +.segmentedlist th { + text-align: left; + padding: 0.2em 3em 0.2em 0.5em; +} +.segmentedlist td { + padding: 0.2em 0.5em 0.2em 0.55em; +} + hr { border: 0; border-bottom: 1px solid #ccc; Index: fedora-plain.css =================================================================== RCS file: /cvs/docs/docs-common/css/fedora-plain.css,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- fedora-plain.css 18 Feb 2007 20:26:08 -0000 1.4 +++ fedora-plain.css 5 Mar 2007 00:30:41 -0000 1.5 @@ -82,6 +82,29 @@ .qandaset tr.question td, .qandaset tr.answer td { } +.segmentedlist { +} +.segmentedlist table { + border-collapse: collapse; + width: 70%; +} +.segmentedlist tr { + border: 1px solid #22437f; +} +.segmentedlist tr.segtitle { + background: #33649f; + color: #fefefe; + font-weight: bold; + font-size: 110%; +} +.segmentedlist th { + text-align: left; + padding: 0.2em 3em 0.2em 0.5em; +} +.segmentedlist td { + padding: 0.2em 0.5em 0.2em 0.55em; +} + hr { border: 0; border-bottom: 1px solid #ccc;

1 0

documentation-guide/en_US getting-files.xml,1.1,1.2
by fedora-docs-commits＠redhat.com 02 Mar '07

02 Mar '07

Author: pfrields Update of /cvs/docs/documentation-guide/en_US In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv2887/en_US Modified Files: getting-files.xml Log Message: Better hinting for choosing module names; caution about using distro name redundantly Index: getting-files.xml =================================================================== RCS file: /cvs/docs/documentation-guide/en_US/getting-files.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- getting-files.xml 3 Feb 2007 22:21:58 -0000 1.1 +++ getting-files.xml 3 Mar 2007 00:03:49 -0000 1.2 @@ -79,7 +79,7 @@ <section id="ch-getting-files-filenames"> <title>Filename Conventions</title> <para> - &FDP; provides the tools, scripts, and stylesheets to transform your + The &FDP; provides the tools, scripts, and stylesheets to transform your <abbrev>XML</abbrev> documents into other output formats such as <abbrev>HTML</abbrev>. In addition, these tools can build your document into a <abbrev>RPM</abbrev> package. To take advantage of these @@ -91,16 +91,28 @@ Each document lives in a peer directory to the <filename>docs-common</filename> directory you extracted from the &FED; archive earlier. On the CVS server, these directories are called - <firstterm>modules</firstterm>. Choose a module name that accurately - reflects your document's subject, but avoid any name already taken. Use + <firstterm>modules</firstterm>. Use the <command>cvs co -c</command> command to view existing module names. </para> + <example> + <title>Partial List of CVS Modules</title> + <screen><userinput>cd ~/localrepo/fedora-docs/</userinput> +<computeroutput>build-docs infrastructure/build-docs +cvsroot CVSROOT +desktop-up2date desktop-up2date +developer-guide developer-guide +docs . +docs-common docs-common +documentation-guide documentation-guide +example-tutorial example-tutorial</computeroutput></screen> + </example> + <para>Choose a module name that accurately reflects your + document's subject, but avoid any name already taken.</para> <important> <title>Avoid Redundancy</title> <para> - Do not use the word <wordasword>&FED;</wordasword> in your module - name. Since all documents in the repository are &FED; documentation, - using this term creates unnecessary confusion. + Do not use the word <wordasword>&FED;</wordasword> to name + modules in the &FDP; CVS repository. </para> </important> </section>

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

docs-commits March 2007