Revision [14980]
This is an old revision of HandlerInfo made by NilsLindenberg on 2006-07-29 09:10:38.
Wikka Handlers
This page needs to be updated to match Wikka 1.1.6.2
What is a Handler
Wikka handlers provide functionality that generally acts on an entire page or affects the wiki as a whole in some way. You could say that handlers "handle" something for the user, such as PageDeletionInfo deleting a page, modifying ACLInfo Access Control Lists (ACLs), or PageHistoryInfo showing page history.
Using handlers vs. using actions
ActionInfo Wikka actions affect a part of a wikka page, they are meant to generate content within the page. Actions are usually UsingActions inserted into a page along with all of the other markup. When the page is viewed/rendered, the action is "executed" and its output is displayed.
Wikka handlers, on the other hand, are not inserted in the page body, but are invoked when you submit a form or click on a menu link like "Page History". They can be manually invoked by appending to the URL of a page the name of the handler preceded by a slash. For example, to switch from the formatted view to the edit view of this page, just append to the URL displayed in your browser address field /edit.
List of available handlers (as of version 1.1.6.0)
page handlers
- acls - Handles the ACLInfo Access Control List (ACL) functionality. You can access ACL settings by clicking the "Edit ACLs" link at the bottom of a page. The link is only visible if:
- You are the page owner and you are logged in.
- You are logged in as the admin user for the Wikka Wiki. The link doesn't appear if the page is owned by "nobody". Click the "Take ownership" link at the bottom of the screen to take ownership of the page before trying to modify the Access Control List.
- addcomment - Handles some of the tasks associated with adding a new comment: e.g. managing comment related access control, posting new comments, displaying comment related error messages.
- backlinks - Displays a list of internal pages linking to the current page.
- claim - Handles tasks associated with PageOwnership page ownership: e.g. determining access to the "take ownership" command, assigning page ownership, displaying confirmation/error messages.
- clone - Clone the current page and save a copy of it as a new page.
- delcomment - Handles tasks associated to the deletion of comments from the MySQL database: e.g. determining if a user is allowed to delete a specific comment.
- delete - Handles tasks related to the PageDeletionInfo deletion of pages: e.g. displaying the form that prompts the user for information about the deletion, displaying confirmation and error messages, determining if a user is allowed to delete a specific page.
- delete_referrer - Handle tasks related to the removal of ReferrersInfo referrers.
- diff - Determines and displays the differences between two revisions of a page, shows additions and deletions.
- edit - Handles tasks associated with EditPageInfo editing a page: displaying the edit form, validating input, showing page preview, checking to see if a user is allowed to edit a page, displaying confirmation and error messages, handling the storage of pages in the MySQL database.
- grabcode - Download a code block as a file.
- history - Shows the PageHistoryInfo history of additions and deletions associated with each version of a page
- raw - Displays the ShowCodeInfo source code of a Wikka page as plain text.
- referrers - Displays a list of sites linking to a page (also known as ReferrersInfo referrers).
- referrers_sites - Displays a list of domains containing links to a page.
- review_blacklist - Displays a list of domains that have been removed from the ReferrersInfo referrer list.
- revisions - Handles task associated with page revisions. Shows all of the versions for a page and allows you to see the differences between any two versions of a page.
- show - Handles tasks related to displaying pages and comments. Checks user access to pages. Allows users to create new pages.
- showcode - Displays the ShowCodeInfo source code of a Wikka page
XML handlers
- files.xml - Handles file downloads and file deletion.
- mindmap.mm - shows an embedded mindmap as an xml - document
- recentchanges.xml - Displays the XML feed of global recent changes on a WikkaWiki
- recentchanges.xml.mm
- recentchanges_simple.xml.mm
- revisions.xml - Displays the XML feed of revisions of a page
CategoryDocumentation