mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00
Code Issues Releases Wiki Activity

Clarify docs for limit parameter of timeline macro

Browse Source 
Prompted by a comment in #975
This commit is contained in:
Jermolene 2014-10-15 17:57:00 +01:00
parent 5211f9c40c
commit b94fc7b647
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
editions/tw5.com/tiddlers/macros/TimelineMacro.tid
View File

@ -1,6 +1,6 @@
title: TimelineMacro title: TimelineMacro
tags: Macros tags: Macros
modified: 20140913100126081 modified: 20141015165343893
caption: timeline 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. 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 ! Parameters
|!Position |!Name |!Description |!Default | |!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 | |2nd |format |A DateFormat string for formatting the date |DDth MMM YYYY |
|3rd |subfilter |A subfilter to include in the timeline filter (see below) | | |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
<<timeline limit:10 subfilter:"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 ! Examples
<$macrocall $name="wikitext-example-without-html" <$macrocall $name="wikitext-example-without-html"