On 07/09/2009 12:19 PM, Xavier de Gaye wrote:
>  On Thu, Jul 9, 2009 at 11:17 AM, Carsten Agger wrote:
> > ...
> > This script allows simple formatting like *italics* and _underline_, but
> > I'd like something a but more "shiny", which would e.g. also recognize
> > chapter and section headings and maybe even generate a TOC.
>
>  You may want to have a look at docutils, http://docutils.sourceforge.net/
>
>  "Docutils is an open-source text processing system for processing
>  plaintext documentation into useful formats, such as HTML or LaTeX. It
>  includes reStructuredText, the easy to read, easy to use,
>  what-you-see-is-what-you-get plaintext markup language."
>
>  reStructuredText handles TOC, headings, lists, tables. The markup
>  is such that the original text can be easily read as a plain text.
>
>  reStructuredText is used for the Python documentation.

I'm fond of reStructuredText as well.  The Python project
uses Sphinx (http://sphinx.pocoo.org/):

"Sphinx uses reStructuredText  as its markup language, and many
of its strengths come from the power and straightforwardness of
reStructuredText and its parsing and translating suite, the
Docutils."

The web page lists these features:

     - Output formats: HTML (including Windows HTML Help) and
       LaTeX, for printable PDF versions

     - Extensive cross-references: semantic markup and automatic
       links for functions, classes, glossary terms and similar
       pieces of information

     - Hierarchical structure: easy definition of a document
       tree, with automatic links to siblings, parents and
       children

     - Automatic indices: general index as well as a module index

     - Code handling: automatic highlighting using the Pygments
       highlighter

     - Extensions: automatic testing of code snippets, inclusion
       of docstrings from Python modules, and more

Sphinx is based on Docutils (the tools for processing
reStructuredText).  The main benefit over raw Docutils for my
purposes is the ability to link between multiple text files.

Michael Henry


--~--~---------~--~----~------------~-------~--~----~
You received this message from the "vim_use" maillist.
For more information, visit http://www.vim.org/maillist.php
-~----------~----~----~----~------~----~------~--~---

Reply via email to