View source for Module:Enumerate/doc

{{Module rating|beta}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
This module is meant to be invoked inside of a template, since it requires the argument list of the calling template.

This module allows the enumeration of a set of parameters with a given prefix. If the prefix was <code>notes</code>, the parameters <code>notes1</code>, <code>notes2</code>, <code>notes3</code>, and so on will be enumerated in a unordered list until it sees the first null parameter.

The prefix is defined by the first argument passed into the invocation.

{| class="wikitable" style="width:100%"
! Template:X35
|-
| <pre>{{#invoke:Enumerate|main|notes}}</pre>
|-
! Any page
|-
| <pre>{{X35
| notes1 = Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
| notes2 = Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
| notes3 = Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
| notes4 = Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
}}</pre>
|-
! Output
|-
| {{Module:Enumerate/doc/demo
| notes1 = Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
| notes2 = Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
| notes3 = Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.
| notes4 = Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
}}
|}

The entries will cut off in the event that the parameters are out of order.

{| class="wikitable" style="width:100%"
! Template:X35
|-
| <pre>{{#invoke:Enumerate|main|notes}}</pre>
|-
! Any page
|-
| <pre>{{X35
| notes1 = Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
| notes2 = Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
| notes3 = 
| notes4 = Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
}}</pre>
|-
! Output
|-
| {{Module:Enumerate/doc/demo
| notes1 = Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
| notes2 = Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
| notes3 = 
| notes4 = Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
}}
|}

''Do note that {{T|X35}} is sandbox template and does not actually call this module.''

== Parameters ==

* {{Para|1}} (or {{Para|prefix}}) - The parameter prefix to enumerate over. Can be left blank.
* {{Para|2}} (or {{Para|suffix}}) - The parameter suffix  to enumerate over. Can be left blank.
* {{Para|ordered|yes}} - Set to a yes, true, etc. to output a ordered list <code>(<nowiki><ol></nowiki></code>) rather than a unorder list (<code><nowiki><ul></nowiki></code>)

* {{Para|pre}} - Text to prefix each list item with.
* {{Para|post}} - Text to suffix each list item with.

== Examples uses ==
* {{Tl|CCI project update}}

== See also ==
* {{mfl|params|with_name_matching}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Template metamodules]]
}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>