svn commit: r42384 - head/en_US.ISO8859-1/books/fdp-primer/overview
Warren Block
wblock at FreeBSD.org
Mon Jul 22 21:08:57 UTC 2013
Author: wblock
Date: Mon Jul 22 21:08:56 2013
New Revision: 42384
URL: http://svnweb.freebsd.org/changeset/doc/42384
Log:
Whitespace-only fixes. Translators, please ignore.
Modified:
head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Mon Jul 22 21:00:03 2013 (r42383)
+++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Mon Jul 22 21:08:56 2013 (r42384)
@@ -125,22 +125,21 @@
<command>svn log</command>. Commit messages are also
archived at <ulink url="&a.svn-doc-all.url;"></ulink>.</para>
- <para>Many people have written tutorials or how-to
- articles about &os;. Some are stored as part of the
- <acronym>FDP</acronym> files. In other cases, the author has
- decided to keep the documentation separate. The
- <acronym>FDP</acronym> endeavors to provide links to as much of
- this external documentation as possible.</para>
+ <para>Many people have written tutorials or how-to articles about
+ &os;. Some are stored as part of the <acronym>FDP</acronym>
+ files. In other cases, the author has decided to keep the
+ documentation separate. The <acronym>FDP</acronym> endeavors to
+ provide links to as much of this external documentation as
+ possible.</para>
</sect1>
<sect1 id="overview-quick-start">
<title>Quick Start</title>
- <para>Some preparatory steps must be taken before
- editing the &os; documentation. New
- contributors will interact with other members of the &os;
- Documentation Team, which can assist in learning to use
- <acronym>XML</acronym> and the suggestions in
+ <para>Some preparatory steps must be taken before editing the &os;
+ documentation. New contributors will interact with other
+ members of the &os; Documentation Team, which can assist in
+ learning to use <acronym>XML</acronym> and the suggestions in
<xref linkend="writing-style-guide"/>. If a new user
contributes regularly, a Documentation Team member may be
assigned as a mentor to guide the user through the process from
@@ -148,8 +147,8 @@
<procedure>
<step>
- <para>Subscribe to the &a.doc;. Some mailing list
- members also interact on the <literal>#bsddocs</literal>
+ <para>Subscribe to the &a.doc;. Some mailing list members
+ also interact on the <literal>#bsddocs</literal>
<acronym>IRC</acronym> channel on <ulink
url="http://www.efnet.org/">EFnet</ulink>.</para>
</step>
@@ -163,103 +162,101 @@
<step>
<para>Install a local working copy of the documentation
- from a mirror of the &os; repository (see <xref linkend="working-copy"/>) in <filename class="directory">~/doc</filename>.</para>
+ from a mirror of the &os; repository (see
+ <xref linkend="working-copy"/>) in
+ <filename class="directory">~/doc</filename>.</para>
<screen>&prompt.user; <userinput>svn checkout https://<replaceable>svn0.us-west.FreeBSD.org</replaceable>/doc/head <replaceable>/usr/doc</replaceable></userinput></screen>
+ </step>
+
+ <step>
+ <para>Configure the text editor:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Word wrap set to 70 characters.</para>
+ </listitem>
+
+ <listitem>
+ <para>Tab stops set to 2.</para>
+ </listitem>
+
+ <listitem>
+ <para>Replace each group of 8 leading spaces with a
+ single tab.</para>
+ </listitem>
+ </itemizedlist>
- </step>
+ <para>Specific editor configurations are listed in
+ <xref linkend="editor-config"/>.</para>
+ </step>
+
+ <step>
+ <para>Update the local working copy:</para>
- <step>
- <para>Configure the text editor:</para>
+ <screen>&prompt.user; <userinput>svn up ~/doc</userinput></screen>
+ </step>
+
+ <step>
+ <para>Edit the documentation files that require changes. If a
+ file needs major changes, consult the &a.doc; for
+ input.</para>
+
+ <para>References to tag and entity usage can be found in
+ <xref linkend="xhtml-markup"/> and
+ <xref linkend="docbook-markup"/>.</para>
+ </step>
+
+ <step>
+ <para>After editing, check for problems by running:</para>
- <itemizedlist>
- <listitem>
- <para>Word wrap set to 70 characters.</para>
- </listitem>
-
- <listitem>
- <para>Tab stops set to 2.</para>
- </listitem>
-
- <listitem>
- <para>Replace each group of 8 leading spaces with a
- single tab.</para>
- </listitem>
- </itemizedlist>
-
- <para>
- Specific editor configurations
- are listed in <xref linkend="editor-config"/>.</para>
- </step>
-
- <step>
- <para>Update the local working copy:</para>
-
- <screen>&prompt.user; <userinput>svn up ~/doc</userinput></screen>
- </step>
-
- <step>
- <para>Edit the documentation files that require
- changes. If a file needs major changes, consult the
- &a.doc; for input.</para>
-
- <para>References to tag and entity usage can be found in
- <xref linkend="xhtml-markup"/> and
- <xref linkend="docbook-markup"/>.</para>
- </step>
-
- <step>
- <para>After editing, check for problems by
- running:</para>
-
- <screen>&prompt.user; <userinput>igor -R filename.xml | less -RS</userinput></screen>
-
- <para>Review the output and edit the file to fix any
- problems shown, then rerun the command to find any
- remaining problems. Repeat until all of the errors that
- are fixable are resolved. If an error seems unsolvable,
- ask for assistance on the &a.doc;.</para>
- </step>
-
- <step>
- <para><emphasis>Always</emphasis> build-test changes before
- submitting them. Running
- <userinput>make</userinput> in the top-level directory of
- the documentation being edited will generate that
- documentation in split HTML format. For example, to build
- the English version of the Handbook in
- <acronym>HTML</acronym>, type <command>make</command> in
- the <filename>en_US.ISO8859-1/books/handbook/</filename>
- directory.</para>
- </step>
-
- <step>
- <para>When changes are complete and tested,
- generate a <quote>diff file</quote>:</para>
+ <screen>&prompt.user; <userinput>igor -R filename.xml | less -RS</userinput></screen>
- <screen>&prompt.user; <userinput>cd /usr/doc</userinput>
+ <para>Review the output and edit the file to fix any problems
+ shown, then rerun the command to find any remaining
+ problems. Repeat until all of the errors that are fixable
+ are resolved. If an error seems unsolvable, ask for
+ assistance on the &a.doc;.</para>
+ </step>
+
+ <step>
+ <para><emphasis>Always</emphasis> build-test changes before
+ submitting them. Running <userinput>make</userinput> in the
+ top-level directory of the documentation being edited will
+ generate that documentation in split HTML format. For
+ example, to build the English version of the Handbook in
+ <acronym>HTML</acronym>, type <command>make</command> in the
+ <filename>en_US.ISO8859-1/books/handbook/</filename>
+ directory.</para>
+ </step>
+
+ <step>
+ <para>When changes are complete and tested, generate a
+ <quote>diff file</quote>:</para>
+
+ <screen>&prompt.user; <userinput>cd /usr/doc</userinput>
&prompt.user; <userinput>svn diff > <replaceable>bsdinstall</replaceable>.diff.txt</userinput></screen>
- <para>Give the diff file a descriptive name.
- In the example above, changes have been made to the
- <filename class="directory">bsdinstall</filename> portion
- of the Handbook.</para>
- </step>
-
- <step>
- <para>Submit the diff file using the web-based <ulink
- url="&url.base;/support.html#gnats">Problem
- Report</ulink> system or with &man.send-pr.1;. If using
- the web form, enter a synopsis of <emphasis>[patch]
- <replaceable>short description of
- problem</replaceable></emphasis>. Select the category
- <literal>docs</literal> and the class
- <literal>doc-bug</literal>. In the body of the message,
- enter a short description of the changes and any
- important details about them. Use the
- <guibutton>[ Browse... ]</guibutton> button to
- attach the <literal>.diff.txt</literal>.</para>
- </step>
- </procedure>
- </sect1>
- </chapter>
+ <para>Give the diff file a descriptive name. In the example
+ above, changes have been made to the
+ <filename class="directory">bsdinstall</filename> portion of
+ the Handbook.</para>
+ </step>
+
+ <step>
+ <para>Submit the diff file using the web-based
+ <ulink url="&url.base;/support.html#gnats">Problem
+ Report</ulink> system or with &man.send-pr.1;. If using
+ the web form, enter a synopsis of
+ <emphasis>[patch] <replaceable>short description of
+ problem</replaceable></emphasis>. Select the category
+ <literal>docs</literal> and the class
+ <literal>doc-bug</literal>. In the body of the message,
+ enter a short description of the changes and any important
+ details about them. Use the
+ <guibutton>[ Browse... ]</guibutton> button to
+ attach the <literal>.diff.txt</literal>.</para>
+ </step>
+ </procedure>
+ </sect1>
+</chapter>
More information about the svn-doc-all
mailing list