View source for Help:Multi-language Conventions

{{Info|Also see [[:Category:Languages]]!}}
__TOC__
== The Languages Template ==
'''Pages and categories''' which exist in multiple translations must have the {{Tl|Languages}} template at the '''bottom of the page'''. This allows users to see the user to see the translations that are available for that page. 

If you use multiple languages, the {{Tl|Languages}} template must be on '''every page in that language'''.

'''The English page contains:'''
<pre>
<!-- The content of the actual page is here. -->
<!-- The {{Languages}} template must be at the bottom of the page! -->
<!-- There should be NO empty lines after {{Languages}}  -->
{{Languages}}
</pre>

'''The translated page contains:'''
<pre>
<!-- The content of the actual page is here. -->
<!-- The {{Languages}} template must be at the bottom of the page! -->
<!-- There should be NO empty lines after {{Languages}}  -->
{{Languages|<name of English page>|<language code>}}
</pre>
For example [[[[Main Page/pt]]]] contains 
<pre>
{{Languages|Main Page|pt}}
</pre>
The English version of a page is always the main version of a page, with all other languages as sub-pages, named using the appropriate language code (see below).

== Naming conventions for translated pages ==
Translated pages need to follow the following naming conventions.
<pre><My Page Name>/<2 Letter Language Code></pre>
The two letter language code must be one of the codes shown in the [[Template:Languages#Supported languages|supported languages ]]table, for example  
{| border="1" cellpadding="5"
! Page Name || Language 
|-
| Main Page || [[:en:|English]]
|-
| Main Page'''/de''' || [[:de:|German]]
|-
| Main Page'''/es''' || [[:es:|Spanish]]
|-
| Main Page'''/fr''' || [[:fr:|French]]
|-
| Main Page'''/ja''' || [[:ja:|Japanese]]
|-
| Main Page'''/ko''' || [[:ko:|Korean]]
|-
| Main Page'''/pt''' || [[:pt:|Portuguese]]
|-
| Main Page'''/pt-br''' || [[:pt-br:|Brazilian Portuguese]]
|-
| Main Page'''/zh''' || [[:zh:|Chinese]]
|}
=== Examples ===
Examples of valid page names are:
<pre>[[Category:Xen/ja]]</pre>
<pre>[[Frontend_Driver/de]]</pre>
<pre>[[Archived/XCI Getting Started/pt]]</pre>
<pre>[[Template:Fmbox/doc/zh]]</pre>

== Languages Category==
Translated pages must be Categorized: they must contain a category of the form
<pre>[[Category:Languages/<Language code>]]</pre>
such that it is possible to find all pages of a specific language.
=== Examples ===
Examples of valid category names are:
<pre>[[Category:Languages/ja]]</pre>
<pre>[[Category:Languages/pt]]</pre>

== Links for translated pages ==
You have to be careful when linking to other pages. Say you want to link to
<pre>[[DomU_Install_with_Virt-Manager]]</pre>
If you use the page above, you will go to the '''English''' page. If you want to go to a '''translated page''', the link must look as follows
<pre>[[DomU_Install_with_Virt-Manager/<language code>]]</pre>
E.g.
<pre>[[DomU_Install_with_Virt-Manager/es]]</pre>
If you keep links to english documents in a translation, it is a good idea to use the following convention
<pre>[[DomU_Install_with_Virt-Manager]] (English)</pre>
such that people see, that the document is in English.

== Examples & Testing ==
=== Example Page ===
Note that it is important to follow the conventions as outlined here. If not followed, the language templates do not work properly and users will find it hard to find translated content.

'''Page Foo''' must contain
<pre>
{{Languages}}
</pre>

'''Page Foo/es''' must contain
<pre>
{{Languages|Foo|es}}
</pre>
The following notation also works
<pre>
[[Category:Languages/es]]
{{Languages|Foo|es}}
</pre>

=== Example Category ===
'''Page Category:Foo''' must contain
<pre>
{{Languages}}
</pre>

'''Page Category:Foo/es''' must contain
<pre>
[[Category:Languages/es]]
{{Languages|:Category:Foo}}
</pre>

=== Testing whether you have done OK ===
You should be able to see the following:
* A box called ''''Languages''' on the english and translated page (see bottom of [[Main_Page|Main Page]] as an example)
* A box called ''''Languages''' on the english and translated category
* The ''''Languages''' box should show: '''English''', '''The Language You added''', languages somebody else added. If it doesn't, you probably used the wrong language macro on the english page.
* Translated pages should be in the '''Language/<your language>''' category, e.g. '''Language/es'''. You should go to the category for your language and check whether all pages are in this category. 

= Language Policy =
[[Category:Languages]]
{{Xen:Language_policy}}

{{Languages}}