Updated for release 4.0.0

.gitignore

@@ -1,6 +1,8 @@
 .DS_Store
 jars/fluenta.jar
 jars/swt.jar
+docs/en/out
+docs/es/out
 out
 bin
 conf

docs/en/concepts/Fluenta_Introduction.dita

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
+<concept id="concept_jqh_y21_ts" xml:lang="en-US">
+  <title class="- topic/title ">Introduction</title>
+  <conbody class="- topic/body  concept/conbody ">
+    <p>Fluenta is a tool designed to simplify the translation of DITA projects. It can parse a DITA
+      map, resolving the references to all topics and subtopics, preparing a unified <xref
+        href="../glossaries/XLIFF.dita" format="dita">XLIFF</xref> file that you can send to your
+        <xref format="dita" href="../glossaries/LSP.dita">Language Service Provider</xref>
+      (LSP).</p>
+
+    <p>Fluenta implements the procedure for translating DITA projects recommended by the <xref
+        scope="external"
+        href="https://www.oasis-open.org/committees/download.php/48340/DITA12XLIFFArticle.pdf"
+        format="pdf">OASIS DITA Adoption TC</xref>.</p>
+    <section>
+      <title>How it works</title>
+      <ol>
+        <li>Start by <xref format="dita" href="../tasks/create_project.dita">creating a
+            project</xref>. All you have to do is provide the location of your DITA map and select
+          the languages that you want to translate into.</li>
+
+        <li>When you are ready to translate your project, <xref href="../tasks/generate_xliff.dita"
+            format="dita">generate an XLIFF file</xref> from it.</li>
+
+        <li>Send the XLIFF file to your <xref href="../glossaries/LSP.dita">Language Service
+            Provider</xref> (LSP) and wait for a translated XLIFF.</li>
+
+        <li><xref format="dita" href="../tasks/import_xliff.dita">Import the translated XLIFF</xref>
+          and select a folder where to store the translated version of your map and topics.</li>
+      </ol>
+      <p>The four steps described above are all you need to get a translated version of your DITA
+        project. The following diagram shows the processes involved:</p>
+      <image align="center" href="../images/FluentaWorkflow.svg" placement="break" scale="80">
+        <alt>Translation Cycle</alt>
+      </image>
+      <p>After updating your DITA content, you may want to update the translations of your project.
+        All you have to do at this moment is:</p>
+      <ol>
+        <li>Generate a new XLIFF file.</li>
+        <li>Send the new XLIFF file to your Language Service Provider and wait for a translated
+          XLIFF.</li>
+
+        <li>Import the translated XLIFF and select the folder where to store the updated translated
+          version of your map and topics.</li>
+      </ol>
+      <p>Fluenta automatically recovers In-Context Exact (ICE) matches from the translation that was
+        stored in the previous cycle. This means that you don't need to pay again for the
+        translation of content that didn't change.</p>
+      <p>Thanks to the <xref href="../glossaries/translation_memory.dita">Translation Memory</xref> technology included in Fluenta, you can also recover
+        translations of parts that were slightly changed.</p>
+    </section>
+
+  </conbody>
+</concept>

docs/en/concepts/advanced_configuration.dita

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
+<concept id="advanced_configuration" xml:lang="en-US">
+ <title>Advanced Configuration</title>
+ <conbody class="- topic/body  concept/conbody ">
+  <p>Fluenta default settings can be changed in the <uicontrol>Preferences</uicontrol> dialog.</p>
+  <ul>
+   <li>To open the <uicontrol>Preferences</uicontrol> dialog on Windows or Linux, in main menu
+    select <menucascade>
+     <uicontrol>Settings</uicontrol>
+     <uicontrol>Preferences</uicontrol>
+    </menucascade>.</li>
+   <li>To open the <uicontrol>Preferences</uicontrol> dialog on macOS, select <menucascade>
+     <uicontrol>Apple</uicontrol>
+     <uicontrol>Preferences</uicontrol>
+    </menucascade> in the menu.</li>
+  </ul>
+ </conbody>
+</concept>

docs/en/concepts/command_line_interface.dita

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
+<concept id="concept_stf_1x2_ts" xml:lang="en-US">
+ <title class="- topic/title ">Command Line Interface</title>
+ <conbody class="- topic/body  concept/conbody ">
+  <p>Fluenta can be integrated into publishing and editing workflows using its Command Line
+   Interface (CLI).</p>
+  <p>The methods exposed by Fluenta's CLI are:</p>
+  <ul>
+   <li><xref href="create_project_cli.dita">Create a project</xref>;</li>
+   <li><xref href="remove_project_cli.dita">Remove project</xref>;</li>
+   <li><xref href="retrieve_project_list_cli.dita">Retrieve the list of projects</xref>;</li>
+   <li><xref href="generate_xliff_cli.dita">Generate XLIFF files and optional word
+        counts</xref>;</li>
+   <li><xref href="import_xliff_cli.dita">Import an XLIFF file</xref>;</li>
+   <li><xref href="create_memory_cli.dita">Create a memory</xref>;</li>
+   <li><xref href="retrieve_memory_list_cli.dita">Retrieve the list of memories</xref>;</li>
+   <li><xref href="import_memory_cli.dita">Import a TMX file into a memory</xref>;</li>
+   <li><xref href="export_memory_cli.dita">Export a memory as TMX file</xref>;</li>
+   <li><xref href="license_management_cli.dita">Register a Subscription Key</xref>;</li>
+      <li><xref href="version_info_cli.dita">Retrieve version information</xref>.</li>
+  </ul>
+  <p>On macOS and Linux use <cmdname>fluenta_cli.sh</cmdname> for executing Fluenta without the
+   graphical user interface. </p>
+  <ul>
+   <li>On macOS the default location for the script is
+     <filepath>/Applications/Fluenta.app/Contents/Resources/fluenta_cli.sh</filepath></li>
+   <li>On Linux the default location for the shell script is
+    <filepath>/opt/Maxprograms/Fluenta/fluenta_cli.sh</filepath></li>
+  </ul>
+  <p>On Windows use <cmdname>fluenta_cli.bat</cmdname> (available in the default installation
+   directory) to process command line parameters.</p> 
+ </conbody>
+</concept>

docs/en/concepts/configuration_files.dita

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
+<concept id="concept_ich_gc4_ts">
+ <title>Configuration Files</title>
+ <shortdesc></shortdesc>
+ <conbody>
+  <p>Fluenta includes a configuration file for the 600+ elements defined defined in <xref
+        href="https://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part3-all-inclusive/non-normative/elementsMerged.html#elements"
+        format="html" scope="external">Appendix B.6 of DITA 1.3 All-Inclusive Edition</xref>.</p>
+  <p>A configuration file for <xref href="https://www.w3.org/TR/SVG/" format="html" scope="external"
+    >Scalable Vector Graphics (SVG)</xref> is also shipped in fluenta installers.</p>
+  <p> Additional configurations can be added by the user as required.</p>
+ </conbody>
+</concept>

docs/en/concepts/create_memory_cli.dita

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
+<concept id="concept_bbr_1vb_dt">
+ <title>Create Memory</title>
+ <conbody>
+  <p>Use the following parameters to create a memory from command line:</p>
+  <table>
+   <tgroup cols="4">
+    <colspec colwidth="20*" align="center"/>
+    <colspec colwidth="15*" align="center"/>
+    <colspec colwidth="50*" align="left"/>
+    <colspec colwidth="15*" align="center"/>
+    <thead>
+     <row>
+      <entry>Parameter</entry>
+      <entry>Value</entry>
+      <entry>Description</entry>
+      <entry>Required</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry translate="no">-addMem</entry>
+      <entry>JSON file</entry>
+      <entry>A JSON file containing the data required for creating the memory</entry>
+      <entry>Yes</entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </table>
+  <p>Example:</p>
+  <codeblock translate="no">
+fluenta_cli.bat -addMem addMemory.json 
+  </codeblock>
+  <p>Where the content of <cmdname>addMemory.json</cmdname> should be like:</p>
+
+  <codeblock translate="no">
+{ id:12345678, 
+  title:"JSON test", 
+  description:"memory created using JSON and CLI", 
+  srcLang:"en-US", 
+  tgtLang:["es","fr"]
+}
+</codeblock>
+  <section>
+   <title>JSON Value Pairs</title>
+   <table>
+    <tgroup cols="4">
+     <colspec colwidth="20*" align="center"/>
+     <colspec colwidth="15*" align="center"/>
+     <colspec colwidth="50*" align="left"/>
+     <colspec colwidth="15*" align="center"/>
+     <thead>
+      <row>
+       <entry>Member</entry>
+       <entry>Data Type</entry>
+       <entry>Description</entry>
+       <entry>Required</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry translate="no">id</entry>
+       <entry>Number</entry>
+       <entry>Memory identifier</entry>
+       <entry>Yes</entry>
+      </row>
+      <row>
+       <entry translate="no">title</entry>
+       <entry>String</entry>
+       <entry>Short text description for the memory. This is the description displayed in Fluenta's
+        GUI.</entry>
+       <entry>Yes</entry>
+      </row>
+      <row>
+       <entry translate="no">description</entry>
+       <entry>String</entry>
+       <entry>A longer text description for the memory.</entry>
+       <entry>Yes</entry>
+      </row>
+      <row>
+       <entry translate="no">srcLang</entry>
+       <entry>String</entry>
+       <entry>Source language code.</entry>
+       <entry>Yes</entry>
+      </row>
+      <row>
+       <entry translate="no">tgtLang</entry>
+       <entry>String Array</entry>
+       <entry>An array containing the target languages for the memory.</entry>
+       <entry>Yes</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </table>
+  </section>
+ </conbody>
+</concept>

docs/en/concepts/create_project_cli.dita

@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
+<concept id="concept_cfk_z5b_dt">
+  <title>Create Project</title>
+  <conbody>
+    <p>Use the following parameters to create a project from command line:</p>
+    <table>
+      <tgroup cols="4">
+        <colspec colwidth="20*" align="center"/>
+        <colspec colwidth="15*" align="center"/>
+        <colspec colwidth="50*" align="left"/>
+        <colspec colwidth="15*" align="center"/>
+        <thead>
+          <row>
+            <entry>Parameter</entry>
+            <entry>Value</entry>
+            <entry>Description</entry>
+            <entry>Required</entry>
+          </row>
+        </thead>
+        <tbody>
+          <row>
+            <entry translate="no">-add</entry>
+            <entry>JSON file</entry>
+            <entry>Full path to a <xref href="../glossaries/JSON.dita">JSON</xref> file containing
+              the data required for creating the project.</entry>
+            <entry>Yes</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+    <p>Example:</p>
+    <codeblock translate="no">
+fluenta_cli.bat -add addProject.json 
+  </codeblock>
+    <p>Where the content of <cmdname>addProject.json</cmdname> should be like:</p>
+
+    <codeblock translate="no">
+{ id:12345678, 
+  title:"JSON test", 
+  description:"project created using JSON and CLI", 
+  map:"D:\\sample content\\en\\User_Guide-use-only.ditamap", 
+  srcLang:"en-US", 
+  tgtLang:["es","fr"]
+}
+</codeblock>
+    <section>
+      <title>JSON Value Pairs</title>
+      <table>
+        <tgroup cols="4">
+          <colspec colwidth="20*" align="center"/>
+          <colspec colwidth="15*" align="center"/>
+          <colspec colwidth="50*" align="left"/>
+          <colspec colwidth="15*" align="center"/>
+          <thead>
+            <row>
+              <entry>Member</entry>
+              <entry>Data Type</entry>
+              <entry>Description</entry>
+              <entry>Required</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry translate="no">id</entry>
+              <entry>Number</entry>
+              <entry>Project identifier</entry>
+              <entry>Yes</entry>
+            </row>
+            <row>
+              <entry translate="no">title</entry>
+              <entry>String</entry>
+              <entry>Short text description for the project. This is the description displayed in
+                Fluenta's GUI</entry>
+              <entry>Yes</entry>
+            </row>
+            <row>
+              <entry translate="no">description</entry>
+              <entry>String</entry>
+              <entry>A longer text description for the project</entry>
+              <entry>Yes</entry>
+            </row>
+            <row>
+              <entry translate="no">map</entry>
+              <entry>String</entry>
+              <entry>Path to the project DITA map</entry>
+              <entry>Yes</entry>
+            </row>
+            <row>
+              <entry translate="no">srcLang</entry>
+              <entry>String</entry>
+              <entry>Language code for the original DITA content</entry>
+              <entry>Yes</entry>
+            </row>
+            <row>
+              <entry translate="no">tgtLang</entry>
+              <entry>String Array</entry>
+              <entry>An array containing the target languages for the project</entry>
+              <entry>Yes</entry>
+            </row>
+            <row>
+              <entry translate="no">memories</entry>
+              <entry>Number Array</entry>
+              <entry>An array containing the ids of existing memories to be associated with the
+                project</entry>
+              <entry>No</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </table>
+    </section>
+  </conbody>
+</concept>