SourceForge.net Logo
May 7, 2006
© GPL
 
ProWikiCenter
Wiki Commands
 
Difference (previous author) (Change, Edit, normal page display)

Changed: 1,217c1
A large number of wiki functions are available by passing commands and parameters to the wiki software. Typically a user need not see or understand them, because their are hidden behind handy links of the user interface.

Sometimes it is useful to know about these commands, because they can be written into pages or sidebars, thus enhancing ease of use. But they can also be directly entered into the BrowserCommandLine, if that makes sense.

Reasons to type in Commands directly:
* the command is not available from the user interface
* it's quicker to type in the command than to use it from some link far away
* special parameters are needed that deviate from the default




[[Inhaltsverzeichnis]]




== action=access ==

This function is deprecated. Use action=login instead.

== action=admin ==

User administration:
* add a new user to your wiki, give him a status (like "Admin" or "Author") and a quota for his upload directory.
* change status and/or quota of existing users
* delete users

== action=browse ==

Thats pretty much the same as just giving a page name. The pagename must be given using the parameter [[green]id].

* ThisWiki:action=browse&id=TestPage

The only advantage is, that you can now add more parameters.

Use the parameter [[green]diff] to add the difference display with respect to the last change:

* ThisWiki:action=browse&id=TestPage&diff=1 (last change)
* ThisWiki:action=browse&id=TestPage&diff=2 (last edit)
* ThisWiki:action=browse&id=TestPage&diff=3 (previous author)
* ThisWiki:action=browse&id=TestPage&diff=4 (diff type from user preferences)

Use the parameter [[green]lang] to override the user interface language:

* ThisWiki:action=browse&id=TestPage&lang=0 (English)
* ThisWiki:action=browse&id=TestPage&lang=1 (German)
* ThisWiki:action=browse&id=TestPage&lang=2 (French, under construction)

Note: there is a shorthand command (avoiding action + id):

* ThisWiki:browse=TestPage


== action=FrontPage ==

This command links to the default page of a wiki. Typically this together with InterWikiLinks, especially when you are not sure about the exact name of the default page you are linking to.

* FractalWiki:action=FrontPage
* FractalWiki:action=FrontPage&lang=2 (French)

Note: the older form "action=HomePage" is still supported but deprecated.

== action=index ==

This command shows the complete list of wiki pages.

* ThisWiki:action=index

== action=log ==

This command produces a session log:

* FractalWiki:action=log

You may use a number of parameters to modify the information produced:

* days (default=1) enlarges the time span of the session analysis
* sum=1 (default=0) produces sums for various data measured
* admins=1 (default=0) includes administrator session
* robots=1 (default=0) includes robot (search engine) sessions

Combined:

* FractalWiki:action=log&admins=1&robots=1&sum=1

The information about who is an administrator is taken from the wiki configuration file. Robots can be identified in any configuration file. There is a global configuration file that identifies most of them, so that this needn't be done for each wiki separately. This is the same information that is used in action=stat&detail=1 to produce the colored access types.

== action=login ==

Offers the standard login form.

* ThisWiki:action=login

The Login data is held as long as the browser is open (in a temporary cookie).

This form is also opened automatically when any user attempts an command which is beyond his current user rights.

Note: the browser must have cookies enabled to remember a successful login.

== action=members ==

This command shows the compete list of member pages.

* ThisWiki:action=members

Note: this function can be configured to support any category (or folder).

== action=projects ==

This command shows the compete list of project pages.

* ThisWiki:action=projects

Note: this function can be configured to support any category (or folder).

== action=random ==

This command shows a page that is selected by using a pseudo random number generator.

* ThisWiki:action=random

Note: It may be useful for someone in the HostRole to look at his wiki this way. It gives him a feeling for the average quality of his wiki and typically lots of ideas of how to improve the system.

== action=rc ==

This command is identical to opening the RecentChanges page.

* ThisWiki:action=rc
* ThisWiki:action=rc

Parameter [[green]edits] (show edits=small corrections):

* ThisWiki:action=rc&edits=1 (shows both changes and edits)
* ThisWiki:action=rc&edits=2 (shows only edits)

Parameter [[green]days]: (show RecentChanges N days back)

* ThisWiki:action=rc&days=90 (shows 90 days of changes, if available)

Note: RecentChanges are built from rc logfiles. The entries are typically not kept for a long time. If there are no special arrangements made (e. g. for long term statistics) their are deleted after about 4-6 months.

== action=rcg ==

Works like action=rc, but for the group of wikis that is defined in action=userdata.

== action=referer ==

This command gives an statistical account of the HTTP_REFERER information that is part of the communication between wiki software and browser.

* FractalWiki:action=referer

Parameter [[green]days] (default=30 days):

* FractalWiki:action=referer&days=60

== action=set ==

The set commmand serves to display and change the wiki configuration file. This function is typically only allowed for the administrator (you may login as FractalUser / context88):

* FractalWiki:action=set

* FractalWiki:action=set&var=FlagFolders&val=0 (turn off folders in the link bar)

* FractalWiki:action=FrontPage (check it)

* FractalWiki:action=set&var=FlagFolders&val=1 (turn on folders in the link bar)

* FractalWiki:action=FrontPage (check it)

Note: A wiki may be fully administrated from any browser in the world without the need for a working FTP or TELNET / SSH access (remember that the template file and logos may be maintained with the upload directory).

== action=stat ==

This command shows access statistics (in bars and numbers) for the wiki (gray background=weekends):

* FractalWiki:action=stat

Parameter [[green]detail] (shows green=admins pink=robots blue=usernames red=anonymous):

* FractalWiki:action=stat&detail=1

Parameter [[green]days] (default=21 days):

* FractalWiki:action=stat&detail=1&days=60

== action=statg ==

Works like stat, but for the group of wikis defined in action=userdata.

There are also an additional detail options:

* FractalWiki:action=statg&detail=2 (different colors for different wikis)
* FractalWiki:action=statg&detail=3 (combines detail=1 and detail=2)

== action=unlock ==

This command unlocks the page database.

This is an administrator functions that is only needed when a serious error occurs during the updating of a page, which may leave the wiki database in a locked state.

The symptom is that edit operation does not return but run into a timeout after about 20-30 seconds. If this is reproducible, ask an administrator to do an action=unlock.

== action=upload ==

Opens the upload form. Any registered user has his own private upload directory. The upload form show the content of the upload directory and allows to upload or delete files.

* FractalWiki:action=upload

Note: when a user is registered in more than one wiki, his upload quotas add up.

== action=userdata ==

The userdata command allows to maintain user specific data, e. g. to set up e-mail notification and wiki group functions (like action=rcg, action=statg and action=logg) for groups of wikis.

* FractalWiki:action=userdata



FolderWikiFeatures FolderActions
See Commands

See Commands