Class: Text_Wiki_Render_Docbook_Heading

Source Location: /Text_Wiki-1.2.4/Text/Wiki/Render/Docbook/Heading.php

Class Overview

Text_Wiki_Render
   |
   --Text_Wiki_Render_Docbook_Heading

This class renders headings in DocBook.

Author(s):

bertrand Gugger <bertrand at toggg.com>

Version:

Release: @package_version@

Inherited Variables

Class: Text_Wiki_Render

Text_Wiki_Render::$format
Text_Wiki_Render::$rule
Text_Wiki_Render::$wiki

Inherited Methods

Class: Text_Wiki_Render

Text_Wiki_Render::__construct(): Constructor for this render format or rule.
Text_Wiki_Render::Text_Wiki_Render(): Constructor for this render format or rule.
Text_Wiki_Render::formatConf(): Simple method to wrap a configuration in an sprintf() format.
Text_Wiki_Render::getConf(): Simple method to safely get configuration key values.
Text_Wiki_Render::textEncode(): Default method to render text (htmlspecialchars)
Text_Wiki_Render::urlEncode(): Default method to render url

Class Details

[line 26]
This class renders headings in DocBook.

Author: bertrand Gugger <bertrand@toggg.com>
Version: Release: @package_version@
Link: http://pear.php.net/package/Text_Wiki_Docbook
License: LGPL License 2.1

[ Top ]

Class Variables

$conf = array(
'sections' => array('sect1', 'sect2', 'sect3', 'sect4', 'sect5'),'section_after'=>'section','section_final'=>'simplesect')

[line 39]

Configuration keys for this rule

'sections' => array of strings, ordered list of sectioning tags, the first (mandatory) one will apply to the whole doc empty string '' means no section for this level 'section_after' => string, the section optionnaly used for next, non terminal levels 'section_end' => string, the section optionnaly used for the terminal level

Var: 'config-key' => mixed config-value
Access: public

Type:	array
Overrides:	Array

[ Top ]

Method Detail

Text_Wiki_Render_Docbook_Heading (Constructor) [line 162]

The Text_Wiki_Render_Docbook_Heading(
object
&$obj)

Constructor.

We override the constructor to pre-process the heading tokens

to correct levels as sequential
mark the terminal ones
prepare the actual sections to be used

Return: render object
Access: public

Parameters:

object &$obj — the base conversion handler

[ Top ]

__construct (Constructor) [line 88]

The __construct(
object
&$obj)

Constructor.

We override the constructor to pre-process the heading tokens

to correct levels as sequential
mark the terminal ones
prepare the actual sections to be used

Return: render object
Access: public

Overrides Text_Wiki_Render::__construct() (Constructor for this render format or rule.)

Parameters:

object &$obj — the base conversion handler

[ Top ]

token [line 175]

string token(

$options, array
$option)

Replace start heading tokens with closure of preceding sections and opening corresponding section if not blank or the last level -1 one

Return: the replacement text
Access: public

Parameters:

array	`$option`	—	the token options
	`$options`	—

[ Top ]

Class: Text_Wiki_Render_Docbook_Heading

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: Text_Wiki_Render

Inherited Methods

Class: Text_Wiki_Render

Class Details

Class Variables

$conf = array( 'sections' => array('sect1', 'sect2', 'sect3', 'sect4', 'sect5'),'section_after'=>'section','section_final'=>'simplesect')

Method Detail

Text_Wiki_Render_Docbook_Heading (Constructor) [line 162]

Parameters:

__construct (Constructor) [line 88]

Parameters:

token [line 175]

Parameters:

$conf = array(
'sections' => array('sect1', 'sect2', 'sect3', 'sect4', 'sect5'),'section_after'=>'section','section_final'=>'simplesect')