DocPerl::Config
POD |CODE
				
			


 1  =head1 NAME
 2  
 3  DocPerl::Config - Details on the configuration setting for the DocPerl application
 4  
 5  =head1 VERSION
 6  
 7  This documentation refers to DocPerl::Config version 1.0.0.
 8  
 9  =head1 DESCRIPTION
 10  
 11  DocPerl's configuration is stored in the file docperl.conf which is an ini
 12  style file which is broken into several sections.
 13  
 14  =head2 Sections
 15  
 16  =head3 LocalFolders
 17  
 18  This sets parameters of the local section, these files not found in the @INC
 19  path usually setup to be your local working POD files.
 20  
 21  =over 4
 22  
 23  =item Path
 24  
 25  A colon seperated list of directories to search for files
 26  
 27  =item Exclude
 28  
 29  A colon seperated list of directories to exclude from the search path.
 30  
 31  =item Match
 32  
 33  A regular expression to decide which files to include in the list. If not
 34  specified it will be created from the suffixes option.
 35  
 36  =item suffixes
 37  
 38  Specifies file suffixes that can be to search for specific files. To
 39  specify more that one suffix repeat the suffixes option multiple tiems e.g.
 40  
 41   suffixes: pm
 42   suffixes: pod
 43   suffixes: pl
 44  
 45  =back
 46  
 47  =head3 IncFolders
 48  
 49  The system wide perl modules section. IncFilders is similar to the
 50  LocalFolders execpt Path is added to the global @INC path. Also any
 51  module/file starting with pod:: is put into the Perl section on the list
 52  page.
 53  
 54  =head3 Templates
 55  
 56  Sets parameters to be sent to L<Template> Toolkit.
 57  
 58  =over 4
 59  
 60  =item Path
 61  
 62  Sets the search path for templates.
 63  
 64  =item history_size
 65  
 66  See L<Template> Toolkit documentation.
 67  
 68  =back
 69  
 70  =head3 Template
 71  
 72  This allows you to set general parameters that are passed to all templates.
 73  
 74  =head3 General
 75  
 76  This section sets up parameters that are used for running DocPerl.
 77  
 78  =over 4
 79  
 80  =item Data
 81  
 82  Specifies the location of the data directory where templates and the cache are
 83  stored.
 84  
 85  =item Perl
 86  
 87  The location of ther perl executable (used when creating POD files).
 88  
 89  =item Cache
 90  
 91  Allows you to turn off caching, which can be usefull you do not have
 92  permissions to write to the disk.
 93  
 94   'on' or not set Turns on the cache
 95   'off' turns off caching
 96  
 97  =item ClearCache
 98  
 99  Allows a user of the web interface to clear the cache (which is usefull when
 100  new modules are installed and the list page is cached and becomes out of
 101  date).
 102  
 103   'on' turns on this feature
 104   anything else turns this off
 105  
 106  Note: You probably should not turn this on for publicly available sites as
 107  this could cause a lot of extra load on your server.
 108  
 109  =back
 110  
 111  =head2 URL Parameters
 112  
 113  Here is a summary of the url parameters.
 114  
 115  =over 4
 116  
 117  =item page
 118  
 119  This effectivly sets which template is to be used as well as what processing
 120  needs to be done. Some more important values are:
 121  
 122  =over 4
 123  
 124  =item list
 125  
 126  Shows the module list page.
 127  
 128  =item pod
 129  
 130  Shows the Plain Old Documentation for the module.
 131  
 132  =item api
 133  
 134  Shows the API of the module (includes sub, modules used, module hirachy etc).
 135  
 136  =item code
 137  
 138  Syntax highlighted version of the module.
 139  
 140  =back
 141  
 142  =item module
 143  
 144  Sets the perl module to be displaied. This can be represented in one of two
 145  forms: either standard perl form (Config::Std) or as a path from the list
 146  page (inc__c__Config__Std). In path from location does not need to be specified.
 147  
 148  =item file
 149  
 150  The file on the file system.
 151  
 152  =item location
 153  
 154  The section that the file is from (inc,local or perl).
 155  
 156  =item source
 157  
 158  The relative perl file path (relative to search paths).
 159  
 160  =item clearcache
 161  
 162  Instructs DocPerl to clear it's cache (if allowed).
 163  
 164  =item sidebar
 165  
 166  Alters the link taget on the list page so that when the list page is used for
 167  a firefox sidebar it displays the pages in the correct place.
 168  
 169  =back
 170  
 171  =cut