Template:Flatlist/doc: Difference between revisions

← Older edit Newer edit →

VisualWikitext

@@ Line 3: / Line 3: @@
 {{Documentation subpage}}
 <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
-{{used in system|in [[MediaWiki:Pageinfo-header]]}}
-{{cascade-protected template}}
-{{tlr|startflatlist|flt}}
-{{Uses TemplateStyles|Template:Hlist/styles.css}}
-This template provides a [[Web Content Accessibility Guidelines|WCAG]]/ISO-standards-compliant accessible alternative to comma- or dash- (or other single character-) separated lists, per [[WP:FLATLIST]] and [[MOS:HLIST]].
-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 ==