RE: [boost] Re: Reference documentation: one approach

From: David Bergman (davidb_at_[hidden])
Date: 2002-11-03 18:38:44

Dave,

So, you do not think the visualization was nice and clear...

The lines were too wide in the previous graph, sorry about the headache
caused by trying to decypher the broken graph.

I will try again without shorter lines:

 +---------+                                                  
 | Doxygen |--------+                                      +---------+
 +---------+        |                                   +->| (X)HTML |
                    v                                   |  +---------+
 +----------+    +---------+               +---------+  |    +-----+  
 | ReStText |--> | C++ XML |-->(merger)--> | DocBook |--+--->| TeX |-+
 +----------+    +---------+     A         +---------+  |    +-----+ |
                    ^            |                      |  +----+    |
 +----------+       |            |                      +->| FO |-+  |
 | Synopsis |-------+            |                         +----+ |  |
 +----------+                    |                                V  V
                                 |                           +--------+
 +-----------+         +---------+                           | PS/PDF |
 | Developer |-------> | C++ XML |                           +--------+
 +-----------+         +---------+

The "merger" process is either a document merger (through XSL) or a
semantic coupling with XPath or other means. The end effect is to have a
link (HREF, \ref or similar) in the end document leading the reader to
the code reference section.

/David

-----Original Message-----
From: boost-bounces_at_[hidden]
[mailto:boost-bounces_at_[hidden]] On Behalf Of David Abrahams
Sent: Sunday, November 03, 2002 5:00 PM
To: Boost mailing list
Subject: Re: [boost] Re: Reference documentation: one approach

"David Bergman" <davidb_at_[hidden]> writes:

> Dave writes (there are too many Davids here ;-):
> 
> > As someone with little experience in this area, I have to say I have
> no clue what you're driving at. Could you > clarify?
> 
> I try to clarify again with a graph (partly stolen from Doug, thanks):
> 
>  +---------+                                                  
>  | Doxygen |--------+
> +---------+
>  +---------+        |                                         +----->|
> (X)HTML |
>                     v                                         |
> +---------+
>  +----------+    +---------+               +-------------+    |
> +-----+    +--------+
>  | ReStText |--> | C++ XML |-->(merger)--> | DocBook XML |----+----->|

> TeX |--->| PS/PDF |
>  +----------+    +---------+     A         +-------------+    |
> +-----+    +--------+
>                     ^            |                            |
> +----+         |
>  +----------+       |            |                            +----->|
> FO |---------+
>  | Synopsis |-------+            |
> +----+
>  +----------+                    |
>                                  |
>  +-----------+         +---------+
>  | Developer |-------> | C++ XML |
>  +-----------+         +---------+

Hmm, maybe you could re-clarify without line breaks?

-- 
                    David Abrahams
dave_at_[hidden] * http://www.boost-consulting.com
_______________________________________________
Unsubscribe & other changes:
http://lists.boost.org/mailman/listinfo.cgi/boost