Re: [boost] HTML docs include of examples

From: Greg Colvin (gcolvin_at_[hidden])
Date: 2001-09-15 12:53:38

The 4.0.1 specification provides an OBJECT tag that might do the trick:

       For instance, the following line embeds the contents of embed_me.html
       at the location where the OBJECT definition occurs.

         ...text before...
         <OBJECT data="embed_me.html">
         Warning: embed_me.html could not be embedded.
         </OBJECT>
         ...text after...

       Recall that the contents of OBJECT must only be rendered if the file
       specified by the data attribute cannot be loaded.

       http://www.w3.org/TR/html40/struct/objects.html#embedded-documents
       http://www.w3.org/TR/html40/struct/objects.html#edef-OBJECT

From: Beman Dawes <bdawes_at_[hidden]>
> It would really be nice for Boost Documentation (and a lot of other 
> documentation too) if there was an easy way to be able to compile example 
> code to make sure it is correct.
> 
> One simple way to do this would be to keep the example code in a regular 
> .cpp file.  Then it could be compiled and tested like any other C++ code.
> 
> The documentation HTML file would then need the ability to include the .cpp 
> file as if it were supplied inline.
> 
> Simple.  Effective.
> 
> But HTML doesn't seem to have an equivalent to the C/C++ preprocessor's 
> #include.  Or am I missing something?  (Has to be a client-side include 
> since Boost docs get downloaded and put on local servers which don't have 
> special server-side includes.)
> 
> Surely #include is such a common need someone has figured out how to do it 
> in HTML?  Could it be done with a plug-in?
> 
> --Beman
> 
> 
> Info: http://www.boost.org  Unsubscribe: <mailto:boost-unsubscribe_at_[hidden]> 
> 
> Your use of Yahoo! Groups is subject to http://docs.yahoo.com/info/terms/ 
> 
> 
>