Difference between revisions of "Translate ICA-AtoM application"

Latest revision as of 12: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.

Difference between revisions of "Translate ICA-AtoM application"

Latest revision as of 12:06, 28 June 2012

Overview

Translation Instructions

Navigation menu

Search

@@ Line 3: / Line 3: @@
 == Overview ==
-ICA-AtoM is a multi-lingual application. This page is for project participants preparing the default translations of the application that will ship with version 1.0. ICA-AtoM 1.0 will support the following languages:
+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''': 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.
+*'''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 stored in the database itself that ships with the application: static pages and controlled vocabularies.
-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.
-== Log in as translator ==
-{| border="0" cellpadding="2"
-|- valign="top"
-|width="600" |
-. Access the ICA-AtoM application at www.ica-atom.org/translate/
-. Click the <span class="button">LogIn</span> link on the <span class="menu">SystemMenu</span>.
-. Enter your user name and password.
-. The <span class="menu">MainMenuBar</span> now appears, including a <span class="button">Translate</span> tab.
-. Click the language for which you have translator access in the <span class="menu">LanguageMenu</span>.
-. Any user interface elements and database content 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"|
-[[Image:LogIn1.png|500px|thumb|left|Log in]]
-[[Image:LogIn2.png|500px|thumb|left|Select language]]
-|}
-== Access the internationalization module ==
-{| border="0" cellpadding="2"
-|- valign="top"
-|width="600" |
-ICA-AtoM's <span calss="entity">Internationalization module</span> facilitates the translation process by organizing the elements requiring translation and providing translators with a central place from which to translate them. To access the Internationalization module:
-. Click the <span class="button">Translate</span> tab on the <span class="menu">MainMenuBar</span>.
-. ICA-AtoM opens the Internationalization module, organized by three sub-tabs.
-. <span class="button">UserInterface</span> sub-tab:
-*Provides links to pages in the application that contain all the user interface elements that need translation.
-*Links / pages are organized by module.
-. <span class="button">DefaultContent</span> sub-tab:
-*Provides all default content that needs to be translated.
-. <span class="button">NewContent</span> sub-tab:
-*Not currently operational, included in the current version of ICA-AtoM (v0.6) as a place-holder.
-*Intended to support the management of translation of all new content in an ICA-AtoM application, listing all pages that contain newly added or revised content requiring translation (e.g. new archival descriptions, revised authority records).
-|width="500" align="right"|
-[[Image:AccessI18NModule1.png|500px|thumb|left|Access translate tab]]
-[[Image:AccessI18NModule2.png|500px|thumb|left|Internationalization module]]
-|}
-== Translate user interface ==
-{| border="0" cellpadding="2"
-|- valign="top"
-|width="600" |
-. Make sure you have selected in the <span class="menu">LanguageMenuBar</span> the language into which you are translating.
-. 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.
-. Click one of the links. ICA-AtoM routes you to the target page; the <span class="menu">TranslationBar</span> appears along the bottom of the screen.
-. Click the <span class="button">TranslateUserInterface</span> button on the <span class="menu">TranslationBar</span>.
-. 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.
-. Select an element for translation; ICA-AtoM bolds the selected element.
-. Add / edit the translation in column 3.
-. 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.
-. When translation is complete, click or tab out of column 3; the element will now appear in column 1 unshaded.
-. Continue until all elements on the page have been translated.
-. 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.
-. Return to the <span class="button">Translate > User interface</span> tab and repeat for all links on this screen.
-|width="500" align="right"|
-[[Image:TranslateInterface1.png|500px|thumb|left|Links organized by module]]
-[[Image:TranslateInterface2.png|500px|thumb|left|Open translation panel]]
-[[Image:TranslateInterface3.png|500px|thumb|left|Translate elements]]
-|}
-=== Symfony tokens ===
-The names of some user interface element include "tokens".
-*A token is a variable whose value is determined by dynamically by the context.
-*In ICA-AtoM's Symfony framework, a token is represented 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 information being handled in any given variable in any given context.
-The following list enumerates in English the elements whose name includes a tokens, the nature of the variable and the context in which it occurs.
-{| border="0.5" cellpadding="2"
-|- valign="top" align="left"
-!width="150" | Element name
-!width="150" | Variable
-!width="800" | Context
-|-
-| %1% profile
-| User's account name
-| Returns user's account name in the <span class="menu">SystemMenu</span> link; clicked by the user clicks to edit his or her user profile; appears on all screens.
-|-
-| add new %1%
-| Entity term
-| Returns the type of entity being viewed on the current screen (e.g. "archival description", "authority record"); appears as part of text on the <span class="button">AddNew</span> button on <span class="screen">Edit</span> screens.
-|-
-| list all %1%
-| Entity term
-| Returns the type of entity being viewed on the current screen (e.g. "archival description", "authority record"); appears as part of text on the <span class="button">ListAll</span> button on <span class="screen">Edit</span> screens.
-|-
-| edit %1%
-| Entity term
-| Returns the type of entity being viewed on the current screen (e.g. "archival description", "authority record"); appears as part of screen title on <span class="screen">Edit</span> screens.
-|-
-| list %1%
-| Entity term
-| Returns the type of entity being viewed on the current screen (e.g. "archival description", "authority record"); appears as part of screen title on <span class="screen">List</span> screens.
-|-
-| view %1%
-| Entity term
-| Returns the type of entity being viewed on the current screen (e.g. "archival description", "authority record"); appears as part of screen title on <span class="screen">View</span> screens.
-|}
-== Translate default content ==
-{| border="0" cellpadding="2"
-|- valign="top"
-|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".
-. Click the <span class="button">Translate > DefaultContent</span> sub-tab. This page provides links to all default content that requires translation, organized into three sections.
-*Static pages: pages whose content is always the same (e.g. Home page, About page); these are stored in the <span class="entity">Static page</span> table.
-*Taxonomies: names of controlled vocabularies that generate drop-down value lists throughout the system (e.g. "Levels of description"); these are stored in the <span class="entity">Taxonomy</span> table.
-*Terms: the values that make up the taxonomies (.e.g. in the "Level of description" taxonomy: "Fonds", "Sub-fonds", "Series", "Sub-series", "File", "Item"); these are stored in the <span class="entity">Term</span> table.
+*'''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|UM-5 Translate content/interface]]). The procedures on this page, however, are for the one-time translations that provide the application defaults.
-. To translate an element, click its name; it will expand into two columns.
+== Translation Instructions ==
+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.
-. The <span class="field">Source content</span> column shows the text in the original source language.
+Attached to the email you receive from the ICA-AtoM Community Manager are two files:
+) Home page text.rtf
+) 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
-. Enter the translation in the <span class="field">Translated content</span> column.
+) Atom-1.3RC1 XLIFF zip file
+Download the Atom-1.3RC1 zip file and extract the contents.
-. Click the <span class="button">Save</span> button.
+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 &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.
-. ICA-AtoM stores the translated value and collapses the element.
+After each &lt;source&gt; tag, there is a &lt;target&gt; tag where you will enter the translated text.
+In cases where a translation has already been contributed the &lt;target&gt; tag will be populated. For example:
-. Repeat until all elements have been translated.
+<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:
-. '''Note when translating static pages:''' the same html and css coding used in the original must also be used in the translation; the coding is visible in the <span class="field">Source content</span> column.
+<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.
-|width="500" align="right"|
+Continue translating each unit of translation. Remember to save your file often while you work.
-[[Image:TranslateDefaultContent1.png|500px|thumb|left|Select content]]
+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.
-[[Image:TranslateDefaultContent2.png|500px|thumb|left|Translate content]]
+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.