Difference between revisions of "Template:Expand section/doc"

From blackwiki
Jump to navigation Jump to search
imported>Andy M. Wang
(30K+)
imported>Geekdiva
(Misc copy and readability edits. Added and renamed headers. Expanded one section.)
Line 2: Line 2:
 
{{high-use|31100+}}
 
{{high-use|31100+}}
  
This is the {{Tlx|Expand section}} message box.
+
This is the {{Tlx|Expand section}} message box template.  
  
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 "Wikipedia:" space. (This template currently only uses the "article message box" style, but that is a bug we are going to fix.)
+
==Usage==
 +
Place this template at the beginning of article sections that need expansion, ''after'' that section's title. You can use this template in the Main/Article [[WP:Namespace|namespace]], and also on other pages such as those in the Wikipedia namespace (which uses the Wikipedia: prefix; for example, [[Wikipedia:Glossary]] is in the Wikipedia namespace).  
  
This template can be used without any parameters, like this:
+
{{As of |2016|August}}, this template only uses the "article message box" style, but this will be fixed in the future.
 +
 
 +
You can use this template without any parameters:
  
 
:{{Tlx|Expand section}}
 
:{{Tlx|Expand section}}
Line 12: Line 15:
 
{{Expand section}}
 
{{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:
+
You can also use the current month and year as a parameter, which adds the page to a template-related category's sub-category sorted by time:
  
 
:{{Tlx|Expand section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
 
:{{Tlx|Expand section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
Line 22: Line 25:
 
{{Expand section|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
 
{{Expand section|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
  
There are [[Wikipedia:Bot policy|bots]] that edit the pages and add the '''date''' parameter if you forget to do it. The date parameter helps make the page categorise properly.
+
See [[#Categorisation|§ Categorisation]] for more information.  
  
This template can also take a {{para|1}} (a.k.a. {{para|with}} or {{para|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:
+
There are [[Wikipedia:Bot policy|bots]] that edit the pages and add the <code>date=</code> parameter if you forget to do it.
 +
 
 +
You can add a {{para|1}} (a.k.a. {{para|with}} or {{para|for}}) parameter with an explanation of what expansion the section needs, and you can of course use the date parameter at the same time:
  
 
:{{Tlx|Expand section|1{{=}}examples and additional citations|3=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
 
:{{Tlx|Expand section|1{{=}}examples and additional citations|3=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
Line 30: Line 35:
 
{{Expand section|1=examples and additional citations|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
 
{{Expand section|1=examples and additional citations|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}
  
When multiple expansion issues need to be raised, a bullet list can be made:
+
When you need to raise multiple yet simply explanable expansion issues, you can make a bullet list within the template:
  
 
:{{Tlx|Expand section|1{{=}}&lt;nowiki /&gt;<br />* Career from 1952 to 1960 <br />* Final days after 1972 retirement <br />
 
:{{Tlx|Expand section|1{{=}}&lt;nowiki /&gt;<br />* Career from 1952 to 1960 <br />* Final days after 1972 retirement <br />
Line 40: Line 45:
 
|date=February 2012}}
 
|date=February 2012}}
  
(The <code>&lt;nowiki /&gt;</code> 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.
+
(The <code>&lt;nowiki /&gt;</code> is required or the first item may not display correctly.)  
 +
 
 +
However, if you want to raise more than a few simple points, your issues would better be raised in a new section of the [[WP:Talk page|talk page]].
  
 
== Categorisation ==
 
== 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 {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]] if the date parameter "date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}" is specified. It also places the article in [[:Category:All articles to be expanded]].
+
When this template is used in the Main/Article [[WP:Namespace|namespace]], it places the article in [[:Category:Articles to be expanded]] or in a dated category like [[:Category:Articles to be expanded from {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]] if the date parameter "date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}" is specified.  
 +
 
 +
It also places the article in [[:Category:All articles to be expanded]].
 +
 
 +
== Choosing the right template ==
 +
 
 +
=== For an empty section ===
 +
If the section is completely empty, you should use {{Tlx|Empty section}} instead.
 +
 
 +
The exception would be an empty section used for references, as explained in the following section.
 +
 
 +
=== For  section for references (aka footnotes) and sources ===
 +
When the section you think needs expansion is a section for citing sources, use either {{Tlx|No footnotes}} or {{Tlx|More footnotes}} instead of {{Tlx|Empty section}} or {{Tlx|Expand section}}.
 +
 
 +
'''Note:''' Unlike the other templates mentioned, these footnote/reference templates should go at the top of the page, rather than the top of the section.
 +
 
 +
In the Main/Article namespace, [[WP:Citing sources|citing sources]] is an important part of the article, done using the tags, <nowiki><ref></ref></nowiki>, which in turn are collected and formatted into text in the section containing {{Tlx|Reflist}} or <nowiki><references /></nowiki>. This section (or sub-section, as might be done if the sources are listed separately) is most often named References, but can have other names.
  
== Usage ==
+
If the article has a section that contains either {{Tlx|Reflist}} or <nowiki><references /></nowiki>, ''the section can still appear blank'' on the saved, rendered page if the article has no text within <nowiki><ref></ref></nowiki> tags. Such a section is still considered blank, even though the template or tag wikitext can be seen in Edit mode, so use {{Tlx|No footnotes}}.  
* If the section is completely empty, you should use {{Tlx|Empty section}} instead.
 
* For the references section, use one of {{Tlx|No footnotes}} and {{Tlx|More footnotes}} instead.
 
  
 
==TemplateData==
 
==TemplateData==
Line 86: Line 107:
  
 
== See also ==
 
== See also ==
* {{Tlx|Expand section}}
+
* {{Tlx|Clarify}}
 
* {{Tlx|Expand list}}
 
* {{Tlx|Expand list}}
 
* {{Tlx|Empty section}}
 
* {{Tlx|Empty section}}

Revision as of 21:18, 1 August 2016

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

Usage

Place this template at the beginning of article sections that need expansion, after that section's title. You can use this template in the Main/Article namespace, and also on other pages such as those in the Wikipedia namespace (which uses the Wikipedia: prefix; for example, Wikipedia:Glossary is in the Wikipedia namespace).

As of August 2016, this template only uses the "article message box" style, but this will be fixed in the future.

You can use this template without any parameters:

{{Expand section}}

You can also use the current month and year as a parameter, which adds the page to a template-related category's sub-category sorted by time:

{{Expand section|date=March 2026}}

or

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

See § Categorisation for more information.

There are bots that edit the pages and add the date= parameter if you forget to do it.

You can add a |1= (a.k.a. |with= or |for=) parameter with an explanation of what expansion the section needs, and you can of course use the date parameter at the same time:

{{Expand section|1=examples and additional citations|date=March 2026}}

When you need to raise multiple yet simply explanable expansion issues, you can make a bullet list within the template:

{{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.)

However, if you want to raise more than a few simple points, your issues would better be raised in a new section of the talk page.

Categorisation

When this template is used in the Main/Article namespace, it places the article in Category:Articles to be expanded or in a dated category like Category:Articles to be expanded from March 2026 if the date parameter "date=March 2026" is specified.

It also places the article in Category:All articles to be expanded.

Choosing the right template

For an empty section

If the section is completely empty, you should use {{Empty section}} instead.

The exception would be an empty section used for references, as explained in the following section.

For section for references (aka footnotes) and sources

When the section you think needs expansion is a section for citing sources, use either {{No footnotes}} or {{More footnotes}} instead of {{Empty section}} or {{Expand section}}.

Note: Unlike the other templates mentioned, these footnote/reference templates should go at the top of the page, rather than the top of the section.

In the Main/Article namespace, citing sources is an important part of the article, done using the tags, <ref></ref>, which in turn are collected and formatted into text in the section containing {{Reflist}} or <references />. This section (or sub-section, as might be done if the sources are listed separately) is most often named References, but can have other names.

If the article has a section that contains either {{Reflist}} or <references />, the section can still appear blank on the saved, rendered page if the article has no text within <ref></ref> tags. Such a section is still considered blank, even though the template or tag wikitext can be seen in Edit mode, so use {{No footnotes}}.

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

Can be placed at the beginning of article sections that need expansion, after the section title.

Template parameters

ParameterDescriptionTypeStatus
reason1 with for

Reason the template was added, an explanation of what expansion the section needs. A bulleted list with lines beginning '*' can be given.

Stringoptional
talksectiontalksection discuss talk

A section heading in the talk page where the issue is discussed. Note: The talksection parameter only displays if the parameter small is set to 'no'.

Stringoptional
datedate

The month and year the template was added, e.g. 'August 2013'.

Stringoptional
smallsmall

By default the template will be displayed in a small size. This can be changed by setting small to no. Not recommended in articles.

Stringoptional

See also