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