Hey all,
I''m considering restructuring of the user documentation for the next
webgen release (developer documentation will be/is already generated
via RDOC).
Currently, all documentation is more or less ''available'' but
not
really connected: there is the basic documentation and the tutorial,
the various reference (meta information reference, WebPage Format
reference, ...) and the plugin documentation; and some important
things are only in the plugin documentation (e.g. information about
Core/FileHandler).
The new documentation should be (I think, comments appreciated!)
structured more like a book with:
1) a quick overview ("5min tutorial")
2) a longer tutorial/documentation showing how webgen works (naming
of input files, output files, metainfo.yaml, config.yaml,...), how
things are done (creating menus, chaining templates, creating a
gallery) and so on
3) a reference part which will include references for all used meta
information, the plugins, the file formats used etc.
The parts 1) and 3) should be fairly easy to create. However, I
haven''t decided on the internal structure of part 2, yet. So, please
post any ideas/comments/etc about part 2 and what you would like to
see in it!
webgen 0.5.0 is coming along fine, the major parts, except the webgen
tags system and the gallery generator, are implemented, documented
(user and developer documentation) and have basic test cases. I plan
to release 0.5.0 at the end of the summer, however, you can already
try it out by checking out the source from the Subversion repository
and using the sources found in the /devel directory. Comments and bug
reports are welcome! :-)
Regards,
Thomas
