Diff: Help/ListPagesPlugin

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

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,19 +1,58 @@
-The ListPagesPlugin is the simpliest plugin to explicitly list a set of pages with all available  
-[pagelist|PhpWiki :PageList] options, mainly used for a wikilens theme to display ratings info 
+The **~ListPages** [[Help:WikiPlugin|plugin]] is the simplest plugin to explicitly list a set of pages with all available  
+[[Help :PageList|PageList] ] options, mainly used for a wikilens theme to display ratings info 
 and recommendations. 
  
-It can also be used with the PhpWiki: PluginList method to list a set of pages generated by 
+It can also be used with the ~ PluginList method to list a set of pages generated by 
 another plugin, and/or to exclude a set of pages generated by another plugin. 
  
-See the PhpWiki :PageList options. 
+See the [[Help :PageList|PageList]] options. 
  
-Usage:  
-<verbatim>  
- <?plugin ListPages pages =HomePage,FindPage,WikiWikiWeb ?>  
+== Usage ==  
  
- <?plugin ListPages info=hits sortby=hits pages=<!plugin-list BackLink page=[] ! > exclude=ListPagesPlugin,WikiPlugin ? >  
-</verbatim>  
+{{{  
+< <ListPages arguments >>  
+}}}  
  
--------------  
+== Arguments ==  
  
-PhpWikiDocumentation Help:WikiPlugin 
+All [[ Help:PageList|PageList]] arguments, plus the following ones:  
+  
+{| class="bordered"  
+|-  
+! Argument  
+! Description  
+! Default value  
+|-  
+| **pages**  
+| Pages to list  
+| false  
+|-  
+| **dimension**  
+|  
+| 0  
+|}  
+  
+=== Additional info arguments ===  
+  
+|= top3recs | recommendations (wikilens theme only)  
+|= numbacklinks | number of backlinks (links to the given page)  
+|= numpagelinks | number of forward links (links at the given page)  
+  
+== Examples ==  
+  
+{{{  
+<<ListPages pages=HomePage,FindPage>>  
+}}}  
+  
+{{{  
+<<ListPages info=hits  
+ sortby=hits  
+ pages=<!plugin-list BackLink page=[] !>  
+ exclude=ListPagesPlugin, WikiPlugin  
+>>  
+}}}  
+  
+<noinclude>  
+----  
+[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

current version

The ListPages plugin is the simplest plugin to explicitly list a set of pages with all available PageList options, mainly used for a wikilens theme to display ratings info and recommendations.

It can also be used with the PluginList method to list a set of pages generated by another plugin, and/or to exclude a set of pages generated by another plugin.

See the PageList options.

Usage

<<ListPages arguments>>

Arguments

All PageList arguments, plus the following ones:

Argument

Description

Default value

pages

Pages to list

false

dimension

0

Additional info arguments

top3recs recommendations (wikilens theme only)
numbacklinks number of backlinks (links to the given page)
numpagelinks number of forward links (links at the given page)

Examples

<<ListPages pages=HomePage,FindPage>>
<<ListPages info=hits
            sortby=hits
            pages=<!plugin-list BackLink page=[] !>
            exclude=ListPagesPlugin,WikiPlugin
>>