Skip to content

Commit ba2bf97

Browse files
rmrayarmraya
committed
Updated for release 4.0.0
1 parent 91131f9 commit ba2bf97

205 files changed

Lines changed: 19372 additions & 570 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
.DS_Store
22
jars/fluenta.jar
33
jars/swt.jar
4+
docs/en/out
5+
docs/es/out
46
out
57
bin
68
conf

‎docs/XLIFF/fluenta_es.ditamap.tmx‎

Lines changed: 4599 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/XLIFF/fluenta_es.ditamap.xlf‎

Lines changed: 8729 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/en/concepts/Fluenta_Introduction.dita‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
3+
<concept id="concept_jqh_y21_ts" xml:lang="en-US">
4+
<title class="- topic/title ">Introduction</title>
5+
<conbody class="- topic/body concept/conbody ">
6+
<p>Fluenta is a tool designed to simplify the translation of DITA projects. It can parse a DITA
7+
map, resolving the references to all topics and subtopics, preparing a unified <xref
8+
href="../glossaries/XLIFF.dita" format="dita">XLIFF</xref> file that you can send to your
9+
<xref format="dita" href="../glossaries/LSP.dita">Language Service Provider</xref>
10+
(LSP).</p>
11+
12+
<p>Fluenta implements the procedure for translating DITA projects recommended by the <xref
13+
scope="external"
14+
href="https://www.oasis-open.org/committees/download.php/48340/DITA12XLIFFArticle.pdf"
15+
format="pdf">OASIS DITA Adoption TC</xref>.</p>
16+
<section>
17+
<title>How it works</title>
18+
<ol>
19+
<li>Start by <xref format="dita" href="../tasks/create_project.dita">creating a
20+
project</xref>. All you have to do is provide the location of your DITA map and select
21+
the languages that you want to translate into.</li>
22+
23+
<li>When you are ready to translate your project, <xref href="../tasks/generate_xliff.dita"
24+
format="dita">generate an XLIFF file</xref> from it.</li>
25+
26+
<li>Send the XLIFF file to your <xref href="../glossaries/LSP.dita">Language Service
27+
Provider</xref> (LSP) and wait for a translated XLIFF.</li>
28+
29+
<li><xref format="dita" href="../tasks/import_xliff.dita">Import the translated XLIFF</xref>
30+
and select a folder where to store the translated version of your map and topics.</li>
31+
</ol>
32+
<p>The four steps described above are all you need to get a translated version of your DITA
33+
project. The following diagram shows the processes involved:</p>
34+
<image align="center" href="../images/FluentaWorkflow.svg" placement="break" scale="80">
35+
<alt>Translation Cycle</alt>
36+
</image>
37+
<p>After updating your DITA content, you may want to update the translations of your project.
38+
All you have to do at this moment is:</p>
39+
<ol>
40+
<li>Generate a new XLIFF file.</li>
41+
<li>Send the new XLIFF file to your Language Service Provider and wait for a translated
42+
XLIFF.</li>
43+
44+
<li>Import the translated XLIFF and select the folder where to store the updated translated
45+
version of your map and topics.</li>
46+
</ol>
47+
<p>Fluenta automatically recovers In-Context Exact (ICE) matches from the translation that was
48+
stored in the previous cycle. This means that you don't need to pay again for the
49+
translation of content that didn't change.</p>
50+
<p>Thanks to the <xref href="../glossaries/translation_memory.dita">Translation Memory</xref> technology included in Fluenta, you can also recover
51+
translations of parts that were slightly changed.</p>
52+
</section>
53+
54+
</conbody>
55+
</concept>

‎docs/en/concepts/advanced_configuration.dita‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
3+
<concept id="advanced_configuration" xml:lang="en-US">
4+
<title>Advanced Configuration</title>
5+
<conbody class="- topic/body concept/conbody ">
6+
<p>Fluenta default settings can be changed in the <uicontrol>Preferences</uicontrol> dialog.</p>
7+
<ul>
8+
<li>To open the <uicontrol>Preferences</uicontrol> dialog on Windows or Linux, in main menu
9+
select <menucascade>
10+
<uicontrol>Settings</uicontrol>
11+
<uicontrol>Preferences</uicontrol>
12+
</menucascade>.</li>
13+
<li>To open the <uicontrol>Preferences</uicontrol> dialog on macOS, select <menucascade>
14+
<uicontrol>Apple</uicontrol>
15+
<uicontrol>Preferences</uicontrol>
16+
</menucascade> in the menu.</li>
17+
</ul>
18+
</conbody>
19+
</concept>

‎docs/en/concepts/command_line_interface.dita‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
3+
<concept id="concept_stf_1x2_ts" xml:lang="en-US">
4+
<title class="- topic/title ">Command Line Interface</title>
5+
<conbody class="- topic/body concept/conbody ">
6+
<p>Fluenta can be integrated into publishing and editing workflows using its Command Line
7+
Interface (CLI).</p>
8+
<p>The methods exposed by Fluenta's CLI are:</p>
9+
<ul>
10+
<li><xref href="create_project_cli.dita">Create a project</xref>;</li>
11+
<li><xref href="remove_project_cli.dita">Remove project</xref>;</li>
12+
<li><xref href="retrieve_project_list_cli.dita">Retrieve the list of projects</xref>;</li>
13+
<li><xref href="generate_xliff_cli.dita">Generate XLIFF files and optional word
14+
counts</xref>;</li>
15+
<li><xref href="import_xliff_cli.dita">Import an XLIFF file</xref>;</li>
16+
<li><xref href="create_memory_cli.dita">Create a memory</xref>;</li>
17+
<li><xref href="retrieve_memory_list_cli.dita">Retrieve the list of memories</xref>;</li>
18+
<li><xref href="import_memory_cli.dita">Import a TMX file into a memory</xref>;</li>
19+
<li><xref href="export_memory_cli.dita">Export a memory as TMX file</xref>;</li>
20+
<li><xref href="license_management_cli.dita">Register a Subscription Key</xref>;</li>
21+
<li><xref href="version_info_cli.dita">Retrieve version information</xref>.</li>
22+
</ul>
23+
<p>On macOS and Linux use <cmdname>fluenta_cli.sh</cmdname> for executing Fluenta without the
24+
graphical user interface. </p>
25+
<ul>
26+
<li>On macOS the default location for the script is
27+
<filepath>/Applications/Fluenta.app/Contents/Resources/fluenta_cli.sh</filepath></li>
28+
<li>On Linux the default location for the shell script is
29+
<filepath>/opt/Maxprograms/Fluenta/fluenta_cli.sh</filepath></li>
30+
</ul>
31+
<p>On Windows use <cmdname>fluenta_cli.bat</cmdname> (available in the default installation
32+
directory) to process command line parameters.</p>
33+
</conbody>
34+
</concept>

‎docs/en/concepts/configuration_files.dita‎

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

‎docs/en/concepts/create_memory_cli.dita‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="concept_bbr_1vb_dt">
4+
<title>Create Memory</title>
5+
<conbody>
6+
<p>Use the following parameters to create a memory from command line:</p>
7+
<table>
8+
<tgroup cols="4">
9+
<colspec colwidth="20*" align="center"/>
10+
<colspec colwidth="15*" align="center"/>
11+
<colspec colwidth="50*" align="left"/>
12+
<colspec colwidth="15*" align="center"/>
13+
<thead>
14+
<row>
15+
<entry>Parameter</entry>
16+
<entry>Value</entry>
17+
<entry>Description</entry>
18+
<entry>Required</entry>
19+
</row>
20+
</thead>
21+
<tbody>
22+
<row>
23+
<entry translate="no">-addMem</entry>
24+
<entry>JSON file</entry>
25+
<entry>A JSON file containing the data required for creating the memory</entry>
26+
<entry>Yes</entry>
27+
</row>
28+
</tbody>
29+
</tgroup>
30+
</table>
31+
<p>Example:</p>
32+
<codeblock translate="no">
33+
fluenta_cli.bat -addMem addMemory.json
34+
</codeblock>
35+
<p>Where the content of <cmdname>addMemory.json</cmdname> should be like:</p>
36+
37+
<codeblock translate="no">
38+
{ id:12345678,
39+
title:"JSON test",
40+
description:"memory created using JSON and CLI",
41+
srcLang:"en-US",
42+
tgtLang:["es","fr"]
43+
}
44+
</codeblock>
45+
<section>
46+
<title>JSON Value Pairs</title>
47+
<table>
48+
<tgroup cols="4">
49+
<colspec colwidth="20*" align="center"/>
50+
<colspec colwidth="15*" align="center"/>
51+
<colspec colwidth="50*" align="left"/>
52+
<colspec colwidth="15*" align="center"/>
53+
<thead>
54+
<row>
55+
<entry>Member</entry>
56+
<entry>Data Type</entry>
57+
<entry>Description</entry>
58+
<entry>Required</entry>
59+
</row>
60+
</thead>
61+
<tbody>
62+
<row>
63+
<entry translate="no">id</entry>
64+
<entry>Number</entry>
65+
<entry>Memory identifier</entry>
66+
<entry>Yes</entry>
67+
</row>
68+
<row>
69+
<entry translate="no">title</entry>
70+
<entry>String</entry>
71+
<entry>Short text description for the memory. This is the description displayed in Fluenta's
72+
GUI.</entry>
73+
<entry>Yes</entry>
74+
</row>
75+
<row>
76+
<entry translate="no">description</entry>
77+
<entry>String</entry>
78+
<entry>A longer text description for the memory.</entry>
79+
<entry>Yes</entry>
80+
</row>
81+
<row>
82+
<entry translate="no">srcLang</entry>
83+
<entry>String</entry>
84+
<entry>Source language code.</entry>
85+
<entry>Yes</entry>
86+
</row>
87+
<row>
88+
<entry translate="no">tgtLang</entry>
89+
<entry>String Array</entry>
90+
<entry>An array containing the target languages for the memory.</entry>
91+
<entry>Yes</entry>
92+
</row>
93+
</tbody>
94+
</tgroup>
95+
</table>
96+
</section>
97+
</conbody>
98+
</concept>

‎docs/en/concepts/create_project_cli.dita‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="concept_cfk_z5b_dt">
4+
<title>Create Project</title>
5+
<conbody>
6+
<p>Use the following parameters to create a project from command line:</p>
7+
<table>
8+
<tgroup cols="4">
9+
<colspec colwidth="20*" align="center"/>
10+
<colspec colwidth="15*" align="center"/>
11+
<colspec colwidth="50*" align="left"/>
12+
<colspec colwidth="15*" align="center"/>
13+
<thead>
14+
<row>
15+
<entry>Parameter</entry>
16+
<entry>Value</entry>
17+
<entry>Description</entry>
18+
<entry>Required</entry>
19+
</row>
20+
</thead>
21+
<tbody>
22+
<row>
23+
<entry translate="no">-add</entry>
24+
<entry>JSON file</entry>
25+
<entry>Full path to a <xref href="../glossaries/JSON.dita">JSON</xref> file containing
26+
the data required for creating the project.</entry>
27+
<entry>Yes</entry>
28+
</row>
29+
</tbody>
30+
</tgroup>
31+
</table>
32+
<p>Example:</p>
33+
<codeblock translate="no">
34+
fluenta_cli.bat -add addProject.json
35+
</codeblock>
36+
<p>Where the content of <cmdname>addProject.json</cmdname> should be like:</p>
37+
38+
<codeblock translate="no">
39+
{ id:12345678,
40+
title:"JSON test",
41+
description:"project created using JSON and CLI",
42+
map:"D:\\sample content\\en\\User_Guide-use-only.ditamap",
43+
srcLang:"en-US",
44+
tgtLang:["es","fr"]
45+
}
46+
</codeblock>
47+
<section>
48+
<title>JSON Value Pairs</title>
49+
<table>
50+
<tgroup cols="4">
51+
<colspec colwidth="20*" align="center"/>
52+
<colspec colwidth="15*" align="center"/>
53+
<colspec colwidth="50*" align="left"/>
54+
<colspec colwidth="15*" align="center"/>
55+
<thead>
56+
<row>
57+
<entry>Member</entry>
58+
<entry>Data Type</entry>
59+
<entry>Description</entry>
60+
<entry>Required</entry>
61+
</row>
62+
</thead>
63+
<tbody>
64+
<row>
65+
<entry translate="no">id</entry>
66+
<entry>Number</entry>
67+
<entry>Project identifier</entry>
68+
<entry>Yes</entry>
69+
</row>
70+
<row>
71+
<entry translate="no">title</entry>
72+
<entry>String</entry>
73+
<entry>Short text description for the project. This is the description displayed in
74+
Fluenta's GUI</entry>
75+
<entry>Yes</entry>
76+
</row>
77+
<row>
78+
<entry translate="no">description</entry>
79+
<entry>String</entry>
80+
<entry>A longer text description for the project</entry>
81+
<entry>Yes</entry>
82+
</row>
83+
<row>
84+
<entry translate="no">map</entry>
85+
<entry>String</entry>
86+
<entry>Path to the project DITA map</entry>
87+
<entry>Yes</entry>
88+
</row>
89+
<row>
90+
<entry translate="no">srcLang</entry>
91+
<entry>String</entry>
92+
<entry>Language code for the original DITA content</entry>
93+
<entry>Yes</entry>
94+
</row>
95+
<row>
96+
<entry translate="no">tgtLang</entry>
97+
<entry>String Array</entry>
98+
<entry>An array containing the target languages for the project</entry>
99+
<entry>Yes</entry>
100+
</row>
101+
<row>
102+
<entry translate="no">memories</entry>
103+
<entry>Number Array</entry>
104+
<entry>An array containing the ids of existing memories to be associated with the
105+
project</entry>
106+
<entry>No</entry>
107+
</row>
108+
</tbody>
109+
</tgroup>
110+
</table>
111+
</section>
112+
</conbody>
113+
</concept>

0 commit comments

Comments
 (0)