[Zope-Checkins] CVS: Zope/lib/python/reStructuredText - reStructuredText.txt:1.1

[Andreas Jung]

Update of /cvs-repository/Zope/lib/python/reStructuredText
In directory cvs.zope.org:/tmp/cvs-serv22589

Added Files:
	reStructuredText.txt 
Log Message:
added


=== Added File Zope/lib/python/reStructuredText/reStructuredText.txt === (2575/2675 lines abridged)

  reStructuredText Markup Specification

Author: David Goodger
Contact: goodger@users.sourceforge.net
<mailto:goodger@users.sourceforge.net>
Revision: 1.34
Date: 2003-01-21

Note

This document is a detailed technical specification; it is not a
tutorial or a primer. If this is your first exposure to
reStructuredText, please read A ReStructuredText Primer
<../../docs/rst/quickstart.html> and the Quick reStructuredText
<../../docs/rst/quickref.html> user reference first.

reStructuredText <http://docutils.sourceforge.net/rst.html> is plaintext
that uses simple and intuitive constructs to indicate the structure of a
document. These constructs are equally easy to read in raw and processed
forms. This document is itself an example of reStructuredText (raw, if
you are reading the text file, or processed, if you are reading an HTML
document, for example). The reStructuredText parser is a component of
Docutils <http://docutils.sourceforge.net/>.

Simple, implicit markup is used to indicate special constructs, such as
section headings, bullet lists, and emphasis. The markup used is as
minimal and unobtrusive as possible. Less often-used constructs and
extensions to the basic reStructuredText syntax may have more elaborate
or explicit markup.

reStructuredText is applicable to documents of any length, from the very
small (such as inline program documentation fragments, e.g. Python
docstrings) to the quite large (this document).

The first section gives a quick overview of the syntax of the
reStructuredText markup by example. A complete specification is given in
the Syntax Details <#syntax-details> section.

Literal blocks <#literal-blocks> (in which no markup processing is done)
are used for examples throughout this document, to illustrate the
plaintext markup.

Contents

    * Quick Syntax Overview <#quick-syntax-overview>
    * Syntax Details <#syntax-details>
          o Whitespace <#whitespace>
                + Blank Lines <#blank-lines>
                + Indentation <#indentation>

[-=- -=- -=- 2575 lines omitted -=- -=- -=-]


            Hierarchical identifiers begin with one or two slashes and
            may use slashes to separate hierarchical components of the
            path. Examples are web pages and FTP sites:

http://www.python.org

ftp://ftp.python.org/pub/python

          *

            Opaque identifiers do not begin with slashes. Examples are
            email addresses and newsgroups:

mailto:someone@somewhere.com

news:comp.lang.python

      With queries, fragments, and %-escape sequences, URIs can become
      quite complicated. A reStructuredText parser must be able to
      recognize any absolute URI, as defined in RFC2396
      <http://www.rfc-editor.org/rfc/rfc2396.txt> and RFC2732
      <http://www.rfc-editor.org/rfc/rfc2732.txt>.

   2.

      Standalone email addresses, which are treated as if they were
      absolute URIs with a "mailto:" scheme. Example:

someone@somewhere.com

Punctuation at the end of a URI is not considered part of the URI.

[8] <#id15> Uniform Resource Identifier. URIs are a general form of URLs
(Uniform Resource Locators). For the syntax of URIs see RFC2396
<http://www.rfc-editor.org/rfc/rfc2396.txt> and RFC2732
<http://www.rfc-editor.org/rfc/rfc2732.txt>.


  Error Handling <#id66>

DTD element: system_message, problematic.

Markup errors are handled according to the specification in PEP 258
<http://docutils.sourceforge.net/spec/pep-0258.txt>.

------------------------------------------------------------------------
View document source <reStructuredText.txt>. Generated on: 2003-01-21
18:52 UTC. Generated by Docutils <http://docutils.sourceforge.net/> from
reStructuredText <http://docutils.sourceforge.net/rst.html> source.