diff options
| author | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2004-10-22 01:23:47 +0000 |
|---|---|---|
| committer | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2004-10-22 01:23:47 +0000 |
| commit | 04554113a5f8dada787e7c561954875fb036b4a2 (patch) | |
| tree | ce37c93162a6f3b2613474e1eb5a01a1bed91120 /docs/user/rst | |
| parent | fa9c91d1c2ad8f1cc5cd4ef5eba9c23bfc9ac250 (diff) | |
| download | docutils-04554113a5f8dada787e7c561954875fb036b4a2.tar.gz | |
added directive; cleanup
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@2760 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/user/rst')
| -rw-r--r-- | docs/user/rst/cheatsheet.txt | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/docs/user/rst/cheatsheet.txt b/docs/user/rst/cheatsheet.txt index df7a00b1a..b83b781c6 100644 --- a/docs/user/rst/cheatsheet.txt +++ b/docs/user/rst/cheatsheet.txt @@ -24,27 +24,27 @@ Grid table: | >>> print 'Doctest block' | | | Doctest block | > Quoted | +--------------------------------+-----------------------------------+ -| | Line blocks preserve line breaks & indents. | +| | Line blocks preserve line breaks & indents. [new in 0.3.6] | | | Useful for addresses, verse, and adornment-free lists; long | | lines can be wrapped with continuation lines. | +--------------------------------------------------------------------+ Simple tables: -================ ==================================================== +================ ============================================================ List Type Examples -================ ==================================================== +================ ============================================================ Bullet list * items begin with "-", "+", or "*" Enumerated list 1. items use any variation of "1.", "A)", and "(i)" Definition list Term is flush-left : optional classifier Definition is indented, no blank line between Field list :field name: field body Option list -o at least 2 spaces between option & description -================ ==================================================== +================ ============================================================ -================ ==================================================== +================ ============================================================ Explicit Markup Examples (visible in the `text source <cheatsheet.txt>`_) -================ ==================================================== +================ ============================================================ Footnote .. [1] Manually numbered or [#] auto-numbered (even [#labelled]) or [*] auto-symbol Citation .. [CIT2002] A citation. @@ -55,7 +55,7 @@ Anonymous Target __ http://docutils.sf.net/docs/ref/rst/restructuredtext.html Directive ("::") .. image:: images/biohazard.png Substitution Def .. |substitution| replace:: like an inline directive Comment .. is anything else -================ ==================================================== +================ ============================================================ Inline Markup ============= @@ -69,9 +69,9 @@ Directive Quick Reference ========================= See <http://docutils.sf.net/docs/ref/rst/directives.html> for full info. -================ ==================================================== -Directive Name Description -================ ==================================================== +================ ============================================================ +Directive Name Description (Docutils version added to, in [brackets]) +================ ============================================================ attention Specific admonition; also "caution", "danger", "error", "hint", "important", "note", "tip", "warning" admonition Generic titled admonition: ``.. admonition:: By The Way`` @@ -82,11 +82,12 @@ sidebar ``.. sidebar:: Title``; like a mini parallel document parsed-literal A literal block with parsed inline markup rubric ``.. rubric:: Informal Heading`` epigraph Block quote with class="epigraph" -highlights Block quote with class="highlights" +highlights Block quote with class="highlights" pull-quote Block quote with class="pull-quote" -table Create a titled table (new in Docutils 0.3.1) -csv-table Create a titled table from CSV data (requires Python 2.3+; - new in Docutils 0.3.4) +compound Compound paragraphs [0.3.6] +table Create a titled table [0.3.1] +csv-table Create a titled table from CSV data (requires Python 2.3+) + [0.3.4] contents Generate a table of contents sectnum Automatically number sections, subsections, etc. target-notes Create an explicit footnote for each external target @@ -96,16 +97,16 @@ raw Non-reST data passed untouched to the Writer replace Replacement text for substitution definitions unicode Unicode character code conversion for substitution defs class Set a "class" attribute on the next element -role Create a custom interpreted text role (new in Docutils 0.3.2) -================ ==================================================== +role Create a custom interpreted text role [0.3.2] +================ ============================================================ Interpreted Text Role Quick Reference ===================================== See <http://docutils.sf.net/docs/ref/rst/roles.html> for full info. -================ ==================================================== +================ ============================================================ Role Name Description -================ ==================================================== +================ ============================================================ emphasis Equivalent to *emphasis* literal Equivalent to ``literal`` but processes backslash escapes PEP Reference to a numbered Python Enhancement Proposal @@ -114,4 +115,4 @@ strong Equivalent to **strong** sub Subscript sup Superscript title Title reference (book, etc.); standard default role -================ ==================================================== +================ ============================================================ |