Help/UnfoldSubpagesPlugin

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:

1. Support translated action buttons and customizable action descriptions.
2. Customize standard actions by tuning the plugin invocation arguments. Override or add plugin defaults.
3. Split simple plugins into multiple actions, like RecentChanges/RecentEdits, MostPopular/LeastPopular, AllPages/AllPagesCreatedByMe/AllPagesLastEditedByMe/ AllPagesOwnedByMe which differ only in one argument.
4. 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

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

Known Problems

• jshide does not work yet. Not very well tested.

Examples

Comments

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

Known Problems

• jshide does not work yet. Not very well tested.

Examples

Comments

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

Known Problems

• jshide does not work yet. Not very well tested.

Examples

Comments

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 ({}),
• double quotes ("),
• pipe (|),
• and hash sign (#) that is used for anchors.

If you wish to add documents with complex markup to the wiki, you might be better off providing a URL to it than trying to add the text of the document here, like so:

[[http://phpwiki.sourceforge.net/|PhpWiki project homepage]]

PhpWiki project homepage

The Wiki does not support most HTML tags, only the simplest. See TextFormattingRules. <tags>They will just render like text.</tags> Wiki is meant to be as simple as possible to encourage use.

Note that there is a feature that your system administrator can enable to allow embedded HTML, but there are security risks involved.

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.

{{myflash.swf}}

or

[[Upload:myflash.swf]]

will inline the image.

Options

Using the Upload: syntax, options are allowed to change the appearance:

[[Upload:myflash.png size=40x25 align=center]]

Separate options by spaces. The allowed options are the following:

• size: width "x" height or num + "%"
• align: string
• border: number
• hspace: number
• vspace: number

Examples

Wikicreole syntax

{{ora.swf}}

Plugin Template failed. Page “Help/Adobe Flash/themes/Sidebar/ora.swf” does not exist.

Upload syntax

[[Upload:ora.swf]]
[[Upload:ora.swf size=50x50]]

URL syntax

[[http://www.qasia.com/games/mahjong.swf]]

http://www.qasia.com/games/mahjong.swf

See Also

• Help:Images
• Help:VideoPlugin
• Help:Wikicreole