DokuWiki

It's better when it's simple

User Tools

Site Tools


Sidebar

Translations of this page?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

Our Privacy Policy

devel:action_modes

This is an old revision of the document!


Action Modes aka. do Modes

List of possible action modes (may be incomplete yet) with their descriptions. These actions are usually caused by supplying an according ?do= parameter to the doku.php dispatcher. The knowledge of the current mode may be useful for making templates more dynamic or write action plugins. The current can be accessed via the global $ACT variable.

In act_dispatch() many default actions are processed and in tpl_content_core() actions create their output.

The description at this page should reflect the state of the last released version of DokuWiki. Changes between versions (very rare) can be inspected by comparing the code of releases at https://github.com/splitbrain/dokuwiki/releases.

Page actions

editing process

  • show: The default action, whenever no special mode is defined this one will be used. It just causes to render the current page.
  • edit: Loads the current page into the editor instead of rendering it
  • preview: Same as above but also previews the edited page below the editor
  • save: Used to save the current page - after saving a redirect using the show mode is sent. You should never see this mode in your template
  • denied: Internal mode. Used to load the access denied message
  • locked: Internal mode. Used to show the page locked message
  • cancel: Cancel conflicting edit, replaced by 'show'
  • recover: Recovers a draft
  • draft: Shows the draft dialog
  • draftdel: Deletes the draft, replaced by 'show'
  • conflict: Report conflicting save

other functions

  • backlink: Shows a list of pages that link to the current page.
  • revisions: Shows changes and editors of the current page.
  • diff: Generates a diff view for easy comparison between 2 revisions
  • subscribe: Add the current user to the mailing list of changes on the current site.
  • unsubscribe: The opposite of above.
  • media: launches the media manager

Site actions

main functions

  • index: Shows a generated index of the pages and namespaces
  • recent: Displays recent changed pages and allows diffs
  • search: Search functionality

different views

  • export_raw: Export as wiki markup
  • export_xhtml: Export as XHTML
  • export_xhtmlbody: Export XHTML-body only
  • check: Dumps some information about the users permissions and the DokuWiki setup.
  • register: Register new user
  • login: Login user
  • logout: Logout user
  • profile: Show/Change users profile
  • resendpwd: Mail users password to given email address
  • admin: displays the admin menu with all installed Admin Plugins, available to a logged in superuser or manager.

FIXME link to development documentation (missing information here are e.g. in which version the action mode is availble (should be availble in dev docs)) — krichter 2014/03/19 16:34

The description at this page should reflect the state of the last released version of DokuWiki.
Do you mean by 'version' which release of DokuWiki, or something different?
Klap-in 2014/03/19 18:10
OK, I added your sentence above - hope you don't mind. My FIXME suggestion above was refering to a matrix with version range and action to provide information about older versions, too. My background problem is that I need URLs to control an older version of dokuwiki where I don't have admin rights and I'm having some troubles, so I need to know if the actions are available or not before I can start debugging. If this page ought to refer to current version only, maybe it's worth starting another page? I hope discussing here is ok?
krichter 2014/03/19 16:34
The two methods mentioned above, act_dispatch() and tpl_content_core(), describe the most actions which dokuwiki can handle (plugins can add actions as well). In general these actions doesn't change much (however some of that kind of details can matter for you of course).
At https://github.com/splitbrain/dokuwiki/releases you can browse for you release and inspect the code and compare it with the current branch…
Discussion is fine at this place, but when we finish its conclusions should be applied to this page afterward(and than the discussion can be clean up).
Can you tell me for which action(s) you are looking for? and in which version?
Klap-in 2014/03/26 11:18
Well, I'm looking for the version action in order to find out which version the wiki is using… (initially I wanted to exclude the fact that the version is not available in the old version). At http://xref.dokuwiki.org/reference/dokuwiki/nav.html?_functions/act_dispatch.html I don't find any documentation — krichter 2014/03/19 16:34
At that xref page you can click throught to line 11 in its source. In the source you can read the handled actions.
I think there is not used the action version before.
When you look for the version number of your current DokuWiki, you need to go to the admin of your wiki. [wikiurl.org]?do=admin At the right side of the “Administration” section, the version number is displayed.
Or visit as admin-user the page [wikiurl.org]?do=check at the top the version number is given.
Klap-in 2014/03/26 18:40
Ah, thanks! I guess I'm very used to @since annotation in javadoc (and I think it's in doxygen, too). I don't have admin rights to the dokuwiki I was trying to get to know the version (meanwhile I'm having trouble with a 303 error and contacted the admin. He or she is going to me the version soon, so I'm just trying to improve this wiki page by now).
devel/action_modes.1423661844.txt.gz · Last modified: 2015-02-11 14:37 by 140.105.48.10