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