Univention Bugzilla – Attachment 7850 Details for
Bug 41909
Developer reference: Chapter 11 needs changes to reflect modified tooling.
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Requests
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Patch for documentation in ucs-4.1-2 branch
bug_41224_doc_changes.patch (text/plain), 7.52 KB, created by
Eduard Mai
on 2016-08-03 16:43:40 CEST
(
hide
)
Description:
Patch for documentation in ucs-4.1-2 branch
Filename:
MIME Type:
Creator:
Eduard Mai
Created:
2016-08-03 16:43:40 CEST
Size:
7.52 KB
patch
obsolete
>Index: ucs-4.1-2/doc/developer-reference/translation.xml >=================================================================== >--- ucs-4.1-2/doc/developer-reference/translation.xml (Revision 71384) >+++ ucs-4.1-2/doc/developer-reference/translation.xml (Arbeitskopie) >@@ -19,29 +19,28 @@ > <remark></remark> > > <para> >- By default UCS includes English and German localization. >- A package is provided to enable users to create additional translations for the &ucsUMC;. >+ By default UCS includes English and German localizations. >+ Univention provides a set of tools that faciliates the process of creating translations for &ucsUMC;. > </para> > <para> > This section describes all steps necessary to create a working translation package for UCS. >- To create a new translation package it is advised to have a running UCS server where the package can be setup. >- A current Subversion checkout of the UCS source code is required. >- After installing the translation template package, a new translation for a target language can be created. >+ We recommend having a running UCS installation where the tools can be set up in an easy manner. >+ Further more a current Subversion checkout of the UCS source code is required. > </para> > > <section id="misc:translation:preparation"> >- <title>Prepare a new translation</title> >+ <title>Install needed tools</title> > <para> >- The following steps are required to setup a UCS server to create a new translation package. >+ The following steps are required to set up the tools for translation package creation. > </para> > <variablelist> > <varlistentry> >- <term>Package <package>univention-ucs-translation-template</package></term> >+ <term>Step 1: Install <package>univention-ucs-translation-template</package> package</term> > <listitem> > <para> > The package <package>univention-ucs-translation-template</package> contains all tools required to setup and update a translation package. > It requires some additional Debian tools to build the package. >- The following packages must be installed on an UCS server by running the following command: >+ Run the following command on your UCS to install all needed packages. > <programlisting language="sh"> > univention-install univention-ucs-translation-template dpkg-dev subversion > </programlisting> >@@ -49,11 +48,10 @@ > </listitem> > </varlistentry> > <varlistentry> >- <term>A current checkout of the UCS Subversion repository</term> >+ <term>Step 2: Obtain a current checkout of the UCS Subversion repository</term> > <listitem> > <para> >- The base translation files are available in the UCS Subversion repository. >- A current checkout can be obtained by running the following commands: >+ The Subversion repository is later processed to get initial files for a new translation(often referred to as PO file or Portable Objects). > </para> > <programlisting language="sh"> > mkdir ~/translation >@@ -61,10 +59,6 @@ > svn co http://forge.univention.org/svn/dev/branches/ucs-4.1/ucs-4.1-0 > </programlisting> > <!-- TODO: Use &websvn; after it has been updated --> >- <para> >- Changes made to the &ucsUMC; should be synchronized regularly to the local Subversion checkout. >- This can be done by executing <command>svn up ~/translation/ucs-4.1-0</command>. >- </para> > </listitem> > </varlistentry> > </variablelist> >@@ -73,13 +67,13 @@ > <section id="misc:translation:createpackage"> > <title>Create a new translation package</title> > <para> >- To create a new translation package for e.g. French in the users home directory, the following command must be executed: >+ To create a new translation package for e.g. French in the current working directory, the following command must be executed: > <programlisting language="sh"> > cd ~/translation >-univention-ucs-translation-build-package.py \ >+univention-ucs-translation-build-package \ > -s ~/translation/ucs-4.1-0 -c fr -l fr_FR.UTF-8:UTF-8 -n French > </programlisting> >- This creates a new directory <filename class="directory">univention-ucs-translation-fr/</filename>, which contains a Debian source package of the same name. >+ This creates a new directory <filename class="directory">~/translation/univention-ucs-translation-fr/</filename>, which contains a Debian source package of the same name. > It includes all source and target files for the translation. > </para> > </section> >@@ -110,7 +104,6 @@ > The first line provides a hint, were the text is used. > The second line is optional and contains flags, which indicate the type and state of the translation. > The string <literal>fuzzy</literal> indicates an entry, which was copied by <command>gettext</command> from a previous version and needs to be updated. >- The flag has to be removed afterwards. > </para> > <para> > The line starting with <literal>msgid</literal> contains the original text. >@@ -157,44 +150,13 @@ > <section id="misc:translation:updatepackage"> > <title>Update the translation package</title> > <para> >- The following steps are needed to upgrade the translation to a new UCS release, or if changes have been made in the translation. >- <variablelist> >- <varlistentry> >- <term>Update translation source files</term> >- <listitem> >- <para> >- If changes occur in the UCS source packages that need a change of the translation files, the source files should be updated. >- To update the source files, change the directory of the translation package and update the files by executing the following commands: >- </para> >- <programlisting language="sh"> >-cd ~/translation/univention-ucs-translation-fr >-univention-ucs-translation-update-source-files \ >- -s ~/translation/ucs-4.1-0 -c fr >- </programlisting> >- </listitem> >- </varlistentry> >- <varlistentry> >- <term>Update translation target files</term> >- <listitem> >- <important> >- <para> >- This step is necessary each time before compiling the translation package. >- If the translation target files are not updated, the translation will not be shown in the &ucsUMC; >- </para> >- </important> >- <para> >- After the translation the source files have to be compiled. >- This step can also be done in an early stage of the translation, when it is not yet complete. >- To update the target files, change to the directory of the translation package and compile the source files by executing the following commands: >- </para> >- <programlisting language="sh"> >-cd ~/translation/univention-ucs-translation-fr >-univention-ucs-translation-update-target-files \ >- -s ~/translation/ucs-4.1-0 -c fr >- </programlisting> >- </listitem> >- </varlistentry> >- </variablelist> >+ If changes affecting translations are made in the Subversion repository, existing translation packages need to be updated to reflect those changes. >+ Given a path to an updated Subversion checkout, univention-ucs-translation-merge can update a previously created translation source package. >+ Following example will update a translation package <filename class="directory">univention-ucs-translation-fr/</filename> using an updated Subversion checkout in <filename class="directory">ucs-4.1-0</filename>: >+ <programlisting language="sh"> >+univention-ucs-translation-merge ~/translation/ucs-4.1-0 \ >+ ~/translation/univention-ucs-translation-fr >+ </programlisting> > </para> > </section> >
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
Attachments on
bug 41909
: 7850