PERFORCE change 156566 for review
Rene Ladan
rene at FreeBSD.org
Fri Jan 23 08:08:51 PST 2009
http://perforce.freebsd.org/chv.cgi?CH=156566
Change 156566 by rene at rene_self on 2009/01/23 16:08:08
IFC
Affected files ...
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/book.sgml#4 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml#2 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml#2 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/see-also/chapter.sgml#2 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml#3 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml#4 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml#2 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml#10 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/eresources/chapter.sgml#12 integrate
.. //depot/projects/docproj_nl/en_US.ISO8859-1/share/sgml/mailing-lists.ent#10 integrate
.. //depot/projects/docproj_nl/nl_NL.ISO8859-1/books/handbook/ports/chapter.sgml#15 integrate
.. //depot/projects/docproj_nl/share/pgpkeys/beech.key#3 integrate
Differences ...
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/book.sgml#4 (text+ko) ====
@@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
- $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.32 2008/12/07 22:03:48 pgj Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.33 2009/01/21 23:52:53 pgj Exp $
-->
<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [
@@ -56,12 +56,13 @@
<year>2006</year>
<year>2007</year>
<year>2008</year>
+ <year>2009</year>
<holder role="mailto:doceng at FreeBSD.org">DocEng</holder>
</copyright>
- <pubdate role="rcs">$FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.32 2008/12/07 22:03:48 pgj Exp $</pubdate>
+ <pubdate role="rcs">$FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.33 2009/01/21 23:52:53 pgj Exp $</pubdate>
- <releaseinfo>$FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.32 2008/12/07 22:03:48 pgj Exp $</releaseinfo>
+ <releaseinfo>$FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.33 2009/01/21 23:52:53 pgj Exp $</releaseinfo>
&bookinfo.legalnotice;
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml#2 (text+ko) ====
@@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
- $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml,v 1.17 2006/01/05 20:03:35 delphij Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/examples/appendix.sgml,v 1.18 2009/01/21 23:38:07 pgj Exp $
-->
<appendix id="examples">
@@ -90,12 +90,12 @@
</preface>
<chapter>
- <title>My first chapter</title>
+ <title>My First Chapter</title>
<para>This is the first chapter in my book.</para>
<sect1>
- <title>My first section</title>
+ <title>My First Section</title>
<para>This is the first section in my book.</para>
</sect1>
@@ -114,7 +114,7 @@
<article>
<articleinfo>
- <title>An example article</title>
+ <title>An Example Article</title>
<author>
<firstname>Your first name</firstname>
@@ -135,12 +135,12 @@
</articleinfo>
<sect1>
- <title>My first section</title>
+ <title>My First Section</title>
<para>This is the first section in my article.</para>
<sect2>
- <title>My first sub-section</title>
+ <title>My First Sub-Section</title>
<para>This is the first sub-section in my article.</para>
</sect2>
@@ -150,7 +150,7 @@
</sect1>
<sect1 id="examples-formatted">
- <title>Producing formatted output</title>
+ <title>Producing Formatted Output</title>
<para>This section assumes that you have installed the software listed in
the <filename role="package">textproc/docproj</filename> port, either by hand, or by
@@ -171,37 +171,37 @@
-c /usr/local/share/sgml/docbook/catalog \
-c /usr/local/share/sgml/jade/catalog \
-d /usr/local/share/sgml/docbook/dsssl/modular/html/docbook.dsl \<co id="examples-co-jade-1-dsssl">
- -t sgml <co id="examples-co-jade-1-transform"> file.sgml > file.html <co id="examples-co-jade-1-filename"></userinput></screen>
+ -t sgml <co id="examples-co-jade-1-transform"> <replaceable>file</replaceable>.sgml > <replaceable>file</replaceable>.html <co id="examples-co-jade-1-filename"></userinput></screen>
<calloutlist>
<callout arearefs="examples-co-jade-1-nochunks">
<para>Specifies the <literal>nochunks</literal> parameter to the
stylesheets, forcing all output to be written to
- <abbrev>STDOUT</abbrev> (using Norm Walsh's stylesheets).</para>
+ the standard output (using Norm Walsh's stylesheets).</para>
</callout>
<callout arearefs="examples-co-jade-1-catalog">
- <para>Specifies the catalogs that Jade will need to process.
+ <para>Specifies the catalogs that <application>Jade</application> will need to process.
Three catalogs are required. The first is a catalog that
contains information about the DSSSL stylesheets. The second
contains information about the DocBook DTD. The third contains
- information specific to Jade.</para>
+ information specific to <application>Jade</application>.</para>
</callout>
<callout arearefs="examples-co-jade-1-dsssl">
- <para>Specifies the full path to the DSSSL stylesheet that Jade
+ <para>Specifies the full path to the DSSSL stylesheet that <application>Jade</application>
will use when processing the document.</para>
</callout>
<callout arearefs="examples-co-jade-1-transform">
- <para>Instructs Jade to perform a
+ <para>Instructs <application>Jade</application> to perform a
<emphasis>transformation</emphasis> from one DTD to another. In
this case, the input is being transformed from the DocBook DTD
to the HTML DTD.</para>
</callout>
<callout arearefs="examples-co-jade-1-filename">
- <para>Specifies the file that Jade should process, and redirects
+ <para>Specifies the file that <application>Jade</application> should process, and redirects
output to the specified <filename>.html</filename> file.</para>
</callout>
</calloutlist>
@@ -219,7 +219,7 @@
<calloutlist>
<callout arearefs="examples-co-jade-2-catalog">
- <para>Specifies the catalogs that Jade will need to process.
+ <para>Specifies the catalogs that <application>Jade</application> will need to process.
Three catalogs are required. The first is a catalog that
contains information about the DSSSL stylesheets. The second
contains information about the DocBook DTD. The third contains
@@ -227,19 +227,19 @@
</callout>
<callout arearefs="examples-co-jade-2-dsssl">
- <para>Specifies the full path to the DSSSL stylesheet that Jade
+ <para>Specifies the full path to the DSSSL stylesheet that <application>Jade</application>
will use when processing the document.</para>
</callout>
<callout arearefs="examples-co-jade-2-transform">
- <para>Instructs Jade to perform a
+ <para>Instructs <application>Jade</application> to perform a
<emphasis>transformation</emphasis> from one DTD to another. In
this case, the input is being transformed from the DocBook DTD
to the HTML DTD.</para>
</callout>
<callout arearefs="examples-co-jade-2-filename">
- <para>Specifies the file that Jade should process. The
+ <para>Specifies the file that <application>Jade</application> should process. The
stylesheets determine how the individual HTML files will be
named, and the name of the <quote>root</quote> file (i.e., the
one that contains the start of the document.</para>
@@ -256,7 +256,7 @@
<para>The source SGML file must be converted to a &tex; file.</para>
- <screen>&prompt.user; <userinput>jade -Vtex-backend \ <co id="examples-co-jade-3-tex-backend">
+ <screen>&prompt.user; <userinput>jade -V tex-backend \ <co id="examples-co-jade-3-tex-backend">
-c /usr/local/share/sgml/docbook/dsssl/modular/catalog \ <co id="examples-co-jade-3-catalog">
-c /usr/local/share/sgml/docbook/catalog \
-c /usr/local/share/sgml/jade/catalog \
@@ -270,7 +270,7 @@
</callout>
<callout arearefs="examples-co-jade-3-catalog">
- <para>Specifies the catalogs that Jade will need to process. Three
+ <para>Specifies the catalogs that <application>Jade</application> will need to process. Three
catalogs are required. The first is a catalog that contains
information about the DSSSL stylesheets. The second contains
information about the DocBook DTD. The third contains
@@ -279,11 +279,11 @@
<callout arearefs="examples-co-jade-3-dsssl">
<para>Specifies the full path to the DSSSL stylesheet that
- Jade will use when processing the document.</para>
+ <application>Jade</application> will use when processing the document.</para>
</callout>
<callout arearefs="examples-co-jade-3-tex">
- <para>Instructs Jade to convert the output to &tex;.</para>
+ <para>Instructs <application>Jade</application> to convert the output to &tex;.</para>
</callout>
</calloutlist>
@@ -300,8 +300,8 @@
on.</para>
<para>Do not be alarmed if you see warning messages such as
- <literal>LaTeX Warning: Reference `136' on page 5 undefined on input
- line 728.</literal> at this point.</para>
+ <errorname>LaTeX Warning: Reference `136' on page 5 undefined on input
+ line 728.</errorname> at this point.</para>
<para>The second run reprocesses the document now that certain pieces
of information are known (such as the document's page length). This
@@ -328,7 +328,7 @@
linkend="examples-docbook-postscript">).</para>
<para>When the <filename>.tex</filename> file has been generated you
- run pdfTeX. However, use the &pdfjadetex macro package
+ run <application>pdfTeX</application>. However, use the <literal>&pdfjadetex</literal> macro package
instead.</para>
<screen>&prompt.user; <userinput>pdftex "&pdfjadetex" <replaceable>file</replaceable>.tex</userinput></screen>
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml#2 (text+ko) ====
@@ -27,15 +27,15 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
- $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml,v 1.10 2005/09/24 23:15:42 keramida Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml,v 1.11 2009/01/21 23:41:25 pgj Exp $
-->
<chapter id="psgml-mode">
<title>Using <literal>sgml-mode</literal> with
<application>Emacs</application></title>
- <para>Recent versions of <application>Emacs</application> or <application>XEmacs</application> (available from the ports
- collection) contain a very useful package called PSGML. Automatically
+ <para>Recent versions of <application>Emacs</application> or <application>XEmacs</application> (available from the Ports
+ Collection) contain a very useful package called PSGML (can be installed from <filename role="package">editors/psgml</filename>). Automatically
invoked when a file with the <filename>.sgml</filename> extension is loaded,
or by typing <command>M-x sgml-mode</command>, it is a major mode for
dealing with SGML files, elements and attributes.</para>
@@ -48,9 +48,9 @@
<term><command>C-c C-e</command></term>
<listitem>
- <para>Runs <literal>sgml-insert-element</literal>. You will be
+ <para>Runs <function>sgml-insert-element</function>. You will be
prompted for the name of the element to insert at the current point.
- You can use the TAB key to complete the element. Elements that are
+ You can use the <keycap>Tab</keycap> key to complete the element. Elements that are
not valid at the current point will be disallowed.</para>
<para>The start and end tags for the element will be inserted. If the
@@ -63,7 +63,7 @@
<term><command>C-c =</command></term>
<listitem>
- <para>Runs <literal>sgml-change-element-name</literal>. Place the
+ <para>Runs <function>sgml-change-element-name</function>. Place the
point within an element and run this command. You will be prompted
for the name of the element to change to. Both the start and end
tags of the current element will be changed to the new
@@ -75,8 +75,8 @@
<term><command>C-c C-r</command></term>
<listitem>
- <para>Runs <literal>sgml-tag-region</literal>. Select some text (move
- to start of text, C-space, move to end of text, C-space) and then
+ <para>Runs <function>sgml-tag-region</function>. Select some text (move
+ to start of text, <command>C-space</command>, move to end of text, <command>C-space</command>) and then
run this command. You will be prompted for the element to use. This
element will then be inserted immediately before and after your
marked region.</para>
@@ -87,7 +87,7 @@
<term><command>C-c -</command></term>
<listitem>
- <para>Runs <literal>sgml-untag-element</literal>. Place the point
+ <para>Runs <function>sgml-untag-element</function>. Place the point
within the start or end tag of an element you want to remove, and
run this command. The element's start and end tags will be
removed.</para>
@@ -98,7 +98,7 @@
<term><command>C-c C-q</command></term>
<listitem>
- <para>Runs <literal>sgml-fill-element</literal>. Will recursively fill
+ <para>Runs <function>sgml-fill-element</function>. Will recursively fill
(i.e., reformat) content from the current element in. The filling
<emphasis>will</emphasis> affect content in which whitespace is
significant, such as within <sgmltag>programlisting</sgmltag>
@@ -110,9 +110,9 @@
<term><command>C-c C-a</command></term>
<listitem>
- <para>Runs <literal>sgml-edit-attributes</literal>. Opens a second
+ <para>Runs <function>sgml-edit-attributes</function>. Opens a second
buffer containing a list of all the attributes for the closest
- enclosing element, and their current values. Use TAB to navigate
+ enclosing element, and their current values. Use <keycap>Tab</keycap> to navigate
between attributes, <command>C-k</command> to remove an existing
value and replace it with a new one, <command>C-c C-c</command>
to close this buffer and return to the main document.</para>
@@ -123,7 +123,7 @@
<term><command>C-c C-v</command></term>
<listitem>
- <para>Runs <literal>sgml-validate</literal>. Prompts you to save the
+ <para>Runs <function>sgml-validate</function>. Prompts you to save the
current document (if necessary) and then runs an SGML validator. The
output from the validator is captured into a new buffer, and you can
then navigate from one troublespot to the next, fixing markup errors
@@ -135,7 +135,7 @@
<term><command>C-c /</command></term>
<listitem>
- <para>Runs <literal>sgml-insert-end-tag</literal>. Inserts the
+ <para>Runs <function>sgml-insert-end-tag</function>. Inserts the
end tag for the current open element.</para>
</listitem>
</varlistentry>
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/see-also/chapter.sgml#2 (text+ko) ====
@@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
- $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/see-also/chapter.sgml,v 1.13 2004/08/05 10:04:29 den Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/see-also/chapter.sgml,v 1.15 2009/01/22 12:08:03 pgj Exp $
-->
<chapter id="see-also">
@@ -64,7 +64,7 @@
<listitem>
<para><ulink
- url="http://etext.virginia.edu/bin/tei-tocs?div=DIV1&id=SG">Gentle introduction to SGML</ulink></para>
+ url="http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html">Gentle introduction to SGML</ulink></para>
</listitem>
</itemizedlist>
</sect1>
@@ -97,14 +97,14 @@
<listitem>
<para><ulink url="http://www.docbook.org/">DocBook: The Definitive
Guide</ulink>, the online documentation for the DocBook
- DTD.</para>
+ DTD</para>
</listitem>
<listitem>
<para><ulink url="http://docbook.sourceforge.net/">The DocBook Open
Repository</ulink> contains DSSSL stylesheets and other resources
- for people using DocBook.</para>
+ for people using DocBook</para>
</listitem>
</itemizedlist>
</sect1>
@@ -114,7 +114,7 @@
<itemizedlist>
<listitem>
- <para><ulink url="http://www.linuxdoc.org/">The Linux Documentation
+ <para><ulink url="http://www.tldp.org/">The Linux Documentation
Project web pages</ulink></para>
</listitem>
</itemizedlist>
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml#3 (text+ko) ====
@@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
- $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml,v 1.18 2008/12/07 02:05:09 pgj Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/structure/chapter.sgml,v 1.19 2009/01/21 23:44:40 pgj Exp $
-->
<chapter id="structure">
@@ -238,13 +238,13 @@
<para>In earlier versions of the Handbook the files were stored in
the same directory as <filename>book.sgml</filename>, and named
after the value of the <literal>id</literal> attribute on the
- file's <sgmltag>chapter</sgmltag> element. Moving them into
- separate directories prepares for future plans for the Handbook.
- Specifically, it will soon be possible to include images in each
- chapter. It makes more sense for each image to be stored in a
- directory with the text for the chapter than to try to keep the
- text for all the chapters, and all the images, in one large
- directory. Namespace collisions would be inevitable, and it is
+ file's <sgmltag>chapter</sgmltag> element.
+ Now, it is possible to include images in each
+ chapter. Images for each Handbook chapter are stored within
+ <filename class="directory">share/images/books/handbook</filename>.
+ Note that localized version of these images should be placed in the same
+ directory as the SGML sources for each chapter.
+ Namespace collisions would be inevitable, and it is
easier to work with several directories with a few files in them
than it is to work with one directory that has many files in
it.</para>
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml#4 (text+ko) ====
@@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
- $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml,v 1.26 2008/08/06 22:03:49 pgj Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml,v 1.27 2009/01/21 23:46:32 pgj Exp $
-->
<chapter id="the-website">
@@ -86,7 +86,7 @@
</itemizedlist>
<sect2 id="the-website-csup">
- <title>Simple method: Using <command>csup</command></title>
+ <title>Simple Method: Using <command>csup</command></title>
<para>The <command>csup</command> command is part of the base system and
already used extensively by most people for updating the
@@ -145,8 +145,8 @@
</sect2>
<sect2 id="the-website-cvsup">
- <title>Advanced method: Maintaining a local
- <application>CVS</application> doc/www repository</title>
+ <title>Advanced Method: Maintaining a Local
+ <application>CVS</application> doc/www Repository</title>
<para>This method will give you more advanced options, but will require
you to install the
@@ -245,7 +245,7 @@
</sect1>
<sect1 id="the-website-build">
- <title>Build the web pages from scratch</title>
+ <title>Build the Web Pages from Scratch</title>
<para>Having completed either of the two methods, you will be ready to
start the website build. In our example, the build directory is
@@ -273,7 +273,7 @@
</sect1>
<sect1 id="the-website-install">
- <title>Install the web pages into your web server</title>
+ <title>Install the Web Pages into Your Web Server</title>
<procedure>
<step>
@@ -305,7 +305,7 @@
</sect1>
<sect1 id="the-website-env">
- <title>Environment variables</title>
+ <title>Environment Variables</title>
<variablelist>
<varlistentry>
@@ -349,8 +349,8 @@
<term><makevar>WEB_ONLY</makevar></term>
<listitem>
- <para>If set and not empty, the makefiles will build and install
- only the HTML pages from the www directory. All documents from
+ <para>If set and not empty, the Makefiles will build and install
+ only the HTML pages from the <filename class="directory">www</filename> directory. All documents from
the <filename class="directory">doc</filename> directory (Handbook,
FAQ, Tutorials) will be ignored. E.g.:</para>
@@ -359,18 +359,31 @@
</varlistentry>
<varlistentry>
+ <term><makevar>WEB_LANG</makevar></term>
+
+ <listitem>
+ <para>If set, the Makefiles will build and install only for
+ the languages specified by this variable inside the
+ <filename class="directory">www</filename> directory. All
+ other languages except English will be ignored. E.g.:</para>
+
+ <screen>&prompt.root; <userinput>make WEB_LANG="el es hu nl" all install</userinput></screen>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><makevar>NOPORTSCVS</makevar></term>
<listitem>
- <para>If set, the makefiles will not checkout files from the ports
- cvs repository. Instead, it will copy the files from
+ <para>If set, the Makefiles will not checkout files from the ports
+ CVS repository. Instead, it will copy the files from
<filename class="directory">/usr/ports</filename> (or where the
variable <envar>PORTSBASE</envar> points to).</para>
</listitem>
</varlistentry>
</variablelist>
- <para><makevar>WEB_ONLY</makevar>, <makevar>ENGLISH_ONLY</makevar> and
+ <para><makevar>WEB_ONLY</makevar>, <makevar>WEB_LANG</makevar>, <makevar>ENGLISH_ONLY</makevar> and
<makevar>NOPORTSCVS</makevar> are make variables. You can set the
variables in <filename>/etc/make.conf</filename>,
<filename>Makefile.inc</filename>, as environment variables on the
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml#2 (text+ko) ====
@@ -27,11 +27,11 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
- $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml,v 1.48 2005/09/12 16:47:36 yar Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml,v 1.49 2009/01/21 23:49:33 pgj Exp $
-->
<chapter id="writing-style">
- <title>Writing style</title>
+ <title>Writing Style</title>
<para>In order to promote consistency between the myriad authors of the
FreeBSD documentation, some guidelines have been drawn up for authors to
@@ -39,7 +39,7 @@
<variablelist>
<varlistentry>
- <term>Use American English spelling</term>
+ <term>Use American English Spelling</term>
<listitem>
<para>There are several variants of English, with different spellings
@@ -166,16 +166,16 @@
Style</ulink>, by William Strunk.</para>
<sect1 id="writing-style-guide">
- <title>Style guide</title>
+ <title>Style Guide</title>
- <para>To keep the source for the Handbook consistent when many different
+ <para>To keep the source for the documentation consistent when many different
people are editing it, please follow these style conventions.</para>
<sect2>
- <title>Letter case</title>
+ <title>Letter Case</title>
- <para>Tags are entered in lower case, <literal><para></literal>,
- <emphasis>not</emphasis> <literal><PARA></literal>.</para>
+ <para>Tags are entered in lower case, <sgmltag>para</sgmltag>,
+ <emphasis>not</emphasis> <sgmltag>PARA</sgmltag>.</para>
<para>Text that appears in SGML contexts is generally written in upper
case, <literal><!ENTITY…></literal>, and
@@ -188,16 +188,16 @@
<title>Acronyms</title>
<para>Acronyms should generally be spelled out the first time
- they appear in a book, as in: "Network Time Protocol (<acronym
- role="Network Time Protocol">NTP</acronym>)." After the
+ they appear in a document, as in: <quote>Network Time Protocol (<acronym
+ role="Network Time Protocol">NTP</acronym>)</quote>. After the
acronym has been defined, you should generally use the acronym
only (not the whole term, unless it makes more sense
contextually to use the whole term). Usually, acronyms are
- defined only one per book. But if you prefer, you can also
+ defined only one per document. But if you prefer, you can also
define them the first time they appear in each chapter.</para>
<para>The first three uses of an acronym should be enclosed in
- <acronym> tags, with a <literal>role</literal> attribute
+ <sgmltag>acronym</sgmltag> tags, with a <literal>role</literal> attribute
with the full term defined. This allows a link to the
glossary to be created, and for mouseovers to be rendered with
the fully expanded term.</para>
@@ -263,10 +263,10 @@
</sect2>
<sect2>
- <title>Tag style</title>
+ <title>Tag Style</title>
<sect3>
- <title>Tag spacing</title>
+ <title>Tag Spacing</title>
<para>Tags that start at the same indent as a previous tag
should be separated by a blank line, and those that are not
@@ -302,7 +302,7 @@
</sect3>
<sect3>
- <title>Separating tags</title>
+ <title>Separating Tags</title>
<para>Tags like <sgmltag>itemizedlist</sgmltag> which will
always have further tags inside them, and in fact do not take
@@ -332,13 +332,13 @@
</sect2>
<sect2>
- <title>White space changes</title>
+ <title>White Space Changes</title>
<para>When committing changes, <emphasis>do not commit changes to the
content at the same time as changes to the
formatting</emphasis>.</para>
- <para>This is so that the teams that convert the Handbook to other
+ <para>This is so that the teams that convert the documentation to other
languages can quickly see what content has actually changed in your
commit, without having to decide whether a line has changed because of
the content, or just because it has been refilled.</para>
@@ -352,7 +352,7 @@
</sect2>
<sect2>
- <title>Nonbreaking space</title>
+ <title>Non-Breaking Space</title>
<para>Avoid line breaks in places where they look ugly
or make it difficult to follow a sentence. Line breaks depend
@@ -364,7 +364,7 @@
GB. Hardware compression …</literallayout>
<para>The general entity <literal>&nbsp;</literal> prohibits
- line breaks between parts belonging together. Use nonbreaking
+ line breaks between parts belonging together. Use non-breaking
spaces in the following places:</para>
<itemizedlist>
@@ -389,7 +389,7 @@
</sect1>
<sect1 id="writing-style-word-list">
- <title>Word list</title>
+ <title>Word List</title>
<para>The following is a small list of words spelled the way they
should be used in the FreeBSD Documentation Project. If the
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml#10 (text+ko) ====
@@ -1,7 +1,7 @@
<!--
The FreeBSD Documentation Project
- $FreeBSD: doc/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml,v 1.236 2009/01/07 09:18:54 pgj Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml,v 1.237 2009/01/22 14:09:01 pgj Exp $
-->
<chapter id="updating-upgrading">
@@ -899,6 +899,16 @@
server to use when updating.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><makevar>DOCDIR</makevar></term>
+
+ <listitem>
+ <para>Where to install the documentation. It defaults to
+ <filename
+ class="directory">/usr/share/doc</filename>.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>For more make variables supported as system-wide options in
==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/eresources/chapter.sgml#12 (text+ko) ====
@@ -1,7 +1,7 @@
<!--
The FreeBSD Documentation Project
- $FreeBSD: doc/en_US.ISO8859-1/books/handbook/eresources/chapter.sgml,v 1.196 2008/12/15 00:10:15 murray Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/books/handbook/eresources/chapter.sgml,v 1.197 2009/01/22 23:02:42 pgj Exp $
-->
<appendix id="eresources">
@@ -376,6 +376,11 @@
</row>
<row>
+ <entry>&a.mono.name;</entry>
+ <entry>Mono and C# applications on FreeBSD</entry>
+ </row>
+
+ <row>
<entry>&a.mozilla.name;</entry>
<entry>Porting <application>Mozilla</application> to FreeBSD</entry>
</row>
@@ -1343,6 +1348,23 @@
</varlistentry>
<varlistentry>
+ <term>&a.mono.name;</term>
+
+ <listitem>
+ <para><emphasis>Mono and C# applications on
+ FreeBSD</emphasis></para>
+
+ <para>This is a list for discussions related to the Mono
+ development framework on &os;. This is a technical
+ mailing list. It is for individuals actively working on
+ porting Mono or C# applications to &os;, to bring up
+ problems or discuss alternative solutions. Individuals
+ interested in following the technical discussion are also
+ welcome.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>&a.openoffice.name;</term>
<listitem>
==== //depot/projects/docproj_nl/en_US.ISO8859-1/share/sgml/mailing-lists.ent#10 (text+ko) ====
@@ -1,7 +1,7 @@
<!--
Names of FreeBSD mailing lists and related software.
- $FreeBSD: doc/en_US.ISO8859-1/share/sgml/mailing-lists.ent,v 1.66 2008/10/20 06:23:00 pgj Exp $
+ $FreeBSD: doc/en_US.ISO8859-1/share/sgml/mailing-lists.ent,v 1.67 2009/01/22 23:02:42 pgj Exp $
-->
<!ENTITY a.mailman.listinfo "http://lists.FreeBSD.org/mailman/listinfo">
@@ -263,6 +263,10 @@
<!ENTITY a.mobile "<ulink url='&a.mobile.url;'>FreeBSD laptop computer mailing list</ulink>">
<!ENTITY a.mobile.name "<ulink url='&a.mobile.url;'>freebsd-mobile</ulink>">
+<!ENTITY a.mono.url "&a.mailman.listinfo;/freebsd-mono">
+<!ENTITY a.mono "<ulink url='&a.mono.url;'>Mono and C# applications on FreeBSD</ulink>">
+<!ENTITY a.mono.name "<ulink url='&a.mono.url;'>freebsd-mono</ulink>">
+
<!ENTITY a.mozilla.url "&a.mailman.listinfo;/freebsd-mozilla">
<!ENTITY a.mozilla "<ulink url='&a.mozilla.url;'>FreeBSD port of the Mozilla browser mailing list</ulink>">
<!ENTITY a.mozilla.name "<ulink url='&a.mozilla.url;'>freebsd-mozilla</ulink>">
==== //depot/projects/docproj_nl/nl_NL.ISO8859-1/books/handbook/ports/chapter.sgml#15 (text+ko) ====
@@ -1,7 +1,7 @@
<!--
The Dutch FreeBSD Documentation Project
- $FreeBSD: doc/nl_NL.ISO8859-1/books/handbook/ports/chapter.sgml,v 1.18 2009/01/07 19:27:33 rene Exp $
+ $FreeBSD: doc/nl_NL.ISO8859-1/books/handbook/ports/chapter.sgml,v 1.19 2009/01/21 19:34:28 rene Exp $
$FreeBSDnl: doc/nl_NL.ISO8859-1/books/handbook/ports/chapter.sgml,v 1.29 2006/08/12 22:53:16 remko Exp $
%SOURCE% en_US.ISO8859-1/books/handbook/ports/chapter.sgml
==== //depot/projects/docproj_nl/share/pgpkeys/beech.key#3 (text+ko) ====
@@ -1,35 +1,41 @@
-<!-- $FreeBSD: doc/share/pgpkeys/beech.key,v 1.3 2008/07/15 01:45:23 beech Exp $ -->
+<!-- $FreeBSD: doc/share/pgpkeys/beech.key,v 1.4 2009/01/23 01:30:08 beech Exp $ -->
<!--
-sh addkey.sh beech 197F3D17;
+sh ./addkey.sh beech 790DB7C7;
-->
<programlisting role="pgpfingerprint"><![CDATA[
-pub 1024D/197F3D17 2007-06-08
- Key fingerprint = F401 391E DD7F 44E9 5F0F C6DC A0C4 E309 197F 3D17
+pub 1024D/790DB7C7 2009-01-23
+ Key fingerprint = 3AFC 32D4 093B 63F1 28A8 1A18 B378 28D2 790D B7C7
uid Beech Rintoul <beech at FreeBSD.org>
-sub 1024g/5D7681A3 2007-06-08
+sub 2048g/9F3B61BF 2009-01-23
]]></programlisting>
<programlisting role="pgpkey"><![CDATA[
-----BEGIN PGP PUBLIC KEY BLOCK-----
-mQGiBEZp6D4RBACIFoSQowHD/NOTeHQl1ZtduOesTn1Itm5JX9QMWqi/ktQ2QkMo
-YB9VJh5jLuKHZq0qtzEDMY8FRlT+y8pT0ZOg4Ey6oXpUO7tGg0FT4h6vQ9flnklS
-M5LBPWGBcE71sOOHoYXc9h3X7sdsgGBw6Nqjef/MP82ER/GixeKdmIBNfwCg/V/t
-WdUhNa4q760BXOLHcWsJH/cD+wYSu9arSUJRJ/9rtVqK0h/a2NhcmWTVAIpkDjHY
-dHlqkKn8rS4BkmOBPm2DpztI86ZRypcMfrL+nMyaLXWY/j3bqbf2U0m4nVFbnyu7
-6b10R+7s0bAv10I+9VtxmosueD7JF//VDr6v9vU0+p2cgYWQ9qKHpIcDQgHRWbJ8
-dtG2A/9cH9qM/gTxcKRgMynI/druUQXZGd/f7K6viAYF/Y/4PLx/4GWLLKjqPKD3
-DXRK1chfpHCGtzKps/i/VNT9DsxrmGEM1cw/w35yWFTTRoqzJ142ftem/3hmoq/U
-XyVzbNMFboYWyQZns4WwQdwvxqIMHdjCag4T5Jcu+VHt9fBd0bQhQmVlY2ggUmlu
-dG91bCA8YmVlY2hARnJlZUJTRC5vcmc+iGAEExECACAFAkZp6D4CGyMGCwkIBwMC
-BBUCCAMEFgIDAQIeAQIXgAAKCRCgxOMJGX89F+slAKDA6lM2EkiZkPKZud0oNSbA
-g6o1vACgnQYZBtdsndH0daWXlBuiAkgSQgu5AQ0ERmnoRhAEAJQluEdOS24DwiGi
-M6NcHhInHhzoGREHle1sgXjuMcyck6kGfnAFzgIa0sJiHfu3ZNNyI+xseorofD2O
-MYlOClGsbk0wnhVha/w7kX1nsA/UQoJzDpbGlX3XepAkLNXPMpOETpukKbebSvs2
-GN02/il1Rt41LpfPyJBVuvL0yqh7AAMFA/4p7LLWyAfcPYXv+HtylZvZsVdxuHUr
-e+FvX7oULTrTRSaiL8ohk61aupVBbpU2ZHe+pourtgG2oVFBL6H9a8B82PxiJW5p
-ls/jou3NHp0kJGUzuM3/ITcJLGyzC7LVwTiwA5X1BFgTtXHCGdGvzzuh6WFrniGJ
-xHNbQq2ICDCGG4hJBBgRAgAJBQJGaehGAhsMAAoJEKDE4wkZfz0XEa8An0fHuygs
-y/ZVFk0lC1rUnlgrvn6TAJ44BfThvTiVyOr6Vf3sXB+C/rak2w==
-=8BZn
+mQGiBEl5FK8RBACFkDT67YK9/ruzIsOMdo903UH3E7wlWRyI0A1KFk6BuBNhDVNb
+QswVV7ZAn7sWCLST3ZNA0c36DAVanrU6Ur1qaX0+4J3+P0RkTsTp/x5iusOWWA8y
+ZPmnZG5QrWeokYCl0WFUI/0n24a/ALQ7mYhASHgY/JqOsqKuHyhc7TYFKwCgh9W8
+lFUjrOmbBxSy8A+gtxA1QtsD/15grmcjTeS6poBpcLgvF5MyVBS9DpgrL1IU/B1v
+X1punyUBO02h1qh+lS3gLoMsY/IxiC23cgItVkOS6xMgrasWlVr6poPovVdzyV0V
+nXkEiZsYV/DafX1WfdBO9Lierb9H057ToWRElVg1HNglvqsOxYNbuMcPQqMvatXt
+M9BzA/94Y4jfIJ1kdX1sORutRNML0YxJvJ5dUV1ZrrGTTEUyPOvvJKo59VYXc8b/
+6u/0GQbDkO/o8n0ZmYaxU++IurtmmdlTTE7Y58saXOUC7TYrbJVQqbWbm0ovRBuU
+57/m0MsNCc3OVOkEhj7YciE0UkIy+wgHdIhSMVvC5s2bIzoMErQhQmVlY2ggUmlu
+dG91bCA8YmVlY2hARnJlZUJTRC5vcmc+iGAEExECACAFAkl5FK8CGwMGCwkIBwMC
+BBUCCAMEFgIDAQIeAQIXgAAKCRCzeCjSeQ23x5i8AJ9Git9M9ajDfaMXQ1hxzfyn
+2GMzpgCeMgVJsGfb9vRWnKxjyugMKyL/PQ25Ag0ESXkUrxAIALUY+/ysAMjyHKFB
+s2Ye0zgPI40yWi0bSXVGhvY8phRo2b9cHtuBRy0wFnYjF7I1Ep4CIjUnNCT0C7S/
+bZQ07HnrCK+tgLDCIZawikDm7MqvJe/vacMKT3k+jYaN5/iK8IN9qwwWQSsylX5F
+O2HoifAA1lBg7iKnCLgwMHTkL6wx2YjLRingTh6dOaHPOnEXPmA57asMVQ1QIF4H
+trHkM1m06yIxtLt5ho8G7DQ/EfOvXEEIYFtP91gTM0yJwA8i5jjxNVMDuemFSxA1
+FtTuRidGIvA+zXSgNbpFhtBYZFYqD3rN5HALh0E3RcGhwTiHld+hYHku72BKdfVR
+vr6+hFcAAwUIAKlWnCWT2byzkMncxI8VyIZuu5SkOreTMRx88EKA5PbDaJkiN2+k
+m/6iKCHSneUNMd9LPuzUhMPgP4fBi84ib8Ume6ZhSd9d+lp28B84fPg2pIZG/gA3
+vRvMN3sxCVa+Qb3NpiKpVt0vfDLG+lRcEJWHMed109ym8kLF099Hc9Odi+9EUflt
+qYEP9/wLJcc+vvd/MytB7n25ykQeQmOoKLs1NZHnDuowzobn7tMxxpW89pZWT1zd
+atMXk6E7ja7G2+T/ugcto8fhqTAztg3+JKaZ3aHyziD5tMREMvzwnSRe4Pb7urja
+7lkeQ7PFCnz6BlU2uNFKvNrGGOgxNDAAnG6ISQQYEQIACQUCSXkUrwIbDAAKCRCz
+eCjSeQ23x4H5AJ9zODtX+BYdDUhH5yl0IxFPFnTdtgCcDXbA5aDUILIgIps1qEN+
+fQOwId4=
+=FPRG
-----END PGP PUBLIC KEY BLOCK-----
]]></programlisting>
More information about the p4-projects
mailing list