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 +++++ .../PhpDocumentor/phpDocumentor/Setup.inc.php | 2 +- 51 files changed, 2033 insertions(+), 749 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') 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 =
-/code =
+code = +/code =
Caution |
---|
-/caution = |
-/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! = 0 refentry = div -refnamediv =
-/warning = |
{$sdesc}
+ + {if $desc != ""}{$desc}{/if} +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} + | +
Constructor Summary | +|
---|---|
{$methods[method].access} | +
+
+ {$methods[method].function_name}
+ {$methods[method].ifunction_call.params}
+
+
+ {$methods[method].sdesc}
+
+ |
+
Destructor Details | +||
---|---|---|
+
+
+ {$methods[method].function_name}+ +
{$methods[method].sdesc} + + {if $methods[method].desc} + {$methods[method].desc} + {/if} + + {include file="_tags.tpl" tags=$methods[method].tags} + |
+
Destructor Summary | +|
---|---|
{strip} + {$methods[method].access} + {/strip} | +
+ {strip}
+ {$methods[method].function_name}
+ {$methods[method].ifunction_call.params}
+ {/strip}
+
+ {$methods[method].sdesc}
+
+ |
+
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*} + | +
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} + + | +
{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}+
Method Details | +||
---|---|---|
+
+
+
+ {$methods[method].function_name}+ +
{$methods[method].sdesc} + + {if $methods[method].desc} + {$methods[method].desc} + {/if} + {* $methods[method]|print_r *} + + + {* include file="_tags.tpl" tags=$methods[method].tags *} + + |
+
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}
+
+ |
+
-top -
| ||
{$index[index].index[contents].name} | {$index[index].index[contents].listing} |
-{section name=tree loop=$class_tree.classes}{$class_tree.classes[tree]}{$class_tree.distance[tree]}{/section} --{if $tutorial} -
Conflicts with classes:
- {section name=me loop=$conflicts.conflicts}
- {$conflicts.conflicts[me]}
- {/section}
-
-{/if} -Location: {$source_location} -
{$iconsts[iconsts].iconsts[iconsts2].link}
= {$iconsts[iconsts].iconsts[iconsts2].value}
- {$ivars[ivars].ivars[ivars2].link}
= {$ivars[ivars].ivars[ivars2].default}
- {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}+
{$imethods[imethods].imethods[im2].link}
{$classtrees[classtrees].class_tree}
+{$consts[consts].const_name}
= {$consts[consts].const_value|replace:"\n":"
\n"|replace:" ":" "|replace:"\t":" "}
- {$consts[consts].const_value|replace:"\n":"
\n"|replace:" ":" "|replace:"\t":" "}
[line {if $consts[consts].slink}{$consts[consts].slink}{else}{$consts[consts].line_number}{/if}][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} + +{$defines[def].define_name}
= {$defines[def].define_value}
- 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:''}Documentation is available at {$docs}
+