1<?php 2/** 3 * DokuWiki plugin PageTitle Shorter; Syntax component 4 * Macro to set the short title of the page in metadata 5 * 6 * @license GPL 2 (http://www.gnu.org/licenses/gpl.html) 7 * @author Satoshi Sahara <sahara.satoshi@gmail.com> 8 */ 9 10if (!defined('DOKU_INC')) die(); 11 12class syntax_plugin_pagetitle_shorter extends DokuWiki_Syntax_Plugin 13{ 14 public function getType() 15 { // Syntax Type 16 return 'substition'; 17 } 18 19 public function getPType() 20 { // Paragraph Type 21 return 'normal'; 22 } 23 24 /** 25 * Connect pattern to lexer, implement Doku_Parser_Mode_Interface 26 */ 27 protected $mode, $pattern; 28 29 public function getSort() 30 { 31 // sort number used to determine priority of this mode 32 return 990; 33 } 34 35 public function preConnect() 36 { 37 // syntax mode, drop 'syntax_' from class name 38 $this->mode = substr(get_class($this), 7); 39 40 //syntax patterns 41 $this->pattern[5] = '~~ShortTitle:[^\n~]*~~'; 42 } 43 44 public function connectTo($mode) 45 { 46 $this->Lexer->addSpecialPattern($this->pattern[5], $mode, $this->mode); 47 } 48 49 /** 50 * Handle the match 51 */ 52 public function handle($match, $state, $pos, Doku_Handler $handler) 53 { 54 global $ID; 55 static $counter = []; 56 57 // ensure first matched pattern only effective 58 if ($counter[$ID]++ > 0) return false; 59 60 // get short title 61 $short_title = trim(substr($match, 13, -2)); 62 return $data = [$state, $short_title, $ID]; 63 } 64 65 /** 66 * Create output 67 */ 68 public function render($format, Doku_Renderer $renderer, $data) 69 { 70 global $ID; 71 72 list($state, $short_title, $id) = $data; 73 74 // skip calls that belong to different pages (eg. title of included page) 75 if (strcmp($id, $ID) !== 0) return false; 76 77 switch ($format) { 78 case 'metadata': 79 $renderer->meta['shorttitle'] = $short_title; 80 return true; 81 default: 82 return false; 83 } 84 } 85 86} 87