Differences between revisions 1 and 9 (spanning 8 versions)
⇤ ← Revision 1 as of 2005-04-28 08:17:31 →
Size: 636
Editor: dyn176202
Comment:
← Revision 9 as of 2008-10-03 20:19:42 → ⇥
Size: 1470
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
The purpose of the Docutils project is to create a set of tools for
processing plaintext documentation into useful formats, such as HTML,
XML, and LaTeX. Includes reStructuredText_, the easy to read, easy to
use, what-you-see-is-what-you-get plaintext markup language. Several
sources are or will be supported:		 .. contents::
Line 9: Line 5:
- Standalone files (implemented).
- Inline documentation from Python modules and packages, extracted
  with namespace context.
- `PEPs (Python Enhancement Proposals)`_ (implemented).
- And others as discovered.		 reStructuredText_ is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for stand-alone documents. !ReStructuredText is designed for extensibility for specific application domains. reStructuredText_ is a revision and re-interpretation of the !StructuredText and Setext lightweight markup systems.

Links
=====
* reStructuredText_
* `Quick Reference`__
* Docutils_

__ http://docutils.sourceforge.net/docs/user/rst/quickref.html

WinEdt shortcuts
================
Suppose docutils is installed properly in ::
 
 C:\Python23\Lib\site-packages\docutils

and the docutils tools are copied to ::

 C:\Python23\Lib\site-packages\docutils\tools

In WinEdit, add a Macro menu item, with *Macro* as::
 
 WinExe('','python C:\Python23\Lib\site-packages\docutils\tools\rst2latex.py "%n%t" "%n_reST.tex" ','%p','reST to LaTeX',1110,0,'', '', '%N.log'); CMD("Errors...");

and *Require File Filter* as::

 %p\%n.txt

tick "Requires a Document" and "Save Input File to Disk". Then we are done.

Start a reST file with an .txt extenstion, say watever.txt, and run the macro from the menu, the generated LaTeX file whatever_reST.tex is ready to fly.
Line 16: Line 38:
.. _PEPs:
.. _PEPs (Python Enhancement Proposals): http://www.python.org/peps/		 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Docutils: http://docutils.sourceforge.net/
Rendering of reStructured text is not possible, please install Docutils.

.. contents::

reStructuredText_ is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for stand-alone documents. !ReStructuredText is designed for extensibility for specific application domains. reStructuredText_ is a revision and re-interpretation of the !StructuredText and Setext lightweight markup systems.

Links
=====
* reStructuredText_
* `Quick Reference`__
* Docutils_

__ http://docutils.sourceforge.net/docs/user/rst/quickref.html

WinEdt shortcuts
================
Suppose docutils is installed properly in ::
 
 C:\Python23\Lib\site-packages\docutils

and the docutils tools are copied to ::

 C:\Python23\Lib\site-packages\docutils\tools

In WinEdit, add a Macro menu item, with *Macro* as::
 
 WinExe('','python C:\Python23\Lib\site-packages\docutils\tools\rst2latex.py "%n%t" "%n_reST.tex" ','%p','reST to LaTeX',1110,0,'', '', '%N.log'); CMD("Errors...");

and *Require File Filter* as::

 %p\%n.txt

tick "Requires a Document" and "Save Input File to Disk". Then we are done.

Start a reST file with an .txt extenstion, say watever.txt, and run the macro from the menu, the generated LaTeX file whatever_reST.tex is ready to fly.


.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Docutils: http://docutils.sourceforge.net/

JunHu: JunHu/Memo/ReStructuredText (last edited 2008-10-03 20:19:42 by localhost)