Add a section documenting how to submit new translations.
This commit is contained in:
parent
f78699024c
commit
13b90ac2e3
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=47549
1 changed files with 62 additions and 0 deletions
|
|
@ -758,4 +758,66 @@ DOC_PREFIX?= ${.CURDIR}/../../..
|
|||
</procedure>
|
||||
</example>
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="po-translations-submitting">
|
||||
<title>Submitting the New Translation</title>
|
||||
|
||||
<para>Prepare the new translation files for submission. This
|
||||
example shows a new Spanish translation of the NanoBSD
|
||||
article in
|
||||
<filename>~/doc/es_ES.ISO8859-1/articles/nanobsd</filename>.</para>
|
||||
|
||||
<procedure>
|
||||
<step>
|
||||
<para>The <acronym>PO</acronym> file must contain a &os;
|
||||
version string comment on the first line:</para>
|
||||
|
||||
<programlisting>#$FreeBSD$</programlisting>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>The <filename>Makefile</filename>, the
|
||||
<acronym>PO</acronym> file, and the generated
|
||||
<acronym>XML</acronym> translation must all be added to
|
||||
version control:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>cd ~/doc/es_ES.ISO8859-1/articles/nanobsd/</userinput>
|
||||
&prompt.user; <userinput>ls</userinput>
|
||||
Makefile article.xml es_ES.po
|
||||
&prompt.user; <userinput>svn add Makefile article.xml es_ES.po</userinput>
|
||||
A Makefile
|
||||
A article.xml
|
||||
A es_ES.po</screen>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>These files must also have the
|
||||
<application>Subversion</application>
|
||||
<literal>svn:keywords</literal> property set to
|
||||
<literal>FreeBSD=%H</literal>:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>svn propset svn:keywords FreeBSD=%H Makefile article.xml es_ES.po</userinput>
|
||||
property 'svn:keywords' set on 'Makefile'
|
||||
property 'svn:keywords' set on 'article.xml'
|
||||
property 'svn:keywords' set on 'es_ES.po'</screen>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>A diff of these new files is created from the
|
||||
<filename>~/doc/</filename> base directory so the full path
|
||||
is shown with the filenames. This helps committers identify
|
||||
the target language directory.</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>cd ~/doc</userinput>
|
||||
<userinput>svn diff es_ES.ISO8859-1/articles/nanobsd/ > /tmp/es_nanobsd.diff</userinput></screen>
|
||||
|
||||
<para>The diff file is now ready for attachment to a
|
||||
<link
|
||||
xlink:href="https://bugs.freebsd.org/bugzilla/enter_bug.cgi?product=Documentation">documentation
|
||||
bug report</link> or <link
|
||||
xlink:href="https://reviews.freebsd.org/">code
|
||||
review</link>.</para>
|
||||
</step>
|
||||
</procedure>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue