Template:Expand/doc View history

Template documentation pages
VisualWikitext
(Added category to page)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{doc subpage}}
{{doc subpage}}
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
<!-- ADD DOCUMENTATION BELOW THIS LINE -->
{{Tlx|{{DraftLink|Expand}}|content or link to transclude|description for header|nt{{=}}yes|section{{=}}#1-4}}
{{Tlx|Expand|content or link to transclude|description for header|nt{{=}}yes|section{{=}}#1-4|editlink{{=}}no|summary{{=}}A short text summary|expand{{=}}yes|style{{=}}CSS style codes}}
This takes two unnamed parameters in order.
{{Para|either a nugget/subpage link, or raw content}} {{red|*required}} if left blank will produce an error.


{{Para|description text to be used in header line}} if left blank it will use the {{Tl|SUBPAGENAME|nl}} of the first parameter.
This template takes two unnamed parameters in order, and some additional named parameters to alter the output.


{{Para|nt|yes}} content is raw (do not enclose in curly braces for transclusion).
It creates a collapsible section on a page, with a heading and optional summary text text. The heading may be formatted as a section header (level 1-5) which will appear in the TOC.
 
At the top of the collapsed section, if the content is being transcluded from another source, a link to edit the source directly is displayed by default.
 
 
{{Para||either a nugget/subpage link, or raw content}} {{red|*required}} if left blank will produce an error.
 
{{Para||description text to be used in header line}} if left blank it will use the {{Tl|SUBPAGENAME|nl}} of the first parameter.
 
{{para|summary|short descriptive summary}} This optional parameter<!-- is only available if the {{Para|section|#}} parameter is also used. It--> allows you to define a very short summary text to be displayed in the header of the collapsible section. This will override the description parameter. If this is not used the default header will be used:
<code>Click expand for details on ...<description, or {{Tl|SUBPAGENAME|nl}}></code>
 
{{Para|nt|yes}} not transcluded; content is wiki text to be rendered directly (do not enclose in curly braces for transclusion).


{{Para|section|#}} any number 1-4, if anything else is entered it defaults to 5. This replaces the header test with just the description from the 2nd parameter (or the {{tl|SUBPAGENAME|nl}} of the 1st parameter, and formats it as a section header. The number entered is the header level used.
{{Para|section|#}} any number 1-4, if anything else is entered it defaults to 5. This replaces the header test with just the description from the 2nd parameter (or the {{tl|SUBPAGENAME|nl}} of the 1st parameter, and formats it as a section header. The number entered is the header level used.


{{Para|newscript|yes}} Designed to detect input from the {{tl|NewScript}} template, and is not meant to be used manually. It generate a preload link for a script nugget, if the defined subpage does not exist yet.
{{Para|newscript|yes}} Designed to detect input from the {{tl|NewScript}} template, and is not meant to be used manually. If the defined subpage exists already it produces a direct link to the nugget above the transclusion. ''For script authors convenience''
 
{{Para|editlink|no}} If this parameter is defined the link to edit the nugget is not displayed.
 
{{para|expand|yes}} If defined, the section will be expanded by default when the page is loaded.
 
{{para|style}} If defined, the style codes specified here will be used on the collapsible section (such as border, background, etc).
 


{{para|summary|short descriptive summary}} This parameter is only available if the {{Para|section|#}} parameter is also used. It allows you to define a very short summary text to be displayed in the header of the collapsible section.
== Sample ==
== Sample ==
<code><nowiki>{{{{DraftLink|Expand}}|(LINK)}}</nowiki></code><br />


<code><nowiki>{{{{DraftLink|Expand}}|/(LINK)}}</nowiki></code><br />
<code><nowiki>{{Expand|(LINK)}}</nowiki></code><br />
 
<code><nowiki>{{Expand|/(LINK)}}</nowiki></code><br />
 
<code><nowiki>{{Expand|/(LINK)|(HEADER)}}</nowiki></code><br />


<code><nowiki>{{{{DraftLink|Expand}}|/(LINK)|(HEADER)}}</nowiki></code><br />
<code><nowiki>{{Expand|(CONTENT)|(HEADER)|nt=yes}}</nowiki></code><br />


<code><nowiki>{{{{DraftLink|Expand}}|(CONTENT)|(HEADER)|nt=yes}}</nowiki></code><br />
<code><nowiki>{{ Expand}}</nowiki></code><br />


<code><nowiki>{{ {{DraftLink|Expand}}}}</nowiki></code><br />
<code><nowiki>{{Expand|/(LINK)|section=2}}</nowiki></code><br />


<code><nowiki>{{{{DraftLink|Expand}}|/(LINK)|section=2}}</nowiki></code><br />
<code><nowiki>{{Expand|/(LINK)|(HEADER)|section=2}}</nowiki></code><br />


<code><nowiki>{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2}}</nowiki></code><br />
<code><nowiki>{{Expand|/(LINK)|(HEADER)|section=2|newscript=yes|summary=This is a subsection dedicated to HEADER}}</nowiki></code><br />


<code><nowiki>{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|summary=This is a subsection dedicated to HEADER}}</nowiki></code><br />
<code><nowiki>{{Expand|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER|expand=yes}}</nowiki></code><br />


<code><nowiki>{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER}}</nowiki></code><br />
<code><nowiki>{{Expand|(LINK)|style=border: solid 1px;}}</nowiki></code><br />


PRODUCES
PRODUCES


{{{{DraftLink|Expand}}|(LINK)}}
{{Expand|(LINK)}}
----
{{Expand|/(LINK)}}
----
----
{{{{DraftLink|Expand}}|/(LINK)}}
{{Expand|/(LINK)|(HEADER)}}
----
----
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)}}
{{Expand|(CONTENT)|(HEADER)|nt=yes}}
----
----
{{{{DraftLink|Expand}}|(CONTENT)|(HEADER)|nt=yes}}
{{ Expand}}
----
----
{{ {{DraftLink|Expand}}}}
{{Expand|/(LINK)|section=2}}
----
----
{{{{DraftLink|Expand}}|/(LINK)|section=2}}
{{Expand|/(LINK)|(HEADER)|section=2}}
----
----
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2}}
{{Expand|/(LINK)|(HEADER)|section=2|newscript=yes|summary=This is a subsection dedicated to HEADER}}
----
----
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|summary=This is a subsection dedicated to HEADER}}
{{Expand|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER|expand=yes}}
----
----
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER}}
{{Expand|(LINK)|style=border: solid 1px;}}
----
----
==See Also==
This template relies on:
*{{tl|Collapsible section top}}
*{{tl|Collapsible section content}}
*{{tl|Collapsible section bottom}}
This template is used by:
*{{tl|NewScript}}
<includeonly>
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:Page formatting templates]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->
<!-- ADD INTERWIKIS BELOW THIS LINE -->


</includeonly>
</includeonly>
<templatedata>
{
"params": {
"1": {
"label": "Content or Link to transclude",
"description": "This is where you put the content of the section, or the link to the page nugget you want to transclude here",
"type": "content",
"required": true
},
"2": {
"label": "Header text",
"description": "The text to be displayed at the top of the section. If you set the section parameter this will be used as the name for the section header. If not set the default text will use the SUBPAGENAME of the transcluded link ",
"type": "string",
"suggested": true
},
"expand": {
"description": "If defined, the section will be expanded by default when the page is loaded.",
"type": "boolean",
"default": "yes"
},
"style": {
"description": " If defined, the style codes specified here will be used on the collapsible section (such as border, background, etc).",
"type": "string"
},
"section": {
"label": "Section Header Level",
"description": "A number from 1 to 4 to be determine the header level for the section. If any other text is entered the default will be 5",
"type": "number",
"suggested": true
},
"nt": {
"label": "no transclude",
"description": "If you put text content instead of a link to transclude in the first parameter, this must be set to \"yes\"",
"type": "boolean",
"default": "yes",
"suggested": true
},
"editlink": {
"description": "If this parameter is defined the link to edit the transcluded nugget is not displayed.",
"type": "boolean",
"default": "no"
},
"summary": {
"description": "a very short summary text to be displayed in the header of the collapsible section. This will override the description parameter. If this is not used the default header will be used: Click expand for details on ...<description, or {{SUBPAGENAME}}>",
"type": "content",
"suggested": true
},
"newscript": {
"description": "Designed to detect input from the {{NewScript}} template, and is not meant to be used manually. If the defined subpage exists already it produces a direct link to the nugget above the transclusion. For script authors convenience",
"type": "boolean"
}
},
"description": "This template is used to create a collapsible section of content on a page which can be hidden until the user chooses to open it making the pages easier to read, and less daunting at first glance.",
"paramOrder": [
"1",
"2",
"nt",
"section",
"summary",
"expand",
"editlink",
"newscript",
"style"
]
}
</templatedata>

Latest revision as of 01:13, 17 August 2022

 This is a documentation subpage for Template:Expand.
It contains usage information, categories and other content that is not part of the original template page.

{{Expand|content or link to transclude|description for header|nt=yes|section=#1-4|editlink=no|summary=A short text summary|expand=yes|style=CSS style codes}}

This template takes two unnamed parameters in order, and some additional named parameters to alter the output.

It creates a collapsible section on a page, with a heading and optional summary text text. The heading may be formatted as a section header (level 1-5) which will appear in the TOC.

At the top of the collapsed section, if the content is being transcluded from another source, a link to edit the source directly is displayed by default.


|either a nugget/subpage link, or raw content *required if left blank will produce an error.

|description text to be used in header line if left blank it will use the {{SUBPAGENAME}} of the first parameter.

|summary=short descriptive summary This optional parameter allows you to define a very short summary text to be displayed in the header of the collapsible section. This will override the description parameter. If this is not used the default header will be used: Click expand for details on ...<description, or {{SUBPAGENAME}}>

|nt=yes not transcluded; content is wiki text to be rendered directly (do not enclose in curly braces for transclusion).

|section=# any number 1-4, if anything else is entered it defaults to 5. This replaces the header test with just the description from the 2nd parameter (or the {{SUBPAGENAME}} of the 1st parameter, and formats it as a section header. The number entered is the header level used.

|newscript=yes Designed to detect input from the {{NewScript}} template, and is not meant to be used manually. If the defined subpage exists already it produces a direct link to the nugget above the transclusion. For script authors convenience

|editlink=no If this parameter is defined the link to edit the nugget is not displayed.

|expand=yes If defined, the section will be expanded by default when the page is loaded.

|style= If defined, the style codes specified here will be used on the collapsible section (such as border, background, etc).


Sample

{{Expand|(LINK)}}

{{Expand|/(LINK)}}

{{Expand|/(LINK)|(HEADER)}}

{{Expand|(CONTENT)|(HEADER)|nt=yes}}

{{ Expand}}

{{Expand|/(LINK)|section=2}}

{{Expand|/(LINK)|(HEADER)|section=2}}

{{Expand|/(LINK)|(HEADER)|section=2|newscript=yes|summary=This is a subsection dedicated to HEADER}}

{{Expand|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER|expand=yes}}

{{Expand|(LINK)|style=border: solid 1px;}}

PRODUCES

Click Expand for details on (LINK)


Template:(LINK)

Click Expand for details on /(LINK)


Template:Expand/doc/(LINK)

Click Expand for details on (HEADER)


Template:Expand/doc/(LINK)

Click Expand for details on (HEADER)

(CONTENT)

Click Expand for details on


{{ ERROR: No content was specified }}

/(LINK) link to this section


Template:Expand/doc/(LINK)

(HEADER) link to this section


Template:Expand/doc/(LINK)

(HEADER) link to this section

This is a subsection dedicated to HEADER

(HEADER) link to this section

This is a subsection dedicated to HEADER

Click Expand for details on (LINK)


Template:(LINK)

See Also

This template relies on:

This template is used by:


This template is used to create a collapsible section of content on a page which can be hidden until the user chooses to open it making the pages easier to read, and less daunting at first glance.

Template parameters

ParameterDescriptionTypeStatus
Content or Link to transclude1

This is where you put the content of the section, or the link to the page nugget you want to transclude here

Contentrequired
Header text2

The text to be displayed at the top of the section. If you set the section parameter this will be used as the name for the section header. If not set the default text will use the SUBPAGENAME of the transcluded link

Stringsuggested
no transcludent

If you put text content instead of a link to transclude in the first parameter, this must be set to "yes"

Default
yes
Booleansuggested
Section Header Levelsection

A number from 1 to 4 to be determine the header level for the section. If any other text is entered the default will be 5

Numbersuggested
summarysummary

a very short summary text to be displayed in the header of the collapsible section. This will override the description parameter. If this is not used the default header will be used: Click expand for details on ...<description, or {{SUBPAGENAME}}>

Contentsuggested
expandexpand

If defined, the section will be expanded by default when the page is loaded.

Default
yes
Booleanoptional
editlinkeditlink

If this parameter is defined the link to edit the transcluded nugget is not displayed.

Default
no
Booleanoptional
newscriptnewscript

Designed to detect input from the {{NewScript}} template, and is not meant to be used manually. If the defined subpage exists already it produces a direct link to the nugget above the transclusion. For script authors convenience

Booleanoptional
stylestyle

If defined, the style codes specified here will be used on the collapsible section (such as border, background, etc).

Stringoptional
Retrieved from "https://beta.waze.com/wiki/USA/index.php?title=Template:Expand/doc&oldid=177021"