From 5abdafeb9ded0c1c41992f7b3758f1dc02255683 Mon Sep 17 00:00:00 2001 From: wei <> Date: Thu, 12 Oct 2006 07:30:33 +0000 Subject: add unified chm build (quickstart + API + classdocs + wiki) --- .../Converters/CHM/default/CHMdefaultConverter.inc | 22 +- .../CHM/default/templates/default/options.ini | 368 +++++++----- .../default/templates/default/templates/__tags.tpl | 13 + .../default/templates/_class_declaration.tpl | 38 ++ .../default/templates/_class_description.tpl | 7 + .../templates/default/templates/_class_list.tpl | 1 + .../default/templates/_constant_details.tpl | 33 ++ .../default/templates/_constant_summary.tpl | 22 + .../default/templates/_constructor_details.tpl | 55 ++ .../default/templates/_constructor_summary.tpl | 25 + .../default/templates/_destructor_details.tpl | 55 ++ .../default/templates/_destructor_summary.tpl | 27 + .../templates/default/templates/_footer.tpl | 1 + .../default/templates/_get_constant_type.tpl | 10 + .../templates/default/templates/_header.tpl | 4 + .../default/templates/_inherited_constants.tpl | 34 ++ .../default/templates/_inherited_methods.tpl | 42 ++ .../default/templates/_inheritence_tree.tpl | 3 + .../default/templates/_method_details.tpl | 101 ++++ .../default/templates/_method_summary.tpl | 61 ++ .../templates/default/templates/_sub_classes.tpl | 19 + .../default/templates/default/templates/_tags.tpl | 13 + .../templates/default/templates/basicindex.tpl | 31 +- .../default/templates/default/templates/blank.tpl | 10 +- .../default/templates/default/templates/class.tpl | 113 +--- .../templates/default/templates/classleft.tpl | 9 +- .../templates/default/templates/classtrees.tpl | 16 +- .../default/templates/default/templates/const.tpl | 39 +- .../templates/default/templates/contents.hhc.tpl | 12 +- .../default/templates/default/templates/define.tpl | 57 +- .../templates/default/templates/docblock.tpl | 44 +- .../templates/default/templates/elementindex.tpl | 6 +- .../templates/default/templates/examplesource.tpl | 6 + .../templates/default/templates/fileleft.tpl | 4 +- .../templates/default/templates/filesource.tpl | 2 + .../default/templates/default/templates/footer.tpl | 17 +- .../templates/default/templates/function.tpl | 78 +-- .../default/templates/default/templates/global.tpl | 64 +- .../default/templates/default/templates/header.tpl | 45 +- .../templates/default/templates/include.tpl | 33 +- .../default/templates/default/templates/index.tpl | 29 +- .../default/templates/default/templates/method.tpl | 77 +-- .../default/templates/default/templates/page.tpl | 41 +- .../default/templates/pkgelementindex.tpl | 9 - .../templates/default/templates/tutorial_tree.tpl | 2 +- .../default/templates/default/templates/var.tpl | 52 +- .../PradoSoft/templates/media/bg_left.png | Bin 0 -> 991 bytes .../templates/PradoSoft/templates/media/manual.css | 260 +++++++++ .../templates/PradoSoft/templates/media/style.css | 641 +++++++++++++++++---- .../PradoSoft/templates/media/stylesheet.css | 129 +++++ 50 files changed, 2032 insertions(+), 748 deletions(-) create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/__tags.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_declaration.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_description.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_list.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constant_details.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constant_summary.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constructor_details.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constructor_summary.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_destructor_details.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_destructor_summary.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_footer.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_get_constant_type.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_header.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inherited_constants.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inherited_methods.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inheritence_tree.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_method_details.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_method_summary.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_sub_classes.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_tags.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/examplesource.tpl create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/bg_left.png create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/manual.css create mode 100644 buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/stylesheet.css (limited to 'buildscripts/PhpDocumentor/phpDocumentor/Converters') diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc index ac38031b..87674ac0 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/CHMdefaultConverter.inc @@ -158,7 +158,7 @@ class CHMdefaultConverter extends Converter $templ->assign("subdir",'../'); $templ->register_outputfilter('CHMdefault_outputfilter'); $this->setTargetDir($this->getFileSourcePath($this->base_dir)); - $this->addSourceTOC($pathinfo['name'],$this->getFileSourceName($path),$pathinfo['package'],$pathinfo['subpackage'], true); + //$this->addSourceTOC($pathinfo['name'],$this->getFileSourceName($path),$pathinfo['package'],$pathinfo['subpackage'], true); phpDocumentor_out("\n"); $this->setSourcePaths($path); $this->writefile($this->getFileSourceName($path).'.html',$templ->fetch('filesource.tpl')); @@ -179,7 +179,7 @@ class CHMdefaultConverter extends Converter $templ->register_outputfilter('CHMdefault_outputfilter'); $pathinfo = $this->proceduralpages->getPathInfo($path, $this); $this->setTargetDir($this->base_dir . PATH_DELIMITER . '__examplesource'); - $this->addSourceTOC($title,'exsource_'.$path,$pathinfo['package'],$pathinfo['subpackage'], false); + //$this->addSourceTOC($title,'exsource_'.$path,$pathinfo['package'],$pathinfo['subpackage'], false); phpDocumentor_out("\n"); $this->writefile('exsource_'.$path.'.html',$templ->fetch('examplesource.tpl')); } @@ -328,7 +328,7 @@ class CHMdefaultConverter extends Converter $this->page_data->assign("package",$this->package); $this->page_data->assign("subdir",$a); $this->page_data->register_outputfilter('CHMdefault_outputfilter'); - $this->addTOC($this->curpage->file,$this->page,$this->package,$this->subpackage); + //$this->addTOC($this->curpage->file,$this->page,$this->package,$this->subpackage); $this->writefile($this->page . '.html',$this->page_data->fetch('page.tpl')); unset($this->page_data); } @@ -460,7 +460,7 @@ class CHMdefaultConverter extends Converter flush(); $this->setTargetDir($this->base_dir); - $this->addTOC("$key Index","li_$key",$key,''); + //$this->addTOC("$key Index","li_$key",$key,''); $this->writefile("li_$key.html",$template->fetch('index.tpl')); unset($template); } @@ -1568,17 +1568,18 @@ class CHMdefaultConverter extends Converter { $comp_subs = ''; $comp_subs1 = false; - foreach($TOC1 as $subpackage => $types) + foreach($TOC1 as $subpackage => $files) { $comp_types = ''; - foreach($types as $type => $files) - { $comp = ''; $templ1 = &$this->newSmarty(); $templ1->assign('entry', array()); + $type = 'Classes'; + //foreach($types as $type => $files) + //{ foreach($files as $file) { - // use book icon for classes + //use book icon for classes if ($type == 'Classes') { $templ1->append('entry', array('paramname' => $file[0],'outputfile' => $file[1],'isclass' => 1)); } else { @@ -1589,7 +1590,7 @@ class CHMdefaultConverter extends Converter $templ->assign('tocsubentries',$templ1->fetch('tocentry.tpl')); $templ->assign('entry', array(array('paramname' => $type))); $comp_types .= $templ->fetch('tocentry.tpl'); - } + //} if (!empty($subpackage)) { $templ = &$this->newSmarty(); @@ -1633,7 +1634,8 @@ class CHMdefaultConverter extends Converter $file = str_replace($this->base_dir . '\\', '', $file); $sub = $class ? 'Classes' : 'Files'; if ($tutorial) $sub = 'Manual'; - $this->TOC[$package][$subpackage][$sub][] = array($name,$file); + if($class) + $this->TOC[$package][$subpackage][] = array($name,$file); } /** diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/options.ini b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/options.ini index 56474470..4566db60 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/options.ini +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/options.ini @@ -5,122 +5,189 @@ preservedocbooktags = false ;; format: ;; T_CONSTANTNAME = open ;; /T_CONSTANTNAME = close -T_ABSTRACT = -/T_ABSTRACT = -T_CLONE = -/T_CLONE = -T_HALT_COMPILER = -/T_HALT_COMPILER = -T_PUBLIC = -/T_PUBLIC = -T_PRIVATE = -/T_PRIVATE = -T_PROTECTED = -/T_PROTECTED = -T_FINAL = -/T_FINAL = -T_IMPLEMENTS = -/T_IMPLEMENTS = -T_CLASS = -/T_CLASS = -T_INTERFACE = -/T_INTERFACE = -T_INCLUDE = -/T_INCLUDE = -T_INCLUDE_ONCE = -/T_INCLUDE_ONCE = -T_REQUIRE_ONCE = -/T_REQUIRE_ONCE = -T_FUNCTION = -/T_FUNCTION = -T_VARIABLE = -/T_VARIABLE = -T_CONSTANT_ENCAPSED_STRING = -/T_CONSTANT_ENCAPSED_STRING = -T_COMMENT = -/T_COMMENT = -T_OBJECT_OPERATOR = -/T_OBJECT_OPERATOR = -T_RETURN = -/T_RETURN = -T_STATIC = -/T_STATIC = -T_SWITCH = -/T_SWITCH = -T_IF = -/T_IF = -T_FOREACH = -/T_FOREACH = -T_FOR = -/T_FOR = -T_VAR = -/T_VAR = -T_EXTENDS = -/T_EXTENDS = -T_RETURN = -/T_RETURN = -T_GLOBAL = -/T_GLOBAL = -T_DOUBLE_COLON = -/T_DOUBLE_COLON = -T_OBJECT_OPERATOR = -/T_OBJECT_OPERATOR = -T_OPEN_TAG = -/T_OPEN_TAG = -T_CLOSE_TAG = -/T_CLOSE_TAG = + +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, using 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 = +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 @@ -154,8 +221,8 @@ ol =
    /ol =
li =
  • /li =
    • -code = 
    -/code =
    +code = 
    +/code =
    var = /var = samp = @@ -174,7 +241,8 @@ br =
    [ppage] ;; this is the DocBook package page translation section. All DocBook tags -;; that have a corresponding html tag must be listed here +;; that have a corresponding html tag must be listed here. Entities should +;; also be listed here ;; ;; examples: ;; 1) @@ -286,33 +354,34 @@ blockquote = blockquote arg = span arg->choice = class -author = by -/author = +author = +/author = author! = 0 -authorblurb = blockquote +authorblurb =
    +/authorblurb =
    -authorgroup = Authors:
    -/authorgroup = +authorgroup =

    Authors

    +/authorgroup =
    authorgroup! = 0 -caution =
    Caution
    -/caution =
    +caution = +/caution = caution! = 0 -command = -/command = - -cmdsynopsis =
    +cmdsynopsis =
    /cmdsynopsis =
    -copyright = -/copyright =
    +command = +/command = + +copyright =
    +/copyright =
    emphasis = strong -example =
    -/example =
    +example = 
    +/example =
    example! = 0 function = @@ -324,11 +393,11 @@ graphic = img graphic->fileref = src graphic/ = -important = u +important = strong informalequation = blockquote -informalexample = pre +informalexample = div inlineequation = em @@ -338,7 +407,7 @@ listitem = li literal = code -literallayout = pre +literallayout = span option = " " /option = @@ -347,22 +416,23 @@ orderedlist = ol para = p -programlisting = 
    -/programlisting =
    +programlisting = 
    +/programlisting =
    programlisting! = 0 refentry = div -refnamediv =
    +refnamediv =
    /refnamediv =
    refnamediv! = 0 -refname = h1 +refname =

    +/refname =

    -refpurpose =

    -/refpurpose =

    +refpurpose =

    +/refpurpose =

    -refsynopsisdiv =
    +refsynopsisdiv =
    /refsynopsisdiv =
    refsynopsisdiv! = 0 @@ -374,8 +444,8 @@ refsect2 = refsect3 = /refsect3 =
    -releaseinfo = ( -/releaseinfo = )
    +releaseinfo =
    ( +/releaseinfo = )
    simpara = /simpara =
    @@ -428,8 +498,8 @@ entry->morerows+9 = 10 entry->morerows+10 = 11 ;; add more if you need more colspans -warning =
    -/warning =
    +warning = +/warning = warning! = 0 ;; now begins the attributes that should be tags in cdata @@ -448,7 +518,7 @@ $id = name ;attr_name = title cdata_start = true ;cdata_end = true -open =

    +open =

    close =

    [refsect1_title] @@ -456,40 +526,40 @@ close = ;attr_name = title cdata_start = true ;cdata_end = true -open =

    -close =

    +open =

    +close =

    [refsect2_title] ;tag_attr = true ;attr_name = title cdata_start = true ;cdata_end = true -open =

    -close =

    +open =

    +close =

    [refsect3_title] ;tag_attr = true ;attr_name = title cdata_start = true ;cdata_end = true -open =

    -close =

    +open =

    +close =

    [para_title] ;tag_attr = true ;attr_name = title cdata_start = true ;cdata_end = true -open = -close = +open =
    +close =
    [formalpara_title] ;tag_attr = true ;attr_name = title cdata_start = true ;cdata_end = true -open = -close = +open =
    +close =
    [example_title] ;tag_attr = true diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/__tags.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/__tags.tpl new file mode 100644 index 00000000..221830c4 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/__tags.tpl @@ -0,0 +1,13 @@ +
    + {section name=tag loop=$tags} + {if $tags[tag].keyword != "abstract" && + $tags[tag].keyword != "access" && + $tags[tag].keyword != "static" && + $tags[tag].keyword != "version" + } + + {$tags[tag].keyword|capitalize}: + {$tags[tag].data}
    + {/if} + {/section} +
    diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_declaration.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_declaration.tpl new file mode 100644 index 00000000..d7fe2f82 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_declaration.tpl @@ -0,0 +1,38 @@ +
    +
    + {if count($tags) > 0} + {section name=tag loop=$tags} + {if $tags[tag].keyword == "abstract"} + abstract + {/if} + {/section} + {/if} + + {if $is_interface} + interface + {else} + class + {/if} + + {$class_name} + + {if count($class_tree) > 1} + {section name=tree loop=$class_tree.classes} + {if $smarty.section.tree.last} + extends {$class_tree.classes[$smarty.section.tree.index_prev]} + {/if} + {/section} + {/if} + + {if $implements} +
    + implements + {foreach item="interface" from=$implements} + {if !$smarty.foreach.interface.first} + , {$interface} + {else} + {$interface} + {/if} + {/foreach} + {/if} +
    \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_description.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_description.tpl new file mode 100644 index 00000000..12025c1c --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_description.tpl @@ -0,0 +1,7 @@ +
    +

    {$sdesc}

    + + {if $desc != ""}{$desc}{/if} +
    + +{include file="_tags.tpl" tags=$tags} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_list.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_list.tpl new file mode 100644 index 00000000..d6a1d398 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_class_list.tpl @@ -0,0 +1 @@ +{eval var=$compiledclassindex} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constant_details.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constant_details.tpl new file mode 100644 index 00000000..bca71e17 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constant_details.tpl @@ -0,0 +1,33 @@ +{if $consts} +
    + + + + + + {section name=const loop=$consts} + + + + {/section} +
    Constant Details
    + + +

    {$consts[const].const_name}

    + +

    {$consts[const].sdesc}

    + + {if $consts[const].desc} + {$consts[const].desc} + {/if} + +
    +

    Type:

    +
    {include file="_get_constant_type.tpl" const=$consts[const].const_value}
    +

    Value:

    +
    {$consts[const].const_value}
    +
    + {include file="_tags.tpl" tags=$consts[const].tags} +

    +

    +{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constant_summary.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constant_summary.tpl new file mode 100644 index 00000000..8049c4b0 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constant_summary.tpl @@ -0,0 +1,22 @@ +{if $consts || $iconsts} +
    + + + + + + {section name=const loop=$consts} + + + + + + {/section} +
    Constant Summary
    {strip}{include file="_get_constant_type.tpl" const=$consts[const].const_value}{/strip}{$consts[const].const_name} + {$consts[const].sdesc} + + {if $consts[const].desc} + {$consts[const].desc} + {/if} +
    +{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constructor_details.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constructor_details.tpl new file mode 100644 index 00000000..ec4fd0a2 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constructor_details.tpl @@ -0,0 +1,55 @@ +{if $methods} + {section name=method loop=$methods} + {if $methods[method].function_name == "__construct"} +
    + + + + + + + + +
    Constructor Details
    + + +

    {$methods[method].function_name}

    + + + + + + +
    {strip} + {if $methods[method].access == "protected"} + protected  + {/if} + + {if $methods[method].access == "public"} + public  + {/if} + + {if $methods[method].abstract == "1"} + abstract  + {/if} + + {if $methods[method].static == "1"} + static  + {/if} + + {$methods[method].function_name} + {/strip}{strip} + {$methods[method].ifunction_call.params} + {/strip}
    + +

    {$methods[method].sdesc}

    + + {if $methods[method].desc} + {$methods[method].desc} + {/if} + + {include file="_tags.tpl" tags=$methods[method].tags} +
    + {/if} + {/section} +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constructor_summary.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constructor_summary.tpl new file mode 100644 index 00000000..8819f63e --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_constructor_summary.tpl @@ -0,0 +1,25 @@ +{if $methods} + {section name=method loop=$methods} + {if $methods[method].function_name == "__construct"} +
    + + + + + + + + + +
    Constructor Summary
    {$methods[method].access} +
    + {$methods[method].function_name} + {$methods[method].ifunction_call.params} +
    +
    + {$methods[method].sdesc} +
    +
    + {/if} + {/section} +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_destructor_details.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_destructor_details.tpl new file mode 100644 index 00000000..3cb5534a --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_destructor_details.tpl @@ -0,0 +1,55 @@ +{if $methods} + {section name=method loop=$methods} + {if $methods[method].function_name == "__destruct"} +
    + + + + + + + + +
    Destructor Details
    + + +

    {$methods[method].function_name}

    + + + + + + +
    {strip} + {if $methods[method].access == "protected"} + protected  + {/if} + + {if $methods[method].access == "public"} + public  + {/if} + + {if $methods[method].abstract == "1"} + abstract  + {/if} + + {if $methods[method].static == "1"} + static  + {/if} + + {$methods[method].function_name} + {/strip}{strip} + {build_argument_list args=$methods[method].ifunction_call.params style="vertical"} + {/strip}
    + +

    {$methods[method].sdesc}

    + + {if $methods[method].desc} + {$methods[method].desc} + {/if} + + {include file="_tags.tpl" tags=$methods[method].tags} +
    + {/if} + {/section} +{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_destructor_summary.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_destructor_summary.tpl new file mode 100644 index 00000000..53e8f1d2 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_destructor_summary.tpl @@ -0,0 +1,27 @@ +{if $methods} + {section name=method loop=$methods} + {if $methods[method].function_name == "__destruct"} +
    + + + + + + + + + +
    Destructor Summary
    {strip} + {$methods[method].access} + {/strip} +
    {strip} + {$methods[method].function_name} + {$methods[method].ifunction_call.params} + {/strip}
    +
    + {$methods[method].sdesc} +
    +
    + {/if} + {/section} +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_footer.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_footer.tpl new file mode 100644 index 00000000..0c2eddc2 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_footer.tpl @@ -0,0 +1 @@ +
    diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_get_constant_type.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_get_constant_type.tpl new file mode 100644 index 00000000..48301da4 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_get_constant_type.tpl @@ -0,0 +1,10 @@ +{if is_numeric(strtolower(trim($const)))} + int +{elseif strtolower(trim($const)) == "true" || + strtolower(trim($const)) == "false"} + bool +{elseif strtolower(trim($const)) == "null"} + null +{else} + string +{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_header.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_header.tpl new file mode 100644 index 00000000..f92571a4 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_header.tpl @@ -0,0 +1,4 @@ +
    + {include file="_class_list.tpl"} +
    +
    diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inherited_constants.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inherited_constants.tpl new file mode 100644 index 00000000..66c37633 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inherited_constants.tpl @@ -0,0 +1,34 @@ +{if $iconsts} + {section name=iconst loop=$iconsts} + + + + + + + +
    Constants Inherited From {$iconsts[iconst].parent_class}
    + {assign var="_consts" value=""} + + {section name=_const loop=$iconsts[iconst].iconsts} + {if $_consts != ""}, + {* append var="_consts" value=", "*} + {/if} + {$iconsts[iconst].iconsts[_const].name}{if !$smarty.section.name.last},{/if} + {* + {extract_attribute attribute="href" + element=$iconsts[iconst].iconsts[_const].link + var="href" append="no"} + + {append var="_consts" value=""} + {append var="_consts" value=$iconsts[iconst].iconsts[_const].name} + {append var="_consts" value=""} + *} +{/section} + + {*$_consts*} +
    + {/section} +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inherited_methods.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inherited_methods.tpl new file mode 100644 index 00000000..55aafb17 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inherited_methods.tpl @@ -0,0 +1,42 @@ +{if $imethods} + {section name=imethod loop=$imethods} + {if count($imethods[imethod].imethods) > 1 || + ($imethods[imethod].imethods[0].name != "__construct" && + $imethods[imethod].imethods[0].name != "__destruct" && + $imethods[imethod].imethods[0].abstract != "1")} + + + + + + + +
    Methods Inherited From {$imethods[imethod].parent_class}
    + {* assign var="_methods" value="" *} + + {section name=_method loop=$imethods[imethod].imethods} + {if $imethods[imethod].imethods[_method].name != "__construct" && + $imethods[imethod].imethods[_method].abstract != "1"} + {* + {if $_methods != ""} + {append var="_methods" value=", "} + {/if} + + {extract_attribute attribute="href" + element=$imethods[imethod].imethods[_method].link + var="href" append="no"} + + {append var="_methods" value=""} + {append var="_methods" value=$imethods[imethod].imethods[_method].name} + {append var="_methods" value=""} + *} + {$imethods[imethod].imethods[_method].link}{if !$smarty.section._method.last},{/if} + {/if} + {/section} + +
    + {/if} + {/section} +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inheritence_tree.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inheritence_tree.tpl new file mode 100644 index 00000000..471c7972 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_inheritence_tree.tpl @@ -0,0 +1,3 @@ +
    + 
    {section name=tree loop=$class_tree.classes}{if $smarty.section.tree.last}{$class_tree.classes[tree]}{else}{$class_tree.classes[tree]}{/if}{$class_tree.distance[tree]}{/section}
    +
    \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_method_details.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_method_details.tpl new file mode 100644 index 00000000..b5ddfb10 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_method_details.tpl @@ -0,0 +1,101 @@ +{if $methods && (count($methods) > 1 || + ($methods[0].function_name != "__construct" && + $methods[0].function_name != "__destruct"))} + +
    + + + + + + {section name=method loop=$methods} + {if $methods[method].function_name != "__construct" && + $methods[method].function_name != "__destruct"} + + + + + {/if} + {/section} +
    Method Details
    + + + +

    {$methods[method].function_name}

    + + + + + + +
    {strip} + {if $methods[method].access == "protected"} + protected  + {/if} + + {if $methods[method].access == "public"} + public  + {/if} + + {if $methods[method].abstract == 1} + abstract  + {/if} + + {if $methods[method].static == 1} + static  + {/if} + + {$methods[method].function_return}  + + + {$methods[method].function_name} + {/strip}{strip} + ( + {if $methods[method].ifunction_call.params} + {foreach item=param name="method" from=$methods[method].ifunction_call.params} + {$param.type} {$param.name} {if !$smarty.foreach.method.last}, {/if} + {/foreach} + + {/if} + ) + {/strip}
    + +

    {$methods[method].sdesc}

    + + {if $methods[method].desc} + {$methods[method].desc} + {/if} + {* $methods[method]|print_r *} +
    + {if $methods[method].ifunction_call.params} + + {foreach item=param name="method" from=$methods[method].ifunction_call.params} + + {/foreach} + {/if} + {if $methods[method].tags} + + + {foreach item=param name="method" from=$methods[method].tags} + {if $param.keyword == "return"} + + {/if} + {/foreach} + {/if} + {if $methods[method].tags} + + + {foreach item=param name="method" from=$methods[method].tags} + {if $param.keyword == "throws"} + + {/if} + {/foreach} + {/if} +
    Input
    {$param.type}{$param.name}{$param.description}
    Output
    + {$methods[method].function_return} + {$param.data}
    Exception
    {$param.keyword}{$param.data}
    + + {* include file="_tags.tpl" tags=$methods[method].tags *} +

    +

    +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_method_summary.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_method_summary.tpl new file mode 100644 index 00000000..8fefd671 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_method_summary.tpl @@ -0,0 +1,61 @@ +{if $methods || $imethods} +
    + + + + + + {section name=method loop=$methods} + {if $methods[method].function_name != "__construct" && + $methods[method].function_name != "__destruct"} + {* + {if trim(substr($methods[method].function_call, 0, 1)) == "&"} + {assign var="ref" value="true"} + {assign var="css" value=" class=\"reference\""} + {else} + {assign var="ref" value="false"} + {assign var="css" value=""} + {/if} + *} + + + + + {/if} + {/section} +
    Method Summary
    + {if $methods[method].access == "protected"} + protected  + {/if} + + {if $methods[method].abstract == 1} + abstract  + {/if} + + {if $methods[method].static == 1} + static  + {/if} + + {$methods[method].function_return} +{* + {if $ref == "true"} +  & + {/if} +*} + +
    + {$methods[method].function_name} + ({strip} + {if $methods[method].ifunction_call.params} + {foreach item=param name="method" from=$methods[method].ifunction_call.params} + {$param.type} {$param.name}{if !$smarty.foreach.method.last}, {/if} + {/foreach} + + {/if} + {/strip}) +
    +
    + {$methods[method].sdesc} +
    +
    +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_sub_classes.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_sub_classes.tpl new file mode 100644 index 00000000..e605b314 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_sub_classes.tpl @@ -0,0 +1,19 @@ +{if $children} +
    + {if $is_interface} +

    Direct Known Sub-interfaces:

    + {else} +

    Direct Known Sub-classes:

    + {/if} + +
    + {section name=child loop=$children} + {if !$smarty.section.child.first} + , {$children[child].link} + {else} + {$children[child].link} + {/if} + {/section} +
    +
    +{/if} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_tags.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_tags.tpl new file mode 100644 index 00000000..221830c4 --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/_tags.tpl @@ -0,0 +1,13 @@ +
    + {section name=tag loop=$tags} + {if $tags[tag].keyword != "abstract" && + $tags[tag].keyword != "access" && + $tags[tag].keyword != "static" && + $tags[tag].keyword != "version" + } + + {$tags[tag].keyword|capitalize}: + {$tags[tag].data}
    + {/if} + {/section} +
    diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/basicindex.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/basicindex.tpl index a040830b..37e94343 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/basicindex.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/basicindex.tpl @@ -1,21 +1,18 @@ {section name=letter loop=$letters} - {$letters[letter].letter} + [ {$letters[letter].letter} ] {/section} - + {section name=index loop=$index} - - {section name=contents loop=$index[index].index} - - {/section} +
    + +
    +

    {$index[index].letter}

    +
    + {section name=contents loop=$index[index].index} +
    {$index[index].index[contents].name}
    +
    {$index[index].index[contents].listing}
    + {/section} +
    +
    + top
    {/section} -
      -top
    - - - - -
    - {$index[index].letter} -
    -
    {$index[index].index[contents].name}{$index[index].index[contents].listing}
    - diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/blank.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/blank.tpl index 1fbaca2f..b503c142 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/blank.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/blank.tpl @@ -1,13 +1,5 @@ - - - {$maintitle} - - - -

    {$maintitle}

    Welcome to {$package}!

    This documentation was generated by phpDocumentor v{$phpdocversion}
    - - \ No newline at end of file + diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/class.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/class.tpl index 1ed17562..49e8c142 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/class.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/class.tpl @@ -1,94 +1,31 @@ {include file="header.tpl" eltype="class" hasel=true contents=$classcontents} - -

    - {if $is_interface}Interface{else}Class{/if} {$class_name} -
    -

    -[line {if $class_slink}{$class_slink}{else}{$line_number}{/if}]
    -
    -{section name=tree loop=$class_tree.classes}{$class_tree.classes[tree]}{$class_tree.distance[tree]}{/section}
-
    -{if $tutorial} -
    Class Tutorial: {$tutorial}
    -{/if} -{if $children} -Classes extended from {$class_name}: - {section name=kids loop=$children} -
    -
    {$children[kids].link}
    -
    {$children[kids].sdesc}
    -
    - {/section}

    -{/if} -{if $conflicts.conflict_type}

    Conflicts with classes:
    - {section name=me loop=$conflicts.conflicts} - {$conflicts.conflicts[me]}
    - {/section} -

    -{/if} -Location: {$source_location} -

    -{include file="docblock.tpl" type="class" sdesc=$sdesc desc=$desc} -
    -{include file="var.tpl" show="summary"} -
    -{include file="const.tpl" show="summary"} -
    - - -

    Inherited Class Constant Summary

    -{section name=iconsts loop=$iconsts} -

    Inherited From Class {$iconsts[iconsts].parent_class}

    -
      - {section name=iconsts2 loop=$iconsts[iconsts].iconsts} - -
    • {$iconsts[iconsts].iconsts[iconsts2].link} = {$iconsts[iconsts].iconsts[iconsts2].value} -
      - {$iconsts[iconsts].iconsts[iconsts2].sdesc} - {/section} -
      • -
    -{/section} -
    - - -

    Inherited Class Variable Summary

    +

    {if $is_interface}Interface{else}Class{/if} {$class_name} +(Class Overview) +

    -{section name=ivars loop=$ivars} -

    Inherited From Class {$ivars[ivars].parent_class}

    -
      - {section name=ivars2 loop=$ivars[ivars].ivars} - -
    • {$ivars[ivars].ivars[ivars2].link} = {$ivars[ivars].ivars[ivars2].default} -
      - {$ivars[ivars].ivars[ivars2].sdesc} - {/section} -
      • -
    -{/section} +{*inheritence tree*} +
    + 
    {section name=tree loop=$class_tree.classes}{if $smarty.section.tree.last}{$class_tree.classes[tree]}{else}{$class_tree.classes[tree]}{/if}{$class_tree.distance[tree]}{/section}
    +
    -
    -{include file="method.tpl" show="summary"} - - -

    Inherited Method Summary

    +{include file="_sub_classes.tpl"} +{include file="_class_description.tpl"} +{include file="_inherited_constants.tpl"} + +{include file="_constructor_summary.tpl"} +{* include file="_destructor_summary.tpl" *} + +{include file="_method_summary.tpl"} + +{include file="_inherited_methods.tpl"} +{include file="_constant_summary.tpl"} +{include file="_constructor_details.tpl"} + +{* include file="_destructor_details.tpl" *} + +{include file="_method_details.tpl"} + +{include file="_constant_details.tpl"} -{section name=imethods loop=$imethods} -

    Inherited From Class {$imethods[imethods].parent_class}

    -
      - {section name=im2 loop=$imethods[imethods].imethods} - -
    • {$imethods[imethods].imethods[im2].link}
      - {$imethods[imethods].imethods[im2].sdesc} - {/section} -
    -{/section} -
    -{include file="method.tpl"} -
    -{include file="var.tpl"} -
    -{include file="const.tpl"} -
    {include file="footer.tpl"} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/classleft.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/classleft.tpl index 15bf6b7e..c07fc33a 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/classleft.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/classleft.tpl @@ -1,8 +1,9 @@ {foreach key=subpackage item=files from=$classleftindex} - {if $subpackage != ""}{$subpackage}
    {/if} +
    + {if $subpackage != ""}{$subpackage}
    {/if} {section name=files loop=$files} - {if $files[files].link != ''}{/if} - {$files[files].title} - {if $files[files].link != ''}{/if}
    + {if $subpackage != ""}  {/if} + {if $files[files].link != ''}{/if}{$files[files].title}{if $files[files].link != ''}{/if}
    {/section} +
    {/foreach} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/classtrees.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/classtrees.tpl index 28c648be..4020e3a8 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/classtrees.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/classtrees.tpl @@ -1,12 +1,8 @@ -{capture name="title"}Class Trees for Package {$package}{/capture} -{include file="header.tpl" title=$smarty.capture.title} - - -

    - {$smarty.capture.title} -

    +{include file="header.tpl" noleftindex=true} +

    {$title}

    {section name=classtrees loop=$classtrees} -Root class {$classtrees[classtrees].class} -{$classtrees[classtrees].class_tree} +
    +
    Root class {$classtrees[classtrees].class}

    +{$classtrees[classtrees].class_tree} {/section} -{include file="footer.tpl"} \ No newline at end of file +{include file="footer.tpl"} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/const.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/const.tpl index 207491a5..88856c4b 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/const.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/const.tpl @@ -1,29 +1,14 @@ -{if $show=="summary"} - - -

    Class Constant Summary

    - -
      - {section name=consts loop=$consts} - -
    • {$consts[consts].const_name} = {$consts[consts].const_value|replace:"\n":"
      \n"|replace:" ":" "|replace:"\t":"   "}       -
      - {$consts[consts].sdesc} - {/section} -
    -{else} - - - - -

    Class Constant Detail

    - -
      {section name=consts loop=$consts} - -
    • {$consts[consts].const_name} = {$consts[consts].const_value|replace:"\n":"
      \n"|replace:" ":" "|replace:"\t":"   "}       [line {if $consts[consts].slink}{$consts[consts].slink}{else}{$consts[consts].line_number}{/if}]
      • -{include file="docblock.tpl" sdesc=$consts[consts].sdesc desc=$consts[consts].desc tags=$consts[consts].tags} -
      +{if $show == 'summary'} + var {$consts[consts].const_name}, {$consts[consts].sdesc}
      +{else} + +

      +

      {$consts[consts].const_name} = {$consts[consts].const_value|replace:"\n":"
      \n"|replace:" ":" "|replace:"\t":"   "}

      +

      [line {if $consts[consts].slink}{$consts[consts].slink}{else}{$consts[consts].line_number}{/if}]

      + {include file="docblock.tpl" sdesc=$consts[consts].sdesc desc=$consts[consts].desc tags=$consts[consts].tags} + +
      +
      [ Top ]

      +{/if} {/section} -
    -{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/contents.hhc.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/contents.hhc.tpl index cf7ee7cb..a1c71a0d 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/contents.hhc.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/contents.hhc.tpl @@ -1,11 +1 @@ - - - - - - - - - -{$toc} - +{$toc} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/define.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/define.tpl index 3917cc70..04ce5b48 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/define.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/define.tpl @@ -1,33 +1,32 @@ -{if $summary} - - -

    Constant Summary

    - -
      - {section name=def loop=$defines} -
    • {$defines[def].define_name} = {$defines[def].define_value} -
      {$defines[def].sdesc} - {/section} -
    +{if count($defines) > 0} +{section name=def loop=$defines} +{if $show == 'summary'} +define constant {$defines[def].define_name} = {$defines[def].define_value}, {$defines[def].sdesc}
    {else} - - - -

    Constant Detail

    +
    + +

    {$defines[def].define_name} [line {if $defines[def].slink}{$defines[def].slink}{else}{$defines[def].line_number}{/if}]

    +
    +
    +
    + {$defines[def].define_name} = {$defines[def].define_value} +
    +
    -
      - {section name=def loop=$defines} - -
    • {$defines[def].define_name} = {$defines[def].define_value} [line {if $defines[def].slink}{$defines[def].slink}{else}{$defines[def].line_number}{/if}]
      - {if $defines[def].define_conflicts.conflict_type} -

      Conflicts with defines: - {section name=me loop=$defines[def].define_conflicts.conflicts} - {$defines[def].define_conflicts.conflicts[me]}
      - {/section} -

      - {/if} -

      - {include file="docblock.tpl" sdesc=$defines[def].sdesc desc=$defines[def].desc tags=$defines[def].tags} + {include file="docblock.tpl" sdesc=$defines[def].sdesc desc=$defines[def].desc tags=$defines[def].tags} +
      + {if $defines[def].define_conflicts.conflict_type} +

      Conflicts with defines: + {section name=me loop=$defines[def].define_conflicts.conflicts} + {$defines[def].define_conflicts.conflicts[me]}
      {/section} -

    +

    + {/if} +{* original {if $defines[def].define_conflicts != "" + Conflicts: {$defines[def].define_conflicts

    + {/if *} +
    +
    [ Top ]


    +{/if} +{/section} {/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/docblock.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/docblock.tpl index 0de18b67..09a603f8 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/docblock.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/docblock.tpl @@ -1,31 +1,15 @@ - -{if $function} - {if $params} -

    Parameters

    - {section name=params loop=$params} -

    {$params[params].var}

    -

    {$params[params].data}

    - {/section} - {/if} -{/if} -{section name=tags loop=$tags} -{if $tags[tags].keyword == 'return'} -

    Returns

    -

    {$tags[tags].data}

    -{/if} +{if $sdesc != ''}{$sdesc|default:''}

    {/if} +{if $desc != ''}{$desc|default:''}
    {/if} +{if count($tags) > 0} +

    +

    Tags:

    +
    + +{section name=tag loop=$tags} + + + {/section} -{if $sdesc || $desc} -

    Remarks

    -{/if} -{if $sdesc} -

    {$sdesc}

    -{/if} -{if $desc} -

    {$desc}

    -{/if} -{section name=tags loop=$tags} -{if $tags[tags].keyword != 'return'} -

    {$tags[tags].keyword}

    -

    {$tags[tags].data}

    -{/if} -{/section} \ No newline at end of file +
    {$tags[tag].keyword}:  {$tags[tag].data}
    +
    +{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/elementindex.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/elementindex.tpl index 8e25db5c..175a5136 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/elementindex.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/elementindex.tpl @@ -1,9 +1,5 @@ {include file="header.tpl" noleftindex=true} -

    Index of All Elements

    -Indexes by package:
    -{section name=p loop=$packageindex} -{$packageindex[p].title}
    -{/section}
    +

    Index of all elements

    {include file="basicindex.tpl" indexname="elementindex"} {include file="footer.tpl"} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/examplesource.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/examplesource.tpl new file mode 100644 index 00000000..fb85654b --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/examplesource.tpl @@ -0,0 +1,6 @@ +{include file="header.tpl" title=$title} +

    {$title}

    +
    +{$source} +
    +{include file="footer.tpl"} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/fileleft.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/fileleft.tpl index c85acbe0..50f108d7 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/fileleft.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/fileleft.tpl @@ -1,8 +1,10 @@ {foreach key=subpackage item=files from=$fileleftindex} {if $subpackage != ""}subpackage {$subpackage}
    {/if} +
    {section name=files loop=$files} - {if $files[files].link != ''}{/if} + {if $files[files].link != ''}{/if} {$files[files].title} {if $files[files].link != ''}{/if}
    {/section} +

    {/foreach} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/filesource.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/filesource.tpl index a0d7119e..b23076a0 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/filesource.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/filesource.tpl @@ -2,5 +2,7 @@ {include file="header.tpl" title=$smarty.capture.tutle}

    Source for file {$name}

    Documentation is available at {$docs}

    +
    {$source} +
    {include file="footer.tpl"} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/footer.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/footer.tpl index a015ceea..0b744c20 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/footer.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/footer.tpl @@ -1,8 +1,11 @@ -{if !$index} -
    -
    - Documentation generated on {$date} by phpDocumentor {$phpdocversion} -
    -{/if} + + + + +
    + + - + \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/function.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/function.tpl index ea314935..098aeb17 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/function.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/function.tpl @@ -1,44 +1,48 @@ -{if $summary} - - -

    Function Summary

    - - -{else} - - - -

    Function Detail

    - -
      {section name=func loop=$functions} - - -
    • {$functions[func].function_return} {$functions[func].function_name}() [line {if $functions[func].slink}{$functions[func].slink}{else}{$functions[func].line_number}{/if}]
      -

      -Usage: {if $functions[func].ifunction_call.returnsref}&{/if}{$functions[func].function_name}( +{if $show == 'summary'} +function {$functions[func].id}, {$functions[func].sdesc}
      +{else} +
      + +

      {$functions[func].function_name} [line {if $functions[func].slink}{$functions[func].slink}{else}{$functions[func].line_number}{/if}]

      +
      +
      +
      + {$functions[func].function_return} {if $functions[func].ifunction_call.returnsref}&{/if}{$functions[func].function_name}( {if count($functions[func].ifunction_call.params)} {section name=params loop=$functions[func].ifunction_call.params} {if $smarty.section.params.iteration != 1}, {/if}{if $functions[func].ifunction_call.params[params].default != ''}[{/if}{$functions[func].ifunction_call.params[params].type} {$functions[func].ifunction_call.params[params].name}{if $functions[func].ifunction_call.params[params].default != ''} = {$functions[func].ifunction_call.params[params].default|escape:"html"}]{/if} {/section} -{/if}) -

      -{if $functions[func].function_conflicts.conflict_type} -

      Conflicts with functions: -{section name=me loop=$functions[func].function_conflicts.conflicts} -{$functions[func].function_conflicts.conflicts[me]}
      -{/section} -

      +{/if})       +
      +

      + + {include file="docblock.tpl" sdesc=$functions[func].sdesc desc=$functions[func].desc tags=$functions[func].tags} +

      + {if $functions[func].function_conflicts.conflict_type} +

      Conflicts with functions: + {section name=me loop=$functions[func].function_conflicts.conflicts} + {$functions[func].function_conflicts.conflicts[me]}
      + {/section} +

      + {/if} +{* original {if $functions[func].function_conflicts != "" + Conflicts: {$functions[func].function_conflicts

      + {/if *} + + {if count($functions[func].params) > 0} +

      Parameters

      + + {section name=params loop=$functions[func].params} + + + + + + {/section} +
      {$functions[func].params[params].datatype}  {$functions[func].params[params].var}  {$functions[func].params[params].data}
      + {/if} +
      [ Top ]


      +
      {/if} -{include file="docblock.tpl" sdesc=$functions[func].sdesc desc=$functions[func].desc tags=$functions[func].tags params=$functions[func].params function=true} -
      -

      [ Top ]

      {/section} -
    -{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/global.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/global.tpl index c1b74a1c..1053f748 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/global.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/global.tpl @@ -1,32 +1,40 @@ -{if $summary} - - -

    Global Variable Summary

    - - - +{if count($globals) > 0} +{section name=glob loop=$globals} +{if $show == 'summary'} +global variable {$globals[glob].global_name} = {$globals[glob].global_value}, {$globals[glob].sdesc}
    {else} - - - -

    Global Variable Detail

    +
    + +

    {$globals[glob].global_type} {$globals[glob].global_name} [line {if $globals[glob].slink}{$globals[glob].slink}{else}{$globals[glob].line_number}{/if}]

    +
    + {if $globals[glob].sdesc != ""} + {include file="docblock.tpl" sdesc=$globals[glob].sdesc desc=$globals[glob].desc tags=$globals[glob].tags} + {/if} -
      - {section name=glob loop=$globals} - -
    • {$globals[glob].global_type} {$globals[glob].global_name} = {$globals[glob].global_value} [line {if $globals[glob].slink}{$globals[glob].slink}{else}{$globals[glob].line_number}{/if}]
      - {if $globals[glob].global_conflicts.conflict_type} -

      Conflicts with globals: - {section name=me loop=$globals[glob].global_conflicts.conflicts} - {$globals[glob].global_conflicts.conflicts[me]}
      - {/section} - {/if}

      - {include file="docblock.tpl" sdesc=$globals[glob].sdesc desc=$globals[glob].desc tags=$globals[glob].tags} + + + + + + {if $globals[glob].global_conflicts.conflict_type} + + + + + {/if} +{* original {if $globals[glob].global_conflicts != "" + + + + + {/if *} +
      Default value:  {$globals[glob].global_value|replace:" ":" "|replace:"\n":"
      \n"|replace:"\t":"   "}
      Conflicts with globals:   + {section name=me loop=$globals[glob].global_conflicts.conflicts} + {$globals[glob].global_conflicts.conflicts[me]}
      {/section} - +
      Conflicts:  {$globals[glob].global_conflicts
      +



    +
    [ Top ]


    +{/if} +{/section} {/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/header.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/header.tpl index bdf6173e..83b0c66b 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/header.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/header.tpl @@ -1,22 +1,23 @@ - - - - - - - {$title} - -{if $bgleft} - -{/if} - - - \ No newline at end of file + + + + + +PRADO API Manual: {$title} + + + + + + + + + + + + + + + + +
    diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/include.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/include.tpl index 1ab7440b..cff067db 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/include.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/include.tpl @@ -1,26 +1,9 @@ -{if $summary} - - -

    Include Statements Summary

    - - -{else} - - - -

    Include Statements Detail

    - -
      - {section name=includes loop=$includes} - -
    • {$includes[includes].include_name} file: = {$includes[includes].include_value} [line {if $includes[includes].slink}{$includes[includes].slink}{else}{$includes[includes].line_number}{/if}]
      -

      - {include file="docblock.tpl" sdesc=$includes[includes].sdesc desc=$includes[includes].desc tags=$includes[includes].tags} - {/section} -
    +{if count($includes) > 0} +

    Includes:

    +
    +{section name=includes loop=$includes} +{$includes[includes].include_name}({$includes[includes].include_value}) [line {if $includes[includes].slink}{$includes[includes].slink}{else}{$includes[includes].line_number}{/if}]
    +{include file="docblock.tpl" sdesc=$includes[includes].sdesc desc=$includes[includes].desc tags=$includes[includes].tags} +{/section} +
    {/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/index.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/index.tpl index f73fb8a3..60c74b47 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/index.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/index.tpl @@ -1,24 +1,7 @@ - - - - - - {$title} - - -{if $package_count > 1} - - +{include file="header.tpl"} +{if $contents} +{$contents} +{else} +{include file="blank.tpl"} {/if} - -{if $package_count > 1} - -{/if} - - - <H2>Frame Alert</H2> - <P>This document is designed to be viewed using the frames feature. - If you see this message, you are using a non-frame-capable web client.</P> - - - +{include file="footer.tpl"} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/method.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/method.tpl index 9309962b..07cb76e5 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/method.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/method.tpl @@ -1,38 +1,25 @@ +{section name=methods loop=$methods} {if $show == 'summary'} - - -

    Method Summary

    - - - +method {$methods[methods].function_call}, {$methods[methods].sdesc}
    {else} - - - -

    Method Detail

    - -
      -{section name=methods loop=$methods} - - -

      {$class_name}::{$methods[methods].function_name}

      - -

      -{if $methods[methods].ifunction_call.returnsref}&{/if}{$methods[methods].function_name}( +

      + +

      {if $methods[methods].ifunction_call.constructor}constructor {elseif $methods[methods].ifunction_call.destructor}destructor {else}method {/if}{$methods[methods].function_name} [line {if $methods[methods].slink}{$methods[methods].slink}{else}{$methods[methods].line_number}{/if}]

      +
      +
      +
      + {$methods[methods].function_return} {if $methods[methods].ifunction_call.returnsref}&{/if}{$methods[methods].function_name}( {if count($methods[methods].ifunction_call.params)} {section name=params loop=$methods[methods].ifunction_call.params} {if $smarty.section.params.iteration != 1}, {/if} -{if $methods[methods].ifunction_call.params[params].default != ''}[{/if}{$methods[methods].ifunction_call.params[params].type} -{$methods[methods].ifunction_call.params[params].name}{if $methods[methods].ifunction_call.params[params].default != ''} = {$methods[methods].ifunction_call.params[params].default}]{/if} +{if $methods[methods].ifunction_call.params[params].default != ''}[{/if}{$methods[methods].ifunction_call.params[params].type} +{$methods[methods].ifunction_call.params[params].name}{if $methods[methods].ifunction_call.params[params].default != ''} = {$methods[methods].ifunction_call.params[params].default}]{/if} {/section} -{/if} ); -

      +{/if})       +
      +

      + + {include file="docblock.tpl" sdesc=$methods[methods].sdesc desc=$methods[methods].desc tags=$methods[methods].tags}

      {if $methods[methods].descmethod}

      Overridden in child classes as:
      @@ -43,13 +30,29 @@ {/section}

      {/if} -{if $methods[methods].method_overrides} -

      Overrides {$methods[methods].method_overrides.link} ({$methods[methods].method_overrides.sdesc|default:"parent method not documented"})

      +{* original {if $methods[methods].descmethod != "" + {$methods[methods].descmethod

      + {/if *} +{if $methods[methods].method_overrides}Overrides {$methods[methods].method_overrides.link} ({$methods[methods].method_overrides.sdesc|default:"parent method not documented"})

      {/if} +{* original {if $methods[methods].method_overrides != "" + {$methods[methods].method_overrides

      + {/if *} + + {if count($methods[methods].params) > 0} +

      Parameters:

      +
      + + {section name=params loop=$methods[methods].params} + + + + + + {/section} +
      {$methods[methods].params[params].datatype}  {$methods[methods].params[params].var}  {$methods[methods].params[params].data}
      +

      + {/if} +
      [ Top ]
      +
      {/if} - -{include file="docblock.tpl" sdesc=$methods[methods].sdesc desc=$methods[methods].desc tags=$methods[methods].tags params=$methods[methods].params function=true} -

      [ Top ]

      -
      {/section} -
    -{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/page.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/page.tpl index dc93b0a1..6dd8683d 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/page.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/page.tpl @@ -1,34 +1,31 @@ -{include file="header.tpl" eltype="Procedural file"} -

    File: {$source_location}
    -

    +{include file="header.tpl" eltype="Procedural file" class_name=$name hasel=true contents=$pagecontents} + +
    +
    + +{if $classes} +
    {if $tutorial} -
    Main Tutorial: {$tutorial}
    +Main Tutorial: {$tutorial} {/if} -{include file="docblock.tpl" desc=$desc sdesc=$sdesc tags=$tags} -Classes in this file: -
    +

    Classes:

    {section name=classes loop=$classes}
    {$classes[classes].link}
    {$classes[classes].sdesc}
    {/section} -
    -
    -{include file="include.tpl" summary=true} -
    -{include file="global.tpl" summary=true} -
    -{include file="define.tpl" summary=true} -
    -{include file="function.tpl" summary=true} -
    +


    +{/if} + +

    Page Details:

    +{include file="docblock.tpl" type="page"} +

    {include file="include.tpl"} -
    +

    {include file="global.tpl"} -
    +

    {include file="define.tpl"} -
    +
    {include file="function.tpl"} -
    + {include file="footer.tpl"} - \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/pkgelementindex.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/pkgelementindex.tpl index 68897450..753ad7cf 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/pkgelementindex.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/pkgelementindex.tpl @@ -1,14 +1,5 @@ {include file="header.tpl"}

    Element index for package {$package}

    -{if count($packageindex) > 1} -Indexes by package:
    -{/if} -{section name=p loop=$packageindex} -{if $packageindex[p].title != $package} -{$packageindex[p].title}
    -{/if} -{/section}
    -Index of all elements
    {include file="basicindex.tpl" indexname=elementindex_$package} {include file="footer.tpl"} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/tutorial_tree.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/tutorial_tree.tpl index 6997545a..faf7bcef 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/tutorial_tree.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/tutorial_tree.tpl @@ -1,5 +1,5 @@ diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/var.tpl b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/var.tpl index d6f04b53..c76929fe 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/var.tpl +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/CHM/default/templates/default/templates/var.tpl @@ -1,30 +1,28 @@ -{if $show=="summary"} - - -

    Class Variable Summary

    - -
      - {section name=vars loop=$vars} - -
    • {$vars[vars].var_name} = {$vars[vars].var_default|replace:"\n":"
      \n"|replace:" ":" "|replace:"\t":"   "}       -
      - {$vars[vars].sdesc} - {/section} -
    +{section name=vars loop=$vars} +{if $show == 'summary'} + var {$vars[vars].var_name}, {$vars[vars].sdesc}
    {else} - - - + +

    +

    {$vars[vars].var_name} = {$vars[vars].var_default|replace:"\n":"
    \n"|replace:" ":" "|replace:"\t":"   "}

    +

    [line {if $vars[vars].slink}{$vars[vars].slink}{else}{$vars[vars].line_number}{/if}]

    + {include file="docblock.tpl" sdesc=$vars[vars].sdesc desc=$vars[vars].desc tags=$vars[vars].tags} -

    Variable Detail

    - -
      -{section name=vars loop=$vars} - -
    • {$vars[vars].var_name} = {$vars[vars].var_default|replace:"\n":"
      \n"|replace:" ":" "|replace:"\t":"   "}       [line {if $vars[vars].slink}{$vars[vars].slink}{else}{$vars[vars].line_number}{/if}]
      • -
    • Data type: {$vars[vars].var_type}{if $vars[vars].var_overrides}Overrides: {$vars[vars].var_overrides}
      {/if}
      • -{include file="docblock.tpl" sdesc=$vars[vars].sdesc desc=$vars[vars].desc tags=$vars[vars].tags} -
      +
      +
      + + + + + + {if $vars[vars].var_overrides != ""} + + + + + {/if} +
      Type:  {$vars[vars].var_type}
      Overrides:  {$vars[vars].var_overrides}
      +


      +
      [ Top ]

      +{/if} {/section} -
    -{/if} \ No newline at end of file diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/bg_left.png b/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/bg_left.png new file mode 100644 index 00000000..19fdf05d Binary files /dev/null and b/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/bg_left.png differ diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/manual.css b/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/manual.css new file mode 100644 index 00000000..8aaa937d --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/manual.css @@ -0,0 +1,260 @@ +/* thanks to symfony for a great base template for phpdoc */ +/* symfony-project.com */ + +#page +{ + width: 99%; +} + +div.credit +{ + font-size: 10px; + color: #888; +} + +.inherited-methods +{ + background-color: #ddd; + font-size: 1.0em; + margin-top: 10px; + width: 100%; +} + +.inherited-methods td +{ + background-color: #FFFFFF; + font-family: "courier new", courier; + font-size: 1.1em; + padding: 5px; +} + +.inherited-methods th +{ + background-color: #F0F0F0; + font-weight: bold; + padding: 5px; + text-align: left; +} + +.method-detail +{ + font-size: 1.0em; +} + +.method-detail a +{ + font-weight: bold; +} + +.method-detail td +{ + font-family: "courier new", courier; + font-size: 1.1em; + padding-top: 10px; + vertical-align: top; +} + +.method-details +{ + background-color: #ddd; + font-size: 1.0em; + width: 100%; +} + +.method-details td +{ + background-color: #FFFFFF; +} + +.method-details td.method-data +{ + padding: 5px; +} + +.method-details h2 +{ + color: #750000; +} + +.method-details th +{ + background-color: #F0F0F0; + font-weight: bold; + font-size: 1.2em; + padding: 5px; + text-align: left; +} + +.method-summary +{ + background-color: #aaa; + font-size: 1.0em; + width: 100%; +} + +.method-summary td +{ + background-color: #FFFFFF; + padding: 5px; +} + +.method-summary td a +{ + font-weight: bold; +} + +.method-summary td.type +{ + font-family: "courier new", courier; + font-size: 1.0em; + text-align: right; + vertical-align: top; +} + +.method-summary div.declaration +{ + font-family: "courier new", courier; + font-size: 1.1em; +} + +.method-summary th +{ + background-color: #F0F0F0; + font-weight: bold; + font-size: 1.2em; + padding: 5px; + text-align: left; +} + +.method-summary th.small +{ + font-size: 1.0em; +} + +.method-summary tr.reference td { + background-color: #FFEDED; +} + + +.constant-details +{ + background-color: #ddd; + font-size: 1.0em; + width: 100%; +} + +.constant-details h3 +{ + color: #750000; +} + +.constant-details td +{ + background-color: #FFFFFF; + padding: 5px; +} + +.constant-details th +{ + background-color: #F0F0F0; + font-weight: bold; + font-size: 1.2em; + padding: 5px; + text-align: left; +} + +.constant-summary +{ + background-color: #ddd; + font-size: 1.0em; + width: 100%; +} + +.constant-summary td +{ + background-color: #FFFFFF; + padding: 5px; +} + +.constant-summary td.name a +{ + font-family: "courier new", courier; + font-size: 1.0em; + font-weight: bold; +} + +.constant-summary td.type +{ + font-family: "courier new", courier; + font-size: 1.0em; +} + +.constant-summary th +{ + background-color: #F0F0F0; + font-weight: bold; + font-size: 1.2em; + padding: 5px; + text-align: left; +} + +.inherited-constants +{ + background-color: #eee; + font-size: 1.0em; + margin-top: 10px; + width: 100%; +} + +.inherited-constants td +{ + background-color: #FFFFFF; + font-family: "courier new", courier; + font-size: 1.1em; + padding: 5px; +} + +.inherited-constants th +{ + background-color: #F0F0F0; + font-weight: bold; + padding: 5px; + text-align: left; +} + +.class-declaration +{ + font-family: "courier new", courier; + font-size: 1.1em; +} + +.class-description +{ + background-color: #F0F0F0; + margin-top: 10px; + padding: 1px 8px 1px 8px; + margin-bottom: 5px; +} + +.inheritence-tree pre +{ + margin-bottom: 0; +} + +.sub-classes h4 +{ + margin: 10px 0 0 0; +} + +.sub-classes div +{ + font-family: "courier new", courier; + font-size: 1.1em; + margin: 5px 0 0 40px; +} + +.sub-classes div small +{ + font-size: 1.0em; +} + diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/style.css b/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/style.css index 9419ca62..918d43e4 100644 --- a/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/style.css +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/style.css @@ -1,197 +1,598 @@ -.php { - padding: 1em; +/** + * PradoSoft profile by Carl G. Mathisen and Stefan A. Petrov + * http://decart.no + */ + +body +{ + text-align: center; } -/* This will not be executed by IE, so now we have a fix! */ -*[class="php-src"], *[class="php"], *[class="listing"] { - line-height: 0px; + +body, div, span, p, input +{ + font-family: Verdana, sans-serif, Arial; + font-size: 10pt; + color: #333333; } -body +h1, h2, h3, h4 { - color: #000000; - background-color: #ffffff; - background-image: url("background.png"); - background-repeat: repeat-y; - font-family: tahoma, verdana, arial, sans-serif; - font-size: 10pt; - margin: 0; - padding: 0; + font-family: Verdana, Helvetica, Arial, Lucida Grande, Trebuchet MS; + padding: 0px; + margin: 0px; + margin-bottom: 10px; + color: #821B18; + font-weight: normal; +} + +h2 +{ + font-size: 18px; +} + +h3 +{ + font-size: 16px; +} + +div +{ + text-align: left; +} + +.instructions +{ + background-color: #EEEEEE; +} + +img +{ + border: none; } a { - color: #000099; - background-color: transparent; - text-decoration: none; + color: #CD2C27; + text-decoration: none; } a:hover { - text-decoration: underline; + color: #821B18; + text-decoration: underline; +} + +#page +{ + margin: 0 auto; + padding: 0; + position: relative; +} + +#header +{ + position: relative; + height: 98px; +} + +#logo +{ + height: 99px; +} + +/* main page */ + +div.intro +{ + height: 190px; + background-image: url('bigmantis.jpg'); + background-repeat: no-repeat; + background-position: top right; + background-color: #fff; +} + +div.statements +{ + height: 135px; + background-image: url('statementsbg.gif'); + background-repeat: repeat-x; + position: relative; + border-bottom : 1px solid #EEE; +} + +div.statements div +{ + position: absolute; + width: 250px; + top: 20px; +} + +div.statements div p +{ + font-size: 13px; + color: #818181; +} + +div.statements div.whatis +{ + left: 20px; +} + +div.statements div.whatreq +{ + left: 290px; +} + +div.statements div.cani +{ + left: 600px; + width: 210px; +} + +/* navbar */ +#navbar +{ + border-bottom: 2px solid #E9EEEF; + height: 30px; + margin-bottom: 20px; +} + +#navbar ul +{ + margin-left: 0; + padding-left: 0; + display: inline; +} + +#navbar ul li +{ + margin-left: 0px; + list-style: none; + display: inline; +} + +#navbar ul li a +{ + display: block; + float: left; + font-size: 14px; + font-weight: bold; + padding-right: 14px; + padding-top: 5px; + color: #CD2B26; + text-decoration: none; + height: 29px; +} + +#navbar ul li a.active, #navbar ul li a.hover +{ + color: #821B18; +} + +/* infobar */ +div#infobar +{ + float: right; + width: 200px; + padding-left: 20px; + border-left: 2px solid #E9EEEF; +} + +div#infobar div +{ + margin-bottom: 20px; +} + +div#infobar div#featured img +{ + margin-top: 10px; +} + +/* articles */ + +div#articles +{ + width: 560px; + float: left; +} + +/* article */ + +div.article +{ + margin-bottom: 40px; +} + +div.article .date +{ + color: #9F9291; +} + +div.article .more +{ + margin-right: 10px; + display: block; + text-align: right; +} + +.logo +{ + position: absolute; + margin-left: 15px; + margin-top: 0px; + z-index: 1; +} + +#main +{ + padding: 20px; + padding-top: 20px; + background-color: #fff; +} + +div.mantis +{ + height: 190px; + background-color: #fff; + border-bottom: 1px solid #DCDCDC; } -a.menu +div.releases { - color: #ffffff; - background-color: transparent; + float: left; + width: 240px; + height: 190px; } -td +div.releases div.official { - font-size: 10pt; + width: 190px; + position: relative; + left: 52px; + top: 128px; + font-size: 8pt; + color: #6D6D6D; } -td.header_top +div.releases div.official a { - color: #ffffff; - background-color: #9999cc; - font-size: 16pt; - font-weight: bold; - text-align: right; - padding: 10px; + display: block; } -td.header_line +div.whyprado { - color: #ffffff; - background-color: #333366; + display: block; + float: left; } -td.header_menu +div.whyprado ul.list { - color: #ffffff; - background-color: #666699; - font-size: 8pt; - text-align: right; - padding: 2px; - padding-right: 5px; + margin-top: 40px; + margin-left: 40px; } -td.menu +div.whyprado ul.list li { - padding: 2px; - padding-left: 5px; + display: block; + margin: 5px; + padding: 0px; + font-size: 18px; + background-repeat: no-repeat; + background-position: bottom left; + padding-left: 30px; + list-style: none; } -td.code_border + +#footer +{ + border-top: 1px solid #e9eeef; + background-color: #fff; + clear: both; + color: #A7A7A7; + font-size: 8pt; + text-align: center; + padding-top: 10px; + padding-bottom: 30px; + background-repeat: repeat-x; + background-position: bottom; +} + +#features +{ + margin-left: 610px; + padding: 10px; + padding-left: 10px; + padding-right: 10px; + background-color: #BEDD75; + color: #344A1E; + font-size: 9pt; +} + +#features ul +{ + margin: 10px; + padding: 0px; +} + +#features ul li +{ + font-size: 8pt; + padding: 0px; + margin: 0px; + margin-top: 8px; +} + +#features h3 +{ + margin: 0px; + padding: 0px; + font-size: 10pt; + color: #292E1D; + text-align: center; + border-bottom: 1px solid silver; +} + +#news +{ + float: left; + width: 590px; +} + +.newstitle +{ + font-size: 12pt; + font-weight: bold; + color: #555; + margin-top: 10px; + margin-bottom: 0px; + border-bottom: 1px solid silver; +} + +.newscontentmore +{ + margin-right: 10px; + display: block; + color: #50811A; + text-align: right; +} + +.newscontentmore:hover { - color: #000000; - background-color: #c0c0c0; + color: red; } -td.code +.newstime { - color: #000000; - background-color: #f0f0f0; + margin: 0px; + font-size:0.8em; + color:#aaa; + padding-left:10px; + text-align: right; } -td.type +.newscontent { - font-style: italic; + margin-top: 5px; } -div.credit +#leftpanel { - font-size: 8pt; - text-align: center; + float: left; + width: 550px; } -div.package +#topics { - padding-left: 5px; + border: 1px solid #804040; + margin-left: 610px; + padding-bottom: 10px; } -div.tags +#topicsheader { - padding-left: 15px; + text-align:center; + font-weight:bold; + background-color:#804040; + color:#FFFFBC; + padding: 3px; + margin-bottom:0px; } -div.function +.topicitem { - padding-left: 15px; + padding: 5px; } -div.top +.topicitem a:hover { - font-size: 8pt; + text-decoration: underline; } -div.warning +.topicitem p { - color: #ff0000; - background-color: transparent; + margin: 0px; + font-size:0.8em; + color:#aaa; + padding-left:10px; + white-space:nowrap; } -div.description +.reference { - padding-left: 15px; } -hr +.reference img { - height: 1px; - border-style: solid; - border-color: #c0c0c0; - margin-top: 10px; - margin-bottom: 10px; + margin: 10px; } -span.smalllinenumber +.reference h3 { - font-size: 8pt; } -ul { - margin-left: 0px; - padding-left: 8px; + +.download +{ + width: 100%; + background-color: #aaa; } -/* Syntax highlighting */ -.src-code { background-color: #f5f5f5; border: 1px solid #ccc9a4; padding: 0px; margin : 0px} -/*.src-code pre { }*/ +.download td +{ + background-color: #FFFFFF; + padding: 5px; + font-size: 9pt; +} -.src-comm { color: green; } -.src-id { } -.src-inc { color: #0000FF; } -.src-key { color: #0000FF; } -.src-num { color: #CC0000; } -.src-str { color: #66cccc; } -.src-sym { font-weight: bold; } -.src-var { } +.download td a +{ + font-weight: bold; +} -.src-php { font-weight: bold; } +.download td.type +{ + font-family: "courier new", courier; + text-align: right; + vertical-align: top; +} -.src-doc { color: #009999 } -.src-doc-close-template { color: #0000FF } -.src-doc-coretag { color: #0099FF; font-weight: bold } -.src-doc-inlinetag { color: #0099FF } -.src-doc-internal { color: #6699cc } -.src-doc-tag { color: #0080CC } -.src-doc-template { color: #0000FF } -.src-doc-type { font-style: italic } -.src-doc-var { font-style: italic } +.download div.declaration +{ + font-family: "courier new", courier; +} -.tute-tag { color: #009999 } -.tute-attribute-name { color: #0000FF } -.tute-attribute-value { color: #0099FF } -.tute-entity { font-weight: bold; } -.tute-comment { font-style: italic } -.tute-inline-tag { color: #636311; font-weight: bold } -/* tutorial */ +.download th +{ + background-color: #F0F0F0; + font-weight: bold; + padding: 5px; + text-align: left; +} -.authors { } -.author { font-style: italic; font-weight: bold } -.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal } -.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; } -.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap; } -.release-info { font-size: 85%; font-style: italic; margin: 1em 0em } -.ref-title-box { } -.ref-title { } -.ref-purpose { font-style: italic; color: #666666 } -.ref-synopsis { } -.title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #9999CC } -.cmd-synopsis { margin: 1em 0em } -.cmd-title { font-weight: bold } -.toc { margin-left: 2em; padding-left: 0em } +.download th.small +{ + font-size: 1.0em; +} + +.download tr.reference td { + background-color: #FFEDED; +} + + +.doc-title +{ + font-size: 14pt; + font-weight: bold; + margin-top: 10px; + margin-bottom: 10px; +} + +.doc-subtitle +{ + font-size: 11pt; + font-weight: bold; + background-color: #EEE; + padding: 5px; + margin-top: 20px; +} +.doc-namespace +{ + font-size: 8pt; +} + + +.doc-menu +{ +} + +.doc-classes +{ +} + +.doc-ancestors +{ + font-size: 8pt; +} + +.doc-properties +{ + font-size: 9pt; +} + +.doc-properties table +{ + border-collapse: collapse; + background-color: silver; + width: 100%; +} + +.doc-properties td, .doc-properties th +{ + padding: 3px; + vertical-align: top; + background-color: white; + border: 1px solid silver; +} + +.doc-events +{ + font-size: 9pt; +} + +.doc-events table +{ + border-collapse: collapse; + background-color: silver; + width: 100%; +} + +.doc-events td, .doc-events th +{ + padding: 3px; + vertical-align: top; + background-color: white; + border: 1px solid silver; +} + +.doc-methods +{ + font-size: 9pt; +} + +.doc-methods table +{ + border-collapse: collapse; + background-color: silver; + width: 100%; +} + +.doc-methods td, .doc-methods th +{ + padding: 3px; + vertical-align: top; + background-color: white; + border: 1px solid silver; +} + +.doc-derived +{ +} + +.doc-inherited +{ +} + +.doc-native td +{ + background-color: lightyellow; +} + +.forum-topic +{ + padding: 10px; + border:1px solid silver; + margin-bottom: 10px; +} diff --git a/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/stylesheet.css b/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/stylesheet.css new file mode 100644 index 00000000..2c08f94f --- /dev/null +++ b/buildscripts/PhpDocumentor/phpDocumentor/Converters/HTML/Smarty/templates/PradoSoft/templates/media/stylesheet.css @@ -0,0 +1,129 @@ +BODY, DIV, SPAN, PRE, CODE, TD, TH { + line-height: 140%; + font-size: 10pt; + font-family: verdana,arial,sans-serif; +} + +H1 { + font-size: 12pt; +} + +H4 { + font-size: 10pt; + font-weight: bold; +} + +P.label { + margin-bottom: 5px; +} +P.dt { + margin-top: 0px; + margin-bottom: 0px; +} +P.indent { + margin-top: 0px; + margin-left: 20px; + margin-bottom: 0px; +} +P.method { + background-color: #f0f0f0; + padding: 2px; + border: 1px #cccccc solid; +} + +A { + text-decoration: none; +} + +A:link{ + color: #336699; +} + +A:visited { + color: #003366; +} + +A:active, A:hover { + color: #6699CC; +} + +A:hover{ + text-decoration: underline; +} + +SPAN.type { + color: #336699; + font-size: xx-small; + font-weight: normal; + } + +PRE { + background-color: #EEEEEE; + padding: 10px; + border-width: 1px; + border-color: #336699; + border-style: solid; +} + +HR { + color: #336699; + background-color: #336699; + border-width: 0px; + height: 1px; + filter: Alpha (opacity=100,finishopacity=0,style=1); +} + +DIV.sdesc { + font-weight: bold; + background-color: #EEEEEE; + padding: 10px; + border-width: 1px; + border-color: #336699; + border-style: solid; +} + +DIV.desc { + font-family: monospace; + background-color: #EEEEEE; + padding: 10px; + border-width: 1px; + border-color: #336699; + border-style: solid; +} + +SPAN.code { + font-family: monospace; +} + +CODE.varsummarydefault{ + padding: 1px; + border-width: 1px; + border-style: dashed; + border-color: #336699; +} + +UL.tute { + margin: 0px; + padding: 0px; + padding-left: 5px; + } + +LI.tute { + line-height: 140%; + font-size: 10pt; + text-indent: -15px; + padding-bottom: 2px; + padding-left: 14px; +} + +.small{ + font-size: 9pt; +} + + +.tute-tag { color: #009999 } +.tute-attribute-name { color: #0000FF } +.tute-attribute-value { color: #0099FF } +.tute-entity { font-weight: bold; } +.tute-comment { font-style: italic } +.tute-inline-tag { color: #636311; font-weight: bold } -- cgit v1.2.3