Because it's quite simple, fully reflects project goal and sounds good :)
Note, that playout has nothing in common with broadcasting, amateurs radios, etc. The word "playout" is originated and formed from words page and layout.
So, this project deals with a XSLT, required to get production ready output (mostly PDFs) for DocBook/XML documents with a design-approved page layouts in mind.
Short answer: to make things easy.
Long answer (it's a real longread - you have been warned :)
The author of the docbook pretty playout project is a technical writer/documentation engineer by profession. He primary uses DocBook/XML as a source for documentation (of course, he sometimes also uses lightweight markup languages like asciidoc, ReStructured text, Markdown).
DocBook toolchain includes and mostly relies on the DocBook XSL Stylesheets - free, open source set of .xsl
files for making transformation from source .xml
to a target formats. The latter include print output (PDFs), online presentation output (HTMLs), gadget-friendly output (ePub) and much more. Despite the DocBook XSL Stylesheets cover nearly all features of DocBook source format (i.e. conditions/profiling, content reuse, gentexts, all kinds of documentation components - TOC, tables indexes, figures, etc), they are quite complicated in nature.
If we talk about print output (technical documentation PDFs), the result using a default stylesheets is quite basic from a visual presentation and design points of view (despite it covers nearly all DocBook advanced features). This phenomenon is well explained due to a creators and maintainers of DocBook XSL Stylesheets are developers by nature.
Of course, alot of people would say that DocBook is for a technical documentation and there is nothing with design there. But...
- We all (as customers) want to look at good designed documentation, that is easy to read, good to look at, easy to navigate in... rather than the poor one.
- And we (as technical writers) want to deliver to our customers best-class documentation not only from a content and accuracy points of view, but from a presentation one too.
Someone can say that a presentation forms and publications delivery methods are changed so fast that the print output have been outdated already. But there are still and will be many segments where a print documentation (in a form of an electronically delivered .pdf
files) is and will be the most reliable and usable one. Curious, what exact segment is it? The answer is obvious and quite simple - it is a corporate segment.
So, to summarize all the above information there are two problems exist:
- using default out-of-box print-related output is quite unpretty as a deliverables;
- any customization requires efforts that any novice users can't afford either from the point of skills, or from the point of time.
The primary goal of the project is to provide any newcomer to a DocBook or even to a seasoned DocBook user an affordable way to get a pretty, design-approved print output for the full spectrum of technical documentation exists: manuals, marketing brochures, whitepapers, etc.
The secondary goal is to provide a some kind of construction kit for any DocBook user to get a custom documents WITH a design layout in mind. The idea behind this project is a main ready-to-use design plus easy alternation gears within design-approved boundaries.
As for results:
-
rendered PDF documents that use quality design are ready out-of-box and available for a bunch of a technical documentation varieties (manuals, whitepapers, marketing "one-pager" and "two-pager" brochures, etc.);
-
users get a some kind of a construction kit that they can use for theirs own projects to get own customized patterns with a lower efforts but with a design in mind.
Just drop me a line to [email protected] with a "docbook pretty playout" in subject line. I'm very curious to hear about your usage of docbook pretty playout.