On 9.06.05, Jean-Marc Lasgouttes wrote: > >>>>> "chr" == chr <[EMAIL PROTECTED]> writes: > > chr> Going off on a slight tangent, what if we put some cursory > chr> documentation of the lfuns in the *source* code using wiki > chr> markup? T > I'd propose to use the exact inverse method: maintain the lfun > documentation outside of source tree in an easy to parse format, so > that we can decide to merge it in the sources later :) > I guess this can be done from outside as a documentation project. If > the file format is straightforward enough, it could even be made > available from inside LyX.
*Pro* of a "with source" documentation is, that it is provided by the people knowing what is going on. And its (at least in theory) easier to keep the documentation in sync. It could take the form of a "standardized comment" format. *Pro* of an external documentation project is, that the work can be shared and maybe the documentation becomes more consistent. Howver, with CVS also a "documentator" could initalize "in source" documentation easily. In both cases I would go for an simple csv (actually rather TAB separated) format. This could be converted into wiki page and lfuns.lyx by scripts. Currently, my lfuns.txt file has just 2 columns # Command string Synopsis # -------------- --------- appendix Insert appendix apropos Describe command backward-select bibtex-database-add ... IMHO, it needs an additional column with info about function arguments. Also, LyXAction.C contains a "column" for tags (is there an explanation of these tags somewhere?) G�nter -- G.Milde web.de
