hi,
i think versioned txt or html would do, i don't know any SW which has other (binary) formats. The doc should be in the tarball, then it can be installed with clapf and you could be always sure that you read the doc corresponding to the installed version. On Mon, 28 Dec 2009 21:47:24 +0100, Janos SUTO <s...@acts.hu> wrote: > Dear clapf-users, > > it was a patchy Monday. A few issues needed to be fixed or enhanced. > In the meantime I was thinking about the clapf site (clapf.acts.hu). > > The clapf site includes the latest documentation (only). As I integrate > or implement or change some features I update the documentation to > reflect these changes. > > However you are unlikely to follow the changes as often as I do, so some > portion of the actual docs is not appropriate for you. For instance I > created a shell script to do the statistics related housekeeping (to > update the rrd files, then to create the pngs) instead of calling > several scripts. If I update the docs, then I actually reference to a > utility not available for you unless you are willing to download the > very latest nightly build. > > So I thought, the online docs should be versioned, too. If you look at > the mysql docs site, you can read the docs from 3.23 to 6.0, and > additionally you can append your comment. > > I can think of a few possibilities: > > a) in the clapf tarball: > > - html/ directory with html files > - doc/ directory with txt files > - doc/ directory with a single pdf file > > b) on the clapf site: > > - a single odt file for every release of clapf (from now) > - a single pdf file for every release of clapf (created from the odt > file above) > - doc/html/VERSION/ directory with html files > > > I also thought a wiki might be a good idea, where you can add your own > contribution. The only thing I am not sure that how it fits in the > versioned docs idea. > > So I need your opinion. I would like you to tell me, what documentation > version is the best for you. Feel free to add your idea to the mix. > > Best regards, > Janos -- Péter XMPP, MSN: peter.laszlo.sz...@gmail.com
