Jan Iven > Pod-DocBook > Pod::DocBook

Download:
Pod-DocBook-0.06.tar.gz

Dependencies

Annotate this POD (1)

Related Modules

Pod::Usage
Pod::Pdf
Pod::LaTeX
more...
By perlmonks.org

CPAN RT

New  2
Open  2
View/Report Bugs
Module Version: 0.06   Source  

NAME ^

Pod::DocBook - module to convert pod files to DocBook SGML

SYNOPSIS ^

    use Pod::DocBook;
    pod2docbook( [options] );

DESCRIPTION ^

Converts files from pod format ( see perlpod ) to DocBook format. It can automatically generate indexes (but SGML does this better) and cross-references.

ARGUMENTS ^

Pod::DocBook takes the following arguments:

help
    --help

Displays the usage message.

infile
    --infile=name

Specify the pod file to convert. Input is taken from STDIN if no infile is specified.

outfile
    --outfile=name

Specify the SGML file to create. Output goes to STDOUT if no outfile is specified.

title
    --title=title

Specify the title of the resulting SGML file.

no-header
    --no-header

Doesn't write a default header out for the DTD.

no-footer
    --no-footer

Doesn't write a default footer out for the DTD.

custom-header
    --custom-header=file

Read DTD header from a file.

custom-footer
    --custom-footer=file

Read footer from a file.

root-id
    --root-id

Specifies the root identifier for the base element used in the new SGML document. The default is the part of the NAME header before '-' or some short version of the full NAME header or something loosely resembling the filename or pod2docbook-ch-1 if none of the above is defined.

verbose
    --verbose

Display progress messages.

style
    --style=article|book|chapter_in_book

Use 'article' or 'book' instead of default (chapter_in_book) style (i.e. toplevel markup is sect1, not chapter; headers are different)

firstsect
    --firstsect=n

Start with <lt>sect n<gt> as the top level tag. Mainly useful for including the docbook file into other SGML files. Use with --no-header, --no-footer, otherwise the result will likely violate the docbook DTD.

LINKS ^

This release features some support for L<> tag links. Basically anything within a single POD document should work. External links are guessed and may of course fail. You'll need to put together all of your converted PODs in order for SGML links to work. Since the Id-attributes of entities are loosely based on filename and entity name, you may get namespace conflicts. Internal links should still work, but there is little chance for you to reach these entities automatically from the outside.

EXAMPLE ^

    pod2docbook( "pod2docbook", "--infile=foo.pod", 
                 "--outfile=/perl/nmanual/foo.sgml" );

AUTHOR ^

Alligator Descartes <descarte@arcana.co.uk> from the original pod2html source code by Tom Christiansen, <tchrist@perl.com>, for it is he. Many thanks to Chris Maden of O'Reilly & Associations for doing serious road-testing on this module.

Jan Iven <jiven@gmx.de<gt> fixed a few things and had a shot at L<> tags.

BUGS ^

Has trouble with C<> etc in = commands.

LIMITATIONS ^

There seems to be some kind of item linking using the C<> tag. Since according to perlpod item links are done with the C<> tag, this is not supported here.

SEE ALSO ^

perlpod

COPYRIGHT ^

This program is distributed under the Artistic License.

syntax highlighting: