Jump to content

Template:TemplateData/doc: Difference between revisions

From CCDirectLink
Newer edit →
VisualWikitext
Created page with "Template for creating a unified parameter format for templates == About == Creates a list that displays Template parameter in a unified format. == Parameter == {{TemplateDat..."
 
doc added
Line 6: Line 6:
== Parameter ==
== Parameter ==
{{TemplateData|
{{TemplateData|
{{TemplateData/entry|name=Entries|param=1|desc=Parameter list|def=NULL|type=1 {[[Template:TemplateData/entry]]}|status=Required}}
{{TemplateData/entry|name=listType|param=1|desc=List type|example=
<pre>{{#invoke:list|bulleted|a|b|c}}</pre>
{{#invoke:list|bulleted|a|b|c}}
<pre>{{#invoke:list|unbulleted|a|b|c}}</pre>
{{#invoke:list|unbulleted|a|b|c}}
<pre>{{#invoke:list|horizontal|a|b|c}}</pre>
{{#invoke:list|horizontal|a|b|c}}
<pre>{{#invoke:list|ordered|a|b|c}}</pre>
{{#invoke:list|ordered|a|b|c}}
<pre>{{#invoke:list|horizontal_ordered|a|b|c}}</pre>
{{#invoke:list|horizontal_ordered|a|b|c}}
|def=NULL|type=<nowiki>[ "bulleted" | "unbulleted" | "horizontal" | "ordered" | "horizontal_ordered" ]</nowiki>|status=Required}}
{{TemplateData/entry|name=listEntries|param=2...x|desc=List entries|def=NULL|type=WikiCode|status=Optional}}
{{TemplateData/entry|name=olStart|param=start|desc=Start entry. <pre><ol start=""></pre> [https://developer.mozilla.org/de/docs/Web/HTML/Element/ol#Attribute MDN (ol)]. Requires <code>listType</code> <nowiki>[ "ordered" | "horizontal_ordered" ]</nowiki>|example=
<pre>{{#invoke:list|ordered|a|b|c|start=5}}</pre>
{{#invoke:list|ordered|a|b|c|start=5}}
<pre>{{#invoke:list|ordered|a|b|c|start=-5}}</pre>
{{#invoke:list|ordered|a|b|c|start=-5}}
|def=1|type=SignedNumber|status=Optional}}
{{TemplateData/entry|name=olType|param=type|desc=Ordered list type. <pre><ol type=""></pre>  [https://developer.mozilla.org/de/docs/Web/HTML/Element/ol#Attribute MDN (ol)]. Requires <code>listType</code> <nowiki>[ "ordered" | "horizontal_ordered" ]</nowiki>. It's recommended to use <code>style</code>,<code>class</code> or param <code>list_style_type</code> instead|example=
<pre>{{#invoke:list|ordered|a|b|c|type=i}}</pre>
{{#invoke:list|ordered|a|b|c|type=i}}
<pre>{{#invoke:list|ordered|a|b|c|type=a}}</pre>
{{#invoke:list|ordered|a|b|c|type=a}}
|def=1|type=<nowiki>[ "1" | "a" | "A" | "i" | "I" ]</nowiki>|status=Optional}}
{{TemplateData/entry|name=cssType|param=list_style_type|desc=Recommended list style type. Uses the css attribute <code>list-style-type</code>|example=
<pre>{{#invoke:list|ordered|a|b|c|list_style_type=lower-alpha}}</pre>
{{#invoke:list|ordered|a|b|c|list_style_type=lower-alpha}}
<pre>{{#invoke:list|ordered|a|b|c|list_style_type=lower-greek}}</pre>
{{#invoke:list|ordered|a|b|c|list_style_type=lower-greek}}
<pre>{{#invoke:list|ordered|a|b|c|list_style_type=decimal-leading-zero}}</pre>
{{#invoke:list|ordered|a|b|c|list_style_type=decimal-leading-zero}}
|def=NULL|type=[https://developer.mozilla.org/en-US/docs/Web/CSS/list-style-type MDN (list-style-type)]|status=Optional}}
{{TemplateData/entry|name=divClass|param=class|desc=<code>class</code> attribute for the <pre><div>...</div></pre> surrounding the list|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=divStyle|param=style|desc=<code>style</code> attribute for the <pre><div>...</div></pre> surrounding the list|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=listStyle|param=list_style|desc=<code>style</code> attribute for the list|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=itemStyle|param=item_style|desc=<code>style</code> attribute for the list items|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=itemXStyle|param=item1_style...itemX_style|desc=<code>style</code> attribute for item x in list|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=itemXValue|param=item1_value...itemX_value|desc=<code>value</code> attribute for item x in list|def=NULL|type=String|status=Optional}}
{{TemplateData/entry|name=listIndent|param=indent|desc=Set <code>margin-left</code> for list (<code>intent * 1.6 em</code>)|def=NULL|type=String|status=Optional}}
}}
}}


== Examples ==
== Examples ==


'''Complete example:'''
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;color:black;}}
 
{{TemplateData|
{{TemplateData/entry|name=Example name|alias1=Example alias 1|alias2=Example alias 2|alias3=Example alias 3|param=example param|desc=example description|def=NULL|example=xyz|type=String|status=Required}}
}}


<pre>
<pre>
{{TemplateData|
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;color:black;}}
{{TemplateData/entry|name=Example name|alias1=Example alias 1|alias2=Example alias 2|alias3=Example alias 3|param=example param|desc=example description|def=NULL|example=xyz|type=String|status=Required}}
}}
</pre>
</pre>

Revision as of 23:34, 31 August 2020

Template for creating a unified parameter format for templates

About

Creates a list that displays Template parameter in a unified format.

Parameter

Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.

Parameter Description Type Status
listType 1 List type

Default: NULL

Example: 

{{#invoke:list|bulleted|a|b|c}}
  • a
  • b
  • c
{{#invoke:list|unbulleted|a|b|c}}
  • a
  • b
  • c
{{#invoke:list|horizontal|a|b|c}}
  • a
  • b
  • c
{{#invoke:list|ordered|a|b|c}}
  1. a
  2. b
  3. c
{{#invoke:list|horizontal_ordered|a|b|c}}
  1. a
  2. b
  3. c
 [ "bulleted" | "unbulleted" | "horizontal" | "ordered" | "horizontal_ordered" ] Required
listEntries 2...x List entries

Default: NULL

Example: no example

WikiCode Optional
olStart start Start entry. 
<ol start="">
MDN (ol). Requires listType [ "ordered" | "horizontal_ordered" ]

Default: 1

Example: 

{{#invoke:list|ordered|a|b|c|start=5}}
  1. a
  2. b
  3. c
{{#invoke:list|ordered|a|b|c|start=-5}}
  1. a
  2. b
  3. c
 SignedNumber Optional
olType type Ordered list type. 
<ol type="">
MDN (ol). Requires listType [ "ordered" | "horizontal_ordered" ]. It's recommended to use style,class or param list_style_type instead

Default: 1

Example: 

{{#invoke:list|ordered|a|b|c|type=i}}
  1. a
  2. b
  3. c
{{#invoke:list|ordered|a|b|c|type=a}}
  1. a
  2. b
  3. c
 [ "1" | "a" | "A" | "i" | "I" ] Optional
cssType list_style_type Recommended list style type. Uses the css attribute list-style-type

Default: NULL

Example: 

{{#invoke:list|ordered|a|b|c|list_style_type=lower-alpha}}
  1. a
  2. b
  3. c
{{#invoke:list|ordered|a|b|c|list_style_type=lower-greek}}
  1. a
  2. b
  3. c
{{#invoke:list|ordered|a|b|c|list_style_type=decimal-leading-zero}}
  1. a
  2. b
  3. c
 MDN (list-style-type) Optional
divClass class class attribute for the 
<div>...</div>
surrounding the list

Default: NULL

Example: no example

String Optional
divStyle style style attribute for the 
<div>...</div>
surrounding the list

Default: NULL

Example: no example

String Optional
listStyle list_style style attribute for the list

Default: NULL

Example: no example

String Optional
itemStyle item_style style attribute for the list items

Default: NULL

Example: no example

String Optional
itemXStyle item1_style...itemX_style style attribute for item x in list

Default: NULL

Example: no example

String Optional
itemXValue item1_value...itemX_value value attribute for item x in list

Default: NULL

Example: no example

String Optional
listIndent indent Set margin-left for list (intent * 1.6 em)

Default: NULL

Example: no example

String Optional

See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation

Examples

  • First item
  • Second item
  • Third item
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;color:black;}}
Retrieved from "https://wiki.c2dl.info/w/index.php?title=Template:TemplateData/doc&oldid=141"