Template:Plainlist/doc - Revision history

RogueScholar: Usage refinements

2022-09-10T14:53:39Z

Usage refinements

RogueScholar: Add example using 'indent-wrap' parameter

2022-09-10T14:16:25Z

Add example using 'indent-wrap' parameter

← Older revision		Revision as of 14:16, 10 September 2022
Line 34:		Line 34:

	== Examples ==		== Examples ==
	{\|		{\| style="border-collapse: collapse; margin: 1.5em auto;"
	! scope="col" \| Wiki markup		\|- style="background-color: #c7c8c9;"
	! scope="col" \| Output generated		! scope="col" style="padding: 0.33em;" \| Wiki markup
	\|-		! scope="col" style="padding: 0.33em;" \| Output generated
	\| {{Tlx\|Plainlist\|Item 1\|Item 2\|Item 3\|Item 4\|Item 5\|Item 6\|Item 7\|Item 8\|Item 9}}		\|- style="border-bottom: 2px solid lightgray;"
	\| {{Plainlist\|Item 1\|Item 2\|Item 3\|Item 4\|Item 5\|Item 6\|Item 7\|Item 8\|Item 9}}		\| style="padding: 0.8em;" \| {{Tlx\|Plainlist\|Item 1\|Item 2\|Item 3\|Item 4\|Item 5\|Item 6\|Item 7\|Item 8\|Item 9}}
	\|-		\| style="padding: 0.8em;" \| {{Plainlist\|Item 1\|Item 2\|Item 3\|Item 4\|Item 5\|Item 6\|Item 7\|Item 8\|Item 9}}
	\| Giant planets (<code><nowiki>{{Plainlist\|[[w:Jupiter\|J]]\|[[w:Saturn\|S]]\|[[w:Uranus\|U]]\|[[w:Neptune\|N]]}}</nowiki></code>).		\|- style="border-bottom: 2px solid lightgray;"
	\| Giant planets ({{Plainlist\|[[wikipedia:Jupiter\|J]]\|[[wikipedia:Saturn\|S]]\|[[wikipedia:Uranus\|U]]\|[[wikipedia:Neptune\|N]]\|list-style=display: inline;}}).		\| style="padding: 0.8em;" \| Giant planets (<code><nowiki>{{Plainlist\|[[w:Jupiter\|J]]\|[[w:Saturn\|S]]\|[[w:Uranus\|U]]\|[[w:Neptune\|N]]}}</nowiki></code>).
	\|-		\| style="padding: 0.8em;" \| Giant planets ({{Plainlist\|[[wikipedia:Jupiter\|J]]\|[[wikipedia:Saturn\|S]]\|[[wikipedia:Uranus\|U]]\|[[wikipedia:Neptune\|N]]\|list-style=display: inline;}}).
	\| Giant planets (<code><nowiki>{{Plainlist\|[[w:Jupiter\|J]]\|[[w:Saturn\|S]]\|[[w:Uranus\|U]]\|[[w:Neptune\|N]]\|class=inline}}</nowiki></code>).		\|- style="border-bottom: 2px solid lightgray;"
	\| Giant planets ({{Plainlist\|[[wikipedia:Jupiter\|J]]\|[[wikipedia:Saturn\|S]]\|[[wikipedia:Uranus\|U]]\|[[wikipedia:Neptune\|N]]\|class=inline\|list-style=display: inline;}}).		\| style="padding: 0.8em;" \| Giant planets (<code><nowiki>{{Plainlist\|[[w:Jupiter\|J]]\|[[w:Saturn\|S]]\|[[w:Uranus\|U]]\|[[w:Neptune\|N]]\|class=inline}}</nowiki></code>).
	\|-		\| style="padding: 0.8em;" \| Giant planets ({{Plainlist\|[[wikipedia:Jupiter\|J]]\|[[wikipedia:Saturn\|S]]\|[[wikipedia:Uranus\|U]]\|[[wikipedia:Neptune\|N]]\|class=inline\|list-style=display: inline;}}).
	\| {{Tlx\|Plainlist\|Winner\|Runner-up\|Third place\|5=indent-all=yes\|6=indent=2}}		\|- style="border-bottom: 2px solid lightgray;"
	\| {{Plainlist\|Winner\|Runner-up\|Third place\|indent-all=yes\|indent=2}}		\| style="padding: 0.8em;" \| {{Tlx\|Plainlist\|Winner\|Runner-up\|Third place\|5=indent-all=yes\|6=indent=2}}
	\|-		\| style="padding: 0.8em;" \| {{Plainlist\|Winner\|Runner-up\|Third place\|indent-all=yes\|indent=2}}
	\| {{Tlx\|Plainlist\|Winner\|Runner-up\|Third place\|5=item-style=color: blue;}}		\|- style="border-bottom: 2px solid lightgray;"
	\| {{Plainlist\|Winner\|Runner-up\|Third place\|item-style=color: blue;}}		\| style="padding: 0.8em;" \| {{Tlx\|Plainlist\|Winner\|Runner-up\|Lorem dolum ipsum sit. Lorem dolum ipsum sit. Lorem dolum ipsum sit. Lorem dolum ipsum sit.\|5=indent-wrap=yes}}
			\| style="padding: 0.8em;" \| {{Plainlist\|Winner\|Runner-up\|Lorem dolum ipsum sit. Lorem dolum ipsum sit. Lorem dolum ipsum sit. Lorem dolum ipsum sit.\|indent-wrap=yes}}
			\|- style="border-bottom: 2px solid lightgray;"
			\| style="padding: 0.8em;" \| {{Tlx\|Plainlist\|Winner\|Runner-up\|Third place\|5=item-style=color: blue;}}
			\| style="padding: 0.8em;" \| {{Plainlist\|Winner\|Runner-up\|Third place\|item-style=color: blue;}}
	\|-		\|-
	\| {{Tlx\|Plainlist\|Winner\|Runner-up\|Third place\|5=item1-style=background-color: yellow;\|6=item2-style=text-decoration: underline;}}		\| style="padding: 0.8em;" \| {{Tlx\|Plainlist\|Winner\|Runner-up\|Third place\|5=item1-style=background-color: yellow;\|6=item2-style=text-decoration: underline;}}
	\| {{Plainlist\|Winner\|Runner-up\|Third place\|item1-style=background-color: yellow;\|item2-style=text-decoration: underline;}}		\| style="padding: 0.8em;" \| {{Plainlist\|Winner\|Runner-up\|Third place\|item1-style=background-color: yellow;\|item2-style=text-decoration: underline;}}
	\|}		\|}

Line 88:		Line 92:
	\|}<includeonly>		\|}<includeonly>

			<!-- Categories go here -->
	~~{{Sandbox other\|\|~~<!-- Categories go here -->		[[Category:List templates]]</includeonly>
	[[Category:List templates]]

	}}</includeonly>

RogueScholar: Create template documentation page

2022-09-10T14:00:07Z

Create template documentation page

New page

{{Documentation subpage}}
This template creates plain lists, which retain their semantic distinction as HTML list objects, but without any symbolic prefix visually identifying them as such. The default layout is horizontal and uses bullet characters (<code>•</code>) as separators, but assigning a value to the {{Para|indent-wrap}} parameter allows it to be switched to a vertical one (new line-delimited) with a hanging indent for each item instead. The list as a whole or each individual item in it may be styled with [[wikipedia:CSS|CSS3]].

== Usage ==
=== Basic usage ===
{{Tlx|Plainlist|''Item 1''|''Item 2''|''Item 3''|…}}

=== Complete syntax ===
<syntaxhighlight lang="text">
{{Plainlist|Item 1|Item 2|Item 3|…
| class = CSS classes for list box
| style = CSS styles for list box
| list-style = CSS styles for entire list
| item-style = CSS styles for all list items
| item1-style = CSS styles for first list item only
| item2-style = CSS styles for second list item
| …
| indent-all = Set to any value to indent all list items from left margin
| indent-wrap = Set to any value to switch to an unbulleted vertical list where list items that wrap onto multiple lines are indented
| indent = Amount of indentation as a number of tab-stops
}}
</syntaxhighlight>

== Parameters ==
* {{Para|1}}, {{Para|2}}, {{Para|3}}, … Positional parameters are the list items, they can be most any kind of wikitext or even wikilinks (assign using their number for values containing an equality sign).
* {{Para|class}} Custom CSS classes for the {{Tag|div}} tags surrounding the list.
* {{Para|style}} Custom CSS styles for the {{Tag|div}} tags surrounding the list, e.g. <code>font-size: 0.9em;</code>.
* {{Para|list-style}} Custom CSS styles for the {{Tag|ul}} tags around the list. The format is the same as for the {{Para|style}} parameter.
* {{Para|item-style}} Custom CSS styles for all of the list items (all of the {{Tag|li}} tags). The format is the same as for the {{Para|style}} parameter.
* {{Para|item1-style}}, {{Para|item2-style}}, {{Para|item3-style}}, … Custom CSS styles for a single list item. The format is the same as for the {{Para|style}} parameter.
* {{Para|indent-all}} When set to any value, indents the entire list from the left margin by <code>indent</code> tab stops.
* {{Para|indent-wrap}} When set to any value, switch list layout to vertical and indent list items that wrap to multiple lines by <code>indent</code> tab stops.
* {{Para|indent}} or {{Para|in}} Amount of indentation from the left margin expressed as tab stops. Default value is 0.

== Examples ==
{|
! scope="col" | Wiki markup
! scope="col" | Output generated
|-
| {{Tlx|Plainlist|Item 1|Item 2|Item 3|Item 4|Item 5|Item 6|Item 7|Item 8|Item 9}}
| {{Plainlist|Item 1|Item 2|Item 3|Item 4|Item 5|Item 6|Item 7|Item 8|Item 9}}
|-
| Giant planets (<code><nowiki>{{Plainlist|[[w:Jupiter|J]]|[[w:Saturn|S]]|[[w:Uranus|U]]|[[w:Neptune|N]]}}</nowiki></code>).
| Giant planets ({{Plainlist|[[wikipedia:Jupiter|J]]|[[wikipedia:Saturn|S]]|[[wikipedia:Uranus|U]]|[[wikipedia:Neptune|N]]|list-style=display: inline;}}).
|-
| Giant planets (<code><nowiki>{{Plainlist|[[w:Jupiter|J]]|[[w:Saturn|S]]|[[w:Uranus|U]]|[[w:Neptune|N]]|class=inline}}</nowiki></code>).
| Giant planets ({{Plainlist|[[wikipedia:Jupiter|J]]|[[wikipedia:Saturn|S]]|[[wikipedia:Uranus|U]]|[[wikipedia:Neptune|N]]|class=inline|list-style=display: inline;}}).
|-
| {{Tlx|Plainlist|Winner|Runner-up|Third place|5=indent-all=yes|6=indent=2}}
| {{Plainlist|Winner|Runner-up|Third place|indent-all=yes|indent=2}}
|-
| {{Tlx|Plainlist|Winner|Runner-up|Third place|5=item-style=color: blue;}}
| {{Plainlist|Winner|Runner-up|Third place|item-style=color: blue;}}
|-
| {{Tlx|Plainlist|Winner|Runner-up|Third place|5=item1-style=background-color: yellow;|6=item2-style=text-decoration: underline;}}
| {{Plainlist|Winner|Runner-up|Third place|item1-style=background-color: yellow;|item2-style=text-decoration: underline;}}
|}

== Avoiding Linter errors ==
{{Tl|Plainlist}} will produce [[wikipedia:Wikipedia:Linter|Linter]] errors if placed inside a template that uses {{Tag|span}} tags, such as {{Tl|Small}}, {{Tl|Larger}}, etc. To avoid this, use the style declarations like the ones shown in the table below.
{|
! scope="col" | Incorrect markup
! scope="col" | Correct markup
|-
| <syntaxhighlight lang="text" inline>{{Small|{{Plainlist|…}}}}</syntaxhighlight>
| {{Tlx|Plainlist|2=…|3=style=font-size: 0.85em;}}
|-
| <syntaxhighlight lang="text" inline>{{Resize|{{Plainlist|…}}}}</syntaxhighlight>
| {{Tlx|Plainlist|2=…|3=style=font-size: 0.9em;}}
|-
| <syntaxhighlight lang="text" inline>{{Larger|{{Plainlist|…}}}}</syntaxhighlight>
| {{Tlx|Plainlist|2=…|3=style=font-size: 1.1em;}}
|-
| <syntaxhighlight lang="text" inline>{{Large|{{Plainlist|…}}}}</syntaxhighlight>
| {{Tlx|Plainlist|2=…|3=style=font-size: 1.125em;}}
|-
| <syntaxhighlight lang="text" inline>{{Big|{{Plainlist|…}}}}</syntaxhighlight>
| {{Tlx|Plainlist|2=…|3=style=font-size: 1.2em;}}
|-
| <syntaxhighlight lang="text" inline>{{Huge|{{Plainlist|…}}}}</syntaxhighlight>
| {{Tlx|Plainlist|2=…|3=style=font-size: 1.8em;}}
|-
| <syntaxhighlight lang="text" inline>{{Resize|x%|{{Plainlist|…}}}}</syntaxhighlight>
| {{Tlx|Plainlist|2=…|3=style=font-size: x%;}}
|-
| <syntaxhighlight lang="text" inline>{{Nowrap|{{Plainlist|…}}}}</syntaxhighlight>
| {{Tlx|Plainlist|2=…|3=style=white-space: nowrap;}}
|}<includeonly>

{{Sandbox other||
[[Category:List templates]]

}}</includeonly>

← Older revision		Revision as of 14:53, 10 September 2022
Line 25:		Line 25:
	* {{Para\|1}}, {{Para\|2}}, {{Para\|3}}, … Positional parameters are the list items, they can be most any kind of wikitext or even wikilinks (assign using their number for values containing an equality sign).		* {{Para\|1}}, {{Para\|2}}, {{Para\|3}}, … Positional parameters are the list items, they can be most any kind of wikitext or even wikilinks (assign using their number for values containing an equality sign).
	* {{Para\|class}} Custom CSS classes for the {{Tag\|div}} tags surrounding the list.		* {{Para\|class}} Custom CSS classes for the {{Tag\|div}} tags surrounding the list.
	* {{Para\|style}} Custom CSS styles for the {{Tag\|div}} tags surrounding the list, e.g. <code>font-size: 0.9em;</code>.		* {{Para\|style}} Custom CSS styles for the {{Tag\|div}} tags surrounding the list, e.g. <code>font-size: 0.9em;</code>. When inserting this template with surrounding text, you must add <code>display: inline-block;</code> here.
	* {{Para\|list-style}} Custom CSS styles for the {{Tag\|ul}} tags around the list. The format is the same as for the {{Para\|style}} parameter.		* {{Para\|list-style}} Custom CSS styles for the {{Tag\|ul}} tags around the list. The format is the same as for the {{Para\|style}} parameter.
	* {{Para\|item-style}} Custom CSS styles for all of the list items (all of the {{Tag\|li}} tags). The format is the same as for the {{Para\|style}} parameter.		* {{Para\|item-style}} Custom CSS styles for all of the list items (all of the {{Tag\|li}} tags). The format is the same as for the {{Para\|style}} parameter.
Line 43:		Line 43:
	\|- style="border-bottom: 2px solid lightgray;"		\|- style="border-bottom: 2px solid lightgray;"
	\| style="padding: 0.8em;" \| Giant planets (<code><nowiki>{{Plainlist\|[[w:Jupiter\|J]]\|[[w:Saturn\|S]]\|[[w:Uranus\|U]]\|[[w:Neptune\|N]]}}</nowiki></code>).		\| style="padding: 0.8em;" \| Giant planets (<code><nowiki>{{Plainlist\|[[w:Jupiter\|J]]\|[[w:Saturn\|S]]\|[[w:Uranus\|U]]\|[[w:Neptune\|N]]}}</nowiki></code>).
	\| style="padding: 0.8em;" \| Giant planets ({{Plainlist\|[[wikipedia:Jupiter\|J]]\|[[wikipedia:Saturn\|S]]\|[[wikipedia:Uranus\|U]]\|[[wikipedia:Neptune\|N]]~~\|list-style=display: inline;~~}}).		\| style="padding: 0.8em;" \| Giant planets ({{Plainlist\|[[wikipedia:Jupiter\|J]]\|[[wikipedia:Saturn\|S]]\|[[wikipedia:Uranus\|U]]\|[[wikipedia:Neptune\|N]]}}).
	\|- style="border-bottom: 2px solid lightgray;"		\|- style="border-bottom: 2px solid lightgray;"
	\| style="padding: 0.8em;" \| Giant planets (<code><nowiki>{{Plainlist\|[[w:Jupiter\|J]]\|[[w:Saturn\|S]]\|[[w:Uranus\|U]]\|[[w:Neptune\|N]]\|~~class~~=inline}}</nowiki></code>).		\| style="padding: 0.8em;" \| Giant planets (<code><nowiki>{{Plainlist\|[[w:Jupiter\|J]]\|[[w:Saturn\|S]]\|[[w:Uranus\|U]]\|[[w:Neptune\|N]]\|style=display: inline-block;}}</nowiki></code>).
	\| style="padding: 0.8em;" \| Giant planets ({{Plainlist\|[[wikipedia:Jupiter\|J]]\|[[wikipedia:Saturn\|S]]\|[[wikipedia:Uranus\|U]]\|[[wikipedia:Neptune\|N]]\|~~class=inline\|list-~~style=display: inline;}}).		\| style="padding: 0.8em;" \| Giant planets ({{Plainlist\|[[wikipedia:Jupiter\|J]]\|[[wikipedia:Saturn\|S]]\|[[wikipedia:Uranus\|U]]\|[[wikipedia:Neptune\|N]]\|style=display: inline-block;}}).
	\|- style="border-bottom: 2px solid lightgray;"		\|- style="border-bottom: 2px solid lightgray;"
	\| style="padding: 0.8em;" \| {{Tlx\|Plainlist\|Winner\|Runner-up\|Third place\|5=indent-all=yes\|6=indent=2}}		\| style="padding: 0.8em;" \| {{Tlx\|Plainlist\|Winner\|Runner-up\|Third place\|5=indent-all=yes\|6=indent=2}}