Difference between revisions of "Template:About/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Galobtter
(+text= and selfref)
blackwiki>Galobtter
(→‎TemplateData: +templatedata)
Line 86: Line 86:
 
"description": "Pass \"yes\" in this parameter to get wording appropriate for use at the top of a section.",
 
"description": "Pass \"yes\" in this parameter to get wording appropriate for use at the top of a section.",
 
"autovalue": "yes"
 
"autovalue": "yes"
}
+
},
 +
        "text": {
 +
"label": "Custom text",
 +
"type": "string",
 +
"description": "Text to be appended to the end."
 +
},
 
}
 
}
 
}
 
}

Revision as of 10:31, 31 March 2018

{{About}} is a commonly used hatnote template on Wikipedia, and should be placed at the top of an article, linking the reader to other articles with similar titles or concepts that they may have been seeking instead. The template has several formats, including:

  • {{About|Use1}}Script error: No such module "about".
  • {{About|Use1||Article2}}Script error: No such module "about".
  • {{About|Use1||Article2|and|Article3}}Script error: No such module "about".
  • {{About|Use1|Use2|Article2}}Script error: No such module "about".
  • {{About|Use1|Use2|Article2|and|Article3}}Script error: No such module "about".
  • {{About|Use1|Use2|Article2|other uses}}Script error: No such module "about".

Alternately, a section=yes parameter can be added to the {{About}} template for use at the top of a section. When using this parameter, the wording in the template changes to specify that it is being used in a section:

  • {{About|Use1|section=yes}}Script error: No such module "about".
  • {{About|Use1||Article2|section=yes}}Script error: No such module "about".
  • {{About|Use1|Use2|Article2|section=yes}}Script error: No such module "about".
  • {{About|Use1|Use2|Article2|and|Article3|section=yes}}Script error: No such module "about".
  • {{About|Use1|Use2|Article2|other uses|section=yes}}Script error: No such module "about".

A |text= option adds text to the end; note that this should be only used when truly necessary, and the other hatnote templates listed below don't suffice. This template also supports |selfref=.


For more options, find "{{About}}" in the text below.

For reference, see Wikipedia:hatnote and documentation below.

TemplateData

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 About

Syntax error in JSON.