Stas Bekman > DocSet-0.19 > DocSet::Doc

Download:
DocSet-0.19.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

DocSet::Doc - A Base Document Class

SYNOPSIS ^

   # e.g. a subclass would do
   use DocSet::Doc::HTML2HTML ();
   my $doc = DocSet::Doc::HTML2HTML->new(%args);
   $doc->scan();
   my $meta = $doc->meta();
   my $toc  = $doc->toc();
   $doc->render();

   # internal methods
   $doc->src_read();
   $doc->src_filter();

DESCRIPTION ^

This super class implement core methods for scanning a single document of a given format and rendering it into another format. It provides sub-classes with hooks that can change the default behavior. Note that this class cannot be used as it is, you have to subclass it and implement the required methods listed later.

METHODS ^

ABSTRACT METHODS ^

These methods must be implemented by the sub-classes:

retrieve_meta_data

Retrieve and set the meta data that describes the input document into the meta object attribute. Various documents may provide different meta information. The only required meta field is title.

These methods can be implemented by the sub-classes:

src_filter

A subclass may want to preprocess the source document before it'll be processed. This method is called after the source has been read. By default nothing happens.

AUTHORS ^

Stas Bekman <stas (at) stason.org>

syntax highlighting: