On Tue, 2009-05-19 at 22:50 -0500, Dean Glazeski wrote:
> Hey all,
>
> I ran into this during my random googlings: oocd-quickreference. I
> was thinking, this might be something cool to put together as part of
> the next release. I'd be willing to help kick it off, just wanted to
> see what people though.
I like these ideas: both the reference guide and the fact that you are
willing to help work on it. :)
To one-up it (as is my wont), it would be nice to produce a set of LaTeX
documents that could produce either 1) a complete reference of the TCL
command set or 2) a quick reference, depending on the surrounding
context that the core .tex file gets applied:
doc/user_ref/full_guide.tex
doc/user_ref/quick_guide.tex
doc/user_ref/parts/*.tex
The 'parts' would be included by the first two, in the appropriate
places, with each defining different commands for defining the commands.
For example, the top-level files could define different versions of
\newcommand{\oocdCmdName}[1]{...}
\newcommand{\oocdCmdBriefDesc[1]{...}
\newcommand{\oocdCmdFullDesc[1]{...}
The quick reference would simply define its version of the last to drop
any provided content from its output, whereas the full reference would
integrate it by providing the appropriate formatting. The result would
produce two different works that are positively in-sync with each other,
without any duplication of documentation effort (and less mechanical
redundancy in the documentation itself, once you grok the above syntax).
What do you think? Do you know LaTeX? I love it for making writing
more like coding. :)
Cheers,
Zach
_______________________________________________
Openocd-development mailing list
[email protected]
https://lists.berlios.de/mailman/listinfo/openocd-development
