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