View source for Template:Expand section/doc

{{documentation subpage}}
<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->
{{high-use| ≈ 33290 }}

This template may be used at the beginning of article sections that need expansion.

== 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 or Wikipedia namespaces.

{{plainlist|1=
*{{tlc|Expand section}}
*{{tlc|Expand section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
*{{tlc|Expand section|small{{=}}no}}
*{{tlc|Expand section|with{{=}}more details about early life|talk{{=}}Early life|small{{=}}no}}
*{{tlc|Expand section|small{{=}}no|find{{=}}search keywords}}
}}

'''Long form:'''

<syntaxhighlight lang="wikitext">
{{Expand section
 | 1           = (or with= or for=)
 | section     = (section number)
 | small       = no (default is "yes")
 | talksection = (link with NO brackets, "[[]]"; displays only if small=no)
 | date        = Month YYYY
 | period      = <!--no--> (included after the input for "1=" from above by default - use this only in instances where terminal punctuation should be placed before a reference)
}}
</syntaxhighlight>

==Parameters==

=== Overview ===

This template may be used without parameters, and a BOT will add the date when necessary.

* {{para|1|''what and why''}}{{snd}} (or with= or for=) add a few words about what needs expansion and why
* {{para|small|no}}	{{snd}} (default when omitted: a small message box flush left){{efn|name="small"}}
* {{para|talksection|''Section name''}}	{{snd}} (link with NO brackets, "[[]]"; displays only if small=no)
* {{para|date|{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
* {{para|find|your search keywords}} {{snd}} search terms for {{tl|find sources}} param 1 (double-quoted search). This optional parameter adds a set of links produced by the {{tl|find sources}} template to the output. If omitted, no "find sources" links are displayed. Details [[#Find parameters|below]].
* {{para|find2|additional search terms}} {{snd}} search keywords for {{tl|find sources}} param 2 (unquoted search).
* {{para|section}}	{{snd}} (section number)
* {{para|period}}	{{snd}} &lt;!--no--> (included after the input for "1=" from above by default - use this

=== Details ===

;small

When the {{para|small}} parameter is omitted, a small, left-justified message box is displayed. This can be overridden: use {{para|small}} with ''any value'' (such as <code>no</code>) to result in a wider message box.{{efn|name="small"|Note that any value for {{para|small}} results in a wide box, so, {{para|small|yes}} and {{para|small|no}} produce the same results: a wide box. This is due to the operation of [[Template:Ambox#small|Ambox]].}}

Use of the wider box with {{para|small|no}} also enables display of the {{para|talksection}} parameter. ({{para|talk}} or {{para|discuss}} may also be used). In most cases, display of "find sources" results will be easier to read in a wide box, but are permitted in the default, smaller box.

;date

The {{para|date}} parameter sorts the article into subcategories of [[:Category:Articles to be expanded]], allowing the oldest ones to be identified and dealt with first.  You do not need to specify the date manually; a [[WP:Bots|bot]] will add it later automatically.

;find parameters

There are two 'find' parameters available to control the presentation and operation of the {{tl|find sources}} links optionally displayed by the template.  The find parameters can be used to provide the search keywords of your choice to the {{tl|find sources}} links. Use:
* {{para|find}} to specify keywords for an exact search (double-quoted query); this corresponds to {{tl|find sources}} positional param one.
* {{para|find2}} to specify keywords for an unquoted search; this corresponds to {{tl|find sources}} param two.
If you want to display {{tl|find sources}} links in the box, but are not sure of what search keywords to use, try setting {{para|find|''Article title''}} and {{para|find2|''Section title''}}. If the article title is a long, [[WP:NDESC|descriptive title]] unlikely to generate good results as a long, double-quoted search query, try swapping the values of the two params.

==Examples==

'''or inline short form'''

{{tlx|Expand section |1{{=}}''what and why'' |small{{=}}'''no''' |talk{{=}}''Talk_section'' find{{=}}''Article title or search terms'' |find2{{=}}''Section title or more terms'' |section{{=}}''n'' |date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}

;date=
:The current month and year can be used in the {{para|date}} parameter. This will add the page to a sub-category sorted by date used (see the [[#Categorisation|Categorisation]] section of this page for more information:

:{{Tlx|Expand section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}

:or

:{{Tlx|Expand section|<nowiki>{{subst:DATE}}</nowiki>}}

:results in:

{{Expand section|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}


;section=
:The {{para|section}} parameter is used to link to the edit screen of the article's section in which this template is placed. If this template is placed in the second section after the TOC, then use {{para|section|2}}:

:{{Tlx|Expand section|section{{=}}2|<nowiki>{{subst:DATE}}</nowiki>}}

:results in:

{{Expand section|section=2|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}

:and links to the edit screen for the ''second section'' of the page ''after the TOC''.


;1=, with=, or for=
:An unnamed parameter, {{para|1}} (or one of the named parameters, {{para|with}} or {{para|for}}), may be used to explain what expansion is needed in the section:

:{{Tlx|Expand section|1{{=}}examples and additional citations|section{{=}}1|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}} }}

:results in:

{{Expand section|1=examples and additional citations|section=1|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|talksection=Template talk:Expand section#When should this template be used? }}

:When multiple expansion issues need to be raised, explain them in a new section on the article's [[WP:Talk page|discussion page]], and use the next two parameters for reader convenience.


;small= 

Specify {{para|small|no}} to generate a wide box, and enable param {{para|talksection}}.

;talksection=

Prerequisite: requires {{para|small|no}}, otherwise presence and values of {{para|talksection}} are ignored.

:{{Tlx|Expand section|1{{=}}examples and additional citations|section{{=}}1|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}|small{{=}}no|talksection{{=}}Template talk:Expand section#When should this template be used?}}

:results in:

:{{Expand section|1=examples and additional citations|section=1|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|small=no|talksection=Template talk:Expand section#When should this template be used?}}

== Categorisation ==

When {{Tlx|Expand section}} is used without a {{para|date}} parameter in an article in the [[WP:Mainspace|main article]] [[WP:Namespace|namespace]], the article is sorted to {{Cat|Articles to be expanded}}. A bot or an editor will then add the date parameter, and the article will be sorted to a category with a name that reflects the date given. For example, if the {{para|date|{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} is used, the article will be added to {{Cat|Articles to be expanded from {{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}.  

No matter what parameters are used with this template, it also adds the article to {{Cat|All articles to be expanded}}.

== Choosing the right template ==

=== For an empty section ===

If the section is completely empty, the {{Tlx|Empty section}} template should be used instead of this template. 

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

=== For a References or Notes section ===

When the section that needs expansion is used to list cited sources, then either {{Tlx|No footnotes}} or {{Tlx|More footnotes needed}} should be used instead of {{Tlx|Empty section}} or {{Tlx|Expand section}}. 

'''Note:''' Unlike the other templates mentioned, those "footnotes" templates should go at the beginning/TOP of the page, just under any hatnotes, rather than at the beginning of a section. 

In the main article namespace, [[WP:Citing sources|citing sources]] is an important part of the article, performed by using the tags, <code><nowiki><ref></ref></nowiki></code>, which in turn are collected and formatted into text in the section containing the {{Tlx|Reflist}} template or the <code><nowiki><references /></nowiki></code> tag. This section (or sub-section, as might be the case if the sources are listed separately) is often titled "References", and can have other names.

If the article has a section that contains either {{Tlx|Reflist}} or <code><nowiki><references /></nowiki></code>, ''the section can still appear blank'' on the saved, rendered page if the article has no text within <code><nowiki><ref></ref></nowiki></code> tags. Such a section is still considered blank, even though the template or tag wikitext can be seen in Edit mode. In that case the {{Tlx|No footnotes}} template should be used at the TOP of the page just beneath any hatnotes.

== TemplateData ==
{{TemplateData header}}
<!-- Why no "reason" here for the param "reason"? This is very confusing. At the beginning, an example with "reason =" is given. --><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": "content",
			"required": false,
			"aliases": [
				"with",
				"for"
			]
		},
		"period": {
			"label": "Terminal punctuation",
			"description": "If set to 'no', this parameter omits the terminal punctuation after the input for the 'with'/'for' parameter (i.e., the reason the template was added); this is normally only used if references are included after terminal punctuation.",
			"type": "line",
			"suggestedvalues": [
				"yes",
				"no"
			],
			"required": false,
			"example": "no",
			"default": "yes",
			"aliases": [
				"punctuation"
			]
		},
		"talksection": {
			"label": "Talk section",
			"description": "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'.",
			"type": "line",
			"required": false,
			"aliases": [
				"discuss",
				"talk"
			]
		},
		"date": {
			"label": "Month and year",
			"description": "The month and year the template was added.",
			"type": "line",
			"required": false,
			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
			"suggested": true,
			"example": "July 2017"
		},
		"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": "line",
			"required": false,
			"suggestedvalues": [
				"no"
			]
		},
		"find": {
			"label": "Find",
			"description": "Search keywords for double-quoted search to pass to 'find sources'.",
			"required": false,
			"example": "Article title",
			"type": "line"
		},
		"find2": {
			"label": "Find2",
			"description": "Search keywords for unquoted search to pass to 'find sources'.",
			"required": false,
			"example": "Section title",
			"type": "line"
		},
		"section": {
			"description": "Section number of the section with the template",
			"type": "number"
		}
	},
	"format": "inline"
}
</templatedata>

== See also ==
* {{tlx|Clarify}} and {{tlx|Explain}} (both inline)
* {{tlx|Incomplete list}}
* {{tlx|Empty section}}
* {{tlx|Missing information}}

== Notes ==
{{notelist}}

<includeonly>{{Sandbox other||

[[Category:Cleanup templates|{{PAGENAME}}]]
[[Category:Wikipedia section templates]]

}}</includeonly>