Template:Bulleted list/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
(Created page with "{{Documentation subpage}} {{Lua|Module:List}} {{tsh||blist}} This template may be used to generate a '''bulleted list''' in similar vein to HTML's {{tag|ul}}. A typical application is within captions, where the equivalent wiki markup (asterisks at the starts of new lines) may be awkward or impossible to use. == Usage == {{tji|bulleted list|item1|item2|...}} == Parameters == ; Positional parameters ({{para|1}}, {{para|2}}, {{para|3}}...) : t...")
 
mNo edit summary
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
{{Lua|Module:List}}
{{Lua|Module:List}}
{{tsh||blist}}
{{tsh||blist}}
__NOTOC__


This template may be used to generate a '''bulleted list''' in similar vein to HTML's {{tag|ul}}. A typical application is within captions, where the equivalent [[wikipedia:Help:Wikitext|wiki markup]] (asterisks at the starts of new lines) may be awkward or impossible to use.
This template may be used to generate a '''bulleted list''' in similar vein to HTML's {{tag|ul}}. A typical application is within captions, where the equivalent [[wikipedia:Help:Wikitext|wiki markup]] (asterisks at the starts of new lines) may be awkward or impossible to use.
Line 9: Line 10:


== Parameters ==
== Parameters ==
; Positional parameters ({{para|1}}, {{para|2}}, {{para|3}}...) : these are the list items. If no list items are present, the module will output nothing.
; Positional parameters ({{para|1}}, {{para|2}}, {{para|3}}...) : these are the list items. If no list items are present, the template will output nothing.
; {{para|class}} : a custom class for the {{tag|div}} tags surrounding the list. Set to <code>inline</code> when using {{tlf|hlist}} inside text.
; {{para|class}} : a custom class for the {{tag|div}} tags surrounding the list. Set to <code>inline</code> when using {{tlf|hlist}} inside text.
; {{para|style}} : a custom CSS style for the {{tag|div}} tags surrounding the list, e.g. <code>font-size: 90%;</code>.
; {{para|style}} : a custom CSS style for the {{tag|div}} tags surrounding the list, e.g. <code>font-size: 90%;</code>.
Line 21: Line 22:
[[File:Books.png|thumb|100px|{{bulleted list|one|two|three}}]]
[[File:Books.png|thumb|100px|{{bulleted list|one|two|three}}]]
</pre>
</pre>
{{clear}}


== See Also ==
== See Also ==
Line 26: Line 28:
* {{tl|Flowlist}}
* {{tl|Flowlist}}
* {{tl|Ordered list}}
* {{tl|Ordered list}}
== TemplateData ==
<templatedata>
{
  "description": "For the creation of bulleted lists.",
  "params": {
      "1": {
      "label": "Positional parameters",
      "description": "The list items go here.",
      "type": "string",
  "aliases": [ "2", "3", "4" ],
      "required": true
},
    "class": {
      "label": "Class",
      "description": "A class for the <div>.",
      "type": "string",
      "suggestedvalues": [ "inline" ],
      "required": false
},
    "style": {
      "label": "Style",
      "description": "CSS style for the <div>.",
      "type": "string",
  "suggestedvalues": [ "font-size" ],
      "required": false
},
    "list_style": {
      "label": "List Style",
      "description": "CSS style for the <ul>.",
      "type": "string",
      "required": false
},
    "item_style": {
      "label": "Item Style",
      "description": "Custom CSS style for all of the list items.",
      "type": "string",
      "required": false
},
    "itemN_style": {
      "label": "ItemN Style",
      "description": "Custom CSS styles for each of the list items. Where N is the item number.",
      "type": "string",
      "required": false
}
  }
}
</templatedata>


<includeonly>{{sandbox other||{{testcases other||
<includeonly>{{sandbox other||{{testcases other||


<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:List templates]]
[[Category:Formatting Templates]]
}}}}</includeonly>
}}}}</includeonly>

Latest revision as of 02:19, 20 August 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.


This template may be used to generate a bulleted list in similar vein to HTML's <ul>...</ul>. A typical application is within captions, where the equivalent wiki markup (asterisks at the starts of new lines) may be awkward or impossible to use.

Usage

{{bulleted list|item1|item2|...}}

Parameters

Positional parameters (|1=, |2=, |3=...)
these are the list items. If no list items are present, the template will output nothing.
|class=
a custom class for the <div>...</div> tags surrounding the list. Set to inline when using {{hlist}} inside text.
|style=
a custom CSS style for the <div>...</div> tags surrounding the list, e.g. font-size: 90%;.
|list_style=
a custom CSS style for the <ul>...</ul> tags around the list. The format is the same as for the |style= parameter.
|item_style=
a custom CSS style for all of the list items (the <li>...</li> tags). The format is the same as for the |style= parameter.
|item1_style=, |item2_style=, |item3_style=, ...
custom CSS styles for each of the list items. The format is the same as for the |style= parameter.

Examples

  • one
  • two
  • three
[[File:Books.png|thumb|100px|{{bulleted list|one|two|three}}]]

See Also

TemplateData

For the creation of bulleted lists.

Template parameters

ParameterDescriptionTypeStatus
Positional parameters1 2 3 4

The list items go here.

Stringrequired
Classclass

A class for the <div>.

Suggested values
inline
Stringoptional
Stylestyle

CSS style for the <div>.

Suggested values
font-size
Stringoptional
List Stylelist_style

CSS style for the <ul>.

Stringoptional
Item Styleitem_style

Custom CSS style for all of the list items.

Stringoptional
ItemN StyleitemN_style

Custom CSS styles for each of the list items. Where N is the item number.

Stringoptional