Boost C++ Libraries: Ticket #1166: [boostbook] paths relative to boost.root

attachment set

Steven Watanabe — Sat, 11 Aug 2007 20:38:38 GMT

attachment → relative-href.xsl.patch

attachment set

Steven Watanabe — Sat, 11 Aug 2007 20:39:13 GMT

attachment → xref.xsl.patch

component changed

Marshall Clow — Sun, 19 Aug 2007 15:08:58 GMT

component None → Building Boost

status, version, component, severity changed; owner set

Daniel James — Mon, 31 Mar 2008 20:36:42 GMT

owner set to Daniel James
status new → assigned
version Boost 1.34.1 → Boost 1.35.0
component Building Boost → Documentation
severity Not Applicable → Problem

Yes, this is definitely needed.

boost://libs/mpl/index.html is probably wrong, as the :// usually indicates that the first past part of the path is a server name. boost:/libs/mpl/index.html or perhaps boost:libs/mpl/index.html is better.

Another possibility is to just do this for paths starting with '/', as that does suggest the root of the distribution. I like this, as I'm not keen on inventing our own protocol name. But 'boost:' will work very well if $boost.root == 'http://www.boost.org' - so it'll be ideal for candidate libraries.

I'll attach an updated patch which implements what I described, and also fixes a small bug when the link is from a sub-directory.

I'll bring this up on the Boost Docs list soon, as someone might have a better idea.

attachment set

Daniel James — Mon, 31 Mar 2008 20:37:56 GMT

attachment → links.patch

Updated implementation, that uses 'boost:/libs..' instead of 'boost://libs..', and works for links from sub-directories.

milestone changed

Daniel James — Sun, 01 Jun 2008 10:08:14 GMT

milestone To Be Determined → Boost 1.37.0

I've been trying something like this in the doc branch, but it still doesn't completely work. Beacuse it's done as part of the chunking mechanism it only works for chunked output (ie. html/xhtml) but not for other types such as fo (for generating pdfs) and html-single. The links should be dealt with in the initial boostbook to docbook conversion. I'll get back to this.

Steven Watanabe — Fri, 20 Jun 2008 01:34:43 GMT

Another thing, Would it be better to have a generic mechanism for specifying the root of a path as using an xsl parameter. so that this would become $(boost.root)/... Is this evan possible in xsl?

I'd also like to be able to specify the root of relative paths so that I can just specify paths relative to my quickbook sources rather than specifying the paths relative to the destination directory, since this is different for the standalone docs vs. the global boost doc build.

attachment set

Daniel James — Wed, 11 Feb 2009 22:32:14 GMT

attachment → boost-links-1.patch

New implementation, which transforms the links in the boostbook to docbook stage. Currently only translates ulinks, not other links such as images.

attachment set

Daniel James — Wed, 11 Feb 2009 22:32:55 GMT

attachment → boost-links-2.patch

Some examples of using the 'boost:/' style links.

status changed; resolution set

Daniel James — Sun, 15 Feb 2009 19:31:39 GMT

status assigned → closed
resolution → fixed

(In [51261]) Implement the 'boost:' for links relative to boost root. Also, optionally replace links within the boost distribution with links to the the boost site, which is useful for generating pdfs and standalone documentation.

Implemented with John Maddock. Fixes #1166.

Daniel James — Thu, 12 Mar 2009 20:11:59 GMT

(In [51739]) Record another previous change:

Recorded merge of revisions 51261 via svnmerge from https://svn.boost.org/svn/boost/trunk

........

r51261 | danieljames | 2009-02-15 19:31:37 +0000 (Sun, 15 Feb 2009) | 5 lines

Implement the 'boost:' for links relative to boost root. Also, optionally replace links within the boost distribution with links to the the boost site, which is useful for generating pdfs and standalone documentation.

Implemented with John Maddock. Fixes #1166.

........

milestone changed

Daniel James — Sun, 12 Apr 2009 11:29:46 GMT

milestone Boost 1.37.0 → Boost 1.39.0