Re: [boost] [QuickBook] missing prev/next

Subject: Re: [boost] [QuickBook] missing prev/next
From: Lorenzo Caminiti (lorcaminiti_at_[hidden])
Date: 2011-01-07 13:07:36

On Fri, Jan 7, 2011 at 12:50 PM, Paul A. Bristow
<pbristow_at_[hidden]> wrote:
>> -----Original Message-----
>> From: boost-bounces_at_[hidden] [mailto:boost-bounces_at_[hidden]]
>> On Behalf Of Lorenzo Caminiti
>> Sent: Friday, January 07, 2011 4:29 PM
>> To: boost_at_[hidden]
>> Subject: Re: [boost] [QuickBook] missing prev/next
>
> I recollect that specific versions of XSL and Docbook are required.
> (The latest versions don't work as I recall).
>
>> Also, how can I get the Doxygen reference documentation to have hyper
> links? I
>> would like for both for Doxygen to link Doxygen pages as well as the
> QuickBook
>> sections. I had to manually use the <a> HTML command but it that is not
> ideal
>> and it broke in the build you have posted on boost-sandbox website...
>
> I do use Doxygen, but I'm not quite sure what you want.
>
> I've used a \mainpage to provide docs in both html/pdf from Quickbook and
> native Doxygen formats.
> (see attached example), but I'm not sure that is what you want.
>
> There should be lots of hyperlinks from function names, for example, that
> show up underlined when you hover over them.
> Click should jump to the function reference info.

Let me try to explain better.

1) Links from Doxygen to Doxygen:
If I build the Doxygen documentation standalone using doxygen
directly, I have hyperlinks for funcitons, macros, etc -- that's good
:) However, if I build the Doxygen documentation from the jamfile.jam
in a way that it generates a .xml file that I can included using
`[include ...]` into by QuickBook documentation, all the usual Doxygen
hyperlinks disappear.

2) Links from Doxygen to QuickBook:
I would also like from within Doxygen to link to a QuickBook `[section
...]` or similar (so using the QuickBook identifiers).

So I manually used HTML commands `<a>...</a>` to link pages within
Doxygen. This works but I was wondering if there was a better way
which uses the identifiers instead of the actual HTML page URLs.

On Fri, Jan 7, 2011 at 12:46 PM, Steven Watanabe <watanabesj_at_[hidden]> wrote:
>
> You can use BoostBook markup:
> @xmlonly <link
> linkend="boost_random.reference.concepts.random_distribution">random
> distribution</link> @endxmlonly
> @xmlonly <classname
> alt="boost::lagged_fibonacci607">lagged_fibonacci607</classname> @endxmlonly

OK, I will try this -- this uses the QuickBook and code identifiers as
in `boost_random.reference.concepts.random_distribution` and
`boost::lagged_fibonacci607` so it should be what I was looking for.
Thanks.

-- 
Lorenzo