m (→Sample) |
m (added expand and editlink params) |
||
| 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|{{DraftLink|Expand}}|content or link to transclude|description for header|nt{{=}}yes|section{{=}}#1-4|editlink{{=}}no|summary{{=}}A short text summary|expand{{=}}yes}} | ||
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. | ||
| Line 11: | Line 18: | ||
{{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. It generate a preload link for a script nugget, if the defined subpage does not exist yet. If the defined subpage exists already it produces a direct link to the nugget above the transclusion. | ||
{{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. | {{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. | ||
{{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. | |||
== Sample == | == Sample == | ||
<code><nowiki>{{{{DraftLink|Expand}}|(LINK)}}</nowiki></code><br /> | <code><nowiki>{{{{DraftLink|Expand}}|(LINK)}}</nowiki></code><br /> | ||
| Line 31: | Line 45: | ||
<code><nowiki>{{{{DraftLink|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>{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER}}</nowiki></code><br /> | <code><nowiki>{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER|expand=yes}}</nowiki></code><br /> | ||
PRODUCES | PRODUCES | ||
| Line 51: | Line 65: | ||
{{{{DraftLink|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}} | ||
---- | ---- | ||
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER}} | {{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER|expand=yes}} | ||
---- | ---- | ||
<includeonly> | <includeonly> | ||
Revision as of 21:01, 6 July 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}}
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.
|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. It generate a preload link for a script nugget, if the defined subpage does not exist yet. If the defined subpage exists already it produces a direct link to the nugget above the transclusion.
|summary=short descriptive summary This parameter is only available if the |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.
|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.
Sample
{{{{DraftLink|Expand}}|(LINK)}}
{{{{DraftLink|Expand}}|/(LINK)}}
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)}}
{{{{DraftLink|Expand}}|(CONTENT)|(HEADER)|nt=yes}}
{{ {{DraftLink|Expand}}}}
{{{{DraftLink|Expand}}|/(LINK)|section=2}}
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2}}
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|summary=This is a subsection dedicated to HEADER}}
{{{{DraftLink|Expand}}|/(LINK)|(HEADER)|section=2|newscript=yes|edit=/(LINK)|summary=This is a subsection dedicated to HEADER|expand=yes}}
PRODUCES
