Module:English variant notice/doc: Difference between revisions

Revision as of 14:54, 20 February 2018

Latest revision as of 15:39, 9 July 2025

(20 intermediate revisions by 6 users not shown)

Line 1:

{{Modulehigh ratinguse|beta25000+}}

This module is for generating various english variant notice templates.

Automatically generates "variant" from title template that invokes it (e.g invoking from "Template:American English" gives "American English" as variant).

All templates using this support a {{para|Oxford}} parameter for oxford spelling and {{para|IUPAC}} automatically.

Module that will soon be used in English variant notices everywhere

<!--

== 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'''&nbsp;– custom text, set only 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

* '''nocat''' disables documentation if set to true

* '''size''' set the size of the image (example: {{para|size|60px}})

=== 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

| variant = Hiberno-English

}}

== See also ==

}}</includeonly>

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

[[Category:Module documentation pages]]

</noinclude>