You are using PhpWiki at this very moment. Incredible, ain't it?

Visit our home page at http://phpwiki.fr and see PhpWiki in action at http://phpwiki.fr (and of course here too :-)).

Describe Help/WikiForumPlugin? here.

Since wabi-sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard Koren, wabi-sabi is the most conspicuous and characteristic feature of what we think of as traditional Japanese beauty and it “occupies roughly the same position in the Japanese pantheon of aesthetic values as do the Greek ideals of beauty and perfection in the West.”

“Wabi-sabi is a beauty of things imperfect, impermanent, and incomplete.”

“It is the beauty of things modest and humble.”

“It is the beauty of things unconventional.”

(quoted from “WABI-SABI: FOR ARTISTS,DESIGNERS, POETS & PHILOSOPHERS,” 1994, Leonard Koren)

The concepts of wabi-sabi correlate with the concepts of Zen Buddhism, as the first Japanese involved with wabi-sabi were tea masters, priests, and monks who practiced Zen. Zen Buddhism originated in India, traveled to China in the 6th century, and was first introduced in Japan around the 12th century. Zen emphasizes “direct, intuitive insight into transcendental truth beyond all intellectual conception.” At the core of wabi-sabi is the importance of transcending ways of looking and thinking about things/existence.

• All things are impermanent
• All things are imperfect
• All things are incomplete

(also taken from WABI-SABI: FOR ARTISTS,DESIGNERS, POETS & PHILOSOPHERS, 1994, Leonard Koren):

Material characteristics of wabi-sabi:

• suggestion of natural process
• irregular
• intimate
• unpretentious
• earthy
• simple

For more about wabi-sabi, see http://c2.com/cgi/wiki?WabiSabi.

Describe Help/WikiForumPlugin? here.

Describe Help/WikiForumPlugin? here.

A new UserPreferences setting to optionally add a [G] link to unknown pages, with a link to Google:[pagename]. Default: Off

See MeatBall:GooglePrompt

Describe Help/WikiForumPlugin? here.

Here are some good starting points for browsing.

• Help:HowToUseWiki gives you the quick lowdown on Wiki markup.
• RecentChanges recorded automatically.
• Help:MoreAboutMechanics of browsing and editing on this server.

Here's a title search. Try something like wiki or sandwich.

Use the following for a full text search. This takes a few seconds. The results will show all lines on a given page which contain a match.

In a fuzzy pages search the titles of all pages are examined to find those which are similarly spelled or similar sounding (english).

Tips

Separate words with a space. All words have to match as substrings.
'OR', grouping with parenthesis, string-quoting and some glob-style wildcard characters are also supported.
To exclude words from a title search or full text search, prepend a '-'.
Use '^xx' or 'xx*' to match words starting with 'xx'.
Use '*xx' or 'xx$' to match words ending with 'xx'.
Use '^word$' to match exact words.
Use regex=auto and 're:' like 're:word.*xx' or regex=posix to use posix regular expressions. (not yet)
Use regex=auto and '//' like '/^word$/' or regex=pcre to match using perl-style regular expressions.
Use regex=sql to match using SQL-style wildcards '%' and '_'.
Use regex=none to match any wildcards verbatim.

Example: 'wiki text -php' looks for all pages containing the words 'wiki' and 'text',

but not containing the word 'php'.

Describe Help/WikiForumPlugin? here.

Describe Help/WikiForumPlugin? here.

Describe Help/WikiForumPlugin? here.

A plugin is some PHP code that:

• lives in phpwiki/lib/plugin/<pluginname>.php
• implements the WikiPlugin interface by extending that class.

There are many plugins already distributed with PhpWiki. Simply look in the lib/plugin directory or see the PluginManager list or see all the Help/*Plugin pages.

To write your own, look at the Help:HelloWorldPlugin (HelloWorld.php in that directory), which is a minimal example of a plugin.

A WikiPlugin allows one to easily add new types of dynamic content (as well as other functionality) to wiki pages within PhpWiki. In this very wiki all actions which are not entirely lowercased are implemented using plugins, and some lowercased convenience actions also. (rename, revert, setacl, diff, ...)

Note that you can NOT extend the markup syntax with a plugin, as in other wiki engines.

(The old-style MagicPhpWikiURLs have been replaced by plugins entirely.)

Example

Currently, one invokes a plugin by putting something like:

<<AllPages limit=20 cols=3>>

into a regular wiki-page. That particular example produces a list of the first 20 existing pages in 3 columns, via the PageList library.

All pages in this wiki (824 total):

Details

Plugins can take certain named arguments, most do. The values of these arguments can be determined four different ways. In order of precedence:

1. The plugin invocation can specify the value for an argument, like so:

   <?plugin BackLinks page=OtherPage ?>

2. The argument can be specified via an HTTP query argument. This doesn't happen (is not allowed) unless the argument is mentioned in the plugin invocation:

   <?plugin BackLinks page ?>

3. Default values specified in the plugin invocation:

   <?plugin BackLinks page||=OtherPage ?>

4. The plugin must supply default values for each argument it uses. Such default args may be overriden by URL arguments like so:

     BackLinks?page=ThisPage&sortby=-mtime

   (The BackLinks plugin uses the current page as the default value for the page argument.)

   Most plugins using the PageList library inherit their default arguments from the PageList.

Standard Arguments

Most plugins display a list of pages, via the 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 PageList library documentation.

exclude and pages accept a list of pages. Either as comma-separated list, supporting glob-style wildcards, or via the <!plugin-list pluginname [args] !> invocation syntax, where pluginname might be any plugin returning a PageList.

Since most plugins return a PageList, this PageList is also a common input parameter for other plugins, actions or formats.

Basic Plugin Types

All these plugins derive from the WikiPlugin class extending the run method, which returns a object tree of HTML objects, and may react on any provided arguments from the WikiPage (see the args below) or optionally overridden by arguments from the url (GET or POST args), if defined via '||='.

A basic plugin just needs the run() method, and optionally getName, getDescription, getDefaultArguments. See the Help:HelloWorldPlugin for a short introduction.

plugin reacts on its arguments and the request and displays arbitrary HTML.

plugin-form is used to display a input type=text box for the default argument s.

plugin-list is used as argument to provide a dynamic list of pagenames.

  <?plugin PluginName [args...] ?>

  <?plugin-form PluginName [args...] ?>

  <?plugin PluginName args=<!plugin-list pluginname [args...] !> ?>

The box Method

Themes based on the "sidebar" theme may use the box method of any plugin, which displays a title and a condensed content in a box.

WikiPluginCached

Plugins deriving from the class WikiPluginCached must also define the methods getPluginType(), optionally getExpire(), managesValidators(), and dependent of the getPluginType the methods to display the possibly cached result.

getImage(), getMap() or getHtml(),

optionally also

getAlt(), getImageType(), embedMap(), embedImg(), embedObject()

See the config.ini PLUGIN_CACHED_* settings and WikiPluginCached

Action Pages

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

Describe Help/WikiForumPlugin? here.

Describe Help/WikiForumPlugin? here.

Describe Help/WikiForumPlugin? here.

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 AllPages plugin lists all pages in this wiki.

Usage

<<AllPages arguments>>

Arguments

All PageList arguments, plus the following ones:

Example

<<AllPages limit=20 cols=3>>

All pages in this wiki (824 total):

Author

• Reini Urban

See Also

• AllPages
• Help:ListPagesPlugin

The AuthorHistory plugin allows you to list the history of edits by a particular author; you can specify the page name as well (default is the current page).

Usage

<<AuthorHistory arguments>>

Arguments

Examples

<<AuthorHistory page=HomePage includeminor=1>>

<<AuthorHistory page=all>>

The Calendar plugin can be used to generate a monthly calendar in a wiki page. It's handy for personal wikis.

Individual dates in the calendar link to specially named wiki pages. The names for the “day pages” are by default formed by appending the date to the pagename on which the calendar appears.

Usage

<<Calendar>>

will get you:

Arguments

Examples

<<Calendar month_offset=+1>>

will get you:

<<Calendar start_wday=0>>

will get you:

See Also

• Help:CalendarListPlugin

Often used together like this:

<<Calendar>>
<<CalendarList>>

Authors

This feature was inspired by Calendar, and first implemented by Gary Benson. It was later implemented as a plugin by Jeff Dairiki.

The Comment plugin lets you hide parts of a Wiki page without actually deleting the text. Comments will only be visible in the Wiki markup when editing or viewing the source.

Usage

Simply place the text to be commented out between <<Comment and >>:

<<Comment

== A Hidden Section ==

This text will not show up in the generated HTML page, but it is still
visible when editing the WikiMarkup.

>>

Author

• Martin Geisler

The CreateBib plugin creates a BibTex file from linked pages.

The page used in argument should contain a list of links to pages containing references in BibTex format.

Usage

<<CreateBib arguments>>

Arguments

Example

<<CreateBib pagename="MyBib">>

Author

• Lea Viljanen

See Also

The CreateToc plugin allows to create a dynamical Table of Contents of all headers. It also allows to number the headers in the page.

The headers might be in classic Phpwiki syntax or in Wikicreole/Mediawiki syntax (see below).

The Table of Contents can easily be inserted by clicking on the TOC button in the Edit toolbar.

Usage

<<CreateToc arguments>>

Arguments

Headers

Syntax: a comma-separated list of levels. !!!,!!,! also allowed

Examples

Default values

<<CreateToc>>

Only two levels of headers

<<CreateToc headers=1,2>>

Table of Contents with hierarchical numbering

<<CreateToc with_counter=1>>

No Table of Contents, but headers are numbered

<<CreateToc notoc=1>>

Table of Contents with hierarchical numbering, first level in roman

<<CreateToc with_counter=1 firstlevelstyle=roman>>

See Also

• Help:TextFormattingRules

Known Problems

• If you include pages via Template or IncludePage plugins, the Table of Contents will not contain the headers of the included pages.

• The Table of Contents will be incorrect if a header contains:

  • a Template plugin call via {{ }},
  • an image,
  • or a ~.
• If you preview the page, the Table of Contents will not be correct if you modified headers. The Table of Contents will be taken from the last saved revision.

The DeadEndPages plugin returns a list of pages which are not linked to by any other page.

It is simply an alias for OrphanedPages plugin.

Administrative plugin, used to debug auth problems and settings. This plugin is only for testing purposes. If DEBUG has no _DEBUG_LOGIN bit set, only the admin user can call it, which is of no real use.

Warning! This may display DB and user passwords in cleartext. We think we cleared everything out though.

Usage

<<DebugAuthInfo userid||=AdminUser>>

Arguments

Example

See DebugAuthInfo

Authors

• Jeff Dairiki
• Reini Urban

See Also

• DebugAuthInfo is the corresponding Help:ActionPage.
• Help:DebugGroupInfoPlugin
• Help:DebugBackendInfoPlugin

The EditMetaData plugin allows you to add/edit/delete metadata key/value pairs for a given page. You must be logged in as the administrator to do this. The page's metadata contains things like the page hit count, last edit time and so on.

<<AppendText argument>>

Argument

Examples

Editing the metadata for the HomePage would look like this:

<<EditMetaData page="HomePage">>

With no arguments the plugin defaults to the current page:

<<EditMetaData>>

The ExternalSearch plugin creates a form to query InterWikis or other internet sites.

Usage

<<ExternalSearch
         url="InterWiki or URL"
         name="button text"
>>

Arguments

Examples

  url="http://sunir.org/apps/meta.pl?"       name="Metawiki Search"
  url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search"
  url=php-lookup
  url=php-function
  url=PhpWiki

Perform a full-text search on multiple wiki's:

Perform a full-text search on MeatBall wiki:

Search the PHP web site for a function name:

Enter the name of a PHP function to view the documentation page:

Enter any existing page name on PhpWiki to jump to that page:

See Also

• Help:TitleSearchPlugin
• Help:FullTextSearchPlugin
• Help:InterWikiSearchPlugin
• Help:LinkSearchPlugin
• Help:SemanticSearchPlugin

The FileInfo plugin displays the version, date, size, perms of an uploaded file. Only files relative and below to the uploads path can be handled.

For exe files the version argument might work to display the VERSIONINFO ressource string. (highly experimental).

Typical Usage

<<FileInfo file=uploads/setup.exe display=version,date>>
<<FileInfo file=uploads/setup.exe display=name,version,date
                                  format="%s (version: %s, date: %s)">>

Arguments

Examples

This wiki was installed at 12/16/18 20:35:17.

The FullTextSearch plugin searches the content of all pages in this wiki.

Usage

<<FullTextSearch arguments>>

Arguments

All PageList arguments (except paganame), plus the following ones:

Example

<<FullTextSearch s=boolean>>

Full text search results for “boolean”

Help/SearchHighlightPlugin

| boolean

| boolean

Help/AllPagesPlugin

| Boolean. If true, header should be omitted.

| Boolean. If true, pages that are referenced but not yet created are included in the list.

Help/VideoPlugin

| Auto play the video when page is displayed (boolean).

Help/FullTextSearchPlugin

| Highlight results (boolean)

| Search with case exact (boolean)

| Do not display header (boolean)

| Be less verbose (boolean)

<<FullTextSearch s=boolean>>

Help/CreateTocPlugin

| Boolean if the Table of Contents should be initially hidden and on click expanded.

| Boolean if the Table of Contents header should be omitted.

| Boolean if the Table of Contents should no be displayed (headers are numbered).

| Boolean if hierarchical prefixes should be added.

| Boolean if headers should link back to the Table of Contents.

Hilfe/AutorenProtokollPlugin

boolean. Vorgabe: false

boolean. Vorgabe: false

boolean. Vorgabe: false

ReleaseNotes

* added boolean UPLOAD_USERDIR to upload into user-specific directory.

Author

• Reini Urban

See Also

• Help:TitleSearchPlugin
• Help:ExternalSearchPlugin
• Help:InterWikiSearchPlugin
• Help:LinkSearchPlugin
• Help:SemanticSearchPlugin

The GoTo plugin displays a form with text entry box and 'Go' button. The user enters a page name... if it exists, browse that page; if not, edit (create) that page.

Note: pagenames are absolute, not relative to the actual subpage.

Usage

<<GoTo>>

Arguments

None.

Example

<<GoTo>>

Authors

• Michael van Dam
• Reini Urban

See Also

The GooglePlugin plugin is a wrapper for the Google Web APIs. It allows you to do Google searches, retrieve pages from the Google cache, and ask Google for spelling suggestions.

Note: You must first obtain a license key at http://www.google.com/apis/

Max 1000 queries per day.

Usage

<<GooglePlugin arguments>>

Arguments

Example

<<GooglePlugin>>

Author

• Reini Urban

See Also

The GraphViz plugin passes all its arguments to the graphviz dot binary and displays the result as cached image (PNG, GIF, SVG) or imagemap. See http://www.graphviz.org/Documentation.php, esp. http://www.graphviz.org/doc/info/lang.html for the dot language specs.

Notes

• We support all image types supported by GD so far, PNG most likely.
• On imgtype = imap, cpamx, ismap, cmap an additional mapfile will be produced.

Usage

<<GraphViz [options...]
   multiline dot script ...
>>

Arguments

Example

<<GraphViz
digraph automata_0 {
        size ="8.5, 11";
        node  [ shape  = circle];
        0 [ style = filled, color=lightgrey ];
        2 [ shape = doublecircle ];
        0 -> 2 [ label = "a " ];
        0 -> 1 [ label = "other " ];
        1 -> 2 [ label = "a " ];
        1 -> 1 [ label = "other " ];
        2 -> 2 [ label = "a " ];
        2 -> 1 [ label = "other " ];
        "Machine: a" [ shape = plaintext ];
}
>>

Author

• Reini Urban

See Also

• VisualWiki plugin, which depends on GraphViz and WikiPluginCached.

A simple example plugin.

From the source of this page:

<<HelloWorld salutation="Hello," name="Wiki User" >>

PhpWiki's plugin architecture allows you to add custom page elements to your wiki. All you have to do is extend (subclass) the WikiPlugin class and create your output via the run() method, dependent on the Wiki- or Request arguments,

• either with the predefined HTML classes to create valid XHTML,
• or by using templates, which are easier customizable, but generally more a mess to use and easier to create invalid XHTML.

The IncludePage plugin will “include” other pages in this wiki. In the language of hypertext this is called transclusion.

Usage

<<IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6>>

Arguments

Inclusion

is stripped.

.. is only expanded in included pages.

Examples

IncludePage page=Help/AllPagesPlugin

Included from Help/AllPagesPlugin

<<AllPages arguments>>

<<AllPages limit=20 cols=3>>

IncludePage page=Help/AllPagesPlugin lines=6

Included from Help/AllPagesPlugin

<<AllPages arguments>>

IncludePage page=Help/AllPagesPlugin section="Arguments"

Included from Help/AllPagesPlugin

IncludePage page=Help/AllPagesPlugin section="Arguments" sectionhead=true

Included from Help/AllPagesPlugin

IncludePage page=Help/AllPagesPlugin sections=2

Does not work in Wikicreole syntax

Known Problems

• Line and word limit doesn't work if the included page itself includes a plugin.
• "sections" parameter does not work if sections to include are in Wikicreole syntax.
• "section" parameter does not always work if sections to include use both Wikicreole/Mediawiki and classic Phpwiki syntax.

Authors

• Joe Edelman
• bug fixes by Reini Urban
• "sections" parameter implemented by Marc-Etienne Vargenau, Alcatel-Lucent

See Also

• Help:IncludePagesPlugin (to include multiple pages)
• Help:TemplatePlugin (to include a page with parameters)

The IncludePages plugin will "include" a list of multiple pages, based on IncludePage plugin.

Usage

<<IncludePages arguments >>

Arguments

All arguments from IncludePage plugin, plus the following ones:

Example

<<IncludePages pages=<!plugin-list BackLinks !> >>

Author

• Reini Urban

See Also

• Help:IncludePagePlugin

Display Dynamic Category Tree.

Usage

<<IncludeTree arguments>>

Arguments

Example

<<IncludeTree>>

Author

• Reini Urban

See Also

• Help:SiteMapPlugin

The JabberPresence plugin shows Jabber presence status.

Usage

<<JabberPresence arguments>>

Arguments

Example

<<JabberPresence scripturl=http://edgar.netflint.net/status.php
                 jid=yourid@jabberserver type=html iconset=phpbb >>

Author

• Arnaud Fontaine

See Also

The LikePages plugin lists page names which share an initial or final title word with a given page.

Usage

<<LikePages arguments>>

Arguments

All PageList arguments, plus the following ones:

Examples

<<LikePages page=HomePage>>

These pages share an initial or final title word with “HomePage”

• WatchPage
• RandomPage
• ModeratedPage
• HomePageAlias
• HomePage
• Help/ActionPage
• FindPage
• CreatePage
• CategoryActionPage

<<LikePages suffix=Page>>

Page names with suffix “Page”

• WatchPage
• RandomPage
• ModeratedPage
• HomePage
• Help/ActionPage
• FindPage
• CreatePage
• CategoryActionPage

Author

• Reini Urban

See Also

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:

Additional info arguments

Examples

<<ListPages pages=HomePage,FindPage>>

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

The MostPopular plugin will display the pages of wiki that have the most (or least) number of hits.

Usage

<<MostPopular arguments>>

Arguments

All PageList arguments, plus the following ones:

Example

<<MostPopular limit=10>>

The 10 most popular pages of this wiki:

|<<   << - 1 / 58 - Next >>   >>|
|<<   << - 1 / 58 - Next >>   >>|
Page Name	Hits
HomePage	1708765
VerlinkteÄnderungen	979999
RecentChanges	831562
NeuesteÄnderungen	818322
GeringfügigeÄnderungen	486000
SenasteÄndringar	374781
DetteErUtenMelk	285465
RecentEdits	243985
KokeBok	233043
Bakst og kaker	213377

Author

• Reini Urban

See Also

The OldStyleTable plugin can be used to include tables within a wiki page using the old-style markup syntax for tables.

This plugin is included for legacy only. We recommend to use Wikicreole tables or Mediawiki tables instead.

Usage

<<OldStyleTable caption="OldStyleTable" border||=2
||^  *Name*                |v *Cost*   |v *Notes*
| *First*     | *Last*
|> Jeff       |< Dairiki   |^  Cheap   |< Not worth it
|> Marco      |< Polo      | Cheaper   |< Not available
>>

will get you

Note that multiple |s lead to spanned columns, and vs can be used to span rows. A > generates a right justified column, < a left justified column and ^ a centered column (which is the default.)

Arguments

Syntax

Note that within each table cell, new-style markup is used. You can only use inline markup --- no block level markup is allowed within table cells.

(Using old-style markup wouldn't make much sense, since one can't include multi-line plugin invocations using the old-style markup rules.)

See Also

• Help:MediawikiTablePlugin
• Help:RichTablePlugin
• Help:WikicreoleTablePlugin

The PageInfo plugin returns extra information about a page.

This plugin just passes a page revision handle to the Template 'info.tmpl', which does all the real work.

Usage

<<PageInfo arguments>>

Arguments

Example

<<PageInfo>>

Author

• Reini Urban

See Also

The PluginManager plugin provides a dynamic list of plugins on this wiki.

Usage

<<PluginManager info=args>>

Arguments

Configuration

define('REQUIRE_ADMIN', true) in the sourcecode to disable general usage.

Example

<<PluginManager>>

PhpWiki lets you extend it with new functionality via a plugin mechanism. In short, you extend a PHP class we provide and customize it to print out the content you want. For more information see Help:WikiPlugin, Help:HelloWorldPlugin, and view the source of the files in lib/plugin.

If there is no example page for the plugin, or you need more information, the best place to go is the source of the plugin. Under your wiki's root directory, the folder lib/plugin contains all the PHP files for the plugins.

External Requirements

Some plugins require correctly configured PLUGIN_CACHED and external libraries not provided with PhpWiki or PHP, such as

• PHP with GD support for the text2png plugin,
• LaTeX2HTML for the TexToPng plugin and TeX2png plugin,
• graphviz for the GraphViz plugin and VisualWiki plugin,
• ploticus for the Ploticus plugin,
• USE_DB_SESSION = true (default for the peardb, adodb or dba backends) for the WhoIsOnline plugin,
• --with-xml support (with expat or libxml2) for the RssFeed plugin (ProjectSummary, RecentReleases) and HtmlParser support (ImportHtml, HtmlAreaEditing),
• PHP Mail functionality (php.ini: SMTP + sendmail_from on Windows or sendmail_path) for email PageChangeNotifications? and ModeratedPage's,
• a Google license key for the GooglePlugin plugin,
• optionally apache/mod_log_{my}sql for fast, external log analysis if ACCESS_LOG_SQL=1 (Referer, Abuse Prevention). See lib/Request.php and http://www.outoforder.cc/projects/apache/mod_log_sql/

Author

• Jeff Dairiki ?

The PopularTags plugin lists the most popular tags.

Usage

<<PopularTags arguments>>

Arguments

Example

<<PopularTags>>

• Prisliste (45)
• InterWiki (5)

Author

• Reini Urban

See Also

• Help%2FCategories
• Help%2FCategoryPagePlugin?

With this plugin you can embed raw unfiltered HTML in the page source; say, for example, you want to put in a complicated set of nested tables to display data. By default, raw HTML is not allowed in most Wikis due to security problems (because malicious users can insert redirects, Javascript, etc.)

For this plugin to work, the page must be locked by the administrator. If you are seeing the raw HTML being displayed below, instead of rendered, try locking the page (log in as the administrator first).

Cache output of RecentChanges called with default arguments.

Usage

<<RecentChangesCached>>

Arguments

Same as Help:RecentChangesPlugin

Example

<<RecentChangesCached limit=10>>

RecentChanges

The 10 most recent major edits during the past 2 days are listed below.

No changes found

Author

• Reini Urban

See Also

Velkommen til utenmelk !!

Utenmelk er en side for alle oss som lever med melkefritt kosthold.

I forumet kan man diskutere kosthold, utveksle tips, oppskrifter, få råd og dra nytte av andres erfaringer. Mailinglista har vært i aktivitet en stund. Her kan man meddele tips og motta nyhetsbrev. Dere er selvfølgelig velkommen til å skrive direkte til meg også.

Utgangspunktet for siden er melkefritt kosthold, men det er litt å finne også for andre allergier og intoleranser. Dessverre er det slik at man ofte har flere enn èn allergi. Det være seg f.eks egg, nøtter, sitrus, soya, fisk, pollen, miljøfaktorer eller glutenintoleranse (cøliaki).

Mitt navn er Hege J. Fledsberg, jeg er laktoseintolerant og har ulcerøs colitt, i tillegg til allergi for en del miljøfaktorer. Min datter er multiallergiker, med blant annet både melk, egg, nøtter, skalldyr, sitrus og miljøfaktorer på sin liste. Vi har også begge ulik grad av atopisk eksem. Jeg har etterhvert mye erfaring og god oversikt over temaet allergi. Jeg har drevet Utenmelk siden 2006, da tok jeg over etter Kristin Øien som startet siden i 1999. Kristin er fortsatt med på laget og har ansvaret for mailinglista.

Håper siden kan være til hjelp og at vi alle her kan dra nytte av hverandres erfaringer.

Velkommen!!

Undersider:

*MelkeAllergi *LaktoseIntoleranse *AndreAllergier *AtopiskEksem *HøytKolesterol *UlcerøsColitt *TipsOgGodeRåd *DetteErUtenMelk *TrygdeRettigheter *NyttigeLenker *KokeBok *HandleISverige *KontaktInfo

The SearchHighLight plugin is an action page plugin, which is only used internally.

When someone is referred from a search engine like Google, Yahoo or our own fulltextsearch, the terms the user searched for are highlighted. See also .

Arguments

Display the list of relations and attributes on this page.

Usage

<<SemanticRelations>>

Arguments

Example

<<SemanticRelations>>

Author

• Reini Urban

See Also

The Template plugin allows to include text from a wiki page and replace certain placeholders by parameters.

A template can be seen as a parametrized block. It is similiar to CreatePage with the template argument, but at run-time.

There are two syntaxes to call a template, the usual Phpwiki syntax for plugins, and a more concise syntax similar to Mediawiki templates.

Usage

Without parameters

Plugin syntax:

<<Template page=Footer>>

Short syntax:

{{Footer}}

With parameters

Plugin syntax:

<<Template page=Film vars="title=SomeFilm&year=1999">>

Short syntax:

{{Film|title=SomeFilm|year=1999}}

With a specific revision of the page

Plugin syntax:

<<Template page=somepage rev=5>>

Short syntax:

{{somepage?version=5}}

Arguments

Page to include

If "Template:$page" exists, it is used.

Else, if "Template/$page" exists, it is used.

Else "$page" is used.

This allows compatibility with Mediawiki that puts templates in the "Template:" namespace.

Parameter expansion

We only support named parameters, not numbered ones as in Mediawiki, and the placeholder is %%var%% and not {{{var}}} as in Mediawiki.

vars="var1=value1&var2=value2"

The following predefined variables are automatically expanded if existing:

Inclusion

is stripped.

.. is only expanded in pages using the template, not in the template itself.

Converts TeX to an image. May be used to embed formulas in PhpWiki.

Usage

<<TexToPng arguments>>

Arguments

Examples

This produces a little help screen:

<<TexToPng>>

A simple formula:

<<TexToPng tex="$x^2$" >>

A more complex formula:

<<TexToPng tex="$$/int^/infty_{-/infty} dx {1 /over /sqrt {x^2+1}}$$" subslash="on" >>

Author

• Johannes Große

See Also

The Transclude plugin can be used to embed include whole (external) web pages within a wiki page.

Pages are transcluded using <iframe> tags.

Arguments

Bugs / Caveats

• When possible, Javascript code is used to adjust the height of the iframe so that it fits the entire transcluded page. Unfortunately, this seems possible only when the transcluded page comes from the same server as the wiki page. (This restriction is due to security checks built in to the Javascript language.)
• The recursion detection code does not currently work. Be careful to avoid recursive transclusions, or you'll be sorry (or at least amused.)

Example

<<Transclude src="http://phpwiki.svn.sourceforge.net/viewvc/phpwiki/trunk/pgsrc/ReleaseNotes?view=markup">>

will get you

Transcluded from http://phpwiki.svn.sourceforge.net/viewvc/phpwiki/trunk/pgsrc/ReleaseNotes?view=markup

The UpLoad plugin displays an editbox and two buttons.

• The first button lets you choose the file to be uploaded at your local filesystem. The text value of this button is localised from your browser.
• The second “Upload” button actually uploads the given filename to the upload directory.

This directory is not browsable, any file there may be accessed by using the “Upload:” InterWikiMap prefix to the given filename. This way you can easily inline uploaded images.

Usage

<<UpLoad arguments>>

Arguments

Notes

1. The user must be authenticated to be able to upload.
2. The filename may not end with certain disallowed extensions, to prevent from abuse.
3. MAX_FILE_SIZE is configured by the config.ini option MAX_UPLOAD_SIZE, which defaults to 16MB. Your webserver and PHP may add another limit.
4. Already existing uploaded files are NOT overwritten.

Example

<<UpLoad>>

See Also

The Video plugin allows to include video in a wiki page. Video file must be encoded in FLV format (Flash Video) or in an HTML 5 format:

• Ogg (.ogg suffix),
• MP4 (.mp4 suffix),
• WebM (.webm suffix).

The Video plugin can also be called with the {{video.flv}} syntax.

Arguments

Use only one of url or file arguments at a time.

Examples

A video:

<<Video url=http://a.video.server/a_video.flv>>

Another video:

<<Video file=another_video.flv>>

This is equivalent to:

{{another_video.flv}}

Big Buck Bunny

{{http://video.webmfiles.org/big-buck-bunny_trailer.webm}}

Authors

• Roger Guignard, Alcatel-Lucent
• Marc-Etienne Vargenau, Alcatel-Lucent

See Also

• Help:Images
• Help:Adobe Flash
• Help:Wikicreole
• WebM Video for Internet Explorer 9+

The WikiAdminDeleteAcl plugin allows to delete page permissions.

Usage

<<~WikiAdminDeleteAcl arguments>>

Arguments

Example

<<WikiAdminDeleteAcl s=Temp*>>

<?plugin WikiAdminDeleteAcl s=Temp*?>

Author

• Marc-Etienne Vargenau, Alcatel-Lucent

See Also

• PhpWikiAdministration

The WikiAdminPurge plugin allows to purge pages.

Usage

<<WikiAdminPurge arguments>>

Arguments

Example

<<WikiAdminPurge s=Temp*>>

<?plugin WikiAdminPurge s=Temp*?>

Author

• Marc-Etienne Vargenau, Alcatel-Lucent

See Also

• PhpWikiAdministration

This simple plugin allows blog-style entries on a page. Try making a few entries, and then look at RecentChanges to get an idea of how things work.

This plugin shows 'blogs' (comments/news) associated with a particular page and provides an input form for adding a new blog.

Arguments

Usage

Add <<WikiBlog>> at your PersonalPage and BlogArchives and BlogJournal? will find the Blog entries automatically.

Now it is also the base class for all attachable pagetypes: "wikiblog", "comment" and "wikiforum"

Hints/comments

To have the blog show up on a separate page:

On TopPage, use <<WikiBlog mode=add>> Create TopPage/Blog with this page as actionpage: <<WikiBlog pagename=TopPage mode=show>>

To have the main ADMIN_USER Blog appear under Blog and not under WikiBlog?/Blog or UserName/Blog as for other users blogs, define BLOG_DEFAULT_EMPTY_PREFIX=true use the page Blog as basepage and user="" (as default for ADMIN or current user) and pagename="Blog" in the various blog plugins (BlogArchives, BlogJournal?)

Example

You must be logged in to add blog entries.

Author

• Michael Van Dam, major refactor by Jeff Dairiki (as AddComment)
• Changed as baseclass to AddComment and WikiForum and EditToolbar integration by Reini Urban.

See Also

• Help:BlogJournalPlugin
• Help:BlogArchivesPlugin

The WikiForm plugin provides generic input buttons.

Usage

<<WikiForm arguments>>

Arguments

Example

<<WikiForm action="loadfile" buttontext="Load File">>

Author

• Reini Urban

See Also

• Help:WikiFormRichPlugin

Create generic and enhanced forms, with various options:

• editbox[] name=.. value=.. text=.. autocomplete=0|1
• checkbox[] name=.. value=0|1 checked text=..
• radio[] name=.. value=.. text=..
• pulldown[] name=.. value=.. selected=.. text=.. autocomplete=0|1
• combobox[] name=.. value=.. text=.. method=.. args=..
• hidden[] name=.. value=..
• submit[]
• action, submit buttontext, optional cancel button (bool)
• method=get or post, Default: post.

Valid arguments for pulldown and editbox: autocomplete=1, Default: 0

If autocomplete=1, additional arguments method and args may be used. autocomplete together with dyn-methods (see below) should be used to handle larger lists (> 500).

If no method is given, value will be used to fill in the valid values.

method="xmlrpc:name [optional args]"
method="dynxmlrpc:url [optional args]"
method="url:http://server/wiki/method"
method="dynurl:http://server/wiki/method"
method="array:jsvariable"
method="plugin:pluginname [optional args]"

• The plugin must return a pagelist.
• args are optional arguments, space separated, for the method.
• A combobox is a pulldown with autocomplete=1.
• Values which are constants are evaluated.
• The cancel button must be supported by the action (just some wikiadmin actions so far)
• improve layout by: nobr=1
• some allow values as list from <!plugin-list pluginname args !>

Samples

<<WikiFormRich action=dumpserial method=get
               checkbox[] name=include value="all"
               editbox[] name=directory value=DEFAULT_DUMP_DIR
               editbox[] name=pages value=*
               editbox[] name=exclude value=""
>>

<<WikiFormRich action=dumphtml method=get
               editbox[] name=directory value=HTML_DUMP_DIR
               editbox[] name=pages value="*"
               editbox[] name=exclude value=""
>>

<<WikiFormRich action=loadfile method=get
               editbox[]  name=source value=DEFAULT_WIKI_PGSRC
               checkbox[] name=overwrite value=1
               editbox[]  name=exclude value=""
>>

<<WikiFormRich action=TitleSearch method=get class=wikiadmin nobr=1
               editbox[] name=s text=""
               submit[]
               checkbox[] name=case_exact
               checkbox[] name=regex
>>

<<WikiFormRich action=FullTextSearch method=get class=wikiadmin nobr=1
               editbox[] name=s text=""
               submit[]
               checkbox[] name=case_exact
               checkbox[] name=regex
>>

<<WikiFormRich action=FuzzyPages method=get class=wikiadmin nobr=1
               editbox[] name=s text=""
               submit[]
               checkbox[] name=case_exact
>>

<<WikiFormRich action=AppendText buttontext="AddPlugin"
               radio[] name=s value=<!plugin-list BackLinks page=WikiPlugin limit=5 !>
>>

<<WikiFormRich action=AppendText buttontext="AddPlugin"
               combobox[] name=s text="" style="width:60px" value=<!plugin-list BackLinks page=WikiPlugin !>
               submit[]
>>

<<WikiFormRich action=AppendText buttontext="AddCategory"
               pulldown[] name=s text="Categories: " value=<!plugin-list TitleSearch s=Category !>
>>

<<WikiFormRich action=SemanticSearch buttontext="AddRelation"
               combobox[] name=relation method="xmlrpc:listRelations"
               submit[]
               checkbox[] name=case_exact text="Case-exact?"
>>

<<WikiFormRich action=AppendText buttontext="InsertTemplate"
               combobox[] name=s text="Template: " method="plugin:titleSearch s=Template*"
               submit[]
>>

<<WikiFormRich action=GoTo
               editbox[] name=page text="GoTo: " method="dynxmlrpc:titleSearch s=H" style="width:100px" autocomplete=1
               submit[]
>>

Author

• Reini Urban

See Also

• Help:WikiFormPlugin

Convert text into a png image using GD without using WikiPluginCached. The images are stored in a private <PHPWIKI_DIR>/images/<LANG> subdirectory instead, which are not timestamp checked at all. Delete the .png file(s) if you change anything.

This is a really simple and stupid plugin, which might need some work.

Usage

<<text2png text="some text">>

Arguments

Configurable Options

See the sourcecode. You'd probably need to adjust $ttfont and text2png_debug.

Example

<<text2png text='Hello WikiWorld!'>>

See Also

• Help:TeX2pngPlugin
• Help:TexToPngPlugin