> First of all, libextl-mkexports in libextl already does the parsing,
> and you could extend it with a simple output format that fits your needs,
> basically copying the current documentation output and replacing LaTeX
> with something else. With that you can find all functions meant to be
> used by the configuration editing user or the scripter. You will want to
> filter out some of them that aren't actions the basic user could be
> interested in. This inludes all marked with EXTL_SAFE.
Okay, I took a look at the latex-output stuff in libextl-mkexports and
it should be easy enough to modify that to a new format. Would you
prefer the output to be similar to the defdescription() format I
showed above, or would you rather an intermediate format that is less
specific (something like: bdoc("WScreen.switch_nth(_, 1)", "Switch to
1st screen")) and then I could convert to the format I need from
there.
> However, If you want simple concise documentation for the end user, I don't
> think the documentation in the source is the place to look for it. It is
> meant to be detailed enough to be useful for the scripter. I'd rather
> bootstrap the description files with the bdoc(...) docs in the current
> configuration files. It should be quite easy to write such a bootstrap
> script. You'll probably want to modify some of the descriptions that
> encompass multiple bindings to apply to only single description., just like
> switch_nth in your example. As I mentioned earlier, this description file
> might later became the source for geneating Ion manual pages as well, and
> the bdoc stuff be removed (replaced with normal comments).
Just to make sure we are on the same page: You think it would be best
to modify libextl-mkexports to output to a new description file. Then
use the current bdocs() in cfg_bindings.lua to try to fill out as many
descriptions as possible. And then this new description format would
be edited to fill in any missing descriptions. From then on (if
everyone was happy with the format) new descriptions would just be
entered in this description file, and bdoc abandoned. Does that sound
right?
--
Zachary P. Landau <[EMAIL PROTECTED]>
