1preservedocbooktags = false
2
3;; used to highlight the {@source} inline tag, @filesource tag, and @example tag
4[highlightSourceTokens]
5;; format:
6;; T_CONSTANTNAME = open
7;; /T_CONSTANTNAME = close
8T_ABSTRACT = <font color="blue">
9/T_ABSTRACT = </font>
10T_CLONE = <font color="blue">
11/T_CLONE = </font>
12T_HALT_COMPILER = <font color="red">
13/T_HALT_COMPILER = </font>
14T_PUBLIC = <font color="blue">
15/T_PUBLIC = </font>
16T_PRIVATE = <font color="blue">
17/T_PRIVATE = </font>
18T_PROTECTED = <font color="blue">
19/T_PROTECTED = </font>
20T_FINAL = <font color="blue">
21/T_FINAL = </font>
22T_IMPLEMENTS = <font color="blue">
23/T_IMPLEMENTS = </font>
24T_CLASS = <font color="blue">
25/T_CLASS = </font>
26T_INTERFACE = <font color="blue">
27/T_INTERFACE = </font>
28T_INCLUDE = <font color="blue">
29/T_INCLUDE = </font>
30T_INCLUDE_ONCE = <font color="blue">
31/T_INCLUDE_ONCE = </font>
32T_REQUIRE_ONCE = <font color="blue">
33/T_REQUIRE_ONCE = </font>
34T_FUNCTION = <font color="blue">
35/T_FUNCTION = </font>
36T_VARIABLE = <strong>
37/T_VARIABLE = </strong>
38T_CONSTANT_ENCAPSED_STRING = <font color="#66cccc">
39/T_CONSTANT_ENCAPSED_STRING = </font>
40T_COMMENT = <font color="green">
41/T_COMMENT = </font>
42T_OBJECT_OPERATOR = <strong>
43/T_OBJECT_OPERATOR = </strong>
44T_RETURN = <font color="blue">
45/T_RETURN = </font>
46T_STATIC = <font color="blue">
47/T_STATIC = </font>
48T_SWITCH = <font color="blue">
49/T_SWITCH = </font>
50T_IF = <font color="blue">
51/T_IF = </font>
52T_FOREACH = <font color="blue">
53/T_FOREACH = </font>
54T_FOR = <font color="blue">
55/T_FOR = </font>
56T_VAR = <font color="blue">
57/T_VAR = </font>
58T_EXTENDS = <font color="blue">
59/T_EXTENDS = </font>
60T_RETURN = <font color="blue">
61/T_RETURN = </font>
62T_GLOBAL = <font color="blue">
63/T_GLOBAL = </font>
64T_DOUBLE_COLON = <strong>
65/T_DOUBLE_COLON = </strong>
66T_OBJECT_OPERATOR = <strong>
67/T_OBJECT_OPERATOR = </strong>
68T_OPEN_TAG = <strong>
69/T_OPEN_TAG = </strong>
70T_CLOSE_TAG = <strong>
71/T_CLOSE_TAG = </strong>
72
73[highlightSource]
74;; this is for highlighting things that aren't tokens like "&"
75;; format:
76;; word = open
77;; /word = close
78@ = <strong>
79/@ = </strong>
80& = <strong>
81/& = </strong>
82[ = <strong>
83/[ = </strong>
84] = <strong>
85/] = </strong>
86! = <strong>
87/! = </strong>
88";" = <strong>
89/; = </strong>
90( = <strong>
91/( = </strong>
92) = <strong>
93/) = </strong>
94, = <strong>
95/, = </strong>
96{ = <strong>
97/{ = </strong>
98} = <strong>
99/} = </strong>
100""" = <font color="#66cccc">
101/" = </font>
102
103[highlightDocBlockSourceTokens]
104;; this is for docblock tokens, using by phpDocumentor_HighlightParser
105;; tagphptype is for "string" in @param string description, for example
106docblock = <font color="#009999">
107/docblock = </font>
108tagphptype = <em>
109/tagphptype = </em>
110tagvarname = <strong>
111/tagvarname = </strong>
112coretag = <strong><font color = "#0099FF">
113/coretag = </font></strong>
114tag = <strong><font color="#009999">
115/tag = </font></strong>
116inlinetag = <em><font color="#0099FF">
117/inlinetag = </font></em>
118internal = <em><font color = "#6699cc">
119/internal = </font></em>
120closetemplate = <strong><font color="blue">
121/closetemplate = </font></strong>
122docblocktemplate = <font color="blue">
123/docblocktemplate = </font color="blue">
124
125[highlightTutorialSourceTokens]
126;; this is for XML DocBook-based tutorials, highlighted by phpDocumentor_TutorialHighlightParser
127;; <tag>
128opentag = <span class="tute-tag">
129/opentag = </span>
130;; </tag>
131closetag = <span class="tute-tag">
132/closetag = </span>
133;; <tag attribute="value">
134attribute = <span class="tute-attribute-name">
135/attribute = </span>
136;; <tag attribute="value">
137attributevalue = <span class="tute-attribute-value">
138/attributevalue = </span>
139;; &entity;
140entity = <span class="tute-entity">
141/entity = </span>
142;; <!-- comment -->
143comment = <span class="tute-comment">
144/comment = </span>
145;; {@inline tag}
146itag = <span class="tute-inline-tag">
147/itag = </span>
148
149;; used for translation of html in DocBlocks
150[desctranslate]
151ul = <ul>
152/ul = </ul>
153ol = <ol>
154/ol = </ol>
155li = <li>
156/li = </li>
157code =
158/code =
159var = <var>
160/var = </var>
161samp = <samp>
162/samp = </samp>
163kbd = <kbd>
164/kbd = </kbd>
165pre = <pre>
166/pre = </pre>
167p = <p>
168/p = </p>
169b = <strong>
170/b = </strong>
171i = <em>
172/i = </em>
173br = <br />
174
175[ppage]
176;; this is the DocBook package page translation section.  All DocBook tags
177;; that have a corresponding html tag must be listed here
178;;
179;; examples:
180;; 1)
181;; tagname = newtagname
182;;
183;; This is the simplest case, where all attributes will be added into the
184;; starting tag and the ending tag will be html/xml style </tranlatedtagname>
185;; <tagname></tagname> becomes <newtagname></newtagname> and
186;; <tagname attr="value"></tagname> becomes
187;; <newtagname attr="value"></newtagname>
188;;
189;; 2)
190;; tagname = newtagname
191;; tagname->attr = newattrname
192;;
193;; in this case, everything will be like the first case, except tags like:
194;; <tagname attr="value"></tagname> will become
195;; <newtagname newattrname="value"></newtagname>
196;;
197;; 3)
198;; tagname = newtagname
199;; tagname->attr = newattrname
200;; tagname->attr+value = newvalue
201;;
202;; in this case, the value is also translated to another.  This can be useful
203;; for instances such as focus="middle" changing to align="center" or something
204;; of that nature.
205;; <tagname attr="value"></tagname> will become
206;; <newtagname newattrname="newvalue"></newtagname>
207;;
208;; 4)
209;; tagname = newtagname
210;; tagname->attr1 = newattrname
211;; tagname->attr2 = newattrname
212;; tagname->attr1+value|attr2+value = newvalue
213;;
214;; in this case, two attributes combine to make one new attribute, and the combined
215;; value is translated into a new value
216;; <tagname attr1="value1" attr2="value2"></tagname> will become
217;; <newtagname newattrname="newvalue"></newtagname>
218;;
219;; 5)
220;; tagname = newtagname
221;; tagname!attr = dummy
222;;
223;; here, the attribute will be ignored.  dummy is not used and may be any value
224;; <tagname attr="value"></tagname> will become
225;; <newtagname></newtagname>
226;;
227;; 6)
228;; tagname = newtagname
229;; tagname! = dummy
230;;
231;; here, all attributes will be ignored.  dummy is not used and may be any value
232;; <tagname attr1="value" attr2="foo"></tagname> will become
233;; <newtagname></newtagname>
234;;
235;; 7)
236;; tagname = newtagname
237;; tagname/ = 1
238;;
239;; here, the tag will be translated as a single tag with no closing tag, and all
240;; attributes
241;; <tagname attr="val">{text text}</tagname> will become
242;; <newtagname attr="val" />
243;;
244;; 8)
245;; tagname = <starttaginfo />
246;; /tagname = closetagtext
247;;
248;; in this case, the text <starttaginfo> will be inserted exactly as entered for
249;; <tagname> and closetagtext for </tagname>
250;; <tagname attr="val"></tagname> will become
251;; <starttaginfo />closetagtext
252;;
253;; 9)
254;; $attr$my_attribute = newattrname
255;;
256;; tagname = newtagname
257;;
258;; in this case, all occurences of my_attribute in any tag will be changed to
259;; newattrname.  This is useful for changing things like role="php" to
260;; class="php," for example.  Note that the text "$attr$" MUST be on the line
261;; start for phpDocumentor to recognize it.
262;;
263;; 10)
264;; &entity; = translation text
265;; &quot; = &quot;
266;; &quot; = """
267;; &lt; = <
268;;
269;; Use this to control translation of entities to their appropriate values
270
271&nbsp; = &nbsp;
272&quot; = &quot;
273&rdquo; = &rdquo;
274&ldquo; = &ldquo;
275&amp; = &amp;
276&lt; = &lt;
277&gt; = &gt;
278&copy; = &copy;
279
280$attr$role = class
281
282abbrev = abbr
283
284blockquote = blockquote
285
286arg = span
287arg->choice = class
288
289author = <font size="-1"><strong>by <em>
290/author = </em></strong></font>
291author! = 0
292
293authorblurb = blockquote
294
295authorgroup = <strong>Authors:</strong><br />
296/authorgroup =
297authorgroup! = 0
298
299caution = <table border="1"><th align="center">Caution</th><tr><td>
300/caution = </td></tr></table>
301caution! = 0
302
303command = <b class="cmd">
304/command = </b>
305
306cmdsynopsis = <div id="cmdsynopsis">
307/cmdsynopsis = </div>
308
309copyright = <em>
310/copyright = </em><br />
311
312emphasis = strong
313
314example = <table class="src-code" width="100%" border="1"><tr><td>
315/example = </td></tr></table>
316example! = 0
317
318function =
319/function = ()
320
321formalpara = p
322
323graphic = img
324graphic->fileref = src
325graphic/ =
326
327important = u
328
329informalequation = blockquote
330
331informalexample = pre
332
333inlineequation = em
334
335itemizedlist = ul
336
337listitem = li
338
339literal = code
340
341literallayout = pre
342
343option = " "
344/option =
345
346orderedlist = ol
347
348para = p
349
350programlisting = <table border="0" bgcolor="#E0E0E0" cellpadding="5"><tr><td><div class="src-code">
351/programlisting = </div></td></tr></table>
352programlisting! = 0
353
354refentry = div
355
356refnamediv = <div class="refname">
357/refnamediv = </div>
358refnamediv! = 0
359
360refname = h1
361
362refpurpose = <h2 class="refpurpose"><em>
363/refpurpose = </em></h2>
364
365refsynopsisdiv = <div class="refsynopsis">
366/refsynopsisdiv = </div>
367refsynopsisdiv! = 0
368
369refsect1 = span
370
371refsect2 =
372/refsect2 = <hr />
373
374refsect3 =
375/refsect3 = <br />
376
377releaseinfo = (
378/releaseinfo = )<br />
379
380simpara =
381/simpara = <br />
382simpara! = 0
383
384subscript = sub
385
386superscript = super
387
388table = table
389
390table->colsep = rules
391table->rowsep = rules
392table->colsep+1|rowsep+1 = all
393table->colsep+1|rowsep+0 = cols
394table->colsep+0|rowsep+1 = rows
395
396table->frame = frame
397table->frame+all = border
398table->frame+none = void
399table->frame+sides = vsides
400table->frame+top = above
401table->frame+topbot = hsides
402
403thead = thead
404
405tfoot = tfoot
406
407tbody = tbody
408
409colspec = col
410
411tgroup = colgroup
412tgroup/ = 1
413tgroup->cols = span
414
415row = tr
416
417entry = td
418entry->morerows = colspan
419entry->morerows+1 = 2
420entry->morerows+2 = 3
421entry->morerows+3 = 4
422entry->morerows+4 = 5
423entry->morerows+5 = 6
424entry->morerows+6 = 7
425entry->morerows+7 = 8
426entry->morerows+8 = 9
427entry->morerows+9 = 10
428entry->morerows+10 = 11
429;; add more if you need more colspans
430
431warning = <table border="1"><tr><td>
432/warning = </td></tr></table>
433warning! = 0
434
435;; now begins the attributes that should be tags in cdata
436[$attr$id]
437open = a
438;close = /a
439cdata! = true
440quotevalues = true
441separator = "="
442;separateall = true
443$id = name
444
445;; now begins the sections that deal with <title>
446[refsynopsisdiv_title]
447;tag_attr = true
448;attr_name = title
449cdata_start = true
450;cdata_end = true
451open = <h1 class="title" align="center">
452close = </h1>
453
454[refsect1_title]
455;tag_attr = true
456;attr_name = title
457cdata_start = true
458;cdata_end = true
459open = <h2 class="title" align="center">
460close = </h1>
461
462[refsect2_title]
463;tag_attr = true
464;attr_name = title
465cdata_start = true
466;cdata_end = true
467open = <h2 class="title" align="center">
468close = </h2>
469
470[refsect3_title]
471;tag_attr = true
472;attr_name = title
473cdata_start = true
474;cdata_end = true
475open = <h3 class="title" align="center">
476close = </h3>
477
478[para_title]
479;tag_attr = true
480;attr_name = title
481cdata_start = true
482;cdata_end = true
483open = <strong class="title" align="center">
484close = </strong>
485
486[formalpara_title]
487;tag_attr = true
488;attr_name = title
489cdata_start = true
490;cdata_end = true
491open = <strong class="title" align="center">
492close = </strong>
493
494[example_title]
495;tag_attr = true
496;attr_name = title
497;cdata_start = true
498cdata_end = true
499open = </td></tr><tr><td><strong>
500close = </strong>
501
502[table_title]
503;tag_attr = true
504;attr_name = true
505cdata_start = true
506open = <caption>
507close = </caption>
508