test alternative header link name

[git.ikiwiki.info.git] / 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 df88b33adbba06bbde3425884e9af45067a68090..4a740f97fd1af59606d765869bcc4c1ef6aad23f 100644 (file)
--- a/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn
+++ b/doc/plugins/contrib/report/ikiwiki/directive/report.mdwn
@@ -114,14 +114,15 @@ to the other pages.
 The following options are used to improve efficiency when dealing
 with large numbers of pages; most people probably won't need them.
 
 The following options are used to improve efficiency when dealing
 with large numbers of pages; most people probably won't need them.
 

-**doscan**:
+**maketrail**:

 
 

-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.
+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.
+
+It is not possible to use "trail" and "maketrail" at the same time.
+By default, "maketrail" is false.

 
 ## TEMPLATE PARAMETERS
 
 
 ## TEMPLATE PARAMETERS
 


@@ -135,8 +136,18 @@ The structured data from the current matching page.  This includes
 
 ### Common values
 
 
 ### 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
 
 
 ### Passed-in values
 


@@ -154,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.
 
 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.
 ### Headers
 
 See the section on Headers.