Diff: Help/IncludeSiteMapPlugin

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

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,27 +1,85 @@

-~~_short description_~~

+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|CategoryCategory]], then a recursive ~BackLinks there will produce a contents

+page for the entire site.

-~~! Usage~~

-~~<verbatim>~~

- ~~<?plugin IncludeSiteMap ?>~~

-~~</verbatim>~~

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

-~~! Arguments~~

+== Usage ==

+{{{

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

+}}}

-~~page _(default: current pagename)_:~~

- ~~The page to execute upon.~~

+== Arguments ==

-! ~~Example~~

+{| class="bordered"

+|-

+ ! Argument

+! Description

+! Default value

+|-

+| **exclude**

+| Comma-separated list of pages to exclude

+| empty

+|-

+| **include_self**

+| Boolean. If true, include yourself in the results.

+| false

+|-

+| **noheader**

+| Boolean. If true, header should be omitted.

+| false

+|-

+| **page**

+| Page from which site map starts

+| The current page

+|-

+| **description**

+| Override default description. Printed as header.

+| Default description

+|-

+| **reclimit**

+| Max recursion depth.

+| 2

+|-

+| **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

+|}

-~~<verbatim>~~

-~~<?plugin IncludeSiteMap ?>~~

-~~</verbatim>~~

+== Example ==

-<~~?plugin IncludeSiteMap ?~~ >

+{{{

+ <<SiteMap page=PhpWikiDocumentation> >

+}}}

-~~! Author~~

-~~PhpWiki:ReiniUrban~~

+<<SiteMap page=PhpWikiDocumentation>>

-~~! See Also~~

+== Author ==

+* Cuthbert Cat

+* Redesigned by [[Help:Reini Urban|Reini Urban]]

+== See Also ==

+* [[Help:BackLinksPlugin]]

+* [[Help:SiteMapPlugin]]

+

+<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

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

Arguments

Argument	Description	Default value
exclude	Comma-separated list of pages to exclude	empty
include_self	Boolean. If true, include yourself in the results.	false
noheader	Boolean. If true, header should be omitted.	false
page	Page from which site map starts	The current page
description	Override default description. Printed as header.	Default description
reclimit	Max recursion depth.	2
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