Module:Enumerate/doc: Difference between revisions
Content deleted Content added
BrandonXLF (talk | contribs) |
BrandonXLF (talk | contribs) Document parameters |
||
| Line 60: | Line 60: | ||
''Do note that {{T|X35}} is sandbox template and does not actually call this module.'' |
''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 == |
|||
| ⚫ | |||
== See also == |
== See also == |
||
Latest revision as of 17:33, 8 September 2024
Usage
[edit]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 notes, the parameters notes1, notes2, notes3, 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.
| Template:X35 |
|---|
{{#invoke:Enumerate|main|notes}}
|
| Any page |
{{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.
}}
|
| Output |
|
The entries will cut off in the event that the parameters are out of order.
| Template:X35 |
|---|
{{#invoke:Enumerate|main|notes}}
|
| Any page |
{{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.
}}
|
| Output |
|
Do note that {{X35}} is sandbox template and does not actually call this module.
Parameters
[edit]|1=(or|prefix=) - The parameter prefix to enumerate over. Can be left blank.|2=(or|suffix=) - The parameter suffix to enumerate over. Can be left blank.|ordered=yes- Set to a yes, true, etc. to output a ordered list(<ol>) rather than a unorder list (<ul>)
|pre=- Text to prefix each list item with.|post=- Text to suffix each list item with.