]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/Help%2FSiteMapPlugin
Wikicreole syntax
[SourceForge/phpwiki.git] / pgsrc / Help%2FSiteMapPlugin
1 Date: Tue,  3 Mar 2009 15:32:44 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
3 X-Rcs-Id: $Id$
4 Content-Type: application/x-phpwiki;
5   pagename=Help%2FSiteMapPlugin;
6   flags=PAGE_LOCKED;
7   markup=2;
8   charset=iso-8859-1
9 Content-Transfer-Encoding: binary
10
11 This is a quick mod of BackLinks to do the job recursively. If your
12 site is categorized correctly, and all the categories are listed in
13 CategoryCategory, then a RecBackLinks there will produce a contents
14 page for the entire site.
15
16 The list is as deep as the recursion level.
17
18 == Usage
19
20 {{{
21 <<SiteMap direction=back|forward reclimit=4>>
22 }}}
23
24 == Arguments
25
26 direction: 
27   Get BackLinks or forward links (links listed on the page)
28
29 firstreversed: 
30   If true, get BackLinks for the first page and forward
31   links for the rest. 
32   Only applicable when direction = 'forward'.
33
34 excludeunknown: 
35   If true (default) then exclude any mentioned pages
36   which don't exist yet.
37   Only applicable when direction = 'forward'.
38
39 exclude:
40   Default: ''
41 include_self:
42   Default: 0
43 noheader:
44   Default: 0
45 page:
46   Default: [pagename] The current page
47 description:
48   Override default Description. Printed as header.
49 reclimit:
50   Default: 4
51 info:
52   Default: false 
53
54 == Example
55
56 {{{
57 <<SiteMap page=PhpWikiDocumentation>>
58 }}}
59
60 <<SiteMap page=PhpWikiDocumentation>>
61
62 == Author
63
64 Cuthbert Cat (cuthbertcat)
65
66 == See Also
67
68 Help:BackLinksPlugin
69
70 <noinclude>
71 ----
72 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
73 </noinclude>