Re: [Boost-docs] [1.35] Where to place PDF versions of docs?

Subject: Re: [Boost-docs] [1.35] Where to place PDF versions of docs?
From: Rene Rivera (grafikrobot_at_[hidden])
Date: 2007-11-02 16:52:18

John Maddock wrote:
> Rene Rivera wrote:
>> John Maddock wrote:

>> web-root/doc/prebuilt/<version>/libs/<library>/doc/whatever.pdf
>> (or any other prebuilt docs, not just pdf)
> 
> Is this under website\public_html\beta\doc ?

Yes.

>> Note, this would be only an internal arrangement. We can arrange the
>> links to show up elsewhere as needed. In particular they can show up
>> as a link to /doc/libs/<version>/doc/whatever.pdf.

Oops, I actually meant /doc/libs/<version>/libs/<library>/doc/whatever.pdf.

> OK, but what I'd really like is a *stable* link in the docs to the PDF's, 
> i.e. one that doesn't have to change for each release, is it possible to 
> auto-generate an index of PDF's in the website area (by version and/or by 
> library) that we can all link to?

There are two possibilities:

* Use relative links from the HTML docs. Since the full release is 
available under the /doc/libs/<version> tree, the references would work out.

* Have symbolic version "numbers" that we point to appropriate real 
versions. For example /doc/libs/release/libs/<library>/doc/whatever.pdf 
would translate to /doc/libs/1_34_1/libs/<library>/doc/whatever.pdf.

Note, they are not exclusive options. And yes it's possible to 
auto-generate a list of PDFs.

> Also having <version> in the directory name is somewhat overkill given that 
> we have an SVN history anyway...

The <version> is not for the purpose of revision control. It's for users 
to be able to look at documentation from past release. For example, 
currently you can look at:

<http://beta.boost.org/doc/libs/1_33_1/libs/math/doc/index.html>
..And
<http://beta.boost.org/doc/libs/1_34_0/doc/html/boost_math.html>

To see a transition from regular HTML to BoostBook.

> although I guess since SVN copies are 
> cheap, we could have:
> 
> web-root/doc/prebuilt/latest/libs/<library>/doc/whatever.pdf
> 
> which would contain the most recent PDF build, and
> 
> web-root/doc/prebuilt/<version>/libs/<library>/doc/whatever.pdf
> 
> as an SVN copy of a specific version?

I should have read before typing above. Yes, except there's not need for 
the copying stuff. The web server can dynamically repoint to the correct 
places.

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