Changes for version 0.14 - 2002-08-19

  • added two examples that one can play with which demonstrate all the DocSet features: o examples/site/ - the shrinked version of perl.apache.org o examples/presentation - a package for generating slides/handouts
  • support local docset options, which can set command line options for the scope of the current docset and below it.
  • support the automatic page-break insertion in the slides-mode (-e)
  • make the index_node's meta.id and meta.stitle attributes available to the templates
  • fix the html title rendering, not to have <a href="" name=""> as some older browsers crush on that, use <a href=""></a><a name=""></a> instead
  • in each document verify that there are no duplicated anchors and croak if there are.
  • added the croak method to the rendering class, so if there is a problem the context is dumped (the problematic source file).
  • croak if the config file includes both: grouped and non-grouped items.
  • added docset id duplication checking, the program will croak when a duplication is detected and report the offending config file and the config file it was previous seen in.
  • fix a bug with properly setting doc.dir.abs_doc_root, for the docs in the very root e.g, src/404.html.
  • added a new special attribute: 'changes', which points to a hidden chapter including changes for each docset (if such exists). this is an improvement over the inclusion of the changes.pod or alike along with all other chapters because usually people don't want to see changes and when the docset pdf is created huge changes files can be an unwanted burden, so now if this attribute is included, the pdf for the docset won't include this file in it.
  • overload Carp.pm's subs in Config.pm and when die'ing or warn'ing start dumping the relevant object attributes, like the used config file, to aid the problem analysis.
  • provide a fix for File::Spec->abs2rel for WIN32 [Per Einar Ellefsen <per.einar@skynet.be>]
  • improve the parsing of the E<lt>headE<gt> and make base, meta and link elements available to the templates. [Per Einar Ellefsen <per.einar@skynet.be>]
  • correct the mapping of config.cfg to autogenerated index.html, also use path2uri to convert from a path to uri. also fix the stripping of the full base path on the non unix system, by using abs2rel from File::Spec.
  • implement the splitting of the long E<lt>preE<gt> text only in DocSet::Doc::POD2HTMLPS's view_verbatim, where it's needed. Use the simple view_verbatim() in DocSet::Doc::POD2HTML.
  • must always use '/' when generating URIs, that means that fs paths from OS like Win32 cannot be used as is. So we use the OS specific splitdir to get rid of the separators and join the dirs with '/'.
  • fix a bug with resolving L<> when not the minimal lenght link is used, also solved a parallel bug with resolving links to ::index
  • skip empty lines in preamble, when extracting pod
  • provide the same data for the ps/index template as it was provided for html/index
  • change the <pre> rule generator, to do all the formatting work in the stylesheet. plus add a new line in front of <pre> so the text browsers will present it nicely.
  • if the <pre> section is too long ps2pdf fails to generate pdf, so split it into 40 lines chunks.
  • sitemap is now correctly highlighted in the menu when selected

Documentation

a script that does documentation projects building in HTML, PS and PDF formats

Modules

documentation projects builder in HTML, PS and PDF formats
perl 5.005_03 compatibility module
Maintain a Non-Volatile Cache of DocSet's Data
A superclass that handles object's configuration and data
A Base Document Class
Common functions used in DocSet::Doc subclasses
HTML source to HTML target converter
HTML source to PS (intermediate HTML) target converter
POD source to HTML target converter
POD source to PS (intermediate HTML) target converter
Text source to HTML target converter
An abstract docset generation class
A subclass of DocSet::DocSet for generating HTML docset
A subclass of DocSet::DocSet for generating PS/PDF docset
Navigate the DocSet's caches in a readonly mode
RunTime Configuration
A class for parsing input document in the HTML format
A class for parsing input document in the POD format
A class for parsing input document in the text format
Commonly used functions

Provides

in lib/DocSet/Doc/POD2HTML.pm
in lib/DocSet/Doc/POD2HTMLPS.pm
in lib/DocSet/Template/Plugin/NavigateCache.pm
in lib/DocSet/5005compat.pm

Examples