xref: /plugin/include/syntax/include.php (revision a0a6f8fbfe8cde5548e622b42849a274c8708beb)
171ec1101SGina Haeussge<?php
271ec1101SGina Haeussge/**
371ec1101SGina Haeussge * Include Plugin: displays a wiki page within another
471ec1101SGina Haeussge * Usage:
571ec1101SGina Haeussge * {{page>page}} for "page" in same namespace
671ec1101SGina Haeussge * {{page>:page}} for "page" in top namespace
771ec1101SGina Haeussge * {{page>namespace:page}} for "page" in namespace "namespace"
871ec1101SGina Haeussge * {{page>.namespace:page}} for "page" in subnamespace "namespace"
971ec1101SGina Haeussge * {{page>page#section}} for a section of "page"
1071ec1101SGina Haeussge *
1171ec1101SGina Haeussge * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
1271ec1101SGina Haeussge * @author     Esther Brunner <wikidesign@gmail.com>
1371ec1101SGina Haeussge * @author     Christopher Smith <chris@jalakai.co.uk>
1471ec1101SGina Haeussge * @author     Gina Häußge, Michael Klier <dokuwiki@chimeric.de>
1571ec1101SGina Haeussge */
1671ec1101SGina Haeussge
1771ec1101SGina Haeussgeif(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
1871ec1101SGina Haeussgeif(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
1971ec1101SGina Haeussgerequire_once(DOKU_PLUGIN.'syntax.php');
2071ec1101SGina Haeussge
2171ec1101SGina Haeussge/**
2271ec1101SGina Haeussge * All DokuWiki plugins to extend the parser/rendering mechanism
2371ec1101SGina Haeussge * need to inherit from this class
2471ec1101SGina Haeussge */
2571ec1101SGina Haeussgeclass syntax_plugin_include_include extends DokuWiki_Syntax_Plugin {
2671ec1101SGina Haeussge
2761053b04SMichael Klier    var $helper = null;
2861053b04SMichael Klier
2971ec1101SGina Haeussge    function getType() { return 'substition'; }
3071ec1101SGina Haeussge    function getSort() { return 303; }
3171ec1101SGina Haeussge    function getPType() { return 'block'; }
3271ec1101SGina Haeussge
3371ec1101SGina Haeussge    function connectTo($mode) {
3471ec1101SGina Haeussge        $this->Lexer->addSpecialPattern("{{page>.+?}}", $mode, 'plugin_include_include');
3571ec1101SGina Haeussge        $this->Lexer->addSpecialPattern("{{section>.+?}}", $mode, 'plugin_include_include');
368b99501bSMichael Klier        $this->Lexer->addSpecialPattern("{{namespace>.+?}}", $mode, 'plugin_include_include');
37*a0a6f8fbSMichael Klier        $this->Lexer->addSpecialPattern("{{tagtopic>.+?}}", $mode, 'plugin_include_include');
3871ec1101SGina Haeussge    }
3971ec1101SGina Haeussge
4071ec1101SGina Haeussge    function handle($match, $state, $pos, &$handler) {
4171ec1101SGina Haeussge
4271ec1101SGina Haeussge        $match = substr($match, 2, -2); // strip markup
4371ec1101SGina Haeussge        list($match, $flags) = explode('&', $match, 2);
4471ec1101SGina Haeussge
4561053b04SMichael Klier        // break the pattern up into its parts
466f0ad9d7SMichael Klier        list($mode, $page, $sect) = preg_split('/>|#/u', $match, 3);
476f0ad9d7SMichael Klier        return array($mode, $page, cleanID($sect), explode('&', $flags));
4871ec1101SGina Haeussge    }
4971ec1101SGina Haeussge
5071ec1101SGina Haeussge    function render($format, &$renderer, $data) {
5161053b04SMichael Klier        return false;
5261053b04SMichael Klier    }
5371ec1101SGina Haeussge}
5471ec1101SGina Haeussge// vim:ts=4:sw=4:et:enc=utf-8:
55