Template:NamedGroup/doc: Difference between revisions

Latest revision as of 20:21, 13 April 2022

This is a documentation subpage for Template:NamedGroup.It contains usage information, categories, and other content that is not part of the original template page.

This template takes a list of items with an optional name and formats them for insertion into a table. Used to process individual list from within the Template:NamedList template.

Titled group with << >> list:

{{NamedGroup|Title << item 1, item 2, item 3>>}}

Title||item 1,item 2,item 3

Group with title parameter and ~~ delimiter:

{{NamedGroup|item 1, item 2, item 3 | Title|~~}}

Title~~item 1,item 2,item 3

Group with no title and "-" list delimiter:

 {{NamedGroup|item 1, item2, item 3}}

item 1-item2-item 3

No description.

Template parameters
Parameter		Description	Type	Status
1	`1`	List of items in group (optionally << >> encapsed with group name in front)	Unknown	optional
2	`2`	Title of group (if not included in parameter 1)	Unknown	optional
3	`3`	Delimiter between group title and list of items	Unknown	optional
4	`4`	Delimiter between list items	Unknown	optional

@@ Line 1: / Line 1: @@
+{{Documentation}}
 This template takes a list of items with an optional name and formats them for insertion into a table. Used to process individual list from within the [[Template:NamedList]] template.
-Examples:
+Titled group with << >> list:
-<pre>Title { item 1, item 2, item 3}</pre>
+<pre>{{NamedGroup|Title << item 1, item 2, item 3>>}}</pre>
-{{NamedGroup|Title { item 1, item 2, item 3}}}
+ {{NamedGroup|Title << item 1, item 2, item 3>>}}
-<pre>item 1, item 2, item 3 | Title</pre>
+Group with title parameter and ~~ delimiter:
-{{NamedGroup|item 1, item 2, item 3 | Title}}
+<pre>{{NamedGroup|item 1, item 2, item 3 | Title|~~}}</pre>
-<pre>this list, has no title, will default to "list"</pre>
+ {{NamedGroup|item 1, item 2, item 3 | Title|~~}}
-{{NamedGroup|this list, has no title, will default to "list"}}
+Group with no title and "-" list delimiter:
+<pre> {{NamedGroup|item 1, item2, item 3}}</pre>
+ {{NamedGroup|item 1, item2, item 3|||-}}
+<templatedata>
+{
+	"params": {
+		"1": {
+			"description": "List of items in group (optionally << >> encapsed with group name in front)"
+		},
+		"2": {
+			"description": "Title of group (if not included in parameter 1)"
+		},
+		"3": {
+			"description": "Delimiter between group title and list of items"
+		},
+		"4": {
+			"description": "Delimiter between list items"
+		}
+	}
+}
+</templatedata>