Diff: Help/IncludeTreePlugin

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

Other diffs: Previous Revision, Previous Author

Newer page: version 3 Last edited on 17 January 2022 3:00 by harold
Older page: version 2 Last edited on 22 May 2014 3:01 by harold Revert
@@ -1,5 +1,5 @@
-Dynamic Category Tree 
+Display Dynamic Category Tree.  
  
 == Usage == 
  
 {{{ 
@@ -7,13 +7,72 @@
 }}} 
  
 == Arguments == 
  
-TBD  
+{| 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**  
+| The page to start the include tree  
+| 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**  
+| 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  
+|-  
+| **includepages**  
+|  
+| words=100  
+|-  
+| **category**  
+|  
+| empty  
+|-  
+| **dtree**  
+|  
+| true  
+|}  
  
 == Example == 
  
-TBD  
+{{{  
+<<IncludeTree>>  
+}}}  
  
 == Author == 
 * [[Help:Reini Urban|Reini Urban]] 
  

current version

Display Dynamic Category Tree.

Usage

<<IncludeTree arguments>>

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

The page to start the include tree

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

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

includepages

words=100

category

empty

dtree

true

Example

<<IncludeTree>>

Author

See Also