Natural Docs
Version 1.2
Natural Docs
Packages
Objects
Languages
Output Formats
Extensions
Documentation
Indexes
Web Site

NaturalDocs:: Builder:: HTML

NaturalDocs::Builder::HTMLBase
NaturalDocs::Builder::HTML

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

sourcefileThe name of the source file.
parsedFileAn arrayref of the source file as NaturalDocs::Parser::ParsedTopic objects.

BuildIndex

sub BuildIndex #(type)

Builds an index for the passed type.

Parameters

typeThe type 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

sourceFileThe source file.

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

typeThe index type, or undef if note.
Copyright © 2003-2004 Greg Valure.  Generated by Natural Docs.
A base package for all the shared functionality in NaturalDocs::Builder::HTML and NaturalDocs::Builder::FramedHTML.
sub INIT
Registers the package with NaturalDocs::Builder.
A package that takes parsed source file and builds the output for it.
sub CommandLineOption
Returns the option to follow -o to use this package.
sub BuildFile #(sourceFile,
parsedFile)
Builds the output file from the parsed source file.
sub BuildIndex #(type)
Builds an index for the passed type.
sub UpdateMenu
Updates the menu in all the output files that weren’t rebuilt.
sub UpdateFile #(sourceFile)
Updates an output file.
sub UpdateIndex #(type)
Updates an index’s output file.
A class for parsed topics of source files.