xref: /plugin/clearfloat/syntax.php (revision 7127f6dd7e764876adb1c975b8b7017ca99651a8)

<?php
/**
 * DokuWiki Syntax Plugin Clearfloat
 *
 * Clears the floating of elements such as images.
 *
 * Syntax:  ~~CLEARFLOAT~~ or ~~CL~~
 *
 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author  Michael Klier <chi@chimeric.de>
 * @author  i-net /// software GmbH <tools@inetsoftware.de>
 */

if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_PLUGIN.'syntax.php');
if(!defined('DW_LF')) define('DW_LF',"\n");

/**
 * All DokuWiki plugins to extend the parser/rendering mechanism
 * need to inherit from this class
 */
class syntax_plugin_clearfloat extends DokuWiki_Syntax_Plugin {

    /**
     * Syntax Type
     *
     * Needs to return one of the mode types defined in $PARSER_MODES in parser.php
     */
    function getType()  { return 'substition'; }
    function getPType() { return 'block'; }
    function getSort()  { return 308; }

    /**
     * Connect pattern to lexer
     */
    function connectTo($mode) {
        $this->Lexer->addSpecialPattern('~~CLEARFLOAT~~',$mode,'plugin_clearfloat');
        $this->Lexer->addSpecialPattern('~~CL~~',$mode,'plugin_clearfloat');
    }

    /**
     * Handler to prepare matched data for the rendering process
     */
    function handle($match, $state, $pos, Doku_Handler $handler){
        return array();
    }

    /**
     * Handles the actual output creation.
     */
    function render($mode, Doku_Renderer $renderer, $data) {
        if($mode == 'xhtml'){
            $renderer->doc .= '<div class="clearer"></div>' . DW_LF;
            return true;
        }
        return false;
    }

}
// vim:ts=4:sw=4:et:enc=utf-8: