Natural Docs

Version 1.0

Settings

Languages:: Language

SymbolDefinition

ReferenceTarget

Parser:: ParsedTopic

Packages and Classes

NaturalDocs:: Settings

A package to handle the command line and various other program settings.

Usage and Dependencies

The Constant Functions can be called immediately.
Prior to initialization, NaturalDocs::Builder must have all its output packages registered.
To initialize, call ParseCommandLine(). All other functions will then be available.

Summary

NaturalDocs:: Settings	A package to handle the command line and various other program settings.
Variables
inputDirectory	The input directory.
projectDirectory	The project directory.
outputFormats	A hash of the output formats and directories being used.
rebuildData	Whether the script should rebuild all data files from scratch.
rebuildOutput	Whether the script should rebuild all output files from scratch.
isQuiet	Whether the script should be run in quiet mode or not.
defaultOutputStyle	The style to be used if an output format doesn’t have its own style specified.
outputStyles	A hash of the output format styles.
Functions
ParseCommandLine	Parses and validates the command line.
PrintSyntax	Prints the syntax reference.
InputDirectory	Returns the input directory.
OutputDirectory	Returns the output directory of an output format.
OutputFormats	Returns a hashref of the output formats and their directories.
OutputStyle	Returns the style associated with an output format.
ProjectDirectory	Returns the project directory.
StyleDirectory	Returns the main style directory.
RebuildData	Returns whether the script should rebuild all data files from scratch.
RebuildOutput	Returns whether the script should rebuild all output files from scratch.
IsQuiet	Returns whether the script should be run in quiet mode or not.
Constant Functions
AppVersion	Returns Natural Docs’ version number as an integer.
TextAppVersion	Returns Natural Docs’ version number as plain text.
AppURL	Returns a string of the project’s current web address.

Variables

inputDirectory

my $inputDirectory

The input directory.

projectDirectory

my $projectDirectory

The project directory.

outputFormats

my %outputFormats

A hash of the output formats and directories being used. The keys are the package names, and the values are their corresponding directories.

rebuildData

my $rebuildData

Whether the script should rebuild all data files from scratch.

rebuildOutput

my $rebuildOutput

Whether the script should rebuild all output files from scratch.

isQuiet

my $isQuiet

Whether the script should be run in quiet mode or not.

defaultOutputStyle

my $defaultOutputStyle

The style to be used if an output format doesn’t have its own style specified.

outputStyles

my %outputStyles

A hash of the output format styles. The keys are the package names, and the values are the style strings. If a package does not have an entry in this hash, it uses defaultOutputStyle.

Functions

ParseCommandLine

sub ParseCommandLine

Parses and validates the command line. Will cause the script to exit if the options ask for the syntax reference or are invalid. Needs to be run before calling any other functions in this package.

PrintSyntax

sub PrintSyntax

Prints the syntax reference.

InputDirectory

sub InputDirectory

Returns the input directory.

OutputDirectory

sub OutputDirectory #

(

package

)

Returns the output directory of an output format.

Parameters

package

The output package.

Returns

The output format directory, or undef if the format wasn’t specified.

OutputFormats

sub OutputFormats

Returns a hashref of the output formats and their directories. The keys are the package names, and the values are their directories. The hashref is not a copy of the data, so don’t change it.

OutputStyle

sub OutputStyle #

(

package

)

Returns the style associated with an output format.

Parameters

package

The output package.

Returns

The style string.

ProjectDirectory

sub ProjectDirectory

Returns the project directory.

StyleDirectory

sub StyleDirectory

Returns the main style directory.

RebuildData

sub RebuildData

Returns whether the script should rebuild all data files from scratch.

RebuildOutput

sub RebuildOutput

Returns whether the script should rebuild all output files from scratch.

IsQuiet

sub IsQuiet

Returns whether the script should be run in quiet mode or not.

Constant Functions

AppVersion

sub AppVersion

Returns Natural Docs’ version number as an integer. Use TextAppVersion() to get a printable version.

TextAppVersion

sub TextAppVersion

Returns Natural Docs’ version number as plain text.

AppURL

sub AppURL

Returns a string of the project’s current web address.