Module:English variant notice/doc: Difference between revisions

Revision as of 12:09, 11 March 2018

Revision as of 06:26, 31 March 2018

Line 2:

{{high use|20000+}}

Module is usedfor thegeneratating majorvarious english variant noticesnotice templates.

Automatically generates "variant" from title template that invokes it (e.g invoking from "Template:American English" gives "American English" as variant). If {{para|Editnotice_cat}} is set to yes then it categorizes in the edit notice category when it used as an edit notice.

<!--

== Usage ==

* '''small''','''form''', and '''including''' &nbsp;– unnecessary to use in templates as grabbed when passed in from talk pages

<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''function_name''}}</code>-->

* '''id'''&nbsp;– the HTML id used in editnotices; "editnotice" is automatically appended

* '''image'''&nbsp;– name of file to be used as an icon, without the File: prefix.

* '''variant'''&nbsp;– defaults to the template name; the variant of English, which should be a Wikipedia article.

* '''spelling examples'''&nbsp;–gives spelling examples in parentheses

* '''compare'''&nbsp;–comparison variants of english

* '''text''' ''(optional)''&nbsp;– custom text, if required to be different from the default.

* '''doc''' if set to no, will not load the automatic documentation at [[Template:English variant notice/documentation]]

* '''editnotice_cat''' if set to yes, categorizes in edit notice category

=== Example ===

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

As of March 2018, [[Template:Hiberno-English]] uses the following parameters:

<!-- Categories below this line, please; interwikis at Wikidata -->

<pre>{{#invoke:English variant notice|main

| id = hie

| image = Four Provinces Flag.svg{{!}}border

| spelling_examples = ''colour'', ''realise'', ''travelled''

| compare = [[British English|English]], [[Scottish English|Scottish]], and

}}

</pre>

which produces:

{{#invoke:English variant notice|main

| id = hie

| image = Four Provinces Flag.svg{{!}}border

| spelling_examples = ''colour'', ''realise'', ''travelled''

| compare = [[British English|English]], [[Scottish English|Scottish]], and

}}

== See also ==

}}</includeonly>

* The <nowiki>{{</nowiki>[[Template:Use X English|Use {{var|X}} English]]<nowiki>}}</nowiki> templates