Doc Sprints

Doc sprints are intended to be virtual meetings amongst documentation committers and contributors, where discussion about the documentation project can be held, general PR busting, or other relevant stuff.

August 13, 2012 in #bsddocs on EFnet and at the Open Help Conference.

Attendees

Agenda items

If something you want to discuss is missing, add it here:

* discuss tools introduced at Openhelp: publican (needs to be ported) and ITS tool (already in ports)

Doc PRs

Provide a link to the ones that should be worked on during the sprint here:

Notes

We will use Etherpad again to record notes, todos, open issues, etc.

Used by the Red Hat Engineering Content Services, takes DocBook XML input and outputs HTML, plain Unicode text and PDF and can be custom-branded. Can specify the sections to include in the book, the format, the languages. Creates POT files and will indicate if the src file has changed and needs translating. Can brand (apply your custom style guide) docs with your license, CSS, images, etc.

Install dependencies:

pkg_add -r p5-Config-Simple

pkg_add -r p5-XML-TreeBuilder

pkg_add -r p5-File-Find-Rule

pkg_add -r p5-XML-LibXSLT

pkg_add -r p5-Locale-Maketext-Gettext

pkg_add -r p5-DateTime

pkg_add -r p5-File-Inplace

pkg_add -r p5-File-Copy-Recursive

pkg_add -r p5-File-Locale-PO

pkg_add -r p5-String-Similarity

pkg_add -r p5-File-pushd

pkg_add -r p5-Archive-Zip

pkg_add -r p5-DateTime-Format-DateParse

pkg_add -r p5-TimeDate

pkg_add -r p5-Syntax-Highlight-Engine-Kate

pkg_add -r p5-HTML-Format

pkg_add -r p5-HTML-FormatText-WithLinks

pkg_add -r p5-IO-String

pkg_add -r p5-File-Which

pkg_add -r p5-DBI

pkg_add -r p5-Template-Toolkit

pkg_add -r p5-XML-Simple

pkg_add -r p5-File-HomeDir

p5-HTML-FormatText-WithLinks-AndTables has been added to ports but packages not built yet, use cpan to install it until packages are available

Install publican:

git clone git://git.fedorahosted.org/publican.git

Set env:

setenv PERL5LIB your_path/publican/publican/lib/

to run: perl -CA your_path/publican/publican/bin/publican

use –help after name of command you want help on

Refer to http://jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/ for command usage and how to create a book.