[ Index ] |
PHP Cross Reference of Eventum |
[Summary view] [Print] [Text view]
1 # 2 # Eventum configuration file for phpxref v0.7 3 # 4 # Be sure to read the README.html file for information 5 # on using PHPXref 6 7 # The base directory containing all of your PHP code to be indexed 8 # This could just be a directory containing symlinks to the real directories 9 SOURCE=. 10 11 # The directory in which you'd like the output to be written 12 OUTPUT=../phpxref/eventum 13 14 # Project name; something short 15 PROJECT=Eventum 16 17 # Cookie key - If you have multiple phpxref projects on the same server 18 # (or on your local machine) then things like the search history will 19 # benefit from having a different key here for each project 20 # It can be any short string; as long as it's unique 21 COOKIE=phpxref 22 23 # Name of the HTML file to prepend to the output 24 HEADERFILE=/usr/share/phpxref/sample_header.html 25 26 # Name of the HTML file to append to the output 27 FOOTERFILE=/usr/share/phpxref/sample_footer.html 28 29 # Names of the stylesheets to copy into the output tree 30 STYLEFILE=sample.css 31 PRINTSTYLEFILE=sample-print.css 32 33 # Character set to specify for generated HTML 34 CHARSET=UTF-8 35 36 # Directories, relative to SOURCE, to search for files that have been 37 # require()'d or include()'d 38 # ie. works in a similar way to PHP's php_include_path variable 39 INCLUDEPATH=.:/include:/ 40 41 # Filenames beginning with a period will be ignored if this is set 42 NO_HIDDEN=1 43 44 # File extension to use on output pages 45 EXTENSION=html 46 47 # Set to 1 and install the IO::Zlib perl module to compress all output 48 # pages. Requires a correctly configured web server to serve the 49 # resulting files. 50 COMPRESS=0 51 52 # Set to 1 to link email and web addresses in the summary pages 53 # This is potentially a cross-site-scripting (XSS) security hole 54 # if you're running phpxref on untrusted source code 55 LINK_URI=1 56 57 # Set to 1 to have links in the file explorer open the 58 # PHP source page, rather than the summary page 59 EXPLORE_SOURCE=0 60 61 # Cross-reference all mentions of source filenames, not just 62 # those in require/include statements 63 # If you find this is too aggressive/verbose, try turning it off 64 FULLXREF=1 65 66 # File containing a list of PHP functions, one per line 67 FUNCTIONLIST=/usr/share/phpxref/php4_functionlist.txt 68 69 # Set this to 0 to enable "traditional" style function comments 70 # (ie. those that begin with '////' used with old versions of 71 # phpxref) 72 NO_TRAD_DOC=1 73 74 # Don't index files listed in these directories 75 # You can have multiple BAD_DIRNAME entries if necessary 76 BAD_DIRNAME=CVS 77 BAD_DIRNAME=SCCS 78 BAD_DIRNAME=.svn 79 BAD_DIRNAME=.DS_Store 80 BAD_DIRNAME=phpxref 81 82 # Don't index files matching this whole path 83 BAD_PATHNAME=/config 84 BAD_PATHNAME=/include/Smarty 85 BAD_PATHNAME=/include/jpgraph 86 BAD_PATHNAME=/include/pear 87 BAD_PATHNAME=/include/php-gettext 88 BAD_PATHNAME=/locks 89 BAD_PATHNAME=/logs 90 BAD_PATHNAME=/misc/cli/include 91 BAD_PATHNAME=/misc/localization 92 BAD_PATHNAME=/misc/upgrade 93 BAD_PATHNAME=/templates 94 BAD_PATHNAME=/templates_c 95 96 # Ignore files with this filename. Multiple entries are allowed 97 #BAD_FILENAME=local.inc 98 99 # Ignore files with this extension. Multiple entries are allowed 100 BAD_EXT=bz2 101 BAD_EXT=gz 102 BAD_EXT=zip 103 BAD_EXT=exe 104 BAD_EXT=bin 105 BAD_EXT=dat 106 BAD_EXT=core 107 BAD_EXT=gif 108 BAD_EXT=jpg 109 BAD_EXT=png 110 BAD_EXT=prc 111 BAD_EXT=tgz 112 BAD_EXT=ico 113 114 # If you'd rather specify which extensions to *include*, instead of 115 # which to *exclude* (via bad_ext above) then use GOOD_EXT instead: 116 # GOOD_EXT=php 117 # GOOD_EXT=phtml 118 119 # Specify which tags you wish to show up along with function/class 120 # descriptions 121 # use multiple DOC_TAG entries if you wish to list more than one tag 122 DOC_TAG=author 123 DOC_TAG=param 124 DOC_TAG=return 125 DOC_TAG=returns 126 127 # Specify which tags you wish to show up for file descriptions 128 # in the file summary page 129 DOC_FILE_TAG=author 130 DOC_FILE_TAG=license 131 DOC_FILE_TAG=copyright 132 DOC_FILE_TAG=version 133 134 # Configuration options to let phpxref obtain information about SQL tables 135 # referenced in your comments. Note this only works with MySQL for the moment 136 137 # Change this to YES to enable this feature 138 # NOTE - This will not work on Windows if you're using the .exe version of PHPXref 139 DB_USE=NO 140 DB_HOST=localhost 141 DB_PORT=3306 142 DB_NAME=mydb 143 DB_USER=dbuser 144 DB_PASS=dbpassword 145 146 # If the code you are trying to cross reference uses constants or 147 # variable names when require()ing or include()ing other PHP files 148 # then you can tell phpxref what those constants/variables should 149 # be set to here 150 # Failing to set this will just cause links between different files 151 # to be missed in situations such as require(HORDE_TEMPLATES.'something.inc') 152 # 153 # to set $templates='foo' just do templates='foo' below. 154 APP_CONFIG_PATH=/config/ 155 APP_INC_PATH=/include/ 156 APP_JPGRAPH_PATH=/include/jpgraph/ 157 APP_PATH=/ 158 APP_PEAR_PATH=/include/pear/ 159 APP_SETUP_FILE=/config/setup.php 160 APP_SMARTY_PATH=/include/Smarty/
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
Generated: Wed Dec 19 21:21:33 2007 | Cross-referenced by PHPXref 0.7 |