On 8/7/05, Quentin Mathé <[EMAIL PROTECTED]> wrote: > Le 7 août 05 à 01:47, Yen-Ju Chen a écrit : > > > I am thinking to supply document for Etoile > > in TiddlyWiki format (http://www.tiddlywiki.com/). > > It is a self-contained html/css format. > > It looks good not only for README, INSTALL, > > but also for help document. > > > > Any comment ? > > Why not. It looks really flexible when you take in account is > lightweight implementation. My plan was to use reStructuredText for > documentation, because it is more readable/editable than docbook et > rather easy to transform to other wiki or xml derived markup. > > About reStructuredText : > <http://docutils.sourceforge.net/rst.html> > <http://www-128.ibm.com/developerworks/library/x-matters24/> > > If TiddlyWiki was supporting reStructuredText markup it would be > ideal, but we may write documentation in reStructuredText and > transform it in TiddlyWiki format… or we can use TiddlyWiki alone > even if the syntax is a bit less friendlier and versatile than > reStructuredText. What's your opinion ?
I always prefer not to add more work of maintaince at this stage. Although the markup of TiddlyWiki may not be perfect, it is still good for README and INSTALL now. My philosophy is always "easier is better, not perfect is better". :D The text format of README is still good for people who just want to know what this application/framework is for and install it quickly. So I will still keep a text format of README for introduction, install, website and maintainer. Others will go to TiddlyWiki if the markup can handle them. Yen-Ju > > Quentin. > > -- > Quentin Mathé > [EMAIL PROTECTED] > > > _______________________________________________ > Etoile-dev mailing list > [email protected] > https://mail.gna.org/listinfo/etoile-dev >
