doscan is now called maketrail
authorhttp://kerravonsen.dreamwidth.org/ <http://kerravonsen.dreamwidth.org/@web>
Fri, 10 Jun 2011 08:13:31 +0000 (08:13 +0000)
committeradmin <admin@branchable.com>
Fri, 10 Jun 2011 08:13:31 +0000 (08:13 +0000)
doc/plugins/contrib/report/ikiwiki/directive/report.mdwn

index df88b33adbba06bbde3425884e9af45067a68090..aa884c13793530fa1de4853b51b84e75a1f94828 100644 (file)
@@ -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.
 
-**doscan**:
-
-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.
+**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.
+
+It is not possible to use "trail" and "maketrail" at the same time.
+By default, "maketrail" is false.
 
 ## TEMPLATE PARAMETERS