From: Reini U. <ru...@us...> - 2007-01-07 20:18:40
|
Update of /cvsroot/phpwiki/phpwiki/pgsrc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7482/pgsrc Modified Files: Help%2FWikiPlugin Log Message: Change from PhpWiki:PageList to Help:PageList. Revert wrong actionpage description. Index: Help%2FWikiPlugin =================================================================== RCS file: /cvsroot/phpwiki/phpwiki/pgsrc/Help%2FWikiPlugin,v retrieving revision 1.5 retrieving revision 1.6 diff -u -2 -b -p -d -r1.5 -r1.6 --- Help%2FWikiPlugin 4 Jan 2007 16:43:39 -0000 1.5 +++ Help%2FWikiPlugin 7 Jan 2007 20:18:39 -0000 1.6 @@ -32,5 +32,5 @@ are implemented using plugins, and some (rename, revert, setacl, diff, ...) -The old-style Help:MagicPhpWikiURLs have been replaced by plugins entirely. +(The old-style Help:MagicPhpWikiURLs have been replaced by plugins entirely.) !!!Example @@ -39,15 +39,15 @@ Currently, one invokes a plugin by putti <verbatim> -<?plugin AllPages limit=20 col=3?> +<?plugin AllPages limit=20 col=3 ?> </verbatim> into a regular wiki-page. That particular example produces a list of -the first 20 existing pages in 3 columns, via the PhpWiki:PageListLibrary. +the first 20 existing pages in 3 columns, via the Help:PageList library. -<?plugin AllPages limit=20 cols=3 ?> +<?plugin AllPages limit=20 col=3 ?> !!!Details -Plugins can take certain named arguments (most do). The values of +Plugins can take certain named arguments, most do. The values of these arguments can be determined four different ways. In order of precedence: @@ -80,10 +80,10 @@ precedence: the ''page'' argument.) - Most plugins using the ~PageListLibrary inherit their default arguments - from the PhpWiki:PageListLibrary. + Most plugins using the Help:PageList library inherit their default arguments + from the ~PageList. !! Standard Arguments -Most plugins display a list of pages, via the ~PageListLibrary. +Most plugins display a list of pages, via the Help:PageList library. ~PageList provides automatic support for those arguments. @@ -91,5 +91,5 @@ Most plugins display a list of pages, vi comma, commasep, ordered - For details see the PhpWiki:PageListLibrary documentation. + For details see the Help:PageList Library documentation. *exclude* and *pages* accept a list of pages. Either as comma-seperated list, @@ -148,8 +148,8 @@ See the config.ini PLUGIN_CACHED_* setti !! Action Pages -The term *Help:ActionPage* refers to a page containing a plugin invocation, which takes -an page argument. +The term *~ActionPage* refers to a page containing a plugin invocation with the same or +translated pluginname as the pagename. An *action* is together with the *pagename* argument the basic PhpWiki argument. -It can both be GET or POST actions. Actions are untranslated, always english. +It can both be GET or POST actions. Actions are untranslated, always english, pagenames can be localized. Basic (and old) actions are all lowercase, like edit, browse, remove, ... Newer actions in PhpWiki:CamelCase are invoked via plugins on their specific action page. @@ -157,7 +157,7 @@ Newer actions in PhpWiki:CamelCase are i We decoupled actions from plugins via action pages for the following reasons: -# support translated action buttons and customizable action descriptions. -# customize standard actions by tuning the plugin invocation arguments. override or add plugin defaults. -# split simple plugins into multiple actions, like RecentChanges/RecentEdits, MostPopular/LeastPopular, +# Support translated action buttons and customizable action descriptions. +# Customize standard actions by tuning the plugin invocation arguments. Override or add plugin defaults. +# Split simple plugins into multiple actions, like RecentChanges/RecentEdits, MostPopular/LeastPopular, AllPages/AllPagesCreatedByMe/AllPagesLastEditedByMe/AllPagesOwnedByMe which differ only in one argument. @@ -169,9 +169,9 @@ We decoupled actions from plugins via ac So for a hypothetical new ~MyActionPage plugin ~MyActionPage will invoke the plugin and -~MyActionPagePlugin is the the description. +~Help:MyActionPagePlugin should be the description page. !!! Existing Plugins -See PluginManager for a detailed list. All plugins should have their own +See PluginManager for a detailed list. Most plugins should have their own description page as subpage of *Help/* with the name *Plugin* appended. |