DocPerl::Config
POD | CODE

NAME
↑
 C

DocPerl::Config - Details on the configuration setting for the DocPerl application

VERSION
↑
 C

This documentation refers to DocPerl::Config version 1.0.0.

DESCRIPTION
↑
 C

DocPerl's configuration is stored in the file docperl.conf which is an ini style file which is broken into several sections.

Sections C

LocalFolders C

This sets parameters of the local section, these files not found in the @INC path usually setup to be your local working POD files.

Path
A colon seperated list of directories to search for files

Exclude
A colon seperated list of directories to exclude from the search path.

Match
A regular expression to decide which files to include in the list. If not specified it will be created from the suffixes option.

suffixes
Specifies file suffixes that can be to search for specific files. To specify more that one suffix repeat the suffixes option multiple tiems e.g.

 suffixes: pm
 suffixes: pod
 suffixes: pl

IncFolders C

The system wide perl modules section. IncFilders is similar to the LocalFolders execpt Path is added to the global @INC path. Also any module/file starting with pod:: is put into the Perl section on the list page.

Templates C

Sets parameters to be sent to Template Toolkit.

Path
Sets the search path for templates.

history_size
See Template Toolkit documentation.

Template C

This allows you to set general parameters that are passed to all templates.

General C

This section sets up parameters that are used for running DocPerl.

Data
Specifies the location of the data directory where templates and the cache are stored.

Perl
The location of ther perl executable (used when creating POD files).

Cache
Allows you to turn off caching, which can be usefull you do not have permissions to write to the disk.

 'on' or not set Turns on the cache
 'off' turns off caching
ClearCache
Allows a user of the web interface to clear the cache (which is usefull when new modules are installed and the list page is cached and becomes out of date).

 'on' turns on this feature
 anything else turns this off

Note: You probably should not turn this on for publicly available sites as this could cause a lot of extra load on your server.

URL Parameters C

Here is a summary of the url parameters.

page
This effectivly sets which template is to be used as well as what processing needs to be done. Some more important values are:

list
Shows the module list page.

pod
Shows the Plain Old Documentation for the module.

api
Shows the API of the module (includes sub, modules used, module hirachy etc).

code
Syntax highlighted version of the module.

module
Sets the perl module to be displaied. This can be represented in one of two forms: either standard perl form (Config::Std) or as a path from the list page (inc__c__Config__Std). In path from location does not need to be specified.

file
The file on the file system.

location
The section that the file is from (inc,local or perl).

source
The relative perl file path (relative to search paths).

clearcache
Instructs DocPerl to clear it's cache (if allowed).

sidebar
Alters the link taget on the list page so that when the list page is used for a firefox sidebar it displays the pages in the correct place.