From: Cherniavsky B. <cb...@us...> - 2004-05-15 23:16:33
|
Update of /cvsroot/docutils/docutils/docs/rst In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4501/docs/rst Modified Files: quickref.html quickstart.txt Log Message: Emphasized the DocTitle transfrom in docs, as it's a very FAQ. Index: quickref.html =================================================================== RCS file: /cvsroot/docutils/docutils/docs/rst/quickref.html,v retrieving revision 1.20 retrieving revision 1.21 diff -u -d -r1.20 -r1.21 --- quickref.html 24 Feb 2004 02:13:42 -0000 1.20 +++ quickref.html 15 May 2004 23:16:23 -0000 1.21 @@ -279,6 +279,10 @@ <br><samp>are "``= - ` : ' " ~ ^ _ * + # < >``".</samp> <br><samp>The underline/overline must be at</samp> <br><samp>least as long as the title text.</samp> +<br><samp></samp> +<br><samp>A lone top-level (sub)section</samp> +<br><samp>is lifted up to be the document's</samp> +<br><samp>(sub)title.</samp> <td> <font size="+2"><strong>Title</strong></font> @@ -290,6 +294,9 @@ are "<samp>= - ` : ' " ~ ^ _ * + # < ></samp>". The underline/overline must be at least as long as the title text. + <p>A lone top-level (sub)section is + lifted up to be the document's + (sub)title. </table> <h2><a href="#contents" name="paragraphs" class="backref" Index: quickstart.txt =================================================================== RCS file: /cvsroot/docutils/docutils/docs/rst/quickstart.txt,v retrieving revision 1.12 retrieving revision 1.13 diff -u -d -r1.12 -r1.13 --- quickstart.txt 10 May 2004 21:26:20 -0000 1.12 +++ quickstart.txt 15 May 2004 23:16:23 -0000 1.13 @@ -302,10 +302,17 @@ the heading has a space in it like `text styles`_, we need to quote the heading "```text styles`_``". -To indicate the document title, use a unique adornment style at the -beginning of the document. To indicate the document subtitle, use -another unique adornment style immediately after the document title. -For example:: +Document Title / Subtitle +------------------------- + +The title of the whole document is a distinct concept from section titles and +is formatted somewhat differently (e.g. the HTML writer by default shows it as +a centered heading). + +To indicate the document title in reStructuredText, use a unique adornment +style at the beginning of the document. To indicate the document subtitle, +use another unique adornment style immediately after the document title. For +example:: ================ Document Title |