Template:Flatlist/doc - Revision history

Cellan3 at 00:07, 11 April 2025

2025-04-11T00:07:32Z

← Older revision		Revision as of 18:07, 10 April 2025
Line 57:		Line 57:
	},		},
	"description": {		"description": {
	"en": "Adds extra CSS properties to the containing div~~. Complex styles should not be used in articles (per [[MOS:DEVIATIONS]]) but may be acceptable on user, project and talk pages~~."		"en": "Adds extra CSS properties to the containing div. "
	},		},
	"example": "\n border: solid 1px silver;\n background: lightyellow;\n",		"example": "\n border: solid 1px silver;\n background: lightyellow;\n",
Line 67:		Line 67:
	},		},
	"description": {		"description": {
	"en": "Indents the list by a number of standard indents (one indent being 1.~~6[[em (typography)\|em]]~~). (Useful in an indented discussion thread.)"		"en": "Indents the list by a number of standard indents (one indent being 1.6em). (Useful in an indented discussion thread.)"
	},		},
	"example": "2",		"example": "2",

Cellan3: /* Examples */

2025-04-09T23:33:15Z

Examples

← Older revision		Revision as of 17:33, 9 April 2025
Line 95:		Line 95:
	<syntaxhighlight lang="wikitext">		<syntaxhighlight lang="wikitext">
	{{flatlist\|		{{flatlist\|
	* [[~~cat~~]]		* [[Sol system]]
	* [[~~dog~~]]		* [[Alpha Centauri system]]
	* [[~~horse~~]]		* [[Procyon system]]
	* [[~~cow~~]]		* [[Hawkeye system]]
	* [[~~sheep~~]]		* [[Casey system]]
	* [[~~pig~~]]		* [[Ikeda system]]
	}}		}}
	</syntaxhighlight>		</syntaxhighlight>
Line 107:		Line 107:

	{{flatlist\|		{{flatlist\|
	* [[~~cat~~]]		* [[Sol system]]
	* [[~~dog~~]]		* [[Alpha Centauri system]]
	* [[~~horse~~]]		* [[Procyon system]]
	* [[~~cow~~]]		* [[Hawkeye system]]
	* [[~~sheep~~]]		* [[Casey system]]
	* [[~~pig~~]]		* [[Ikeda system]]
	}}		}}

Line 118:		Line 118:
	<syntaxhighlight lang="wikitext">		<syntaxhighlight lang="wikitext">
	{{startflatlist}}		{{startflatlist}}
	* [[~~cat~~]]		* [[Sol system]]
	* [[~~dog~~]]		* [[Alpha Centauri system]]
	* [[~~horse~~]]		* [[Procyon system]]
	* [[~~cow~~]]		* [[Hawkeye system]]
	* [[~~sheep~~]]		* [[Casey system]]
	* [[~~pig~~]]		* [[Ikeda system]]
	{{endflatlist}}		{{endflatlist}}
	</syntaxhighlight>		</syntaxhighlight>
Line 130:		Line 130:

	{{startflatlist}}		{{startflatlist}}
	* [[~~cat~~]]		* [[Sol system]]
	* [[~~dog~~]]		* [[Alpha Centauri system]]
	* [[~~horse~~]]		* [[Procyon system]]
	* [[~~cow~~]]		* [[Hawkeye system]]
	* [[~~sheep~~]]		* [[Casey system]]
	* [[~~pig~~]]		* [[Ikeda system]]
	{{endflatlist}}		{{endflatlist}}

Line 141:		Line 141:
	<syntaxhighlight lang="wikitext">		<syntaxhighlight lang="wikitext">
	{{flatlist\|		{{flatlist\|
	# [[~~first~~]]		# [[Sol system]]
	# [[~~second~~]]		# [[Alpha Centauri system]]
	# [[~~3\|third~~]]		# [[Procyon system]]
	# [[~~fourth~~]]		# [[Hawkeye system]]
	# [[~~fifth~~]]		# [[Casey system]]
	# [[~~sixth~~]]		# [[Ikeda system]]
	}}		}}
	</syntaxhighlight>		</syntaxhighlight>
Line 153:		Line 153:

	{{flatlist\|		{{flatlist\|
	# [[~~first~~]]		# [[Sol system]]
	# [[~~second~~]]		# [[Alpha Centauri system]]
	# [[~~3\|third~~]]		# [[Procyon system]]
	# [[~~fourth~~]]		# [[Hawkeye system]]
	# [[~~fifth~~]]		# [[Casey system]]
	# [[~~sixth~~]]		# [[Ikeda system]]
	}}		}}

Cellan3: /* Using optional parameters */

2025-04-09T23:31:36Z

Using optional parameters

← Older revision		Revision as of 17:31, 9 April 2025
Line 179:		Line 179:
	{{flatlist \|indent=2 \|style=border:solid 1px silver; background:lightyellow; \|class=nowraplinks \|		{{flatlist \|indent=2 \|style=border:solid 1px silver; background:lightyellow; \|class=nowraplinks \|
	* [[Sol system]]		* [[Sol system]]
	* [[Alpha Centauri]]		* [[Alpha Centauri system]]
	* [[Procyon system]]		* [[Procyon system]]
	* [[Hawkeye system]]		* [[Hawkeye system]]

Cellan3: Created page with "{{Documentation subpage}} {{used in system|in MediaWiki:Pageinfo-header}} {{tlr|startflatlist|flt}} {{Uses TemplateStyles|Template:Hlist/styles.css}} This template provides a Web Content Accessibility Guideline (WCAG)/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists. Lists output by {{tl|Flatlist}} and {{tl|Hlist}} are semantically and vis..."

2025-04-09T23:31:12Z

Created page with "{{Documentation subpage}}  {{used in system|in MediaWiki:Pageinfo-header}} {{tlr|startflatlist|flt}} {{Uses TemplateStyles|Template:Hlist/styles.css}} This template provides a Web Content Accessibility Guideline (WCAG)/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists. Lists output by {{tl|Flatlist}} and {{tl|Hlist}} are semantically and vis..."

New page

{{Documentation subpage}}

{{used in system|in [[MediaWiki:Pageinfo-header]]}}
{{tlr|startflatlist|flt}}
{{Uses TemplateStyles|Template:Hlist/styles.css}}
This template provides a Web Content Accessibility Guideline (WCAG)/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists.

Lists output by {{tl|Flatlist}} and {{tl|Hlist}} are semantically and visually identical, and differ only in the wiki-markup used to create the lists.

{{TOC limit|3}}

== Usage ==
{{tl|flatlist}} starts a horizontal list, such as:

{{flatlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}

If this template is used with no parameters, {{tl|endflatlist}} is required. For navigation boxes using {{tl|navbox}}, one can set {{para|listclass|hlist}}, and achieve the same styling without using this template. For image captions, list (i.e. asterisk) markup does not work, so consider using {{tl|hlist}} instead.

== Parameters ==
{{#switch:{{NAMESPACE}}:{{ROOTPAGENAME}}|#default=
{{Format TemplateData|<templatedata>
{
"description": {
"en": "Used to create plain (i.e. unbulleted) lists."
},
"format": "inline",
"params": {
"1": {
"label": {
"en": "Content"
},
"description": {
"en": "The list to wrap."
},
"suggested": true,
"type": "content"
},
"class": {
"label": {
"en": "Extra Classes"
},
"description": {
"en": "Adds extra CSS classes to the containing div."
},
"type": "string"
},
"style": {
"label": {
"en": "CSS Style"
},
"description": {
"en": "Adds extra CSS properties to the containing div. Complex styles should not be used in articles (per [[MOS:DEVIATIONS]]) but may be acceptable on user, project and talk pages."
},
"example": "\n border: solid 1px silver;\n background: lightyellow;\n",
"type": "string"
},
"indent": {
"label": {
"en": "Indent"
},
"description": {
"en": "Indents the list by a number of standard indents (one indent being 1.6[[em (typography)|em]]). (Useful in an indented discussion thread.)"
},
"example": "2",
"type": "number"
}
},
"paramOrder": [
"class",
"style",
"indent",
"1"
]
}
</templatedata>}}
|Template:Endflatlist=
{{Format TemplateData|JSON=
{
"description": "Ends a flat list created by {{tl|flatlist}}.",
"format": "inline",
"params": {
}
}
}}
}}

== Examples ==
<syntaxhighlight lang="wikitext">
{{flatlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}
</syntaxhighlight>

produces:

{{flatlist|
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
}}

=== Alternative syntax ===
<syntaxhighlight lang="wikitext">
{{startflatlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endflatlist}}
</syntaxhighlight>

produces:

{{startflatlist}}
* [[cat]]
* [[dog]]
* [[horse]]
* [[cow]]
* [[sheep]]
* [[pig]]
{{endflatlist}}

=== Syntax for ordered lists ===
<syntaxhighlight lang="wikitext">
{{flatlist|
# [[first]]
# [[second]]
# [[3|third]]
# [[fourth]]
# [[fifth]]
# [[sixth]]
}}
</syntaxhighlight>

produces:

{{flatlist|
# [[first]]
# [[second]]
# [[3|third]]
# [[fourth]]
# [[fifth]]
# [[sixth]]
}}

=== Using optional parameters ===
<syntaxhighlight lang="wikitext">
{{flatlist |indent=2
|style=border:solid 1px silver; background:lightyellow;
|class=nowraplinks |
* [[Sol system]]
* [[Alpha Centauri system]]
* [[Procyon system]]
* [[Hawkeye system]]
* [[Casey system]]
* [[Ikeda system]]
}}
</syntaxhighlight>

produces:

{{flatlist |indent=2 |style=border:solid 1px silver; background:lightyellow; |class=nowraplinks |
* [[Sol system]]
* [[Alpha Centauri]]
* [[Procyon system]]
* [[Hawkeye system]]
* [[Casey system]]
* [[Ikeda system]]
}}

== Technical details ==
This template uses the <code>.hlist</code> CSS class defined in [[MediaWiki:Common.css]] to generate horizontal lists. It causes ordinary html list items to be displayed inline (horizontally), where they would normally display as block elements (vertically). The class also generates the interpuncts between list items and parentheses around nested lists.

{| class="wikitable"
! Wikitext
! Expanded template
! HTML
|- style="vertical-align:top;"
| <syntaxhighlight lang="wikitext">
{{flatlist|
* cat
* dog
* horse
* cow
* sheep
* pig
}}
</syntaxhighlight>
| {{nowiki2|tag=pre|
{{flatlist|
* cat
* dog
* horse
* cow
* sheep
* pig
}}
}}
| <syntaxhighlight lang="html">
<div class="hlist">
<ul><li>cat</li>
<li>dog</li>
<li>horse</li>
<li>cow</li>
<li>sheep</li>
<li>pig</li></ul>
</div>
</syntaxhighlight>
|}

== See also ==
* {{tl|endflatlist}}
* {{tl|hlist}}
* {{tl|plainlist}} and {{tl|unbulleted list}}
* {{tl|bulleted list}}
* {{tl|ordered list}}
* {{tl|nowrap}}
* {{tl|pagelist}}
{{HTML lists}}
<includeonly>{{Sandbox other||

[[Category:Typing-aid templates|Flatlist]]
[[Category:List formatting and function templates|Flatlist]]
}}</includeonly>