Menu
▾
▴
[phpwiki-checkins] SF.net SVN: phpwiki:[7370] trunk/pgsrc
|
From: <var...@us...> - 2010-05-04 12:04:41
|
Revision: 7370
http://phpwiki.svn.sourceforge.net/phpwiki/?rev=7370&view=rev
Author: vargenau
Date: 2010-05-04 12:04:32 +0000 (Tue, 04 May 2010)
Log Message:
-----------
New help page describing PageList arguments
Modified Paths:
--------------
trunk/pgsrc/Help%2FAllPagesPlugin
trunk/pgsrc/Help%2FAllUsersPlugin
trunk/pgsrc/Help%2FBackLinksPlugin
trunk/pgsrc/Help%2FFullTextSearchPlugin
trunk/pgsrc/Help%2FLikePagesPlugin
trunk/pgsrc/Help%2FLinkDatabasePlugin
trunk/pgsrc/Help%2FListPagesPlugin
trunk/pgsrc/Help%2FListSubpagesPlugin
trunk/pgsrc/Help%2FMostPopularPlugin
trunk/pgsrc/Help%2FRandomPagePlugin
trunk/pgsrc/Help%2FRecentReferrersPlugin
trunk/pgsrc/Help%2FSemanticSearchPlugin
trunk/pgsrc/Help%2FTitleSearchPlugin
trunk/pgsrc/Help%2FUnfoldSubpagesPlugin
trunk/pgsrc/Help%2FWantedPagesPlugin
trunk/pgsrc/Help%2FWikiPlugin
trunk/pgsrc/Help%2F_WikiTranslationPlugin
trunk/pgsrc/PhpWikiManual
Added Paths:
-----------
trunk/pgsrc/Help%2FPageList
Modified: trunk/pgsrc/Help%2FAllPagesPlugin
===================================================================
--- trunk/pgsrc/Help%2FAllPagesPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FAllPagesPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -17,7 +17,7 @@
== Arguments
-All ~PageList arguments, plus the following ones.
+All [[Help:PageList|PageList]] arguments, plus the following ones.
{| class="bordered"
|-
Modified: trunk/pgsrc/Help%2FAllUsersPlugin
===================================================================
--- trunk/pgsrc/Help%2FAllUsersPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FAllUsersPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -11,12 +11,15 @@
The **~AllUsers** [[Help:WikiPlugin|plugin]] lists all once authenticated users.
== Usage
+
{{{
<<AllUsers arguments>>
}}}
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
{| class="bordered"
|-
! Argument
Modified: trunk/pgsrc/Help%2FBackLinksPlugin
===================================================================
--- trunk/pgsrc/Help%2FBackLinksPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FBackLinksPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -11,12 +11,15 @@
The **~BackLinks** [[Help:WikiPlugin|plugin]] lists all pages which link to a given page.
== Usage
+
{{{
<<BackLinks arguments>>
}}}
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
{| class="bordered"
|-
! Argument
Modified: trunk/pgsrc/Help%2FFullTextSearchPlugin
===================================================================
--- trunk/pgsrc/Help%2FFullTextSearchPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FFullTextSearchPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -17,6 +17,8 @@
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
page _(default: current pagename)_:
The page to execute upon.
Modified: trunk/pgsrc/Help%2FLikePagesPlugin
===================================================================
--- trunk/pgsrc/Help%2FLikePagesPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FLikePagesPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -11,12 +11,15 @@
The **~LikePages** [[Help:WikiPlugin|plugin]] lists page names which share an initial or final title word with a given page.
== Usage
+
{{{
<<LikePages arguments>>
}}}
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
{| class="bordered"
|-
! Argument
Modified: trunk/pgsrc/Help%2FLinkDatabasePlugin
===================================================================
--- trunk/pgsrc/Help%2FLinkDatabasePlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FLinkDatabasePlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -11,12 +11,15 @@
_short description_
== Usage
+
{{{
<<LinkDatabase>>
}}}
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
page _(default: current pagename)_:
The page to execute upon.
Modified: trunk/pgsrc/Help%2FListPagesPlugin
===================================================================
--- trunk/pgsrc/Help%2FListPagesPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FListPagesPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -9,14 +9,18 @@
Content-Transfer-Encoding: binary
The **~ListPages** [[Help:WikiPlugin|plugin]] is the simplest plugin to explicitly list a set of pages with all available
-[[PhpWiki:PageList|pagelist]] options, mainly used for a wikilens theme to display ratings info
+[[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
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.
+== Arguments
+
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
== Usage
{{{
Modified: trunk/pgsrc/Help%2FListSubpagesPlugin
===================================================================
--- trunk/pgsrc/Help%2FListSubpagesPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FListSubpagesPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -18,7 +18,7 @@
== Arguments
-All ~PageList arguments, plus the following ones.
+All [[Help:PageList|PageList]] arguments, plus the following ones.
{| class="bordered"
|-
Modified: trunk/pgsrc/Help%2FMostPopularPlugin
===================================================================
--- trunk/pgsrc/Help%2FMostPopularPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FMostPopularPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -18,7 +18,7 @@
== Arguments
-All ~PageList arguments, plus the following ones.
+All [[Help:PageList|PageList]] arguments, plus the following ones.
{| class="bordered"
|-
Added: trunk/pgsrc/Help%2FPageList
===================================================================
--- trunk/pgsrc/Help%2FPageList (rev 0)
+++ trunk/pgsrc/Help%2FPageList 2010-05-04 12:04:32 UTC (rev 7370)
@@ -0,0 +1,131 @@
+Date: Thu, 15 Apr 2010 16:32:58 +0000
+Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC-20100415)
+X-Rcs-Id: $Id$
+Content-Type: application/x-phpwiki;
+ pagename=Help%2FPageList;
+ flags="";
+ markup=2;
+ charset=UTF-8
+Content-Transfer-Encoding: binary
+
+The **~PageList** library allows to list a number of pagenames, optionally as table with various columns.
+
+This library relieves some work for these plugins:
+* AllPages,
+* BackLinks,
+* LikePages,
+* MostPopular,
+* TitleSearch,
+- WikiAdmin* and more.
+
+It also allows dynamic expansion of those plugins to include more columns in their output.
+
+== Arguments ==
+
+{| class="bordered"
+|-
+! Argument
+! Description
+! Default value
+|-
+| **info**
+| which columns to display
+| pagename
+|-
+| **exclude**
+| which pages to exclude. Wildcards, comma-seperated lists and <!plugin-list !> arrays allowed.
+| //none//
+|-
+| **author**
+| select pages by author; current user by ~[~]
+| false
+|-
+| **owner**
+| select pages by owner; current user by ~[~]
+| false
+|-
+| **creator**
+| select pages by creator; current user by ~[~]
+| false
+|-
+| **sortby**
+| select column to sort
+| //none//
+|-
+| **limit**
+| number of rows
+| 5000
+|-
+| **paging**
+| auto (top + bottom rows if applicable) \\ top (top only if applicable) \\ bottom (bottom only if applicable) \\ none (don't page at all)
+| auto
+|-
+| **cols**
+| side-by-side display of list (1-3)
+| 1
+|-
+| **azhead**
+| 1: group by initials \\ 2: provide shortcut links to initials also
+| 0
+|-
+| **comma**
+| condensed comma-seperated list, 1 if without links, 2 if with
+| 0
+|-
+| **commasep**
+| comma separator
+| ', '
+|-
+| **listtype**
+| ul, ol, dl, comma
+| ul
+|-
+| **ordered**
+| OL or just UL lists (ignored for comma)
+| false
+|-
+| **linkmore**
+| If count > 0 and limit > 0, display a link with the number of all results, linked to the given pagename.
+| //none//
+|-
+| **nopage**
+| for info=col omit the pagename column
+| false
+|}
+
+=== Info arguments ===
+
+Column 'info=' arguments:
+|= pagename | Page Name (string regex)
+|= mtime | Last Modified
+|= hits | Hits
+|= summary | Last Summary
+|= version | Version
+|= author | Last Author
+|= locked | Locked
+|= external | External
+|= minor | Minor Edit
+|= markup | Markup
+|= size | Size
+|= creator | Creator
+|= owner | Owner
+|= checkbox | Selectable checkbox at the left
+|= content | Page content
+
+Special, custom columns, either theme or plugin (WikiAdmin*) specific:
+|= remove | Remove
+|= perm | Permission Mask
+|= acl | ACL
+|= renamed_pagename | Rename to
+|= ratingwidget | wikilens theme specific.
+|= custom | See plugin/_WikiTranslation
+
+Symbolic 'info=' arguments:
+|= all | All columns except the special columns
+|= most | pagename, mtime, author, size, hits, ...
+|= some | pagename, mtime, author
+
+<noinclude>
+----
+[[PhpWikiDocumentation]]
+</noinclude>
Property changes on: trunk/pgsrc/Help%2FPageList
___________________________________________________________________
Added: svn:keywords
+ Id
Modified: trunk/pgsrc/Help%2FRandomPagePlugin
===================================================================
--- trunk/pgsrc/Help%2FRandomPagePlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FRandomPagePlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -17,6 +17,8 @@
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
{| class="bordered"
|-
! Argument
Modified: trunk/pgsrc/Help%2FRecentReferrersPlugin
===================================================================
--- trunk/pgsrc/Help%2FRecentReferrersPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FRecentReferrersPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -11,12 +11,16 @@
_short description_
== Usage
+
{{{
<<RecentReferrers>>
}}}
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
+
page _(default: current pagename)_:
The page to execute upon.
Modified: trunk/pgsrc/Help%2FSemanticSearchPlugin
===================================================================
--- trunk/pgsrc/Help%2FSemanticSearchPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FSemanticSearchPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -29,12 +29,15 @@
* "(is_a::city or is_a::country) and population < 10.000.000"
== Usage
+
{{{
<<SemanticSearch arguments>>
}}}
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
{| class="bordered"
|-
! Argument
Modified: trunk/pgsrc/Help%2FTitleSearchPlugin
===================================================================
--- trunk/pgsrc/Help%2FTitleSearchPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FTitleSearchPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -20,7 +20,7 @@
== Arguments
-All ~PageList arguments, plus the following ones.
+All [[Help:PageList|PageList]] arguments, plus the following ones.
{| class="bordered"
|-
Modified: trunk/pgsrc/Help%2FUnfoldSubpagesPlugin
===================================================================
--- trunk/pgsrc/Help%2FUnfoldSubpagesPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FUnfoldSubpagesPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -28,6 +28,8 @@
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
{| class="bordered"
|-
! Argument
Modified: trunk/pgsrc/Help%2FWantedPagesPlugin
===================================================================
--- trunk/pgsrc/Help%2FWantedPagesPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FWantedPagesPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -13,12 +13,15 @@
All empty pages which are linked from any page - with an ending question mark, or for just a single page, when the page argument is present.
== Usage
+
{{{
-<<WantedPages>>
+<<WantedPages arguments>>
}}}
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
{| class="bordered"
|-
! Argument
Modified: trunk/pgsrc/Help%2FWikiPlugin
===================================================================
--- trunk/pgsrc/Help%2FWikiPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2FWikiPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -43,7 +43,7 @@
}}}
into a regular wiki-page. That particular example produces a list
-of the first 20 existing pages in 3 columns, via the [[PhpWiki:PageList]]
+of the first 20 existing pages in 3 columns, via the [[Help:PageList|PageList]]
library.
<<AllPages limit=20 cols=3>>
@@ -81,22 +81,22 @@
(The BackLinks plugin uses the current page as the default value for
the *page* argument.)
- Most plugins using the PhpWiki:PageList library inherit their
+ Most plugins using the [[Help:PageList|PageList]] library inherit their
default arguments from the ~PageList.
=== Standard Arguments
-Most plugins display a list of pages, via the PhpWiki:PageList
+Most plugins display a list of pages, via the [[Help:PageList|PageList]]
library. ~PageList provides automatic support for those arguments.
info, exclude, author, owner, creator, sortby, limit, paging, cols, azhead,
comma, commasep, ordered
- For details see the PhpWiki:PageList library documentation.
+ For details see the [[Help:PageList|PageList]] library documentation.
*exclude* and *pages* accept a list of pages. Either as comma-seperated list,
supporting glob-style wildcards, or via the ##<!plugin-list pluginname ~[args~] !>##
-invocation syntax, where pluginname might be any plugin returning a PhpWiki:PageList.
+invocation syntax, where pluginname might be any plugin returning a [[Help:PageList|PageList]].
See PhpWiki:PluginList.
Since most plugins return a ~PageList, this ~PageList is also a common
Modified: trunk/pgsrc/Help%2F_WikiTranslationPlugin
===================================================================
--- trunk/pgsrc/Help%2F_WikiTranslationPlugin 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/Help%2F_WikiTranslationPlugin 2010-05-04 12:04:32 UTC (rev 7370)
@@ -22,6 +22,8 @@
== Arguments
+All [[Help:PageList|PageList]] arguments, plus the following ones.
+
languages:
comma delimited string of de,en,sv,...
string:
Modified: trunk/pgsrc/PhpWikiManual
===================================================================
--- trunk/pgsrc/PhpWikiManual 2010-04-30 08:39:48 UTC (rev 7369)
+++ trunk/pgsrc/PhpWikiManual 2010-05-04 12:04:32 UTC (rev 7370)
@@ -27,4 +27,5 @@
<<IncludePage page="Help/PagePermissions">>
<<IncludePage page="Help/SemanticRelations">>
<<IncludePage page="Help/Spreadsheet">>
+<<IncludePage page="Help/PageList">>
<<IncludePages pages=<!plugin-list BackLinks page=CategoryWikiPlugin sortby=pagename exclude="Template/*" !> >>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
