Template:ScrollBox/doc: Difference between revisions
Jump to navigation
Jump to search
(docs - open for improvements as usual) |
Thunder4ik (talk | contribs) m (→top: clean up, replaced: {{Documentation subpage → {{Doc/subpage) |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{Doc/subpage}} | ||
<!-- Please place categories where indicated at the bottom of this page.) --> | <!-- Please place categories where indicated at the bottom of this page.) --> | ||
Use this to rein in lists such as KV, Input and Ouput lists on entity pages. Reaaally long lists won'tnot flood the entire page this way. | Use this to rein in lists such as KV, Input and Ouput lists on entity pages. Reaaally long lists won'tnot flood the entire page this way. | ||
=== Parameters === | === Parameters === | ||
* {{ | * {{Param}} – The text inside the ScrollBox. | ||
* {{ | * {{Param|title}} – The title above the scroll box. Leave empty for no title. | ||
* {{ | * {{Param|bottom-border}} – If set to a non-empty value, then a short, thin line will be present at the bottom. Use if the scrollbar becomes unreliable from long lists. | ||
* {{ | * {{Param|noscroll}} – If set to a non-zero value, scrolling is disabled. Use if scrolling becomes problematic on nested ScrollBoxes. | ||
* {{ | * {{Param|maxheight}} – Change the height threshold for when the ScrollBox should be active. This isn't for things such as KV or I/O lists, as ideally these should use the default to maintain a consistency. | ||
* {{Param|color}} – Sets the background color of the ScrollBox. | |||
* {{Param|border-color}} – Sets the color of the border of the ScrollBox. | |||
* {{Param|style}} – Allows the editor to throw in any other style attributes to the ScrollBox. | |||
=== Examples === | === Examples === | ||
{| class="wikitable" style="width:100%; table-layout:fixed | <!-- Use 'wikitable' instead, or 'bottom-border' is invisible. Bonus for looking nice too --> | ||
! style="width:50% | {| class="wikitable" style="width:100%; table-layout:fixed" | ||
! style="width:50% | ! style="width:50%" | Wikitext | ||
! style="width:50%" | Result | |||
|- | |- | ||
| <pre style="width:80%;margin:auto auto | | <pre style="width:80%; margin:auto auto">{{ScrollBox|maxheight=8em| | ||
# One | # One | ||
# Two | # Two | ||
| Line 27: | Line 31: | ||
# Ten | # Ten | ||
}}</pre> | }}</pre> | ||
| {{ScrollBox| maxheight=8em| | | {{ScrollBox|maxheight=8em| | ||
# One | # One | ||
# Two | # Two | ||
| Line 40: | Line 44: | ||
}} | }} | ||
|- | |- | ||
| <pre style="width:80%;margin:auto auto | | <pre style="width:80%; margin:auto auto">{{ScrollBox|maxheight=8em|bottom-border=1| | ||
# One | # One | ||
# Two | # Two | ||
| Line 52: | Line 56: | ||
# Ten | # Ten | ||
}}</pre> | }}</pre> | ||
| {{ScrollBox| maxheight=8em | bottom-border=1| | | {{ScrollBox|maxheight=8em|bottom-border=1| | ||
# One | # One | ||
# Two | # Two | ||
| Line 65: | Line 69: | ||
}} | }} | ||
|- | |- | ||
| <pre style="width:80%;margin:auto auto | | <pre style="width:80%; margin:auto auto">{{ScrollBox|maxheight=8em|bottom-border=1|noscroll=1| | ||
# One | # One | ||
# Two | # Two | ||
| Line 77: | Line 81: | ||
# Ten | # Ten | ||
}}</pre> | }}</pre> | ||
| {{ScrollBox| maxheight=8em | bottom-border=1 | noscroll=1| | | {{ScrollBox|maxheight=8em|bottom-border=1|noscroll=1| | ||
# One | |||
# Two | |||
# Three | |||
# Four | |||
# Five | |||
# Six | |||
# Seven | |||
# Eight | |||
# Nine | |||
# Ten | |||
}} | |||
|- | |||
| <pre style="width:80%; margin:auto auto">{{ScrollBox|maxheight=8em|bottom-border=1|noscroll=0| | |||
# One | |||
# Two | |||
# Three | |||
# Four | |||
# Five | |||
# Six | |||
# Seven | |||
# Eight | |||
# Nine | |||
# Ten | |||
}}</pre> | |||
| {{ScrollBox|maxheight=8em|bottom-border=1|noscroll=0| | |||
# One | |||
# Two | |||
# Three | |||
# Four | |||
# Five | |||
# Six | |||
# Seven | |||
# Eight | |||
# Nine | |||
# Ten | |||
}} | |||
|- | |||
| <pre style="width:80%; margin:auto auto">{{ScrollBox|maxheight=8em|color=#234|border-color=#456|style=border-left:10px solid #FC6| | |||
# One | |||
# Two | |||
# Three | |||
# Four | |||
# Five | |||
# Six | |||
# Seven | |||
# Eight | |||
# Nine | |||
# Ten | |||
}}</pre> | |||
| {{ScrollBox|maxheight=8em|color=#234|border-color=#456|style=border-left:10px solid #FC6|l=1| | |||
# One | # One | ||
# Two | # Two | ||
Latest revision as of 02:17, 12 January 2024
This is a documentation subpage for Template:ScrollBox.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Use this to rein in lists such as KV, Input and Ouput lists on entity pages. Reaaally long lists won'tnot flood the entire page this way.
Parameters
- {{{1}}} – The text inside the ScrollBox.
- {{{title}}} – The title above the scroll box. Leave empty for no title.
- {{{bottom-border}}} – If set to a non-empty value, then a short, thin line will be present at the bottom. Use if the scrollbar becomes unreliable from long lists.
- {{{noscroll}}} – If set to a non-zero value, scrolling is disabled. Use if scrolling becomes problematic on nested ScrollBoxes.
- {{{maxheight}}} – Change the height threshold for when the ScrollBox should be active. This isn't for things such as KV or I/O lists, as ideally these should use the default to maintain a consistency.
- {{{color}}} – Sets the background color of the ScrollBox.
- {{{border-color}}} – Sets the color of the border of the ScrollBox.
- {{{style}}} – Allows the editor to throw in any other style attributes to the ScrollBox.
Examples
| Wikitext | Result |
|---|---|
{{ScrollBox|maxheight=8em|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
|
|
{{ScrollBox|maxheight=8em|bottom-border=1|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
|
|
{{ScrollBox|maxheight=8em|bottom-border=1|noscroll=1|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
|
|
{{ScrollBox|maxheight=8em|bottom-border=1|noscroll=0|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
|
|
{{ScrollBox|maxheight=8em|color=#234|border-color=#456|style=border-left:10px solid #FC6|
# One
# Two
# Three
# Four
# Five
# Six
# Seven
# Eight
# Nine
# Ten
}}
|
|