xref: /dokuwiki/inc/parser/renderer.php (revision 559fe45bec851f141d2599db3bf5ea23a2b0509d)
1<?php
2/**
3 * Renderer for XHTML output
4 *
5 * @author Harry Fuecks <hfuecks@gmail.com>
6 * @author Andreas Gohr <andi@splitbrain.org>
7 */
8if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
9
10require_once DOKU_INC . 'inc/parser/renderer.php';
11require_once DOKU_INC . 'inc/pluginutils.php';
12
13class Doku_Renderer {
14    var $info = array(
15        'cache' => TRUE, // may the rendered result cached?
16        'toc'   => TRUE, // render the TOC?
17    );
18
19
20    function nocache() {
21        $this->info['cache'] = FALSE;
22    }
23
24    function notoc() {
25        $this->info['toc'] = FALSE;
26    }
27
28    //handle plugin rendering
29    function plugin($name,$data){
30        $plugin =& plugin_load('syntax',$name);
31        if($plugin != null){
32            // determine mode from renderer class name - format = "Doku_Renderer_<mode>"
33            $mode = substr(get_class($this), 14);
34            $plugin->render($mode,$this,$data);
35        }
36    }
37
38    function document_start() {}
39
40    function document_end() {}
41
42    function toc_open() {}
43
44    function tocbranch_open($level) {}
45
46    function tocitem_open($level, $empty = FALSE) {}
47
48    function tocelement($level, $title) {}
49
50    function tocitem_close($level) {}
51
52    function tocbranch_close($level) {}
53
54    function toc_close() {}
55
56    function header($text, $level, $pos) {}
57
58    function section_open($level) {}
59
60    function section_close() {}
61
62    function cdata($text) {}
63
64    function p_open() {}
65
66    function p_close() {}
67
68    function linebreak() {}
69
70    function hr() {}
71
72    function strong_open() {}
73
74    function strong_close() {}
75
76    function emphasis_open() {}
77
78    function emphasis_close() {}
79
80    function underline_open() {}
81
82    function underline_close() {}
83
84    function monospace_open() {}
85
86    function monospace_close() {}
87
88    function subscript_open() {}
89
90    function subscript_close() {}
91
92    function superscript_open() {}
93
94    function superscript_close() {}
95
96    function deleted_open() {}
97
98    function deleted_close() {}
99
100    function footnote_open() {}
101
102    function footnote_close() {}
103
104    function listu_open() {}
105
106    function listu_close() {}
107
108    function listo_open() {}
109
110    function listo_close() {}
111
112    function listitem_open($level) {}
113
114    function listitem_close() {}
115
116    function listcontent_open() {}
117
118    function listcontent_close() {}
119
120    function unformatted($text) {}
121
122    function php($text) {}
123
124    function html($text) {}
125
126    function preformatted($text) {}
127
128    function file($text) {}
129
130    function quote_open() {}
131
132    function quote_close() {}
133
134    function code($text, $lang = NULL) {}
135
136    function acronym($acronym) {}
137
138    function smiley($smiley) {}
139
140    function wordblock($word) {}
141
142    function entity($entity) {}
143
144    // 640x480 ($x=640, $y=480)
145    function multiplyentity($x, $y) {}
146
147    function singlequoteopening() {}
148
149    function singlequoteclosing() {}
150
151    function doublequoteopening() {}
152
153    function doublequoteclosing() {}
154
155    // $link like 'SomePage'
156    function camelcaselink($link) {}
157
158    // $link like 'wiki:syntax', $title could be an array (media)
159    function internallink($link, $title = NULL) {}
160
161    // $link is full URL with scheme, $title could be an array (media)
162    function externallink($link, $title = NULL) {}
163
164    // $link is the original link - probably not much use
165    // $wikiName is an indentifier for the wiki
166    // $wikiUri is the URL fragment to append to some known URL
167    function interwikilink($link, $title = NULL, $wikiName, $wikiUri) {}
168
169    // Link to file on users OS, $title could be an array (media)
170    function filelink($link, $title = NULL) {}
171
172    // Link to a Windows share, , $title could be an array (media)
173    function windowssharelink($link, $title = NULL) {}
174
175//  function email($address, $title = NULL) {}
176    function emaillink($address, $name = NULL) {}
177
178    function internalmedialink (
179        $src,$title=NULL,$align=NULL,$width=NULL,$height=NULL,$cache=NULL
180        ) {}
181
182    function externalmedialink(
183        $src,$title=NULL,$align=NULL,$width=NULL,$height=NULL,$cache=NULL
184        ) {}
185
186    function table_open($maxcols = NULL, $numrows = NULL){}
187
188    function table_close(){}
189
190    function tablerow_open(){}
191
192    function tablerow_close(){}
193
194    function tableheader_open($colspan = 1, $align = NULL){}
195
196    function tableheader_close(){}
197
198    function tablecell_open($colspan = 1, $align = NULL){}
199
200    function tablecell_close(){}
201
202}
203
204
205//Setup VIM: ex: et ts=4 enc=utf-8 :
206