boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2025-03-27 13:50:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clarify redirection, add rationale

Browse Source 
[SVN r16623]
This commit is contained in:
Beman Dawes 2002-12-16 13:54:56 +00:00
parent 87b63053ee
commit 0026aa49e4
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib_guide.htm
View File

@ -270,8 +270,14 @@ library, but a reasonable effort to comply is expected.</p>
</table> </table>
</blockquote> </blockquote>
<h4><a name="Redirection">Redirection</a></h4> <h4><a name="Redirection">Redirection</a></h4>
<p>If the documentation is in a doc sub-directory, the primary directory should <p>The primary directory should always contain a file named index.html (or
contain an index.html file which redirects to the doc subdirectory:</p> 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> <blockquote>
<pre>&lt;html&gt; <pre>&lt;html&gt;
&lt;head&gt; &lt;head&gt;
@ -435,7 +441,7 @@ suggestion.&nbsp; Major contributions are usually acknowledged in the
documentation, while minor fixes are often mentioned in comments within the code documentation, while minor fixes are often mentioned in comments within the code
itself.</p> itself.</p>
<hr> <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> </body>