X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/3fbcd2c8d270b1282e3c457cd2eb7720f43726af..cdae4fe6ecd5f1d18f6deb62166ea7cbec6ba3a9:/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn diff --git a/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn b/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn index 8f8e6b4e8..4a740f97f 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,20 +96,33 @@ The "mood_summary" template might be like this: ### () \[[]] - + +### 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 with large numbers of pages; most people probably won't need them. -**doscan**: +**maketrail**: + +Make a trail; if true, then this report is called in "scan" mode and the +pages which match the pagespec are added to the list of links from this +page. This can be used by *another* report by setting this page to be a +"trail" page in *that* report. -Whether this report should be called in "scan" mode; if it is, then -the pages which match the pagespec are added to the list of links from -this page. This can be used by *another* report by setting this -page to be a "trail" page in *that* report. -It is not possible to use "trail" and "doscan" at the same time. -By default, "doscan" is false. +It is not possible to use "trail" and "maketrail" at the same time. +By default, "maketrail" is false. ## TEMPLATE PARAMETERS @@ -113,8 +136,18 @@ The structured data from the current matching page. This includes ### Common values -Values known for all pages: "page", "destpage". Also "basename" (the -base name of the page). +Values known for all pages: + +* page (the current page) +* destpage (the destination page) +* basename (the base name of the page) +* recno (N if the page is the Nth page in the report) + +### Prev_Page And Next_Page + +The "prev_page" and "next_page" variables will give the value of the +previous page in the matching pages, or the next page in the matching pages. +This is mainly useful for a "here_only" report. ### Passed-in values @@ -132,13 +165,6 @@ For example, one could have a "hide_mood" parameter which would hide the "Mood" section of your template when it is true, which one could use when the Mood is one of the headers. -### Prev_ And Next_ Items - -Any of the above variables can be prefixed with "prev_" or "next_" -and that will give the previous or next value of that variable; that is, -the value from the previous or next page that this report is reporting on. -This is mainly useful for a "here_only" report. - ### Headers See the section on Headers.