]> git.ipfire.org Git - thirdparty/bugzilla.git/commitdiff
Bug 1226865 - bug fixes to localization documentation.
authorGervase Markham <gerv@gerv.net>
Sat, 21 Nov 2015 14:34:50 +0000 (14:34 +0000)
committerGervase Markham <gerv@gerv.net>
Sat, 21 Nov 2015 14:34:50 +0000 (14:34 +0000)
docs/en/rst/localizing/caveats.rst
docs/en/rst/localizing/get-the-source.rst
docs/en/rst/localizing/localizing-documentation.rst
docs/en/rst/localizing/shipping.rst

index ce988dabeaae7498b0a157d7399baf6dc34ef7a0..3275562b954197f5106cd4ff3a5b0ad9f2bd6139 100644 (file)
@@ -164,21 +164,21 @@ Let's say we have the following:
     [% IF !Param("allowbugdeletion") %]
     <p>
       Sorry, there
-  
-      [% IF comp.bug_count &gt; 1 %] 
-        are [% comp.bug_count %] [%+ terms.bugs %] 
+
+      [% IF comp.bug_count &gt; 1 %]
+        are [% comp.bug_count %] [%+ terms.bugs %]
       [% ELSE %]
-         is [% comp.bug_count %] [%+ terms.bug %] 
+         is [% comp.bug_count %] [%+ terms.bug %]
       [% END %]
-  
+
       pending for this component. You should reassign
-  
+
       [% IF comp.bug_count &gt; 1 %]
          these [% terms.bugs %]
       [% ELSE %]
          this [% terms.bug %]
       [% END %]
-  
+
       to another component before deleting this component.
     </p>
     [% ELSE %]
@@ -189,7 +189,7 @@ for a component. ``IF comp.bug_count > 1`` means "if there are more than one bug
 Let's say your language has to deal with three plural forms and that the terms "bug" and
 "pending" should be declensed as well.
 
-First, you'll have to populate the :file:`/template/en/default/global/variables.none.tmp`
+First, you'll have to populate the :file:`/template/en/default/global/variables.none.tmpl`
 file with the declensions for "bug", which would give something like:
 
 .. code-block:: text
@@ -200,7 +200,7 @@ file with the declensions for "bug", which would give something like:
     "bug2" => "declension for two bugs",
     "bug3" => "declension for three bugs",
     "bugs" => "declension for more than three bugs",
-  
+
 
 Then, the previous code should look like:
 
@@ -209,31 +209,31 @@ Then, the previous code should look like:
     [% IF !Param("allowbugdeletion") %]
     <p>
       Sorry, there
-  
-      [% IF comp.bug_count > 3 %] 
-        are [% comp.bug_count %] pending [% terms.bugs %] 
+
+      [% IF comp.bug_count > 3 %]
+        are [% comp.bug_count %] pending [% terms.bugs %]
       [% ELSE %]
-        [% IF comp.bug_count == 0 %] 
-         is [% comp.bug_count %] pending [% terms.bug0 %] 
+        [% IF comp.bug_count == 0 %]
+         is [% comp.bug_count %] pending [% terms.bug0 %]
       [% ELSE %]
-        [% IF comp.bug_count == 1 %] 
+        [% IF comp.bug_count == 1 %]
          is [% comp.bug_count %] pending [% terms.bug %]
       [% ELSE %]
-        [% IF comp.bug_count == 2 %] 
+        [% IF comp.bug_count == 2 %]
          are [% comp.bug_count %] pending [% terms.bug2 %]
       [% ELSE %]
-        [% IF comp.bug_count == 3 %] 
-         are [% comp.bug_count %] pending [% terms.bug3 %] 
+        [% IF comp.bug_count == 3 %]
+         are [% comp.bug_count %] pending [% terms.bug3 %]
       [% END %]
-  
+
       for this component. You should reassign
-  
+
       [% IF comp.bug_count &gt; 1 %]
          these [% terms.bugs %]
       [% ELSE %]
          this [% terms.bug %]
       [% END %]
-  
+
       to another component before deleting this component.
     </p>
     [% ELSE %]
index d25f8266ef638498c5d7c965c4cab829c6a7c2e1..d4c62a95c3184aad9050d3e5a74a6bfe1a31b5e8 100644 (file)
@@ -49,7 +49,8 @@ also use a four-letter locale code, e.g. ``pt-BR`` for Brazilian Portuguese or
 ``zh-CN`` for Chinese (Simplified). In the rest of this guide, your locale
 code will be represented by ``ab-CD``.
 
-Then, run:
+Open a terminal and go to your Bugzilla installation's top-level directory
+and then run:
 
 :command:`contrib/new-locale.pl ab-CD`
 
index 593bcd4d1c29732f81717a0cf047d08bbb2ba7a1..7d30fa1c80a43e468366fca5247f4beca71352b0 100644 (file)
@@ -23,8 +23,8 @@ Though I recommend that you read the documents stated above, here are a few rule
 
   <ul>
     <li>In <code>index.rst</code> files, never localize what is under the <code>.. toctree::</code> directive: these are file names.</li>
-    <li>Never localize a term surrounded with a double dot and two colons. For instance: <code><mark>.. warning::</mark> <span class="green">This is a warning.</span></code>. This
-    will be automatically localized if necessary at compilation time. You can localize what is located after, in green in this example.</li>
+    <li>Never localize a term surrounded with a double dot and two colons. For instance: <code><mark>.. warning::</mark> This is a warning</code>. This
+    will be automatically localized if necessary at compilation time. You can localize any text that comes after ("This is a warning" in this example).</li>
     <li>Exception: do not localize what is located after the directive <code>.. highlight:: console</code>. The word console here is for formatting purpose.</li>
     <li>Do not localize a term surrounded with two colons or with the signs lesser than and greater than:
     <code>:<mark>ref</mark>:`<span class="green">Démarrage rapide</span>&lt;<mark>quick-start</mark>&gt;`</code>. "ref" is a reserved word and "quick-start" is a file name. In the following syntax example, do not localize "using"
index 556d881142d701ff35add17771682788ac22435b..8afabc3b7c5e404cd47a658224df9bf21ed6d18b 100644 (file)
@@ -10,4 +10,7 @@ Bugzilla administrator will untar in their ``$BUGZILLA_HOME`` directory.
 This command will find all of the files you've localized and put them into
 an appropriate tarball. Don't forget to replace both instances of ``ab-CD``:
 
+Open a terminal and go to your Bugzilla installation's top-level directory
+and then run:
+
 :command:`find -name "ab-CD" -print0 -o -path "./data" -prune | tar -cjvf ../bugzilla-ab-CD.tar.bz2 --null -T -`