*
* The title text can contain wiki formatting markups such as bold,
* itlic, subscript and superscript, but title metadata remains simple
* plain text without any markup.
* example
* wiki source:
H2O
* page (html): H2O
* title metadata: H2O
*/
if (!defined('DOKU_INC')) die();
class syntax_plugin_pagetitle_decorative extends DokuWiki_Syntax_Plugin
{
public function getType()
{ // Syntax Type
return 'baseonly';
}
public function getPType()
{ // Paragraph Type
return 'block';
}
public function getAllowedTypes()
{ // Allowed Mode Types
return ['formatting', 'substition', 'disabled'];
}
/**
* Connect pattern to lexer, implement Doku_Parser_Mode_Interface
*/
protected $mode, $pattern;
public function getSort()
{
// sort number used to determine priority of this mode
return 49;
}
public function preConnect()
{
// syntax mode, drop 'syntax_' from class name
$this->mode = substr(get_class($this), 7);
// syntax patterns
$this->pattern[1] = ']*>(?=.*?)'; // entry
$this->pattern[4] = ''; // exit
$this->pattern[5] = '~~Title:[^\n~]*~~'; // special
}
public function connectTo($mode)
{
$this->Lexer->addSpecialPattern($this->pattern[5], $mode, $this->mode);
$this->Lexer->addEntryPattern($this->pattern[1], $mode, $this->mode);
}
public function postConnect()
{
$this->Lexer->addExitPattern($this->pattern[4], $this->mode);
}
/**
* Handle the match
*/
public function handle($match, $state, $pos, Doku_Handler $handler)
{
global $ID;
static $params; // store title tag parameters
switch ($state) {
case DOKU_LEXER_SPECIAL : // ~~Title:*~~ macro syntax
$title = trim(substr($match, 8, -2));
return $data = [$state, $ID, $title];
case DOKU_LEXER_ENTER :
// store title tag parameters
$params = strtolower(trim(substr($match, 6, -1)));
return $data = [$state, $ID, ''];
case DOKU_LEXER_UNMATCHED :
$handler->base($match, $state, $pos);
return false;
case DOKU_LEXER_EXIT :
// hand over title tag parameters to render stage
return $data = [$state, $ID, $params];
}
return false;
}
/**
* Create output
*/
public function render($format, Doku_Renderer $renderer, $data)
{
global $ID;
static $doc, $capture; // store properties of $renderer
static $counter = [];
list ($state, $id, $param) = $data;
switch ($state) {
case DOKU_LEXER_SPECIAL : // ~~Title:*~~ macro syntax
// $decorative_title = $param;
// convert to curly quote characters depending on $conf['typography']
$decorative_title = $this->render_text($param);
break;
case DOKU_LEXER_ENTER :
// preserve variables
$doc = $renderer->doc;
$capture = $renderer->capture;
// set doc blank prior to store "UNMATHCED" content
$renderer->doc = '';
// metadata renderer should always parse "UNMATCHED" content
$renderer->capture = ($format == 'metadata') ? true : $capture;
return true;
break;
case DOKU_LEXER_EXIT :
// retrieve "UNMATCHED" content
$decorative_title = trim($renderer->doc);
// restore variables
$renderer->doc = $doc;
$renderer->capture = ($format == 'metadata') ? true : $capture;
break; // do not return here
default:
return false; // this should never happen
}
// follow up only for DOKU_LEXER_EXIT
// skip calls that belong to different pages (eg. title of included page)
if (strcmp($id, $ID) !== 0) return false;
// ensure first instruction only effective
if ($counter[$format]++ > 0) return false;
// get plain title
$title = trim(htmlspecialchars_decode(strip_tags($decorative_title), ENT_QUOTES));
if (empty($title)) return false;
// output title
switch ($format) {
case 'metadata':
// set metadata for metadata indexer
$renderer->meta['plugin']['pagetitle']['title'] = $ID;
if ($this->getConf('usePersistent')) {
// metadata persistence
$renderer->persistent['title'] = $title;
$renderer->meta['title'] = $title;
} else {
// erase persistent title metadata if defined
unset($renderer->persistent['title']);
$renderer->meta['title'] = $title;
}
return true;
case 'xhtml':
if ($state == DOKU_LEXER_SPECIAL) return false;
if (($wrap = $this->loadHelper('wrap')) != NULL) {
$attr = $wrap->buildAttributes($param, 'pagetitle');
} else {
$attr = ' class="pagetitle"';
}
// even title in , it never shown up in the table of contents (TOC)
$renderer->doc .= '';
$renderer->doc .= $decorative_title;
$renderer->doc .= '
'.DOKU_LF;
return true;
case 'text':
$renderer->doc .= $title . DOKU_LF;
return true;
}
return false;
}
}