Template:Collapse top/doc: Difference between revisions

From PS3 Developer wiki
Jump to navigation Jump to search
(Created page with "<div style="margin-left:{{{indent|0px}}}"><!-- NOTE: width renders incorrectly if added to main STYLE section--> {| <!-- Template:Collapse top --> class="navbox collapsible {{...")
 
mNo edit summary
 
Line 1: Line 1:
<div style="margin-left:{{{indent|0px}}}"><!-- NOTE: width renders incorrectly if added to main STYLE section-->
{{Documentation subpage}}
{| <!-- Template:Collapse top --> class="navbox collapsible {{{{{|safesubst:}}}#if:{{{expand|}}}||collapsed}}" style="background: transparent; text-align: left; border: {{{border|1px}}} solid {{{b-color|silver}}}; margin-top: 0.2em; {{{{{|safesubst:}}}#if:{{{width|}}}|width:{{{width}}};}}"
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
|-
{{shortcut|Template:Cot|Template:Cob}}
! style="background-color: {{{bg|#CFC}}}; text-align:{{{{{|safesubst:}}}#if:{{{left|}}}|left|center}}; font-size:112%;" | {{{1|{{{title|{{{reason|{{{header|{{{heading|Extended content}}} }}} }}} }}} }}} 
 
{{{{{|safesubst:}}}#if:{{{warning|{{{2|}}}}}}
The {{tlx|collapse top}} template (a.k.a. {{tlx|cot}}) and its paired template {{tlx|collapse bottom}} (or {{tlx|cob}}) are used for placing a collapse box around a talk page discussion, especially when the content contains complex wikimarkup such as tables.  For very simple content, the one-piece template {{tlx|collapse}} can be used instead.
|{{{{{|safesubst:}}}!}}-
 
{{{{{|safesubst:}}}!}} style="text-align:center; font-style:italic;" {{{{{|safesubst:}}}!}} {{{2|The following is a closed debate. {{strongbad|Please do not modify it.}} }}} }}
These templates should only be used in accordance with the [[Wikipedia:Refactoring]] guideline; they should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.
|-
 
| style="border: solid {{{border2|1px silver}}}; padding: {{{padding|8px}}}; background-color: {{{bg2|white}}}; font-size:112%;" {{{{{|safesubst:}}}!}}<noinclude>
== Usage ==
{{lorem ipsum|3}}
Place {{tlx|collapse top}} and {{tlx|collapse bottom}} around the text to be collapsed. For example:
 
<pre>{{Collapse top|title=This is the title text}}
{{lorem ipsum}}
{{Collapse bottom}}</pre>
produces:
{{Collapse top|title=This is the title text}}
{{lorem ipsum}}
{{Collapse bottom}}
{{Collapse bottom}}
{{Documentation}}
 
<!-- PLEASE ADD THIS TEMPLATE'S CATEGORIES AND INTERWIKIS TO THE /doc SUBPAGE, THANKS -->
== Parameters ==
</noinclude>
This template takes the following parameters, all of which are optional
 
;positional parameter 1, named parameter 'title': These parameters give the main title of collapsed box, which occurs on the same line as the ''show'' link and is always visible. It defaults to 'Extended content'.
;warning: If this parameter evaluates to true (i.e. is not empty) it will display a default warning line under the main title which reads "The following is a closed debate. {{strongbad|Please do not modify it.}}"
;positional parameter 2: This is optional warning-line text. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter.
;expand: If this parameter evaluates to true (i.e. is not empty) it will leave the material uncollapsed with the border and coloring. Default is to collapse the material.
;bg: Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green. Other colors available from [[List of colors]].
;border: Sets the width of the border line on the collapsed material. defaults to 1px.
;b-color: Sets the border color. defaults to silver.
;padding: Sets the padding on the collapsed material in the colored area. defaults to 8px
;width: Sets the width of the overall template. Use {{para|width|50%}}, not {{para|Width|50%}} (Upper case "W" doesn't work) or <code>|width=200</code> (omits "px" and doesn't work).
;border2: Sets the border of the box that appears when template is expanded; defaults to "1px silver" (no provision to change from a solid line)
;bg2: Sets background of the box that appears when template is expanded; defaults to white.
;indent: indents the box from the left of the page. Use: {{para|indent|50px}} not {{para|Indent|50px}} (Upper case "I" doesn't work). Defaults to "do not indent" (ie, 0px). Each ":" in wiki-markup is approximately equivalent to 25px indent.
 
If an entire section is being closed, remove the section header and add it as the first parameter of the template. This keeps the section header from showing in the TOC.
 
== Examples ==
*changing background color - <nowiki>{{Collapse top|bg=#F0F2F5}} or {{cot|bg=#F0F2F5}}</nowiki>
{{cot|bg=#F0F2F5}}
{{lorem ipsum}}
{{cob}}
*adding extra padding - <nowiki>{{cot|padding=40px}}</nowiki>
{{cot|padding=40px}}
{{lorem ipsum}}
{{cob}}
*adding a warning line - <nowiki>{{cot|default warning|warning=1}}</nowiki>, <nowiki>{{cot|custom warning|this is a custom warning line}}</nowiki>
{{cot|default warning|warning=1}}
{{lorem ipsum}}
{{cob}}
{{cot|custom warning|this is a custom warning line}}
{{lorem ipsum}}
{{cob}}
*archiving a section
<pre>{{cot}}
==section header==
text
{{cob}}</pre>
rewritten as
<pre>{{cot|section header}}
text
{{cob}}</pre>
{{cot|section header}}
text
{{cob}}
 
== Redirects ==
To Collapse top:
* {{tl|cot}}
* {{tl|DAT}}
To Collapse bottom:
* {{tl|cob}}
* {{tl|hab}}
* {{tl|hidden archive bottom}}
 
== See also ==
* {{tl|collapse}}
* {{#ifeq: {{BASEPAGENAME}} | Collapse top || {{tl|collapse top}} }}
* {{#ifeq: {{BASEPAGENAME}} | Collapse bottom || {{tl|collapse bottom}} }}
* {{tl|discussion top}}
* {{tl|hidden archive top}}
 
{{Warchivenav|state=uncollapsed}}
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Archival templates|{{PAGENAME}}]]
[[Category:Collapse templates|{{PAGENAME}}]]
 
}}</includeonly>

Latest revision as of 01:20, 13 December 2012

This is a documentation subpage for Template:Collapse top (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.
Shortcuts:
Template:Cot
Template:Cob

The {{collapse top}} template (a.k.a. {{cot}}) and its paired template {{collapse bottom}} (or {{cob}}) are used for placing a collapse box around a talk page discussion, especially when the content contains complex wikimarkup such as tables. For very simple content, the one-piece template {{collapse}} can be used instead.

These templates should only be used in accordance with the Wikipedia:Refactoring guideline; they should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.

Usage[edit source]

Place {{collapse top}} and {{collapse bottom}} around the text to be collapsed. For example: 

{{Collapse top|title=This is the title text}}
{{lorem ipsum}}
{{Collapse bottom}}

produces:

Parameters[edit source]

This template takes the following parameters, all of which are optional

positional parameter 1, named parameter 'title'
These parameters give the main title of collapsed box, which occurs on the same line as the show link and is always visible. It defaults to 'Extended content'.
warning
If this parameter evaluates to true (i.e. is not empty) it will display a default warning line under the main title which reads "The following is a closed debate. Template:Strongbad"
positional parameter 2
This is optional warning-line text. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter.
expand
If this parameter evaluates to true (i.e. is not empty) it will leave the material uncollapsed with the border and coloring. Default is to collapse the material.
bg
Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green. Other colors available from List of colors.
border
Sets the width of the border line on the collapsed material. defaults to 1px.
b-color
Sets the border color. defaults to silver.
padding
Sets the padding on the collapsed material in the colored area. defaults to 8px
width
Sets the width of the overall template. Use |width=50%, not |Width=50% (Upper case "W" doesn't work) or |width=200 (omits "px" and doesn't work).
border2
Sets the border of the box that appears when template is expanded; defaults to "1px silver" (no provision to change from a solid line)
bg2
Sets background of the box that appears when template is expanded; defaults to white.
indent
indents the box from the left of the page. Use: |indent=50px not |Indent=50px (Upper case "I" doesn't work). Defaults to "do not indent" (ie, 0px). Each ":" in wiki-markup is approximately equivalent to 25px indent.

If an entire section is being closed, remove the section header and add it as the first parameter of the template. This keeps the section header from showing in the TOC.

Examples[edit source]

  • changing background color - {{Collapse top|bg=#F0F2F5}} or {{cot|bg=#F0F2F5}}

Template:Cot Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:Cob

  • adding extra padding - {{cot|padding=40px}}

Template:Cot Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:Cob

  • adding a warning line - {{cot|default warning|warning=1}}, {{cot|custom warning|this is a custom warning line}}

Template:Cot Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:Cob Template:Cot Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:Cob

  • archiving a section
{{cot}}
==section header==
text
{{cob}}

rewritten as 

{{cot|section header}}
text
{{cob}}

Template:Cot text Template:Cob

Redirects[edit source]

To Collapse top:

To Collapse bottom:

See also[edit source]

Template:Warchivenav


Retrieved from "http://www.psdevwiki.com/ps3/index.php?title=Template:Collapse_top/doc&oldid=17353"