Module:English variant notice

Module documentation[view] [edit] [history] [purge]

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 |Oxford= parameter for oxford spelling and |IUPAC= automatically.

Usage

• small, form and including  – unnecessary to use in templates as grabbed when passed in from talk pages
• id – the HTML id used in editnotices; "editnotice" is automatically appended
• image – name of file to be used as an icon, without the File: prefix.
• variant – defaults to the template name; the variant of English, which should be a Wikipedia article.
• spelling examples –gives spelling examples in parentheses
• compare –comparison variants of english
• text – 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: |size=60px)

Example

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

{{#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
}}

which produces:

See also

• The {{Use X English}} templates

The above documentation is transcluded from Module:English variant notice/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

local p = {}
local mArguments
function p.main (frame)
	mArguments = require('Module:Arguments')
	local args = mArguments.getArgs(frame, {parentFirst = true})
	id, text, variant = args.id, args.text, args.variant
end