Просмотр исходного кода

Clarify redirection, add rationale

[SVN r16623]
Beman Dawes 23 лет назад
Родитель
Сommit
54bb65dbfc
1 измененных файлов с 9 добавлено и 3 удалено
  1. 9 3
      more/lib_guide.htm

+ 9 - 3
more/lib_guide.htm

@@ -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 
-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>
 <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>
 
 

粤ICP备19079148号