SF.net SVN: docutils:[10193 ] trunk/docutils/docs/user /rst/cheatsheet.rst

Revision: 10193
          http://sourceforge.net/p/docutils/code/10193
Author:   milde
Date:     2025-07-31 14:18:24 +0000 (Thu, 31 Jul 2025)
Log Message:
-----------
Update reStructuredText Cheat Sheet.

Remove "new in 0.3.x" markers (this was before 2006).

Add "code" role and directive and "math" role.

Sort directives as in "directives.rst".
TODO: rather sort alphabetically?

Modified Paths:
--------------
    trunk/docutils/docs/user/rst/cheatsheet.rst

Modified: trunk/docutils/docs/user/rst/cheatsheet.rst
===================================================================
--- trunk/docutils/docs/user/rst/cheatsheet.rst	2025-07-30 08:22:51 UTC (rev 10192)
+++ trunk/docutils/docs/user/rst/cheatsheet.rst	2025-07-31 14:18:24 UTC (rev 10193)
@@ -27,7 +27,7 @@
 | >>> print 'Doctest block'      |                                   |
 | Doctest block                  | > Quoted                          |
 +--------------------------------+-----------------------------------+
-| | Line blocks preserve line breaks & indents. [new in 0.3.6]       |
+| | Line blocks preserve line breaks & indents.                      |
 | |     Useful for addresses, verse, and adornment-free lists; long  |
 |       lines can be wrapped with continuation lines.                |
 +--------------------------------------------------------------------+
@@ -70,7 +70,7 @@
 https://docutils.sourceforge.io; named reference, reStructuredText_;
 `anonymous reference`__; footnote reference, [1]_; citation reference,
 [CIT2002]_; |substitution|; _`inline internal target`.
-
+
 Directive Quick Reference
 =========================
 See <https://docutils.sourceforge.io/docs/ref/rst/directives.html> for full info.
@@ -86,30 +86,31 @@
 topic             ``.. topic:: Title``; like a mini section
 sidebar           ``.. sidebar:: Title``; like a mini parallel document
 parsed-literal    A literal block with parsed inline markup
+code              Literal block for code with optional syntax highlighting
+math              Mathematical notation (input in LaTeX format)
 rubric            ``.. rubric:: Informal Heading``
 epigraph          Block quote with class="epigraph"
 highlights        Block quote with class="highlights"
 pull-quote        Block quote with class="pull-quote"
-compound          Compound paragraphs [0.3.6]
-container         Generic block-level container element [0.3.10]
-table             Create a titled table [0.3.1]
-list-table        Create a table from a uniform two-level bullet list [0.3.8]
-csv-table         Create a table from CSV data [0.3.4]
+compound          Compound paragraphs
+container         Generic block-level container element
+table             Create a titled table
+list-table        Create a table from a uniform two-level bullet list
+csv-table         Create a table from CSV data
 contents          Generate a table of contents
 sectnum           Automatically number sections, subsections, etc.
-header, footer    Create document decorations [0.3.8]
+header, footer    Create document decorations
 target-notes      Create an explicit footnote for each external target
-math              Mathematical notation (input in LaTeX format)
-meta              Document metadata
-include           Read an external reST file as if it were inline
-raw               Non-reST data passed untouched to the Writer
 replace           Replacement text for substitution definitions
 unicode           Unicode character code conversion for substitution defs
 date              Generates today's date; for substitution defs
+include           Read an external reST file as if it were inline
+raw               Non-reST data passed untouched to the Writer
 class             Set a "class" attribute on the next element
-role              Create a custom interpreted text role [0.3.2]
-default-role      Set the default interpreted text role [0.3.10]
-title             Set the metadata document title [0.3.10]
+role              Create a custom interpreted text role
+default-role      Set the default interpreted text role
+meta              Document metadata
+title             Set the metadata document title
 ================  ============================================================
 
 Interpreted Text Role Quick Reference
@@ -119,12 +120,13 @@
 ================  ============================================================
 Role Name         Description
 ================  ============================================================
+code              code in a formal language (see docs for syntax highlighting)
 emphasis          Equivalent to *emphasis*
 literal           Equivalent to ``literal`` but processes backslash escapes
 math              Mathematical notation (input in LaTeX format)
 PEP               Reference to a numbered Python Enhancement Proposal
 RFC               Reference to a numbered Internet Request For Comments
-raw               For non-reST data; cannot be used directly (see docs) [0.3.6]
+raw               For non-reST data; cannot be used directly (see docs)
 strong            Equivalent to **strong**
 sub               Subscript
 sup               Superscript

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.