preservedocbooktags = false
;; used to highlight the {@source} inline tag, @filesource tag, and @example tag
[highlightSourceTokens]
;; format:
;; T_CONSTANTNAME = open
;; /T_CONSTANTNAME = close
T_INCLUDE =
/T_INCLUDE =
T_INCLUDE_ONCE =
/T_INCLUDE_ONCE =
T_REQUIRE_ONCE =
/T_REQUIRE_ONCE =
T_REQUIRE_ONCE =
/T_REQUIRE_ONCE =
T_CONSTANT_ENCAPSED_STRING =
/T_CONSTANT_ENCAPSED_STRING =
T_STRING_VARNAME =
/T_STRING_VARNAME =
T_STRING =
/T_STRING =
T_DNUMBER =
/T_DNUMBER =
T_LNUMBER =
/T_LNUMBER =
T_VARIABLE =
/T_VARIABLE =
T_COMMENT =
/T_COMMENT =
T_ML_COMMENT =
/T_ML_COMMENT =
T_OBJECT_OPERATOR =
/T_OBJECT_OPERATOR =
T_ABSTRACT =
/T_ABSTRACT =
T_CLONE =
/T_CLONE =
T_HALT_COMPILER =
/T_HALT_COMPILER =
T_ARRAY =
/T_ARRAY =
T_AS =
/T_AS =
T_BREAK =
/T_BREAK =
T_CLASS =
/T_CLASS =
T_CASE =
/T_CASE =
T_CONST =
/T_CONST =
T_CONTINUE =
/T_CONTINUE =
T_DECLARE =
/T_DECLARE =
T_DEFAULT =
/T_DEFAULT =
T_ELSE =
/T_ELSE =
T_ELSEIF =
/T_ELSEIF =
T_EMPTY =
/T_EMPTY =
T_ENDDECLARE =
/T_ENDDECLARE =
T_ENDFOR =
/T_ENDFOR =
T_ENDSWITCH =
/T_ENDSWITCH =
T_ENDFOREACH =
/T_ENDFOREACH =
T_ENDIF =
/T_ENDIF =
T_ENDWHILE =
/T_ENDWHILE =
T_EXIT =
/T_EXIT =
T_EXTENDS =
/T_EXTENDS =
T_FINAL =
/T_FINAL =
T_FOR =
/T_FOR =
T_FOREACH =
/T_FOREACH =
T_FUNCTION =
/T_FUNCTION =
T_GLOBAL =
/T_GLOBAL =
T_IF =
/T_IF =
T_IMPLEMENTS =
/T_IMPLEMENTS =
T_INTERFACE =
/T_INTERFACE =
T_LOGICAL_AND =
/T_LOGICAL_AND =
T_LOGICAL_OR =
/T_LOGICAL_OR =
T_LOGICAL_XOR =
/T_LOGICAL_XOR =
T_NEW =
/T_NEW =
T_PRIVATE =
/T_PRIVATE =
T_PROTECTED =
/T_PROTECTED =
T_PUBLIC =
/T_PUBLIC =
T_RETURN =
/T_RETURN =
T_STATIC =
/T_STATIC =
T_SWITCH =
/T_SWITCH =
T_VAR =
/T_VAR =
T_WHILE =
/T_WHILE =
T_DOUBLE_COLON =
/T_DOUBLE_COLON =
T_OPEN_TAG =
/T_OPEN_TAG =
T_OPEN_TAG_WITH_ECHO =
/T_OPEN_TAG_WITH_ECHO =
T_CLOSE_TAG =
/T_CLOSE_TAG =
[highlightSource]
;; this is for highlighting things that aren't tokens like "&"
;; format:
;; word = open
;; /word = close
@ =
/@ =
& =
/& =
[ =
/[ =
] =
/] =
! =
/! =
";" =
/; =
( =
/( =
) =
/) =
, =
/, =
{ =
/{ =
} =
/} =
""" =
/" =
[highlightDocBlockSourceTokens]
;; this is for docblock tokens, highlighted by phpDocumentor_HighlightParser
;; tagphptype is for "string" in @param string description, for example
docblock =
/docblock =
tagphptype =
/tagphptype =
tagvarname =
/tagvarname =
coretag =
/coretag =
tag =
/tag =
inlinetag =
/inlinetag =
internal =
/internal =
closetemplate =
/closetemplate =
docblocktemplate =
/docblocktemplate =
[highlightTutorialSourceTokens]
;; this is for XML DocBook-based tutorials, highlighted by phpDocumentor_TutorialHighlightParser
;;
opentag =
/opentag =
;;
closetag =
/closetag =
;;
attribute =
/attribute =
;;
attributevalue =
/attributevalue =
;; &entity;
entity =
/entity =
;;
comment =
;; {@inline tag}
itag =
/itag =
;; used for translation of html in DocBlocks
[desctranslate]
ul =
ol =
/ol =
li =
/li =
code =
/code =
var =
/var =
samp =
/samp =
kbd =
/kbd =
pre =
/pre =
p =
/p =
b =
/b =
i =
/i =
br =
[ppage]
;; this is the DocBook package page translation section. All DocBook tags
;; that have a corresponding html tag must be listed here. Entities should
;; also be listed here
;;
;; examples:
;; 1)
;; tagname = newtagname
;;
;; This is the simplest case, where all attributes will be added into the
;; starting tag and the ending tag will be html/xml style
;; becomes and
;; becomes
;;
;;
;; 2)
;; tagname = newtagname
;; tagname->attr = newattrname
;;
;; in this case, everything will be like the first case, except tags like:
;; will become
;;
;;
;; 3)
;; tagname = newtagname
;; tagname->attr = newattrname
;; tagname->attr+value = newvalue
;;
;; in this case, the value is also translated to another. This can be useful
;; for instances such as focus="middle" changing to align="center" or something
;; of that nature.
;; will become
;;
;;
;; 4)
;; tagname = newtagname
;; tagname->attr1 = newattrname
;; tagname->attr2 = newattrname
;; tagname->attr1+value|attr2+value = newvalue
;;
;; in this case, two attributes combine to make one new attribute, and the combined
;; value is translated into a new value
;; will become
;;
;;
;; 5)
;; tagname = newtagname
;; tagname!attr = dummy
;;
;; here, the attribute will be ignored. dummy is not used and may be any value
;; will become
;;
;;
;; 6)
;; tagname = newtagname
;; tagname! = dummy
;;
;; here, all attributes will be ignored. dummy is not used and may be any value
;; will become
;;
;;
;; 7)
;; tagname = newtagname
;; tagname/ = 1
;;
;; here, the tag will be translated as a single tag with no closing tag, and all
;; attributes
;; {text text} will become
;;
;;
;; 8)
;; tagname =
;; /tagname = closetagtext
;;
;; in this case, the text will be inserted exactly as entered for
;; and closetagtext for
;; will become
;; closetagtext
;;
;; 9)
;; $attr$my_attribute = newattrname
;;
;; tagname = newtagname
;;
;; in this case, all occurences of my_attribute in any tag will be changed to
;; newattrname. This is useful for changing things like role="php" to
;; class="php," for example. Note that the text "$attr$" MUST be on the line
;; start for phpDocumentor to recognize it.
;;
;; 10)
;; &entity; = translation text
;; " = "
;; " = """
;; < = <
;;
;; Use this to control translation of entities to their appropriate values
=
" = "
” = ”
“ = “
& = &
< = <
> = >
© = ©
$attr$role = class
abbrev = abbr
blockquote = blockquote
arg = span
arg->choice = class
author = by
/author =
author! = 0
authorblurb =
/authorblurb =
authorgroup = Authors
/authorgroup =
authorgroup! = 0
caution =
/caution =
caution! = 0
cmdsynopsis =
/cmdsynopsis =
command =
/command =
copyright =
/copyright =
emphasis = strong
example =
/example =
example! = 0
function =
/function = ()
formalpara = p
graphic = img
graphic->fileref = src
graphic/ =
important = strong
informalequation = blockquote
informalexample = div
inlineequation = em
itemizedlist = ul
listitem = li
literal = code
literallayout = span
option = " "
/option =
orderedlist = ol
para = p
programlisting =
/programlisting =
programlisting! = 0
refentry = div
refnamediv =
/refnamediv =
refnamediv! = 0
refname =
/refname =
refpurpose =
/refpurpose =
refsynopsisdiv =
/refsynopsisdiv =
refsynopsisdiv! = 0
refsect1 = span
refsect2 =
/refsect2 =
refsect3 =
/refsect3 =
releaseinfo = (
/releaseinfo = )
simpara =
/simpara =
simpara! = 0
subscript = sub
superscript = super
table = table
table->colsep = rules
table->rowsep = rules
table->colsep+1|rowsep+1 = all
table->colsep+1|rowsep+0 = cols
table->colsep+0|rowsep+1 = rows
table->frame = frame
table->frame+all = border
table->frame+none = void
table->frame+sides = vsides
table->frame+top = above
table->frame+topbot = hsides
thead = thead
tfoot = tfoot
tbody = tbody
colspec = col
tgroup = colgroup
tgroup/ = 1
tgroup->cols = span
row = tr
entry = td
entry->morerows = colspan
entry->morerows+1 = 2
entry->morerows+2 = 3
entry->morerows+3 = 4
entry->morerows+4 = 5
entry->morerows+5 = 6
entry->morerows+6 = 7
entry->morerows+7 = 8
entry->morerows+8 = 9
entry->morerows+9 = 10
entry->morerows+10 = 11
;; add more if you need more colspans
warning =
/warning =
warning! = 0
;; now begins the attributes that should be tags in cdata
[$attr$id]
open = a
;close = /a
cdata! = true
quotevalues = true
separator = "="
;separateall = true
$id = name
;; now begins the sections that deal with
[refsynopsisdiv_title]
;tag_attr = true
;attr_name = title
cdata_start = true
;cdata_end = true
open = <h1 class="title">
close = </h1>
[refsect1_title]
;tag_attr = true
;attr_name = title
cdata_start = true
;cdata_end = true
open = <h2 class="title">
close = </h2>
[refsect2_title]
;tag_attr = true
;attr_name = title
cdata_start = true
;cdata_end = true
open = <h3 class="title">
close = </h3>
[refsect3_title]
;tag_attr = true
;attr_name = title
cdata_start = true
;cdata_end = true
open = <h4 class="title">
close = </h4>
[para_title]
;tag_attr = true
;attr_name = title
cdata_start = true
;cdata_end = true
open = <div class="title">
close = </div>
[formalpara_title]
;tag_attr = true
;attr_name = title
cdata_start = true
;cdata_end = true
open = <div class="title">
close = </div>
[example_title]
;tag_attr = true
;attr_name = title
;cdata_start = true
cdata_end = true
open = </td></tr><tr><td><strong>
close = </strong>
[table_title]
;tag_attr = true
;attr_name = true
cdata_start = true
open = <caption>
close = </caption>