Diff: Help/IncludeSiteMapPlugin

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

Differences between version 2 and previous revision of Help/IncludeSiteMapPlugin.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 2 Last edited on 22 May 2014 3:01 by harold Revert
Older page: version 1 Last edited on 17 January 2022 18:35 by harold Revert
@@ -16,52 +16,48 @@
 |- 
 ! 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** 
-| Comma-separated list of pages to exclude  
-| //empty//  
+|  
+| 
 |- 
 | **include_self** 
-| Boolean. If true, include yourself in the results.  
-| false  
+|  
+| 0  
 |- 
 | **noheader** 
-| Boolean. If true, header should be omitted.  
-| false  
+|  
+| 0  
 |- 
 | **page** 
-| Page from which site map starts  
+| 
 | The current page 
 |- 
 | **description** 
-| Override default description . Printed as header.  
-| Default description  
+| Override default Description . Printed as header.  
+| 
 |- 
 | **reclimit** 
-| Max recursion depth.  
-| 2  
+|  
+| 4  
 |- 
 | **info** 
-| Info to display in the table  
+| 
 | false 
-|-  
-| **direction**  
-| Get BackLinks or forward links (links listed on the page)  
-| back  
-|-  
-| **firstreversed**  
-| If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward'.  
-| false  
-|-  
-| **excludeunknown**  
-| If true, exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'.  
-| true  
-|-  
-| **includepages**  
-| Passed verbatim to the IncludePage plugin.  
-| words=50  
 |} 
  
 == Example == 
  

version 2

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

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

Arguments

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

Example

<<SiteMap page=PhpWikiDocumentation>>

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

Author

See Also