svn commit: r42065 - in head/en_US.ISO8859-1/books/fdp-primer: . overview
Warren Block
wblock at FreeBSD.org
Wed Jun 26 15:40:24 UTC 2013
Author: wblock
Date: Wed Jun 26 15:40:23 2013
New Revision: 42065
URL: http://svnweb.freebsd.org/changeset/doc/42065
Log:
Whitespace-only fixes. Translators, please ignore.
Modified:
head/en_US.ISO8859-1/books/fdp-primer/book.xml
head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
Modified: head/en_US.ISO8859-1/books/fdp-primer/book.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/book.xml Wed Jun 26 15:29:14 2013 (r42064)
+++ head/en_US.ISO8859-1/books/fdp-primer/book.xml Wed Jun 26 15:40:23 2013 (r42065)
@@ -72,7 +72,8 @@
<abstract>
<para>Thank you for becoming a part of the FreeBSD Documentation
- Project. Your contribution is extremely valuable, and we appreciate it.</para>
+ Project. Your contribution is extremely valuable, and we
+ appreciate it.</para>
<para>This primer covers details needed
to start contributing to the FreeBSD Documentation
@@ -172,13 +173,16 @@ The time is 09:18</screen></entry>
<row>
<entry>Emphasis.</entry>
- <entry>The user <emphasis>must</emphasis> do this.</entry>
+ <entry>The user <emphasis>must</emphasis> do
+ this.</entry>
</row>
<row>
<entry>Text that the user is expected to replace with
the actual text.</entry>
- <entry>To search for a keyword in the manual pages, type <command>man -k
+
+ <entry>To search for a keyword in the manual pages, type
+ <command>man -k
<replaceable>keyword</replaceable></command></entry>
</row>
@@ -220,9 +224,9 @@ The time is 09:18</screen></entry>
<warning>
<para>Warnings are represented like this, and contain
information warning about possible damage if the
- instructions are not followed. This damage may be physical, to
- the hardware or the user, or it may be non-physical, such as
- the inadvertent deletion of important files.</para>
+ instructions are not followed. This damage may be physical,
+ to the hardware or the user, or it may be non-physical, such
+ as the inadvertent deletion of important files.</para>
</warning>
<example>
Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Wed Jun 26 15:29:14 2013 (r42064)
+++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Wed Jun 26 15:40:23 2013 (r42065)
@@ -39,16 +39,15 @@
to the success of &os;, and we value your contributions very
highly.</para>
- <para>This document describes how the
- <acronym>FDP</acronym> is organized, how to write and submit
- documentation, and how to effectively use the available
- tools.</para>
+ <para>This document describes how the <acronym>FDP</acronym> is
+ organized, how to write and submit documentation, and how to
+ effectively use the available tools.</para>
<para>Everyone is welcome to contribute to the
- <acronym>FDP</acronym>. Willingness to contribute is the only membership requirement.</para>
+ <acronym>FDP</acronym>. Willingness to contribute is the only
+ membership requirement.</para>
- <para>This Primer shows the reader how
- to:</para>
+ <para>This Primer shows the reader how to:</para>
<itemizedlist>
<listitem>
@@ -77,7 +76,6 @@
categories of &os; documentation.</para>
<itemizedlist>
-
<listitem>
<para><emphasis>Handbook</emphasis>: The Handbook is the
comprehensive online resource and reference for &os;
@@ -110,9 +108,9 @@
</listitem>
</itemizedlist>
- <para>Translation teams are responsible for translating
- the Handbook and web site into different languages. Manual
- pages are not translated.</para>
+ <para>Translation teams are responsible for translating the
+ Handbook and web site into different languages. Manual pages
+ are not translated.</para>
<para>Documentation source for the &os; web site, Handbook, and
<acronym>FAQ</acronym> is available in the Subversion
@@ -123,31 +121,30 @@
Subversion repository located at
<literal>https://svn.FreeBSD.org/base/</literal>.</para>
- <para>Documentation commit messages
- are visible with <application>svn</application>.
- Commit messages are also archived at <ulink url="&a.svn-doc-all.url;"></ulink>.</para>
+ <para>Documentation commit messages are visible with
+ <application>svn</application>. Commit messages are also
+ archived at <ulink url="&a.svn-doc-all.url;"></ulink>.</para>
<para>In addition, 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>
+ <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>Here we describe the steps contributors must
- follow before they can make changes to the
- <acronym>FDP</acronym>. 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 contributor
- to documentation committer.</para>
+ <para>Here we describe the steps contributors must follow before
+ they can make changes to the <acronym>FDP</acronym>. 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
+ contributor to documentation committer.</para>
<procedure>
<step>
@@ -182,13 +179,16 @@
How to do so varies by editor. Some editor configurations
are listed in <xref linkend="writing-style"/>. The editor
should be configured as follows:</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>
@@ -198,10 +198,10 @@
<step>
<para>Locate the file to edit. Run
- <command>svn up</command> within the local working copy
- to make sure that it is up to date. Before making major
- changes to a file, discuss the proposed changes with
- the &a.doc;.</para>
+ <command>svn up</command> within the local working copy to
+ make sure that it is up to date. Before making major
+ changes to a file, discuss the proposed changes with the
+ &a.doc;.</para>
<para>When making edits, determine which tags and entities
are needed to achieve the desired formatting. One way to
@@ -220,13 +220,12 @@
<screen>&prompt.user; <userinput>igor -R filename.xml | less -RS</userinput></screen>
- <para>Review the output and edit the file to fix any
- listed tab errors, spelling mistakes, and improper
- grammar. Save the changes and rerun this command to find
- any remaining problems. Repeat until all of the errors
- that you deem fixable are resolved. If you get stuck
- trying to fix errors, ask for assistance on the
- &a.doc;.</para>
+ <para>Review the output and edit the file to fix any listed
+ tab errors, spelling mistakes, and improper grammar. Save
+ the changes and rerun this command to find any remaining
+ problems. Repeat until all of the errors that you deem
+ fixable are resolved. If you get stuck trying to fix
+ errors, ask for assistance on the &a.doc;.</para>
</step>
<step>
@@ -255,13 +254,14 @@
<screen>&prompt.user; <userinput>make FORMATS="html txt"</userinput></screen>
- <para>Once these steps are successfully completed, generate a
- <quote>diff file</quote> of the changes. While in <filename
- class="directory">/usr/doc</filename>, run this command,
- replacing <replaceable>bsdinstall</replaceable> with the
- name of the directory containing the edits:</para>
+ <para>Once these steps are successfully completed, generate
+ a <quote>diff file</quote> of the changes. While in
+ <filename class="directory">/usr/doc</filename>, run this
+ command, replacing <replaceable>bsdinstall</replaceable>
+ with the name of the directory containing the
+ edits:</para>
- <screen>&prompt.user; <userinput>svn diff > <replaceable>bsdinstall</replaceable>.diff.txt</userinput></screen>
+ <screen>&prompt.user; <userinput>svn diff > <replaceable>bsdinstall</replaceable>.diff.txt</userinput></screen>
</step>
<step>
More information about the svn-doc-all
mailing list