Module:LeftAlignedList
Jump to navigation
Jump to search
Module:LeftAlignedList
Utility module to support Template:LeftAlignedList by converting comma-separated strings into bullet lists.
This module provides the following function(s):
main- Converts a comma-separated string into a wikitext bullet list. Each comma-delimited value becomes its own `*` list item, with surrounding whitespace trimmed.
Usage
Core functionality
{{#invoke:LeftAlignedList|main|Item 1, Item 2, Item 3}}
Output:
* Item 1 * Item 2 * Item 3
Convert each item into wikilink
{{#invoke:LeftAlignedList|main|Item 1, Item 2, Item 3|link=true}}
Output:
* [[Item 1]] * [[Item 2]] * [[Item 3]]
Parameters
main
- 1
- string
- A comma-separated string containing the items to convert into a bullet list.
- link (optional)
- boolean
- If specified with a truthy value, each item will be wrapped in double square brackets, rendering it as a wikilink.
- Valid values:
trueyes1
Notes
main
- Empty items are ignored (e.g. `A,,B` becomes `A` and `B`).
- If the input contains no commas, it will still be returned as a bullet list with a single `*` item.
local p = {}
local common = require("Module:Common")
function p.main(frame)
local args = frame.args
local content = args[1]
local link = args.link or ""
if not content or content == "" then return "" end
local items = {}
-- split string by commas
for item in mw.text.gsplit(content, ",") do
-- trim whitespace
item = common.trim(item)
if item ~= "" then
if common.isTruthy(link) then
item = "[[" .. item .. "]]"
end
items[#items + 1] = "* " .. item
end
end
-- join items back into bullet list
return table.concat(items, "\n")
end
return p