Difference between revisions of "Module:English variant notice/doc"
Jump to navigation
Jump to search
blackwiki>Galobtter (→Usage: space) |
blackwiki>Galobtter (→Usage: +nodoc) |
||
| Line 17: | Line 17: | ||
* '''doc''' if set to no, will not load the automatic documentation at [[Template:English variant notice/documentation]] | * '''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 | * '''editnotice_cat''' if set to yes, categorizes in edit notice category | ||
| + | * '''nocat''' disables documentation if set to true | ||
| + | * '''doc''' if set to no, disables automatic documentation on template pages | ||
=== Example === | === Example === | ||
Revision as of 04:42, 3 April 2018
| 40x40px | This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
| 40px | This Lua module is used on 38,000+ pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
Module is for generatating 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).
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 (optional) – 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
- nocat disables documentation if set to true
- doc if set to no, disables automatic documentation on template pages
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:
| 50px | This module is written in Hiberno-English, which has its own spelling conventions (colour, realise, travelled), and some terms that are used in it may be different or absent from English, Scottish, and other varieties of English. According to the relevant style guide, this should not be changed without broad consensus. |
See also
- The {{Use X English}} templates