Subroutine Name

RegCommand

Explanation and Usage

This will register a command, which will be called via the 'do' parameter (do=action).

Syntax

RegCommand(Name, Subroutine, Display)

Options

Name - This is the name to associate with the action.

Subroutine - This should be the subroutine that is called when the action you specify is called via the 'do' parameter. Must be entered in this format: \&SubroutineName

Display - Beginning with Aneuch 0.40, the display variable was added. This is what will show up in the visitor log for the command you are defining. There are a couple of things you can put in here:

  • %s: This will get replaced by the name of the page
  • %d: This will get replaced by the page revision

Examples

These are actual examples from the Aneuch source code:

RegCommand('admin', \&DoAdmin, 'was in Administrative mode, doing %s');
This will register the command 'admin', and specify that the subroutine DoAdmin should be called. This would take place by the user calling "?do=admin". It will show up in the visitor log as "was in Administrative mode, doing <admin page name>".

RegCommand('revision', \&DoRevision, 'was viewing revision %d of page %s');
This will register the command 'revision', and specify that the subroutine DoRevision should be called. It will show up in the visitor log (as an example) as "was viewing revision 10 of page HomePage".

← Return to API listing