On 29 Jul 2007, at 18:05, Yen-Ju Chen wrote: > I think we should start to write some user documentation > considering we have several applications already.
I agree. This should be a big priority for 0.3. > Unlike frameworks, it is impossible to generate such documentation > from source code. Randomly thinking aloud, I wonder if you could embed the information in a nib in the same way you embed comments in source files for gsdoc. > So we probably need to write the documentation by hand. > We also need to decide which syntax/tag system to use > and put the html'd version on web site. > In such case, I think we can use etoile's gna web page > (http://home.gna.org/etoile/) > so that all modification can be tracked. Good idea. We ought to use that space for something. I wonder if we can put API docs in there easily too. > Any suggestion for the syntax system (plain html, docbook, ReSt, > etc) ? > To reduce the overhead of having tool, I personally prefer plain HTML > with some CSS. > I think there are suffficient tools out there to convert them into > PDF. > That's pretty much all we need for user documentation. I'd like something that the help viewer can read, and that is easily searchable. RTF seems to be standard for GNUstep, but is no fun to work with. I'd prefer HTML + CSS if we can get SimpleWebKit working (if not, there's an experimental XHTML-IM parser in TRXML that could possibly be used). David _______________________________________________ Etoile-discuss mailing list [email protected] https://mail.gna.org/listinfo/etoile-discuss
