Diff: Help/SiteMapPlugin

Note: You are viewing an old revision of this page. View the current version.

Differences between version 5 and previous revision of Help/SiteMapPlugin.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
Older page: version 4 Last edited on 22 May 2014 3:01 by harold Revert
@@ -1,81 +1,57 @@
-This is a quick mod of [[Help:BackLinksPlugin| BackLinks plugin]] to do the job recursively. If your 
+This is a quick mod of BackLinks to do the job recursively. If your 
 site is categorized correctly, and all the categories are listed in 
-[[: CategoryCategory|CategoryCategory]] , then a recursive ~BackLinks there will produce a contents 
+CategoryCategory, then a RecBackLinks there will produce a contents 
 page for the entire site. 
  
-The list is as deep as the recursion level (##reclimit##) . 
+The list is as deep as the recursion level. 
  
-== Usage == 
+! Usage  
+<verbatim>  
+ <?plugin SiteMap direction =back|forward reclimit =4 ?>  
+</verbatim>  
  
-{{{  
-<<SiteMap direction=back|forward reclimit=4>>  
-}}}  
+! Arguments  
  
-== Arguments ==  
+direction:  
+ Get BackLinks or forward links (links listed on the page)  
  
-{| class="bordered"  
-|-  
-! Argument  
-! Description  
-! Default value  
-|-  
-| **direction**  
-| Get BackLinks or forward links (links listed on the page)  
-|  
-|-  
-| ** firstreversed**  
-| If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward' .  
-|  
-|-  
-| **excludeunknown**  
-| If true (default) then exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'.  
-|  
-|-  
-| **exclude**  
-|  
-|  
-|-  
-| **include_self**  
-|  
-| 0  
-|-  
-| **noheader**  
-|  
-| 0  
-|-  
-| **page**  
-|  
-| The current page  
-|-  
-| **description**  
-| Override default Description. Printed as header.  
-|  
-|-  
-| **reclimit**  
-|  
-| 4  
-|-  
-| **info**  
-|  
-| false  
-|}  
+firstreversed:  
+ If true, get BackLinks for the first page and forward  
+ links for the rest.  
+ Only applicable when direction = 'forward'. 
  
-== Example ==  
+excludeunknown:  
+ If true (default) then exclude any mentioned pages  
+ which don't exist yet.  
+ Only applicable when direction = 'forward'.  
  
-{{{  
-<<SiteMap page=PhpWikiDocumentation>>  
-}}}  
+exclude:  
+ Default: ''  
+include_self:  
+ Default: 0  
+noheader:  
+ Default: 0  
+page:  
+ Default: [pagename] The current page  
+description:  
+ Override default Description. Printed as header.  
+reclimit:  
+ Default: 4  
+info:  
+ Default: false  
  
-<<SiteMap page=PhpWikiDocumentation>>  
+! Example  
  
-== Author ==  
-* Cuthbert Cat (cuthbertcat)  
+<verbatim>  
+<?plugin SiteMap page =PhpWikiDocumentation ?>  
+</verbatim>  
  
-== See Also ==  
-* [[Help:BackLinksPlugin]]  
-* [[Help:IncludeSiteMapPlugin]]  
+<?plugin SiteMap page =PhpWikiDocumentation ?>  
  
-<noinclude>  
+! Author  
+Cuthbert Cat (cuthbertcat)  
+  
+! See Also  
+Help:BackLinksPlugin  
 ---- 
-[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
-</noinclude>  
+PhpWikiDocumentation Help:WikiPlugin  

version 5

This is a quick mod of BackLinks to do the job recursively. If your site is categorized correctly, and all the categories are listed in CategoryCategory, then a RecBackLinks there will produce a contents page for the entire site.

The list is as deep as the recursion level.

Usage

  <?plugin SiteMap direction=back|forward reclimit=4 ?>

Arguments

direction
Get BackLinks or forward links (links listed on the page)
firstreversed
If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward'.
excludeunknown
If true (default) then exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'.
exclude
Default: ''
include_self
Default: 0
noheader
Default: 0
page
Default: pagename The current page
description
Override default Description. Printed as header.
reclimit
Default: 4
info
Default: false

Example

<?plugin SiteMap page=PhpWikiDocumentation ?>

Recursively get BackLinks or links. (max. recursion level: 4):

Author

Cuthbert Cat (cuthbertcat)

See Also

Help:BackLinksPlugin

PhpWikiDocumentation Help:WikiPlugin