| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
|---|
| 4 | <link rel="stylesheet" type="text/css" href="../../boost.css"> |
|---|
| 5 | <title>Writing Documentation for Boost - Introduction</title> |
|---|
| 6 | </head> |
|---|
| 7 | <body link="#0000ff" vlink="#800080"> |
|---|
| 8 | <table border="0" cellpadding="7" cellspacing="0" width="100%" summary= |
|---|
| 9 | "header"> |
|---|
| 10 | <tr> |
|---|
| 11 | <td valign="top" width="300"> |
|---|
| 12 | <h3><a href="index.html"><img height="86" width="277" alt="C++ Boost" src="../../boost.png" border="0"></a></h3> |
|---|
| 13 | </td> |
|---|
| 14 | <td valign="top"> |
|---|
| 15 | <h1 align="center">Writing Documentation for Boost</h1> |
|---|
| 16 | <h2 align="center">Introduction</h2> |
|---|
| 17 | </td> |
|---|
| 18 | </tr> |
|---|
| 19 | </table> |
|---|
| 20 | <hr> |
|---|
| 21 | <p>Boost does not have any requirements on how you write your documentation. If |
|---|
| 22 | you are submitting a library that already has written documentation in HTML |
|---|
| 23 | format, there is no reason to change it to follow any of the guidelines presented |
|---|
| 24 | here. However, if you have documentation that's not in HTML format and can't |
|---|
| 25 | be easily converted to HTML, or if you're starting on a library from scratch |
|---|
| 26 | or have a library with no documentation then these guidelines can make writing |
|---|
| 27 | the documentation much easier.</p> |
|---|
| 28 | <p>The section on <a href="structure.html">Documentation Structure</a> describes |
|---|
| 29 | how to go about structuring the documentation's content. This section may be |
|---|
| 30 | helpful even for libraries that already have documentation. If there's a desire |
|---|
| 31 | to present the library for possible inclusion by the C++ Standards Committee |
|---|
| 32 | then there may be a need to restructure the documentation's content in order |
|---|
| 33 | to insure the content meets explicit requirements for library components (Section |
|---|
| 34 | 17.3).</p> |
|---|
| 35 | <p>The section on <a href="design.html">HTML Design</a> gives general rules to |
|---|
| 36 | follow when writing HTML documentation in order to give a professional and consistent |
|---|
| 37 | look. This section also contains some template files that can be used to rapidly |
|---|
| 38 | create documentation pages.</p> |
|---|
| 39 | <hr> |
|---|
| 40 | <p>Revised |
|---|
| 41 | <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 November, 2003<!--webbot bot="Timestamp" endspan i-checksum="39371" --> |
|---|
| 42 | </p> |
|---|
| 43 | <p><i>© Copyright <a href="mailto:williamkempf@hotmail.com">William E. Kempf</a> |
|---|
| 44 | 2001. All Rights Reserved.</i></p> |
|---|
| 45 | </body> |
|---|
| 46 | </html> |
|---|
