xref: /plugin/include/syntax/include.php (revision 75668fa90184ea2394730e9a5f5e6f72a797e94a)
1<?php
2/**
3 * Include Plugin: displays a wiki page within another
4 * Usage:
5 * {{page>page}} for "page" in same namespace
6 * {{page>:page}} for "page" in top namespace
7 * {{page>namespace:page}} for "page" in namespace "namespace"
8 * {{page>.namespace:page}} for "page" in subnamespace "namespace"
9 * {{page>page#section}} for a section of "page"
10 *
11 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
12 * @author     Esther Brunner <wikidesign@gmail.com>
13 * @author     Christopher Smith <chris@jalakai.co.uk>
14 * @author     Gina Häußge, Michael Klier <dokuwiki@chimeric.de>
15 */
16
17if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
18if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
19require_once(DOKU_PLUGIN.'syntax.php');
20
21/**
22 * All DokuWiki plugins to extend the parser/rendering mechanism
23 * need to inherit from this class
24 */
25class syntax_plugin_include_include extends DokuWiki_Syntax_Plugin {
26
27    var $helper = null;
28
29    function getType() { return 'substition'; }
30    function getSort() { return 303; }
31    function getPType() { return 'block'; }
32
33    function connectTo($mode) {
34        $this->Lexer->addSpecialPattern("{{page>.+?}}", $mode, 'plugin_include_include');
35        $this->Lexer->addSpecialPattern("{{section>.+?}}", $mode, 'plugin_include_include');
36        $this->Lexer->addSpecialPattern("{{namespace>.+?}}", $mode, 'plugin_include_include');
37        $this->Lexer->addSpecialPattern("{{tagtopic>.+?}}", $mode, 'plugin_include_include');
38    }
39
40    function handle($match, $state, $pos, &$handler) {
41
42        $match = substr($match, 2, -2); // strip markup
43        list($match, $flags) = explode('&', $match, 2);
44
45        // break the pattern up into its parts
46        list($mode, $page, $sect) = preg_split('/>|#/u', $match, 3);
47        return array($mode, $page, cleanID($sect), explode('&', $flags));
48    }
49
50    function render($format, &$renderer, $data) {
51        return false;
52    }
53}
54// vim:ts=4:sw=4:et:enc=utf-8:
55