plugin info added

Each plugin now needs to return some infos about it self. This
allows to display a list of installed plugins using the info
plugin.

darcs-hash:20050626151617-9977f-0be6e15b32c35b23967e509b0057a00226df150c.gz

1 files changed, 16 insertions, 0 deletions

diff --git a/lib/plugins/syntax.php b/lib/plugins/syntax.php
index 2a67a5ca5..bf03fdf2c 100644
--- a/lib/plugins/syntax.php
+++ b/lib/plugins/syntax.php
@@ -17,6 +17,22 @@ require_once(DOKU_INC.'inc/parser/parser.php');
 class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode {
 
     /**
+     * General Info
+     *
+     * Needs to return a associative array with the following values:
+     *
+     * author - Author of the plugin
+     * email  - Email address to contact the author
+     * date   - Last modified date of the plugin in YYYY-MM-DD format
+     * name   - Name of the plugin
+     * desc   - Short description of the plugin (Text only)
+     * url    - Website with more information on the plugin (eg. syntax description)
+     */
+    function getInfo(){
+        trigger_error('getType() not implemented in '.get_class($this), E_USER_WARNING);
+    }
+
+    /**
      * Syntax Type
      *
      * Needs to return one of the mode types defined in $PARSER_MODES in parser.php