pgsrc/Help%2FSiteMapPlugin

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