Revision: 345 Author: shomnia Date: Sun Nov 8 05:51:04 2009 Log: [No log message] http://code.google.com/p/boost-doc-zh/source/detail?r=345 Modified: /trunk/more/writingdoc/introduction.html ======================================= --- /trunk/more/writingdoc/introduction.html Sat Sep 12 01:00:21 2009 +++ /trunk/more/writingdoc/introduction.html Sun Nov 8 05:51:04 2009 @@ -2,67 +2,244 @@ <html> <head> + <TITLE>Writing Documentation for +Boost - Introduction</TITLE> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<META name=ProgId content=Word.Document> +<META name=GENERATOR content="MSHTML 8.00.6001.18828"> +<META name=Originator content="Microsoft Word 11"> + <LINK rel=Edit-Time-Data +href="../../../新建文件夹/boost_doc/more/writingdoc/introduction.files/editdata.mso">+ <LINK rel=Stylesheet type=text/css href="../../../新建文件夹/boost_doc/boost.css"
+media=all> +<STYLE> +<!-- + /* Font Definitions */ + @font-face + {font-family:SimSun; + panose-1:2 1 6 0 3 1 1 1 1 1; + mso-font-alt:SimSun; + mso-font-charset:134; + mso-generic-font-family:auto; + mso-font-pitch:variable; + mso-font-signature:3 135135232 16 0 262145 0;} +@font-face + {font-family:SimSun; + panose-1:2 1 6 0 3 1 1 1 1 1; + mso-font-charset:134; + mso-generic-font-family:auto; + mso-font-pitch:variable; + mso-font-signature:3 135135232 16 0 262145 0;} + /* Style Definitions */ + p.MsoNormal, li.MsoNormal, div.MsoNormal + {mso-style-parent:""; + margin:0cm; + margin-bottom:.0001pt; + mso-pagination:widow-orphan; + font-size:12.0pt; + font-family:"Times New Roman"; + mso-fareast-font-family:SimSun;} +a:link, span.MsoHyperlink + {color:blue; + text-decoration:underline; + text-underline:single;} +a:visited, span.MsoHyperlinkFollowed + {color:purple; + text-decoration:underline; + text-underline:single;} +p + {mso-margin-top-alt:auto; + margin-right:0cm; + mso-margin-bottom-alt:auto; + margin-left:0cm; + mso-pagination:widow-orphan; + font-size:12.0pt; + font-family:"Times New Roman"; + mso-fareast-font-family:SimSun;} +span.GramE + {mso-style-name:""; + mso-gram-e:yes;} +@page Section1 + {size:595.3pt 841.9pt; + margin:72.0pt 90.0pt 72.0pt 90.0pt; + mso-header-margin:42.55pt; + mso-footer-margin:49.6pt; + mso-paper-source:0;} +div.Section1 + {page:Section1;} +--> +</STYLE> +<style> + /* Style Definitions */ + table.MsoNormalTable + {mso-style-name:\666E\901A\8868\683C; + mso-tstyle-rowband-size:0; + mso-tstyle-colband-size:0; + mso-style-noshow:yes; + mso-style-parent:""; + mso-padding-alt:0cm 5.4pt 0cm 5.4pt; + mso-para-margin:0cm; + mso-para-margin-bottom:.0001pt; + mso-pagination:widow-orphan; + font-size:10.0pt; + font-family:"Times New Roman"; + mso-fareast-font-family:"Times New Roman"; + mso-ansi-language:#0400; + mso-fareast-language:#0400; + mso-bidi-language:#0400;} +</style> +<META content=en-us http-equiv=Content-Language> + <meta http-equiv="Content-Language" content="en-us"> + <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">+ <link rel="stylesheet" type="text/css" href="../../../新建文件夹/boost_doc/boost.css">
+ + <title>Writing Documentation for Boost - Introduction</title> <meta http-equiv="Content-Language" content="en-us"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <link rel="stylesheet" type="text/css" href="../../boost.css"> <title>Writing Documentation for Boost - Introduction</title> + <style> +<!-- +div.Section1 + {page:Section1;} + table.MsoNormalTable + {mso-style-parent:""; + font-size:10.0pt; + font-family:"Times New Roman"; + } +span.GramE + {} + div.MsoNormal + {mso-style-parent:""; + margin-bottom:.0001pt; + font-size:12.0pt; + font-family:"Times New Roman"; + margin-left:0cm; margin-right:0cm; margin-top:0cm} +--> +</style> </head> <body link="#0000FF" vlink="#800080"> - <table border="0" cellpadding="7" cellspacing="0" width="100%" summary= - "header"> - <tr> - <td valign="top" width="300">- <h3><a href="index.html"><img height="86" width="277" alt="C++ Boost"
- src="../../boost.png" border="0"></a></h3> - </td> - - <td valign="top"> - <h1 align="center">Writing Documentation for Boost</h1> - - <h2 align="center">Introduction</h2> - </td> - </tr> - </table> - <hr> - - <p>Boost does not have any requirements on how you write your - documentation. If you are submitting a library that already has written- documentation in HTML format, there is no reason to change it to follow any - of the guidelines presented here. However, if you have documentation that's
- not in HTML format and can't be easily converted to HTML, or if you're- starting on a library from scratch or have a library with no documentation
- then these guidelines can make writing the documentation much easier.</p> - - <p>The section on <a href="structure.html">Documentation Structure</a> - describes how to go about structuring the documentation's content. This- section may be helpful even for libraries that already have documentation.
- If there's a desire to present the library for possible inclusion by the - C++ Standards Committee then there may be a need to restructure the - documentation's content in order to insure the content meets explicit - requirements for library components (Section 17.3).</p> -- <p>The section on <a href="design.html">HTML Design</a> gives general rules
- to follow when writing HTML documentation in order to give a professional - and consistent look. This section also contains some template files that - can be used to rapidly create documentation pages.</p> - <hr> -- <p><a href="http://validator.w3.org/check?uri=referer";><img border="0" src=
- "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional" - height="31" width="88"></a></p> - - <p>Revised- <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04 - December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
- - <p><i>Copyright © 2001 <a href= - "mailto:williamkempf@xxxxxxxxxxx";>William E. Kempf</a></i></p> - - <p><i>Distributed under the Boost Software License, Version 1.0. (See - accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or - copy at <a href= - "http://www.boost.org/LICENSE_1_0.txt";>http://www.boost.org/LICENSE_1_0.txt</a>)</i></p> + <HTML> + <BODY link=blue vLink=purple> +<DIV class=Section1> +<TABLE+style="WIDTH: 100%; mso-cellspacing: 0cm; mso-padding-alt: 5.25pt 5.25pt 5.25pt 5.25pt" +class=MsoNormalTable border=0 cellSpacing=0 cellPadding=0 width="100%" id="table1">
+ <TBODY>+ <TR style="mso-yfti-irow: 0; mso-yfti-firstrow: yes; mso-yfti-lastrow: yes">
+ <TD+ style="PADDING-BOTTOM: 5.25pt; PADDING-LEFT: 5.25pt; WIDTH: 225pt; PADDING-RIGHT: 5.25pt; PADDING-TOP: 5.25pt"
+ vAlign=top width=300>+ <H3><SPAN style="mso-fareast-font-family: 'Times New Roman'" lang=EN-US>
+ <A+ href="../../../新建文件夹/boost_doc/more/writingdoc/index.html" style="color: blue; text-decoration: underline; text-underline: single"><SPAN
+ style="TEXT-DECORATION: none; text-underline: none"> + <IMG id=_x0000_i1025+ border=0 alt="C++ Boost" src="../../../新建文件夹/boost_doc/boost.png" width=277
+ height=86></SPAN></A><o:p></o:p></SPAN></H3></TD> + <TD+ style="PADDING-BOTTOM: 5.25pt; PADDING-LEFT: 5.25pt; PADDING-RIGHT: 5.25pt; PADDING-TOP: 5.25pt"
+ vAlign=top> + <H1 style="TEXT-ALIGN: center" align=center><SPAN + style="mso-fareast-font-family: 'Times New Roman'" lang=EN-US>Writing + Documentation for Boost</SPAN></H1> + <H1 style="TEXT-ALIGN: center" align=center><SPAN+ style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">
+ 为</SPAN><SPAN + style="mso-fareast-font-family: 'Times New Roman'" + lang=EN-US>Boost</SPAN><SPAN class=GramE><SPAN+ style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">库写文档</SPAN></SPAN><SPAN
+ style="mso-fareast-font-family: 'Times New Roman'" + lang=EN-US><o:p></o:p></SPAN></H1> + <H2 style="TEXT-ALIGN: center" align=center><SPAN+ style="mso-fareast-font-family: 'Times New Roman'" lang=EN-US>Introduction
+ </SPAN></H2> + <H2 style="TEXT-ALIGN: center" align=center><SPAN+ style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">
+ 介绍</SPAN><SPAN + style="mso-fareast-font-family: 'Times New Roman'" + lang=EN-US><o:p></o:p></SPAN></H2></TD></TR></TBODY></TABLE>+<DIV style="TEXT-ALIGN: center" class=MsoNormal align=center><SPAN lang=EN-US>
+<HR align=center SIZE=2 width="100%"> +</SPAN></DIV>+<P><SPAN lang=EN-US>Boost does not have any requirements on how you write your
+documentation. If you are submitting a library that already has written+documentation in HTML format, there is no reason to change it to follow any of +the guidelines presented here. However, if you have documentation that's not in +HTML format and can't be easily converted to HTML, or if you're starting on a
+library from scratch or have a library with no documentation then these +guidelines can make writing the documentation much easier.</SPAN></P> +<P><SPAN lang=EN-US>Boost </SPAN><SPAN+style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">
+没有任何关于如何写文档的需求。如果你提交的<SPAN+class=GramE>库已经</SPAN>有</SPAN><SPAN lang=EN-US>HTML</SPAN><SPAN +style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">格式的文档,没有任何理由再去改变它遵守这里的准则。然而,如果你的文档不是</SPAN><SPAN
+lang=EN-US>HTML</SPAN><SPAN+style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">格式,而且不能很容易转换成</SPAN><SPAN
+lang=EN-US>HTML</SPAN><SPAN+style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">格式,或者你正准备从头开始构建一个<SPAN
+class=GramE>库或者</SPAN>一个已经存在的库没有文档,<SPAN +class=GramE>这时这些</SPAN>指导方针能够让你更容易的编写文档。</SPAN></P> +<P><SPAN lang=EN-US>The section on+<A href="../../../新建文件夹/boost_doc/more/writingdoc/structure.html" style="color: blue; text-decoration: underline; text-underline: single">Documentation +Structure</A> describes how to go about structuring the documentation's content. +This section may be helpful even for libraries that already have documentation. +If there's a desire to present the library for possible inclusion by the C++ +Standards Committee then there may be a need to restructure the documentation's +content in order to insure the content meets explicit requirements for library
+components (Section 17.3).</SPAN></P> +<P><SPAN+style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'"> +<a href="../../../新建文件夹/boost_doc/more/writingdoc/structure.html" style="color: blue; text-decoration: underline; text-underline: single">文档结构</a>这一节描述了怎样结构化地组织文档的内容。这一节对已经有文档的库也是有帮助的。如果一个库想要被</SPAN><SPAN
+lang=EN-US>C++</SPAN><SPAN+style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">标准委员会采用,这时需要重新组织文档的内容保证它满足库组件的显示需要</SPAN><SPAN
+lang=EN-US>(17.3</SPAN><SPAN+style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">节</SPAN><SPAN
+lang=EN-US>)</SPAN><SPAN+style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">。</SPAN></P>
+<P><SPAN lang=EN-US>The section on+<A href="../../../新建文件夹/boost_doc/more/writingdoc/design.html" style="color: blue; text-decoration: underline; text-underline: single">HTML Design</A> gives
+general rules to follow when writing HTML documentation in order to give a+professional and consistent look. This section also contains some template files
+that can be used to rapidly create documentation pages.</SPAN></P> +<P><SPAN lang=EN-US>+<a href="../../../新建文件夹/boost_doc/more/writingdoc/design.html" style="color: blue; text-decoration: underline; text-underline: single">HTML设计</a></SPAN><SPAN +style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">这节给出了写作</SPAN><SPAN
+lang=EN-US>HTML</SPAN><SPAN+style="FONT-FAMILY: SimSun; mso-ascii-font-family: 'Times New Roman'; mso-hansi-font-family: 'Times New Roman'">文档时保持专业和一致外观的准则。这节也包含一些模板文件能够用来快速创建文档页。</SPAN></P> +<DIV style="TEXT-ALIGN: center" class=MsoNormal align=center><SPAN lang=EN-US>
+<HR align=center SIZE=2 width="100%"> +</SPAN></DIV> +<P><SPAN lang=EN-US>+<A href="http://validator.w3.org/check?uri=referer"; style="color: blue; text-decoration: underline; text-underline: single"><SPAN
+style="TEXT-DECORATION: none; text-underline: none"><IMG id=_x0000_i1028 +border=0 alt="Valid HTML 4.01 Transitional" +src="http://www.w3.org/Icons/valid-html401"; width=88 +height=31></SPAN></A></SPAN></P> +<P><SPAN lang=EN-US>Revised+<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->08 十一月, 2009<!--webbot bot="Timestamp" endspan i-checksum="51165" --></SPAN></P>
+<P><I><SPAN lang=EN-US>Copyright © 2001 +<A+href="mailto:williamkempf@xxxxxxxxxxx"; style="color: blue; text-decoration: underline; text-underline: single">William E. Kempf</A></SPAN></I></P> +<P><SPAN class=GramE><I><SPAN lang=EN-US>Distributed under the Boost Software +License, Version 1.0.</SPAN></I></SPAN><I><SPAN lang=EN-US> (See accompanying
+file+<A href="../../../新建文件夹/boost_doc/LICENSE_1_0.txt" style="color: blue; text-decoration: underline; text-underline: single">LICENSE_1_0.txt</A> or copy at
+<A+href="http://www.boost.org/LICENSE_1_0.txt"; style="color: blue; text-decoration: underline; text-underline: single">http://www.boost.org/LICENSE_1_0.txt</A>)</SPAN></I></P>
+<DIV class=Section1> +<div class="Section1">+<i><span style="font-family: Arial;" lang="EN-US"> 中文版修订:2009/11/05<br>
+<br> +Copyright © 2009 shomnia<br> +<br>+在 Boost Software License, Version 1.0 的条款下发布。(参看文件 </span></i><a href="file:///Volumes/%C3%B0%E2%94%AC%E2%95%9DE%CC%88%C2%A5Y%CC%81/LICENSE_1_0.txt" style="color: blue; text-decoration: none; text-underline: none; text-line-through: none"> + LICENSE_1_0.txt</a><i><span style="font-family: Arial;" lang="EN-US">
+或在线副本+<a href="http://www.boost.org/LICENSE_1_0.txt"; style="color: blue; text-decoration: none; text-underline: none; text-line-through: none">
+http://www.boost.org/LICENSE_1_0.txt</a>) </span></i> +</div></DIV></DIV></BODY></HTML> </body> </html>