[phpwiki-checkins] SF.net SVN: phpwiki:[7753] trunk/pgsrc

[<var...@us...>]

Revision: 7753
          http://phpwiki.svn.sourceforge.net/phpwiki/?rev=7753&view=rev
Author:   vargenau
Date:     2010-12-09 09:39:02 +0000 (Thu, 09 Dec 2010)

Log Message:
-----------
Update doc

Modified Paths:
--------------
    trunk/pgsrc/Help%2FIncludeSiteMapPlugin
    trunk/pgsrc/Help%2FSiteMapPlugin

Modified: trunk/pgsrc/Help%2FIncludeSiteMapPlugin
===================================================================
--- trunk/pgsrc/Help%2FIncludeSiteMapPlugin	2010-12-06 15:48:05 UTC (rev 7752)
+++ trunk/pgsrc/Help%2FIncludeSiteMapPlugin	2010-12-09 09:39:02 UTC (rev 7753)
@@ -1,4 +1,4 @@
-Date: Fri, 10 Sep 2010 13:46:13 +0000
+Date: Thu,  9 Dec 2010 10:37:40 +0000
 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC1)
 X-Rcs-Id: $Id$
 Content-Type: application/x-phpwiki;
@@ -8,30 +8,82 @@
   charset=UTF-8
 Content-Transfer-Encoding: binary
 
-_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.
 
+The list is as deep as the recursion level (##reclimit##).
+
 == Usage ==
 {{{
-<<IncludeSiteMap>>
+<<IncludeSiteMap direction=back|forward reclimit=4>>
 }}}
 
 == Arguments ==
 
-page _(default: current pagename)_:
-  The page to execute upon.
+{| 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
+|}
 
 == Example ==
 
 {{{
-<<IncludeSiteMap>>
+<<SiteMap page=PhpWikiDocumentation>>
 }}}
 
-<<IncludeSiteMap>>
+<<SiteMap page=PhpWikiDocumentation>>
 
 == Author ==
-* [[PhpWiki:ReiniUrban|Reini Urban]]
+* Cuthbert Cat
+* Redesigned by [[PhpWiki:ReiniUrban|Reini Urban]]
 
 == See Also ==
+* [[Help:BackLinksPlugin]]
+* [[Help:SiteMapPlugin]]
 
 <noinclude>
 ----

Modified: trunk/pgsrc/Help%2FSiteMapPlugin
===================================================================
--- trunk/pgsrc/Help%2FSiteMapPlugin	2010-12-06 15:48:05 UTC (rev 7752)
+++ trunk/pgsrc/Help%2FSiteMapPlugin	2010-12-09 09:39:02 UTC (rev 7753)
@@ -1,4 +1,4 @@
-Date: Fri, 10 Sep 2010 13:46:13 +0000
+Date: Thu,  9 Dec 2010 10:37:40 +0000
 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC1)
 X-Rcs-Id: $Id$
 Content-Type: application/x-phpwiki;
@@ -13,7 +13,7 @@
 [[: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 ==
 
@@ -83,6 +83,7 @@
 
 == See Also ==
 * [[Help:BackLinksPlugin]]
+* [[Help:IncludeSiteMapPlugin]]
 
 <noinclude>
 ----


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.