pgsrc/Help%2FIncludeSiteMapPlugin

   1 Date: Thu,  9 Dec 2010 10:37:40 +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%2FIncludeSiteMapPlugin;
   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 <<IncludeSiteMap direction=back|forward reclimit=4>>
  21 }}}
  22
  23 == Arguments ==
  24
  25 {| class="bordered"
  26 |-
  27 ! Argument
  28 ! Description
  29 ! Default value
  30 |-
  31 | **direction**
  32 | Get BackLinks or forward links (links listed on the page)
  33 |
  34 |-
  35 | **firstreversed**
  36 | If true, get BackLinks for the first page and forward links for the rest.  Only applicable when direction = 'forward'.
  37 |
  38 |-
  39 | **excludeunknown**
  40 | If true (default) then exclude any mentioned pages which don't exist yet.  Only applicable when direction = 'forward'.
  41 |
  42 |-
  43 | **exclude**
  44 |
  45 |
  46 |-
  47 | **include_self**
  48 |
  49 | 0
  50 |-
  51 | **noheader**
  52 |
  53 | 0
  54 |-
  55 | **page**
  56 |
  57 | The current page
  58 |-
  59 | **description**
  60 | Override default Description. Printed as header.
  61 |
  62 |-
  63 | **reclimit**
  64 |
  65 | 4
  66 |-
  67 | **info**
  68 |
  69 | false
  70 |}
  71
  72 == Example ==
  73
  74 {{{
  75 <<SiteMap page=PhpWikiDocumentation>>
  76 }}}
  77
  78 <<SiteMap page=PhpWikiDocumentation>>
  79
  80 == Author ==
  81 * Cuthbert Cat
  82 * Redesigned by [[PhpWiki:ReiniUrban|Reini Urban]]
  83
  84 == See Also ==
  85 * [[Help:BackLinksPlugin]]
  86 * [[Help:SiteMapPlugin]]
  87
  88 <noinclude>
  89 ----
  90 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  91 </noinclude>