ceph/src/boost/more/writingdoc/introduction.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2
   3 <html>
   4 <head>
   5   <meta http-equiv="Content-Language" content="en-us">
   6   <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
   7   <link rel="stylesheet" type="text/css" href="../../boost.css">
   8
   9   <title>Writing Documentation for Boost - Introduction</title>
  10 </head>
  11
  12 <body link="#0000FF" vlink="#800080">
  13   <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
  14   "header">
  15     <tr>
  16       <td valign="top" width="300">
  17         <h3><a href="index.html"><img height="86" width="277" alt="C++ Boost"
  18         src="../../boost.png" border="0"></a></h3>
  19       </td>
  20
  21       <td valign="top">
  22         <h1 align="center">Writing Documentation for Boost</h1>
  23
  24         <h2 align="center">Introduction</h2>
  25       </td>
  26     </tr>
  27   </table>
  28   <hr>
  29
  30   <p>Boost does not have any requirements on how you write your
  31   documentation. If you are submitting a library that already has written
  32   documentation in HTML format, there is no reason to change it to follow any
  33   of the guidelines presented here. However, if you have documentation that's
  34   not in HTML format and can't be easily converted to HTML, or if you're
  35   starting on a library from scratch or have a library with no documentation
  36   then these guidelines can make writing the documentation much easier.</p>
  37
  38   <p>The section on <a href="structure.html">Documentation Structure</a>
  39   describes how to go about structuring the documentation's content. This
  40   section may be helpful even for libraries that already have documentation.
  41   If there's a desire to present the library for possible inclusion by the
  42   C++ Standards Committee then there may be a need to restructure the
  43   documentation's content in order to insure the content meets explicit
  44   requirements for library components (Section 17.3).</p>
  45
  46   <p>The section on <a href="design.html">HTML Design</a> gives general rules
  47   to follow when writing HTML documentation in order to give a professional
  48   and consistent look. This section also contains some template files that
  49   can be used to rapidly create documentation pages.</p>
  50   <hr>
  51
  52   <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
  53   "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional"
  54   height="31" width="88"></a></p>
  55
  56   <p>Revised
  57   <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
  58   December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
  59
  60   <p><i>Copyright &copy; 2001 <a href=
  61   "mailto:williamkempf@hotmail.com">William E. Kempf</a></i></p>
  62
  63   <p><i>Distributed under the Boost Software License, Version 1.0. (See
  64   accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  65   copy at <a href=
  66   "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
  67 </body>
  68 </html>