Template:Vocabulary/doc

{{documentation subpage}}
== {{message|Function|anchor}} ==
Interprete given string into user's preference language, according to the site standard or an user specific dictionary.

== {{message|Usage|anchor}} ==
 <nowiki>{{</nowiki>{{PAGENAME}}
 | ''string''
 | dict = ''dictionary_name''
 | case = uc / lc / ucfirst / uf / lcfirst / lf
 | ''xx''   = ''synonym_id'' (Note: "''xx''" is the language code, e.g. de, fr, etc.)
 | term / conj / decl / infl / syno / alt
        = ''synonym_id''
 | lang = ''language_code''
 | anchor
 <nowiki>}}</nowiki>

== {{message|Parameters|anchor}} ==
{{Documentation paramlist/begin}}
{{Documentation paramlist
| name = 1 (''string'')
| desc = Original text normally in English.  If there is no translation for user's preference language, this text will be shown.
}}
{{Documentation paramlist
| name = dict 
| desc = Dictionary name. See [[Project:Vocabulary]] for detailed information.  If this parameter is blank, System messages in MediaWiki: namespace will be used instead of articles in Vocabulary: namespace.
| opt  = optional
}}
{{Documentation paramlist
| name = lang
| desc = Language code (only needs to be provided if the language displayed is to be fixed and independent of the user’s preferences). This option is usually only used for template debugging.
| def  = Value of <code><nowiki>{{int:Lang}}</nowiki></code> (the preferred language of the visitor viewing the page).
| opt  = optional
}}
{{Documentation paramlist
| name = case
| desc = Output case modifier.
| opt  = optional
}}
{{Documentation paramlist
| name = anchor
| desc = Produce the English anchor for section toc.
| opt  = optional
}}
{{Documentation paramlist/end}}

== {{message|Examples|anchor}} ==
=== Consult the standard dictionary ===
{| class="wikitable"
! {{message|Code}}
! {{message|Return value}}
! {{message|Description}}
|-
| <tt><nowiki>{{message|parameter}}</nowiki></tt>
| align="center" | {{message|parameter}}
| Interprete with the [[Vocabulary:Common|common]] dictionary.
|-
| <tt><nowiki>{{message|parameter|dict=demo}}</nowiki></tt>
| align="center" | {{message|parameter|dict=demo}}
| Interprete with the dictionary named "[[Vocabulary:Demo|demo]]."
|-
| <tt><nowiki>{{message|Parameter}}</nowiki></tt>
| align="center" | {{message|Parameter}}
| Convert first character to upper case after interpretation.
|-
| <tt><nowiki>{{message|parameter|case=uc}}</nowiki></tt>
| align="center" | {{message|parameter|case=uc}}
| Convert to upper case after interpretation.
|-
| <tt><nowiki>{{message|parameters}}</nowiki></tt>
| align="center" | {{message|parameter|de=pl}}
| Specify a homograph in German only.
|-
| <tt><nowiki>{{message|parameter|en=pl}}</nowiki></tt>
| align="center" | {{message|parameter|de=pl|fr=pl}}
| define language specific homograph.
|-
| <tt><nowiki>{{message|parameter|en=pl}}</nowiki></tt>
| align="center" | {{message|parameter|en=pl}}
| You may specify a homograph in English too.
|-
| <tt><nowiki>{{message|parameter|decl=pl}}</nowiki></tt>
| align="center" | {{message|parameter|decl=pl}}
| Specify homographs in all languages.
|-
| <tt><nowiki>{{message|parameter|conj=pl}}</nowiki></tt>
| align="center" | {{message|parameter|decl=pl}}
| You may use conj (= conjugation) option instead of decl (= declension) option.
|}

=== Translate messages in articles or templates ===

== {{message|See also|anchor}} ==
* [[Project:Vocabulary]]
* [[Template:Vocabulary/core]]
* [[Template:Vocabulary/anchor]]
* [[Template:Vocabulary/doc]]
* [[Template:Vocabulary/form]]
* [[Form:Vocabulary]]
* [[:Category:Documentation translate template subpages]]
__NOTOC__
[[Category:Documentation templates|Examples]]
<noinclude>

{{documentation debug}}
</noinclude>