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 2012-05-21 14:43:21 +00:00
parent 54e191e028
commit 0fcdcf3172
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=38871
1 changed files with 193 additions and 165 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

342
en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml
View file

@ -33,13 +33,14 @@
<chapter id="translations"> <chapter id="translations">
<title>Translations</title> <title>Translations</title>
<para>This is the FAQ for people translating the FreeBSD documentation <para>This is the FAQ for people translating the FreeBSD
(FAQ, Handbook, tutorials, manual pages, and others) to different documentation (FAQ, Handbook, tutorials, manual pages, and others)
languages.</para> to different languages.</para>
<para>It is <emphasis>very</emphasis> heavily based on the translation FAQ <para>It is <emphasis>very</emphasis> heavily based on the
from the FreeBSD German Documentation Project, originally written by Frank translation FAQ from the FreeBSD German Documentation Project,
Gr&uuml;nder <email>elwood@mc5sys.in-berlin.de</email> and translated back to originally written by Frank Gr&uuml;nder
<email>elwood@mc5sys.in-berlin.de</email> and translated back to
English by Bernd Warken <email>bwarken@mayn.de</email>.</para> English by Bernd Warken <email>bwarken@mayn.de</email>.</para>
<para>The FAQ is maintained by the &a.doceng;.</para> <para>The FAQ is maintained by the &a.doceng;.</para>
@ -51,10 +52,11 @@
</question> </question>
<answer> <answer>
<para>More and more people are approaching the freebsd-doc mailing <para>More and more people are approaching the freebsd-doc
list and volunteering to translate FreeBSD documentation to other mailing list and volunteering to translate FreeBSD
languages. This FAQ aims to answer their questions so they can start documentation to other languages. This FAQ aims to answer
translating documentation as quickly as possible.</para> their questions so they can start translating documentation
as quickly as possible.</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -66,14 +68,14 @@
<answer> <answer>
<para><phrase>i18n</phrase> means <para><phrase>i18n</phrase> means
<phrase>internationalization</phrase> and <phrase>l10n</phrase> <phrase>internationalization</phrase> and
means <phrase>localization</phrase>. They are just a convenient <phrase>l10n</phrase> means <phrase>localization</phrase>.
shorthand.</para> They are just a convenient shorthand.</para>
<para><phrase>i18n</phrase> can be read as <quote>i</quote> followed by <para><phrase>i18n</phrase> can be read as <quote>i</quote>
18 letters, followed by <quote>n</quote>. Similarly, followed by 18 letters, followed by <quote>n</quote>.
<phrase>l10n</phrase> is <quote>l</quote> followed by 10 letters, Similarly, <phrase>l10n</phrase> is <quote>l</quote>
followed by <quote>n</quote>.</para> followed by 10 letters, followed by <quote>n</quote>.</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -83,10 +85,12 @@
</question> </question>
<answer> <answer>
<para>Yes. Different translation groups have their own mailing <para>Yes. Different translation groups have their own
lists. The <ulink url="http://www.freebsd.org/docproj/translations.html">list mailing lists. The <ulink
of translation projects</ulink> has more information about the url="http://www.freebsd.org/docproj/translations.html">list
mailing lists and web sites run by each translation project.</para> of translation projects</ulink> has more information about
the mailing lists and web sites run by each translation
project.</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -96,12 +100,13 @@
</question> </question>
<answer> <answer>
<para>Yes. The more people work on translation the faster it gets <para>Yes. The more people work on translation the faster it
done, and the faster changes to the English documentation are gets done, and the faster changes to the English
mirrored in the translated documents.</para> documentation are mirrored in the translated
documents.</para>
<para>You do not have to be a professional translator to be able to <para>You do not have to be a professional translator to be
help.</para> able to help.</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -111,12 +116,12 @@
</question> </question>
<answer> <answer>
<para>Ideally, you will have a good knowledge of written English, and <para>Ideally, you will have a good knowledge of written
obviously you will need to be fluent in the language you are English, and obviously you will need to be fluent in the
translating to.</para> language you are translating to.</para>
<para>English is not strictly necessary. For example, you could do a <para>English is not strictly necessary. For example, you
Hungarian translation of the FAQ from the Spanish could do a Hungarian translation of the FAQ from the Spanish
translation.</para> translation.</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -127,123 +132,135 @@
</question> </question>
<answer> <answer>
<para>It is strongly recommended that you maintain a local copy of the <para>It is strongly recommended that you maintain a local
FreeBSD CVS repository (at least the documentation part) either copy of the FreeBSD CVS repository (at least the
using <application>CTM</application> or documentation part) either using
<application>CVSup</application>. The "Staying current with FreeBSD" <application>CTM</application> or
chapter in the Handbook explains how to use these <application>CVSup</application>. The "Staying current with
FreeBSD" chapter in the Handbook explains how to use these
applications.</para> applications.</para>
<para>You should be comfortable using <application>CVS</application>. <para>You should be comfortable using
This will allow you to see what has changed between different <application>CVS</application>. This will allow you to see
versions of the files that make up the documentation.</para> what has changed between different versions of the files
that make up the documentation.</para>
<para>[XXX To Do -- write a tutorial that shows how to use CVSup to <para>[XXX To Do -- write a tutorial that shows how to use
get just the documentation, check it out, and see what has changed CVSup to get just the documentation, check it out, and see
between two arbitrary revisions]</para> what has changed between two arbitrary revisions]</para>
</answer> </answer>
</qandaentry> </qandaentry>
<qandaentry> <qandaentry>
<question> <question>
<para>How do I find out who else might be translating to the same <para>How do I find out who else might be translating to the
language?</para> same language?</para>
</question> </question>
<answer> <answer>
<para>The <ulink <para>The <ulink
url="http://www.FreeBSD.org/docproj/translations.html">Documentation url="http://www.FreeBSD.org/docproj/translations.html">Documentation
Project translations page</ulink> lists the translation efforts Project translations page</ulink> lists the translation
that are currently known about. If others are already working efforts that are currently known about. If others are
on translating documentation to your language, please do not already working on translating documentation to your
duplicate their efforts. Instead, contact them to see how you can language, please do not duplicate their efforts. Instead,
help.</para> contact them to see how you can help.</para>
<para>If no one is listed on that page as translating for your <para>If no one is listed on that page as translating for your
language, then send a message to the &a.doc; in case someone else language, then send a message to the &a.doc; in case someone
is thinking of doing a translation, but has not announced it yet. else is thinking of doing a translation, but has not
</para> announced it yet.</para>
</answer> </answer>
</qandaentry> </qandaentry>
<qandaentry> <qandaentry>
<question> <question>
<para>No one else is translating to my language. What do I do?</para> <para>No one else is translating to my language. What do I
do?</para>
</question> </question>
<answer> <answer>
<para>Congratulations, you have just started the <quote>FreeBSD <para>Congratulations, you have just started the
<replaceable>your-language-here</replaceable> Documentation <quote>FreeBSD <replaceable>your-language-here</replaceable>
Translation Project</quote>. Welcome aboard.</para> Documentation Translation Project</quote>. Welcome
aboard.</para>
<para>First, decide whether or not you have got the time to spare. Since <para>First, decide whether or not you have got the time to
you are the only person working on your language at the moment it is spare. Since you are the only person working on your
going to be your responsibility to publicize your work and language at the moment it is going to be your responsibility
coordinate any volunteers that might want to help you.</para> to publicize your work and coordinate any volunteers that
might want to help you.</para>
<para>Write an email to the Documentation Project mailing list, <para>Write an email to the Documentation Project mailing
announcing that you are going to translate the documentation, so the list, announcing that you are going to translate the
Documentation Project translations page can be maintained.</para> documentation, so the Documentation Project translations
page can be maintained.</para>
<para>If there is already someone in your country providing FreeBSD <para>If there is already someone in your country providing
mirroring services you should contact them and ask if you can FreeBSD mirroring services you should contact them and ask
have some webspace for your project, and possibly an email if you can have some webspace for your project, and possibly
address or mailing list services.</para> an email address or mailing list services.</para>
<para>Then pick a document and start translating. It is best to start <para>Then pick a document and start translating. It is best
with something fairly small&mdash;either the FAQ, or one of the to start with something fairly small&mdash;either the FAQ,
tutorials.</para> or one of the tutorials.</para>
</answer> </answer>
</qandaentry> </qandaentry>
<qandaentry> <qandaentry>
<question> <question>
<para>I have translated some documentation, where do I send it?</para> <para>I have translated some documentation, where do I send
it?</para>
</question> </question>
<answer> <answer>
<para>That depends. If you are already working with a translation team <para>That depends. If you are already working with a
(such as the Japanese team, or the German team) then they will have translation team (such as the Japanese team, or the German
their own procedures for handling submitted documentation, and these team) then they will have their own procedures for handling
will be outlined on their web pages.</para> submitted documentation, and these will be outlined on their
web pages.</para>
<para>If you are the only person working on a particular language (or <para>If you are the only person working on a particular
you are responsible for a translation project and want to submit language (or you are responsible for a translation project
your changes back to the FreeBSD project) then you should send your and want to submit your changes back to the FreeBSD project)
translation to the FreeBSD project (see the next question).</para> then you should send your translation to the FreeBSD project
(see the next question).</para>
</answer> </answer>
</qandaentry> </qandaentry>
<qandaentry> <qandaentry>
<question> <question>
<para>I am the only person working on translating to this language, how <para>I am the only person working on translating to this
do I submit my translation?</para> language, how do I submit my translation?</para>
<para>or</para> <para>or</para>
<para>We are a translation team, and want to submit documentation that <para>We are a translation team, and want to submit
our members have translated for us?</para> documentation that our members have translated for
us?</para>
</question> </question>
<answer> <answer>
<para>First, make sure your translation is organized properly. This <para>First, make sure your translation is organized properly.
means that it should drop into the existing documentation tree and This means that it should drop into the existing
build straight away.</para> documentation tree and build straight away.</para>
<para>Currently, the FreeBSD documentation is stored in a top level <para>Currently, the FreeBSD documentation is stored in a top
directory called <filename>doc/</filename>. Directories below this level directory called <filename>doc/</filename>.
are named according to the language code they are written in, as Directories below this are named according to the language
defined in ISO639 (<filename>/usr/share/misc/iso639</filename> on a code they are written in, as defined in ISO639
version of FreeBSD newer than 20th January 1999).</para> (<filename>/usr/share/misc/iso639</filename> on a version of
FreeBSD newer than 20th January 1999).</para>
<para>If your language can be encoded in different ways (for example, <para>If your language can be encoded in different ways (for
Chinese) then there should be directories below this, one for each example, Chinese) then there should be directories below
encoding format you have provided.</para> this, one for each encoding format you have provided.</para>
<para>Finally, you should have directories for each document.</para> <para>Finally, you should have directories for each
document.</para>
<para>For example, a hypothetical Swedish translation might look <para>For example, a hypothetical Swedish translation might
like:</para> look like:</para>
<programlisting>doc/ <programlisting>doc/
sv_SE.ISO8859-1/ sv_SE.ISO8859-1/
@ -256,8 +273,8 @@
<para><literal>sv_SE.ISO8859-1</literal> is the name of the <para><literal>sv_SE.ISO8859-1</literal> is the name of the
translation, in translation, in
<filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename> <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename>
form. Note the form. Note the two Makefiles, which will be used to build
two Makefiles, which will be used to build the documentation.</para> the documentation.</para>
<para>Use &man.tar.1; and &man.gzip.1; to compress up your <para>Use &man.tar.1; and &man.gzip.1; to compress up your
documentation, and send it to the project.</para> documentation, and send it to the project.</para>
@ -266,41 +283,47 @@
&prompt.user; <userinput>tar cf swedish-docs.tar sv_SE.ISO8859-1</userinput> &prompt.user; <userinput>tar cf swedish-docs.tar sv_SE.ISO8859-1</userinput>
&prompt.user; <userinput>gzip -9 swedish-docs.tar</userinput></screen> &prompt.user; <userinput>gzip -9 swedish-docs.tar</userinput></screen>
<para>Put <filename>swedish-docs.tar.gz</filename> somewhere. If you <para>Put <filename>swedish-docs.tar.gz</filename> somewhere.
do not have access to your own webspace (perhaps your ISP does not If you do not have access to your own webspace (perhaps your
let you have any) then you can email &a.doceng;, and arrange to email ISP does not let you have any) then you can email
the files when it is convenient.</para> &a.doceng;, and arrange to email the files when it is
convenient.</para>
<para>Either way, you should use &man.send-pr.1; to submit a report <para>Either way, you should use &man.send-pr.1; to submit a
indicating that you have submitted the documentation. It would be report indicating that you have submitted the documentation.
very helpful if you could get other people to look over your It would be very helpful if you could get other people to
translation and double check it first, since it is unlikely that the look over your translation and double check it first, since
person committing it will be fluent in the language.</para> it is unlikely that the person committing it will be fluent
in the language.</para>
<para>Someone (probably the Documentation Project Manager, currently <para>Someone (probably the Documentation Project Manager,
&a.doceng;) will then take your translation and confirm that it builds. currently &a.doceng;) will then take your translation and
In particular, the following things will be looked at:</para> confirm that it builds. In particular, the following things
will be looked at:</para>
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>Do all your files use RCS strings (such as "ID")?</para> <para>Do all your files use RCS strings (such as
"ID")?</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Does <command>make all</command> in the <para>Does <command>make all</command> in the
<filename>sv_SE.ISO8859-1</filename> directory work correctly?</para> <filename>sv_SE.ISO8859-1</filename> directory work
correctly?</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Does <command>make install</command> work correctly?</para> <para>Does <command>make install</command> work
correctly?</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<para>If there are any problems then whoever is looking at the <para>If there are any problems then whoever is looking at the
submission will get back to you to work them out.</para> submission will get back to you to work them out.</para>
<para>If there are no problems your translation will be committed <para>If there are no problems your translation will be
as soon as possible.</para> committed as soon as possible.</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -313,21 +336,22 @@
<answer> <answer>
<para>We would prefer that you did not.</para> <para>We would prefer that you did not.</para>
<para>For example, suppose that you are translating the Handbook to <para>For example, suppose that you are translating the
Korean, and want to include a section about retailers in Korea in Handbook to Korean, and want to include a section about
your Handbook.</para> retailers in Korea in your Handbook.</para>
<para>There is no real reason why that information should not be in the <para>There is no real reason why that information should not
English (or German, or Spanish, or Japanese, or &hellip;) versions be in the English (or German, or Spanish, or Japanese, or
as well. It is feasible that an English speaker in Korea might try &hellip;) versions as well. It is feasible that an English
to pick up a copy of FreeBSD whilst over there. It also helps speaker in Korea might try to pick up a copy of FreeBSD
increase FreeBSD's perceived presence around the globe, which is not whilst over there. It also helps increase FreeBSD's
a bad thing.</para> perceived presence around the globe, which is not a bad
thing.</para>
<para>If you have country specific information, please submit it as a <para>If you have country specific information, please submit
change to the English Handbook (using &man.send-pr.1;) and then it as a change to the English Handbook (using
translate the change back to your language in the translated &man.send-pr.1;) and then translate the change back to your
Handbook.</para> language in the translated Handbook.</para>
<para>Thanks.</para> <para>Thanks.</para>
</answer> </answer>
@ -335,27 +359,29 @@
<qandaentry> <qandaentry>
<question> <question>
<para>How should language specific characters be included?</para> <para>How should language specific characters be
included?</para>
</question> </question>
<answer> <answer>
<para>Non-ASCII characters in the documentation should be included <para>Non-ASCII characters in the documentation should be
using SGML entities.</para> included using SGML entities.</para>
<para>Briefly, these look like an ampersand (&amp;), the name of the <para>Briefly, these look like an ampersand (&amp;), the name
entity, and a semi-colon (;).</para> of the entity, and a semi-colon (;).</para>
<para>The entity names are defined in ISO8879, which is in the ports <para>The entity names are defined in ISO8879, which is in the
tree as <filename role="package">textproc/iso8879</filename>.</para> ports tree as <filename
role="package">textproc/iso8879</filename>.</para>
<para>A few examples include:</para> <para>A few examples include:</para>
<segmentedlist> <segmentedlist>
<segtitle>Entity</segtitle> <segtitle>Entity</segtitle>
<segtitle>Appearance</segtitle> <segtitle>Appearance</segtitle>
<segtitle>Description</segtitle> <segtitle>Description</segtitle>
<seglistitem> <seglistitem>
<seg>&amp;eacute;</seg> <seg>&amp;eacute;</seg>
@ -377,8 +403,8 @@
</segmentedlist> </segmentedlist>
<para>After you have installed the iso8879 port, the files in <para>After you have installed the iso8879 port, the files in
<filename>/usr/local/share/sgml/iso8879</filename> contain the <filename>/usr/local/share/sgml/iso8879</filename> contain
complete list.</para> the complete list.</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -389,12 +415,13 @@
<answer> <answer>
<para>In the English documents, the reader is addressed as <para>In the English documents, the reader is addressed as
<quote>you</quote>, there is no formal/informal distinction as there <quote>you</quote>, there is no formal/informal distinction
is in some languages.</para> as there is in some languages.</para>
<para>If you are translating to a language which does distinguish, use <para>If you are translating to a language which does
whichever form is typically used in other technical documentation in distinguish, use whichever form is typically used in other
your language. If in doubt, use a mildly polite form.</para> technical documentation in your language. If in doubt, use
a mildly polite form.</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -407,8 +434,8 @@
<answer> <answer>
<para>Yes.</para> <para>Yes.</para>
<para>The header of the English version of each document will look <para>The header of the English version of each document will
something like this:</para> look something like this:</para>
<programlisting>&lt;!-- <programlisting>&lt;!--
The FreeBSD Documentation Project The FreeBSD Documentation Project
@ -416,12 +443,13 @@
&dollar;FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v 1.5 2000/07/07 18:38:38 dannyboy Exp &dollar; &dollar;FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v 1.5 2000/07/07 18:38:38 dannyboy Exp &dollar;
--&gt;</programlisting> --&gt;</programlisting>
<para>The exact boilerplate may change, but it will always include a <para>The exact boilerplate may change, but it will always
&dollar;FreeBSD&dollar; line and the phrase <literal>The FreeBSD Documentation include a &dollar;FreeBSD&dollar; line and the phrase
Project</literal>. <literal>The FreeBSD Documentation Project</literal>.
Note that the &dollar;FreeBSD part is expanded automatically by Note that the &dollar;FreeBSD part is expanded automatically
CVS, so it should be empty (just by CVS, so it should be empty (just
<literal>&dollar;FreeBSD&dollar;</literal>) for new files.</para> <literal>&dollar;FreeBSD&dollar;</literal>) for new
files.</para>
<para>Your translated documents should include their own <para>Your translated documents should include their own
&dollar;FreeBSD&dollar; line, and change the &dollar;FreeBSD&dollar; line, and change the
@ -429,8 +457,8 @@
<literal>The FreeBSD <replaceable>language</replaceable> <literal>The FreeBSD <replaceable>language</replaceable>
Documentation Project</literal>.</para> Documentation Project</literal>.</para>
<para>In addition, you should add a third line which indicates which <para>In addition, you should add a third line which indicates
revision of the English text this is based on.</para> which revision of the English text this is based on.</para>
<para>So, the Spanish version of this file might start:</para> <para>So, the Spanish version of this file might start:</para>