Translating/HowTo: Difference between revisions

From OLPC
Jump to navigation Jump to search
(edit "Translation template notes: version")
(Removing all content from page)
Line 1: Line 1:
{{ Translations }}
{{l10n-nav}}
Translation is often a difficult and tedious task that requires much effort. The volatile nature of wiki adds further complications. However these complications can be overcome by following a few simple rules and using standardised work practices. It is hoped that this will allow anybody to collaborate in the [[translating]] effort and at the same time have fun in the process.

== Step-by-step ==

From the point-of-view of the wiki, there are basically three tasks to hook up a translated page:
# [[#Setting up the source page|modify the source page]] — if it has never been translated;
# [[#Modifying the language bar|adding a reference]] — point/link to the translation in a standard way; and
# [[#Setting up the translated page|conditioning the translated page]] — adding some helper structure.
Most of the time, [[translators]] will only deal with the last two steps (setting up and linking the translation).

You can see an overview of the [[#Anatomy of a wiki-page|relevant structure]] of a page, and a [[#Full finished example|full finished example]] towards the end of this page.

=== Setting up the source page ===

We'll assume that you want to translate a page that is maintained by the OLPC team; meaning that it will have a reference to the [[Template:OLPC|<nowiki>{{OLPC}}</nowiki>]] template&mdash;that groups pages in the [[:Category:Pages maintained by OLPC]]&mdash;and they frequently are the entry points or that contain information that may be more obviously helpful for the local communities.

If the page to translate already has a language bar, you can skip down to [[#Modifying the language bar]].

<div style="font-size:80%; ">
{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page]]</nowiki> !! <span style="font-size:80%">''(translated page does not exist&mdash;yet)''</span>

|- valign="top"
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|}
</div>

==== Adding the language bar ====

Although it is rare, it may be necessary to translate a page that nobody else has translated yet. In that case, a translations navigation bar must be added in the original page.

<div style="font-size:80%; ">
{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page]]</nowiki> !! <span style="font-size:80%">''(translated page does not exist&mdash;yet)''</span>

|- valign="top"
|
<nowiki>{{OLPC}}</nowiki>
'''<nowiki>{{Translations}}</nowiki>'''
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|}
</div>

==== Setting up the /translations ====

{{ Translated text |

You should follow the <tt><nowiki>[[Original page/translations]]</nowiki></tt> link in order to edit the page that groups the translations of a particular page, and should look something like this:

| display = none }}

To edit the page that groups the translations of a particular page, follow the ''<nowiki>[[Original page/translations]]</nowiki>'' link. It should look something like the following:

<div style="font-size:80%; ">
{| cellspacing=0

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page/translations]]</nowiki>

|- valign="top"
|
<nowiki>[[Original page|english]] | [[</nowiki>Original page/lang-[[#lang|xx]]|[[#language name|shortNativeName]]<nowiki>]]</nowiki>
|}
</div>

The resulting page will have a red colored link, denoting a missing/broken link to your future translation. Don't worry, you'll fix that in the next step.

{{ Translated text |

'''NOTE:''' Although you could give any name to the translated page (ie: instead of "<tt>[[The OLPC Wiki/lang-es]]</tt>" you could do "<tt>[[El Wiki de la OLPC]]</tt>"). As a matter of fact, there are quite some pages that follow that structure, but most of them are either left overs from when there wasn't a clear structure and way for adding translations. As mentioned in the [[translating]] pages, there are advantages to sticking with the <tt>/lang-[[#lang|xx]]</tt> structure, particularly because you can always create a <tt><nowiki>#REDIRECT</nowiki></tt> in the native language to your translated version.

| display = none }}

'''NOTE''': Although any name can be give to the translated page (ie: instead of "''[[The OLPC Wiki/lang-es]]''" it could be named as "''[[El Wiki de la OLPC]]''"), there is a clear advantage in sticking with the ''/lang-[[#lang|xx]]'' structure. The ''/lang-[[#lang|xx]]'' method allows a creation of ''<nowiki>#REDIRECT</nowiki>'' in the native language of the version by the translator. Pages that do not use the ''/lang-[[#lang|xx]]'' structure do exit. Often these are leftovers from the times when there was no consensus on the structure and ways of adding translations.


=== Modifying the language bar ===

Below is an example of a typical language bar. The page that may need translation would have a link shown as <tt>'''+/-'''</tt> to the far right of the bar. (Not shown on this example.) This is a link to the editing page for the language bar. To create a link, for example when adding a new language on the language bar, follow this <tt>'''+/-'''</tt> link to go to the editing page. Then add the appropriate code for the new language.
<div style="font-size:80%; margin-left:10%; margin-right:10%; ">
{{Translations | {{:Bitfrost/translations}}}}
</div>
When inserting the link to your page, please keep things in alphabetical order denoted by the <tt>/lang-[[#lang|xx]]</tt> sequence (if you're adding say <tt>/lang-de</tt> it should go before the link to 'english'). Also, note the spaces around the '|' that separate each language. See [[#Setting up the /translations|above on <tt>/translations</tt>]] for more info.

=== Setting up the translated page ===

Although the translator is given as much freedom to edit and to translate as possible when translating the wiki, there is one rule that must be adhered to at all times. The translated page must be declared as a [[Template:Translation|<nowiki>{{Translation}}</nowiki>]]. (Please note the use of "singular". Plural is for the original page and it will have many translations.)

There are couple of other bits of advice that may improve the quality of the translation process. First, please keep navigation and linking within the translated pages simple and easy to follow. Secondly, preserving the original text in the translation may simplify peer review and help with maintenance.

The quickest way to set up a page is by going back to the
original page, then copying the '''wiki-text'''. This can be done either by following the ''edit'' link or through ''view source'' if the page is protected. Then copy the whole page and paste it onto the new page.

==== Adding the [[Template:Translation|Translation template]] ====

<div style="font-size:80%; ">
{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page]]</nowiki> !! <nowiki>[[</nowiki>Original page/lang-[[#lang|xx]]<nowiki>]]</nowiki><span style="font-size:80%"><br>''(translated page name)''</span>

|- valign="top"
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{Translations}}</nowiki>
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|
<nowiki>{{OLPC}}</nowiki>
'''<nowiki>{{</nowiki>Translation'''
'''&#124; lang = [[#lang|xx]]'''
'''&#124; source = [[#source|Original page]]'''
'''&#124; version = [[#version|yyyy]]<nowiki>}}</nowiki>'''
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|}
</div>
For a full explanation of the parameters, see the [[#Notes|Notes]] below, in short:
'''lang''' &mdash; is the [http://www.iana.org/assignments/language-subtag-registry IANA language code] (usually 2 letters, without any further segmentation&mdash;ie: instead of ''<tt>lang-pt-BR</tt>'' (brazilian portuguese), just ''<tt>lang-pt</tt>'' (portuguese)&mdash;just to keep things simple and neutral.

==== Adding the [[Template:Ongoing Translation|Ongoing Translation template]] ====

<div style="font-size:80%; ">
{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page]]</nowiki> !! <nowiki>[[</nowiki>Original page/lang-[[#lang|xx]]<nowiki>]]</nowiki><span style="font-size:80%"><br>''(translated page name)''</span>

|- valign="top"
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{Translations}}</nowiki>
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{</nowiki>Translation
&#124; lang = [[#lang|xx]]
&#124; source = [[#source|Original page]]
&#124; version = [[#version|yyyy]]<nowiki>}}</nowiki>
'''<nowiki>{{</nowiki>Ongoing Translation<nowiki>}}</nowiki>'''
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|}
</div>
The main purpose of the [[Template:Ongoing Translation|<nowiki>{{Ongoing Translation}}</nowiki>]] template is to inform the readers that a particular page is still not finished, therefore they can expect the presence of untranslated text or that it hasn't been reviewed enough and thus may not be quite done yet. Parallel to that notice to the reader, it does a grouping of them in the [[:Category:Ongoing Translation|Ongoing Translation category]] thus allowing other translators to find them and collaborate, review, make comments, etc. on them.

==== Translating section headers ====

When translating section headers, the best practice is to preserve them as anchors. Then add the translated header under it.

For example if the section header is called "Some Section Header" and it is translated into German in the form of "Einige Paragraph Kopfzeile". Original text "Some Section Header" is preserved by wrapping it between curly braces like the following:

<nowiki>{{anchor|Some Section Header}}</nowiki>

Then the translated text "Einige Paragraph Kopfzeile" is placed under it. Together it will look like the following when finished:

<nowiki> {{anchor|Some Section Header}} </nowiki><br>
<nowiki> == Einige Paragraph Kopfzeile == </nowiki><br>

<div style="font-size:80%; ">
{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page]]</nowiki> !! <nowiki>[[</nowiki>Original page/lang-[[#lang|xx]]<nowiki>]]</nowiki><span style="font-size:80%"><br>''(translated page name)''</span>

|- valign="top"
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{Translations}}</nowiki>
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{</nowiki>Translation
&#124; lang = [[#lang|xx]]
&#124; source = [[#source|Original page]]
&#124; version = [[#version|yyyy]]<nowiki>}}</nowiki>
<nowiki>{{</nowiki>Ongoing Translation<nowiki>}}</nowiki>
'''<nowiki>{{anchor|Some header}}</nowiki>'''
<nowiki>== Un titular ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
'''<nowiki>{{anchor|Another header}}</nowiki>'''
<nowiki>== Otro titular ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|}
</div>

==== Translating links ====

When translating links, the original text is preserved by using what is called "piped links". By placing the symbol "|" between original text and the translated text, both become connected together through a pipe. For example if "some-link" is to be translated into German as "einige-link", it will end up looking like the following:

<nowiki>[[some-link|einige-link]]</nowiki>

As a result, following "einige-like" will connect to "some-link". The reader will only see the translated link "einige-link".

==== Linking to a page in particular language ====

When linking to a translated page in a particular language use the /lang-xx to point to that particular translation.

<nowiki>[[some-link/lang-de|einige-link]]</nowiki>

==== Translating texts ====
When translating text, it is useful to preserve original text by wrapping them inside [[Template:Translated_text|<nowiki>{{Translated text}}</nowiki>]] function. "display = ''value''" parameter
can be used to control whether the original text is visible to the
reader or not.

Original text invisible to reader (display = none).
<nowiki>
{{ Translated text |
original text
more original text
yet more original text
final original text
| display = none }}
</nowiki>


Original text visible to reader (display = block).
<nowiki>
{{ Translated text |
original text
more original text
yet more original text
final original text
| display = block }}
</nowiki>

Please see [[Template:Translated_text|here]] for more information.


<div style="font-size:80%; ">
{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page]]</nowiki> !! <nowiki>[[</nowiki>Original page/lang-[[#lang|xx]]<nowiki>]]</nowiki><span style="font-size:80%"><br>''(translated page name)''</span>

|- valign="top"
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{Translations}}</nowiki>
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{</nowiki>Translation
&#124; lang = [[#lang|xx]]
&#124; source = [[#source|Original page]]
&#124; version = [[#version|yyyy]]<nowiki>}}</nowiki>
<nowiki>{{</nowiki>Ongoing Translation<nowiki>}}</nowiki>
<nowiki>{{anchor|Some header}}</nowiki>
<nowiki>== Un titular ==</nowiki>
Algo de texto bla... <br>bla... '''<nowiki>[[</nowiki>#Another header|Otro titular<nowiki>]]</nowiki>''' <br>... blah
'''<nowiki>{{ Translated text |</nowiki>'''
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
'''&#124; display = [[#display|block]]<nowiki>}}</nowiki>'''
<nowiki>{{anchor|Another header}}</nowiki>
<nowiki>== Otro titular ==</nowiki>
Algo más de texto bla... <br>bla... <nowiki>[[</nowiki>Another page'''/lang-[[#lang|xx]]|Otra página'''<nowiki>]]</nowiki> <br>y <nowiki>[[</nowiki>Another page'''/lang-[[#lang|xx]]#section|sección'''<nowiki>]]</nowiki> <br>... bla
'''<nowiki>{{ Translated text |</nowiki>'''
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
'''&#124; display = [[#display|block]]<nowiki>}}</nowiki>'''
|}
</div>

{{ Translated text|
==== Handling missing translated links ====
| display = none }}

==== Handling translated links that point to a non-existant page ====

At the beginning, any link you 'translate' will most likely point to a non-existing page, don't worry. There are two alternatives:
* let the wiki handle them through [[Special:Wantedpages]]
* make one last translating effort: dedicated redirects
The first alternative is the simplest but also the hardest on the reader (lands them on the 'create page option' which is hardly the best alternative). Another downside, is that it'll be hard to detect those 'wanted pages' for a specific language, as they will be in the same list as all other 'missing translated pages' in other languages ''plus'' all the ''naturally missing pages in the wiki'' (a long list due to historical reasons).

The second, recommended alternative, is to create a redirect of the <tt><nowiki>[[</nowiki>Foo/lang-[[#lang|xx]]<nowiki>]]</nowiki></tt> to just <tt><nowiki>[[Foo]]</nowiki></tt> and categorizing the redirect in a dedicated category specific to the language:

<div style="font-size:80%; ">
{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[</nowiki>Another page/lang-[[#lang|xx]]<nowiki>]]</nowiki>

|- valign="top"
|
<nowiki>#REDIRECT [[Another page]]</nowiki>
<nowiki>[[</nowiki>Category:Translations wanted lang-[[#lang|xx]]<nowiki>]]</nowiki>
|}
</div>
; WARNING : Make '''sure''' that the original page is '''not''' linking to a '''REDIRECT'''. If that is the case, you should change the target to the ''real page and create there the <tt>/lang-[[#lang|xx]]</tt> subpage''. For example, if the <tt><nowiki>[[Foo]]</nowiki></tt> actually is a redirect to <tt><nowiki>[[Bar]]</nowiki></tt>, then you should create the '''<tt><nowiki>[[</nowiki>Bar/lang-[[#lang|xx]]<nowiki>]]</nowiki></tt>''' instead of <tt><nowiki>[[</nowiki>Foo/lang-[[#lang|xx]]<nowiki>]]</nowiki></tt> and change the referencing link accordingly.

This will serve three purposes, first the page will at least take the reader to the right page (albeit not in the correct language). Secondly, the ''Category'' will allow a simple way to check 'what is missing'. Finally, and using the ''What links here'' from the '''toolbox''' you can find out how many references to the missing page exist, giving some sense of ''need'' for it and thus guiding the translating efforts.

'''Please do NOT add''' these ''fake translation redirects'' to the <tt>/translations</tt> page, as it doesn't make sense to advertise a translation that doesn't yet exist. Only when the REDIRECT is made into a real translation (ongoing or otherwise) add the link to the language navigation page.

== Full example of a wiki-page ==

=== Anatomy of a wiki-page ===

<div style="font-size:80%; ">
{|
|+ This 'sample' page includes all of the elements that require some level of consideration when translating

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page]]</nowiki> !! Notes on the structure

|- valign="top"
|
<nowiki>{{OLPC}}</nowiki>
'''<nowiki>== Some header ==</nowiki>'''
Some text blah... <br>blah... '''<nowiki>[[#Another header]]</nowiki>''' <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... '''<nowiki>[[Another page]]</nowiki>''' <br>and '''<nowiki>[[Another page#section|section]]</nowiki>''' <br>... blah
| <br>
; <tt><nowiki>== Some header ==</nowiki></tt> : section headers act as anchors, and their translation is sensitive as they ''anchor'' incomming links.
; <tt><nowiki>[[#Another header]]</nowiki></tt> : intra-page section linking may be simple to maintain as it's within the same page (you can search&replace local references) but will break external inbound links if changed.
; <tt><nowiki>[[Another page]]</nowiki></tt> : the most common problem with links to other pages is to know how the page title has been translated...
; <tt><nowiki>[[Another page#section|section]]</nowiki></tt> : links to specific sections in other pages pose the conflated problem of knowing ''both'' the target page name '''and''' the section name's translations.
|}
</div>

=== Full finished example ===
<div style="font-size:80%; ">
{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page]]</nowiki> !! <nowiki>[[</nowiki>Original page/lang-[[#lang|xx]]<nowiki>]]</nowiki><span style="font-size:80%"><br>''(translated page name)''</span> !! Translated text deleted...<span style="font-size:80%"><br>''(not really recommended)''</span>

|- valign="top"
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{Translations}}</nowiki>
<nowiki>== Some header ==</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
<nowiki>== Another header ==</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{</nowiki>Translation
&#124; lang = [[#lang|xx]]
&#124; source = [[#source|Original page]]
&#124; version = [[#version|yyyy]]<nowiki>}}</nowiki>
<nowiki>{{</nowiki>Ongoing Translation<nowiki>}}</nowiki>
<nowiki>{{anchor|Some header}}</nowiki>
<nowiki>== Un titular ==</nowiki>
Algo de texto bla... <br>bla... <nowiki>[[#Another header|Otro titular]]</nowiki> <br>... blah
<nowiki>{{ Translated text |</nowiki>
Some text blah... <br>blah... <nowiki>[[#Another header]]</nowiki> <br>... blah
&#124; display = [[#display|block]]<nowiki>}}</nowiki>
<nowiki>{{anchor|Another header}}</nowiki>
<nowiki>== Otro titular ==</nowiki>
Algo más de texto bla... <br>bla... <nowiki>[[</nowiki>Another page/lang-[[#lang|xx]]|Otra página<nowiki>]]</nowiki> <br>y <nowiki>[[</nowiki>Another page/lang-[[#lang|xx]]#section|sección<nowiki>]]</nowiki> <br>... bla
<nowiki>{{ Translated text |</nowiki>
Some other text blah... <br>blah... <nowiki>[[Another page]]</nowiki> <br>and <nowiki>[[Another page#section|section]]</nowiki> <br>... blah
&#124; display = [[#display|block]]<nowiki>}}</nowiki>
|
<nowiki>{{OLPC}}</nowiki>
<nowiki>{{</nowiki>Translation
&#124; lang = [[#lang|xx]]
&#124; source = [[#source|Original page]]
&#124; version = [[#version|yyyy]]<nowiki>}}</nowiki>
<nowiki>{{anchor|Some header}}</nowiki>
<nowiki>== Un titular ==</nowiki>
Algo de texto bla... <br>bla... <nowiki>[[#Another header|Otro titular]]</nowiki> <br>... blah
<nowiki>{{anchor|Another header}}</nowiki>
<nowiki>== Otro titular ==</nowiki>
Algo más de texto bla... <br>bla... <nowiki>[[</nowiki>Another page/lang-[[#lang|xx]]|Otra página<nowiki>]]</nowiki> <br>y <nowiki>[[</nowiki>Another page/lang-[[#lang|xx]]#section|sección<nowiki>]]</nowiki> <br>... bla
|}
</div>

Supporting pages:

<div style="font-size:80%; ">
{| cellspacing=0

|- valign="top" style="background:lightgray; "
! <nowiki>[[Original page/translations]]</nowiki>

|- valign="top"
|
<nowiki>[[Original page|english]] | [[</nowiki>Original page/lang-[[#lang|xx]]|[[#language name|shortNativeName]]<nowiki>]]</nowiki>
|}

{|

|- valign="top" style="background:lightgray; "
! <nowiki>[[</nowiki>Another page/lang-[[#lang|xx]]<nowiki>]]</nowiki>
! <nowiki>[[Another page]]</nowiki>

|- valign="top"
|
<nowiki>#REDIRECT [[Another page]]</nowiki>
<nowiki>[[Category:Missing translation]]</nowiki>
|
''some untranslated page...''
''maybe the content is mutating rapidly,''
''or is peripheric to the main corpus, etc.''
|}
</div>

== Notes ==

{{anchor|language name}}
; shortNativeName : should be in the native language; <tt>español</tt> instead of <tt>spanish</tt>.

=== [[Template:Translation|Translation template]] notes ===

For the full documentation, please see [[Template:Translation]].

{{anchor|lang}}
; lang : This parameter identifies the target language of the translation. See [[ISO 639]] for a select list of codes being used in the wiki. (Another source is [http://www.iana.org/assignments/language-subtag-registry IANA's lang codes]).
: It serves several purposes, and is used in several contexts although it should be done in a homogeneous way.
: '''We are currently using [[ISO 639-1]] codes (two-letter codes)'''.

{{anchor|source}}
; source : is the name of the page (not the link&mdash;in other words, without the enclosing square brackets).

{{anchor|version}}
<!--
; version : is a bit of a tricky until you understand it, but extremely helpful.
: The number associated with the parameter comes from the '''original''' page, and has been made explicit in the blue language navigation bar at its right: <tt>'''[ID# ''yyyyy'']'''</tt>.
: Pages in the wiki have a ''numeric id'', and each edition creates a new ID. So when you start translating a page, you want to register which ''version'' you started from. When at some point the source page is modified, its current version will have a higher version number. If you follow the ''changes'' link in the translation blue bar, the system will report all the changes done in that page from the ID# you started from. Once you update the translation, '''do not forget to update''' the version # to match the latest sync'ed to number!
: So when you compare the differences between two pages, internally you are comparing two IDs between them.
: For example [http://wiki.laptop.org/index.php?title=Template%3ATranslation&diff=35092&oldid=39128 this diff] is actually comparing two pages, NOT two versions of the same page&mdash;admitedly, they are very similar.
-->

; version : Each original page has a unique version number. These version numbers appear on the far right of the 'blue language navigation bar', and appear in the form: <nowiki>[</nowiki>ID# yyyyy<nowiki>]</nowiki>

: When a page edit is submitted, the version number for that particular page is incremented.

: A translated page on the other hand does not have a visible version number on its own. It must be manually assigned by the translator when an edit is submitted. The version number of a translated page is the same as the version number of the original page which it is based on.

: For example if the original page has a version number ID<nowiki>#</nowiki> 54321, and the translatation is based on this particular version, the translated page is given the version number ID<nowiki>#</nowiki> 54321.

: The version number for the translated page is entered at the top of the page as a parameter for the [[Template:Translation|<nowiki>{{</nowiki>Translation<nowiki>}}</nowiki>]] function.

: <nowiki>{{</nowiki> Translation
:: | lang = de
:: | source = Translating/HowTo
:: | '''version = 54321''' <nowiki>}}</nowiki>

: There is one use which results directly from the above manual assignment of a version number to the translated page. It allows the translator to easily lookup what new translations are needed by following the 'changes' link located to the far right of the 'blue language navigation bar'.

: Suppose translator 'A' is making a translation of page [[Bitfrost]] with version number ID# 65535 into español. As per this guide, translator 'A' assigns version number ID# 65535 to the Bitfrost/lang-es español translated page. Meanwhile editor 'B' arrives and edits the original [[Bitfrost]] page and its version number is incremented to ID# 6553'''6'''. Translator 'A' then can see what new translations are necessary by followoing the 'changes' link located on the blue nav bar. The 'changes' link compares the differences of two versions of the original page ID# 6553'''5''' and ID# 6553'''6'''. By observing the resulting output, translator 'A' could easily see what new text needs to be translated.

=== [[Template:Translated text|Translated text]] template notes ===

{{anchor|display}}
; display : is used to show or hide the enclosed translated text.
: While doing the translation, it comes in handy for comparing the original with the translation. When finished, you can replace the ''block'' with ''none'' and the source text is not displayed. Although it adds quite a bit of text and 'noise' to the source of the translated page, it comes in handy when trying to update or synchronize it with any changes in the original page&mdash;after all, this IS a wiki and pages are supposed to mutate!

[[Category:Language support]]
[[Category:HowTo]]

Revision as of 13:12, 25 November 2007

Retrieved from "http://wiki.laptop.org/mediawiki/index.php?title=Translating/HowTo&oldid=79998"