m (→Sample: add 2 section header examples) |
m (changed {{{summary}}} so it is not just availble if {{{section}}} is used) |
||
| (14 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{doc subpage}} | {{doc subpage}} | ||
<!-- ADD DOCUMENTATION BELOW THIS LINE --> | <!-- ADD DOCUMENTATION BELOW THIS LINE --> | ||
{{Tlx | {{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. | |||
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. | |||
{{Para|either a nugget/subpage link, or raw content}} {{red|*required}} if left blank will produce an error. | {{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 {{{{ | {{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}} content is raw (do not enclose in curly braces for transclusion). | {{Para|nt|yes}} content is raw (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|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). | |||
== Sample == | == Sample == | ||
{{{{ | |||
<code><nowiki>{{Expand|(LINK)}}</nowiki></code><br /> | |||
<code><nowiki>{{Expand|/(LINK)}}</nowiki></code><br /> | |||
<code><nowiki>{{Expand|/(LINK)|(HEADER)}}</nowiki></code><br /> | |||
<code><nowiki>{{Expand|(CONTENT)|(HEADER)|nt=yes}}</nowiki></code><br /> | |||
<code><nowiki>{{ Expand}}</nowiki></code><br /> | |||
<code><nowiki>{{Expand|/(LINK)|section=2}}</nowiki></code><br /> | |||
<code><nowiki>{{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>{{Expand|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER|expand=yes}}</nowiki></code><br /> | |||
<code><nowiki>{{Expand|(LINK)|style=border: solid 1px;}}</nowiki></code><br /> | |||
PRODUCES | |||
{{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;}} | |||
---- | |||
==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 --> | ||
Latest revision as of 16:22, 25 October 2015
 |
This is a documentation subpage for . 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 content is raw (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
