Skip to content

Commit 758f05a

Browse files
rmrayarmraya
committed
Added DITA sources
1 parent 5dbc8b7 commit 758f05a

206 files changed

Lines changed: 15770 additions & 0 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
@@ -10,6 +10,8 @@
1010
/node_modules/
1111
/TMXEditor-darwin-x64/
1212
/TMXEditor-win32-x64/
13+
/docs/en/out/
14+
/docs/es/out/
1315
app.js
1416
release
1517
server.sh

‎docs/en/concepts/basic_editing.dita‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="basic_editing">
4+
<title>Editing an Existing File</title>
5+
<shortdesc/>
6+
<conbody>
7+
<ol>
8+
<li>In main menu, select <menucascade>
9+
<uicontrol>File</uicontrol>
10+
<uicontrol>Open</uicontrol>
11+
</menucascade> option ([<userinput>Ctrol+O</userinput>] on Windows/Linux,
12+
[<userinput>Cmd+O</userinput>] on macOS) or click the <image
13+
href="../images/openFile.svg" placement="inline" height="16"
14+
/>&nbsp;<uicontrol>Open</uicontrol> button on the top toolbar.</li>
15+
<li>Use the dialog that appears to select a TMX file from the file system.</li>
16+
</ol>
17+
<p id="editing">Once the selected TMX file is open, you can:</p>
18+
<ul>
19+
<li>Click on any text cell to begin editing. After making changes, you can either<ul>
20+
<li>Click outside the cell or press [<userinput>Alt+Enter</userinput>] to save
21+
your changes</li>
22+
<li>Press the [<userinput>ESC</userinput>] key to cancel your changes</li>
23+
</ul>
24+
</li>
25+
<li>To add new units to the TMX file, select <menucascade>
26+
<uicontrol>Edit</uicontrol>
27+
<uicontrol>Insert Translation Unit</uicontrol>
28+
</menucascade> in main menu or click the <image placement="inline"
29+
href="../images/insertUnit.svg" height="16"/>&nbsp;<uicontrol>Insert Translation
30+
Unit</uicontrol> button from the top toolbar.</li>
31+
<li>To delete one or more units:<ol>
32+
<li>Select the checkbox in the leftmost column of the editing window to mark the
33+
units that you want to remove</li>
34+
<li>Select <menucascade>
35+
<uicontrol>Edit</uicontrol>
36+
<uicontrol>Delete Selected Units</uicontrol>
37+
</menucascade> in main menu or click the <image
38+
href="../images/deleteUnits.svg" placement="inline" height="16"
39+
/>&nbsp;<uicontrol>Delete Selected Units</uicontrol> button on the top
40+
toolbar.</li>
41+
</ol>
42+
<note>You can use the top-left checkbox to select/deselect all units at
43+
once.</note></li>
44+
<li>Use the <xref href="../tasks/filterUnits.dita">Filter Translation Units</xref>
45+
option to locate text in the file.</li>
46+
<li>Use the <xref href="../tasks/sortData.dita">Sort Translation Units</xref> option to
47+
display file entries sorted on a selected language.</li>
48+
</ul>
49+
50+
<p>After making changes to the TMX file, select <menucascade>
51+
<uicontrol>File</uicontrol>
52+
<uicontrol>Save</uicontrol>
53+
</menucascade> in main menu ([<userinput>Ctrl+S</userinput>] on Windows/Linux,
54+
[<userinput>Cmd+S</userinput>] on macOS) or click the <image
55+
href="../images/saveFile.svg" placement="inline" height="16"
56+
/>&nbsp;<uicontrol>Save</uicontrol> button on the top toolbar to save your
57+
modifications.</p>
58+
59+
</conbody>
60+
</concept>

‎docs/en/concepts/conversionTasks.dita‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="conversionTasks">
4+
<title>Conversion Tasks</title>
5+
<conbody>
6+
<p>TMXEditor can perform the following conversions:</p>
7+
<ul>
8+
<li><image href="../images/importExcel.svg" placement="inline" height="16"/>
9+
<xref href="../tasks/importExcel.dita">Convert Excel File to TMX</xref>
10+
</li>
11+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
12+
<xref href="../tasks/exportExcel.dita">Export TMX as Excel File</xref>
13+
</li>
14+
<li><image href="../images/importDelimited.svg" placement="inline" height="16"/>
15+
<xref href="../tasks/import_delimited.dita">Convert CSV/TAB Delimited File to
16+
TMX</xref>
17+
</li>
18+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
19+
<xref href="../tasks/export_delimited.dita">Export TMX as TAB Delimited File</xref>
20+
</li>
21+
<li><image href="../images/importSDLTM.svg" placement="inline" height="16"/>
22+
<xref href="../tasks/importSDLTM.dita">Convert SDLTM File to TMX</xref>
23+
</li>
24+
<li><image href="../images/importTBX.svg" placement="inline" height="16"/>
25+
<xref href="../tasks/importTBX.dita">Convert TBX File to TMX</xref>
26+
</li>
27+
</ul>
28+
<note>Prefer Excel files over CSV/TAB delimited when your data contains multiple lines of
29+
text in a single cell or translation unit.</note>
30+
</conbody>
31+
</concept>

‎docs/en/concepts/features.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="fetures">
4+
<title>Features</title>
5+
<shortdesc/>
6+
<conbody>
7+
<p>With TMXEditor you can:</p>
8+
<ul>
9+
<li>Set attributes, properties and notes at file level</li>
10+
<li>Edit segments of your TMX file to correct errors.</li>
11+
<li>Merge &amp; split TMX files.</li>
12+
<li>Add and remove languages from a TMX file.</li>
13+
<li>Change languages in a TMX file.</li>
14+
<li>Remove duplicates.</li>
15+
<li>Remove untranslated units.</li>
16+
<li>Remove inline tags.</li>
17+
<li>Trim initial and trailing spaces.</li>
18+
<li>Consolidate translation units when the TMX file has three or more languages.</li>
19+
<li>Validate TMX files.</li>
20+
<li>Clean invalid XML characters from a TMX file.</li>
21+
<li>Convert to TMX format<ul>
22+
<li>Excel files</li>
23+
<li>CSV or TAB delimited files</li>
24+
<li>SDLTM files</li>
25+
</ul>
26+
</li>
27+
<li>Export TMX files as<ul>
28+
<li>Excel files</li>
29+
<li>TAB Delimited files</li>
30+
</ul>
31+
</li>
32+
</ul>
33+
</conbody>
34+
</concept>

‎docs/en/concepts/gettingStarted.dita‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="gettingStarted">
4+
<title>Getting Started</title>
5+
<shortdesc>You can use TMXEditor to edit existing TMX files and also to create new TMX files,
6+
empty or from CSV/TAB delimited data.</shortdesc>
7+
<conbody>
8+
<ul>
9+
<li><image href="../images/openFile.svg" placement="inline" height="16"/>
10+
<xref href="basic_editing.dita">Editing an Existing TMX File</xref></li>
11+
<li><image href="../images/newFile.svg" height="16" placement="inline"/>
12+
<xref href="../tasks/create_file.dita">Create TMX File</xref></li>
13+
<li><image href="../images/convertCSV.svg" placement="inline" height="16"/>
14+
<xref href="../tasks/import_delimited.dita">Convert CSV/TAB Delimited to
15+
TMX</xref></li>
16+
</ul>
17+
</conbody>
18+
</concept>

‎docs/en/concepts/introduction.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="introduction">
4+
<title>Introduction</title>
5+
<shortdesc>TMXEditor is a cross-platform desktop application designed for editing <xref
6+
href="../glossaries/TMX.dita#TMX">TMX</xref> (Translation Memory eXchange) files on
7+
macOS, Linux and Microsoft Windows.</shortdesc>
8+
<conbody>
9+
<p>TMXEditor allows editing the content of multilingual TMX files. </p>
10+
<image href="../images/tmxeditor.png" placement="break" scalefit="yes">
11+
<alt>TMXEditor on Windows</alt>
12+
</image>
13+
</conbody>
14+
</concept>

‎docs/en/concepts/licenses.dita‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="credits">
4+
<title>Licenses</title>
5+
<conbody>
6+
<p>TMXEditor uses components from these open source projects:</p>
7+
8+
<p><b>Electron</b></p>
9+
<ul>
10+
<li>Available from <xref href="https://www.electronjs.org/" format="html"
11+
scope="external">https://www.electronjs.org/</xref></li>
12+
<li>Published under <xref
13+
href="https://raw.githubusercontent.com/electron/electron/main/LICENSE"
14+
scope="external" format="html">MIT License</xref></li>
15+
</ul>
16+
17+
<p><b>Java</b></p>
18+
<ul>
19+
<li>Available from <xref href="https://adoptium.net/" scope="external"
20+
format="html">https://adoptium.net/</xref></li>
21+
<li>Published under <xref
22+
href="https://raw.githubusercontent.com/adoptium/jdk/master/LICENSE"
23+
format="html" scope="external">GPL with CLASSPATH
24+
Exception</xref></li>
25+
</ul>
26+
<p><b>BCP47J</b></p>
27+
<ul>
28+
<li>Available from <xref href="https://github.com/rmraya/JavaBCP47"
29+
scope="external" format="html"
30+
>https://github.com/rmraya/BCP47J</xref></li>
31+
<li>Published under <xref
32+
href="https://www.eclipse.org/org/documents/epl-v10.html"
33+
format="html" scope="external">Eclipse Public License
34+
1.0</xref></li>
35+
</ul>
36+
<p><b>JSON-java</b></p>
37+
<ul>
38+
<li>Available from <xref href="https://github.com/stleary/JSON-java"
39+
format="html" scope="external"
40+
>https://github.com/stleary/JSON-java</xref></li>
41+
<li>Published under a <xref
42+
href="https://raw.githubusercontent.com/rmraya/OpenXLIFF/master/licenses/json/LICENSE"
43+
format="html" scope="external">custom license</xref></li>
44+
</ul>
45+
46+
<p><b>sdltm</b></p>
47+
<ul>
48+
<li>Available from <xref href="https://github.com/rmraya/sdltm"
49+
scope="external" format="html"
50+
>https://github.com/rmraya/sdltm</xref></li>
51+
<li>Published under <xref
52+
href="https://www.eclipse.org/org/documents/epl-v10.html"
53+
format="html" scope="external">Eclipse Public License
54+
1.0</xref></li>
55+
</ul>
56+
<p><b>SL4J</b></p>
57+
<ul>
58+
<li>Available from <xref href="https://slf4j.org" format="html"
59+
scope="external">https://slf4j.org</xref></li>
60+
<li>Published under <xref href="https://slf4j.org/license.html"
61+
format="html" scope="external">MIT License</xref></li>
62+
</ul>
63+
<p><b>SQLite JDBC Driver</b></p>
64+
<ul>
65+
<li>Available from <xref href="https://github.com/xerial/sqlite-jdbc"
66+
format="html" scope="external"
67+
>https://github.com/xerial/sqlite-jdbc</xref></li>
68+
<li>Published under <xref
69+
href="https://raw.githubusercontent.com/xerial/sqlite-jdbc/master/LICENSE"
70+
format="html" scope="external">Apache License</xref></li>
71+
</ul>
72+
<p><b>TMXValidator</b></p>
73+
<ul>
74+
<li>Available from <xref
75+
href="https://www.maxprograms.com/products/tmxvalidator.html"
76+
scope="external" format="html"
77+
>https://www.maxprograms.com/products/tmxvalidator.html</xref></li>
78+
<li>Published under <xref
79+
href="https://www.eclipse.org/org/documents/epl-v10.html"
80+
format="html" scope="external">Eclipse Public License
81+
1.0</xref></li>
82+
</ul>
83+
<p><b>TypesXML</b></p>
84+
<ul>
85+
<li>Available from <xref href="https://github.com/rmraya/JavaBCP47"
86+
scope="external" format="html"
87+
>https://github.com/rmraya/TypesXML</xref></li>
88+
<li>Published under <xref
89+
href="https://www.eclipse.org/org/documents/epl-v10.html"
90+
format="html" scope="external">Eclipse Public License
91+
1.0</xref></li>
92+
</ul>
93+
<p><b>XMLJava</b></p>
94+
<ul>
95+
<li>Available from <xref href="https://github.com/rmraya/XMLJava"
96+
scope="external" format="html"
97+
>https://github.com/rmraya/XMLJava</xref></li>
98+
<li>Published under <xref
99+
href="https://www.eclipse.org/org/documents/epl-v10.html"
100+
format="html" scope="external">Eclipse Public License
101+
1.0</xref></li>
102+
</ul>
103+
</conbody>
104+
</concept>

‎docs/en/concepts/maintenanceTasks.dita‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="maintenanceTasks">
4+
<title>Maintenance Tasks</title>
5+
<conbody>
6+
<p>TMXEditor maintenance options are </p>
7+
<ul>
8+
<li><image href="../images/fileInfo.svg" placement="inline" height="16"/>
9+
<xref href="../tasks/fileMetadata.dita">Set Attributes, Properties and Notes at File Level</xref></li>
10+
<li><image href="../images/maintenance.svg" placement="inline" height="16"/>
11+
<xref href="../tasks/maintenanceDashboard.dita">Maintenance Dashboard</xref></li>
12+
<li><image href="../images/sortUnits.svg" placement="inline" height="16"/>
13+
<xref href="../tasks/sortData.dita">Sort Translation Units</xref></li>
14+
<li><image href="../images/filterUnits.svg" placement="inline" height="16"/>
15+
<xref href="../tasks/filterUnits.dita">Filter Translation Units</xref></li>
16+
<li><image href="../images/replaceTexts.svg" placement="inline" height="16"/>
17+
<xref href="../tasks/search_replace.dita">Search &amp; Replace Text</xref></li>
18+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
19+
<xref href="../tasks/change_language.dita">Change Language</xref></li>
20+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
21+
<xref href="../tasks/add_language.dita">Add Language</xref></li>
22+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
23+
<xref href="../tasks/remove_language.dita">Remove Language</xref></li>
24+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
25+
<xref href="../tasks/change_src_language.dita">Change Source Language</xref></li>
26+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
27+
<xref href="../tasks/remove_tags.dita">Remove Inline Tags</xref></li>
28+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
29+
<xref href="../tasks/remove_duplicates.dita">Remove Duplicated Units</xref></li>
30+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
31+
<xref href="../tasks/remove_sameAsSource.dita">Remove Translation Same as
32+
Source</xref></li>
33+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
34+
<xref href="../tasks/remove_spaces.dita">Remove Initial &amp; Trailing
35+
Spaces</xref></li>
36+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
37+
<xref href="../tasks/consolidate_units.dita">Consolidate Translation
38+
Units</xref></li>
39+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
40+
<xref href="../tasks/split_file.dita">Split TMX File</xref></li>
41+
<li><image href="../images/blank.svg" placement="inline" height="16"/>
42+
<xref href="../tasks/merge_files.dita">Merge TMX Files</xref></li>
43+
</ul>
44+
</conbody>
45+
</concept>

0 commit comments

Comments
 (0)