PhpWikiManual

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

Visit our home page at https://sourceforge.net/projects/phpwiki/ and see PhpWiki in action at http://phpwiki.demo.free.fr (and of course here too ).

A WikiWikiWeb is a site where everyone can collaborate on the content. The most well-known and widely used Wiki is the Portland Pattern Repository at http://c2.com/cgi-bin/wiki?WikiWikiWeb.

You and I will find these statements there particularly relevant:

The point is to make the EditText form simple and the FindPage search fast.

In addition to being quick, this site also aspires to Zen ideals generally labeled WabiSabi. Zen finds beauty in the imperfect and ephemeral. When it comes down to it, that's all you need.

The Universe tends toward chaos. The Universe tends toward Wiki.

You can say hello on RecentVisitors, or read about HowToUseWiki and AddingPages. So go ahead and play with it and have fun!!

-- Steve Wainstead

Hi. I started building this WikiWikiWeb but many others help me now. I'm at http://www.panix.com/~swain/.

Please report bugs to phpwiki-talk@lists.sourceforge.net.

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.

Here are some wikis using PhpWiki:

URL	PhpWiki release	Theme
http://alsach.at/phpwiki/	1.4.0RC1	default
https://bh.hallikainen.org	1.6.0	Sidebar
http://www.carnatic.com/karmasaya/
http://churchofvirus.org/wiki/	1.3.2-jeffs-hacks	Virus (custom)
http://crossfamily.me.uk/wiki/	1.2.7
http://www.dairiki.org/HammondWiki/	1.3.5pre	default
https://dev.cmeerw.org	1.6.1	Sidebar
http://dkbush.com/zphpwiki/	1.3.14
http://drtedwilliams.net/kb/	1.3.14	MacOSX
http://e38.org/phpwiki/	1.3.14
http://echolalie.org/wiki/index.php?EcholaListes
http://forge.cesga.es/wiki/g/optimiza/		Fusionforge
http://forkedcedarandscuppermongfarm.com/phpwiki/	1.2.10
https://garage.maemo.org/plugins/wiki/index.php?id=290&type=g		Gforge
https://gforge.irsn.fr/gf/project/redice/wiki/		Gforge
http://gforge.wits.ac.za/gf/project/vre/wiki/		Gforge
https://www.gidley.co.uk/wiki/
http://glhrn.org/NoPlaceToGo/	1.4.0RC1	Sidebar
http://gouwm.com/wiki/	1.2.11
http://hollenback.net	1.5.4	Sidebar
https://kcpralumni.org/wiki/	1.6.0	Sidebar
http://kqlives.sourceforge.net/	1.3.14	kq (custom)
http://math.drhuang.com/wiki/Index.php/HomePage	1.4.0RC1	Sidebar
http://matthieuachard.free.fr/wiki/	1.2.10
http://meanwhile.sourceforge.net/wiki/	1.4.0RC1	MonoBook
http://mtswiki.westwood-tech.com/mtswiki-index.php/HomePage	1.6.0	Sidebar
http://mupad-combinat.sourceforge.net/Wiki/AboutWiki.html		default
http://muthanna.com/looperng/tutorial/HelpPages.html	?? (wikidump)
http://netfrag.org/rrr/wiki/	1.5.5	Sidebar
http://nukemclan.free.fr	1.2.10
http://ohg82er.de/wiki/	1.3.2-jeffs-hacks	DigiLog (custom)
http://oldwiki.gnustep.org	1.3.2-jeffs-hacks
http://people.biology.ucsd.edu/bshanks/hosting/work/papers/symSysHonorsThesis/talkSlides/biw.html	1.3.5pre	default
http://raczkowscy.prv.pl	1.2.10
http://rec-puzzles.org	1.3.11p1	default
https://senseis.xmp.net
http://squibbett.vacationhomesonnantucket.com/wiki/	1.2.11
http://swimuu.org/cu2c2-board/
https://tdwg.napier.ac.uk	1.3.10	default
http://the-bees-knees.info/phpwiki/	1.5.4	default
http://utenmelk.no/wiki2/	1.6.0	Wordpress
http://wac-tk.drni.de	1.3.11p1	Crao
https://wiki.cyberleo.net	1.5.5	MacOSX
http://wiki.elaboratedsolutions.com	1.2.11
http://wiki.wlug.org.nz	1.3.11p1	WLUG05 (custom)
http://www.allpsych.uni-giessen.de/wikidump/HomePage.html	?? (wikidump)
http://www-bd.lip6.fr/ens/li345-2011/index.php/Accueil	1.4.0RC1	default
https://www.cs.helsinki.fi/group/keltsi/wikidumphtml/HomePage	?? (wikidump)
https://www.gidley.co.uk/wiki/
http://www.student.nada.kth.se/gecco/phpwiki/
http://xmlhack.ru/protva/xquery/index.php/	1.3.2-jeffs-hacks

See also

• https://www.opensourcecms.com/phpwiki/ for a Phpwiki demonstration.

Adding pages

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.

Removing pages

Removing a page will clear all it versions. The history of the page will still be visible and the removal will appear in the RecentChanges. It will be possible to restore the page by creating a new version; in that case, all previous versions will be restored.

You must be logged as administrator to be able to remove a page.

Purging pages

Purging a page will delete it with all its versions without any possibility to restore it. Purging will not appear in the RecentChanges.

You must be logged as administrator to be able to purge a page.

All pages have an Edit link. You can edit the page you are reading by clicking that link.

“Young writers often suppose that style is a garnish for the meat of prose, a sauce by which a dull dish is made palatable. Style has no such separate entity; it is nondetachable, unfilterable. The beginner should approach style warily, realizing that it is himself he is approaching, no other; and he should begin by turning resolutely away from all devices that are popularly believed to indicate style--all mannerisms, tricks, adornments. The approach to style is by way of plainness, simplicity, orderliness, sincerity.”

--Strunk and White, “The Elements of Style”

And thus an American textbook, typical required reading for 10th-grade English students, unknowingly extols some virtues of Wabi Sabi.

--scummings

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

See MeatBall:GooglePrompt

“Wiki wiki” means “quick” in Hawai'ian.

All you really need to know is:

• To edit any page click on the Edit. You should do that right now, and read the source code of this page. It will make more sense.
• You get italics by surrounding words with two slashes on either side like this.
• You get bold text by using two asterisks on either side.
• And, bold italics by using both.
• You get monospaced text by using two hash signs on either side.
• You get bullets by using an asterisk * at the start of the line.
• To have a paragraph in plain monospaced font, start it with {{{ and end it with }}}:

  this is a poem for sure
  about monospacing
  i wrote in purple velour
  but couldn't find a rhyme for monospacing

• You separate paragraphs with an extra blank line. Example:

I am a paragraph.

I am a paragraph too. We're just very small paragraphs.

• You can get horizontal rules with four or more dashes like this:

• To create hyperlinks you just capitalize the words and string them together. Let's say you want to create a page about how Steve Wainstead eats worms. All you have to do is capitalize each word and string them together like this: SteveWainsteadEatsLiveWorms. If the page does not exist yet a question mark appears after the link, inviting you to create the page: ThisPageShouldNotExist. (And please don't ruin the example by creating one.)
• To link to pages outside the Wiki, you can just type in the URL and Wiki will link it for you: http://www.nytimes.com/
• To put images in, just provide the hyperlink in brackets like this: [[http://www.yourhost.yourdomain/images/picture.png]]. Image URLs not in brackets will just appear as hyperlinks to the image.
• Now you are ready to begin adding pages.

A WikiWikiWeb is meant to be fast and easy to edit. It has very simple markup that you can read about in Help:TextFormattingRules.

If you don't like the size of the text editing window you get, you can change it. See UserPreferences.

Here are some good starting points for browsing.

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

Title Search

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

Full Text Search

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

Fuzzy Search

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'.

PhpWikiDocumentation

You can easily use images in the wiki.

Uploaded images

First, image files need to be uploaded in the wiki. For that purpose, you will use the UpLoad plugin.

Toolbar

Once the image is uploaded, the easiest way to insert it is to use the toolbar.

Click on the icon and you will be shown a list of available images.

Select an image and click Insert. The image will be inserted without options or alternative text.

TOOLBAR_IMAGE_PULLDOWN must be set to true for the icon to appear in the toolbar (default).

Syntax

You give access to the uploaded image with the following syntax.

{{myimage.png}}

or

[[Upload:myimage.png]]

will inline the image.

{{myimage.png|this is the alt text for my image}}

inlines the image with an alternative text.

[[some link|{{myimage.png}}]]

if you click on the image, will goto "some link"

[[some link|{{myimage.png|alt text}}]]

same with alternative

[[http://example.com/|{{myimage.png}}]]

same as above: picture links to url

[[http://example.com/|{{myimage.png|alt text}}]]

same with alternative

Upload:myimage.png

shows a plain link

[[Upload:myimage.png | my image]]

shows the image under a link named "my image".

For Mediawiki compatibility, the keyword Upload: can be replaced by File: or Image:.

Options

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

[[Upload:myimage.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

URL images

You can also use "external" images by providing a URL.

In that case, you simply put the URL between double brackets or double curly brackets:

[[http://phpwiki.demo.free.fr/themes/default/images/poweredby_phpwiki_51x31.png]]

or

{{http://phpwiki.demo.free.fr/themes/default/images/poweredby_phpwiki_51x31.png}}

will give:

See Also

• Help:VideoPlugin
• Help:Wikicreole

Categories are a way to group pages that are related to the same subject. They provide an easy way to browse the wiki.

In Phpwiki, categories are not stored in a separate namespace like in Mediawiki for instance. A category is a page with a name that begins with “Category” and contains a call to the BackLinks plugin.

Creating a new category

The simplest way to create a new category is to to go the CategoryCategory page.

Enter its name (starting with “Category”) and hit “CreatePage” button.

This will automatically insert the necessary plugins calls.

You might want to add at the beginning of the page a paragraph explaining the purpose of the category.

Suppose you want to create a category called CategoryFruit. You might add:

This Category groups the different kinds of fruit.

By default, the new category is created as a subcategory of CategoryCategory (the “root” category). You might want to change this (see below “Category hierarchies”).

Putting a page in a category

To put the article banana in CategoryFruit, you have to put at the end of the page:

----
[[CategoryFruit]]

The CategoryFruit page will then display your text describing the purpose of the category, then the list of pages in the category.

The can be done very easily by using the button of the edit toolbar when editing the page.

Category hierarchies

The simplest way to use categories is to use “flat” categories. But you can also build a hierarchy of categories by putting categories themselves in categories.

For example, you can put the [[CategoryFruit]] in [[CategoryFood]] instead of default [[CategoryCategory]].

Tips and tricks

• Page CategoryCategory is the root category. All categories should be subcategories of this category (recursively).
• If in a page you need to refer to a category, you should add a semi-colon: [[:CategoryFruit]]. This will create a link to the category without putting the page in the category (which would be the case if using [[CategoryFruit]]).
• You can put a page in several categories if needed.

PhpWikiDocumentation

This wiki supports InterWiki links in a style copied from UseMod: wiki. Links to pages in other wikis can be made without having to know or type the full URLs, for example: MeatBall:InterWiki will link to the page named "InterWiki" at Meatball wiki.

The InterWiki map is taken from the the <verbatim> block in InterWikiMap, but that page must be locked for it to work. This denies a potential hacker the ability to nefariously change every InterWiki link to point to some evil URL. If no map is found in InterWikiMap (or the page is not locked), PhpWiki will fall back to using the file lib/interwiki.map in your phpwiki distribution. The InterWiki map file in use at PhpWiki: can be viewed at http://phpwiki.sf.net/interwiki.map.

The map file is manually updated. It is based upon and periodically synchronized with UseMod's InterMap but it is not quite identical. One notable difference from UseMod: is that PhpWiki supports '%s' within the URLs in the map--see the entry for RFC for an example of how this works.

Not all of the entries in the InterWikiMap are actual wikis. For example, these are just regular web sites: Dictionary:fungible, JargonFile:Alderson loop, IMDB:Roman Holiday, RFC:2822, and ISBN:020171499X.

The "Category" moniker is a special entry which allows one to link a wiki page to a Category page without creating a back-reference. Thus Category:Category links to the CategoryCategory page, yet this page won't show up in the back-links listing of CategoryCategory.

The term "InterWiki" also refers to a broader concept. See InterWikiSearch for more links.

PhpWikiDocumentation

LinkIcons are an optional feature of PhpWiki. When activated, icons will be displayed in front of URLs to indicate the type of link.

	http link
	generic internet link
	Interwiki link
	https link
	mailto link
	ftp link

Examples

The following examples will display with the above link icons only if the administrator has enabled this feature.

InterWiki links

• InterWiki link PhpWiki:InterWikiMap
• A named InterWiki read WhyWikiWorks at c2.

URLs

• Email address PhpWiki-talk mailing list
• Normal http link PhpWiki's Home Page
• Secure http link PhpWiki's Home Page
• File transfer ftp://ftp.sourceforge.net

A generic icon is shown for other less common link types.

• news://nntp.news.com
• gopher://gopher.caltech.cmu.edu

LinkIcons will only display when the URL protocol is one which PhpWiki is allowed to link to. The following examples won't show any icons and PhpWiki won't automatically provide double-clickable links either, unless the administrator adds them:

• bogus://oedipus.nostradamus.com
• bolo://lgm.cheshire.org

Phpwiki allows you to easily include some predefined icons in your wiki pages.

The following icons are available:

Notation	{{:)}}	{{:(}}	{{:P}}	{{:D}}	{{;)}}	{{(y)}}	{{(n)}}
Image
Notation	{{(i)}}	{{(/)}}	{{(x)}}	{{(!)}}	{{(+)}}	{{(-)}}	{{(?)}}
Image
Notation	{{(on)}}	{{(off)}}	{{(*)}}	{{(*r)}}	{{(*g)}}	{{(*b)}}	{{(*y)}}
Image

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.

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 (376 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:

   <<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:

   <<BackLinks page>>

3. Default values specified in the plugin invocation:

   <<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

About phpwiki: URLs

A special type of URL is available for making links to perform administrative and other special functions in PhpWiki. Here is a brief description of how they work.

The basic syntax of a phpwiki: URL is

phpwiki:pagename?query-args

If pagename is omitted it defaults to the current page.

Query-args should be a set of parameters in standard HTTP GET format.

The "action=x" parameter should almost always be given. It can be one of browse, diff, edit, viewsource, zip, dumpserial, loadserial, remove, lock, unlock, login, logout, setprefs or save. The default action is browse.

Some of the actions accept other parameters.

Writing Magic Links in Wiki Pages

A magic link looks like:

[[ text | phpwiki-url ]]

The "text |" is optional but usually recommended. If given it will provide the label for the link.

The phpwiki-url is a phpwiki: URL as described above.

Some examples

[[phpwiki:SandBox?action=edit|Edit the SandBox]]

will generate a link which will take you directly to editing the SandBox, like so: Edit the SandBox.

Other possibilities:

• Diff the SandBox,
• Lock the HomePage,
• Get a Full Zip Dump,
• Search for Page titles containing 'wiki'

Writing Magic Forms in Wiki Pages

Note: The old syntax for Magic forms is no longer supported. They are superseded by <?plugin-form>.

If the plugin is called using <?plugin-form instead of <?plugin and the plugin supports searching, then it will be rendered as a form.

Examples

A search plugin invoked with <?plugin instead of <?plugin-form simply inserts the search results of the plugin:

<<TitleSearch s=wiki noheader=true limit=10>>

Search results for Page titles containing 'wiki':

• PhpWikiDocumentation
• PhpWikiManual
• PhpWikiPoll
• PhpWikiRecentChanges
• The PhpWiki programming team
• WikiBlog
• WikiWikiWeb

<?plugin-form FullTextSearch ?>

gives

While

<?plugin-form TitleSearch formsize=12 ?>

yields

PhpWiki is written in the server-side scripting language PHP, available from https://www.php.net/. PHP resembles C and Perl in its syntax, and functions much like ASP, EmbPerl or JSP.

PhpWiki consists of a dozen or so files of mixed PHP and HTML. The web pages that make up a WikiWikiWeb based on PHP live in a database with backup copies of previous versions of pages stored as well. (For the database, PhpWiki works with DBM, MySQL, PostgreSQL or text files.)

Every time a user hits the site, the page requested is pulled from the database and rendered on the fly. The user only really ever requests the file index.php, which then decides which other PHP files to include.

Links to pages in the Wiki are automatically linked: FindPage. This might be the single most compelling aspect of a Wiki, the ability to add pages simply by linking to them. The next most compelling thing is how easily external URLs link, like this:

1. http://www.wcsb.org/
2. ftp://ftp.redhat.com/
3. news://news.mozilla.org/
4. http://slashdot.org/
5. http://theregister.co.uk/

Combined with one namespace and a simple markup, a Wiki exhibits many of the characteristics of WabiSabi.

PhpWiki is licensed under the GNU General Public license, which you should be able to see here: http://www.gnu.org/copyleft/gpl.txt.

Phpwiki allows you to use the Wikicreole syntax to edit your wiki pages.

We have implemented most of Wikicreole 1.0 and Wikicreole 1.0 additions. What is implemented is described below.

Complete information about Wikicreole can be found at: http://www.wikicreole.org/

Cheat Sheet from Wikicreole web site

Text formatting

Bold

Bold text is made using two stars:

This sentence contains **words in bold**.

This sentence contains words in bold.

Italics

Italics text is made using two slashes:

This sentence contains //words in italics//.

This sentence contains words in italics.

Underline

Underline text is made using two underscores:

This sentence contains __underlined text__.

This sentence contains underlined text.

Monospace

Monospace text is made using two hashes:

This sentence contains ##monospace text##.

This sentence contains monospace text.

Superscript

Superscript text is made using two carets:

The XX^^th^^ century.

The XX^th century.

Subscript

Subscript text is made using two commas:

Water is H,,2,,O.

Water is H₂O.

Headers

Headers start on a new line with two or more equal signs (up to six) followed the header text.

Optional equal signs can be put at the end of the line (to be compatible with Mediawiki syntax). They are ignored.

The content of the headers is parsed, allowing for instance to use subscript and superscript text. (The header content parsing is optional in Wikicreole.)

~== First level of header (h2 in HTML) ==
~=== Second level of header (h3 in HTML) ===
~==== Third level of header (h4 in HTML)

Links

Simple link

This is a [[link]].

This is a link.

Link with alternate text

This is a [[link|link with alternate text]].

This is a link with alternate text.

External link (URL)

[[http://www.wikicreole.org]]

http://www.wikicreole.org

Raw external link (URL)

http://www.wikicreole.org

http://www.wikicreole.org

External link with alternate text

[[http://www.wikicreole.org|Visit the Wikicreole website]]

Visit the Wikicreole website

Paragraphs

Paragraphs are made of text separated by a blank line.

Line breaks

A line break is made with two backslashes.

This is the first line,\\and this is the second.

This is the first line,
and this is the second.

Lists

Unordered lists

* Item 1
* Item 2
** Item 2.1
** Item 2.2
* Item 3

• Item 1

• Item 2

  • Item 2.1
  • Item 2.2
• Item 3

Ordered lists

# Item 1
# Item 2
## Item 2.1
## Item 2.2
# Item 3

1. Item 1

2. Item 2

   1. Item 2.1
   2. Item 2.2
3. Item 3

Horizontal rule

A horizontal rule is made with four hyphens (or more)

----

Images

A inline image is created with curly brackets. An alternate text can be put after a pipe. If there is none, an empty alternate text will be created.

{{myimage.png}}

{{myimage.png|this is my image}}

Tables

All cells are separated by single pipes. Leading spaces are permitted before the first cell of a row and trailing spaces are permitted at the end of a line. The ending pipe is optional. You can embed links, bold, italics, line breaks, and nowiki in table cells. Equal sign directly following pipe defines a header. Headers can be arranged horizontally or vertically.

|=Heading Col 1 |=Heading Col 2         |
|Cell 1.1       |Two lines\\in Cell 1.2 |
|Cell 2.1       |Cell 2.2               |

Nowiki

Between three opening curly brackets and three closing curly brackets, no wiki markup is interpreted.

//This// does **not** get [[formatted]]

Some examples of markup are: {{{** <i>this</i> ** }}}

Some examples of markup are: ** <i>this</i> **

Escape character

The escape character is the tilde.

It escapes the character immediately following it.

It disables the automatic conversion of the URL immediately following it.

It disables camel case in the word following it.

~http://www.foo.com/

http://www.foo.com/

~CamelCaseLink

CamelCaseLink

Plugins

Plugins use double angle brackets.

<<CurrentTime format="date">>

Synopsis

Emphasis: // for italics, ** for bold, **//...//** for both, ## for fixed width.
Lists: * for bullet lists, # for numbered lists; use multiple * or # for nested lists.
Headings: "==", "===", "====", etc. make headings.
Preformatted text: Enclose text in {{{...}}} or <pre></pre>.
Indented text: Indent the paragraph with whitespaces.
References: use double square brackets for a [[page link]] or URL [[http://cool.wiki.int/]].
References: use pipe | to name the links: [[page link|some text]] or [[http://cool.wiki.int/|some text]].
Preventing linking: Prefix with "~": ~DoNotHyperlink.
Misc: "\\" makes a linebreak, "----" makes a horizontal rule.
Allowed HTML tags: b big i small tt em strong s strike abbr acronym cite code dfn kbd samp var ^sup _sub
More: tables, images, table of contents, plugins

More explanations: Help:TextFormattingRules

Character Formatting

Emphasis

• Use a double slash (//) for emphasis (usually italics)
• Use a double asterisk (**) for strong emphasis (usually bold)
• Mix them at will: bold italics
• Emphasis can be used multiple times within a paragraph, but cannot cross paragraph boundaries:

// this

will not work//

Monospace

Monospace text is made using two hashes:

This sentence contains ##monospace text##.

This sentence contains monospace text.

Superscript

Superscript text is made using two carets:

The XX^^th^^ century.

The XX^th century.

Subscript

Subscript text is made using two commas:

Water is H,,2,,O.

Water is H₂O.

Fonts

There's no syntax for font tags.

Color Text

It is possible to write text in color.

%color=green% green text %% and back to normal

will give:
green text and back to normal

The easiest way to do it is to use the COLOR button in the Edit Toolbar. The text will be in green by default. You can then change the color.

Allowed colors are:

• an HTML color number (# followed by 3 or 6 digits),
• the following predefined color names:

Note: you can put the headers in color, but only if you do not have a table of content. For now, the table of content is incompatible with color headers.

Escape Character

The tilde '~' is the Escape Character:

• A single tilde '~' followed by nothing gets rendered as a single tilde. => ~
• Two tilde '~~' get rendered as a single tilde. => ~
• A single tilde before a link ('~http://foo.bar') prevents linking. => http://foo.bar
• Two tildes before a link ('~~http://foo.bar') produce a tilde followed by the hyperlinked URL. => ~http://foo.bar
• A tilde inside an URL gets removed, unless it's formatted inside square brackets.
• Two tildes inside an URL (without brackets) become a single tilde. => http://foo.bar/~user or http://foo.bar/~user

Special Characters

All special non-whitespace HTML characters are displayed as-is. Exceptions below.

Paragraphs

• Don't indent paragraphs
• Words wrap and fill as needed
• Use blank lines as separators
• Four or more minus signs make a horizontal rule
• "\\", "%%%" or "<br>" makes a linebreak (in headings and lists too)

Lists

Unordered lists

Recommended syntax (Wikicreole):

• asterisk for first level
• double asterisk for second level, etc.

Be sure to put a space after the asterisk.

You can also use indented asterisk for second level (indent at least two spaces).

Ordered lists

Recommended syntax (Wikicreole):

• # for first level
• double # for second level, etc.

Be sure to put a space after the hash sign.

You can also use indented # for second level (indent at least two spaces).

Definition lists

Term:
  definition

gives

Term

definition

Remark

Items may contain multiple paragraphs and other multi-lined content, just indent the items

Headings

Wikicreole syntax (recommended)

• '==' at the start of a line makes a large heading (h2)
• '===' at the start of a line makes a medium heading (h3)
• '====' at the start of a line makes a small heading (h4)
• '=====' at the start of a line makes a smaller heading (h5)
• '======' at the start of a line makes a tiny heading (h6)

Classic Phpwiki syntax

• '!!!' at the start of a line makes a large heading (h2)
• '!!' at the start of a line makes a medium heading (h3)
• '!' at the start of a line makes a small heading (h4)

Preformatted text

Place the preformatted text between three opening curly brackets and three closing curly brackets:

{{{
Preformatted text. ~WikiLinks do not work.
}}}

gives

Preformatted text. WikiLinks do not work.

If you want Wiki interaction, place preformatted lines inside <pre>:

<pre>
Preformatted text. WikiLinks still work.
</pre>

gives

Preformatted text. WikiLinks still work.

Indented Paragraphs

Two or more whitespaces signal indented text. Indents may be nested.

This is an indented block of text.

This block is even more indented.

E-mail style block-quoting is supported as well:

> This is block-quoted text.

renders as

This is block-quoted text.

References

• Hyperlinks to other pages within the Wiki are made by placing the page name in double square brackets: this is a page link. Single brackets or WikiWords will also work.
• Hyperlinks to external pages are done like this: http://www.wcsb.org/
• You can name the links by providing the hyperlink or pagename, a pipe (|) and then the name: PhpWiki home page, the front page
• You can suppress linking to URIs by preceding the word with a '~', e.g. NotLinkedAsWikiName, http://not.linked.to/
• Also, the old way of linking URL's is still supported: precede URLs with "http:", "ftp:" or "mailto:" to create links automatically as in: http://c2.com/
• URLs ending with .png, .gif, or .jpg are inlined if in square brackets, by themselves:
• You can create footnotes by using [1], [2], [3], ... like this here #[|ftnt

_ref_1]^[1]. See footnote for counterpart. (If the [ is in the first column, it is a footnote definition rather than a footnote

reference ^[1].)

• In-page hyperlinks are made by placing a named anchor and referring to the anchor in a hyperlink:

  • Named anchors:

    • #[[foo]]: An anchor around the text "foo" with id "foo".
    • #[[|foo]]: An empty anchor with id "foo".
    • #[[howdy|foo]]: An anchor around the text "howdy" with id "foo".
  • References to name anchors are made thusly:
    [[#hyperlinks]], [[OtherPage#foo]], [[OtherPage#foo|named]].
• Semantic links are named links like: is_a::WikiPage and attributes like size:-4000.
• A pagelink within square brackets starting with ":" is not backlinked.

Images

An inline image is created with curly brackets. An alternate text can be put after a pipe. If there is none, an empty alternate text will be created.

{{myimage.png}}
{{myimage.png|this is the alt text for my image}}
[[some link|{{myimage.png}}]] - if you click on the image, will goto "some link"
[[some link|{{myimage.png|alt text}}]] - same with alternative
[[http://example.com/|{{myimage.png}}]] - same as above: picture links to url
[[http://example.com/|{{myimage.png|alt text}}]] - same with alternative

Tables

Wikicreole tables

All cells are separated by single pipes. Leading spaces are permitted before the first cell of a row and trailing spaces are permitted at the end of a line. The ending pipe is optional.

You can embed links, bold, italics, line breaks, and nowiki in table cells.

Equal sign directly following pipe defines a header. Headers can be arranged horizontally or vertically.

|=Heading Col 1 |=Heading Col 2         |
|Cell 1.1       |Two lines\\in Cell 1.2 |
|Cell 2.1       |Cell 2.2               |

will give:

Mediawiki tables

See Help:MediawikiTablePlugin.

Definition list style tables

Definition list style tables are written just like definition lists, except that you replace the trailing colon on the term with a "pipe" (|).

Term 1 |
   Definition 1 begins here.
   Term 1.1 |
      Definition 1.1
   Term 1.2 |
      Definition 1.2
   This is part of definition 1.
Term 2 |
   Here's definition 2.

will give:

Old-style tables

See: Help:OldStyleTablePlugin

HTML Mark-Up Language

• Some in-line markup is allowed through the use of HTML tags: b, big, i, small, tt, em, strong, abbr, acronym, cite, code, dfn, kbd, samp, var, ^sup and _sub
• < and > are themselves
• The & characters will not work

Creating various kinds of special links

See Help:MagicPhpWikiURLs for gory details on how to write various kind of wiki maintenance and other special links.

Inserting plugins

Several plugins permit embedding additional functionality to Wiki pages. For example,

<<BackLinks page=HomePage info=hits>>

gives

11 pages link to HomePage:

Page Name	Hits
Help/EditMetaDataPlugin	19
Help/RandomPagePlugin	18
Help/PopUpPlugin	17
Help/TextFormattingRules	17
Help/UserRatingsPlugin	18
Help/RedirectToPlugin	18
Help/RichTablePlugin	33
Help/NewMarkupTestPage	212
Help/OldMarkupTestPage	189
Help/OldTextFormattingRules	225

For more information on plugins see Help:WikiPlugin, and PluginManager for a list of all plugins.

Full recursive ACL page permissions support (Solaris / Windows style)

Boolean permissions per page and action (granted or denied) based on the current users group membership is implemented with ACL's (Access Control Lists). Opposed to the simplier unix like ugo:rwx system.
The previous system was only based on action and current user, independent of pages.

A individual page permission may be inherited from its parent pages, and from an optional master page ("." or _dotpage').
Use predefined default permissions, if a "." page does not exist.
Pagenames starting with "." have tighter default permissions. (edit, change, list disallowed)

Order of Evaluation (denial overrides granted, or vice versa?)

The array of permissions is evaluated from top to bottom.
Access is granted if the next matching group membership returns true, denied if false.
If the group membership is false, the next group is tried.
If no group membership matches the upper permissions are tried recursively:

current page => basepage => "." page => default perms.

If no group-perm pair grants access, access is denied.

Consider the following perm:

     'change' => array(ACL_ADMIN => false,
                       ACL_OWNER => true));

=> "Members of ADMIN may not change, the owner may change."

For Authentication see WikiUser.php, WikiGroup.php and main.php

I suspect ACL page permissions to degrade performance by 10%

Enable/Disable it in config/config.ini

ENABLE_PAGEPERM = true

The defined (and extendable) main.php actions map to simplier access types:

       browse => view
       edit   => edit
       create => edit or create
       remove => remove
       rename => change
       store prefs => change
       list in PageList => list

For simplicity we also map the ACL to the posix-style owner, group and world groups and read, write, execute perms, in cygwin fashion.

Groups - definition of group membership

See WikiGroup how to enable and where to store user-specific group membership. Group methods: database, file, ldap, wikipage, none

To do: explain better.

The following special groups are always predefined, even if no other group methods are provided:

• _EVERY
• _ANONYMOUS
• _BOGOUSER
• _HASHOMEPAGE
• _SIGNED
• _AUTHENTICATED
• _ADMIN
• _OWNER
• _CREATOR

Those special groups are stored in a page acl as locale-independent string.

To do: See the available translations for these special groups.

Other group names are safed as defined by the group methods. (e.g. "Other Users")

Perms - mapping of actions to permissions

PhpWiki supports individual actions, the default is browse. To simplify ACL's these actions are mapped to some special permissions (vulgo 'perms').

We currently support the following permissions which can be stored in every page, for every group.

There are no plans to support additional custom perms. The API can handle that, but there's no UI, and it would be only specific for certain plugins, which check permissions by their own.

Action <=> Perm mapping

Those perms are mapped to those actions. Action Pages (plugins) check their access restrictions by themselves.

Default Permissions

        $perm = array('view'   => array(ACL_EVERY => true),
                      'edit'   => array(ACL_EVERY => true),
                      'create' => array(ACL_EVERY => true),
                      'list'   => array(ACL_EVERY => true),
                      'remove' => array(ACL_ADMIN => true,
                                        ACL_OWNER => true),
                      'change' => array(ACL_ADMIN => true,
                                        ACL_OWNER => true));
        if (ZIPDUMP_AUTH)
            $perm['dump'] = array(ACL_ADMIN => true,
                                  ACL_OWNER => true);
        else
            $perm['dump'] = array(ACL_EVERY => true);
        // view:
        if (!ALLOW_ANON_USER) {
            if (!ALLOW_USER_PASSWORDS)
                $perm['view'] = array(ACL_SIGNED => true);
            else
                $perm['view'] = array(ACL_AUTHENTICATED => true);
            $perm['view'][ACL_BOGOUSER] = ALLOW_BOGO_LOGIN ? true : false;
        }
        // edit:
        if (!ALLOW_ANON_EDIT) {
            if (!ALLOW_USER_PASSWORDS)
                $perm['edit'] = array(ACL_SIGNED => true);
            else
                $perm['edit'] = array(ACL_AUTHENTICATED => true);
            $perm['edit'][ACL_BOGOUSER] = ALLOW_BOGO_LOGIN ? true : false;
            $perm['create'] = $perm['edit'];
        }
        return $perm;

The PhpWiki SemanticWeb implementation follows closely the implementation of the semantic Mediawiki extension. It features:

• Annotation of article-article-links by means of configurable relations (link-types).
• Annotation of articles with simple data-values that are assigned to numeric attributes.
• Support for using physical units of measurement in all numerical attributes, without need for prior configuration.

Relations can be searched for with regular expressions, attributes can be searched for with full mathematical expressions.

The annotation data will be combined with annotations from the current category system to generate standard-compliant OWL/RDF output, which can be fully processed with tools that support OWL DL or OWL Lite, but which can also be treated in a meaningful way by software that supports RDF, RDFS or XML.

Relations

Relations (link-types) are defined as link with the following syntax:

  relation::pagename

Attributes

Attributes are defined as link to numbers (understandable by GNU Units) with the following markup syntax:

  attribute:=value

Attributes and relations refer only to the current page - the current page is the subject, the relation the predicate, the linked page the object in a RDF triple. Relations always refer to another page, attributes not.

Example

Sample taken from http://wiki.ontoworld.org/index.php/San_Diego

San Diego [[is_a::city]] located in the southwestern corner of
[[located_in::California|California]], the extreme southwestern corner
of the [[country::United States|United States]]. It is the county seat
of San Diego County. As of the 2000 census, the city had a total population of
[[population:=1,223,400|1,223,400]]; as of 2005, the California Department
of Finance estimated the city to have 1,305,736 residents. The city
is the second-largest in California and the seventh-largest in the
United States and is noted for its temperate climate and many beaches.

According to the United States Census Bureau, the city has a total
area of [[area:=963.6 km^2|963.6 km²]] (372.0 mi²). 840.0 km²
(324.3 mi²) of it is land and 123.5 km² (47.7 mi²) of it is water.
The total area is 12.82% water.

Most notably, San Diego is the location of the 2005 International
Symposium on Wikis 2005, and the San Diego Zoo, and the San Diego
Chargers.

<<SemanticRelations>>

See Also

• SemanticRelations, ListRelations, SemanticSearch
• SemanticRelationsPlugin, SemanticSearchPlugin

Phpwiki has extended the Wikicreole syntax of tables so that some simple spreadsheet-like calculations can be performed in tables.

Syntax

Five functions are available: SUM, AVERAGE, MAX, MIN and COUNT.

They operate on the current row (R) or column (C).

The function is placed in the cell surrounded by @@. Other wiki text can be placed in the cell, but there can be only one formula per cell.

Examples

Sum

|=Region          |=Telecom Sales  |=Power Sales |=Other       |=TOTAL      |
|=Europe          |            320 |          80 |         120 |@@=SUM(R)@@ |
|=Asia            |            580 |         723 |         564 |@@=SUM(R)@@ |
|=North America   |            235 |          60 |         109 |@@=SUM(R)@@ |
|=South America   |            120 |          35 |          82 |@@=SUM(R)@@ |
|=Antarctica      |              0 |           0 |          12 |@@=SUM(R)@@ |
|=TOTAL           |    @@=SUM(C)@@ | @@=SUM(C)@@ | @@=SUM(C)@@ |Grand total: @@=SUM(R)@@ |

Total of both colums and rows is calculated automatically by wiki.

Count and Sum

|=Bug                |=Priority   |=Subject             |=Status     |=Days to fix
| 1231               | Low        | File Open ...       | Open       | 3
| 1232               | High       | Memory Window ...   | Fixed      | 2
| 1233               | Medium     | Usability issue ... | Assigned   | 5
| 1234               | High       | No arrange ...      | Fixed      | 1
| Number of bugs: @@=COUNT(C)@@ | |                     |            | Total: @@=SUM(C)@@ days

Min, Max and Average

|=Location            |=Morning     |=Noon        |=Evening     |=Average temperature |
| Paris               | 7           | 13          | 10          | @@=AVERAGE(R)@@     |
| London              | 3           | 10          | 8           | @@=AVERAGE(R)@@     |
| Berlin              | 9           | 15          | 12          | @@=AVERAGE(R)@@     |
| Tokyo               | 12          | 20          | 16          | @@=AVERAGE(R)@@     |
| Maximum temperature | @@=MAX(C)@@ | @@=MAX(C)@@ | @@=MAX(C)@@ |                     |
| Minimum temperature | @@=MIN(C)@@ | @@=MIN(C)@@ | @@=MIN(C)@@ |                     |

Limitations

The formulas are evaluated line per line, from left to right.

So this will work:

|          10 |         -13 | @@=SUM(R)@@ |
|          15 |          17 | @@=SUM(R)@@ |
| @@=SUM(C)@@ | @@=SUM(C)@@ | @@=SUM(R)@@ |

And this will not:

| @@=SUM(R)@@ |          10 |         -13 |
| @@=SUM(R)@@ |          15 |          17 |
| @@=SUM(R)@@ | @@=SUM(C)@@ | @@=SUM(C)@@ |

Author

• Marc-Etienne Vargenau, Alcatel-Lucent

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

Note for limit

limit can be:

• a single integer, in that case it is the number of rows;
• or two integers separated by a comma, in that case it is the start index (starting at 0) and the number of rows.

Info arguments

Column 'info=' arguments:

Special, custom columns, either theme or plugin (WikiAdmin*) specific:

Symbolic 'info=' arguments:

If you contribute to Wikipedia or to other wikis that use the Mediawiki software, you will notice some differences in the wiki syntax of Mediawiki and the wiki syntax of Phpwiki.

Syntax differences

Here are some differences between Mediawiki and Phpwiki:

• Italics are // (but you can also use '' like in Wikipedia)
• Bold is ** (you cannot use ''' like in Wikipedia)
• Line break is \\ in Wikicreole, <br /> in Mediawiki
• There is no automatic capitalisation of first character of page name. Pages [[foo]] and [[Foo]] are different.
• A space in a page name in not equivalent to an underscore. Pages [[foo bar]] and [[foo_bar]] are different. We recommend to use a space in the page names.
• Many things that are built-in in Mediawiki use plugins in Phpwiki (table of contents, redirections, back links, etc.).
• Redirections are less sophisticated in Phpwiki (e.g. backlinks do not show redirected pages)

Tables

You can use the Mediawiki table syntax.

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 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 (376 total):

Author

• Reini Urban

See Also

• AllPages
• Help:ListPagesPlugin

The AllUsers plugin lists all once authenticated users.

Usage

<<AllUsers arguments>>

Arguments

All PageList arguments, plus the following ones:

Example

<<AllUsers limit=10>>

Authenticated users on this wiki (0 total):

No matches

Author

• Reini Urban

See Also

The AnalyseAccessLogSql plugin provides a framework to analyse the SQL access log and display the results. This information may be sensitive and therefore this plugin is limited to administrator access only.

A small number of queries that may (or might not) use the MySQL specific dialect of SQL are provided in lib/plugin/AnalyseAccessLogSql.php. For more information, please see the section Adding new queries below.

Usage

Experimental! Will change a lot.

<<AnalyseAccessLogSql mode=<QUERY NAME> >>

Parameters

Adding new queries

The file lib/plugin/AnalyseAccessLogSql.php contains a default set of queries against the SQL access log. Feel free to change this file to suit your own needs, but please note that this requires filesystem access to the web server where PhpWiki is running. In particular, this file may need to be modified to correctly query databases other than MySQL. The queries supplied by default are: “Referring URLs”, “Referring Domains”, “Remote Hosts”, “Users” and “Host Users”.

To add a new query, add a new section towards the end of the file, using one of the existing queries as a template. An example of an existing query is:

} elseif ($mode=="Users") {
    $query = "SELECT "
        ."remote_user AS User, "
        ."count(*) AS 'Access Count' "
        ."FROM $accesslog "
        .($whereConditions ? 'WHERE '.$whereConditions : '')
        ."GROUP BY User";

If you do add a query, please consider contributing it back to the PhpWiki project at http://sourceforge.net/projects/phpwiki

API for AnalyseAccessLogSql

• input arguments:

  • $mode contains the name of the query requested in the plugin parameters.
  • $accesslog contains the qualified name of the accesslog table, which may or may not be equal to “accesslog”.
  • $whereConditions contains the conditions (specific user, etc.) requested in the plugin parameters.

• output:

  • $query must contain the final SQL query to be executed.

• conventions:

  • While constructing the query string,

    • each clause is on a separate line and
    • each clause contains the required trailing punctuation or space.
  • The mode parameter is, by default, displayed as the caption in the final output, so please choose a user friendly name.
  • The column names displayed on the wiki page are generated from the SQL column names defined in the queries, so please choose user friendly names. MySQL allows column names to include spaces. If spaces are not allowed, then “_” is probably the next best choice.

• language hints for PHP newbies - please remember:

  • terminate statements with “;”,
  • assignment uses “=” and comparison uses “==”,
  • concatenate strings using the “.” operator,
  • the parentheses around the expression “($whereConditions ? 'WHERE '.$whereConditions : )=” are essential,
  • strings enclosed in single quotes may not contain substrings enclosed in single quotes (actually the truth is more complex but let's leave it like that here), and
  • strings enclosed in double quotes will evaluate and replace variable names so that, for example, "FROM $accesslog" might be evaluated to "FROM phpwiki_accesslog".

Authors

• Charles Corrigan
• Changes by Reini Urban

AppendText is a plugin to automatically add text to a page. For general usage better use the AddComment plugin.

<<AppendText arguments>>

Arguments

Examples

Add from a list of all available plugins one to the current page

<<WikiFormRich action=AppendText buttontext="AddPlugin"
               pulldown[] name=s text="Plugins: " value=<!plugin-list BackLinks page=CategoryWikiPlugin !>
>>

Add from a list of all available Categories to the current page

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

Usage

<<AsciiMath formula >>

Arguments

All arguments are passed to the ASCII Math PHP library and rendered as Math ML.

Example

<<AsciiMath sum_(i=1)^n i = (n(n+1))/2 >>

Author

• Reini Urban

See Also

• Help:AsciiSVGPlugin

The AsciiSVGPlugin plugin is an interface to http://www1.chapman.edu/~jipsen/svg/asciisvg.html

Syntax: http://www1.chapman.edu/~jipsen/svg/asciisvgcommands.html

The browser must support SVG in order graphs to be displayed. If you are using a recent browser (Firefox, Opera, Chrome, Safari) then you should see the examples.

Usage

<<AsciiSVG width= height= onmousemove="" script=""
         code...
>>

Arguments

All other arguments are passed to the ASCIISvg javascript library and rendered as SVG.

See http://www1.chapman.edu/~jipsen/svg/asciisvg.html

Example

<<AsciiSVG width="117" height="117"
  initPicture(-10,10)
  axes()
  stroke = "red"
  p = []
  with (Math)
    for (t = 0; t < 10.01; t += 0.05)
      p[p.length] = [t*cos(PI*t), t*sin(PI*t)]
  path(p)
>>

Known Problems

With multiple AsciiSVG plugins on the same page the second and subsequent ones will have the same width and height.

Author

• Reini Urban

See Also

• Help:AsciiMathPlugin
• Help:ChartPlugin

The AtomFeed plugin displays an external Atom feed.

Usage

<<AtomFeed url=http://example.com/feed.atom>>

Arguments

Example

Atom feed for PHP News

<<AtomFeed feed=PHPNews description="PHP News"
           url=https://www.php.net/feed.atom titleonly=true maxitem=5>>

Author

• Sébastien Le Callonnec

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 BackLinks plugin lists all pages which link to a given page.

The contents of all pages are searched to find links to the current page. The BackLinks function also answers the question: “Which pages contain the title of this page?”.

To display the list of pages which all contain multiple links use a pagelist as page argument. For example <<BackLinks page=Milk,Honey>> would display all pages which contain links to Milk AND Honey.

Usage

<<BackLinks arguments>>

Arguments

All PageList arguments, plus the following ones:

Example

<<BackLinks page=HomePage>>

11 pages link to HomePage:

• Help/OldTextFormattingRules
• Help/OldMarkupTestPage
• Help/NewMarkupTestPage
• Help/RichTablePlugin
• Help/RedirectToPlugin
• Help/UserRatingsPlugin
• Help/TextFormattingRules
• Help/PopUpPlugin
• Help/RandomPagePlugin
• Help/EditMetaDataPlugin

Known Problems

Back links might not work if the link is in text generated by a plugin. Prior to PhpWiki 1.6.2, back links did not work if the link was inside a table, or in an included template,

Author

• Reini Urban

See Also

The BlogArchives plugin lists monthly links for the current users blog if signed, or the ADMIN_USER's blog if not.

Usage

<<BlogArchives arguments>>

Arguments

Example

<<BlogArchives user="John Smith">>

Author

• Reini Urban

See Also

• Help:WikiBlogPlugin
• Help:BlogJournalPlugin

The BlogJournal plugin includes the latest blog entries for the current users blog if signed, or the ADMIN_USER's blog if not.

Usage

<<BlogJournal arguments>>

Arguments

Example

<<BlogJournal>>

No Blog Entries

Author

• Reini Urban

See Also

• Help:WikiBlogPlugin
• Help:BlogArchivesPlugin

The BoxRight plugin displays its content as a wiki-formatted right-floating div box with border.

Example

<<BoxRight
**This Wiki** ([[Help:WikiWikiWeb|What is a Wiki?]]) is a place where problems and
solutions are being documented.

See [[Help/HowToUseWiki|How to use this Wiki]] for instructions.

//Don't be afraid - it's easy and you can't break anything!//

Remark

If ENABLE_MARKUP_DIVSPAN is enabled then you can produce the same result with a simple <div>:

<div class=boxright>
**This Wiki** ([[Help:WikiWikiWeb|What is a Wiki?]]) is a place where problems and
solutions are being documented.

See [[Help/HowToUseWiki|How to use this Wiki]] for instructions.

//Don't be afraid - it's easy and you can't break anything!//
</div>

The CacheTest plugin allows to test image caching.

Usage

<<CacheTest arguments>>

Arguments

Example

<<CacheTest>>

Author

• Johannes Große

The CalendarList plugin is used in conjunction with the Calendar plugin. It was written for those who use a wiki as a personal information manager.

Just click any date in the calendar, edit the for that date, then come back to this page. The event should be listed below the calendar.

Usage

<<Calendar>>
<<CalendarList>>

Example

Click any date and edit it, then return to this page:

Arguments

Support ranges: next or last N days/events

Config Options

• PLUGIN_CALENDARLIST_ORDER = normal
• PLUGIN_CALENDARLIST_NEXT_N_DAYS = ''
• PLUGIN_CALENDARLIST_NEXT_N = ''
• PLUGIN_CALENDARLIST_LAST_N_DAYS = ''
• PLUGIN_CALENDARLIST_LAST_N = ''

Author

Derived from Calendar plugin by Martin Norbäck.

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 CategoryPage plugin puts boilerplate text on a category page to make it easily usable by novices.

It finds the file templates/categorypage.tmpl, then loads it with a few variables substituted.

This has only been used in wikilens.org.

Usage

<?plugin-form CategoryPage arguments ?>

Arguments

Example

<?plugin-form CategoryPage pagename=CategoryExample?>

Author

• Dan Frankowski

See Also

• TemplatePlugin
• CreatePagePlugin

The Chart plugin allows to easily draw simple graphs on a wiki page.

Three graph formats are possible: line, bar and pie. In pie mode, negative values are ignored.

The browser must support SVG in order graphs to be displayed. If you are using a recent browser (Firefox, Opera, Chrome, Safari) then you should see the examples.

Usage

<<Chart width=200 height=200 legend="My legend" type=line color=green data="5, 7, 11, 3, 15" >>

Arguments

Examples

Line chart

<<Chart type=line
        data="5, 7, 11, 3, 15"
        legend="Price evolution"
>>

Bar chart

<<Chart type=bar
        color=red
        data="5, 7, 11, 3, 15"
        legend="Number of users"
>>

Pie chart

<<Chart type=pie
        color=blue
        data="5, 7, 11, 3, 15"
        legend="Use per country"
>>

Known Problems

With multiple Chart plugins on the same page the 2nd and subsequent ones will have the same width and height.

Author

• Marc-Etienne Vargenau

See Also

• Help:AsciiSVGPlugin

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 CreatePage plugin allows to easily create new pages, optionally with default content.

This allows you to create a page getting the new pagename from a forms-based interface, and optionally with the initial content from some template.

Put a <?plugin-form CreatePage ?> at some page, browse this page, enter the name of the page to create, then click the button.

Usage

<?plugin-form CreatePage ?>
<?plugin-form CreatePage template=CategoryHomePages ?>
<?plugin-form CreatePage template=SomeTemplatePage vars="year=2004&name=None" ?>

Arguments

Variable Expansion

The content (either initial_content or template) might hold some variables, which will be expanded on creation. Unassigned variables will stay as %%<var>%%, assigned variables without matching %%<var>%% placeholder will be ignored, without any warning.

A variable in a template is denoted as %%var%%, which will be expanded by the value of var given to the vars argument (in urlencoded php notation).

Some special variables are automatically assigned:

This forms together with page templates and the Help:WikiFormRichPlugin and optionally the Help:SqlResultPlugin a framework to create templated pages.

Authors

• Dan Frankowski
• Reini Urban

Examples

<?plugin-form CreatePage s=MyHomePage ?>

See Also

• Help:WikiFormRichPlugin
• Help:SqlResultPlugin

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 CurrentTime plugin displays current time and date (when page was saved).

Usage

<<CurrentTime format=xxx>>

Arguments

Examples

<<CurrentTime>>

<<CurrentTime format=date>>

<<CurrentTime format=time>>

<<CurrentTime format='%d %h %Y %H h %M m %S s %Z'>>

Author

• Marc-Etienne Vargenau, Alcatel-Lucent

See Also

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

Administrative plugin, used to debug DATABASE backend problems and settings. This plugin is only for testing purposes.

Displays all/most database infos about a page.

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

Usage

<<DebugBackendInfo arguments>>

Arguments

Example

See DebugBackendInfo

Author

• Jeff Dairiki

See Also

• EditMetaData
• Help:EditMetaDataPlugin
• Help:DebugAuthInfoPlugin
• Help:DebugGroupInfoPlugin

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

<<DebugGroupInfo>>

Arguments

None.

Example

See DebugGroupInfo

Author

• Charles Corrigan

See Also

• DebugGroupInfo is the corresponding Help:ActionPage.
• Help:DebugAuthInfoPlugin
• Help:DebugBackendInfoPlugin

Show a markup retransformation of a wiki page.

Usage

<<DebugRetransform arguments>>

Arguments

Example

Retransform page “HomePage”

<div class="wikitext"><h3>Welcome to DevCorner @ cmeerw.org</h3>

Cached_PluginInvocation Object
(
    [_pi] => <?plugin IncludePage page="Projects" ?>
    [pi_name] => plugin
    [name] => IncludePage
    [args] => page="Projects"
)

<hr />
<ul><li>What is a 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => WikiWikiWeb
    [_basepage] => 
)

? A description of this application.</li>
<li>Learn 

Cached_InterwikiLink Object
(
    [_url] => 
    [_relation] => 
    [_link] => Help:HowToUseWiki
)

 and learn about 

Cached_InterwikiLink Object
(
    [_url] => 
    [_relation] => 
    [_link] => Help:AddingPages
)

.</li>
<li>Use the 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => SandBox
    [_basepage] => 
)

 page to experiment with Wiki pages.</li>
<li>Please sign your name in 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => RecentVisitors
    [_basepage] => 
)

.</li>
<li>See 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => RecentChanges
    [_basepage] => 
)

 for the latest page additions and changes.</li>
<li>Find out which pages are 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => MostPopular
    [_basepage] => 
)

.</li>
<li>Read the 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => ReleaseNotes
    [_basepage] => 
)

 and 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => RecentReleases
    [_basepage] => 
)

.</li>
<li>Administer this wiki via 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => PhpWikiAdministration
    [_basepage] => 
)

.</li>
<li>See more 

Cached_WikiLink Object
(
    [_url] => 
    [_relation] => 
    [_page] => PhpWikiDocumentation
    [_basepage] => 
)

.</li>
</ul>
</div>

Links

Array
(
    [linkto] => Projects
)

Array
(
    [linkto] => WikiWikiWeb
)

Array
(
    [linkto] => SandBox
)

Array
(
    [linkto] => RecentVisitors
)

Array
(
    [linkto] => RecentChanges
)

Array
(
    [linkto] => MostPopular
)

Array
(
    [linkto] => ReleaseNotes
)

Array
(
    [linkto] => RecentReleases
)

Array
(
    [linkto] => PhpWikiAdministration
)

Array
(
    [linkto] => PhpWikiDocumentation
)

Author

• Reini Urban

See Also

The Diff plugin displays differences between revisions of a wiki page.

Usage

<<Diff arguments>>

Arguments

Examples

<<Diff pagename=HomePage>>

Differences between current version and predecessor to the previous major change of HomePage.

Other diffs: Previous Revision, Previous Author

<<Diff pagename=HomePage version=4>>

Differences between version 4 and predecessor to the previous major change of HomePage.

Other diffs: Previous Revision, Previous Author

<<Diff pagename=HomePage version=4 previous=minor>>

Differences between version 4 and previous revision of HomePage.

Other diffs: Previous Major Revision, Previous Author

<<Diff pagename=HomePage previous=author>>

Differences between current version and revision by previous author of HomePage.

Other diffs: Previous Major Revision, Previous Revision

Author

• Reini Urban

See Also

The DynamicIncludePage plugin will asynchronously “include” other pages in this wiki.

Usage

<<DynamicIncludePage arguments>>

Arguments

All arguments from IncludePage plugin are supported, plus the following one.

Example

<<DynamicIncludePage page=SandBox>>

SandBox :

Author

• Reini Urban

See Also

• Help:IncludePagePlugin

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.

<<EditMetaData 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 FacebookLike plugin will include a Facebook “Like” button in your wiki page.

Usage

<<FacebookLike arguments>>

Arguments

Examples

Author

• Reini Urban

See Also

• http://developers.facebook.com/docs/reference/plugins/like

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

Typical Usage

<<FileInfo file=Upload:image.png display=size,date >>
<<FileInfo file=Upload:image.png display=name,size,date
                                 format="%s (size: %s, date: %s)" >>

Arguments

Example

This wiki was installed at <<FileInfo file=config/config.ini display=date>>.

This wiki was installed at Plugin FileInfo failed. File “config/config.ini” not found..

The FoafViewer plugin is written to facilitate the viewing of FOAF / RDF files in human readable form. Please note, it provides only basic features at this time.

Usage

<<FoafViewer foaf=http://www.myfoaf.com/foaf.rdf>>
/FoafViewerPlugin?foaf=http://www.myfoaf.com/foaf.rdf

Download

http://www.ahsonline.com.au/dod/FoafViewerPlugin.zip

Example

<<FoafViewer foaf=http://www.ahsonline.com.au/dod/FOAF.rdf>>

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/TranscludePlugin

| Boolean. If true, frame appears as normal content.

Help/WikiPollPlugin

| Boolean: if true, all questions must be answered

| Boolean: if true, an administrator can view and reset statistics (//not yet implemented//)

Help/WikiForumPlugin

| Boolean. If true, header should be omitted.

Help/WikiAdminRenamePlugin

| Boolean. If true, create a redirect page from the old to the new pagename.

| Boolean. If true, change pagename in all linked pages also. \\ //not yet implemented//

Help/WikiAdminSelectPlugin

| Boolean. If true, header should be omitted.

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

Help/WikiAdminSetExternalPlugin

| Boolean. If true, set the page to external.

Help/VideoPlugin

| Boolean. If true, auto play the video when page is displayed.

Help/TemplatePlugin

| Boolean. If true, when including a named section show the heading.

Help/ListSubpagesPlugin

| Boolean. If true, header should be omitted.

Help/WantedPagesPlugin

| Boolean. If true, display links.

| Boolean. If true, header should be omitted.

Help/UserRatingsPlugin

| Boolean. If true, header should be omitted.

| Boolean. If true, we're on a user's homepage, get **their** ratings

| Boolean.

Help/WhoIsOnlinePlugin

| Boolean. If true, in summary mode, add a link to the detail mode.

| Boolean. If true, also display the fact that admin is online.

Help/SemanticRelationsPlugin

| Boolean. If true, header should be omitted.

| Boolean. If true, do not display help.

Help/IncludePagePlugin

| Boolean. If true, inclusion appears as normal content.

| Boolean. If true, when including a named section show the heading.

Help/RecentReferrersPlugin

| Boolean. If true, header should be omitted.

Help/TitleSearchPlugin

| Boolean. If true and only one page is found, this page is displayed immediately

| Boolean. If true, header should be omitted.

| Boolean. If true, search with case exact.

Help/SemanticSearchAdvancedPlugin

| Boolean. If true, search with case exact.

| Boolean. If true, don't show form with results.

| Boolean. If true, header should be omitted.

Help/CreatePagePlugin

| Boolean. If true, overwrite an existing page.

Help/SiteMapPlugin

| Boolean. If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward'.

| Boolean. If true, then exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'.

| Boolean. If true, include yourself in the results.

| Boolean. If true, header should be omitted.

Help/SemanticSearchPlugin

| Boolean. If true, search with case exact.

| Boolean. If true, don't show form with results.

| Boolean. If true, header should be omitted.

Help/SearchHighlightPlugin

| Boolean. If true, header should be omitted.

| Boolean. If true, print the list of lines with lines terms additionally.

| Boolean. If true, highlight only case exact searches. Not yet supported.

Help/DebugBackendInfoPlugin

| Boolean. If true, only display information for the last version of the page.

Help/PopularNearbyPlugin

| Boolean. If true, header should be omitted.

Help/UnfoldSubpagesPlugin

| Boolean. If true, header should be omitted.

Help/PagePermissions

Boolean permissions per page and action (**granted** or **denied**) based on the current users

Help/PhotoAlbumPlugin

Boolean. If true, each image will be hyperlinked to a page where

Help/IncludeTreePlugin

| Boolean. If true, include yourself in the results.

| Boolean. If true, header should be omitted.

| Boolean. If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward'.

| Boolean. If true, then exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'.

Help/CreateTocPlugin

| Boolean. If true, provide a button to hide/display the Table of Contents.

| Boolean. If true, the Table of Contents should be initially hidden and on click expanded.

| Boolean. If true, the Table of Contents header should be omitted.

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

| Boolean. If true, hierarchical prefixes should be added.

Help/NewPagesPerUserPlugin

| Boolean. If true, pages that are comments are included (page names that include "/Comment").

| Boolean. If true, have a link to pages.

Help/LinkDatabasePlugin

| Boolean. If true, header should be omitted.

Help/OrphanedPagesPlugin

| Boolean. If true, header should be omitted.

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

Help/IncludeSiteMapPlugin

| Boolean. If true, include yourself in the results.

| Boolean. If true, header should be omitted.

Help/MostPopularPlugin

| Boolean. If true, header should be omitted.

Help/LinkSearchPlugin

| Boolean. If true, search with case exact.

| Boolean. If true, don't show form with results.

| Boolean. If true, header should be omitted.

Help/RandomPagePlugin

| Boolean. If true, do not display random page link, redirect to random page.

| Boolean. If true, hide name (only for numpages=1)

Help/AppendTextPlugin

| Boolean. If true, redirect to modified page.

Help/FullTextSearchPlugin

| Boolean. If true, highlight results.

| Boolean. If true, search with case exact.

| Boolean. If true, header should be omitted.

| Boolean. If true, be less verbose.

<<FullTextSearch s=boolean>>

Help/FileInfoPlugin

| Boolean. If true, print no error if file is not found.

ReleaseNotes

* Better check boolean arguments in plugins

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

Help/ExternalSearchPlugin

| Boolean. If true, don't really redirect to the external site, just print out the URL that would be redirected to.

Help/AllUsersPlugin

| Boolean. If true, header should be omitted.

| Boolean. If true, shows also users which stored their preferences, but never saved their homepage.

Help/RssFeedPlugin

| Boolean. If true, do not display item body.

Help/BackLinksPlugin

| Boolean. If true, include yourself in the results.

| Boolean. If true, header should be omitted.

Help/AtomFeedPlugin

| Boolean. If true, only displays the title of the entry.

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.

| Boolean. If true, display only pages created by users (not the ones created at initialisation of the wiki).

Help/AuthorHistoryPlugin

| Boolean. If true, page header should be omitted.

| Boolean. If true, include minor modifications.

| Boolean. If true, include deleted pages.

Help/AddCommentPlugin

| Boolean. If true, the comments and/or textbox should be initially hidden and on click expanded.

| Boolean. If true, the “Comments” header should be omitted.

Author

• Reini Urban

See Also

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

The FuzzyPages plugin will search for similar page titles.

Pages are considered similar by averaging the similarity scores of the spelling comparison and the metaphone comparison for each page title in the database (PHP's metaphone() is an improved soundex function).

• https://www.php.net/manual/en/function.similar-text.php
• https://www.php.net/manual/en/function.metaphone.php

Usage

<<FuzzyPages s=pagename>>

Arguments

Example

<<FuzzyPages s=HomePage>>

Author

• Reini Urban

See Also

• Help:LikePagesPlugin

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 GoogleMaps plugin displays a marker with further infos (when clicking) on given coordinates.

You need to sign up for a Google Maps API key!

http://www.google.com/apis/maps/signup.html

Then enter the key in config/config.ini under GOOGLE_LICENSE_KEY=

Usage

<<GoogleMaps arguments>>

Arguments

Example

<<GoogleMaps
          Latitude=53.053
          Longitude=7.803
          ZoomFactor=10
          Marker=true
          MapType=Hybrid
          width=500px
          height=400px
>>

Author

• 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.

<?php
/**
 * A simple demonstration WikiPlugin.
 *
 * Usage:
 * <<HelloWorld> >
 * <<HelloWorld
 *          salutation="Greetings, "
 *          name=Wikimeister
 * > >
 * <<HelloWorld salutation=Hi > >
 * <<HelloWorld name=WabiSabi > >
 */

// Constants are defined before the class.
if (!defined('THE_END'))
    define('THE_END', "!");

class WikiPlugin_HelloWorld
extends WikiPlugin
{
    // Five required functions in a WikiPlugin.

    function getName () {
        return _("HelloWorld");
    }

    function getDescription () {
        return _("Simple Sample Plugin");
    }

    // Establish default values for each of this plugin's arguments.
    function getDefaultArguments() {
        return array('salutation' => "Hello,",
                     'name'       => "World");
    }

    function run($dbi, $argstr, $request) {
        extract($this->getArgs($argstr, $request));

        // Any text that is returned will not be further transformed,
        // so use html where necessary.
        $html = HTML::samp(fmt('%s: %s', $salutation, WikiLink($name, 'auto')),
                         THE_END);
        return $html;
    }
};

The HtmlConverter plugin will convert HTML tags as far to Wiki markup as possible and eliminate all other HTML markup, so the output can be copied and pasted into a wiki page.

Usage

<<HtmlConverter>>

Arguments

None.

Example

<<HtmlConverter>>

Authors

• Hendrik Scheider
• Reini Urban

See Also

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