os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Whitespace-only fixes. Translators, please ignore.

Browse source
This commit is contained in:
Warren Block 2013-06-26 15:40:23 +00:00
parent f349092366
commit 981827cc42
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=42065
2 changed files with 55 additions and 51 deletions
en_US.ISO8859-1/books/fdp-primer
book.xml
overview
chapter.xml

16
en_US.ISO8859-1/books/fdp-primer/book.xml
View file

@ -72,7 +72,8 @@
<abstract> <abstract>
<para>Thank you for becoming a part of the FreeBSD Documentation <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 <para>This primer covers details needed
to start contributing to the FreeBSD Documentation to start contributing to the FreeBSD Documentation
@ -172,13 +173,16 @@ The time is 09:18</screen></entry>
<row> <row>
<entry>Emphasis.</entry> <entry>Emphasis.</entry>
<entry>The user <emphasis>must</emphasis> do this.</entry> <entry>The user <emphasis>must</emphasis> do
this.</entry>
</row> </row>
<row> <row>
<entry>Text that the user is expected to replace with <entry>Text that the user is expected to replace with
the actual text.</entry> 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> <replaceable>keyword</replaceable></command></entry>
</row> </row>
@ -220,9 +224,9 @@ The time is 09:18</screen></entry>
<warning> <warning>
<para>Warnings are represented like this, and contain <para>Warnings are represented like this, and contain
information warning about possible damage if the information warning about possible damage if the
instructions are not followed. This damage may be physical, to instructions are not followed. This damage may be physical,
the hardware or the user, or it may be non-physical, such as to the hardware or the user, or it may be non-physical, such
the inadvertent deletion of important files.</para> as the inadvertent deletion of important files.</para>
</warning> </warning>
<example> <example>

90
en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
View file

@ -39,16 +39,15 @@
to the success of &os;, and we value your contributions very to the success of &os;, and we value your contributions very
highly.</para> highly.</para>
<para>This document describes how the <para>This document describes how the <acronym>FDP</acronym> is
<acronym>FDP</acronym> is organized, how to write and submit organized, how to write and submit documentation, and how to
documentation, and how to effectively use the available effectively use the available tools.</para>
tools.</para>
<para>Everyone is welcome to contribute to the <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 <para>This Primer shows the reader how to:</para>
to:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -77,7 +76,6 @@
categories of &os; documentation.</para> categories of &os; documentation.</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>Handbook</emphasis>: The Handbook is the <para><emphasis>Handbook</emphasis>: The Handbook is the
comprehensive online resource and reference for &os; comprehensive online resource and reference for &os;
@ -110,9 +108,9 @@
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>Translation teams are responsible for translating <para>Translation teams are responsible for translating the
the Handbook and web site into different languages. Manual Handbook and web site into different languages. Manual pages
pages are not translated.</para> are not translated.</para>
<para>Documentation source for the &os; web site, Handbook, and <para>Documentation source for the &os; web site, Handbook, and
<acronym>FAQ</acronym> is available in the Subversion <acronym>FAQ</acronym> is available in the Subversion
@ -123,31 +121,30 @@
Subversion repository located at Subversion repository located at
<literal>https://svn.FreeBSD.org/base/</literal>.</para> <literal>https://svn.FreeBSD.org/base/</literal>.</para>
<para>Documentation commit messages <para>Documentation commit messages are visible with
are visible with <application>svn</application>. <application>svn</application>. Commit messages are also
Commit messages are also archived at <ulink url="&a.svn-doc-all.url;"></ulink>.</para> archived at <ulink url="&a.svn-doc-all.url;"></ulink>.</para>
<para>In addition, many people have written tutorials or how-to <para>In addition, many people have written tutorials or how-to
articles about &os;. Some are stored as part of the articles about &os;. Some are stored as part of the
<acronym>FDP</acronym> files. In other cases, the author has decided <acronym>FDP</acronym> files. In other cases, the author has
to keep the documentation separate. decided to keep the documentation separate. The
The <acronym>FDP</acronym> endeavors to <acronym>FDP</acronym> endeavors to provide links to as much of
provide links to as much of this external documentation as this external documentation as possible.</para>
possible.</para>
</sect1> </sect1>
<sect1 id="overview-quick-start"> <sect1 id="overview-quick-start">
<title>Quick Start</title> <title>Quick Start</title>
<para>Here we describe the steps contributors must <para>Here we describe the steps contributors must follow before
follow before they can make changes to the they can make changes to the <acronym>FDP</acronym>. New
<acronym>FDP</acronym>. New contributors will interact with contributors will interact with other members of the &os;
other members of the &os; Documentation Team, which can assist in Documentation Team, which can assist in learning to use
learning to use <acronym>XML</acronym> and the suggestions in <xref <acronym>XML</acronym> and the suggestions in
linkend="writing-style-guide"/>. If a new user contributes <xref linkend="writing-style-guide"/>. If a new user
regularly, a Documentation Team member may be assigned as a contributes regularly, a Documentation Team member may be
mentor to guide the user through the process from contributor assigned as a mentor to guide the user through the process from
to documentation committer.</para> contributor to documentation committer.</para>
<procedure> <procedure>
<step> <step>
@ -182,13 +179,16 @@
How to do so varies by editor. Some editor configurations How to do so varies by editor. Some editor configurations
are listed in <xref linkend="writing-style"/>. The editor are listed in <xref linkend="writing-style"/>. The editor
should be configured as follows:</para> should be configured as follows:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Word wrap set to 70 characters.</para> <para>Word wrap set to 70 characters.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Tab stops set to 2.</para> <para>Tab stops set to 2.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Replace each group of 8 leading spaces with a <para>Replace each group of 8 leading spaces with a
single tab.</para> single tab.</para>
@ -198,10 +198,10 @@
<step> <step>
<para>Locate the file to edit. Run <para>Locate the file to edit. Run
<command>svn up</command> within the local working copy <command>svn up</command> within the local working copy to
to make sure that it is up to date. Before making major make sure that it is up to date. Before making major
changes to a file, discuss the proposed changes with changes to a file, discuss the proposed changes with the
the &a.doc;.</para> &a.doc;.</para>
<para>When making edits, determine which tags and entities <para>When making edits, determine which tags and entities
are needed to achieve the desired formatting. One way to 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> <screen>&prompt.user; <userinput>igor -R filename.xml | less -RS</userinput></screen>
<para>Review the output and edit the file to fix any <para>Review the output and edit the file to fix any listed
listed tab errors, spelling mistakes, and improper tab errors, spelling mistakes, and improper grammar. Save
grammar. Save the changes and rerun this command to find the changes and rerun this command to find any remaining
any remaining problems. Repeat until all of the errors problems. Repeat until all of the errors that you deem
that you deem fixable are resolved. If you get stuck fixable are resolved. If you get stuck trying to fix
trying to fix errors, ask for assistance on the errors, ask for assistance on the &a.doc;.</para>
&a.doc;.</para>
</step> </step>
<step> <step>
@ -255,13 +254,14 @@
<screen>&prompt.user; <userinput>make FORMATS="html txt"</userinput></screen> <screen>&prompt.user; <userinput>make FORMATS="html txt"</userinput></screen>
<para>Once these steps are successfully completed, generate a <para>Once these steps are successfully completed, generate
<quote>diff file</quote> of the changes. While in <filename a <quote>diff file</quote> of the changes. While in
class="directory">/usr/doc</filename>, run this command, <filename class="directory">/usr/doc</filename>, run this
replacing <replaceable>bsdinstall</replaceable> with the command, replacing <replaceable>bsdinstall</replaceable>
name of the directory containing the edits:</para> 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>
<step> <step>