Pod & DocBook

Jozef

DocBook

"The Source for Documentation"

• documentation?
• everyone needs one
• no one relly enjoy to write one
• it's not that easy to start to use it - no "main stream editor", just a lot of tags definitions laying around on web
• after it's setup, it's easy to write and generate different formats - PDF, HTML, ...

Pod

the Plain Old Documentation format

• every (?) Perl developer is aware and it's easy to use
• =head1, =head2, =cut, L<>
  know-how is just enough to write it
• probably doesn't need introduction || justification

Pod + DocBook

CPAN has:

• Pod::DocBook 0.05
  (Alligator Descartes - latest release 03 Apr 1999)
• Pod::DocBook 1.2
  (Nandu Shah - latest release 16 Mar 2004
  
  ** UNAUTHORIZED RELEASE **
  )
  MIA
• Pod::2::DocBook 0.01
  (Jozef Kutej - latest release 02 Jul 2008)
  + Paul Fenwick, + Yanick Champoux

Pod::2::DocBook - Why

Why?

• allow to create DocBook sections from Pod that can be xincluded to the main documentation file
• developers continue with Pod, "writers" can write the "sauce"
• has a DocBook documentation ;-) (doc/)
• has "source" for it's documentation (examples/pod2docbook-docbook)

Pod::2::DocBook doc/

let's see how it look like

• Pod-2-DocBook.html
• Pod-2-DocBook.pdf

Pod::2::DocBook example

examples/pod2docbook-docbook/

• in version >= 0.02_01
• apt-get install docbook-utils psutils docbook-xml docbook-xsl xsltproc fop make
• cd Pod-2-Docbook/examples/pod2docbook-docbook/
• make Pod-2-DocBook.html
• make Pod-2-DocBook.pdf
• let's try/see it...

Pod::2::DocBook@?

• Pod::2::DocBook@CPAN
• Pod::2::DocBook@Ohloh

And that's it...

Questions?