diff options
| author | http://kerravonsen.dreamwidth.org/ <http://kerravonsen.dreamwidth.org/@web> | 2010-12-06 02:02:30 +0000 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2010-12-06 02:02:30 +0000 |
| commit | 3f4ec334df4cc2c169edfbcef3fa530cbae0d7f1 (patch) | |
| tree | 4db4477569c12d30a50291adddbbd77240bd1295 | |
| parent | e0b58215f7fdf64ff3e888a5402b22e89081091a (diff) | |
updating the docs in keeping with latest version - multi-page reports
| -rw-r--r-- | doc/plugins/contrib/report/ikiwiki/directive/report.mdwn | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn b/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn index 8f8e6b4e8..df88b33ad 100644 --- a/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn +++ b/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn @@ -30,6 +30,11 @@ them work as wiki pages. **pages**: A PageSpec to determine the pages to report on. +**pagenames**: If given instead of pages, this is interpreted as a +space-separated list of links to pages, and they are shown in exactly the order +given: the sort and pages parameters cannot be used in conjunction with this +one. If they are used, they will be ignored. + **trail**: A page or pages to use as a "trail" page. When a trail page is used, the matching pages are limited to (a subset @@ -45,6 +50,11 @@ For example: This will take the links from both the "animals/cats" page and the "animals/dogs" page as the set of pages to apply the PageSpec to. +**start**: Start the report at the given page-index; the index starts +from zero. + +**count**: Report only on N pages where count=N. + **sort**: A SortSpec to determine how the matching pages should be sorted. **here_only**: Report on the current page only. @@ -86,7 +96,19 @@ The "mood_summary" template might be like this: ### <TMPL_VAR NAME="TITLE"> (<TMPL_VAR NAME="DATE">) \[[<TMPL_VAR NAME="PAGE">]] <TMPL_VAR NAME="DESCRIPTION"> - + +### Multi-page Reports + +Reports can now be split over multiple pages, so that there aren't +too many items per report-page. + +**per_page**: how many items to show per report-page. + +**first_page_is_index**: If true, the first page of the report is just +an index which contains links to the other report pages. +If false, the first page will contain report-content as well as links +to the other pages. + ### Advanced Options The following options are used to improve efficiency when dealing |