summaryrefslogtreecommitdiff
path: root/docutils/docs/user/rst
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2013-02-20 01:10:53 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2013-02-20 01:10:53 +0000
commit998ba406904e8be69d9cf6a30bacb7c4034595f1 (patch)
treee808c9c9c2ce8551b5e29ce6e79ff63ca3d4bd9f /docutils/docs/user/rst
parent994f6e6aa1b0ececf904760f87b573af001e6470 (diff)
downloaddocutils-998ba406904e8be69d9cf6a30bacb7c4034595f1.tar.gz
added notes to see .txt source
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7612 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/user/rst')
-rw-r--r--docutils/docs/user/rst/cheatsheet.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/docutils/docs/user/rst/cheatsheet.txt b/docutils/docs/user/rst/cheatsheet.txt
index 1ad2c852e..43849b644 100644
--- a/docutils/docs/user/rst/cheatsheet.txt
+++ b/docutils/docs/user/rst/cheatsheet.txt
@@ -7,6 +7,9 @@
:Revision: $Revision$
:Description: This is a "docinfo block", or bibliographic field list
+.. NOTE:: If you are reading this as HTML, please read
+ `<cheatsheet.txt>`_ instead to see the input syntax examples!
+
Section Structure
=================
Section titles are underlined or overlined & underlined.
@@ -32,7 +35,7 @@ Grid table:
Simple tables:
================ ============================================================
-List Type Examples
+List Type Examples (syntax in the `text source <cheatsheet.txt>`_)
================ ============================================================
Bullet list * items begin with "-", "+", or "*"
Enumerated list 1. items use any variation of "1.", "A)", and "(i)"
@@ -44,7 +47,7 @@ Option list -o at least 2 spaces between option & description
================ ============================================================
================ ============================================================
-Explicit Markup Examples (visible in the `text source <cheatsheet.txt>`_)
+Explicit Markup Examples (visible in the `text source`_)
================ ============================================================
Footnote .. [1] Manually numbered or [#] auto-numbered
(even [#labelled]) or [*] auto-symbol