diff options
| author | Beman Dawes <bdawes@acm.org> | 2002-12-16 13:54:56 +0000 |
|---|---|---|
| committer | Beman Dawes <bdawes@acm.org> | 2002-12-16 13:54:56 +0000 |
| commit | 54bb65dbfc5e80724cff19726e8c4cb1decc5293 (patch) | |
| tree | 3562621fefa8a6ba06b733f708e7adac0eedc060 /more/lib_guide.htm | |
| parent | baf07a3b965fd118a72de9f9ff877b3bd20d54a8 (diff) | |
| download | boost-54bb65dbfc5e80724cff19726e8c4cb1decc5293.tar.gz | |
Clarify redirection, add rationale
[SVN r16623]
Diffstat (limited to 'more/lib_guide.htm')
| -rw-r--r-- | more/lib_guide.htm | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/more/lib_guide.htm b/more/lib_guide.htm index e6d1bd00c7..a83a2d125c 100644 --- a/more/lib_guide.htm +++ b/more/lib_guide.htm @@ -270,8 +270,14 @@ library, but a reasonable effort to comply is expected.</p> </table> </blockquote> <h4><a name="Redirection">Redirection</a></h4> -<p>If the documentation is in a doc sub-directory, the primary directory should -contain an index.html file which redirects to the doc subdirectory:</p> +<p>The primary directory should always contain a file named index.html (or +index.htm). Authors have requested this so that they can publish URL's in the +form <i>http://www.boost.org/libs/lib-name</i> with the assurance a +documentation reorganization won't invalidate the URL. Boost's internal tools +are also simplified by knowing that a library's documentation is always +reachable via the simplified URL.</p> +<p>If the documentation is in a doc sub-directory, the primary directory index.html file +should just do an automatic redirection to the doc subdirectory:</p> <blockquote> <pre><html> <head> @@ -435,7 +441,7 @@ suggestion. Major contributions are usually acknowledged in the documentation, while minor fixes are often mentioned in comments within the code itself.</p> <hr> -<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->19 September, 2002<!--webbot bot="Timestamp" endspan i-checksum="39348" --></p> +<p>Revised <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->16 December, 2002<!--webbot bot="Timestamp" endspan i-checksum="38515" --></p> </body> |