Hey all,
> 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]{...}
>
I like this idea and wouldn't mind playing around with the idea.
> 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. :)
Unfortunately, I am not skilled in the ways of LaTeX. I have tried to
do it before but sort of fell on my face doing it :). I have to say, I
do like writing in a way that is like coding, much in the way I like
drawing with code (GraphViz). At any rate, I'll start looking into it.
Forward me any good LaTeX references you may have that can help me.
// Dean Glazeski
_______________________________________________
Openocd-development mailing list
[email protected]
https://lists.berlios.de/mailman/listinfo/openocd-development
