TiddlyWiki5/editions/tw5.com/tiddlers/macros/ListMacro.tid

caption: list-links
created: 20140917083515996
modified: 20190206000000000
tags: Macros [[Core Macros]]
title: list-links Macro
type: text/vnd.tiddlywiki

The <<.def list-links>> [[macro|Macros]] returns a formatted list of links to a [[selection of tiddlers|Title Selection]].

If a tiddler has a <<.field caption>> field, this is shown instead of the tiddler's title. If the caption field is empty, a blank entry is shown.

Note: Each first [[step|Filter Step]] of a [[filter run|Filter Run]] not given any input titles receives the output of <$link to="all Operator">[all[tiddlers]]</$link> as its input. This means all the existing non-[[shadow|ShadowTiddlers]] tiddlers.

!! Parameters

;filter
: A [[filter|Filters]] selecting which tiddlers to include
;type
: An HTML element to use for the overall list element, defaulting to `ul`
;subtype
: An HTML element to use for each item in the list, defaulting to `li`
;class
: A [[CSS|Cascading Style Sheets]] class for the overall list element
;emptyMessage
: Optional wikitext to display if there are no tiddlers with the specified tag

<<.macro-examples "list-links">>
Add emptyMessage parameter to list-links and list-tagged-draggable macros 2018-01-09 17:13:45 +00:00			`caption: list-links`
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`created: 20140917083515996`
Docs: Update ListMacro.tid (#3754) Addressing 2 issues. 1) If the caption field of a tiddler is empty 2) A note addressing no input titles resulting in a Filter Run as brought up on [Google Groups](https://groups.google.com/forum/?hl=en#!topic/tiddlywikidev/VNl_cwu_rIE) 2019-04-10 10:22:12 +00:00			`modified: 20190206000000000`
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`tags: Macros [[Core Macros]]`
Add emptyMessage parameter to list-links and list-tagged-draggable macros 2018-01-09 17:13:45 +00:00			`title: list-links Macro`
			`type: text/vnd.tiddlywiki`
Refine preliminary list macro @pmario: I’ve taken your suggestion and made the HTML element type(s) be macro parameters. 2014-09-17 11:13:24 +00:00
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`The <<.def list-links>> [[macro\|Macros]] returns a formatted list of links to a [[selection of tiddlers\|Title Selection]].`
Refine preliminary list macro @pmario: I’ve taken your suggestion and made the HTML element type(s) be macro parameters. 2014-09-17 11:13:24 +00:00
Docs: Update ListMacro.tid (#3754) Addressing 2 issues. 1) If the caption field of a tiddler is empty 2) A note addressing no input titles resulting in a Filter Run as brought up on [Google Groups](https://groups.google.com/forum/?hl=en#!topic/tiddlywikidev/VNl_cwu_rIE) 2019-04-10 10:22:12 +00:00			`If a tiddler has a <<.field caption>> field, this is shown instead of the tiddler's title. If the caption field is empty, a blank entry is shown.`

			`Note: Each first [[step\|Filter Step]] of a [[filter run\|Filter Run]] not given any input titles receives the output of <$link to="all Operator">[all[tiddlers]]</$link> as its input. This means all the existing non-[[shadow\|ShadowTiddlers]] tiddlers.`
Refine preliminary list macro @pmario: I’ve taken your suggestion and made the HTML element type(s) be macro parameters. 2014-09-17 11:13:24 +00:00
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`!! Parameters`
Refine preliminary list macro @pmario: I’ve taken your suggestion and made the HTML element type(s) be macro parameters. 2014-09-17 11:13:24 +00:00
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`;filter`
			`: A [[filter\|Filters]] selecting which tiddlers to include`
			`;type`
			: An HTML element to use for the overall list element, defaulting to `ul`
			`;subtype`
			: An HTML element to use for each item in the list, defaulting to `li`
			`;class`
			`: A [[CSS\|Cascading Style Sheets]] class for the overall list element`
Add emptyMessage parameter to list-links and list-tagged-draggable macros 2018-01-09 17:13:45 +00:00			`;emptyMessage`
			`: Optional wikitext to display if there are no tiddlers with the specified tag`
Refine preliminary list macro @pmario: I’ve taken your suggestion and made the HTML element type(s) be macro parameters. 2014-09-17 11:13:24 +00:00
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`<<.macro-examples "list-links">>`