More equation woes.....

Some more experimentation reveals that:

* IE9 will only support the MathJax scripts if the script is loaded from a 
subdirectory of the one containing the HTML (a non-starter) otherwise you 
get a security warning (which I missed the first time), and if you either 
miss the warning or just follow IE9's advice and block the script then all 
the equations disappear 
* I tried using SVG's instead of MathML or Tex, and Oh dear that's as bad 

Yes IE9 supports SVG's, but in order for a graceful fallback be provided for 
earlier IE users you have to use <object> tags - that's OK that's what the 
Docbook stylesheets generate - except IE9 (and only IE9) won't then display 
either the SVG or the fallback image unless the image has explicit width and 
height attributes.  If that's not bad enough, IE and all the other browsers 
handle the width and height attributes differently.   I'm mean seriously 
what the &&^%$$ does MS think it's doing here?  Anyhow, I simply can't find 
a magic combination of factors that works on all the browsers... possibly 
removing the width/height attributes from the SVG and adding them to the 
HTML only would work (just checked it does work - but content gets blocked 
by default, and breaks PDF generation, besides how do you know what 
attributes to use once they're gone from the SVG?  Two sets of SVG's 
maybe?????), having the attributes on both just totally screws up the IE 
display BTW.   Likewise using <embed> doesn't help at all.

Sorry for the rant, but really, there's no way this should be this hard!

Anyhow, if anyone wants to play, I've committed an equation test page to the 
test project under doc/test.  Just don't use IE.

Still looking for ideas yours, John. 

Experimenting with equation (MathJax) support

I've been experimenting with the tentative equation handling support in 
Trunk, and have some observations:

* There's no docs.... took me a while to figure out what to do...
* I added quickbook markup as follows to doc/test/test.qbk to test both 
LaTex and MathML support:

[section Equations]

This equation is formatted from Latex text:

'''<inlinemediaobject><textobject role="tex">ax^2 + bx + c = 
0</textobject></inlinemediaobject>'''

This equation is formed from MathML:

'''<inlinemediaobject><textobject role="MathML"><?dbhtml-include 
href="test.mml"?></textobject></inlinemediaobject>'''

[endsect]

Then I modified the Jamfile to add an xsl:path attribute so that test.mml 
could be found in the current directory, and everything builds OK, raw HTML 
output looks OK to.

* The equations are both rendered correctly in Firefox, but MathJax support 
is only present in the HTML if a Tex object is present - I guess some change 
to our XSL stylesheets is required for the latter (and that I can't set the 
role to "tex" as the HTML output won't be correct)?
* IE9 renders neither equation correctly - is this a fatal flaw, or is there 

[quickbook] Why doesn't this work?

I'm rather confused.. I keep trying to use templates to reduce some of 
the repetition in doing the tree TR proposal. And I ran into a strange 
error. I've reduced my problem down to this code:

   [template tr_ref[id] [link [id] tr]]
   [tr_ref hierarchy.req]

It produces this error:

   x.qbk:2: error: Mismatched code bracket

The error happens on the use of the template. If the template isn't used 
it's fine. And if the template is changed to this:

   [template tr_ref[id] [link id tr.[id]]]
   [tr_ref hierarchy.req]

No error happens. Any idea what's going on?

Rene.

--

-- 
-- Grafik - Don't Assume Anything
-- Redshift Software, Inc. - http://redshift-software.com
-- rrivera/acm.org (msn) - grafik/redshift-software.com
-- 102708583/icq - grafikrobot/aim,yahoo,skype,efnet,gmail

How to build the documentation

Hi

I created a small patch for libs/python/doc/tutorial/doc/tutorial.qbk

How can I check that it builds correctly and generates propper html?

Regards.

Pedro.

Index: libs/python/doc/tutorial/doc/tutorial.qbk
===================================================================
--- libs/python/doc/tutorial/doc/tutorial.qbk	(revision 76153)
+++ libs/python/doc/tutorial/doc/tutorial.qbk	(working copy)
@@ -1302,6 +1302,22 @@
 [def PyModule_GetDict       [@http://www.python.org/doc/current/api/moduleObjects.html#l2h-594   PyModule_GetDict]]

 [endsect]
+
+[section Creating boost::python::object from PyObject*]
+
+When you want a boost::python::object to manage a pointer to PyObject* pyobj one does:
+
+    boost::python::object o(boost::python::handle<>(pyobj));
+
+In this case, the o object, manages the pyobj, it won’t increase the reference count on construction.
+
+Otherwise, to use a borrowed reference:
+

Preventing private member functions from appearing in the doxygen reference info

I'm struggling to stop private member functions from appearing in the Doxygen reference section of
Quickbook generated stuff.

private member functions do not appear in the Standalone Doxygen docs, and I've tried to set the
corresponding <doxygen:param> settings in the jamfile.

<doxygen:param>EXTRACT_ALL=NO
    <doxygen:param>EXTRACT_PRIVATE=NO
    <doxygen:param>EXTRACT_STATIC=NO <doxygen:param>HIDE_UNDOC_MEMBERS=YES 
 <doxygen:param>HIDE_UNDOC_MEMBERS=YES
 <doxygen:param>HIDE_UNDOC_CLASSES=YES

but I'm still getting the private members listed.

Please can anyone confirm that they have seen this working as expected, supressing private members?

(This will confirm that I am missing something).

Or any others suggestions on tracing this?

Thanks

Paul

---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
+44 1539 561830  07714330204
pbristow <at> hetp.u-net.com

[Quickbook] How to control the layout of a table?

How is the layout of a table controlled? Vertical alignment,
horizontal alignment, border size, cell padding, cell spacing, width,
background color, etc.

How can the special handling of the first row be suppressed?

How are columns or rows spanned?

--Beman

Quickbook glob includes..

I've just checked in the ability to "[include *.qbk]" multiple files at 
once. This is in the quickbook dev branch. The implementation of glob is 
a port to C++ from the C one present inside the b2 engine. Note, I 
didn't add tests for this. Will do that later after some time for people 
to look at it and doing any needed changes from that.

Feedback welcome.

--

-- 
-- Grafik - Don't Assume Anything
-- Redshift Software, Inc. - http://redshift-software.com
-- rrivera/acm.org (msn) - grafik/redshift-software.com
-- 102708583/icq - grafikrobot/aim,yahoo,skype,efnet,gmail

Sample TR2 library proposal using Quickbook

I've added a sample TR2 library proposal to trunk at
boost-root\tools\quickbook\extra\cxx_committee.

It's based on René and Bernhard's
http://svn.boost.org/svn/boost/sandbox/tree/libs/tree/proposal

It sort of works. The document does get produced, but it just looks
like a regular boost library, not like a standards committee document.
In the tree proposal, the external stylesheet gets replaced by inline
styles. That's a requirement for the committee, as the html has to be
complete without reference to an external stylesheet. But that doesn't
happen with the cxx_committee version, even though the Jamfile,
proposal.qbk, and proposal.css files were originally copied from the
tree sandbox proposal subdirectory.

Rene, what did you do to cause the stylesheet to be inlined?

--Beman

Using Quickbook for TR2 proposals?

Presumably, several Boost developers will be working on TR2 proposals
soon, and Quickbook seems like it might be an attractive way to create
and maintain those proposals as they go through the committee process.

In particular, I'd like to maintain a single source for reference
documentation.  Since I already follow the standard library's
conventions for specifications, the textual differences like different
namespaces should be easy to cope with using quickbook macros and
conditions.

Is the FAQ "Can I use QuickBook for non-Boost documentation?" entry
the best place to start?

http://www.boost.org/doc/libs/1_48_0/doc/html/quickbook/faq.html

It might be helpful if we could put together an example for generating
TR2 proposals.

Is Quickbook a reasonable approach?

Comments?

--Beman

Effects of document-type?

The Quickbook docs for document-type list the names (book, article,
library, etc.) but gives no indication as to what the effects are.
Does a stylesheet change? Do other settings change?

See http://www.boost.org/doc/libs/1_48_0/doc/html/quickbook/syntax.html#quickbook.syntax.block.document

The best response would be if someone could update the docs, perhaps
by converting the list of names to a table showing the effect of each
name.

Thanks,

--Beman

Quickbook wish list..

_______________________________________________
Boost-docs mailing list
Boost-docs <at> lists.boost.org
http://lists.boost.org/mailman/listinfo.cgi/boost-docs