NaturalDocs::Builder::HTML

NaturalDocs::Builder::HTMLBase

A package that generates output in HTML.

All functions are called with Package->Function() notation.

Summary

NaturalDocs::Builder::HTML	A package that generates output in HTML.
Implemented Interface Functions
INIT	Registers the package with NaturalDocs::Builder.
CommandLineOption	Returns the option to follow -o to use this package.
BuildFile	Builds the output file from the parsed source file.
BuildIndex	Builds an index for the passed type.
UpdateMenu	Updates the menu in all the output files that weren’t rebuilt.
Support Functions
UpdateFile	Updates an output file.
UpdateIndex	Updates an index’s output file.

Implemented Interface Functions

INIT

sub INIT

Registers the package with NaturalDocs::Builder.

CommandLineOption

sub CommandLineOption

Returns the option to follow -o to use this package. In this case, “html”.

BuildFile

sub BuildFile #( sourceFile,
parsedFile )

Builds the output file from the parsed source file.

Parameters

sourcefile	The FileName of the source file.
parsedFile	An arrayref of the source file as NaturalDocs::Parser::ParsedTopic objects.

BuildIndex

sub BuildIndex #( type )

Builds an index for the passed type.

Parameters

type	The TopicType to limit the index to, or undef if none.

UpdateMenu

sub UpdateMenu

Updates the menu in all the output files that weren’t rebuilt. Also generates index.html.

Support Functions

UpdateFile

sub UpdateFile #( sourceFile )

Updates an output file. Replaces the menu, HTML title, and footer. It opens the output file, makes the changes, and saves it back to disk, which is much quicker than rebuilding the file from scratch if these were the only things that changed.

Parameters

sourceFile

The source FileName.

Dependencies

Requires <Builder::BuildMenu()> to surround its content with the exact strings “<div id=Menu>” and “</div>”.
Requires <Builder::BuildFooter()> to surround its content with the exact strings “<div id=Footer>” and “</div>”.

UpdateIndex

sub UpdateIndex #( type )

Updates an index’s output file. Replaces the menu and footer. It opens the output file, makes the changes, and saves it back to disk, which is much quicker than rebuilding the file from scratch if these were the only things that changed.

Parameters

type	The index TopicType, or undef if none.