phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Packages:
phpDocumentor
Converters

Source for file config.php

Documentation is available at config.php

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <?php
  3. /**
  4.  * phpDocumentor :: docBuilder Web Interface
  5.  * 
  6.  * Advanced Web Interface to phpDocumentor
  7.  *
  8.  * PHP versions 4 and 5
  9.  *
  10.  * Copyright (c) 2003-2006 Andrew Eddie, Greg Beaver
  11.  * 
  12.  * LICENSE:
  13.  * 
  14.  * This library is free software; you can redistribute it
  15.  * and/or modify it under the terms of the GNU Lesser General
  16.  * Public License as published by the Free Software Foundation;
  17.  * either version 2.1 of the License, or (at your option) any
  18.  * later version.
  19.  * 
  20.  * This library is distributed in the hope that it will be useful,
  21.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  23.  * Lesser General Public License for more details.
  24.  * 
  25.  * You should have received a copy of the GNU Lesser General Public
  26.  * License along with this library; if not, write to the Free Software
  27.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  28.  *
  29.  * @package    phpDocumentor
  30.  * @author     Andrew Eddie
  31.  * @author     Greg Beaver <[email protected]>
  32.  * @copyright  2003-2006 Andrew Eddie, Greg Beaver
  33.  * @license    http://www.opensource.org/licenses/lgpl-license.php LGPL
  34.  * @version    CVS: $Id: config.php 234145 2007-04-19 20:20:57Z ashnazg $
  35.  * @filesource
  36.  * @see phpdoc.php
  37.  */
  38.  
  39. if (!function_exists( 'version_compare' )) {
  40.     print "phpDocumentor requires PHP version 4.1.0 or greater to function";
  41.     exit;
  42. }
  43.  
  44. if ('@DATA-DIR@' != '@'.'DATA-DIR@')
  45. {
  46.     $root_dir = 'PhpDocumentor';
  47.     $path = '@WEB-DIR@/PhpDocumentor/docbuilder/images/';
  48.  
  49.     /**
  50.     * common file information
  51.     */
  52.     include_once("PhpDocumentor/phpDocumentor/common.inc.php");
  53.     include_once("@WEB-DIR@/PhpDocumentor/docbuilder/includes/utilities.php" );
  54.  
  55.     // find the .ini directory by parsing phpDocumentor.ini and extracting _phpDocumentor_options[userdir]
  56.     $ini = phpDocumentor_parse_ini_file('@DATA-DIR@/PhpDocumentor/phpDocumentor.ini', true);
  57.     if (isset($ini['_phpDocumentor_options']['userdir'])) {
  58.         $configdir = $ini['_phpDocumentor_options']['userdir'];
  59.     } else {
  60.         $configdir =  '@DATA-DIR@/PhpDocumentor/user';
  61.     }
  62. } else {
  63.     $root_dir = dirname(dirname(__FILE__));
  64.     $path = 'images/';
  65.  
  66.     // set up include path so we can find all files, no matter what
  67.     $GLOBALS['_phpDocumentor_install_dir'] = dirname(dirname( realpath( __FILE__ ) ));
  68.     // add my directory to the include path, and make it first, should fix any errors
  69.     if (substr(PHP_OS, 0, 3) == 'WIN') {
  70.         ini_set('include_path',$GLOBALS['_phpDocumentor_install_dir'].';'.ini_get('include_path'));
  71.     } else {
  72.         ini_set('include_path',$GLOBALS['_phpDocumentor_install_dir'].':'.ini_get('include_path'));
  73.     }
  74.  
  75.     /**
  76.     * common file information
  77.     */
  78.     include_once("$root_dir/phpDocumentor/common.inc.php");
  79.     include_once("$root_dir/docbuilder/includes/utilities.php" );
  80.  
  81.     // find the .ini directory by parsing phpDocumentor.ini and extracting _phpDocumentor_options[userdir]
  82.     $ini = phpDocumentor_parse_ini_file($_phpDocumentor_install_dir . PATH_DELIMITER . 'phpDocumentor.ini', true);
  83.     if (isset($ini['_phpDocumentor_options']['userdir'])) {
  84.         $configdir = $ini['_phpDocumentor_options']['userdir'];
  85.     } else {
  86.         $configdir = $_phpDocumentor_install_dir . '/user';
  87.     }
  88. }
  89.  
  90. // allow the user to change this at runtime
  91. if (!empty( $_REQUEST['altuserdir'] )) {
  92.     $configdir = $_REQUEST['altuserdir'];
  93. }
  94.  
  95. // assign the available converters
  96. $converters = array(
  97.     "HTML:frames:default"            =>    'HTML:frames:default',
  98.     "HTML:frames:earthli"            =>    'HTML:frames:earthli',
  99.     "HTML:frames:l0l33t"            =>    'HTML:frames:l0l33t',
  100.     "HTML:frames:phpdoc.de"            =>    'HTML:frames:phpdoc.de',
  101.     "HTML:frames:phphtmllib"        =>    'HTML:frames:phphtmllib',
  102.     "HTML:frames:phpedit"            =>    'HTML:frames:phpedit',
  103.     "HTML:frames:DOM/default"        =>    'HTML:frames:DOM/default',
  104.     "HTML:frames:DOM/earthli"        =>    'HTML:frames:DOM/earthli',
  105.     "HTML:frames:DOM/l0l33t"        =>    'HTML:frames:DOM/l0l33t',
  106.     "HTML:frames:DOM/phpdoc.de"        =>    'HTML:frames:DOM/phpdoc.de',
  107.     "HTML:frames:DOM/phphtmllib"    =>    'HTML:frames:DOM/phphtmllib',
  108.     "HTML:Smarty:default"            =>    'HTML:Smarty:default',
  109.     "HTML:Smarty:HandS"                =>    'HTML:Smarty:HandS',
  110.     "HTML:Smarty:PHP"               =>    'HTML:Smarty:PHP',
  111.     "PDF:default:default"            =>    'PDF:default:default',
  112.     "CHM:default:default"            =>    'CHM:default:default',
  113.     "XML:DocBook/peardoc2:default"    =>    'XML:DocBook/peardoc2:default'
  114. );
  115.  
  116. // compile a list of available screen shots
  117. $convScreenShots = array();
  118.  
  119. if ($dir = opendir($path)) {
  120.     while (($file = readdir( $dir )) !== false) { 
  121.         if ($file != '.' && $file != '..') {
  122.             if (!is_dir( $path . $file )) {
  123.                 if (strpos( $file, 'ss_' ) === 0) {
  124.                     $key = substr( $file, 3 );
  125.                     $key = str_replace( '_', ':', $key );
  126.                     $key = str_replace( '-', '/', $key );
  127.                     $key = str_replace( '.png', '', $key );
  128.                     $convScreenShots[$key] = $file;
  129.                 }
  130.             }
  131.         }
  132.     }
  133. }
  134.  
  135. ?>
  136. <html>
  137. <head>
  138.     <title>
  139.         Form to submit to phpDocumentor v<?php print PHPDOCUMENTOR_VER; ?>
  140.     </title>
  141.     <style type="text/css">
  142.         body, td, th {
  143.             font-family: verdana,sans-serif;
  144.             font-size: 9pt;
  145.         }
  146.         .text {
  147.             font-family: verdana,sans-serif;
  148.             font-size: 9pt;
  149.             border: solid 1px #000000;
  150.         }
  151.         .small {
  152.             font-size: 7pt;
  153.         }
  154.     </style>
  155.  
  156.     <script src="includes/tabpane.js" language="JavaScript" type="text/javascript"></script>
  157.     <link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="includes/tab.webfx.css" />
  158.  
  159. <script type="text/javascript" language="Javascript">
  160. /**
  161.    Creates some global variables
  162. */
  163. function initializate() {
  164. //
  165. //The "platform independent" newLine
  166. //
  167. //Taken from http://developer.netscape.com/docs/manuals/communicator/jsref/brow1.htm#1010426
  168.     if (navigator.appVersion.lastIndexOf('Win') != -1) {
  169.       $pathdelim="\\";
  170.       $newLine="\r\n";
  171.     } else {
  172.       $newLine="\n";
  173.       $pathdelim="/";
  174.     }
  175. }
  176.  
  177. /**Adds the contents of the help box as a directory
  178. */
  179. function addDirectory($object) {
  180.     //$a = document.helpForm.fileName.value;
  181.     $a = parent.ActionFrame.document.actionFrm.fileName.value;
  182.     $a = myReplace( $a, '\\\\', '\\' );
  183.     if ($a[$a.length - 1] == $pathdelim) {
  184.         $a = $a.substring(0, $a.length - 1);
  185.     }
  186.     if ($a.lastIndexOf('.') > 0) {
  187.         $a = $a.substring(0,$a.lastIndexOf($pathdelim));
  188.     }
  189.     $object.value = prepareString($object.value)+$a;
  190. }
  191. /**Adds the contents of the converter box to the converters list
  192. */
  193. function addConverter($object) {
  194.  $object.value = prepareString($object.value)+document.dataForm.ConverterSetting.value;
  195. }
  196. /**Replaces the converters list with the contents of the converter box
  197. */
  198. function replaceConverter($object) {
  199.  $object.value = document.dataForm.ConverterSetting.value;
  200. }
  201. /**Adds the contents of the help box as a file to the given control
  202. */
  203. function addFile($object) {
  204.     //$a = document.helpForm.fileName.value;
  205.     $a = parent.ActionFrame.document.actionFrm.fileName.value;
  206.     $a = myReplace($a,'\\\\','\\');
  207.     $object.value = prepareString($object.value)+$a;
  208. }
  209. /**Takes a given string and leaves it ready to add a new string
  210.    That is, puts the comma and the new line if needed
  211. */
  212. function prepareString($myString) {
  213.  //First verify that a comma is not at the end
  214.  if($myString.lastIndexOf(",") >= $myString.length-2) {
  215.   //We have a comma at the end
  216.   return $myString;
  217.  }
  218.  if($myString.length > 0) {
  219.   $myString+=","+$newLine;
  220.  }
  221.  return $myString;
  222. }
  223. /**Do the validation needed before sending the from and return a truth value indicating if the form can be sent
  224. */
  225.  function validate() {
  226.   //Take out all newLines and change them by nothing
  227.   //This could be done by using javascript function's replacebut that was implemented only until Navigator 4.0 and so it is better to use more backward compatible functions like substr
  228.   document.dataForm.elements[0].value= stripNewLines(document.dataForm.elements[0].value);
  229.   document.dataForm.elements[1].value= stripNewLines(document.dataForm.elements[1].value);
  230.   document.dataForm.elements[2].value= stripNewLines(document.dataForm.elements[2].value);
  231.   document.dataForm.elements[3].value= stripNewLines(document.dataForm.elements[3].value);
  232.   document.dataForm.elements[4].value= stripNewLines(document.dataForm.elements[4].value);
  233.   document.dataForm.elements[5].value= stripNewLines(document.dataForm.elements[5].value);
  234.   document.dataForm.elements[6].value= stripNewLines(document.dataForm.elements[6].value);
  235.   document.dataForm.elements[7].value= stripNewLines(document.dataForm.elements[7].value);
  236.   //By returning true we are allowing the form to be submitted
  237.   return true;
  238.  }
  239. /**Takes a string and removes all the ocurrences of new lines
  240. Could have been implemented a lot easier with replace but it's not very backwards compatible
  241. */
  242. function stripNewLines( $myString ) {
  243.     return myReplace($myString,$newLine,'');
  244. }
  245.  
  246. function myReplace($string,$text,$by) {
  247.     // Replaces text with by in string
  248.     var $strLength = $string.length, $txtLength = $text.length;
  249.     if (($strLength == 0) || ($txtLength == 0)) {
  250.         return $string;
  251.     }
  252.     var $i = $string.indexOf($text);
  253.     if ((!$i) && ($text != $string.substring(0,$txtLength))) {
  254.         return $string;
  255.     }
  256.     if ($i == -1) {
  257.         return $string;
  258.     }
  259.     var $newstr = $string.substring(0,$i) + $by;
  260.     if ($i+$txtLength < $strLength) {
  261.         $newstr += myReplace($string.substring($i+$txtLength,$strLength),$text,$by);
  262.     }
  263.     return $newstr;
  264. }
  265.  
  266. var screenShots = new Array();
  267. <?php
  268.     $temp = array();
  269.     foreach ($converters as $k=>$v) {
  270.         if (array_key_exists( $k, $convScreenShots )) {
  271.             echo "\nscreenShots['$k'] = '{$convScreenShots[$k]}'";
  272.         } else {
  273.             echo "\nscreenShots['$k'] = ''";
  274.         }
  275.     }
  276. ?>
  277.  
  278.  
  279. /** Swaps the converted screen shot image
  280. */
  281.     function swapImage( key ) {
  282.         document.screenshot.src = 'images/' + screenShots[key];
  283.     }
  284.  
  285. </script>
  286.  
  287. </head>
  288.  
  289. <body bgcolor="#ffffff" onload="javascript:initializate()" topmargin="0" leftmargin="0" marginheight="0" marginwidth="0">
  290.  
  291. <!-- onsubmit="return validate()"  -->
  292.  
  293. <form name="dataForm" action="builder.php" method="get" target="OutputFrame">
  294.  
  295. <div class="tab-pane" id="tabPane1">
  296. <script type="text/javascript">
  297.     var tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
  298. </script>
  299.     <div class="tab-page" id="tab_intro">
  300.         <h2 class="tab">Introduction</h2>
  301.         Welcome to <b>docBuilder</b>.
  302.         <p>This is the new web-interface for running, in our opinion, the best in-code documentation compiler there is: <b>phpDocumentor</b>.</p>
  303.         <p>What's new in this release?  Heaps of things, but here are the headlines:</p>
  304.         <ul>
  305.             <li>Much greater support for PEAR on both windows and linux</li>
  306.             <li>CHM, PDF and XML:DocBook/peardoc2 converters are all stable!</li>
  307.             <li>New tokenizer-based parser is literally twice as fast as the old parser (requires PHP 4.3.0+)</li>
  308.             <li>New external user-level manual parsing and generation allows cross-linking between API docs and DocBook-format tutorials/manuals!</li>
  309.             <li>Color syntax source highlighting and cross-referencing with documentation of source code in HTML, CHM and PDF with customizable templating</li>
  310.             <li>New Configuration files simplify repetitive and complex documentation tasks</li>
  311.             <li>Brand new extensive manual - which can be generated directly from the source using makedocs.ini!</li>
  312.             <li>Many improvements to in-code API documentation including new tags, and better handling of in-code html tags</li>
  313.             <li>New XML:DocBook/peardoc converter makes generating PEAR manual formats easy for PEAR developers along with the --pear command-line switch</li>
  314.             <li>Many new HTML templates, all of them beautiful thanks to Marco von Ballmoos</li>
  315.             <li>A brand new web interface thanks to Andrew Eddie!</li>
  316.         </ul>
  317.     </div>
  318.  
  319.     <div class="tab-page" id="tab_config">
  320.         <h2 class="tab">Config</h2>
  321.         <table cellspacing="0" cellpadding="3" border="0">
  322.         <tr>
  323.             <td colspan="2"><b>Use a pre-created config file for form values.</b></td>
  324.         </tr>
  325.         <tr>
  326.             <td nowrap="nowrap">
  327.                 <b>change config directory:</b>
  328.             </td>
  329.             <td width="100%">
  330.                 <input size="20" type="text" name="altuserdir" value="" /><input type="SUBMIT" value="Change" name="submitButton" onclick="document.dataForm.target='DataFrame'; document.dataForm.action = 'config.php';document.dataForm.submit();">
  331.         <?php
  332.             if (!empty($_REQUEST['altuserdir'])) {
  333.                 print '<br><i>changed to <b>"'.$_REQUEST['altuserdir'].'"</b></i>';
  334.             }
  335.         ?>
  336.             </td>
  337.         </tr>
  338.         <tr>
  339.             <td nowrap="nowrap">
  340.                 <b>Choose a config:</b>
  341.             </td>
  342.             <td>
  343.  
  344.                 <select name="setting_useconfig">
  345.                       <option value="" <?php if (empty($_REQUEST['altuserdir'])) print 'selected'; ?>>don't use config file</option>
  346.                       <?php
  347.                       $dirs = array();
  348.                       $dirs = phpDocumentor_ConfigFileList($configdir);
  349.                       $path = '';
  350.                       $sel = ' selected';
  351.                       if (!empty($_REQUEST['altuserdir'])) $path = $configdir . PATH_DELIMITER;
  352.                       else $sel = '';
  353.                       foreach($dirs as $configfile)
  354.                       {
  355.                           print '<option value="'.$path.$configfile.'"'.$sel.'>'.$configfile.".ini</option>\n";
  356.                           $sel = '';
  357.                       }
  358.                       ?>
  359.                 </select>
  360.                 <input type="SUBMIT" value="Go" name="submitButton">
  361.             </td>
  362.         </tr>
  363.         <tr>
  364.             <td colspan="2">
  365.                 Normally, phpDocumentor uses the form values from this form to set up parsing.  In version 1.2, phpDocumentor allows you to "save" form values in configuration files so that you can replicate common complicated documentation tasks with only one time.  Just choose a config file below or create a new one and refresh this page to choose it.
  366.             </td>
  367.         </tr>
  368.         </table>
  369.     </div>
  370.  
  371.     <div class="tab-page" id="tab_files">
  372.         <h2 class="tab">Files</h2>
  373.         <table cellspacing="0" cellpadding="3" border="0">
  374.         <tr>
  375.             <td align="right" valign="top" nowrap="nowrap">
  376.                 <b>Files<br />to parse</b>
  377.                 <br />
  378.                 <a href="javascript:addFile(document.dataForm.setting_filename)" title="Add the file in the help box">
  379. <?php
  380.     echo showImage( 'images/rc-gui-install-24.png', '24', '24' );
  381. ?></a>
  382.             </td>
  383.             <td valign="top">
  384.                 <textarea rows="5" cols="60" name="setting_filename" class="text"></textarea>
  385.             </td>
  386.             <td valign="top" class="small">
  387.                 This is a group of comma-separated names of php files or tutorials that will be processed by phpDocumentor.
  388.             </td>
  389.         </tr>
  390.         <tr>
  391.             <td align="right" valign="top" nowrap="nowrap">
  392.                 <b>Directory<br />to parse</b>
  393.                 <br />
  394.                 <a href="javascript:addFile(document.dataForm.setting_directory)" title="Add the file in the help box">
  395. <?php
  396.     echo showImage( 'images/rc-gui-install-24.png', '24', '24' );
  397. ?></a>
  398.             </td>
  399.             <td valign="top">
  400.                 <textarea rows="5" cols="60" name="setting_directory" class="text" title=""></textarea>
  401.             </td>
  402.             <td valign="top" class="small">
  403.                 This is a group of comma-separated directories where php files or tutorials are found that will be processed by phpDocumentor. phpDocumentor automatically parses subdirectories
  404.             </td>
  405.         </tr>
  406.         <tr>
  407.             <td align="right" valign="top" nowrap="nowrap">
  408.                 <b>Files<br />to ignore</b>
  409.                 <br />
  410.                 <a href="javascript:addFile(document.dataForm.setting_ignore)" title="Add the file in the help box">
  411. <?php
  412.     echo showImage( 'images/rc-gui-install-24.png', '24', '24' );
  413. ?></a>
  414.             </td>
  415.             <td valign="top">
  416.                 <textarea rows="5" cols="60" class="text" name="setting_ignore"></textarea>
  417.             </td>
  418.             <td valign="top" class="small">
  419.                 A list of files (full path or filename), and patterns to ignore.  Patterns may use wildcards * and ?.  To ignore all subdirectories named "test" for example, using "test/"  To ignore all files and directories with test in their name use "*test*"
  420.             </td>
  421.         </tr>
  422.         <tr>
  423.             <td align="right" valign="top" nowrap="nowrap">
  424.                 <b>Packages<br />to parse</b>
  425.             </td>
  426.             <td valign="top">
  427.                 <textarea rows="4" cols="60" class="text" name="setting_packageoutput"></textarea>
  428.             </td>
  429.             <td valign="top" class="small">
  430.                 The parameter packages is a group of comma separated names of abstract packages that will be processed by phpDocumentor. All package names must be separated by commas.
  431.             </td>
  432.         </tr>
  433.         </table>
  434.     </div>
  435.  
  436.  
  437.     <div class="tab-page" id="tab_output">
  438.         <h2 class="tab">Output</h2>
  439.         <table cellspacing="0" cellpadding="3" border="0">
  440.         <tr>
  441.             <td align="right" valign="top" nowrap="nowrap">
  442.                 <b>Target</b>
  443.                 <br />
  444.                 <a href="javascript:addFile(document.dataForm.setting_target)" title="Add the file in the help box">
  445. <?php
  446.     echo showImage( 'images/rc-gui-install-24.png', '24', '24' );
  447. ?></a>
  448.             </td>
  449.             <td valign="top">
  450.                 <input type="text" name="setting_target" size="60" class="text" />
  451.             </td>
  452.             <td valign="top" class="small">
  453.                 Target is the directory where the output produced by phpDocumentor will reside.
  454.             </td>
  455.         </tr>
  456.         <tr>
  457.             <td align="right" valign="top" nowrap="nowrap">
  458.                 <b>Output<br />Format</b>
  459.             </td>
  460.             <td valign="top">
  461.                 <textarea cols="60" rows="3" name="setting_output" class="text">HTML:Smarty:default</textarea>
  462.                 <br />
  463.                 Output type:Converter name:template name
  464.                 <br />
  465. <?php
  466.     echo htmlArraySelect( $converters, 'ConverterSetting', 'size="1" class="text" onchange="swapImage(this.options[this.options.selectedIndex].value);"', 'HTML:Smarty:default' );
  467. ?>
  468.                 <br />
  469.                 <a href="javascript:addConverter(document.dataForm.setting_output)">
  470.                     Add the converter in the help box
  471.                 </a>
  472.                 <br />
  473.                 <br />
  474.                 <img name="screenshot" src="images/ss_HTML_Smarty_default.png" width="200" height="200" border="2" alt="Screen Shot">
  475.             </td>
  476.             <td valign="top" class="small">
  477.                 Outputformat may be HTML, XML, PDF, or CHM (case-sensitive) in version 1.2.
  478.                 <br />There is only one Converter for both CHM and PDF:<br /><i>default</i>.
  479.                 <br />There are 2 HTML Converters:<br /><i>frames</i> or <i>Smarty</i>.
  480.                 <br /><b>frames templates</b> may be any of:
  481.                 <br />
  482.                 <i>default, earthli, l0l33t, phpdoc.de, phphtmllib, phpedit, DOM/default, DOM/earthli, DOM/l0l33t, DOM/phphtmllib, or DOM/phpdoc.de</i>.
  483.                 <br />
  484.                 <b>Smarty templates</b> may be any of:
  485.                 <br />
  486.                 <i>default, HandS, or PHP</i>
  487.                 <br />
  488.                 <strong>XML:DocBook/peardoc2:default</strong> is the only choice for XML in 1.2.2
  489.             </td>
  490.         </tr>
  491.         </table>
  492.     </div>
  493.  
  494.     <div class="tab-page" id="tab_options">
  495.         <h2 class="tab">Options</h2>
  496.         <table cellspacing="0" cellpadding="3" border="0">
  497.         <tr>
  498.             <td align="right" nowrap="nowrap">
  499.                 <b>Generated Documentation Title</b>
  500.             </td>
  501.             <td>
  502.                 <input type="text" name="setting_title" size="40" value="Generated Documentation" class="text">
  503.             </td>
  504.             <td class="small">
  505.                 Choose a title for the generated documentation
  506.             </td>
  507.         </tr>
  508.         <tr>
  509.             <td nowrap="nowrap">
  510.                 <b>Default Package Name</b>
  511.             </td>
  512.             <td>
  513.                 <input type="TEXT" name="setting_defaultpackagename" size="40" value="default" class="text" />
  514.             </td>
  515.             <td class="small">
  516.                 Choose a name for the default package
  517.             </td>
  518.         </tr>
  519.         <tr>
  520.             <td nowrap="nowrap">
  521.                 <b>Default Category Name</b>
  522.             </td>
  523.             <td>
  524.                 <input type="TEXT" name="setting_defaultcategoryname" size="40" value="default" class="text" />
  525.             </td>
  526.             <td class="small">
  527.                 Choose a name for the default category.  This is only used by the peardoc2 converter
  528.             </td>
  529.         </tr>
  530.         <tr>
  531.             <td nowrap="nowrap">
  532.                 <b>Custom Tags</b>
  533.             </td>
  534.             <td>
  535.                 <input type="text" name="setting_customtags" size="40" class="text" />
  536.             </td>
  537.             <td class="small">
  538.                 Custom Tags is a comma-separated list of tags you want phpDocumentor to include as valid tags in this parse.  An example would be 'value, size' to allow @value and @size tags.
  539.             </td>
  540.         </tr>
  541.         <tr>
  542.             <td nowrap="nowrap">
  543.                 <b>Parse @access private and @internal/{@internal}}</b>
  544.             </td>
  545.             <td nowrap="nowrap">
  546.                 <input type="checkbox" name="setting_parseprivate" value="on" />
  547.             </td>
  548.             <td class="small">
  549.                 The parameter Parse @access private tells phpDocumentor whether to parse elements with an '@access private' tag in their docblock.  In addition, it will turn on parsing of @internal tags and inline {@internal}} sections
  550.             </td>
  551.         </tr>
  552.         <tr>
  553.             <td nowrap="nowrap">
  554.                 <b>Generate Highlighted Source Code</b>
  555.             </td>
  556.             <td nowrap="nowrap">
  557.                 <input type="checkbox" name="setting_sourcecode" value="on" />
  558.             </td>
  559.             <td class="small">
  560.                 The parameter Generate Highlighted Source Code tells phpDocumentor whether to generate highlighted XRef source code similar to PHP-XRef output.
  561.             </td>
  562.         </tr>
  563.         <tr>
  564.             <td nowrap="nowrap">
  565.                 <b>JavaDoc-compliant<br />Description parsing.</b>
  566.             </td>
  567.             <td>
  568.                 <input type="checkbox" name="setting_javadocdesc" value="on" />
  569.             </td>
  570.             <td class="small">
  571.                 Normally, phpDocumentor uses several rules to determine the short description.  This switch asks phpDocumentor to simply search for the first period (.) and use it to delineate the short description.  In addition, the short description will not be separated from the long description.
  572.             </td>
  573.         </tr>
  574.         <tr>
  575.             <td nowrap="nowrap">
  576.                 <b>PEAR package repository parsing</b>
  577.             </td>
  578.             <td>
  579.                 <input type="checkbox" name="setting_pear" value="on" />
  580.             </td>
  581.             <td class="small">
  582.                 PEAR package repositories have specific requirements:
  583.                 <ol>
  584.                     <li>Every package is in a directory with the same name.</li>
  585.                     <li>All private data members and methods begin with an underscore (function _privfunction()).</li>
  586.                     <li>_Classname() is a destructor</li>
  587.                 </ol>
  588.                 This option recognizes these facts and uses them to make assumptions about packaging and access levels.  Note that with PHP 5, the destructor option will be obsolete.
  589.             </td>
  590.         </tr>
  591.         </table>
  592.     </div>
  593.  
  594.     <div class="tab-page" id="tab_credits">
  595.         <h2 class="tab">Credits</h2>
  596.         phpDocumentor written by Joshua Eichorn
  597.         <br />Web Interface originally written by Juan Pablo Morales, enhanced by Greg Beaver and super-charged by Andrew Eddie
  598.         <p>
  599.         Joshua Eichorn <a href="mailto:[email protected]">[email protected]</a>
  600.         <br>Juan Pablo Morales <a href=
  601.         "mailto:[email protected]">[email protected]</a>
  602.         <br>Gregory Beaver <a href=
  603.         "mailto:[email protected]">[email protected]</a>
  604.         <br>Andrew Eddie <a href=
  605.         "mailto:[email protected]">[email protected]</a>
  606.         </p>
  607.         <p>
  608.         If you have any problems with phpDocumentor, please visit the website: 
  609.         <a href='http://phpdoc.org'>phpdoc.org</a>, or 
  610.         <a href="http://pear.php.net/bugs/search.php?cmd=display&package_name[]=PhpDocumentor&status=Open">
  611.         submit a bug at PEAR</a>.
  612.         </p>
  613.         <!-- Created: Tue Jun 26 18:52:40 MEST 2001 -->
  614.         <!-- hhmts start -->
  615.         <pre>
  616.         Last modified: $Date: 2007-04-19 15:20:57 -0500 (Thu, 19 Apr 2007) $
  617.         Revision: $Revision: 234145 $
  618.         </pre>
  619.     </div>
  620.     <div class="tab-page" id="tab_links">
  621.         <h2 class="tab">Links</h2>
  622.         <ul>
  623.             <li><a target="_top" href="http://www.phpdoc.org/manual.php">phpDocumentor manual</a> - Learn how to use phpDocumentor to document your PHP source code</li>
  624.             <li><a target="_top" href="http://pear.php.net/package/PhpDocumentor/">phpDocumentor homepage</a> on PEAR</li>
  625.             <li><a target="_top" href="http://phpdocu.sourceforge.net/">phpDocumentor homepage</a> on SourceForge</li>
  626.             <li><a target="_top" href="http://freshmeat.net/projects/phpdocu">Freshmeat record</a> - subscribe here</li>
  627.         </ul>
  628.     </div>
  629. </div>
  630. <input type="hidden" name="interface" value="web">
  631. <input type="hidden" name="dataform" value="true">
  632.  
  633. </form>
  634.  
  635. <script type="text/javascript">
  636.  
  637.     tp1.addTabPage( document.getElementById( "tab_intro" ) );
  638.     tp1.addTabPage( document.getElementById( "tab_config" ) );
  639.     tp1.addTabPage( document.getElementById( "tab_files" ) );
  640.     tp1.addTabPage( document.getElementById( "tab_output" ) );
  641.     tp1.addTabPage( document.getElementById( "tab_options" ) );
  642.     tp1.addTabPage( document.getElementById( "tab_credits" ) );
  643.     tp1.addTabPage( document.getElementById( "tab_links" ) );
  644.     setupAllTabs();
  645. </script>
  646.  
  647. </body>
  648. </html>
Documentation generated on Tue, 06 Dec 2011 07:10:46 -0600 by phpDocumentor 1.4.4