OODoc::Format::Html - Produce HTML pages using OODoc::Template
OODoc::Format::Html is an OODoc::Format is an OODoc::Object
my $doc = OODoc->new(...); $doc->createManual ( 'html' # or 'OODoc::Format::Html' , format_options => [show_examples => 'NO'] );
Create manual pages in the HTML syntax, using the OODoc::Template template system. Producing HTML is more complicated than producing POD, because one manual page may be spread over multiple output files.
Extends "DESCRIPTION" in OODoc::Format.
Extends "OVERLOADED" in OODoc::Format.
Extends "METHODS" in OODoc::Format.
Extends "Constructors" in OODoc::Format.
-Option --Defined in --Default html_meta_data '' html_root '/' html_stylesheet undef jump_script <html_root>/jump.cgi manifest OODoc::Format undef project OODoc::Format <required> version OODoc::Format <required> workdir OODoc::Format <required>
Will be (usually) be added to the header, and may contain links to Cascading Style Sheets, and such.
Adds a link to the stylesheet to the meta-data.
Extends "Inheritance knowledge" in OODoc::Format.
Inherited, see "Inheritance knowledge" in OODoc::Object
Extends "Attributes" in OODoc::Format.
Inherited, see "Attributes" in OODoc::Format
Returns (optionally after setting) the $manual which is being processed.
Extends "Page generation" in OODoc::Format.
Inherited, see "Page generation" in OODoc::Format
The general cleanup() is over eager: it turns all pieces of text into paragraphs. So things, like names of chapters, are not paragraphs at all: these simple strings are to be cleaned from paragraph information.
-Option --Defined in --Default append OODoc::Format undef format_options OODoc::Format [] manual OODoc::Format <required> project OODoc::Format <required> template "html/manual/"
A DIRECTORY containing all template files which have to be filled-in and copied per manual page created. You may also specify an HASH of file- and directory names and format options for each of those files. These options overrule the general createManual(format_options) values and the defaults. These options can be overruled by values specified in the template file.
example: template specification
Default:
template => "html/manual/"
Complex:
template => { "man_index/" => [ show_examples => 'NO' ] , "man_main.html" => [ show_examples => 'EXPAND' ] }
-Option --Defined in --Default process OODoc::Format qr/\.(s?html|cgi)$/ source OODoc::Format "html/other/"
Translate a filename, directory name or hash with file/directory names which are specified as $location for templates into hash of filenames names and related formatting options. The $format is an array of options which can be overruled by values which the $location is specified as hash.
example: expanding template specification into files
my $exp = $self->expandTemplate("html/manual", [show => 'NO']); while(my ($fn,$opts) = each %$exp) {print "$fn @$opts\n"} # may print something like # index.html show NO # main.html show NO my $exp = $self->expandTemplate( { "html/manual/index.html" => [show => 'YES'] "html/manual/main.html" => [] } , [show => 'NO']); # will print something like # index.html show YES # main.html show NO
Create the html for a link which refers to the $object. The link will be shown somewhere in the $manual. The $text is displayed as link, and defaults to the name of the $object.
Write a marker to items file. This locates an item to a frameset.
-Option--Default header <required> output <required> rows <required>
An array of arrays, each describing a row for the output. The first row is the header.
-Option--Default manual undef
The name of the distribution which contains the manual page at hand.
The index template is called with one keyword, which tells the kind of index to be built. Valid values are MANUALS, SUBROUTINES, DIAGNOSTICS, and DETAILS. In the future, more names may get defined.
MANUALS
SUBROUTINES
DIAGNOSTICS
DETAILS
The tag produces a list of columns which should be put in a table container to produce valid html.
-Option --Default starting_with 'ALL' table_columns 2 type 'ALL'
Only selects the objects which have names which start with the STRING (case-insensitive match). Underscores in the string are interpreted as any non-word character or underscore.
Produce a table with that number of columns.
The types of objects which are to be selected, which is not applicable to all kinds of indexes. The STRING may contain an underscore or pipe separated list of types, for instance method|tie when subroutines are listed or error for diagnostics.
method|tie
error
example: use of the template tag "index"
<table cellspacing="10"> <!--{index DIAGNOSTICS type => error, starting_with => A}--> </table>
-Option --Default manual <required> show_sections 'LINK' show_subroutines 'LIST' subroutine_types 'ALL'
This option is only used when a chapter name is specified. It tells how to treat sections within the chapter: must they be shown expanded or should the subroutines be listed within the chapter.
The LIST contains a underscore separated set of subroutine types which are selected to be displayed, for instance method_tie_function. The separator underscore is used because Template::Magic does not accept commas in the tag parameter list, which is a pity.
method_tie_function
ARGS is a reference to a hash with options. ZONE contains the attributes in the template. Use new(html_meta_data) to set the result of this method, or extend its implementation.
The version is taken from the manual (which means that you may have a different version number per manual) when a manual is being formatted, and otherwise the project total version.
Extends "Commonly used functions" in OODoc::Format.
Inherited, see "Commonly used functions" in OODoc::Object
Extends "Manual Repository" in OODoc::Format.
Inherited, see "Manual Repository" in OODoc::Object
Somewhere was specified to use $name (a file or directory) as source for a template. However, it does not seem to exist. Unfortunately, the location where the source is specified is not known when the error is produced.
In your template file, a {chapter} statement is used, which is erroneous, because it requires a chapter name.
A call to addManual() expects a new manual object (a OODoc::Manual), however an incompatible thing was passed. Usually, intended was a call to manualsForPackage() or mainManual().
In your template file, an {index} statement is used without a chapter name or 'ALL'. Therefore, it is unclear which kind of index has to be built.
This module is part of OODoc distribution version 2.02, built on December 08, 2021. Website: http://perl.overmeer.net/oodoc/
Copyrights 2003-2021 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it under the Artistic license. See http://dev.perl.org/licenses/artistic.html
To install OODoc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OODoc
CPAN shell
perl -MCPAN -e shell install OODoc
For more information on module installation, please visit the detailed CPAN module installation guide.