Module:ParseList/doc: Difference between revisions

← Older edit

Module:ParseList/doc (view source)

Revision as of 23:07, 11 October 2024

1,833 bytes added , 11 October 2024

m

→‎Output styles

HiddenDragon

Maintainers, Administrators

70,487

edits

@@ Line 18: / Line 18: @@
 ! parameter !! default !! meaning
 |-
-| <code>type</code> || <code>sentence</code>
+| <code>style</code> || '<code>text</code>'
 | The desired output format, see below for possibilities.
 |-
-| <code>delimiter</code> || <code>,</code>
+| <code>type</code> ||
-| The character that should serve as a delimiter of the list.  This can actually be a string of multiple characters which will all work as a delimiter, but that usage is discouraged as it may cause confusion.
+| ''Deprecated synonym for <code>style</code>.''
+|-
+| <code>delimiter</code> || '<code>,</code>'
+| The character that should serve as a delimiter of the input list.  This can actually be a string of multiple characters which will all work as a delimiter, but that usage is discouraged as it may cause confusion.
 |-
 | <code>makePlural</code> || ''(empty)''
@@ Line 48: / Line 51: @@
 E.g., the list element "Apple" would become <code><nowiki>{{Template|Apple|apples}}</nowiki></code> if <code>makePlural</code>, <code>makeLowercase</code>, and <code>useTemplate</code> were provided.
 |-
-| <code>joinWord</code> || <code>and</code> ||
+| <code>textDelim</code> || '<code>, </code>' ||
-If <code>type</code> is <code>sentence</code>, this defines whether to use "and" or "or" (or any other word) for the last two elements of the list.
+If <code>style</code> is <code>text</code>, this is used as the delimiter for the output list.
+Setting this causes the default value for <code>textLastDelim</code> to be changed to the same value, since the default value of <code>textLastDelim</code> is unlikely to be useful with anything other than the default value of <code>textDelim</code>.
+Note that the default value is not just a comma; it's a comma followed by a space character.
+|-
+| <code>textLastDelim</code> || ''(conditional)'' ||
+If <code>style</code> is <code>text</code>, this is used as the delimiter between the last two elements of the output list.
+If <code>textDelim</code> is not set (i.e., left at its default value), then the default value for this is '<code>, and </code>' such that an input list "X, Y, Z" would be turned into "X, Y, and Z".  You could leave <code>textDelim</code> unset, but set <code>textLastDelim = &lt;nowiki&gt;, or &lt;/nowiki&gt;</code> to get the output "X, Y, or Z" instead.
+If <code>textDelim</code> is set, then this defaults to the same value as that.  E.g., specifying <code>textDelim = &lt;nowiki&gt; + &lt;/nowiki&gt;</code> would transform the input list "X, Y, Z" into "X + Y + Z" without needing to also change the value of <code>textLastDelim</code>.
-E.g., the default would be to turn "X, Y" into "X and Y" and "X, Y, Z" into "X, Y, and Z", but by providing <code>joinWord = or</code> you can make these become "X or Y" and "X, Y, or Z" respectively.
+Note: The use of <code>&lt;nowiki&gt;</code> here is to prevent leading and trailing space characters from being ignored when setting <code>textDelim</code> or <code>textLastDelim</code> to a string that should start and/or end with a space character.
 |}
@@ Line 58: / Line 72: @@
 The <code>makeLink</code>, <code>useTemplate</code>, and <code>useTemplate2</code> arguments are mutually exclusive; when several are provided, only the first will take effect.
-=== Output types ===
+=== Output styles ===
-The value of the <code>type</code> parameter can be the following:
+The value of the <code>style</code> parameter can be the following:
 {| class="wikitable"
 ! value !! example output
 |-
-| <code>sentence</code>
+| <code>text</code>
-| {{#invoke:ParseList|main|Fighter, Cleric, Wizard}}
+| {{#invoke:ParseList | main | Fighter, Cleric, Wizard }}
+|-
+| <code>simpleList</code>
+| {{#invoke:ParseList | main | Fighter, Cleric, Wizard | style = simpleList }}
 |-
 | <code>htmlList</code>
-| {{#invoke:ParseList|main|Fighter, Cleric, Wizard|type=htmlList}}
+| {{#invoke:ParseList | main | Fighter, Cleric, Wizard | style = htmlList }}
 |-
 | <code>htmlListNoBullets</code>
-| {{#invoke:ParseList|main|Fighter, Cleric, Wizard|type=htmlListNoBullets}}
+| {{#invoke:ParseList | main | Fighter, Cleric, Wizard | style = htmlListNoBullets }}
+|-
+| <code>htmlListNoBulletsOrMargin</code>
+| {{#invoke:ParseList | main | Fighter, Cleric, Wizard | style = htmlListNoBulletsOrMargin }}
+|-
+| <code>tableList</code>
+| {{#invoke:ParseList | main | Fighter, Cleric, Wizard | style = tableList }}
 |-
-| <code>simpleList</code>
+| <code>none</code>
-| {{#invoke:ParseList|main|Fighter, Cleric, Wizard|type=simpleList}}
+| {{#invoke:ParseList | main | Fighter, Cleric, Wizard | style = none }}
 |}
+The style <code>none</code> is useful if each element is being transformed into an HTML element such that no textual delimiters are desired.
 == Examples ==
@@ Line 113: / Line 138: @@
 <pre>
-{{#invoke: ParseList | main | Fighter, Cleric, Wizard | makeLinks = yes | makePlural = yes | joinWord = or }}
+{{#invoke: ParseList | main | Fighter, Cleric, Wizard | makeLinks = yes | makePlural = yes | textLastDelim = &lt;nowiki&gt;, or &lt;/nowiki&gt; }}
 </pre>
 Result:
-: {{#invoke: ParseList | main | Fighter, Cleric, Wizard | makeLinks = yes | makePlural = yes | joinWord = or }}
+: {{#invoke: ParseList | main | Fighter, Cleric, Wizard | makeLinks = yes | makePlural = yes | textLastDelim = <nowiki>, or </nowiki> }}
 === Make Plural Links, turn into HTML list ===
 <pre>
-{{#invoke: ParseList | main | Fighter, Cleric, Wizard | makeLinks = yes | makePlural = yes | type = htmlList }}
+{{#invoke: ParseList | main | Fighter, Cleric, Wizard | makeLinks = yes | makePlural = yes | style = htmlList }}
 </pre>
 Result:
-{{#invoke: ParseList | main | Fighter, Cleric, Wizard | makeLinks = yes | makePlural = yes | type = htmlList }}
+{{#invoke: ParseList | main | Fighter, Cleric, Wizard | makeLinks = yes | makePlural = yes | style = htmlList }}