2018-01-09 17:13:45 +00:00
caption: list-links
2015-02-24 16:41:16 +00:00
created: 20140917083515996
2022-11-05 09:10:31 +00:00
modified: 20221105090835041
2015-02-24 16:41:16 +00:00
tags: Macros [[Core Macros]]
2018-01-09 17:13:45 +00:00
title: list-links Macro
type: text/vnd.tiddlywiki
2014-09-17 11:13:24 +00:00
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]].
2014-09-17 11:13:24 +00:00
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.
2014-09-17 11:13:24 +00:00
2015-02-24 16:41:16 +00:00
!! Parameters
2014-09-17 11:13:24 +00:00
2015-02-24 16:41:16 +00:00
;filter
: A [[filter|Filters]] selecting which tiddlers to include
2022-11-05 09:10:31 +00:00
;caption
: The name of the field to transclude for each list item, defaultingt to `caption`
2015-02-24 16:41:16 +00:00
;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
2018-01-09 17:13:45 +00:00
;emptyMessage
: Optional wikitext to display if there are no tiddlers with the specified tag
2014-09-17 11:13:24 +00:00
2015-02-24 16:41:16 +00:00
<<.macro-examples "list-links">>
