This is the mail archive of the
guile@sourceware.cygnus.com
mailing list for the Guile project.
Re: Schemey markup (was Re: Doc Tasks)
"Greg J. Badros" <gjb@cs.washington.edu> writes:
>
> I'm all for the shorthand, but that should just be shorthand that gets
> expanded into full SGML markup and when we need to do something a little
> less common. E.g., in Scwm we have:
>
> SCWM_PROC(scwm_path_exec_prefix, "scwm-path-exec-prefix", 0, 0, 0,
> (),
> "Return the <envar>$EXEC_PREFIX</envar> directory that scwm was
> installed with.")
Shell environment variable or lexical environment variable? >;')
If we are using shorthand, then it could be easily expanded into
either if we just use a small set of neutral tags. Using a set of tags
we've devised ourselves to satisfy the (very spartan) needs of
docstrings means that we aren't making generation of either harder out
of principle or personal preference; really, would it be that bad to
make that @envar{$EXEC_PREFIX} (which also, btw, won't need anything
special to allow you to check that the tag is balanced in most
editors).
--
Gregh: or (\envar $EXEC_PREFIX), or something totally not like either
sgml or texinfo, so that it doesn't look like anybody got their way ;)