Difference between revisions of "Template:Localize"

From Pathfinder Wiki
m
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<includeonly>{{#lst:Localization:All{{GetLangSuffix}}|{{{1|Phrase cannot be localized}}}}}
+
<includeonly>{{#vardefine:lang|{{#invoke:String|replace|{{{language|{{PAGELANGUAGE}}}}}|/||}}}}{{#iferror:{{#expr:{{{1}}}+0}}
−
</includeonly><noinclude>
+
  |{{#vardefine:result|{{#cargo_query:tables=Localizations_{{{2|All}}}
−
This template returns a localized version of a "canned" phrase that we use in the interfaces.  THe phrase is in the language of the page that invokes it, so if we call the template from
+
      |fields=text
−
<nowiki>[[</nowiki>some page<nowiki>[[</nowiki>some page]], we'd get the English version of the page, but if we call it from <nowiki>[[</nowiki>some page/es]], we would get the Spanish version of the phrase. 
+
      |where=id="{{{1}}}/{{#var:lang}}"
 +
      |format=template
 +
      |template=LocalizeOutputQuery
 +
      |named args=yes
 +
      |default=}}
 +
  }}
 +
  |{{#vardefine:result|{{{1}}}}}
 +
}}{{#if:{{#var:result}}
 +
  |{{#var:result}}{{#cargo_store:_table=UsageOfLocalizations|uniqueID={{PAGEID}}/{{{1}}}/{{#var:lang}}|id={{{1}}}|locPage={{{2|All}}}|lang={{#var:lang}}}}
 +
  |{{#vardefine:localizationErrorCategories|{{#var:localizationErrorCategories}}[[Category:Missing Localization/{{{2|All}}}/{{{1|unsupplied}}}/{{#var:lang}}]]}}
 +
}}</includeonly><noinclude>
 +
{{#cargo_declare:_table=UsageOfLocalizations
 +
|uniqueID=String (mandatory;unique)
 +
|id=String (mandatory)
 +
|locPage=String (mandatory)
 +
|lang=String (mandatory)
 +
}}
  
−
Here is an example:
+
This template returns a localized version of a "canned" phrase that we use in the interfaces. The phrase is in the language of the page that invokes it, so if we call the template from
−
<nowiki>{{</nowiki>Localize|Overview}}
+
<nowiki>[[</nowiki>some page<nowiki>[[</nowiki>some page]], we'd get the English version of the page, but if we call it from <nowiki>[[</nowiki>some page/es]], we would get the Spanish version of the phrase.
  
−
{{Localize|Overview}}
+
The template can also take a second argument to specify a different page in the Localization namespace. If omitted, the template defaults to searching [[:Localization:All]]. We may wish to use additional pages for things like honors, or the names of honor variants.
  
 +
If no localization can be found (unless the argument is a number), the invoking page is added to a Category:Missing_Localization/''page''/''key''/''language''. This category is saved in a variable called '''localizationErrorCategories'''. This variable can be printed to the page by calling the Template [[Template:PrintLocalizationErrors]] at the end of the page.
 +
In case of a missing localization the template will return an empty string, in other words, nothing.
 +
 +
We don't throw an error on a numeric argument so that we can pass in a year - sometimes the year is a number, and sometimes it's "Unknown". We want to localize "Unknown" but pass the number through instead of returning a blank string.
 +
 +
Here are some examples:
 +
<nowiki>{{</nowiki>Localize|2021}} &rarr; {{Localize|2021}}
 +
 +
<nowiki>{{</nowiki>Localize|Answer Key}} &rarr; {{Localize|Answer Key}}
 +
 +
<nowiki>{{</nowiki>Localize|Lorem ipsum}} &rarr; {{Localize|Lorem ipsum}}
 +
 +
<nowiki>{{</nowiki>Localize|Switzerland|Countries|language=/es}} &rarr; {{Localize|Switzerland|Countries|language=/es}}
 +
 +
<nowiki>{{</nowiki>Localize|Switzerland|Countries|language=es}} &rarr; {{Localize|Switzerland|Countries|language=es}}
 +
 +
{{PrintLocalizationErrors}}
 +
 +
[[Category:Localization Templates]]
 
</noinclude>
 
</noinclude>

Latest revision as of 00:24, 29 July 2022

This template defines the table "UsageOfLocalizations". View table.

This template returns a localized version of a "canned" phrase that we use in the interfaces. The phrase is in the language of the page that invokes it, so if we call the template from [[some page[[some page]], we'd get the English version of the page, but if we call it from [[some page/es]], we would get the Spanish version of the phrase.

The template can also take a second argument to specify a different page in the Localization namespace. If omitted, the template defaults to searching Localization:All. We may wish to use additional pages for things like honors, or the names of honor variants.

If no localization can be found (unless the argument is a number), the invoking page is added to a Category:Missing_Localization/page/key/language. This category is saved in a variable called localizationErrorCategories. This variable can be printed to the page by calling the Template Template:PrintLocalizationErrors at the end of the page. In case of a missing localization the template will return an empty string, in other words, nothing.

We don't throw an error on a numeric argument so that we can pass in a year - sometimes the year is a number, and sometimes it's "Unknown". We want to localize "Unknown" but pass the number through instead of returning a blank string.

Here are some examples: {{Localize|2021}} → 2021

{{Localize|Answer Key}} → Answer Key

{{Localize|Lorem ipsum}} →

{{Localize|Switzerland|Countries|language=/es}} → Suiza

{{Localize|Switzerland|Countries|language=es}} → Suiza

Retrieved from "https://wiki.pathfindersonline.org/index.php?title=Template:Localize&oldid=579610"