GNOME.org
 

[gtranslator: 1/2] help: Document new features on Damned Lies


commit ce1625802bcb71a700870957a8721cd5206e0259
Author: Amanda Shafack <shafack likhene gmail com>
Date:   Mon Mar 8 11:41:00 2021 +0100

    help: Document new features on Damned Lies
    
    Provide detail instructions on how to reserve a po file for
    translation and how to upload a po file to Damned Lies.

 help/C/gtr-reserve-po.page | 60 ++++++++++++++++++++++++++++++++++++++++++++++
 help/C/gtr-save-po.page    |  3 ++-
 help/C/gtr-upload-po.page  | 59 +++++++++++++++++++++++++++++++++++++++++++++
 help/C/index.page          |  2 +-
 help/meson.build           |  2 ++
 5 files changed, 124 insertions(+), 2 deletions(-)
---
diff --git a/help/C/gtr-reserve-po.page b/help/C/gtr-reserve-po.page
new file mode 100644
index 00000000..90a439d9
--- /dev/null
+++ b/help/C/gtr-reserve-po.page
@@ -0,0 +1,60 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic" style="task"
+      id="gtr-reserve-po">
+
+  <info>
+    <link type="guide" xref="index#gtr-po" group="seventh"/>
+    <link type="seealso" xref="gtr-edit-po"/>
+    <link type="seealso" xref="gtr-open-po"/>
+    <link type="seealso" xref="gtr-add-comment-po"/>
+    <link type="seealso" xref="gtr-goto-string-po"/>
+    <link type="seealso" xref="gtr-edit-header"/>
+    <link type="seealso" xref="gtr-upload-po"/>
+
+ <revision pkgversion="2.91.6" date="2013-06-18" status="review"/>
+ <revision pkgversion="3.34.0" date="2019-09-27" status="review"/>
+    <credit type="author copyright">
+      <name>Amanda Shafack</name>
+      <email its:translate="no">shafack likhene gmail com</email>
+      <years>2021</years>
+    </credit>
+    <credit type="copyright editor">
+      <name></name>
+      <email its:translate="no"></email>
+      <years></years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+  </info>
+
+  <title>Reserve PO file</title>
+
+  <p>You can reserve a po file for translation, during the process of downloading it from Damned Lies. To be 
able to reserve a po file, you need to be authenticated.</p>
+
+   <list type="numbered">
+    <title>To authenticate yourself:</title>
+      <item><p>Login to your account on <link href="https://l10n.gnome.org/";>Damned Lies</link></p></item>
+      <item><p>From your profile, click on the <gui style="button">Create auth token </gui>button.</p></item>
+      <item><p>Copy the auth token that has been generated; you can find it just below your profile 
details.</p></item>
+      <item><p>Launch the Translation Editor and go to Preferences >> Profiles.</p></item>
+      <item><p>Select your profile and click on the <gui style="button">Edit Profile</gui> button.</p></item>
+      <item><p>Paste the auth token you copied in the "DL auth token" field and click on the <gui 
style="button">OK</gui> button.</p></item>
+      <item><p>You have successfully authenticated yourself. You can now perform the reserve 
operation.</p></item>
+  </list>
+
+  <list type="numbered">
+    <title>To reserve a po file:</title>
+      <item><p>Click on the <gui style="button">Load from DL</gui> button (if you are on the main window) or 
<gui style="button">Open from Damned Lies</gui> icon (if a po file is open) in the header bar.
+      You can also use the <keyseq><key>Ctrl</key><key>D</key></keyseq> keyboard shortcut.</p></item>
+      <item><p>Select your desired po file; specifying the particular team, module, branch and 
domain.</p></item>
+      <item><p>The state of the po file is displayed.</p></item>
+      <item><p>Select the <gui style="button">Reserve for translation</gui> checkbox to reserve your chosen 
po file.</p></item>
+      <item><p>A message dialog will display the status of the operation.</p></item>
+      <item><p>If the message dialog displays a success message, you have successfully reserved the po file 
for translation.</p></item>
+      <item><p>However, if the <gui style="button">Reserve for translation</gui> checkbox is deactivated, it 
means the po file cannot be reserved. This is because it is not in the appropriate state.
+      See the <link href="https://l10n.gnome.org/help/vertimus_workflow/";>vertimus workflow </link>for more 
details.</p></item>
+  </list>
+
+</page>
diff --git a/help/C/gtr-save-po.page b/help/C/gtr-save-po.page
index 6c241da4..6732f0f5 100644
--- a/help/C/gtr-save-po.page
+++ b/help/C/gtr-save-po.page
@@ -10,7 +10,8 @@
     <link type="seealso" xref="gtr-add-comment-po"/>
     <link type="seealso" xref="gtr-goto-string-po"/>
     <link type="seealso" xref="gtr-edit-header"/>
-    
+    <link type="seealso" xref="gtr-upload-po"/>
+    <link type="seealso" xref="gtr-reserve-po"/>
        
  <revision pkgversion="2.91.6" date="2013-06-18" status="review"/>
  <revision pkgversion="3.34.0" date="2019-09-27" status="review"/>
diff --git a/help/C/gtr-upload-po.page b/help/C/gtr-upload-po.page
new file mode 100644
index 00000000..197c5cf5
--- /dev/null
+++ b/help/C/gtr-upload-po.page
@@ -0,0 +1,59 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic" style="task"
+      id="gtr-upload-po">
+
+  <info>
+    <link type="guide" xref="index#gtr-po" group="eighth"/>
+    <link type="seealso" xref="gtr-edit-po"/>
+    <link type="seealso" xref="gtr-open-po"/>
+    <link type="seealso" xref="gtr-add-comment-po"/>
+    <link type="seealso" xref="gtr-goto-string-po"/>
+    <link type="seealso" xref="gtr-edit-header"/>
+    <link type="seealso" xref="gtr-reserve-po"/>
+
+ <revision pkgversion="2.91.6" date="2013-06-18" status="review"/>
+ <revision pkgversion="3.34.0" date="2019-09-27" status="review"/>
+    <credit type="author copyright">
+      <name>Amanda Shafack</name>
+      <email its:translate="no">shafack likhene gmail com</email>
+      <years>2021</years>
+    </credit>
+    <credit type="copyright editor">
+      <name></name>
+      <email its:translate="no"></email>
+      <years></years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+  </info>
+
+  <title>Upload PO file</title>
+
+  <p>You can upload a po file (translation file) to Damned Lies after translating. Note that the po file 
that is uploaded is that which is currently open at a given time; as it is not yet possible to manually 
select a file to upload.</p>
+
+  <p>In order to perform the upload operation, you need to be authenticated.</p>
+
+  <list type="numbered">
+    <title>To authenticate yourself:</title>
+      <item><p>Login to your account on <link href="https://l10n.gnome.org/";>Damned Lies</link></p></item>
+      <item><p>From your profile, click on the <gui style="button">Create auth token </gui>button.</p></item>
+      <item><p>Copy the auth token that has been generated; you can find it just below your profile 
details.</p></item>
+      <item><p>Launch the Translation Editor and go to Preferences >> Profiles.</p></item>
+      <item><p>Select your profile and click on the <gui style="button">Edit Profile</gui> button.</p></item>
+      <item><p>Paste the auth token you copied in the "DL auth token" field and click on the <gui 
style="button">OK</gui> button.</p></item>
+      <item><p>You have successfully authenticated yourself. You can now upload a po file to Damned 
Lies.</p></item>
+  </list>
+
+  <list type="numbered">
+    <title>To upload a po file:</title>
+      <item><p>Click on the <gui style="button">Upload file</gui> icon in the header bar or use the 
<keyseq><key>Ctrl</key><key>B</key></keyseq> keyboard shortcut.</p></item>
+      <item><p>A message dialog will display the status of the operation.</p></item>
+      <item><p>If the message dialog displays a success message, you have successfully uploaded the po file 
to Damned Lies.</p></item>
+      <item><p>If the <gui style="button">Upload file</gui> icon is deactivated, it means the po file cannot 
be uploaded. This is because it is not in the appropriate state. See the <link 
href="https://l10n.gnome.org/help/vertimus_workflow/";>vertimus workflow </link>for more details.</p></item>
+  </list>
+
+<p>Note that a po file must be reserved (in the state; Translating) before it can be uploaded to Damned 
Lies.</p>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
index ed725735..18efcca2 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -47,7 +47,7 @@
 
  <section id="gtr-po">
     <title>Working with PO files</title>
-    <links type="topic" style="2column" groups="first second third fourth fifth"/>
+    <links type="topic" style="2column" groups="first second third fourth fifth sixth seventh eighth"/>
  </section>
  
   <section id="gtr-tm" style="2column">
diff --git a/help/meson.build b/help/meson.build
index a4ba4eff..334282e3 100644
--- a/help/meson.build
+++ b/help/meson.build
@@ -16,6 +16,8 @@ sources = [
   'gtr-shortcut-keys.page',
   'gtr-translate.page',
   'gtr-use-delete-entry.page',
+  'gtr-reserve-po.page',
+  'gtr-upload-po.page',
   'gtr-wizzard.page',
   'index.page',
   'legal.xml',
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]