diff options
| author | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2008-12-07 14:15:30 +0000 |
|---|---|---|
| committer | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2008-12-07 14:15:30 +0000 |
| commit | 6ad288f17823ac5a4ee261d80777bc5bf769d4cc (patch) | |
| tree | 6566f12b3857b7111c8fc116973b6f3930416bce | |
| parent | 5f37e8a4ec948546a308246a8b43b0ff881c84dc (diff) | |
| download | docutils-6ad288f17823ac5a4ee261d80777bc5bf769d4cc.tar.gz | |
note the informal nature of this doc, and expand on inline markup a bit
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5801 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
| -rw-r--r-- | docutils/docs/user/rst/quickstart.txt | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/docutils/docs/user/rst/quickstart.txt b/docutils/docs/user/rst/quickstart.txt index 48d5a5719..f9c197f85 100644 --- a/docutils/docs/user/rst/quickstart.txt +++ b/docutils/docs/user/rst/quickstart.txt @@ -18,6 +18,10 @@ __ .. _master quick reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html +.. Note:: This document is an informal introduction to + reStructuredText. The `What Next?`_ section below has links to + further resources, including a formal reference. + Structure --------- @@ -64,7 +68,7 @@ __ quickref.html#inline-markup Inside paragraphs and other bodies of text, you may additionally mark text for *italics* with "``*italics*``" or **bold** with -"``**bold**``". +"``**bold**``". This is called "inline markup". If you want something to appear as a fixed-space literal, use "````double back-quotes````". Note that no further fiddling is done @@ -73,7 +77,8 @@ alone. If you find that you want to use one of the "special" characters in text, it will generally be OK -- reStructuredText is pretty smart. -For example, this * asterisk is handled just fine. If you actually +For example, this lone asterisk * is handled just fine, as is the +asterisk in this equation: 5*6=30. If you actually want text \*surrounded by asterisks* to **not** be italicised, then you need to indicate that the asterisk is not special. You do this by placing a backslash just before it, like so "``\*``" (quickref__), or @@ -83,6 +88,14 @@ by enclosing it in double back-quotes (inline literals), like this:: __ quickref.html#escaping +.. Tip:: Think of inline markup as a form of (parentheses) and use it + the same way: immediately before and after the text being marked + up. Inline markup by itself (surrounded by whitespace) or in the + middle of a word won't be recognized. See the `markup spec`__ for + full details. + +__ ../../ref/rst/restructuredtext.html#inline-markup + Lists ----- |