From: Arndt Roger Schneider Date: 2010-03-28T18:30:14+09:00 Subject: Re: Ruby and user documentation Michel Demazure schrieb: >Hi all, > >I just finished a quite large business project (in 1.9, pure ruby, not >Rails, with GUIs in FXRuby). I want to write a documentation for users >(not the code doc, I use Yard for it). Of course I can produce doc files >or PDF files. > >But I'd like to stay in the Ruby ecosystem. What would do suggest ? >Prawn, Sinatra ... ? Do you know examples (with reusable patterns) ? > >Thanks. >_md > > docbook --for all your documentation. + docbook is the default documentation system fro Linux (LDP), gnome, kde. + You are free to use whatever editor or wordprocessor, you like; including: Microsoft Word, Apple Pages, Adobe FrameMaker, OpenOffice (all via Roundtrip). + Offers the best SVG integration for graphics --gnuplot features a SVG backend. + Many target formats such as unix manual pages, texinfo, javadoc, eclipse, htmlhelp, epub, pdf, postscript, printing, SVG (and Flash) , html, xhtml, LaTeX, ... + Converting source code tags for Rdoc or yard into docbook is simple. The markup is handled by the docbook toolchain, all you got to do is analyse the source code commentary --if possible reuse Rdoc or yard for this. I ve done this for Jeszra: http://jeszra.sourceforge.net/jeszra/Jeszra_DocBook.html -roger