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

title: TimelineMacro
tags: Macros
modified: 20141103172520228
caption: timeline

The timeline macro produces a list of tiddlers in reverse chronological order of modification date that is grouped by the date of the day of modification.

! Parameters

|!Position |!Name |!Description |!Default |
|1st |limit |The maximum number of tiddlers to list (see below) |100 |
|2nd |format |A DateFormat string for formatting the date |DDth MMM YYYY |
|3rd |subfilter |A subfilter to include in the timeline filter (see below)  | |
|4th |dateField |Optional name of date field to use |modified |

The subfilter and limit parameters are spliced into the filter string like this:

```
[!is[system]$subfilter$has[modified]!sort[modified]limit[$limit$]eachday[modified]]
```

To restrict the timeline to a particular tag, the subfilter can be set to something like `tag[mytag]`:

```
<<timeline limit:10 subfilter:"tag[mytag]">>
```

Note that the timeline macro does not truncate the entries for a particular day, instead always displaying all the tiddlers under each displayed day heading. This means that the limit parameter works in an unexpected way because it is possible for more than the specified number of tiddlers to be displayed.

! Examples

<$macrocall $name="wikitext-example-without-html"
src="<<timeline limit:30 format:'DD/MM/YYYY'>>
"/>
Improve timeline macro 2014-09-08 17:58:48 +00:00			`title: TimelineMacro`
Update macro reference docs 2014-09-10 22:42:06 +00:00			`tags: Macros`
Move docs for 5.1.5 release 2014-11-26 11:22:20 +00:00			`modified: 20141103172520228`
More mangling of reference docs 2014-09-10 23:06:19 +00:00			`caption: timeline`
Improve timeline macro 2014-09-08 17:58:48 +00:00
			`The timeline macro produces a list of tiddlers in reverse chronological order of modification date that is grouped by the date of the day of modification.`

			`! Parameters`

			`\|!Position \|!Name \|!Description \|!Default \|`
Clarify docs for limit parameter of timeline macro Prompted by a comment in #975 2014-10-15 16:57:00 +00:00			`\|1st \|limit \|The maximum number of tiddlers to list (see below) \|100 \|`
Improve timeline macro 2014-09-08 17:58:48 +00:00			`\|2nd \|format \|A DateFormat string for formatting the date \|DDth MMM YYYY \|`
Extend timeline macro to allow a subfilter 2014-09-13 10:06:50 +00:00			`\|3rd \|subfilter \|A subfilter to include in the timeline filter (see below) \| \|`
Move docs for 5.1.5 release 2014-11-26 11:22:20 +00:00			`\|4th \|dateField \|Optional name of date field to use \|modified \|`
Extend timeline macro to allow a subfilter 2014-09-13 10:06:50 +00:00
			`The subfilter and limit parameters are spliced into the filter string like this:`

			```
			`[!is[system]$subfilter$has[modified]!sort[modified]limit[$limit$]eachday[modified]]`
			```

			To restrict the timeline to a particular tag, the subfilter can be set to something like `tag[mytag]`:

			```
			`<<timeline limit:10 subfilter:"tag[mytag]">>`
			```
Improve timeline macro 2014-09-08 17:58:48 +00:00
Clarify docs for limit parameter of timeline macro Prompted by a comment in #975 2014-10-15 16:57:00 +00:00			`Note that the timeline macro does not truncate the entries for a particular day, instead always displaying all the tiddlers under each displayed day heading. This means that the limit parameter works in an unexpected way because it is possible for more than the specified number of tiddlers to be displayed.`

Improve timeline macro 2014-09-08 17:58:48 +00:00			`! Examples`

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			`<$macrocall $name="wikitext-example-without-html"`
			`src="<<timeline limit:30 format:'DD/MM/YYYY'>>`
			`"/>`