171ec1101SGina Haeussge<?php 271ec1101SGina Haeussge/** 371ec1101SGina Haeussge * Include plugin (permalink header component) 471ec1101SGina Haeussge * 571ec1101SGina Haeussge * Provides a header instruction which renders a permalink to the included page 671ec1101SGina Haeussge * 771ec1101SGina Haeussge * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 871ec1101SGina Haeussge * @author Gina Haeussge <osd@foosel.net> 971ec1101SGina Haeussge * @author Michael Klier <chi@chimeric.de> 1071ec1101SGina Haeussge */ 1171ec1101SGina Haeussge 1271ec1101SGina Haeussgeif (!defined('DOKU_INC')) 1371ec1101SGina Haeussge define('DOKU_INC', realpath(dirname(__FILE__) . '/../../') . '/'); 1471ec1101SGina Haeussgeif (!defined('DOKU_PLUGIN')) 1571ec1101SGina Haeussge define('DOKU_PLUGIN', DOKU_INC . 'lib/plugins/'); 1671ec1101SGina Haeussgerequire_once (DOKU_PLUGIN . 'syntax.php'); 1771ec1101SGina Haeussge 1871ec1101SGina Haeussgeclass syntax_plugin_include_header extends DokuWiki_Syntax_Plugin { 1971ec1101SGina Haeussge 2071ec1101SGina Haeussge function getInfo() { 2171ec1101SGina Haeussge return array ( 2271ec1101SGina Haeussge 'author' => 'Gina Häußge, Michael Klier', 2371ec1101SGina Haeussge 'email' => 'dokuwiki@chimeric.de', 2471ec1101SGina Haeussge 'date' => '2008-06-28', 2571ec1101SGina Haeussge 'name' => 'Include Plugin (permalink header component)', 2671ec1101SGina Haeussge 'desc' => 'Provides a header instruction which renders a permalink to the included page', 2771ec1101SGina Haeussge 'url' => 'http://wiki.splitbrain.org/plugin:include', 2871ec1101SGina Haeussge ); 2971ec1101SGina Haeussge } 3071ec1101SGina Haeussge 3171ec1101SGina Haeussge function getType() { 3271ec1101SGina Haeussge return 'formatting'; 3371ec1101SGina Haeussge } 3471ec1101SGina Haeussge 3571ec1101SGina Haeussge function getSort() { 3671ec1101SGina Haeussge return 50; 3771ec1101SGina Haeussge } 3871ec1101SGina Haeussge 3971ec1101SGina Haeussge function handle($match, $state, $pos, &$handler) { 4071ec1101SGina Haeussge // this is a syntax plugin that doesn't offer any syntax, so there's nothing to handle by the parser 4171ec1101SGina Haeussge } 4271ec1101SGina Haeussge 4371ec1101SGina Haeussge /** 4471ec1101SGina Haeussge * Renders a permalink header. 4571ec1101SGina Haeussge * 4671ec1101SGina Haeussge * Code heavily copied from the header renderer from inc/parser/xhtml.php, just 4771ec1101SGina Haeussge * added an href parameter to the anchor tag linking to the wikilink. 4871ec1101SGina Haeussge */ 4971ec1101SGina Haeussge function render($mode, &$renderer, $indata) { 5071ec1101SGina Haeussge global $ID; 5171ec1101SGina Haeussge list($text, $level, $pos) = $indata; 5271ec1101SGina Haeussge 5371ec1101SGina Haeussge if ($mode == 'xhtml') { 5471ec1101SGina Haeussge $hid = $renderer->_headerToLink($text,true); 5571ec1101SGina Haeussge 5671ec1101SGina Haeussge //only add items within configured levels 5771ec1101SGina Haeussge $renderer->toc_additem($hid, $text, $level); 5871ec1101SGina Haeussge 5971ec1101SGina Haeussge // write the header 6071ec1101SGina Haeussge $renderer->doc .= DOKU_LF.'<h'.$level.'><a name="'.$hid.'" id="'.$hid.'" href="'.wl($ID).'">'; 6171ec1101SGina Haeussge $renderer->doc .= $renderer->_xmlEntities($text); 6271ec1101SGina Haeussge $renderer->doc .= "</a></h$level>".DOKU_LF; 6371ec1101SGina Haeussge 6471ec1101SGina Haeussge return true; 6571ec1101SGina Haeussge } 6671ec1101SGina Haeussge 6771ec1101SGina Haeussge // unsupported $mode 6871ec1101SGina Haeussge return false; 6971ec1101SGina Haeussge } 7071ec1101SGina Haeussge} 7171ec1101SGina Haeussge 72*58f4883aSMichael Klier// vim:ts=4:sw=4:et:enc=utf-8: 73