prest/doc/src/prest_intro.rst

   1 ======================
   2 Introduction to Prest
   3 ======================
   4 :Author: Mark Nodine
   5 :Contact: mnodine@alum.mit.edu
   6 :Revision: $Revision: 762 $
   7 :Date: $Date: 2006-01-27 11:47:47 -0600 (Fri, 27 Jan 2006) $
   8 :Copyright: This document has been placed in the public domain.
   9
  10 .. contents::
  11
  12 --------------
  13  Introduction
  14 --------------
  15
  16 This document gives an introduction to the ``prest`` program, which is
  17 a Perl implementation of a reStructuredText_ parser (and writers) and
  18 gives a map of the documentation.
  19
  20 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
  21
  22 reStructuredText_ is an easy-to-read, what-you-see-is-what-you-get
  23 plaintext markup syntax and parser system.  It is useful for inline
  24 program documentation (such as Python docstrings), for quickly
  25 creating simple web pages, and for standalone documents.  This web
  26 page was generated from reStructuredText.  The original implementation
  27 of a reStructuredText parser is that of the docutils_ project, written
  28 in Python.  The "prest" name is an acronym for "***P***\ erl
  29 ***reS***\ tructured\ ***T***\ ext".
  30
  31 .. _docutils: http://docutils.sourceforge.net
  32
  33 ---------------
  34  Documentation
  35 ---------------
  36
  37 Since prest is a re-implementation of a reStructuredText parser, it has
  38 diverged from the original Python version, both because the Python
  39 version has made changes not tracked by the Perl version and because
  40 the Perl version has added some innovations of its own.  So the
  41 documentation references have potentially three versions: the prest
  42 version, the Docutils version, and a difference between the two.
  43 The difference is based on the latest Docutils version available when
  44 the prest documentation was compiled.
  45
  46 ======================================== ================= ==================== ======
  47 A ReStructuredText Primer                                  `docutils version`__
  48 Quick reStructuredText                                     `docutils version`__
  49 An Introduction to reStructuredText      `prest version`__ `docutils version`__ diff__
  50 reStructuredText Markup Specification    `prest version`__ `docutils version`__ diff__
  51 reStructuredText Directives              `prest version`__ `docutils version`__ diff__
  52 reStructuredText Interpreted Text Roles  `prest version`__ `docutils version`__ diff__
  53 Usage of Prest                           `prest version`__
  54 Internals of Prest                       `prest version`__
  55 How to Extend Prest                      `prest version`__
  56 Prest Release Notes                      `prest version`__
  57 ======================================== ================= ==================== ======
  58
  59 __ http://docutils.sourceforge.net/docs/rst/quickstart.html
  60
  61 __ http://docutils.sourceforge.net/docs/rst/quickref.html
  62
  63 __ introduction.html
  64 __ http://docutils.sourceforge.net/docs/ref/rst/introduction.html
  65 __ introduction_diff.html
  66
  67 __ reStructuredText.html
  68 __ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
  69 __ reStructuredText_diff.html
  70
  71 __ directives.html
  72 __ http://docutils.sourceforge.net/docs/ref/rst/directives.html
  73 __ directives_diff.html
  74
  75 __ roles.html
  76 __ http://docutils.sourceforge.net/docs/ref/rst/roles.html
  77 __ roles_diff.html
  78
  79 __ prest_usage.html
  80
  81 __ prest_internals.html
  82
  83 __ prest_extend.html
  84
  85 __ prest_releases.html
  86 \f
  87 ..
  88    Local Variables:
  89    mode: indented-text
  90    indent-tabs-mode: nil
  91    sentence-end-double-space: t
  92    fill-column: 70
  93    End: