Template:Kbl10n

From Second Life Wiki
Revision as of 05:49, 8 May 2009 by Zai Lynch (talk | contribs) (adding temporary variable, to be removed again in a few weeks)
Jump to navigation Jump to search


This template is supposed to provide a language bar for Knowledge Base translations via Template:Kbl10n/ml, as well as an easy method to document already translated pages via Template:Kbl10n/table.

Setup

Please create subpages of this template with the name scheme: Template:Kbl10n/ENGLISH_KB_ID for each new localized KB article.

E.g.: Template:Kbl10n/5816

Syntax:

{{kbl10n
|en=ENGLISH-KB-ID
|en_title=ENGLISH-KB-TITLE (optional, for hovertext)
|en_note=
|en_up=
|de=GERMAN-KB-ID
|de_title=GERMAN-KB-TITLE (optional, for hovertext)
|de_jira=
|de_note=
|de_up=
|fr=FRENCH-WIKI-LINK
|fr_jira=
|fr_note=
|fr_up=
|ja=JAPANESE WIKI LINK
|ja_jira=
|ja_note=
|ja_up=
|mode={{{mode|view}}}
}}

The _jire variables can store the related Jira issue ID.

The _up variables can store the date when the last update of the article occured.

The _note variables can store additional notes.

It is not required to add info to all variables.

Please don't touch the |mode={{{mode|view}}} variable.

Example

{{kbl10n
|en=5816
|en_title=Xstreet Merchants and Shoppers FAQs
|en_up=20/1/2009
|de=5830
|de_title=Häufig gestellte Fragen von Xstreet-Händlern und Kunden
|de_jira=CT-146
|de_up=23/1/2009
|fr=FAQ Vendeurs Acheteurs Xstreet (KB)
|fr_jira=CT-159
|ja=Xstreetで商品を販売購入するためのFAQ (KB)
|ja_jira=CT-160
|mode={{{mode|view}}}
}}

Inclusion

The subtemplates of this template can be included with {{kbl10n/KB-ID}} to add the language bar to the connected KB article. E.g. {{kbl10n/5816}} to FAQ Vendeurs Acheteurs Xstreet (KB) and Xstreetで商品を販売購入するためのFAQ (KB).

This will create a language bar looking like this:


Furthermore, they can be included in documentation pages in order to keep track of all currently published articles and their translations/roots. To use the template in a documentation page, enter {{kbl10n/KB-ID|mode=table}}. E.g. {{kbl10n/5816|mode=table}}.

This will create a table, looking like this:


Xstreet Merchants and Shoppers FAQs: Xstreet Merchants and Shoppers FAQs

Language Title Jira Last Update Note
English Merchants and Shoppers FAQs Xstreet Merchants and Shoppers FAQs   20/1/2009  
German Häufig gestellte Fragen von Xstreet-Händlern und Kunden CT-146 23/1/2009  
French FAQ Vendeurs Acheteurs Xstreet CT-159 27/1/2009  
Japanese Xstreetで商品を販売購入するためのFAQ CT-160 18/3/2009  

Linking

There are two problems with links in KB articles and this template is trying to solve them. These are:

  • finding translated versions of the articles where the KB article is linking to
  • finding translated articles which are linking to an english root rather than to a recently created translation

With Template:Kbl10n/Links, it can be specified to which KB articles an KB article is linking to. The template then provides the tables of all linked to articles and the link to the translated version can easily be picked from these tables. Furthermore - because of the fact that the tables contain links -, the ""what links here"-feature can be used to track which KB articles are linking to the new article.

Usage

Say, you'd like to translate an article with the Knowledge Base ID XXXX.

  • Create a new page at Template:Kbl10n/XXXX.
  • Write {{subst:kbl10n/subst}} as only content of the page and save it afterwards.
  • Edit the newly created page again. You'll notice that the content changed and that it now contains the standart setup of the templates described above.
  • Fill in the blanks (English issue ID, English article name, Jira IDs, ...)
  • In case the article contains links to other KB articles, specify them at the {{kbl10n/Links}} template as described in Template:Kbl10n/Links.
  • Save your edit.

Contact Zai Lynch when you run into any problems or got questions.

Related Articles