"SfR Fresh" - the SfR Freeware/Shareware Archive

Member "docutils-0.5/docs/index.txt" of archive docutils-0.5.tar.gz:

As a special service "SfR Fresh" has tried to format the requested source page into HTML format using source code syntax highlighting with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field. 
    1 ==========================================
    2  Docutils_ Project Documentation Overview
    3 ==========================================
    4 
    5 :Author: David Goodger
    6 :Contact: goodger@python.org
    7 :Date: $Date: 2006-11-12 19:02:26 +0100 (Son, 12 Nov 2006) $
    8 :Revision: $Revision: 4803 $
    9 :Copyright: This document has been placed in the public domain.
   10 
   11 The latest working documents may be accessed individually below, or
   12 from the ``docs`` directory of the `Docutils distribution`_.
   13 
   14 .. _Docutils: http://docutils.sourceforge.net/
   15 .. _Docutils distribution: http://docutils.sourceforge.net/#download
   16 
   17 .. contents::
   18 
   19 
   20 Docutils Stakeholders
   21 =====================
   22 
   23 Docutils stakeholders can be categorized in several groups:
   24 
   25 1. End-users: users of reStructuredText and the Docutils tools.
   26    Although some are developers (e.g. Python developers utilizing
   27    reStructuredText for docstrings in their source), many are not.
   28 
   29 2. Client-developers: developers using Docutils as a library,
   30    programmers developing *with* Docutils.
   31 
   32 3. Component-developers: those who implement application-specific
   33    components, directives, and/or roles, separately from Docutils.
   34 
   35 4. Core-developers: developers of the Docutils codebase and
   36    participants in the Docutils project community.
   37 
   38 5. Re-implementers: developers of alternate implementations of
   39    Docutils.
   40 
   41 There's a lot of overlap between these groups.  Most (perhaps all)
   42 core-developers, component-developers, client-developers, and
   43 re-implementers are also end-users.  Core-developers are also
   44 client-developers, and may also be component-developers in other
   45 projects.  Component-developers are also client-developers.
   46 
   47 
   48 Project Fundamentals
   49 ====================
   50 
   51 These files are for all Docutils stakeholders.  They are kept at the
   52 top level of the Docutils project directory.
   53 
   54 :README.txt_: Project overview: quick-start, requirements,
   55               installation, and usage.
   56 :COPYING.txt_: Conditions for Docutils redistribution, with links to
   57                licenses.
   58 :FAQ.txt_: Docutils Frequently Asked Questions.  If you have a
   59            question or issue, there's a good chance it's already
   60            answered here.
   61 :BUGS.txt_: A list of known bugs, and how to report a bug.
   62 :RELEASE-NOTES.txt_: Summary of the major changes in recent releases.
   63 :HISTORY.txt_: Detailed change history log.
   64 :THANKS.txt_: Acknowledgements.
   65 
   66 .. _README.txt: ../README.html
   67 .. _BUGS.txt: ../BUGS.html
   68 .. _COPYING.txt: ../COPYING.html
   69 .. _Docutils FAQ:
   70 .. _FAQ.txt: ../FAQ.html
   71 .. _RELEASE-NOTES.txt: ../RELEASE-NOTES.html
   72 .. _HISTORY.txt: ../HISTORY.html
   73 .. _THANKS.txt: ../THANKS.html
   74 
   75 
   76 .. _user:
   77 
   78 ``user/``: Introductory & Tutorial Material for End-Users
   79 =========================================================
   80 
   81 Docutils-general:
   82 
   83 * `Docutils Front-End Tools <user/tools.html>`__
   84 * `Docutils Configuration <user/config.html>`__
   85 * `Docutils Mailing Lists <user/mailing-lists.html>`__
   86 * `Docutils Link List <user/links.html>`__
   87 
   88 Writer-specific:
   89 
   90 * `Easy Slide Shows With reStructuredText & S5 <user/slide-shows.html>`__
   91 * `Docutils LaTeX Writer <user/latex.html>`__
   92 
   93 `reStructuredText <http://docutils.sourceforge.net/rst.html>`_:
   94 
   95 * `A ReStructuredText Primer (HTML) <user/rst/quickstart.html>`__ (or
   96   `text source <user/rst/quickstart.txt>`__)
   97 * `Quick reStructuredText <user/rst/quickref.html>`__ (user reference)
   98 * `reStructuredText Cheat Sheet <user/rst/cheatsheet.txt>`__ (text
   99   only; 1 page for syntax, 1 page directive & role reference)
  100 * `reStructuredText Demonstration <user/rst/demo.html>`_ (a
  101   demonstration of most reStructuredText features; you can also have a
  102   look at the `text source <user/rst/demo.txt>`__)
  103 
  104 Editor support:
  105 
  106 * `Emacs support for reStructuredText <user/emacs.html>`_
  107 
  108 
  109 .. _ref:
  110 
  111 ``ref/``: Reference Material for All Groups
  112 ===========================================
  113 
  114 Many of these files began as developer specifications, but now that
  115 they're mature and used by end-users and client-developers, they have
  116 become reference material.  Successful specs evolve into refs.
  117 
  118 Docutils-general:
  119 
  120 * `The Docutils Document Tree <ref/doctree.html>`__ (incomplete)
  121 * `Docutils Transforms <ref/transforms.html>`__
  122 * `Docutils Generic DTD <ref/docutils.dtd>`__
  123 * `OASIS XML Exchange Table Model Declaration Module
  124   <ref/soextblx.dtd>`__ (CALS tables DTD module)
  125 
  126 Although not in the "ref" directory, `PEP 258`_ is a must-read
  127 reference for any Docutils developer.
  128 
  129 reStructuredText_:
  130 
  131 * `An Introduction to reStructuredText <ref/rst/introduction.html>`__
  132   (includes the `Goals <ref/rst/introduction.html#goals>`__ and
  133   `History <ref/rst/introduction.html#history>`__ of reStructuredText)
  134 * `reStructuredText Markup Specification <ref/rst/restructuredtext.html>`__
  135 * `reStructuredText Directives <ref/rst/directives.html>`__
  136 * `reStructuredText Interpreted Text Roles <ref/rst/roles.html>`__
  137 * `reStructuredText Standard Definition Files
  138   <ref/rst/definitions.html>`_
  139 
  140 Prehistoric:
  141 
  142 * `Setext Documents Mirror
  143   <http://docutils.sourceforge.net/mirror/setext.html>`__
  144 
  145 
  146 .. _peps:
  147 
  148 ``peps/``: Python Enhancement Proposals
  149 =======================================
  150 
  151 * `PEP 256: Docstring Processing System Framework`__ is a high-level
  152   generic proposal.  [`PEP 256`__ in the `master repository`_]
  153 * `PEP 257: Docstring Conventions`__ addresses docstring style and
  154   touches on content.  [`PEP 257`__ in the `master repository`_]
  155 * `PEP 258: Docutils Design Specification`__ is an overview of the
  156   architecture of Docutils.  It documents design issues and
  157   implementation details.  [`PEP 258`__ in the `master repository`_]
  158 * `PEP 287: reStructuredText Docstring Format`__ proposes a standard
  159   markup syntax.  [`PEP 287`__ in the `master repository`_]
  160 
  161 Please note that PEPs in the `master repository`_ may not be current,
  162 whereas the local versions are.
  163 
  164 __ peps/pep-0256.html
  165 __ http://www.python.org/peps/pep-0256.html
  166 __ peps/pep-0257.html
  167 __ http://www.python.org/peps/pep-0257.html
  168 .. _PEP 258:
  169 __ peps/pep-0258.html
  170 __ http://www.python.org/peps/pep-0258.html
  171 __ peps/pep-0287.html
  172 __ http://www.python.org/peps/pep-0287.html
  173 .. _master repository: http://www.python.org/peps/
  174 
  175 
  176 .. _api:
  177 
  178 ``api/``: API Reference Material for Client-Developers
  179 ======================================================
  180 
  181 * `The Docutils Publisher <api/publisher.html>`__
  182 * `Inside A Docutils Command-Line Front-End Tool <api/cmdline-tool.html>`__
  183 * `Docutils Runtime Settings <api/runtime-settings.html>`__
  184 * (`Docutils Transforms <ref/transforms.html>`__ should be moved here)
  185 
  186 `PEP 258`_ is an overview of the architecture of Docutils.
  187 
  188 
  189 .. _howto:
  190 
  191 ``howto/``: Instructions for Developers
  192 =======================================
  193 
  194 * **Security:** `Deploying Docutils Securely <howto/security.html>`__
  195 * `Writing HTML (CSS) Stylesheets for Docutils
  196   <howto/html-stylesheets.html>`__
  197 * `Docutils Internationalization <howto/i18n.html>`__
  198 * `Creating reStructuredText Directives <howto/rst-directives.html>`__
  199 * `Creating reStructuredText Interpreted Text Roles
  200   <howto/rst-roles.html>`__
  201 
  202 
  203 .. _dev:
  204 
  205 ``dev/``: Development Notes and Plans for Core-Developers
  206 =========================================================
  207 
  208 Docutils-general:
  209 
  210 * `Docutils Hacker's Guide <dev/hacking.html>`__
  211 * `Docutils Distributor's Guide <dev/distributing.html>`__
  212 * `Docutils To Do List <dev/todo.html>`__
  213 * `Docutils Project Policies <dev/policies.html>`__
  214 * `Docutils Web Site <dev/website.html>`__
  215 * `Docutils Release Procedure <dev/release.html>`__
  216 * `The Docutils Subversion Repository <dev/repository.html>`__
  217 * `Docutils Testing <dev/testing.html>`__
  218 * `Docstring Semantics <dev/semantics.html>`__ (incomplete)
  219 * `Python Source Reader <dev/pysource.html>`_ (incomplete)
  220 * `Docutils Python DTD <dev/pysource.dtd>`_ (experimental)
  221 * `Plan for Enthought API Documentation Tool <dev/enthought-plan.html>`_
  222 * `Enthought API Documentation Tool RFP <dev/enthought-rfp.html>`_
  223 
  224 reStructuredText_:
  225 
  226 * `A Record of reStructuredText Syntax Alternatives
  227   <dev/rst/alternatives.html>`__
  228 * `Problems With StructuredText <dev/rst/problems.html>`__
  229 
  230 
  231 ..
  232    Local Variables:
  233    mode: indented-text
  234    indent-tabs-mode: nil
  235    sentence-end-double-space: t
  236    fill-column: 70
  237    End: