Difference between revisions of "Translate ICA-AtoM application"

From ICA-AtoM
Jump to navigation Jump to search
 
(98 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[Main Page]] > Translate ICA-AtoM application
 
[[Main Page]] > Translate ICA-AtoM application
  
ICA-AtoM is a multi-lingual application, meaning that users can switch the interface between different languages, as well as contribute translations of descriptions from the source language to another. This page is for project participants preparing the default translations of the interface that will ship with version 1.0. This version will support the following languages:
+
== Overview ==
 +
 
 +
ICA-AtoM is a multi-lingual application. This page is for project participants preparing the default translations of the application.
 +
 
 +
ICA-AtoM release 1.3 will support the following languages:
 +
 
 
*Dutch
 
*Dutch
 +
*Farsi
 +
*Galician
 +
*German
 
*English
 
*English
 
*French
 
*French
 +
*Georgian
 +
*Indonesian (Bahasa)
 
*Italian
 
*Italian
 +
*Japanese
 +
*Korean
 
*Portuguese
 
*Portuguese
 
*Slovenian
 
*Slovenian
 
*Spanish
 
*Spanish
 +
*Thai
  
Users of an ICA-AtoM application will still have the option to modify the default translations to suit their own purposes (as described in [[User manual]] > [[Translate ICA-AtoM]]). The procedures on this page, however, are for the one-time translations that provide the defaults.
+
There are two broad classes of information that need to be translated into all of the supported languages:
 
 
== Log on as translator ==
 
 
 
{| border="0" cellpadding="2"
 
 
 
|- valign="top"
 
|width="600" |
 
 
 
1. Access the ICA-AtoM application at www.ica-atom.org/ ...
 
 
 
 
 
2. Click the <span class="button">LogIn</span> link on the <span class="menu">SystemMenu</span>.
 
 
 
 
 
3. Enter your user name and password.
 
 
 
 
 
4. The <span class="menu">MainMenuBar</span> now appears, including a <span class="button">Translate</span> tab.
 
 
 
 
 
5. Click the language for which you have translator access in the <span class="menu">LanguageMenu</span>.
 
 
 
 
 
6. Any user interface elements that have already been translated into the selected language switch to that language. The <span class="menu">TranlateBar</span> now appears along the bottom of the screen.
 
 
 
|width="500" align="right"|
 
 
 
insertScreenshot
 
 
 
|}
 
 
 
== Internationalization module ==
 
 
 
{| border="0" cellpadding="2"
 
 
 
|- valign="top"
 
|width="600" |
 
 
 
There are two broad classes of information that need to be translated:
 
 
 
 
 
*'''User interface''': the elements that structure how the content of the system is presented and enable the user to interact with that content. User interface elements include field labels, column headers, screen titles, buttons, links and pop-up dialog boxes.
 
 
 
 
 
*'''Database content''': data that is stored in the database itself. ICA-AtoM ships with some default database content that needs to be translated, including the text of the <span class="screen">Home</span> and <span class="screen">About</span> pages, and the controlled vocabularies (taxonomies) that are used throughout the system (e.g. in drop-down lists).
 
 
 
 
 
ICA-AtoM's <span class="entity">Internationalization module</span> is intended to facilitate the translation process by organizing the elements requiring translation and providing translators with a single place from which to translate them. To access the Internationalization module:
 
 
 
 
 
1. Click the <span class="button">Translate</span> tab on the <span class="menu">MainMenuBar</span>.
 
 
 
 
 
2. ICA-AtoM opens the Internationalization module, organized by three sub-tabs.
 
 
 
 
 
3. The <span class="button">UserInterface</span> sub-tab provides links to screens in the application that contain all the user interface elements that need translation. Links are organized by module (e.g. grouping links to archival description screens).
 
 
 
 
 
4. The <span class="button">DefaultContent</span> sub-tab provides the actual content that needs to be translated.
 
 
 
 
 
5. The <span class="button">NewContent</span> sub-tab is not currently operational and is included in the current version of ICA-AtoM (v0.6) only as a place-holder. In future version, this screen will will list all newly added or revised content that requires translation (e.g. new archival descriptions, revised authority records).
 
 
 
|width="500" align="right"|
 
 
 
insertScreenshot
 
 
 
|}
 
 
 
 
 
== Translate user interface ==
 
 
 
{| border="0" cellpadding="2"
 
 
 
|- valign="top"
 
|width="600" |
 
 
 
1. Click the <span class="button">Translate > UserInterface</span> sub-tab to open a list of links to pages that contain all the user interface elements requiring translation.
 
 
 
 
 
2. Click one of the links.
 
 
 
 
 
3. On the target page, the <span class="menu">TranslationBar</span> appears along the bottom of the screen (if it does not appear make sure you click the language into which you are translating in the <span class="menu">LanguageMenu</span>). Click the <span class="button">TranslateUserInterface</span> button on the <span class="menu">TranslationBar</span>.
 
 
 
 
 
4. ICA-AtoM opens the <span class="menu">TranslationPanel</span> in the lower frame of your screen. The panel is organized into three columns:
 
 
 
*Column 1 ("Page text") lists all elements for translation; '''all elements shaded with a yellow background have not yet been translated'''; elements with no shading (white background) have already been translated and appear in the list under their translated name.
 
 
 
*Column 2 ("Source") shows the name of the element in the default source language (English).
 
 
 
*Column 3 ("Translation") is where you input the translation.
 
 
 
 
 
5. Select an element for translation; ICA-AtoM bolds the selected element.
 
 
 
 
 
6. Add / edit the translation in column 3.
 
 
 
 
 
7. Note that some element names include a number enclosed by percent sign (e.g. "%1%", "%2%"). This is a Symfony "token" indicating a variable whose value is dynamically generated by context. The token must be included in the translation. See below, [[#Symfony tokens | Symfony tokens]], for an enumeration of elements that include tokens and how to handle them.
 
 
 
 
 
8. When translation is complete, click or tab out of column 3; the element will now appear in column 1 unshaded.
 
 
 
 
 
9. Continue until all elements have been translated.
 
 
 
 
 
10. Click the <span class="button">SaveTranslation</span> button; ICA-AtoM closes the <span class="menu">TranslationPanel</span>. All interface elements on the screen will now appear in their translations.
 
 
 
 
 
11. Return to the <span class="button">Translate > User interface</span> tab and repeat for all links on this screen.
 
 
 
|width="500" align="right"|
 
 
 
insertScreenshot
 
 
 
|}
 
 
 
 
 
=== Symfony tokens ===
 
 
 
Some user interface element names include "tokens". A token represents a variable whose value is determined by context. It is represented in Symfony by a number enclosed in percent signs (e.g. "%1%"). Tokens must be included in the translation, but because different languages have different grammar rules, translators need to be aware of the type of data being handled in any given variable in any given context. The following list enumerates in English the elements whose names includes tokens and the nature of the variables and context.
 
 
 
{| border="1" cellpadding="2"
 
 
 
|- valign="top" align="left"
 
 
 
!width="300" | Element name
 
 
 
!width="300" | Variable
 
 
 
!width="500" | Context
 
 
 
|-
 
| %1% profile
 
 
 
| User's account name
 
 
 
| Represents the link in the <span class="menu">SystemMenu</span> the user clicks to edit his or her user profile.
 
 
 
|}
 
  
 +
*'''User interface''': User interface elements include field labels, column headers, screen titles, buttons, links and pop-up dialog boxes. These are the generic template elements that structure how the application content is presented on the user interface.
  
== Translate default content ==
+
*'''Default content''': Data that is included by default when the application is installed. This includes things like the default homepage content and picklist values that are stored in taxonomies such as ''level of description'' or ''note types''.
  
{| border="0" cellpadding="2"
+
Users of an ICA-AtoM application will still have the option to modify the default translations to suit their own purposes (as described in [[UM-5|UM-5 Translate content/interface]]). The procedures on this page, however, are for the one-time translations that provide the application defaults.
  
|- valign="top"
+
== Translation Instructions ==
|width="600" |
 
  
"Default content" refers to data that is stored in the database but has been entered by the developers to ship with ICA-AtoM so that users can begin using an ICA-AtoM application "out of the box".
+
Thank you for helping us translate ICA-AtoM Release 1.3. The first step is to contact the [mailto:jessica@artefactual.com| ICA-AtoM Community Manager] and request the two translation files to be emailed directly to you.
  
 +
Attached to the email you receive from the ICA-AtoM Community Manager are two files:
 +
1) Home page text.rtf
 +
2) Atom-1.3RC1_xliff.zip
  
1. Click the <span class="button">Translate > DefaultContent</span> sub-tab. This page is organized into three sections.
+
Open the file and replace the content with your translated text for each of the three sections:
 +
* Qubit home page text,
 +
* ICA-AtoM home page text, and
 +
* Demo site home page text
  
 +
2) Atom-1.3RC1 XLIFF zip file
  
2. The ''Static pages'' section shows the various static pages that appear throughout the system (e.g. Home page, About page); these are stored in the <span class="entity">Static page</span> table.
+
Download the Atom-1.3RC1 zip file and extract the contents.
  
*Click the name of a page to translate; it expands into two columns.
+
Once the zip file is extracted, you will find individual folders according to language (e.g. "de/" for German, and "es/" for Spanish). Please select the folder for your specific language and open the file "messages.xml".
  
*The
+
In the messages.xml file, each string for translation is wrapped in a &lt;trans-unit id="#"&gt; tag. Within each &lt;trans-unit&gt; tag is a &lt;source&gt; tag, containing the original, English string for translation.
  
*The original text appears in the
+
After each &lt;source&gt; tag, there is a &lt;target&gt; tag where you will enter the translated text.
  
*Taxonomies: names of controlled vocabularies used throughout the system to generate drop-down value lists (e.g. "Levels of description"); stored in the <span class="entity">Taxonomy</span> table.
+
In cases where a translation has already been contributed the &lt;target&gt; tag will be populated. For example:
  
*Terms: the values that make up the taxonomies (.e.g. in the "Level of description" taxonomy: "Fonds", "Sub-fonds", "Series", "Sub-series", "File", "Item"); stored in the <span class="entity">Term</span> table.
+
<pre>
 +
&lt;trans-unit id="157"&gt;
 +
    &lt;source&gt;Accessibility&lt;/source&gt;
 +
    &lt;target&gt;Zugänglichkeit&lt;/target&gt;
 +
    &lt;note&gt;http://code.google.com/p/qubit-toolkit/source/browse/trunk/plugins/sfIsdiahPlugin/modules/sfIsdiahPlugin/templates/editSuccess.php&lt;/note&gt;
 +
&lt;/trans-unit&gt;
 +
</pre>
  
 +
In cases where no translation has been done, you will see an empty &lt;target/&gt; tag. For example:
  
2. Click an element for translation; ICA-AtoM expands it in two columns - on the left the text to be translated, on the right data entry boxes for the translation.
+
<pre>
 +
&lt;trans-unit="158"&gt;
 +
    &lt;source&gt;Accession area&lt;/source&gt;
 +
    &lt;target/&gt;
 +
    &lt;note&gt;http://code.google.com/p/qubit-toolkit/source/browse/trunk/plugins/sfDcPlugin/modules/sfDcPlugin/templates/indexSuccess.php&lt;/note&gt;
 +
&lt;/trans-unit&gt;
 +
</pre>
  
 +
To add a new translation, replace the &lt;target/&gt; tag with &lt;target&gt;Your translated text&lt;/target&gt;.  The final result should look like the populated example above.  To replace an existing translation, simply replace the existing translated text.
  
 +
Continue translating each unit of translation. Remember to save your file often while you work.
  
|width="500" align="right"|
+
The &lt;note&gt; field contains a link to the HTML template from which the translation text was extracted. You can view this template file by pasting the URL into your web browser, or some editors may allow you to click the link directly.
  
insertScreenshot
+
Translations must be submitted by August 6,2012!
  
|}
+
If you have any questions, please contact me.  We realize this is a short turnaround time, and encourage you to do the best you can.  If you are unable to do the translation work for any reason, please let us know as soon as possible so we can try to find a replacement translator.

Latest revision as of 13:06, 28 June 2012

Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.

Main Page > Translate ICA-AtoM application

Overview

ICA-AtoM is a multi-lingual application. This page is for project participants preparing the default translations of the application.

ICA-AtoM release 1.3 will support the following languages:

  • Dutch
  • Farsi
  • Galician
  • German
  • English
  • French
  • Georgian
  • Indonesian (Bahasa)
  • Italian
  • Japanese
  • Korean
  • Portuguese
  • Slovenian
  • Spanish
  • Thai

There are two broad classes of information that need to be translated into all of the supported languages:

  • User interface: User interface elements include field labels, column headers, screen titles, buttons, links and pop-up dialog boxes. These are the generic template elements that structure how the application content is presented on the user interface.
  • Default content: Data that is included by default when the application is installed. This includes things like the default homepage content and picklist values that are stored in taxonomies such as level of description or note types.

Users of an ICA-AtoM application will still have the option to modify the default translations to suit their own purposes (as described in UM-5 Translate content/interface). The procedures on this page, however, are for the one-time translations that provide the application defaults.

Translation Instructions

Thank you for helping us translate ICA-AtoM Release 1.3. The first step is to contact the ICA-AtoM Community Manager and request the two translation files to be emailed directly to you.

Attached to the email you receive from the ICA-AtoM Community Manager are two files: 1) Home page text.rtf 2) Atom-1.3RC1_xliff.zip

Open the file and replace the content with your translated text for each of the three sections:

  • Qubit home page text,
  • ICA-AtoM home page text, and
  • Demo site home page text

2) Atom-1.3RC1 XLIFF zip file

Download the Atom-1.3RC1 zip file and extract the contents.

Once the zip file is extracted, you will find individual folders according to language (e.g. "de/" for German, and "es/" for Spanish). Please select the folder for your specific language and open the file "messages.xml".

In the messages.xml file, each string for translation is wrapped in a <trans-unit id="#"> tag. Within each <trans-unit> tag is a <source> tag, containing the original, English string for translation.

After each <source> tag, there is a <target> tag where you will enter the translated text.

In cases where a translation has already been contributed the <target> tag will be populated. For example:

<trans-unit id="157">
    <source>Accessibility</source>
    <target>Zugänglichkeit</target>
    <note>http://code.google.com/p/qubit-toolkit/source/browse/trunk/plugins/sfIsdiahPlugin/modules/sfIsdiahPlugin/templates/editSuccess.php</note>
</trans-unit>

In cases where no translation has been done, you will see an empty <target/> tag. For example:

<trans-unit="158">
    <source>Accession area</source>
    <target/>
    <note>http://code.google.com/p/qubit-toolkit/source/browse/trunk/plugins/sfDcPlugin/modules/sfDcPlugin/templates/indexSuccess.php</note>
</trans-unit>

To add a new translation, replace the <target/> tag with <target>Your translated text</target>. The final result should look like the populated example above. To replace an existing translation, simply replace the existing translated text.

Continue translating each unit of translation. Remember to save your file often while you work.

The <note> field contains a link to the HTML template from which the translation text was extracted. You can view this template file by pasting the URL into your web browser, or some editors may allow you to click the link directly.

Translations must be submitted by August 6,2012!

If you have any questions, please contact me. We realize this is a short turnaround time, and encourage you to do the best you can. If you are unable to do the translation work for any reason, please let us know as soon as possible so we can try to find a replacement translator.