1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-30 05:19:57 +00:00
TiddlyWiki5/editions/tw5.com/tiddlers/macros/ListMacro.tid
00SS 12b08b7abf 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 11:22:12 +01:00

28 lines
1.1 KiB
Plaintext

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">>