From b94fc7b647b2e5c1cd0c81bb0f1e59b392fa652c Mon Sep 17 00:00:00 2001 From: Jermolene Date: Wed, 15 Oct 2014 17:57:00 +0100 Subject: [PATCH] Clarify docs for limit parameter of timeline macro Prompted by a comment in #975 --- editions/tw5.com/tiddlers/macros/TimelineMacro.tid | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/editions/tw5.com/tiddlers/macros/TimelineMacro.tid b/editions/tw5.com/tiddlers/macros/TimelineMacro.tid index 1f9396518..4a3ec9b0e 100644 --- a/editions/tw5.com/tiddlers/macros/TimelineMacro.tid +++ b/editions/tw5.com/tiddlers/macros/TimelineMacro.tid @@ -1,6 +1,6 @@ title: TimelineMacro tags: Macros -modified: 20140913100126081 +modified: 20141015165343893 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. @@ -8,7 +8,7 @@ The timeline macro produces a list of tiddlers in reverse chronological order of ! Parameters |!Position |!Name |!Description |!Default | -|1st |limit |The maximum number of tiddlers to list |100 | +|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) | | @@ -24,6 +24,8 @@ To restrict the timeline to a particular tag, the subfilter can be set to someth <> ``` +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"