Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
2015OmegaT/OmegaT/doc_src/en/UserInterface.xml
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
1202 lines (944 sloc)
45.6 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?xml version="1.0" encoding="UTF-8"?> | |
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" | |
"../../../docbook-xml-4.5/docbookx.dtd"> | |
<chapter id="chapter.user.interface"> | |
<title>The user interface</title> | |
<section id="user.interface.items"> | |
<title>Main OmegaT window, other windows and dialogs</title> | |
<para>OmegaT main window contains the main menu, status bar and several | |
panes. Additional windows are available, as well as dialogs, used to | |
change OmegaT project settings. The information below summarizes their use | |
and how they are invoked:</para> | |
<table colsep="0" rowsep="0"> | |
<title>Main OmegaT window<indexterm class="singular"> | |
<primary>User Interface</primary> | |
<secondary>Main OmegaT window</secondary> | |
</indexterm></title> | |
<tgroup cols="2" colsep="0" rowsep="1" title="Main OMegaT window"> | |
<colspec align="left" colnum="1"/> | |
<colspec align="left" colnum="2"/> | |
<tbody> | |
<row> | |
<entry><guimenuitem>Editor pane</guimenuitem></entry> | |
<entry>where you type and edit the translation</entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Match pane</guimenuitem></entry> | |
<entry>displays the most similar segments from translation | |
memories</entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Glossary pane</guimenuitem></entry> | |
<entry>displays terminology found for items in the current | |
segment</entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Dictonary pane</guimenuitem></entry> | |
<entry>displays dictionary hits found for items in the current | |
segment</entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Machine Translations | |
pane</guimenuitem></entry> | |
<entry>displays the translation, provided by MT services</entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Notes pane</guimenuitem></entry> | |
<entry>notes pertaining to the current segment, e.g. alternative | |
translations or the current key in case of key=value file | |
formats</entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Comments pane</guimenuitem></entry> | |
<entry>Comments by the author in PO files, or the name of the | |
attribute being translated (in XHTML)</entry> | |
</row> | |
</tbody> | |
</tgroup> | |
</table> | |
<table colsep="0" rowsep="0"> | |
<title>Other windows<indexterm class="singular"> | |
<primary>User interface</primary> | |
<secondary>Other windows</secondary> | |
</indexterm></title> | |
<tgroup cols="2" colsep="0" rowsep="1" title="Other windows"> | |
<colspec align="left" colnum="1"/> | |
<colspec align="left" colnum="2"/> | |
<tbody> | |
<row> | |
<entry><guimenuitem><indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Tag validation - Ctrl+T</secondary> | |
</indexterm>Tag Validation window</guimenuitem></entry> | |
<entry><para>Used to validate tags (open with <keycombo> | |
<keycap>Ctrl</keycap> | |
<keycap>Shift</keycap> | |
<keycap>V</keycap> | |
</keycombo>, close with <keycap>Esc</keycap>)</para></entry> | |
</row> | |
<row> | |
<entry><guimenuitem><indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Help - F1</secondary> | |
</indexterm>Help browser</guimenuitem></entry> | |
<entry><para>Used to display the user manual (open with | |
<keycap>F1</keycap>, close with | |
<keycap>Esc)</keycap></para></entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Statistics window</guimenuitem></entry> | |
<entry><para>Used to open the window with the statistics of the | |
project, display it, using <menuchoice> | |
<guimenu><indexterm class="singular"> | |
<primary>Menu Tools</primary> | |
<secondary>statistics</secondary> | |
</indexterm>Tools</guimenu> | |
<guimenuitem>Statistics.</guimenuitem> | |
</menuchoice></para></entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Match statistics window</guimenuitem></entry> | |
<entry><para>Used to display the match statistics of the project, | |
select <menuchoice> | |
<guimenu><indexterm class="singular"> | |
<primary>Menu Tools</primary> | |
<secondary>Match statistics</secondary> | |
</indexterm>Tools</guimenu> | |
<guimenuitem>Match statistics</guimenuitem> | |
</menuchoice>to open it.</para></entry> | |
</row> | |
</tbody> | |
</tgroup> | |
</table> | |
<table border="0" colsep="0" rowsep="0"> | |
<title>Settings dialogs<indexterm class="singular"> | |
<primary>User interface</primary> | |
<secondary>Settings dialogs</secondary> | |
<seealso>Project Settings</seealso> | |
</indexterm></title> | |
<tgroup cols="2" colsep="0" rowsep="1" title="Settings dialogs"> | |
<colspec align="left" colnum="1"/> | |
<colspec align="left" colnum="2"/> | |
<tbody> | |
<row> | |
<entry><guimenuitem>Project properties<indexterm class="singular"> | |
<primary>Menu Project</primary> | |
<secondary>Properties</secondary> | |
</indexterm></guimenuitem> <indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Project properties - Ctrl+E</secondary> | |
</indexterm></entry> | |
<entry>Used to modify the project folders and languages (access | |
via <guimenuitem>Ctrl+E </guimenuitem>shortcut or <menuchoice> | |
<guimenu>Project</guimenu> | |
<guimenuitem>properties...</guimenuitem> | |
</menuchoice>, close via <keycap>Esc)</keycap></entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Font<indexterm class="singular"> | |
<primary>Font</primary> | |
</indexterm></guimenuitem></entry> | |
<entry><para>Used to modify the font used by | |
<application>OmegaT</application> to display source, translation, | |
matches and glossary terms, (access via <menuchoice> | |
<guimenu>Options</guimenu> | |
<guimenuitem>Font...</guimenuitem> | |
</menuchoice>, close via <keycap>Esc</keycap>)</para></entry> | |
</row> | |
<row> | |
<entry><guimenuitem>File filters<indexterm class="singular"> | |
<primary>File filters</primary> | |
</indexterm></guimenuitem></entry> | |
<entry>Used to adjust the handling of supported file formats | |
(access via <menuchoice> | |
<guimenu>Options</guimenu> | |
<guimenuitem>File Filters...</guimenuitem> | |
</menuchoice>, close via <keycap>Esc</keycap>)</entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Segmentation<indexterm class="singular"> | |
<primary>Segmentation</primary> | |
</indexterm></guimenuitem></entry> | |
<entry>Used to change the way your text is segmented into | |
sentences (access via <menuchoice> | |
<guimenu>Options</guimenu> | |
<guimenuitem>Segmentation</guimenuitem> | |
</menuchoice>, close via <keycap>Esc</keycap>)</entry> | |
</row> | |
<row> | |
<entry><guimenuitem>Editing Behavior<indexterm class="singular"> | |
<primary>Editing Behavior</primary> | |
</indexterm></guimenuitem></entry> | |
<entry>Used to change how <application>OmegaT</application> | |
behaves when you iterate between the segments (access via | |
<menuchoice> | |
<guimenu>Options</guimenu> | |
<guimenuitem>Behavior...</guimenuitem> | |
</menuchoice>, close via <keycap>Esc</keycap>)</entry> | |
</row> | |
</tbody> | |
</tgroup> | |
</table> | |
</section> | |
<section id="OmegaT.main.window"> | |
<title><application>OmegaT</application> main window<indexterm | |
class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Main window</secondary> | |
</indexterm></title> | |
<figure id="OmegaT.main.window.figure"> | |
<title>OmegaT main window</title> | |
<mediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/OmegaT_panes_25.png" scale="100"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/OmegaT_panes_25.png" width="80%"/> | |
</imageobject> | |
</mediaobject> | |
</figure> | |
<para>The main window consists of several panes, the main menu and a | |
status bar. You can change the position of any pane or even undock it to a | |
separate window by clicking and dragging the pane by its name. Depending | |
on the pane status, different signs can appear at its top right | |
corner:</para> | |
<note> | |
<para>If you can not see all the panes (be it opened or minimized), | |
pressing <guisubmenu> Options > Restore Main Window </guisubmenu>will | |
restore them to the state, defined in the installation.</para> | |
</note> | |
<table> | |
<title>Pane widgets<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Pane widgets</secondary> | |
</indexterm></title> | |
<tgroup cols="2"> | |
<colspec align="left" colnum="1"/> | |
<tbody> | |
<row> | |
<entry><inlinemediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/Minimize.gif" width="60%"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/Minimize.gif" width="40%"/> | |
</imageobject> | |
</inlinemediaobject></entry> | |
<entry>minimizes the pane, so that only its name is shown at the | |
bottom of the window</entry> | |
</row> | |
<row> | |
<entry><inlinemediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/Maximize.gif" width="60%"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/Maximize.gif" width="40%"/> | |
</imageobject> | |
</inlinemediaobject></entry> | |
<entry>maximizes the pane</entry> | |
</row> | |
<row> | |
<entry><inlinemediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/restore.gif" width="60%"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/restore.gif" width="40%"/> | |
</imageobject> | |
</inlinemediaobject></entry> | |
<entry>restores the layout before the maximizing step</entry> | |
</row> | |
<row> | |
<entry><inlinemediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/undock.gif" width="60%"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/undock.gif" width="40%"/> | |
</imageobject> | |
</inlinemediaobject></entry> | |
<entry>undocks the pane from the main window</entry> | |
</row> | |
<row> | |
<entry><inlinemediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/dock.gif" width="60%"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/dock.gif" width="40%"/> | |
</imageobject> | |
</inlinemediaobject></entry> | |
<entry>puts the pane back within the main window</entry> | |
</row> | |
</tbody> | |
</tgroup> | |
</table> | |
<para>You can overlap panes if desired. When this is done the panes | |
display a tab at the top. The separators between the panes can be dragged | |
to resize panes. Should you lose track of your changes to the user | |
interface, you can use <guimenuitem><indexterm class="singular"> | |
<primary>OmegaT windows</primary> | |
<seealso>Windows and panes in OmegaT</seealso> | |
</indexterm> <indexterm class="singular"> | |
<primary>OmegaT windows</primary> | |
<secondary>Restoring to factory setup</secondary> | |
</indexterm>Options → Restore the main window</guimenuitem> any time to | |
return to the original layout.</para> | |
<para>The counters in the lower right corner keep track of the progress of | |
the translation (numbers in the left hand column refer to the figure | |
above):</para> | |
<table> | |
<title>Main Window - counters<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Counters</secondary> | |
</indexterm></title> | |
<tgroup cols="2"> | |
<colspec align="left" colnum="1"/> | |
<tbody> | |
<row> | |
<entry>27/27</entry> | |
<entry>number of segments - translated vs total for the current | |
file</entry> | |
</row> | |
<row> | |
<entry>9319/16338</entry> | |
<entry>number of unique segments - translated vs total in the | |
project</entry> | |
</row> | |
<row> | |
<entry>31175</entry> | |
<entry>total number of segments (including repeats) in the | |
project</entry> | |
</row> | |
<row> | |
<entry>103/114</entry> | |
<entry>number of source and target characters in the current | |
segment</entry> | |
</row> | |
</tbody> | |
</tgroup> | |
</table> | |
<para>From a practical point of view, the most important pair of numbers | |
is the second pair: it tells, how much you have done so far, in relation | |
to the total or second number. The project in the example is evidently | |
finished, as all the unique segments have been translated.</para> | |
<section id="editor.pane"> | |
<title>Editor pane<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Editor pane</secondary> | |
</indexterm></title> | |
<para>This is where you type and edit your translation. The Editor pane | |
displays the text of the partially translated document: the text already | |
translated is displayed in translation while the untranslated text is | |
displayed in the original language. The displayed text is split into | |
segments and you may scroll through the document and double-click on any | |
segment to open and edit it. In the above case, the segments already | |
translated are shown in yellow.</para> | |
<para>One of the above segments is the current segment. It is the | |
segment that is displayed in two parts. The upper part is in the source | |
language, in bold characters with a green background color, the lower | |
part is the editing field, ended by a marker: <indexterm | |
class="singular"> | |
<primary>Segment marker</primary> | |
</indexterm>the marker is <literal><segment nnnn></literal> | |
where nnnn is a number of the segment in the project. Use the upper part | |
as a reference and replace or modify the contents of the editing field | |
with your translation.</para> | |
<para>Depending upon the preferred editing behavior, the editing field | |
for the untranslated segment may be empty, contain the source text, or | |
contain the translation of the string most similar to the one to be | |
translated. When you move to another segment, the translation is | |
validated and stored. If you want the translation to be the same as the | |
source, simply make the editing field empty by removing all the text | |
(select all with <keycap>Ctrl+A</keycap> and delete with | |
<keycap>Del</keycap>). OmegaT is able to store translations that are | |
identical to the source. This is useful for documents that contain trade | |
marks, names or other proper nouns, or parts in a third language that do | |
not require translation. See <emphasis>Translation editing</emphasis> | |
for more details.</para> | |
<para>If you right click on the Editor pane, a pop-up menu opens, | |
offering<emphasis role="bold"> Cut, Copy, Paste</emphasis> (i.e. same | |
functions as <keycombo> | |
<keycap>Ctrl</keycap> | |
<keycap>X</keycap> | |
</keycombo>, <keycombo> | |
<keycap>Ctrl</keycap> | |
<keycap>C</keycap> | |
</keycombo> and <keycombo> | |
<keycap>Ctrl</keycap> | |
<keycap>V</keycap> | |
</keycombo>) and the <emphasis role="bold">GoTo segment</emphasis> | |
functions.</para> | |
</section> | |
<section id="match.viewer"> | |
<title>Fuzzy matches pane<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Fuzzy matches pane</secondary> | |
</indexterm></title> | |
<para><figure id="matches.pane"> | |
<title><indexterm class="singular"> | |
<primary>Matches</primary> | |
<secondary>Matches pane - figure</secondary> | |
</indexterm><indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Matches pane - figure</secondary> | |
</indexterm>Matches pane</title> | |
<mediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/MatchesPane_25.png"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/MatchesPane_25.png" width="80%"/> | |
</imageobject> | |
</mediaobject> | |
</figure></para> | |
<para>The match viewer shows the most similar segments from translation | |
memories, both from internal project translation memory created in real | |
time as you translate your project and from ancillary translation | |
memories you have imported from your earlier jobs, or received from your | |
client or translation agency.</para> | |
<para>When you move to the next segment, the first fuzzy match (the one | |
with the best matching percentage) is automatically selected. You may | |
select a different match by pressing <guimenuitem>Ctrl+2, 3, 4, or | |
5</guimenuitem>.<indexterm> | |
<primary>Shortcuts</primary> | |
<secondary>Selecting the match - Ctrl+N</secondary> | |
</indexterm> Of course, pressing <keycombo> | |
<keycap>Ctrl</keycap> | |
<keycap>5</keycap> | |
</keycombo> will have no effect, if there is no match #5. To use the | |
selected match in your translation, use | |
<guimenuitem>Ctrl+R</guimenuitem><indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Replace text - Ctrl+R</secondary> | |
</indexterm> to replace the target field with the match or use | |
<guimenuitem>Ctrl+I <indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Insert text - Ctrl+I</secondary> | |
</indexterm></guimenuitem> to insert it at the cursor position.</para> | |
<para>The matching percentage is roughly equivalent to taking the number | |
of common words in the matched and the matching segment and dividing by | |
the number of words in the longer of the two. The selected fuzzy match | |
is highlighted in bold, words that are missing in the segment you are | |
translating are colored blue and words adjacent to the missing parts | |
green. In the above example the source segment is <emphasis | |
role="bold">Context menu command</emphasis>. The top match is 100%, | |
because all words match. So do the next two matches, and the match #4 is | |
similar, but different. The line with the matching percentage also | |
includes the name of the translation memory <indexterm class="singular"> | |
<primary>Translation memories</primary> | |
<secondary>Matches</secondary> | |
</indexterm> containing the match. If there's no file name displayed, | |
the source is the internal project translation memory. Orphan | |
segments<indexterm class="singular"> | |
<primary>Translation memories</primary> | |
<secondary>Orphan segments</secondary> | |
</indexterm> (the match #2) describe segments in the default project | |
translation memory that have no corresponding source segment.</para> | |
<para>There are actually three match estimates available (66/66/30 in | |
the case of the match #4 above). They are defined as follows:</para> | |
<itemizedlist> | |
<listitem> | |
<para>match percentage (taking into account tokenizers)</para> | |
</listitem> | |
</itemizedlist> | |
<itemizedlist> | |
<listitem> | |
<para>default OmegaT match - number of matched words - with numerals | |
and tags ignored - divided by the total word count</para> | |
</listitem> | |
</itemizedlist> | |
<itemizedlist> | |
<listitem> | |
<para>OmegaT match, including numbers, tags</para> | |
</listitem> | |
</itemizedlist> | |
<section> | |
<title>Customizing the Fuzzy matches pane<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Fuzzy matches pane</secondary> | |
<tertiary>Customizing</tertiary> | |
</indexterm><indexterm class="singular"> | |
<primary>Source files</primary> | |
<secondary>Translating updated source</secondary> | |
</indexterm></title> | |
<para>In <guimenu>Options > External TMXs</guimenu>, a number of | |
variables allow to configure the display of the match pane:</para> | |
<figure id="matches.pane.setup"> | |
<title><indexterm class="singular"> | |
<primary>Matches</primary> | |
<secondary>Matches pane setup - figure</secondary> | |
</indexterm><indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Matches pane setup - figure</secondary> | |
</indexterm>Matches pane setup</title> | |
<mediaobject> | |
<imageobject> | |
<imagedata fileref="images/MatchesPaneSetup.png"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/MatchesPaneSetup.png" width="50%"/> | |
</imageobject> | |
</mediaobject> | |
</figure> | |
<para>The figure above shows the default match display template. The | |
contents can be customized using following variables:</para> | |
<table colsep="0" rowsep="0"> | |
<title>Match pane setup<indexterm class="singular"> | |
<primary>User Interface</primary> | |
<secondary>Match pane setup</secondary> | |
</indexterm></title> | |
<tgroup cols="2" colsep="1" rowsep="1" title="Match pane setup"> | |
<colspec align="left" colnum="1"/> | |
<colspec align="left" colnum="2"/> | |
<tbody> | |
<row> | |
<entry><literal>${id}</literal></entry> | |
<entry>Number of the match from 1 to 5</entry> | |
</row> | |
<row> | |
<entry><literal>${sourceText}</literal></entry> | |
<entry>Source text of the match</entry> | |
</row> | |
<row> | |
<entry><literal>${targetText}</literal></entry> | |
<entry>Target text of the match</entry> | |
</row> | |
<row> | |
<entry><literal>${diff}</literal></entry> | |
<entry>String showing the differences between the source and | |
the match.<emphasis> Hint:</emphasis> use this if the text, | |
you are translating has been updated.</entry> | |
</row> | |
<row> | |
<entry><literal>${score}</literal></entry> | |
<entry>Percentage with tokenizer</entry> | |
</row> | |
<row> | |
<entry><literal>${noStemScore}</literal></entry> | |
<entry>Percentage without numbers and tags</entry> | |
</row> | |
<row> | |
<entry><literal>${adjustedScore}</literal></entry> | |
<entry>Percentage adjusted</entry> | |
</row> | |
<row> | |
<entry><literal>${fileNameOnly}</literal></entry> | |
<entry>Name of the TMX</entry> | |
</row> | |
<row> | |
<entry><literal>${filePath}</literal></entry> | |
<entry>Full path of the TMX</entry> | |
</row> | |
<row> | |
<entry><literal>${fileShortPath}</literal></entry> | |
<entry>Path of the TMX starting from the root of /tm</entry> | |
</row> | |
<row> | |
<entry><literal>${creationID}</literal></entry> | |
<entry>Author of the match</entry> | |
</row> | |
<row> | |
<entry><literal>${creationDate}</literal></entry> | |
<entry>Date of the match</entry> | |
</row> | |
<row> | |
<entry><literal>${fuzzyFlag}</literal></entry> | |
<entry>Indicate that this match is fuzzy (currently only for | |
translations from PO files with the #fuzzy mark)</entry> | |
</row> | |
</tbody> | |
</tgroup> | |
</table> | |
</section> | |
</section> | |
<section> | |
<title>Glossary pane<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Glossary pane</secondary> | |
</indexterm></title> | |
<para>The Glossary pane allows you to access your own collection of | |
expressions and specialist terminology which you have built up in your | |
glossary files. It shows translation of terms found in the current | |
segment. The source segment in the example below was “<emphasis>Context | |
menu command</emphasis>”, as in the Fuzzy Matches example above, and the | |
terms shown were found in the glossaries, available (Microsoft's Term | |
collection and Slovenian Linux User group Glossary).</para> | |
<figure id="multiword.pane"> | |
<title><indexterm class="singular"> | |
<primary>Glossaries</primary> | |
</indexterm>multi-word entry in the glossary</title> | |
<mediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/GlossaryPane_25.png"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/GlossaryPane_25.png" width="80%"/> | |
</imageobject> | |
</mediaobject> | |
</figure> | |
<para>If you have TransTips option activated (<guimenuitem>Options → | |
TransTips</guimenuitem>), you can right click on the highlighted word in | |
the source segment to open a pop-up menu with suggested translation, as | |
offered by your glossary. Selecting one of them will insert it at the | |
current cursor position into the target segment. You can also highlight | |
your preferred alternative in the glossary pane and insert it into the | |
target by right clicking on the selection.</para> | |
</section> | |
<section id="dictionaries"> | |
<title>Dictionary pane<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Dictionary pane</secondary> | |
</indexterm></title> | |
<para>Dictionaries are the electronic equivalents of printed | |
dictionaries like Merriam Webster, Duden, Larousse etc., that you may | |
have on your desk. See more about them in the chapter on <link | |
linkend="chapter.dictionaries">Dictionaries</link></para> | |
</section> | |
<section id="Multiple.Translations"> | |
<title>Multiple Translations pane<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Multiple Translations pane</secondary> | |
</indexterm></title> | |
<para>A given source segment may require several different translations, | |
depending on the context. If the current translation of the segment does | |
not fit, the user can select <guisubmenu>Edit → Create Alternative | |
Translation</guisubmenu>. The target text entered after that will be | |
treated as an alternative translation of the source segment. You can | |
define one of the alternative - for instance the most probable among | |
them - as default translation by selecting <guisubmenu>Edit → Use as | |
Default Translation</guisubmenu></para> | |
</section> | |
<section> | |
<title>Notes pane</title> | |
<para>The translator can add notes to the opened segment, for instance | |
to come back later to the segment and redo the translation, check that | |
alternative translations are correct or to ask colleagues for their | |
opinion. You can browse through notes using <guisubmenu>GoTo → Next | |
Note</guisubmenu> and <guisubmenu>GoTo → Previous | |
Note</guisubmenu>.</para> | |
</section> | |
<section> | |
<title>Comments pane</title> | |
<para>Some of the file formats, specialized for translation work, for | |
instance PO, allow the inclusion of comments. This way the translator | |
can be provided the context about the segment to be translated. In the | |
example below, the author of the PO file included a warning for the | |
translator to check the length of the translation:</para> | |
<figure id="comments.pane"> | |
<title>Comments pane<indexterm class="singular"> | |
<primary>Comments</primary> | |
<secondary>Comments pane</secondary> | |
</indexterm></title> | |
<mediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/Comments_25.png"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/Comments_25.png" width="80%"/> | |
</imageobject> | |
</mediaobject> | |
</figure> | |
</section> | |
<section id="Google.Translate"> | |
<title>Machine Translation pane<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Machine Translation pane</secondary> | |
</indexterm></title> | |
<para>The machine translation pane, when opened, contains the | |
suggestions by machine translation tools for the current segment. Press | |
<keysym>Ctrl+M</keysym> to replace the translation of the current | |
segment with the suggested translation. More in the chapter <link | |
linkend="chapter.machine.translate">Machine translation</link></para> | |
</section> | |
<section> | |
<title id="main.menu">Main menu</title> | |
<para>The main menu provides access to all | |
<application>OmegaT</application> functions. See the <emphasis>Main | |
Menu</emphasis> appendix for a full description of all menus and menu | |
items. The most frequently used functions are accessible with keyboard | |
shortcuts, so once you become accustomed to them, you will no longer | |
need to browse through the menus while translating. See chapter <link | |
linkend="chapter.menu">Menu and Keyboard shortcuts</link> for | |
details.</para> | |
</section> | |
<section id="status.bar"> | |
<title>Status bar</title> | |
<para>The status bar displays work-flow related messages at the bottom | |
of the main window. This bar gives the user feedback on specific | |
operations that are in progress. It also displays the number of fuzzy | |
and glossary matches for the current segment.</para> | |
</section> | |
</section> | |
<section id="other.windows"> | |
<title>Other windows</title> | |
<section id="section.project.files"> | |
<title>Project files<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Project files</secondary> | |
</indexterm></title> | |
<para>The Project Files window lists the project files and displays | |
other project information. It is displayed automatically when OmegaT | |
loads a project. Use <guimenuitem>Ctrl+L<indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Project files list - Ctrl+L</secondary> | |
</indexterm></guimenuitem> to open and <keycap>Esc</keycap> to close | |
it. The Project Files Window displays the following information:</para> | |
<itemizedlist> | |
<listitem> | |
<para>the total number of translatable files in the project. These | |
are the files present in the /source folder in a format that OmegaT | |
is able to recognize. This number is displayed in brackets, next to | |
the "Project file" title</para> | |
</listitem> | |
<listitem> | |
<para>the list of all translatable files in the project. Clicking on | |
any file will open it for translation. Note: filenames (in first | |
column) can be sorted alphabetically by clicking in the header. It | |
also possible to change the position of a filename, by clicking on | |
it and pressing <emphasis>Move ...</emphasis> buttons.</para> | |
</listitem> | |
</itemizedlist> | |
<itemizedlist> | |
<listitem> | |
<para>the file currently available in the Editor pane is highlighted | |
with a blue background. Pressing <keycap>Enter</keycap> will move | |
the Editor pane to the top of the file selected</para> | |
</listitem> | |
</itemizedlist> | |
<itemizedlist> | |
<listitem> | |
<para>File entries include their names, file filter types, their | |
encoding and the number of segments each file contains</para> | |
</listitem> | |
</itemizedlist> | |
<itemizedlist> | |
<listitem> | |
<para>the total number of segments, the number of unique segments in | |
the whole project, and the number of unique segments already | |
translated are shown at the bottom</para> | |
</listitem> | |
</itemizedlist> | |
<para>The set of <emphasis role="bold">Unique </emphasis>segments is | |
computed by taking all the segments and removing all duplicate segments. | |
(The definition of “unique” is case-sensitive: "Run" and "run" are | |
treated as being different)</para> | |
<para>The difference between "Number of segments" and "Number of unique | |
segments" provides an approximate idea of the number of repetitions in | |
the text. Note however that the numbers do not indicate how relevant the | |
repetitions are: they could mean relatively long sentences repeated a | |
number of times (in which case you are fortunate) or it could describe a | |
table of keywords (not so fortunate). The | |
<filename>project_stats.txt</filename> located in the omegat folder of | |
your project contains more detailed segment information, broken down by | |
file.</para> | |
<para>Modifying the segmentation rules may have the effect of modifying | |
the number of segments/unique segments. This, however, should generally | |
be avoided once you have started translating the project. See the | |
chapter <emphasis>Segmentation rules</emphasis> for more | |
information.</para> | |
<para><emphasis role="bold"><indexterm class="singular"> | |
<primary>Source files</primary> | |
<secondary>Adding files to the project</secondary> | |
</indexterm>Adding files to the project: </emphasis>You can add source | |
files to the project by clicking on the "<guimenuitem>Import Source | |
Files..."</guimenuitem> button. This copies the selected files to the | |
<filename>source</filename> folder and reloads the project to import the | |
new files. You can also add source files from Internet pages, written in | |
MediaWiki, by clicking on<guimenuitem> "Import from | |
MediaWiki"</guimenuitem> button and providing the corresponding | |
URL.</para> | |
</section> | |
<section id="section.search.window"> | |
<title>Search window<indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Search pane</secondary> | |
</indexterm></title> | |
<para>You can use the search window to find specific segments in a | |
project. You can also have several search windows open simultaneously. | |
To open a new search window, use <keycombo> | |
<keycap>Ctrl</keycap> | |
<keycap>F</keycap> | |
</keycombo> in the Main window. The search window consists of a text | |
field for search strings or keywords, flags and radio buttons for | |
setting up the search and a display area containing the results of the | |
search. See the chapter<emphasis> <link | |
linkend="chapter.user.interface">Searches</link> </emphasis>for more | |
information about the search window.</para> | |
</section> | |
<section id="section.tag.validation"> | |
<title>Tag validation<indexterm class="singular"> | |
<primary>Tag validation</primary> | |
<seealso>Shortcuts, Tags</seealso> | |
</indexterm><indexterm class="singular"> | |
<primary>Windows and panes in OmegaT</primary> | |
<secondary>Tag validation</secondary> | |
<seealso>Tags</seealso> | |
</indexterm></title> | |
<para>The tag validation window detects and lists any tag errors and | |
inconsistencies in the translation. Open the window with | |
<guimenuitem>Ctrl+T. </guimenuitem>The window features a 3 column table | |
with a link to the segment and its source and target contents:</para> | |
<para><figure id="tag.validator.window"> | |
<title><indexterm class="singular"> | |
<primary>Tag validation</primary> | |
<secondary>Window - figure</secondary> | |
<seealso>Tags</seealso> | |
</indexterm>Tag validation window</title> | |
<mediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/TagValidator.png"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/TagValidator.png" width="60%"/> | |
</imageobject> | |
</mediaobject> | |
</figure></para> | |
<para>Tags are highlighted in bold blue for easy comparison between the | |
original and the translated contents. Click on the link to jump to the | |
segment in the Editor pane. Correct the error if necessary and press | |
<guimenuitem>Ctrl+T</guimenuitem> to return to the tag validation window | |
to correct other errors. In the first and third case above tags are | |
paired incorrectly, and in the second case the < sign is missing from | |
the starting tag.</para> | |
<para>Tag errors are cases in which the tags in the translation do not | |
correspond in order and number to the original segment. Some tag | |
scenarios flagged in the tag validation window are necessary and are | |
benign, others will cause problems when the translated document is | |
created. Tags generally represent some kind of formatting in the | |
original text. Simplifying the original text formatting in the source | |
file before commencing translation greatly contributes to reducing the | |
number of tags.</para> | |
</section> | |
<section> | |
<title>Statistics<indexterm class="singular"> | |
<primary>Statistics</primary> | |
<seealso>Menu Tools</seealso> | |
</indexterm></title> | |
<para>The statistics window - accessed via <emphasis | |
role="bold">Tools>Statistics </emphasis>- shows the statistics of the | |
current OmegaT project, both in the summary form as well as in detail | |
for every file to be translated. The statistics shown is available as a | |
tab-separated <filename>project_stats.txt</filename> file (subfolder | |
<filename>omegat</filename>), ready to be loaded into a spreadsheet | |
program for the user's convenience. You can use <guimenuitem>Ctrl+A | |
<indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Select All - Ctrl+A</secondary> | |
</indexterm></guimenuitem><guimenuitem>, Ctrl+C <indexterm | |
class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Copy text - Ctrl+C</secondary> | |
</indexterm></guimenuitem>, <guimenuitem>Ctrl+V <indexterm | |
class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Paste text - Ctrl+V</secondary> | |
</indexterm></guimenuitem> to copy/paste the contents. <figure | |
id="ProjectStatistic.Window"> | |
<title>project statistics</title> | |
<mediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/StatisticsWindow_25.png"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/StatisticsWindow_25.png" width="60%"/> | |
</imageobject> | |
</mediaobject> | |
</figure></para> | |
</section> | |
<section> | |
<title>Match statistics<indexterm class="singular"> | |
<primary>Match Statistics</primary> | |
<seealso>Menu Tools</seealso> | |
</indexterm></title> | |
<para>The match statistics are accessed via<guimenuitem>Tools>Match | |
Statistics.</guimenuitem> The evaluation is rather CPU intensive and can | |
be time-consuming, so a progress bar is shown during the calculation. As | |
far as categories are concerned, the de facto industry standard of | |
classifying matches into the following groups is used: Repetitions, | |
Exact match, 95%-100%, 85%-94%, 75%-84%, 50%-74% and No match. This | |
information is computed for segments as well as for words and for | |
characters (without and including spaces). Note that there could be | |
minor differences between the OmegaT counts and the numbers, provided by | |
other CAT tools.<figure> | |
<title>Match statistics</title> | |
<mediaobject> | |
<imageobject role="html"> | |
<imagedata fileref="images/MatchStatistics.png"/> | |
</imageobject> | |
<imageobject role="fo"> | |
<imagedata fileref="images/MatchStatistics.png" width="80%"/> | |
</imageobject> | |
</mediaobject> | |
</figure></para> | |
<para>Note that these totals are a good (or as good as they can be) | |
approximation of the work involved in the project and thus can serve as | |
a basis for your cost and price calculations.</para> | |
<para>Spaces between segments are not taken into account in the last | |
column. Repetitions stand for identical segments present several times | |
in the text. The first segment and its contents will be classified as | |
"no match", and the rest of them as a repetition of the first. If the | |
translation for several identical source segments already exists in the | |
translation memory of the project, these segments, together with other, | |
already translated unique segments, will be classified as an "Exact | |
match". The number of unique segments, if needed, is provided in the | |
standard statistics window, regardless of whether they have been | |
translated or not.</para> | |
<para>The rest of the categories (50-100%) involves untranslated | |
segments with a fuzzy match. Fuzzy matches can come from the | |
<filename>/tm</filename> folder as well - and not just from the internal | |
translation memory in <filename>/omegaT,</filename> as is the case for | |
repetitions and exact matches. The only difference with matches from the | |
<filename>project_save</filename> translation memory is that external | |
TMs cannot give exact matches, only 100%. If one does not wish to use | |
external TMs for counting, one will either have to empty the /tm folder | |
or change the project setup (temporarily) so that the value for /tm | |
points to a different location.</para> | |
<para>The Match Statistics are tab-separated and you can use | |
<guimenuitem>Ctrl+A <indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Select All - Ctrl+A</secondary> | |
</indexterm></guimenuitem><guimenuitem>, Ctrl+C <indexterm | |
class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>copy text - Ctrl+C</secondary> | |
</indexterm></guimenuitem>, <guimenuitem>Ctrl+V <indexterm | |
class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Paste text - Ctrl+V</secondary> | |
</indexterm></guimenuitem> to copy/paste them, for instance into a | |
spreadsheet or into your cost-accounting application. Once computed, the | |
data also available in | |
<filename>omegat/project_stats_match.txt.</filename> Note that the file | |
is time-stamped, as the calculation (contrary to the standard | |
statistics) is not instantaneous and can thus quickly become | |
obsolete.</para> | |
</section> | |
<section> | |
<title>Help browser<indexterm class="singular"> | |
<primary>Menu Help</primary> | |
<secondary>Help browser</secondary> | |
</indexterm></title> | |
<para>The help browser (which displays this manual) can be opened by | |
pressing <keycap><indexterm class="singular"> | |
<primary>Shortcuts</primary> | |
<secondary>Help - F1</secondary> | |
</indexterm>F1</keycap> or navigating to <guimenuitem><indexterm | |
class="singular"> | |
<primary>Menu Help</primary> | |
<secondary>User Manual...</secondary> | |
</indexterm>Help → User Manual...</guimenuitem> in the main menu. In | |
the window, the manual and two buttons are displayed: Back and Contents. | |
The user manual is an HTML document with links to different chapters. | |
Clicking on a link as you would do in a web browser brings the desired | |
page to the front.</para> | |
<para>The user manual is located in the docs subfolder under the OmegaT | |
installation folder, so you may can, for instance, view the English | |
documentation by opening the <filename>docs/en/index.html | |
</filename>file in your browser. Opening the user manual in this way | |
also enables you to follow external links, as the built-in help browser | |
does not accept external Internet links.</para> | |
</section> | |
</section> | |
</chapter> |