Diff: Help/SiteMapPlugin

Differences between current version and predecessor to the previous major change of Help/SiteMapPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,57 +1,81 @@
-This is a quick mod of BackLinks to do the job recursively. If your 
+This is a quick mod of [[Help:BackLinksPlugin| BackLinks plugin]] 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 
+[[: CategoryCategory|CategoryCategory]] , then a recursive ~BackLinks there will produce a contents 
 page for the entire site. 
  
-The list is as deep as the recursion level. 
+The list is as deep as the recursion level (##reclimit##) . 
  
-! Usage  
-<verbatim>  
- <?plugin SiteMap direction =back|forward reclimit =4 ?>  
-</verbatim>  
+== Usage == 
  
-! Arguments  
+{{{  
+<<SiteMap direction=back|forward reclimit=4>>  
+}}}  
  
-direction:  
- Get BackLinks or forward links (links listed on the page)  
+== Arguments ==  
  
-firstreversed:  
- If true, get BackLinks for the first page and forward  
- links for the rest.  
- Only applicable when direction = 'forward'. 
+{| class="bordered"  
+|-  
+! Argument  
+! Description  
+! Default value  
+|-  
+| **direction**  
+| Get BackLinks or forward links (links listed on the page)  
+| back  
+|-  
+| ** firstreversed**  
+| Boolean. If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward' .  
+| false  
+|-  
+| **excludeunknown**  
+| Boolean. If true, then exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'.  
+| true  
+|-  
+| **exclude**  
+| List of pagenames to exclude, separated by comma  
+| (empty)  
+|-  
+| **include_self**  
+| Boolean. If true, include yourself in the results.  
+| false  
+|-  
+| **noheader**  
+| Boolean. If true, header should be omitted.  
+| false  
+|-  
+| **page**  
+| Page to get SiteMap from  
+| The current page  
+|-  
+| **description**  
+| Override default description. Printed as header.  
+| Default description  
+|-  
+| **reclimit**  
+| Maximum recusion level  
+| 4  
+|-  
+| **info**  
+| Info to display in the table  
+| false  
+|}  
  
-excludeunknown:  
- If true (default) then exclude any mentioned pages  
- which don't exist yet.  
- Only applicable when direction = 'forward'.  
+== Example ==  
  
-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  
+<<SiteMap page=PhpWikiDocumentation>>  
  
-<verbatim>  
-<?plugin SiteMap page =PhpWikiDocumentation ?>  
-</verbatim>  
+== Author ==  
+* Cuthbert Cat (cuthbertcat)  
  
-<?plugin SiteMap page =PhpWikiDocumentation ?>  
+== See Also ==  
+* [[Help:BackLinksPlugin]]  
+* [[Help:IncludeSiteMapPlugin]]  
  
-! Author  
-Cuthbert Cat (cuthbertcat)  
-  
-! See Also  
-Help:BackLinksPlugin  
+<noinclude>  
 ---- 
-PhpWikiDocumentation Help:WikiPlugin  
+[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

current version

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

The list is as deep as the recursion level (reclimit).

Usage

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

Arguments

Argument

Description

Default value

direction

Get BackLinks or forward links (links listed on the page)

back

firstreversed

Boolean. If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward'.

false

excludeunknown

Boolean. If true, then exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'.

true

exclude

List of pagenames to exclude, separated by comma

(empty)

include_self

Boolean. If true, include yourself in the results.

false

noheader

Boolean. If true, header should be omitted.

false

page

Page to get SiteMap from

The current page

description

Override default description. Printed as header.

Default description

reclimit

Maximum recusion level

4

info

Info to display in the table

false

Example

<<SiteMap page=PhpWikiDocumentation>>

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

Author

  • Cuthbert Cat (cuthbertcat)

See Also