Help/UnfoldSubpagesPlugin
Note: You are viewing an old revision of this page. View the current version.
The UnfoldSubpages plugin is used to display all or some subpages of the current or a given page. This gives an overview for a Help:WikiBlogPlugin, Help:CalendarPlugin or similar subpages.
Warning: Don't use it with subpages with non-existant sections! The section extractor is currently quite unstable.
Usage
<<UnfoldSubpages>>
<<UnfoldSubpages sortby=-mtime words=50 maxpages=5>>
<<UnfoldSubpages quiet=1 smalltitle=1>>
<<UnfoldSubpages sections=2 words=100>>
<<UnfoldSubpages lines=3>>
<<UnfoldSubpages pagename="PhpWikiAdministration"
section="Plugin Arguments" sectionhead=1>>
Arguments
All PageList arguments, plus the following ones.
Argument |
Description |
Default value |
|---|---|---|
pagename |
Any pagename or if empty the current page |
empty |
quiet |
Print no header |
false |
sortby |
Sort by + (ASC) or - (DESC) and one column. |
pagename |
maxpages |
Maximum number of pages to include or all if not defined. |
false |
sections |
Maximum number of sections per page to include or all if not defined. |
false |
section |
Include this named section per page only if defined. |
empty |
sectionhead |
When including a named section show the heading. |
false |
smalltitle |
If set, hide transclusion-title, just have a small link at the start of the page. |
false |
words |
Maximum number of words per page to include. |
false |
lines |
Maximum number of lines per page to include. |
false |
bytes |
Maximum number of bytes per page to include. |
false |
Deprecated Arguments
Argument |
Description |
|---|---|
pages |
Deprecated. Renamed to maxpages. |
sort |
'asc' or 'desc'. Deprecated: use "+" or "-" before the column name with sortby. |
Example
<<UnfoldSubpages pagename=Help maxpages=5 lines=10>>
Included from Help/ActionPage
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, pagenames can be localized. Basic (and old) actions are all lowercase, like edit, browse, remove, ... Newer actions in CamelCase are invoked via plugins on their specific action page.
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, AllPages/AllPagesCreatedByMe/AllPagesLastEditedByMe/ AllPagesOwnedByMe which differ only in one argument.
- Simplify the syntax for actions on another actions using a PageList as result of an actionpage as input parameter for another action or format.
- Those actions which have buttons or links in the theme or are referenced in the standard pgsrc pageset require their (possibly localized) actionpages, otherwise the actions will not work.
- If the localized actionpage is not found the english version is used.
- If no actionpage is found, it is recommended to do action=upgrade, which imports all missing and required action pages into the database.
So for a hypothetical new MyActionPage plugin MyActionPage will invoke the plugin and Help:MyActionPagePlugin should be the description page.
Existing Plugins
See PluginManager for a detailed list. Most plugins should have their own description page as subpage of Help/ with the name Plugin appended. PhpWikiDocumentation
... first 10 lines
Included from Help/AddCommentPlugin
The AddComment plugin lets users attach comments to the end of a page. Change the layout via the templates comment.tmpl and addcomment.tmpl, and the CSS classes wikicomment, wikicomment-header, wikicomment-body, wikicomment-footer
Usage
<<AddComment order||=normal jshide||=0 mode||=show,add noheader||=0>>
Arguments
... first 10 lines
Included from Help/AddCommentPlugin
The AddComment plugin lets users attach comments to the end of a page. Change the layout via the templates comment.tmpl and addcomment.tmpl, and the CSS classes wikicomment, wikicomment-header, wikicomment-body, wikicomment-footer
Usage
<<AddComment order||=normal jshide||=0 mode||=show,add noheader||=0>>
Arguments
... first 10 lines
Included from Help/AddCommentPlugin
The AddComment plugin lets users attach comments to the end of a page. Change the layout via the templates comment.tmpl and addcomment.tmpl, and the CSS classes wikicomment, wikicomment-header, wikicomment-body, wikicomment-footer
Usage
<<AddComment order||=normal jshide||=0 mode||=show,add noheader||=0>>
Arguments
... first 10 lines
Included from Help/AddingPages
To add a new page to the wiki, all you have to do is come up with a meaningful title and put it between [[double brackets]].
Then you can go ahead and click the question mark at the end of your new hyperlink, and the Wiki will give you a window for making the new page.
The page name can contain any character, except:
- angle brackets (<>),
- square brackets ([]),
- curly brackets ({}),
... first 10 lines
Included from Help/Adobe Flash
You can easily insert Adobe Flash (.swf) files in the wiki.
Uploading Flash files
First, Flash files need to be uploaded in the wiki. For that purpose, you will use the UpLoad plugin.
Syntax
You give access to the uploaded Flash files with the following syntax.
... first 10 lines
