summaryrefslogtreecommitdiff
path: root/docs/user/rst/quickstart.txt
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2002-11-03 04:28:21 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2002-11-03 04:28:21 +0000
commit6f29cffd10c80e604b5298fbecf046c2c9657cc6 (patch)
treecb4be407379a0706eb21b119fc20376434813d9b /docs/user/rst/quickstart.txt
parent9b6399c61cdd1c032bfb71ce1d46ed293bdc94fa (diff)
downloaddocutils-6f29cffd10c80e604b5298fbecf046c2c9657cc6.tar.gz
Replaced stilted section example with abstract output.
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@882 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/user/rst/quickstart.txt')
-rw-r--r--docs/user/rst/quickstart.txt42
1 files changed, 24 insertions, 18 deletions
diff --git a/docs/user/rst/quickstart.txt b/docs/user/rst/quickstart.txt
index c40c67cdd..5426e9c93 100644
--- a/docs/user/rst/quickstart.txt
+++ b/docs/user/rst/quickstart.txt
@@ -269,24 +269,30 @@ underline style are deemed to be at the same level::
Chapter 2 Title
===============
-results in:
-
-.. sorry, I change the heading style here, but it's only an example :)
-
-Chapter 1 Title
-~~~~~~~~~~~~~~~
-
-Section 1.1 Title
-'''''''''''''''''
-
-Subsection 1.1.1 Title
-""""""""""""""""""""""
-
-Section 1.2 Title
-'''''''''''''''''
-
-Chapter 2 Title
-~~~~~~~~~~~~~~~
+This results in the following structure, illustrated by simplified
+pseudo-XML::
+
+ <section>
+ <title>
+ Chapter 1 Title
+ <section>
+ <title>
+ Section 1.1 Title
+ <section>
+ <title>
+ Subsection 1.1.1 Title
+ <section>
+ <title>
+ Section 1.2 Title
+ <section>
+ <title>
+ Chapter 2 Title
+
+(Pseudo-XML uses indentation for nesting and has no end-tags. It's
+not possible to show actual processed output, as in the other
+examples, because sections cannot exist inside block quotes. For a
+concrete example, compare the section structure of this document's
+source text and processed output.)
Note that section headers are available as link targets, just using
their name. To link to the Lists_ heading, I write "``Lists_``". If