Template:Expand section/doc

From LNF Wiki
Jump to navigation Jump to search

This is the {{Expand section}} message box.

It can be placed at the beginning of article sections that need expansion, after the section title. It can also be used on other pages such as in "LNF Wiki:" space. (This template currently only uses the "article message box" style, but that is a bug we are going to fix.)

This template can be used without any parameters, like this:

{{Expand section}}

It can also take the current month and year as a parameter, which is used in categorising the page into a corresponding category. (See more on that further.) Like this:

{{Expand section|date=August 2022}}

or

{{Expand section|{{subst:DATE}}}}

The date parameter causes no visible change in the message box itself, it only makes the page categorise properly.

This template can also take a |1= (a.k.a. |with= or |for=) parameter with an explanation of what expansion the section needs. And you can of course feed the date parameter at the same time. Like this:

{{Expand section|1=examples and additional citations|date=August 2022}}

When multiple expansion issues need to be raised, a bullet list can be made:

{{Expand section|1=<nowiki />
* Career from 1952 to 1960
* Final days after 1972 retirement
|{{subst:DATE}}}}

(The <nowiki /> is required or the first item may not display correctly.) If this list were longer than three items, it would probably be better raised on the talk page.

Categorisation

When this template is used in main (article) space it places the article in Category:Articles to be expanded or in a dated category like Category:Articles to be expanded from August 2022 if the date parameter "date=August 2022" is specified. It also places the article in Category:All articles needing cleanup.

Usage

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 Expand section

<templatedata> {

   "description": "Can be placed at the beginning of article sections that need expansion, after the section title.",
   "params": {
       "1": {
           "label": "reason",
           "description": "Reason the template was added, an explanation of what expansion the section needs. A bulleted list with lines beginning '*' can be given.",
           "type": "string",
           "required": false,
           "aliases": ["with","for"]
       },
       "talksection": {
           "label": "talksection",
           "description": "A section heading in the talk page where the issue is discussed.",
           "type": "string",
           "required": false,
           "aliases": ["discuss","talk"]
       },
       "date": {
           "label": "date",
           "description": "The month and year the template was added, e.g. 'August 2013'.",
           "type": "string",
           "required": false
       },
       "small": {
           "label": "small",
           "description": "By default the template will be displayed in a small size. This can be changed by setting small to no. Not recommended in articles.",
           "type": "string",
           "required": false
       }
   }

} </templatedata>

See also