Template:Expand section/doc: Difference between revisions

Revision as of 21:27, 30 August 2020

Latest revision as of 09:27, 3 August 2025

(32 intermediate revisions by 13 users not shown)

Line 1:

{{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=

{{As of |2016|August}}, this template only uses the "article message box" (Ambox) style; this will be fixed in the future.

*{{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}}

}}

'''or inline shortLong form:'''

Recommended use is with a talk page link explaining what is needed and ''especially any justification for your judgement''.

<syntaxhighlight lang="wikitext">

Note: {{tl|sect-stub}} is a shortcut used for consistency with [[Template:Stub|other]] [[Template:Cleanup|cleanup]] [[Template:Cleanup section|templates]].

<pre>

{{Expand section

| 1 = (or with= or for=)

Line 20 ⟶ 27:

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

</pre>

===Parameters===

'''or inline short form'''

=== Overview ===

<pre>{{Expand section | 1 = (or with= or for=) | section = (section number) | small = no (default is "yes") | talksection= (or talk= or discuss=) | date= }}</pre>

===Parameters===

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=

Line 67 ⟶ 107:

;small= and talksection=

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

:The default for the {{para|small}} parameter is "yes", which means that if this parameter is omitted, then the size of the tag will default to the sizes shown above. Use {{para|small|no}} to result in a larger section tag and to enable the {{para|talksection}} parameter ({{para|talk}} or {{para|discuss}} may also be used):

;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?}}

Line 120 ⟶ 164:

"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": "booleanline",

"suggestedvalues": [

"yes",

"no"

],

"required": false,

"example": "no",

"default": "yes",

"autovalue": "",

"aliases": [

"punctuation"

Line 132 ⟶ 179:

"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": "stringline",

"required": false,

"aliases": [

Line 141 ⟶ 188:

"date": {

"label": "Month and year",

"description": "The month and year the template was added, e.g. 'July 2017'.",

"type": "stringline",

"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": "booleanline",

"required": false,

"examplesuggestedvalues": "no",[

"defaultno": "yes",

]

"autovalue": ""

},

"find": {

"autovaluelabel": "Find",

"description": "Search keywords for double-quoted search to pass to 'find sources'.",

"required": false,

"example": "Article title",

"autovaluetype": "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"

}

},

Line 166 ⟶ 232:

* {{tlx|Empty section}}

* {{tlx|Missing information}}

== Notes ==

{{notelist}}

<includeonly>{{Sandbox other||

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

[[Category:Exclude in print]]

[[Category:Wikipedia section templates]]