Difference between revisions of "Template:MOS-TRANS/doc"

From blackwiki
Jump to navigation Jump to search
imported>TheDragonFire
(Documentation overhaul.)
imported>GreenComputer
(Update templatedata)
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
 
: {{tlx|MOS-TRANS}}
 
: {{tlx|MOS-TRANS}}
 
: or  
 
: or  
: {{tlx|MOS-TRANS|f|DS=no|Forum=no}}
+
: {{tlx|MOS-TRANS|f|ds=no|forum=no}}
  
 
=== Hardcoded versions ===
 
=== Hardcoded versions ===
  
: {{tlx|MOS-TW}} – equivalent to {{tlx|MOS-TRANS|f|Forum=no}}
+
: {{tlx|MOS-TW}} – equivalent to {{tlx|MOS-TRANS|f|forum=no}}
: {{tlx|MOS-TM}} – equivalent to {{tlx|MOS-TRANS|m|Forum=no}}
+
: {{tlx|MOS-TM}} – equivalent to {{tlx|MOS-TRANS|m|forum=no}}
: {{tlx|MOS-NB}} – equivalent to {{tlx|MOS-TRANS|nb|Forum=no}}
+
: {{tlx|MOS-NB}} – equivalent to {{tlx|MOS-TRANS|nb|forum=no}}
  
 
== Parameters ==
 
== Parameters ==
Line 22: Line 22:
 
"1": {
 
"1": {
 
"label": "Gender",
 
"label": "Gender",
"type": "string",
+
"type": "line",
 
"suggested": true,
 
"suggested": true,
 
"example": "f",
 
"example": "f",
Line 30: Line 30:
 
"label": "Contentious topics",
 
"label": "Contentious topics",
 
"description": "Additional topics that may produce heated discussions.",
 
"description": "Additional topics that may produce heated discussions.",
"type": "string"
+
"type": "line"
 
},
 
},
"Forum": {
+
"nocat": {
 +
"label": "Supress error",
 +
"description": "Don't error when used on a non-talk page.",
 +
"type": "boolean",
 +
"default": "false"
 +
},
 +
"small": {
 +
"label": "Small",
 +
"description": "Display the message in a small talk page box.",
 +
"type": "boolean",
 +
"default": "no"
 +
},
 +
"ds": {
 +
"aliases": [
 +
"DS"
 +
],
 +
"label": "Discretionary sanctions",
 +
"description": "Display the discretionary sanctions warning.",
 +
"type": "boolean",
 +
"default": "yes"
 +
},
 +
"forum": {
 +
"aliases": [
 +
"Forum"
 +
],
 +
"label": "Not a forum",
 
"description": "Display the {{Not a forum}} template.",
 
"description": "Display the {{Not a forum}} template.",
 
"type": "boolean",
 
"type": "boolean",
 
"default": "yes"
 
"default": "yes"
 
},
 
},
"nocat": {},
+
"they": {
"small": {},
+
"label": "Singular they",
"DS": {
+
"description": "Show a message about the usage of singular they.",
"description": "Display the discretionary sanctions warning.",
 
 
"type": "boolean",
 
"type": "boolean",
 
"default": "yes"
 
"default": "yes"
Line 48: Line 72:
 
"1",
 
"1",
 
"2",
 
"2",
"DS",
+
"ds",
"Forum",
+
"forum",
 +
"they",
 
"small",
 
"small",
 
"nocat"
 
"nocat"

Latest revision as of 02:29, 12 December 2020

Usage

{{MOS-TRANS}}
or
{{MOS-TRANS|f|ds=no|forum=no}}

Hardcoded versions

{{MOS-TW}} – equivalent to {{MOS-TRANS|f|forum=no}}
{{MOS-TM}} – equivalent to {{MOS-TRANS|m|forum=no}}
{{MOS-NB}} – equivalent to {{MOS-TRANS|nb|forum=no}}

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for MOS-TRANS

Manual of Style identity guideline talk-page warning.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Gender1

The self-designated gender of the article subject.

Example
f
Linesuggested
Contentious topics2

Additional topics that may produce heated discussions.

Lineoptional
Discretionary sanctionsds DS

Display the discretionary sanctions warning.

Default
yes
Booleanoptional
Not a forumforum Forum

Display the {{Not a forum}} template.

Default
yes
Booleanoptional
Singular theythey

Show a message about the usage of singular they.

Default
yes
Booleanoptional
Smallsmall

Display the message in a small talk page box.

Default
no
Booleanoptional
Supress errornocat

Don't error when used on a non-talk page.

Default
false
Booleanoptional