paragraphtypes for syntax plugins

darcs-hash:20050626111513-9977f-5b317b14c9544a0c0a637d21816542d394e6606f.gz

1 files changed, 18 insertions, 0 deletions

diff --git a/lib/plugins/syntax.php b/lib/plugins/syntax.php
index 303c0de33..2a67a5ca5 100644
--- a/lib/plugins/syntax.php
+++ b/lib/plugins/syntax.php
@@ -17,6 +17,8 @@ require_once(DOKU_INC.'inc/parser/parser.php');
 class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode {
 
     /**
+     * Syntax Type
+     *
      * Needs to return one of the mode types defined in $PARSER_MODES in parser.php
      */
     function getType(){
@@ -24,6 +26,22 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode {
     }
 
     /**
+     * Paragraph Type
+     *
+     * Defines how this syntax is handled regarding paragraphs. This is important
+     * for correct XHTML nesting. Should return one of the following:
+     *
+     * 'normal' - The plugin can be used inside paragraphs
+     * 'block'  - Open paragraphs need to be closed before plugin output
+     * 'stack'  - Special case. Plugin wraps other paragraphs.
+     *
+     * @see Doku_Handler_Block
+     */
+    function getPType(){
+        return 'normal';
+    }
+
+    /**
      * Handler to prepare matched data for the rendering process
      *
      * Usually you should only need the $match param.