Template:Collapse top: Difference between revisions

From NARA
Jump to navigation Jump to search
NARA>Izno
(per tech news)
m (1 revision imported: forgot this existed...)
Line 1: Line 1:
<div style="margin-left:{{{indent|0}}}"><!-- NOTE: width renders incorrectly if added to main STYLE section -->
<noinclude>
{| <!-- Template:Collapse top --> class="mw-collapsible mw-archivedtalk {{<includeonly>safesubst:</includeonly>#if:{{{expand|{{{collapse|}}}}}}||mw-collapsed}} {{{class|}}}" style="background: {{{bg1|transparent}}}; text-align: left; border: {{{border|1px}}} solid {{{b-color|Silver}}}; margin: 0.2em auto auto; width:{{<includeonly>safesubst:</includeonly>#if:{{{width|}}}|{{{width}}}|100%}}; clear: {{{clear|both}}}; padding: 1px;"
<languages/>
|-
</noinclude><!--
! style="background: {{{bg|#{{main other|F0F2F5|CCFFCC}}}}}; font-size:87%; padding:0.2em 0.3em; text-align:{{<includeonly>safesubst:</includeonly>#if:{{{left|}}}|left|{{<includeonly>safesubst:</includeonly>#if:{{{align|}}}|left|center}}}}; {{<includeonly>safesubst:</includeonly>#if:{{{fc|}}}|color: {{{fc}}};|}}" | <div style="font-size:115%;{{<includeonly>safesubst:</includeonly>#if:{{{left|}}}||margin:0 4em}}">{{{1|{{{title|{{{reason|{{{header|{{{heading|{{{result|Extended content}}}}}}}}}}}}}}}}}}</div>  
--><div style="display:{{{display|block}}};margin-{{dir|{{pagelang}}|right|left}}:{{{indent|0}}};{{{extrastyle|}}}"><!-- NOTE: width renders incorrectly if added to main STYLE section
{{<includeonly>safesubst:</includeonly>#if:{{{warning|{{{2|}}}}}}
  --><table class="mw-collapsible {{#if:{{{expand|}}}|| mw-collapsed}}" style="margin-top:.2em; border:{{{border|1px}}} solid {{{b-color|silver}}};text-align:{{dir|{{pagelang}}|right|left}}; width: {{{width|100%}}};"><tr><th style="font-size:{{{title-font-size|112%}}};background:{{{bg|#F8FCFF}}};color:{{{fc|black}}};text-align:{{#if:{{{left|}}}
|{{<includeonly>safesubst:</includeonly>!}}-
  | {{dir|{{pagelang}}|right|left}}
{{<includeonly>safesubst:</includeonly>!}} style="text-align:center; font-style:italic;" {{<includeonly>safesubst:</includeonly>!}} {{{2|The following is a closed discussion. {{strongbad|Please do not modify it.}} }}} }}
  | center
|-
  }}">{{{1|{{{title|{{{reason|{{{header|{{{heading|<translate><!--T:1--> Extended content</translate>}}}}}}}}}}}}}}}</th></tr><!--
| style="border: solid {{{border2|1px Silver}}}; padding: {{{padding|0.6em}}}; background: {{{bg2|White}}};" {{<includeonly>safesubst:</includeonly>!}}<noinclude>
  -->{{#if:{{{warning|{{{2|}}}}}}
{{lorem ipsum|3}}
  | <tr><td style="text-align:center;font-style:italic">{{{2|<translate><!--T:2--> The following is a closed debate.</translate> {{Strong
    | style = color:red
    | 1 = <translate><!--T:3--> Please do not modify it.</translate>
    }}}}}</td></tr>
  }}<!--
  --><tr><td style="font-size:{{{font-size|112%}}};background:{{{bg2|white}}};border:solid {{{border2|1px silver}}};padding:{{{padding|8px}}}"><!--
--><noinclude>
<div style="width:100%;text-align:center">''<translate><!--T:4--> The following content has been placed in a collapsed box for improved usability.</translate>''</div>
{{Collapse bottom}}
{{Collapse bottom}}
{{Documentation}}
{{Documentation|content=
<translate>
<!--T:12-->
The <tvar name=1>{{Tlx|Collapse top}}</tvar> template, and its paired template <tvar name=2>{{Tlx|Collapse bottom}}</tvar>, are used for placing a collapse box around a talk page discussion.
 
== Usage == <!--T:8-->
</translate>
<translate><!--T:13--> Place <tvar name=1>{{Tlx|Collapse top}}</tvar> and <tvar name=2>{{Tlx|Collapse bottom}}</tvar> around the text to be collapsed.</translate>
<translate><!--T:14--> For example:</translate>
 
<syntaxhighlight lang="html5">
{{Collapse top|title=This is the title text}}
Sample contents text
{{Collapse bottom}}
</syntaxhighlight>
 
<translate>
<!--T:15-->
produces:
</translate>
 
{{Collapse top|title=This is the title text}}
Sample contents text
{{Collapse bottom}}
 
<translate>
<!--T:16-->
<tvar name=1>{{Tlx|Collapse bottom}}</tvar> should always be placed on its own line.
 
== Parameters == <!--T:9-->
</translate>
<translate><!--T:17--> This template takes the following parameters, all of which are optional.</translate>
<translate><!--T:18--> They are case-sensitive.</translate>
<translate><!--T:19--> Those that take CSS measurements require them in CSS format (e.g. <tvar name=1><code style="color: #006400">1em</code></tvar> not <tvar name=2><code style="color:#8B0000">1&nbsp;em</code></tvar>).</translate>
 
; {{Para|1}} <span style="font-weight:normal"><translate><!--T:20--> (or first unnamed parameter)</translate></span>, {{Para|title}}, {{Para|reason}}, {{Para|header}}, {{Para|heading}}
: <translate><!--T:21--> Will give the collapsed box a title, which occurs on the same line as the ''show'' link and is always visible.</translate> <translate><!--T:22--> It defaults to "Extended content".</translate>
: <translate><!--T:23--> For example, <tvar name=1><code><nowiki>{{Collapse top|title=This is the title text}}</nowiki></code></tvar> or <tvar name=2><code><nowiki>{{Collapse top|This is the title text}}</nowiki></code></tvar>.</translate> <translate><!--T:24--> Note: The shorter, unnamed markup will not work if the title value contain an equals (<tvar name=1><code>=</code></tvar>) character.</translate>
; {{Para|warning|yes}}
: <translate><!--T:25--> Will display a default warning line under the main title which reads "The following is a closed debate. {{<tvar name=1>Strong|style=color:red</tvar>|Please do not modify it.}}"</translate>
: <translate><!--T:27--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>{{Para|warning|<span style="color:red">no</span>}}</tvar> will not work as expected).</translate>
; {{Para|2}} <span style="font-weight:normal"><translate><!--T:28--> (or second unnamed parameter)</translate></span>
: <translate><!--T:29--> This is optional warning-line text.</translate> <translate><!--T:30--> It will override the standard warning line above; it is not necessary to also use <tvar name=1>{{Para|warning|yes}}</tvar> in this case, though doing so is harmless.</translate>
; {{Para|left|yes}}
: <translate><!--T:31--> Will align the title along the left margin (in RTL languages, along the right margin instead).</translate>
: <translate><!--T:32--> By default, text is centered, specifically between the left edge of the green box and the left edge of the "show" link.</translate>
: <translate><!--T:33--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>{{Para|left|<span style="color:#8B0000">no</span>}}</tvar> will not work as expected).</translate>
; {{Para|expand|yes}}
: <translate><!--T:34--> Will leave the material uncollapsed with the border and coloring.</translate> <translate><!--T:35--> Default is to collapse the material.</translate>
: <translate><!--T:36--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>{{Para|expand|<span style="color:#8B0000">no</span>}}</tvar> will not work as expected).</translate>
; {{Para|bg}}
: <translate><!--T:37--> Sets the background color of the title of the collapsible bar.</translate> <translate><!--T:38--> Defaults to "<tvar name=1>#F8FCFF</tvar>", a whitish color.</translate> <translate><!--T:39--> Named colors are listed at [[List of colors]].</translate>
: <translate><!--T:40--> For example, <tvar name=1><code><nowiki>{{Collapse top|This is the title text|bg=#008000}}</nowiki></code></tvar> or <tvar name=2><code><nowiki>{{Collapse top|This is the title text|bg=green}}</nowiki></code></tvar> (numeric HTML color codes require the leading <tvar name=H><code>#</code></tvar>).</translate>
; {{Para|fc}}
: <translate><!--T:41--> Sets the font color of the title of the collapsible bar.</translate> <translate><!--T:42--> Defaults to "<tvar name=1>black</tvar>".</translate>
: <translate><!--T:43--> See <tvar name=bg>{{Para|bg}}</tvar>, above, for details on color options.</translate>
; {{Para|border}}
: <translate><!--T:44--> Sets the width of the border line on the collapsed material.</translate> <translate><!--T:45--> Defaults to <tvar name=1><code>1px</code></tvar>.</translate>
: <translate><!--T:46--> For example, <tvar name=1><code><nowiki>{{Collapse top|border=2px}}</nowiki></code></tvar>; going much thicker than this is not very useful.</translate>
; {{Para|b-color}}
: <translate><!--T:47--> Sets the border color.</translate> <translate><!--T:48--> Defaults to <tvar name=1><code>silver</code></tvar> (<tvar name=2><code>#C0C0C0</code></tvar>).</translate>
: <translate><!--T:49--> See <tvar name=bg>{{Para|bg}}</tvar>, above, for details on color options.</translate>
; {{Para|padding}}
: <translate><!--T:50--> Sets the padding (distance from borders) on the collapsed material inside the colored area.</translate> <translate><!--T:51--> Defaults to <tvar name=1><code>8px</code></tvar>.</translate>
; {{Para|width}}
: <translate><!--T:52--> Sets the width of the overall template relative to the page (or a block element containing the collapse box).</translate> <translate><!--T:53--> This should virtually always be given as a percentage, e.g. <tvar name=1>{{Para|width|50%}}</tvar>, or in relative <tvar name=2><code>em</code></tvar> units, e.g. <tvar name=3>{{Para|width|30em}}</tvar>.</translate> <translate><!--T:54--> Pixel-based values should be avoided, as they are effectively meaningless – the result will be different depending on each user's browser and local CSS settings (which browser and operating system it is, zoom level, font sizes, etc.).</translate>
; {{Para|border2}}
: <translate><!--T:55--> Sets the properties of the border of the box that appears when template is expanded.</translate> <translate><!--T:56--> Defaults to <tvar name=1><code>1px silver</code></tvar> (there is no provision to change from a solid line).</translate>
: <translate><!--T:57--> For example, <tvar name=1><code><nowiki>{{Collapse top|border2=2px}}</nowiki></code></tvar> (only width or color will be changed if only one value is supplied).</translate>
: <translate><!--T:58--> See <tvar name=bg>{{Para|bg}}</tvar>, above, for details on color options.</translate>
; {{Para|bg2}}
: <translate><!--T:59--> Sets the background color of the box that appears when template is expanded; defaults to <tvar name=1><code>white</code></tvar> (<tvar name=2><code>#FFF</code></tvar>).</translate>
: <translate><!--T:60--> See <tvar name=bg>{{Para|bg}}</tvar>, above, for details on color options.</translate>
; {{Para|indent}}
: <translate><!--T:61--> Indents the box from the left of the page.</translate> <translate><!--T:62--> Defaults to no indentation.</translate> <translate><!--T:63--> Each <tvar name=1><code>:</code></tvar> in talk page markup is approximately equivalent to <tvar name=2><code>1.6em</code></tvar> of indent (e.g., to match <tvar name=3><code>::::</code></tvar> indentation level, use <tvar name=4>{{Para|indent|6.4em}}</tvar>).</translate> <translate><!--T:64--> You can also use a percentage value.</translate>
: <translate><!--T:65--> Pixel-based values should be avoided (see <tvar name=1>{{Para|width}}</tvar>, above, for the reason).</translate>
 
<translate>
== Examples == <!--T:10-->
</translate>
* <translate><!--T:66--> Adding a box title (if omitted, default is "Extended content")</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text}}</syntaxhighlight>
 
{{Collapse top|This is the title text}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <translate><!--T:67--> Adding a standard warning line</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text|warning=true}}</syntaxhighlight>
 
{{Collapse top|This is the title text|warning=true}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <translate><!--T:68--> Adding a custom warning line</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text|This is a custom warning line}}</syntaxhighlight>
 
{{Collapse top|This is the title text|This is a custom warning line}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <translate><!--T:69--> Aligning box title along left margin</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|left=true}}</syntaxhighlight>
 
{{Collapse top|left=true}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <translate><!--T:70--> Changing background color</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|bg=#F0F2F5}}</syntaxhighlight>
 
{{Collapse top|bg=#F0F2F5}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <translate><!--T:71--> Adding extra padding</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|padding=5em}}</syntaxhighlight>
 
{{Collapse top|padding=5em}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <translate><!--T:72--> Archiving a section</translate> – <translate><!--T:73--> The markup below:</translate>
 
<syntaxhighlight lang="html5">{{Collapse top}}
== Section header ==
Sample contents text
{{Collapse bottom}}</syntaxhighlight>
 
<translate>
<!--T:74-->
must be rewritten as:
</translate>
 
<syntaxhighlight lang="html5">{{Collapse top|Section header}}
Sample contents text
{{Collapse bottom}}</syntaxhighlight>
 
<translate>
<!--T:75-->
The end result:
</translate>
 
{{Collapse top|Section header}}
Sample contents text
{{Collapse bottom}}
 
<translate>
== TemplateData == <!--T:76-->
</translate>
{{Collapse top/doc}}
 
<translate>
== See also == <!--T:11-->
</translate>
* {{Tl|Collapse bottom}}
* {{Tl|Hidden archive top}} and {{Tl|Hidden archive bottom}}
* {{Tl|Hidden begin}} and {{Tl|Hidden end}}
* {{Tl|Hidden}}}
 
[[Category:Formatting templates{{#translation:}}]]
}}
</noinclude>
</noinclude>

Revision as of 14:03, 19 April 2023

<languages/>

<translate> Extended content</translate>
<translate> The following content has been placed in a collapsed box for improved usability.</translate>
Template documentation

<translate> The <tvar name=1>{{Collapse top}}</tvar> template, and its paired template <tvar name=2>{{Collapse bottom}}</tvar>, are used for placing a collapse box around a talk page discussion.

Usage

</translate> <translate> Place <tvar name=1>{{Collapse top}}</tvar> and <tvar name=2>{{Collapse bottom}}</tvar> around the text to be collapsed.</translate> <translate> For example:</translate>

<syntaxhighlight lang="html5">

This is the title text

Sample contents text

</syntaxhighlight>

<translate> produces: </translate>

This is the title text

Sample contents text

<translate> <tvar name=1>{{Collapse bottom}}</tvar> should always be placed on its own line.

Parameters

</translate> <translate> This template takes the following parameters, all of which are optional.</translate> <translate> They are case-sensitive.</translate> <translate> Those that take CSS measurements require them in CSS format (e.g. <tvar name=1>1em</tvar> not <tvar name=2>1 em</tvar>).</translate>

|1= <translate> (or first unnamed parameter)</translate>, |title=, |reason=, |header=, |heading=
<translate> Will give the collapsed box a title, which occurs on the same line as the show link and is always visible.</translate> <translate> It defaults to "Extended content".</translate>
<translate> For example, <tvar name=1>{{Collapse top|title=This is the title text}}</tvar> or <tvar name=2>{{Collapse top|This is the title text}}</tvar>.</translate> <translate> Note: The shorter, unnamed markup will not work if the title value contain an equals (<tvar name=1>=</tvar>) character.</translate>
|warning=yes
<translate> Will display a default warning line under the main title which reads "The following is a closed debate. {{<tvar name=1>Strong|style=color:red</tvar>|Please do not modify it.}}"</translate>
<translate> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>|warning=</tvar> will not work as expected).</translate>
|2= <translate> (or second unnamed parameter)</translate>
<translate> This is optional warning-line text.</translate> <translate> It will override the standard warning line above; it is not necessary to also use <tvar name=1>|warning=yes</tvar> in this case, though doing so is harmless.</translate>
|left=yes
<translate> Will align the title along the left margin (in RTL languages, along the right margin instead).</translate>
<translate> By default, text is centered, specifically between the left edge of the green box and the left edge of the "show" link.</translate>
<translate> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>|left=</tvar> will not work as expected).</translate>
|expand=yes
<translate> Will leave the material uncollapsed with the border and coloring.</translate> <translate> Default is to collapse the material.</translate>
<translate> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>|expand=</tvar> will not work as expected).</translate>
|bg=
<translate> Sets the background color of the title of the collapsible bar.</translate> <translate> Defaults to "<tvar name=1>#F8FCFF</tvar>", a whitish color.</translate> <translate> Named colors are listed at List of colors.</translate>
<translate> For example, <tvar name=1>{{Collapse top|This is the title text|bg=#008000}}</tvar> or <tvar name=2>{{Collapse top|This is the title text|bg=green}}</tvar> (numeric HTML color codes require the leading <tvar name=H>#</tvar>).</translate>
|fc=
<translate> Sets the font color of the title of the collapsible bar.</translate> <translate> Defaults to "<tvar name=1>black</tvar>".</translate>
<translate> See <tvar name=bg>|bg=</tvar>, above, for details on color options.</translate>
|border=
<translate> Sets the width of the border line on the collapsed material.</translate> <translate> Defaults to <tvar name=1>1px</tvar>.</translate>
<translate> For example, <tvar name=1>{{Collapse top|border=2px}}</tvar>; going much thicker than this is not very useful.</translate>
|b-color=
<translate> Sets the border color.</translate> <translate> Defaults to <tvar name=1>silver</tvar> (<tvar name=2>#C0C0C0</tvar>).</translate>
<translate> See <tvar name=bg>|bg=</tvar>, above, for details on color options.</translate>
|padding=
<translate> Sets the padding (distance from borders) on the collapsed material inside the colored area.</translate> <translate> Defaults to <tvar name=1>8px</tvar>.</translate>
|width=
<translate> Sets the width of the overall template relative to the page (or a block element containing the collapse box).</translate> <translate> This should virtually always be given as a percentage, e.g. <tvar name=1>|width=50%</tvar>, or in relative <tvar name=2>em</tvar> units, e.g. <tvar name=3>|width=30em</tvar>.</translate> <translate> Pixel-based values should be avoided, as they are effectively meaningless – the result will be different depending on each user's browser and local CSS settings (which browser and operating system it is, zoom level, font sizes, etc.).</translate>
|border2=
<translate> Sets the properties of the border of the box that appears when template is expanded.</translate> <translate> Defaults to <tvar name=1>1px silver</tvar> (there is no provision to change from a solid line).</translate>
<translate> For example, <tvar name=1>{{Collapse top|border2=2px}}</tvar> (only width or color will be changed if only one value is supplied).</translate>
<translate> See <tvar name=bg>|bg=</tvar>, above, for details on color options.</translate>
|bg2=
<translate> Sets the background color of the box that appears when template is expanded; defaults to <tvar name=1>white</tvar> (<tvar name=2>#FFF</tvar>).</translate>
<translate> See <tvar name=bg>|bg=</tvar>, above, for details on color options.</translate>
|indent=
<translate> Indents the box from the left of the page.</translate> <translate> Defaults to no indentation.</translate> <translate> Each <tvar name=1>:</tvar> in talk page markup is approximately equivalent to <tvar name=2>1.6em</tvar> of indent (e.g., to match <tvar name=3>::::</tvar> indentation level, use <tvar name=4>|indent=6.4em</tvar>).</translate> <translate> You can also use a percentage value.</translate>
<translate> Pixel-based values should be avoided (see <tvar name=1>|width=</tvar>, above, for the reason).</translate>

<translate>

Examples

</translate>

  • <translate> Adding a box title (if omitted, default is "Extended content")</translate> – <syntaxhighlight lang="html5" inline>
    This is the title text
    </syntaxhighlight>
    This is the title text

    Template:Lorem ipsum

    • <translate> Adding a standard warning line</translate> – <syntaxhighlight lang="html5" inline>
      This is the title text
      <translate> The following is a closed debate.</translate> <translate> Please do not modify it.</translate>
      </syntaxhighlight>
      This is the title text
      <translate> The following is a closed debate.</translate> <translate> Please do not modify it.</translate>

      Template:Lorem ipsum

      • <translate> Adding a custom warning line</translate> – <syntaxhighlight lang="html5" inline>
        This is the title text
        This is a custom warning line
        </syntaxhighlight>
        This is the title text
        This is a custom warning line

        Template:Lorem ipsum

        • <translate> Aligning box title along left margin</translate> – <syntaxhighlight lang="html5" inline>
          <translate> Extended content</translate>
          </syntaxhighlight>
          <translate> Extended content</translate>

          Template:Lorem ipsum

          • <translate> Changing background color</translate> – <syntaxhighlight lang="html5" inline>
            <translate> Extended content</translate>
            </syntaxhighlight>
            <translate> Extended content</translate>

            Template:Lorem ipsum

            • <translate> Adding extra padding</translate> – <syntaxhighlight lang="html5" inline>
              <translate> Extended content</translate>
              </syntaxhighlight>
              <translate> Extended content</translate>

              Template:Lorem ipsum

              • <translate> Archiving a section</translate> – <translate> The markup below:</translate>
              <syntaxhighlight lang="html5">
              <translate> Extended content</translate>

              Section header

              Sample contents text

              </syntaxhighlight>

              <translate> must be rewritten as: </translate>

              <syntaxhighlight lang="html5">
              Section header

              Sample contents text

              </syntaxhighlight>

              <translate> The end result: </translate>

              Section header

              Sample contents text

              <translate>

              TemplateData

              </translate> Template:Collapse top/doc

              <translate>

              See also

              </translate>

              [[Category:Formatting templates{{#translation:}}]]

              Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
              Subpages of this template.
Retrieved from "https://nara.vindexcraft.net/index.php?title=Template:Collapse_top&oldid=230"