merge from ajung-restructuredtext-integration-branch

doc/CHANGES.txt

@@ -33,6 +33,9 @@ Zope Changes
        than one attribute of an object. This removes the ties between the
        indexes ID and the attribute name to be indexed. 
 
+     - Integration of reStructuredText (reST). 
+       See doc/RESTRUCTUREDTEXT.txt for details.
+
     Bugs Fixed
 
      - Collector #771: ZCatalog failed to index DTML Document if the name

doc/RESTRUCTUREDSTEXT.txt

+Integration of reStructuredText (reST) in Zope:
+
+Zope 2.7 or higher integrates reST as part of the Python
+docutils package. The syntax of reST is defined under
+
+    http://docutils.sf.net/spec/rst/introduction.html
+
+
+Usage inside DTML:
+
+     <dtml-var rest-document fmt="restructured-text">
+
+
+Usage inside ZPT:
+
+    <span tal:content="structure python: modules['Products.PythonScripts.standard'].restructured_test(rest_txt)" />
+
+
+Usage inside PythonScripts:
+
+    from Products.PythonScripts.standard import restructured_text
+
+    rendered_html = restructured_test(rest_txt)
+    return rendered_html
+
+
+Usage inside Zope products:
+
+    from reStructuredText import HTML
+    rendered_html = HTML(rest_txt)
+    ...
+
+Character set issues:
+
+   reST processes the reST document internally using unicode. A reST
+   document is converted using Pythons default encoding to unicode and
+   converted back from unicode to the default encoding on the output side.
+   This means you must ensure that Python default encoding is properly.
+
+   You can customize the default encoding by creating a file sitecustomize.py
+   somewhere in yout PYTHONPATH:
+
+      import sys
+      sys.setdefaultencoding("iso-8859-1")
+
+
+
+This version of Zope also includes the ZReST product written by Richard Jones.
+ZRest is a standalone Zope product to handle reStructuredText documents.
+

lib/python/DocumentTemplate/DT_Var.py

@@ -151,8 +151,8 @@ Evaluating expressions without rendering results
 
 
 ''' # '
-__rcs_id__='$Id: DT_Var.py,v 1.58 2002/09/16 10:09:11 htrd Exp $'
-__version__='$Revision: 1.58 $'[11:-2]
+__rcs_id__='$Id: DT_Var.py,v 1.59 2003/02/01 09:25:58 andreasjung Exp $'
+__version__='$Revision: 1.59 $'[11:-2]
 
 from DT_Util import parse_params, name_param, str, ustr
 import os, string, re,  sys
@@ -396,6 +396,18 @@ def len_format(v, name='(Unknown name)', md={}):
 def len_comma(v, name='(Unknown name)', md={}):
     return thousands_commas(str(len(v)))
 
+def restructured_text(v, name='(Unknown name)', md={}):
+
+    from reStructuredText import HTML
+
+    if isinstance(v,StringType): txt = v
+    elif aq_base(v).meta_type in ['DTML Document','DTML Method']:
+        txt = aq_base(v).read_raw()
+    else: txt = str(v)
+
+    return HTML(txt)
+
+
 StructuredText=None
 def structured_text(v, name='(Unknown name)', md={}):
     global StructuredText
@@ -428,6 +440,7 @@ special_formats={
     'dollars-and-cents': dollars_and_cents,
     'collection-length': len_format,
     'structured-text': structured_text,
+    'restructured-text': restructured_text,
 
     # The rest are deprecated:
     'sql-quote': sql_quote,

lib/python/Products/ZReST/Makefile

+FILES = ZReST.py __init__.py refresh.txt version.txt TODO.txt README.txt
+DTML = dtml/manage_addZReSTForm.dtml dtml/manage_editForm.dtml
+VERSION := $(shell cat version.txt)
+
+all: ${FILES} ${DTML}
+	rm -rf dist
+	mkdir dist
+	mkdir dist/ZReST
+	mkdir dist/ZReST/dtml
+	cp ${FILES} dist/ZReST
+	cp ${DTML}  dist/ZReST/dtml
+	(cd dist; tar zcf ZReST-${VERSION}.tgz ZReST)
+	mv dist/ZReST-${VERSION}.tgz .
+	rm -rf dist
+

lib/python/Products/ZReST/README.txt

+----------------------------------
+ReStructuredText Document for Zope
+----------------------------------
+
+Requirements
+============
+
+To use this product, you will need:
+
+python2.1+
+   see http://www.python.org/
+Zope 2.5+
+   see http://www.zope.org/
+A docutils snapshot from later than 21 August 2002
+   see http://docutils.sourceforge.net/#development-snapshots
+
+Installation
+============
+
+To install this product, unpack it so the ZReST directory is in the Zope
+lib/python/Products directory. You should then restart Zope.
+
+You will now be able to add objects of type "ReStructuredText Document".
+
+Usage
+=====
+
+See the docutils user documentation section:
+
+   http://docutils.sourceforge.net/#user-documentation
+
+I recommend starting with the ReST "primer":
+
+   http://docutils.sourceforge.net/docs/rst/quickstart.html
+
+
+Footnotes
+=========
+
+This product was written by Richard Jones, rjones@ekit-inc.com.
+
+Please direct questions about ReStructureText to the docutils mailing lists.
+
+This package is placed in the Public Domain.
+

lib/python/Products/ZReST/TODO.txt

+. charset configuration, defaulting to 'latin-1'
+. add "level" and "header" args to render / as_html
+  - level indicates the header level to start at
+  - header boolean turns page header tags on/off
+

lib/python/Products/ZReST/__init__.py

+# 
+# $Id: __init__.py,v 1.2 2003/02/01 09:28:30 andreasjung Exp $
+#
+__version__='1.0'
+
+# product initialisation
+import ZReST
+def initialize(context):
+    context.registerClass(
+        ZReST, meta_type = 'ReStructuredText Document',
+        constructors = (
+            ZReST.manage_addZReSTForm, ZReST.manage_addZReST
+        )
+    )
+
+
+#
+# $Log: __init__.py,v $
+# Revision 1.2  2003/02/01 09:28:30  andreasjung
+# merge from ajung-restructuredtext-integration-branch
+#
+# Revision 1.1.2.2  2002/11/06 16:09:36  andreasjung
+# updated to ZReST 1.1
+#
+# Revision 1.2  2002/08/15 04:36:56  richard
+# FTP interface and Reporter message snaffling
+#
+# Revision 1.1  2002/08/14 05:15:37  richard
+# Zope ReStructuredText Product
+#
+#
+#
+# vim: set filetype=python ts=4 sw=4 et si

lib/python/Products/ZReST/dtml/manage_addZReSTForm.dtml

+<dtml-var manage_page_header>
+
+<dtml-var "manage_form_title(this(), _, form_title='Add ReStructureText Document')">
+
+<p class="form-help">
+You may optionally select a file to upload from your local computer by
+clicking the <em>Browse</em> button.
+</p>
+
+<form action="manage_addZReST" method="post" enctype="multipart/form-data">
+<table cellspacing="0" cellpadding="2" border="0">
+  <tr>
+    <td align="left" valign="top">
+    <div class="form-label">
+    Id
+    </div>
+    </td>
+    <td align="left" valign="top">
+    <input type="text" name="id" size="40" />
+    </td>
+  </tr>
+  <tr>
+    <td align="left" valign="top">
+    <div class="form-optional">
+    File
+    </div>
+    </td>
+    <td align="left" valign="top">
+    <input type="file" name="file" size="25" value="" />
+    </td>
+  </tr>
+  <tr>
+    <td align="left" valign="top">
+    </td>
+    <td align="left" valign="top">
+    <div class="form-element">
+    <input class="form-element" type="submit" name="submit" 
+     value=" Add " /> 
+    </div>
+    </td>
+  </tr>
+</table>
+</form>
+
+<dtml-var manage_page_footer>

lib/python/Products/ZReST/dtml/manage_editForm.dtml

+<dtml-var manage_page_header>
+<dtml-var manage_tabs>
+
+<p class="form-help">
+You may edit the source for this document using the form below. You 
+may also upload the source for this document from a local file. Click
+the <em>browse</em> button to select a local file to upload.
+</p>
+
+<dtml-if warnings>
+<pre class="system-msg">
+&dtml-warnings;
+</pre>
+</dtml-if>
+
+<p class="form-help"><strong>Help:</strong> ReStructuredText
+ <a href="http://docutils.sourceforge.net/docs/rst/quickstart.html">primer</a>
+  for beginners,
+ <a href="http://docutils.sourceforge.net/docs/rst/quickref.html">quick
+  reference</a> for the more advanced and
+ <a href="http://docutils.sourceforge.net/rst.html">home page</a> for all
+  the details.
+</p>
+
+<form action="manage_edit" method="post">
+<table cellpadding="2" cellspacing="0" width="100%" border="0">
+
+<dtml-with keyword_args mapping>
+<tr>
+  <td align="left" valign="top" colspan="2">
+  <div style="width: 100%;">
+  <textarea name="data:text" wrap="off" style="width: 100%;"<dtml-if 
+   dtpref_cols> cols="<dtml-var dtpref_cols>"<dtml-else
+   > cols="50"</dtml-if><dtml-if dtpref_rows> rows="<dtml-var 
+   dtpref_rows>"<dtml-else> rows="20"</dtml-if>><dtml-var 
+   __str__></textarea>
+  </div>
+  </td>
+</tr>
+</dtml-with>
+
+<tr>
+  <td align="left" valign="top" colspan="2">
+  <div class="form-element">
+  <dtml-if wl_isLocked>
+   <em>Locked by WebDAV</em>
+  <dtml-else>
+   <input class="form-element" type="submit" name="SUBMIT" value="Save Changes">
+  </dtml-if>
+  &nbsp;&nbsp;
+  <input class="form-element" type="submit" name="SUBMIT" value="Taller">
+  <input class="form-element" type="submit" name="SUBMIT" value="Shorter">
+  <input class="form-element" type="submit" name="SUBMIT" value="Wider">
+  <input class="form-element" type="submit" name="SUBMIT" value="Narrower">
+  </div>
+  </td>
+</tr>
+</table>
+</form>
+
+<form action="manage_upload" method="post" enctype="multipart/form-data">
+<table cellpadding="2" cellspacing="0" border="0">
+<tr>
+  <td align="left" valign="top">
+  <div class="form-label">
+  File &nbsp;
+  </div>
+  </td>
+  <td align="left" valign="top">
+  <input type="file" name="file" size="25" value="">
+  </td>
+</tr>
+<tr>
+  <td></td>
+  <td align="left" valign="top">
+  <div class="form-element">
+  <dtml-if wl_isLocked>
+   <em>Locked by WebDAV</em>
+  <dtml-else>
+   <input class="form-element" type="submit" value="Upload File">
+  </dtml-if>
+  </div>
+  </td>
+</tr>
+</table>
+</form>
+
+<dtml-var manage_page_footer>

lib/python/Products/ZReST/refresh.txt

+This is a flag that tells Zope that the product may be auto-refreshed.

lib/python/Products/ZReST/version.txt

+1.1

lib/python/docutils/__init__.py

+# Author: David Goodger
+# Contact: goodger@users.sourceforge.net
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:00 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+This is the Docutils (Python Documentation Utilities) package.
+
+Package Structure
+=================
+
+Modules:
+
+- __init__.py: Contains the package docstring only (this text).
+
+- core.py: Contains the ``Publisher`` class and ``publish()`` convenience
+  function.
+
+- frontend.py: Command-line and common processing for Docutils front-ends.
+
+- io.py: Provides a uniform API for low-level input and output.
+
+- nodes.py: Docutils document tree (doctree) node class library.
+
+- optik.py: Option parsing and command-line help; from Greg Ward's
+  http://optik.sf.net/ project, included for convenience.
+
+- roman.py: Conversion to and from Roman numerals. Courtesy of Mark
+  Pilgrim (http://diveintopython.org/).
+
+- statemachine.py: A finite state machine specialized for
+  regular-expression-based text filters.
+
+- urischemes.py: Contains a complete mapping of known URI addressing
+  scheme names to descriptions.
+
+- utils.py: Contains the ``Reporter`` system warning class and miscellaneous
+  utilities.
+
+Subpackages:
+
+- languages: Language-specific mappings of terms.
+
+- parsers: Syntax-specific input parser modules or packages.
+
+- readers: Context-specific input handlers which understand the data
+  source and manage a parser.
+
+- transforms: Modules used by readers and writers to modify DPS
+  doctrees.
+
+- writers: Format-specific output translators.
+"""
+
+__docformat__ = 'reStructuredText'
+
+__version__ = '0.2.8'
+"""``major.minor.micro`` version number.  The micro number is bumped any time
+there's a change in the API incompatible with one of the front ends.  The
+minor number is bumped whenever there is a project release.  The major number
+will be bumped when the project is complete, and perhaps if there is a major
+change in the design."""
+
+
+class ApplicationError(StandardError): pass
+class DataError(ApplicationError): pass
+
+
+class SettingsSpec:
+
+    """
+    Runtime setting specification base class.
+
+    SettingsSpec subclass objects used by `docutils.frontend.OptionParser`.
+    """
+
+    settings_spec = ()
+    """Runtime settings specification.  Override in subclasses.
+
+    Specifies runtime settings and associated command-line options, as used by
+    `docutils.frontend.OptionParser`.  This tuple contains one or more sets of
+    option group title, description, and a list/tuple of tuples: ``('help
+    text', [list of option strings], {keyword arguments})``.  Group title
+    and/or description may be `None`; no group title implies no group, just a
+    list of single options.  Runtime settings names are derived implicitly
+    from long option names ("--a-setting" becomes ``settings.a_setting``) or
+    explicitly from the "destination" keyword argument."""
+
+    settings_default_overrides = None
+    """A dictionary of auxiliary defaults, to override defaults for settings
+    defined in other components.  Override in subclasses."""
+
+    relative_path_settings = ()
+    """Settings containing filesystem paths.  Override in subclasses.
+
+    Settings listed here are to be interpreted relative to the current working
+    directory."""
+
+
+class TransformSpec:
+
+    """
+    Runtime transform specification base class.
+
+    TransformSpec subclass objects used by `docutils.transforms.Transformer`.
+    """
+
+    default_transforms = ()
+    """Transforms required by this class.  Override in subclasses."""
+
+
+class Component(SettingsSpec, TransformSpec):
+
+    """Base class for Docutils components."""
+
+    component_type = None
+    """Override in subclasses."""
+
+    supported = ()
+    """Names for this component.  Override in subclasses."""
+
+    def supports(self, format):
+        """
+        Is `format` supported by this component?
+
+        To be used by transforms to ask the dependent component if it supports
+        a certain input context or output format.
+        """
+        return format in self.supported

lib/python/docutils/io.py

+# Author: David Goodger
+# Contact: goodger@users.sourceforge.net
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:00 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+I/O classes provide a uniform API for low-level input and output.  Subclasses
+will exist for a variety of input/output mechanisms.
+"""
+
+__docformat__ = 'reStructuredText'
+
+import sys
+import locale
+from docutils import TransformSpec
+
+
+class Input(TransformSpec):
+
+    """
+    Abstract base class for input wrappers.
+    """
+
+    component_type = 'input'
+
+    default_source_path = None
+
+    def __init__(self, settings=None, source=None, source_path=None,
+                 encoding=None):
+        self.encoding = encoding
+        """The character encoding for the input source."""
+
+        if settings:
+            if not encoding:
+                self.encoding = settings.input_encoding
+            import warnings, traceback
+            warnings.warn(
+                'Setting input encoding via a "settings" struct is '
+                'deprecated; send encoding directly instead.\n%s'
+                % ''.join(traceback.format_list(traceback.extract_stack()
+                                                [-3:-1])))
+
+        self.source = source
+        """The source of input data."""
+
+        self.source_path = source_path
+        """A text reference to the source."""
+
+        if not source_path:
+            self.source_path = self.default_source_path
+
+    def __repr__(self):
+        return '%s: source=%r, source_path=%r' % (self.__class__, self.source,
+                                                  self.source_path)
+
+    def read(self):
+        raise NotImplementedError
+
+    def decode(self, data):
+        """
+        Decode a string, `data`, heuristically.
+        Raise UnicodeError if unsuccessful.
+
+        The client application should call ``locale.setlocale`` at the
+        beginning of processing::
+
+            locale.setlocale(locale.LC_ALL, '')
+        """
+        if self.encoding and self.encoding.lower() == 'unicode':
+            return unicode(data)
+        encodings = [self.encoding, 'utf-8']
+        try:
+            encodings.append(locale.nl_langinfo(locale.CODESET))
+        except:
+            pass
+        try:
+            encodings.append(locale.getlocale()[1])
+        except:
+            pass
+        try:
+            encodings.append(locale.getdefaultlocale()[1])
+        except:
+            pass
+        encodings.append('latin-1')
+        for enc in encodings:
+            if not enc:
+                continue
+            try:
+                decoded = unicode(data, enc)
+                return decoded
+            except (UnicodeError, LookupError):
+                pass
+        raise UnicodeError(
+            'Unable to decode input data.  Tried the following encodings: %s.'
+            % ', '.join([repr(enc) for enc in encodings if enc]))
+
+
+class Output(TransformSpec):
+
+    """
+    Abstract base class for output wrappers.
+    """
+
+    component_type = 'output'
+
+    default_destination_path = None
+
+    def __init__(self, settings=None, destination=None, destination_path=None,
+                 encoding=None):
+        self.encoding = encoding
+        """The character encoding for the output destination."""
+
+        if settings:
+            if not encoding:
+                self.encoding = settings.output_encoding
+            import warnings, traceback
+            warnings.warn(
+                'Setting output encoding via a "settings" struct is '
+                'deprecated; send encoding directly instead.\n%s'
+                % ''.join(traceback.format_list(traceback.extract_stack()
+                                                [-3:-1])))
+
+        self.destination = destination
+        """The destination for output data."""
+
+        self.destination_path = destination_path
+        """A text reference to the destination."""
+
+        if not destination_path:
+            self.destination_path = self.default_destination_path
+
+    def __repr__(self):
+        return ('%s: destination=%r, destination_path=%r'
+                % (self.__class__, self.destination, self.destination_path))
+
+    def write(self, data):
+        raise NotImplementedError
+
+    def encode(self, data):
+        if self.encoding and self.encoding.lower() == 'unicode':
+            return data
+        else:
+            return data.encode(self.encoding or '')
+
+
+class FileInput(Input):
+
+    """
+    Input for single, simple file-like objects.
+    """
+
+    def __init__(self, settings=None, source=None, source_path=None,
+                 encoding=None, autoclose=1):
+        """
+        :Parameters:
+            - `source`: either a file-like object (which is read directly), or
+              `None` (which implies `sys.stdin` if no `source_path` given).
+            - `source_path`: a path to a file, which is opened and then read.
+            - `autoclose`: close automatically after read (boolean); always
+              false if `sys.stdin` is the source.
+        """
+        Input.__init__(self, settings, source, source_path, encoding)
+        self.autoclose = autoclose
+        if source is None:
+            if source_path:
+                self.source = open(source_path)
+            else:
+                self.source = sys.stdin
+                self.autoclose = None
+        if not source_path:
+            try:
+                self.source_path = self.source.name
+            except AttributeError:
+                pass
+
+    def read(self):
+        """Read and decode a single file and return the data."""
+        data = self.source.read()
+        if self.autoclose:
+            self.close()
+        return self.decode(data)
+
+    def close(self):
+        self.source.close()
+
+
+class FileOutput(Output):
+
+    """
+    Output for single, simple file-like objects.
+    """
+
+    def __init__(self, settings=None, destination=None, destination_path=None,
+                 encoding=None, autoclose=1):
+        """
+        :Parameters:
+            - `destination`: either a file-like object (which is written
+              directly) or `None` (which implies `sys.stdout` if no
+              `destination_path` given).
+            - `destination_path`: a path to a file, which is opened and then
+              written.
+            - `autoclose`: close automatically after write (boolean); always
+              false if `sys.stdout` is the destination.
+        """
+        Output.__init__(self, settings, destination, destination_path,
+                        encoding)
+        self.opened = 1
+        self.autoclose = autoclose
+        if destination is None:
+            if destination_path:
+                self.opened = None
+            else:
+                self.destination = sys.stdout
+                self.autoclose = None
+        if not destination_path:
+            try:
+                self.destination_path = self.destination.name
+            except AttributeError:
+                pass
+
+    def open(self):
+        self.destination = open(self.destination_path, 'w')
+        self.opened = 1
+
+    def write(self, data):
+        """Encode `data`, write it to a single file, and return it."""
+        output = self.encode(data)
+        if not self.opened:
+            self.open()
+        self.destination.write(output)
+        if self.autoclose:
+            self.close()
+        return output
+
+    def close(self):
+        self.destination.close()
+        self.opened = None
+
+
+class StringInput(Input):
+
+    """
+    Direct string input.
+    """
+
+    default_source_path = '<string>'
+
+    def read(self):
+        """Decode and return the source string."""
+        return self.decode(self.source)
+
+
+class StringOutput(Output):
+
+    """
+    Direct string output.
+    """
+
+    default_destination_path = '<string>'
+
+    def write(self, data):
+        """Encode `data`, store it in `self.destination`, and return it."""
+        self.destination = self.encode(data)
+        return self.destination
+
+
+class NullInput(Input):
+
+    """
+    Degenerate input: read nothing.
+    """
+
+    default_source_path = 'null input'
+
+    def read(self):
+        """Return a null string."""
+        return u''
+
+
+class NullOutput(Output):
+
+    """
+    Degenerate output: write nothing.
+    """
+
+    default_destination_path = 'null output'
+
+    def write(self, data):
+        """Do nothing ([don't even] send data to the bit bucket)."""
+        pass

lib/python/docutils/languages/__init__.py

+# Author: David Goodger
+# Contact: goodger@users.sourceforge.net
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:02 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+This package contains modules for language-dependent features of Docutils.
+"""
+
+__docformat__ = 'reStructuredText'
+
+_languages = {}
+
+def get_language(language_code):
+    if _languages.has_key(language_code):
+        return _languages[language_code]
+    module = __import__(language_code, globals(), locals())
+    _languages[language_code] = module
+    return module

lib/python/docutils/languages/de.py

+# Authors:   David Goodger; Gunnar Schwant
+# Contact:   goodger@users.sourceforge.net
+# Revision:  $Revision: 1.2 $
+# Date:      $Date: 2003/02/01 09:26:03 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+German language mappings for language-dependent features of Docutils.
+"""
+
+__docformat__ = 'reStructuredText'
+
+from docutils import nodes
+
+
+labels = {
+    'author': 'Autor',
+    'authors': 'Autoren',
+    'organization': 'Organisation',
+    'address': 'Adresse',
+    'contact': 'Kontakt',
+    'version': 'Version',
+    'revision': 'Revision',
+    'status': 'Status',
+    'date': 'Datum',
+    'dedication': 'Widmung',
+    'copyright': 'Copyright',
+    'abstract': 'Zusammenfassung',
+    'attention': 'Achtung!',
+    'caution': 'Vorsicht!',
+    'danger': '!GEFAHR!',
+    'error': 'Fehler',
+    'hint': 'Hinweis',
+    'important': 'Wichtig',
+    'note': 'Bemerkung',
+    'tip': 'Tipp',
+    'warning': 'Warnung',
+    'contents': 'Inhalt'}
+"""Mapping of node class name to label text."""
+
+bibliographic_fields = {
+    'autor': nodes.author,
+    'autoren': nodes.authors,
+    'organisation': nodes.organization,
+    'adresse': nodes.address,
+    'kontakt': nodes.contact,
+    'version': nodes.version,
+    'revision': nodes.revision,
+    'status': nodes.status,
+    'datum': nodes.date,
+    'copyright': nodes.copyright,
+    'widmung': nodes.topic,
+    'zusammenfassung': nodes.topic}
+"""Field name (lowcased) to node class name mapping for bibliographic fields
+(field_list)."""
+
+author_separators = [';', ',']
+"""List of separator strings for the 'Authors' bibliographic field. Tried in
+order."""

lib/python/docutils/languages/en.py

+# Author: David Goodger
+# Contact: goodger@users.sourceforge.net
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:03 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+English-language mappings for language-dependent features of Docutils.
+"""
+
+__docformat__ = 'reStructuredText'
+
+
+from docutils import nodes
+
+
+labels = {
+      'author': 'Author',
+      'authors': 'Authors',
+      'organization': 'Organization',
+      'address': 'Address',
+      'contact': 'Contact',
+      'version': 'Version',
+      'revision': 'Revision',
+      'status': 'Status',
+      'date': 'Date',
+      'copyright': 'Copyright',
+      'dedication': 'Dedication',
+      'abstract': 'Abstract',
+      'attention': 'Attention!',
+      'caution': 'Caution!',
+      'danger': '!DANGER!',
+      'error': 'Error',
+      'hint': 'Hint',
+      'important': 'Important',
+      'note': 'Note',
+      'tip': 'Tip',
+      'warning': 'Warning',
+      'contents': 'Contents'}
+"""Mapping of node class name to label text."""
+
+bibliographic_fields = {
+      'author': nodes.author,
+      'authors': nodes.authors,
+      'organization': nodes.organization,
+      'address': nodes.address,
+      'contact': nodes.contact,
+      'version': nodes.version,
+      'revision': nodes.revision,
+      'status': nodes.status,
+      'date': nodes.date,
+      'copyright': nodes.copyright,
+      'dedication': nodes.topic,
+      'abstract': nodes.topic}
+"""Field name (lowcased) to node class name mapping for bibliographic fields
+(field_list)."""
+
+author_separators = [';', ',']
+"""List of separator strings for the 'Authors' bibliographic field. Tried in
+order."""

lib/python/docutils/languages/fr.py

+# Author: Stefane Fermigier
+# Contact: sf@fermigier.com
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:03 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+French-language mappings for language-dependent features of Docutils.
+"""
+
+__docformat__ = 'reStructuredText'
+
+
+from docutils import nodes
+
+
+labels = {
+      'author': 'Auteur',
+      'authors': 'Auteurs',
+      'organization': 'Organisation',
+      'address': 'Adresse',
+      'contact': 'Contact',
+      'version': 'Version',
+      'revision': 'R\u00e9vision',
+      'status': 'Statut',
+      'date': 'Date',
+      'copyright': 'Copyright',
+      'dedication': 'D\u00e9dicace',
+      'abstract': 'R\u00e9sum\u00e9',
+      'attention': 'Attention!',
+      'caution': 'Avertissement!',
+      'danger': '!DANGER!',
+      'error': 'Erreur',
+      'hint': 'Indication',
+      'important': 'Important',
+      'note': 'Note',
+      'tip': 'Astuce',
+      'warning': 'Avertissement',
+      'contents': 'Contenu'}
+"""Mapping of node class name to label text."""
+
+bibliographic_fields = {
+      'auteur': nodes.author,
+      'auteurs': nodes.authors,
+      'organisation': nodes.organization,
+      'adresse': nodes.address,
+      'contact': nodes.contact,
+      'version': nodes.version,
+      'r\u00e9vision': nodes.revision,
+      'status': nodes.status,
+      'date': nodes.date,
+      'copyright': nodes.copyright,
+      'd\u00e9dicace': nodes.topic,
+      'r\u00e9sum\u00e9': nodes.topic}
+"""Field name (lowcased) to node class name mapping for bibliographic fields
+(field_list)."""
+
+author_separators = [';', ',']
+"""List of separator strings for the 'Authors' bibliographic field. Tried in
+order."""

lib/python/docutils/languages/it.py

+# Author: Nicola Larosa
+# Contact: docutils@tekNico.net
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:03 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+Italian-language mappings for language-dependent features of Docutils.
+"""
+
+__docformat__ = 'reStructuredText'
+
+
+from docutils import nodes
+
+
+labels = {
+      'author': 'Autore',
+      'authors': 'Autori',
+      'organization': 'Organizzazione',
+      'address': 'Indirizzo',
+      'contact': 'Contatti',
+      'version': 'Versione',
+      'revision': 'Revisione',
+      'status': 'Status',
+      'date': 'Data',
+      'copyright': 'Copyright',
+      'dedication': 'Dedica',
+      'abstract': 'Riassunto',
+      'attention': 'Attenzione!',
+      'caution': 'Cautela!',
+      'danger': '!PERICOLO!',
+      'error': 'Errore',
+      'hint': 'Suggerimento',
+      'important': 'Importante',
+      'note': 'Nota',
+      'tip': 'Consiglio',
+      'warning': 'Avvertenza',
+      'contents': 'Indice'}
+"""Mapping of node class name to label text."""
+
+bibliographic_fields = {
+      'autore': nodes.author,
+      'autori': nodes.authors,
+      'organizzazione': nodes.organization,
+      'indirizzo': nodes.address,
+      'contatti': nodes.contact,
+      'versione': nodes.version,
+      'revisione': nodes.revision,
+      'status': nodes.status,
+      'data': nodes.date,
+      'copyright': nodes.copyright,
+      'dedica': nodes.topic,
+      'riassunto': nodes.topic}
+"""Field name (lowcased) to node class name mapping for bibliographic fields
+(field_list)."""
+
+author_separators = [';', ',']
+"""List of separator strings for the 'Authors' bibliographic field. Tried in
+order."""

lib/python/docutils/languages/sk.py

+# :Author: Miroslav Vasko
+# :Contact: zemiak@zoznam.sk
+# :Revision: $Revision: 1.2 $
+# :Date: $Date: 2003/02/01 09:26:03 $
+# :Copyright: This module has been placed in the public domain.
+
+"""
+Slovak-language mappings for language-dependent features of Docutils.
+"""
+
+__docformat__ = 'reStructuredText'
+
+
+from docutils import nodes
+
+
+labels = {
+      'author': u'Autor',
+      'authors': u'Autori',
+      'organization': u'Organiz\u00E1cia',
+      'address': u'Adresa',
+      'contact': u'Kontakt',
+      'version': u'Verzia',
+      'revision': u'Rev\u00EDzia',
+      'status': u'Stav',
+      'date': u'D\u00E1tum',
+      'copyright': u'Copyright',
+      'dedication': u'Venovanie',
+      'abstract': u'Abstraktne',
+      'attention': u'Pozor!',
+      'caution': u'Opatrne!',
+      'danger': u'!NEBEZPE\u010cENSTVO!',
+      'error': u'Chyba',
+      'hint': u'Rada',
+      'important': u'D\u00F4le\u017Eit\u00E9',
+      'note': u'Pozn\u00E1mka',
+      'tip': u'Tip',
+      'warning': u'Varovanie',
+      'contents': u'Obsah'}
+"""Mapping of node class name to label text."""
+
+bibliographic_fields = {
+      u'autor': nodes.author,
+      u'autori': nodes.authors,
+      u'organiz\u00E1cia': nodes.organization,
+      u'adresa': nodes.address,
+      u'kontakt': nodes.contact,
+      u'verzia': nodes.version,
+      u'rev\u00EDzia': nodes.revision,
+      u'stav': nodes.status,
+      u'D\u00E1tum': nodes.date,
+      u'copyright': nodes.copyright,
+      u'venovanie': nodes.topic,
+      u'abstraktne': nodes.topic}
+"""Field name (lowcased) to node class name mapping for bibliographic fields
+(field_list)."""
+
+author_separators = [';', ',']
+"""List of separator strings for the 'Authors' bibliographic field. Tried in
+order."""

lib/python/docutils/languages/sv.py

+# Author:    Adam Chodorowski
+# Contact:   chodorowski@users.sourceforge.net
+# Revision:  $Revision: 1.2 $
+# Date:      $Date: 2003/02/01 09:26:03 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+Swedish language mappings for language-dependent features of Docutils.
+"""
+
+__docformat__ = 'reStructuredText'
+
+
+from docutils import nodes
+
+
+labels = {
+    'author':       u'F\u00f6rfattare',
+    'authors':      u'F\u00f6rfattare',
+    'organization': u'Organisation',
+    'address':      u'Adress',
+    'contact':      u'Kontakt',
+    'version':      u'Version',
+    'revision':     u'Revision',
+    'status':       u'Status',
+    'date':         u'Datum',
+    'copyright':    u'Copyright',
+    'dedication':   u'Dedikation',
+    'abstract':     u'Sammanfattning',
+    'attention':    u'Observera!',
+    'caution':      u'Varning!',
+    'danger':       u'FARA!',
+    'error':        u'Fel',
+    'hint':         u'V\u00e4gledning',
+    'important':    u'Viktigt',
+    'note':         u'Notera',
+    'tip':          u'Tips',
+    'warning':      u'Varning',
+    'contents':     u'Inneh\u00e5ll' }
+"""Mapping of node class name to label text."""
+
+bibliographic_fields = {
+    # 'Author' and 'Authors' identical in Swedish; assume the plural:
+    u'f\u00f6rfattare': nodes.authors,
+    u'organisation':    nodes.organization,
+    u'adress':          nodes.address,
+    u'kontakt':         nodes.contact,
+    u'version':         nodes.version,
+    u'revision':        nodes.revision,
+    u'status':          nodes.status,
+    u'datum':           nodes.date,
+    u'copyright':       nodes.copyright,
+    u'dedikation':      nodes.topic, 
+    u'sammanfattning':  nodes.topic }
+"""Field name (lowcased) to node class name mapping for bibliographic fields
+(field_list)."""
+
+author_separators = [';', ',']
+"""List of separator strings for the 'Authors' bibliographic field. Tried in
+order."""

lib/python/docutils/parsers/__init__.py

+# Author: David Goodger
+# Contact: goodger@users.sourceforge.net
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:05 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+This package contains Docutils parser modules.
+"""
+
+__docformat__ = 'reStructuredText'
+
+from docutils import Component
+
+
+class Parser(Component):
+
+    component_type = 'parser'
+
+    def parse(self, inputstring, document):
+        """Override to parse `inputstring` into document tree `document`."""
+        raise NotImplementedError('subclass must override this method')
+
+    def setup_parse(self, inputstring, document):
+        """Initial parse setup.  Call at start of `self.parse()`."""
+        self.inputstring = inputstring
+        self.document = document
+        document.reporter.attach_observer(document.note_parse_message)
+
+    def finish_parse(self):
+        """Finalize parse details.  Call at end of `self.parse()`."""
+        self.document.reporter.detach_observer(
+            self.document.note_parse_message)
+
+
+_parser_aliases = {
+      'restructuredtext': 'rst',
+      'rest': 'rst',
+      'restx': 'rst',
+      'rtxt': 'rst',}
+
+def get_parser_class(parser_name):
+    """Return the Parser class from the `parser_name` module."""
+    parser_name = parser_name.lower()
+    if _parser_aliases.has_key(parser_name):
+        parser_name = _parser_aliases[parser_name]
+    module = __import__(parser_name, globals(), locals())
+    return module.Parser

lib/python/docutils/parsers/rst/directives/admonitions.py

+# Author: David Goodger
+# Contact: goodger@users.sourceforge.net
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:09 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+Admonition directives.
+"""
+
+__docformat__ = 'reStructuredText'
+
+
+from docutils.parsers.rst import states
+from docutils import nodes
+
+
+def admonition(node_class, name, arguments, options, content, lineno,
+               content_offset, block_text, state, state_machine):
+    text = '\n'.join(content)
+    admonition_node = node_class(text)
+    if text:
+        state.nested_parse(content, content_offset, admonition_node)
+        return [admonition_node]
+    else:
+        error = state_machine.reporter.error(
+            'The "%s" admonition is empty; content required.' % (name),
+            nodes.literal_block(block_text, block_text), line=lineno)
+        return [error]
+
+def attention(*args):
+    return admonition(nodes.attention, *args)
+
+attention.content = 1
+
+def caution(*args):
+    return admonition(nodes.caution, *args)
+
+caution.content = 1
+
+def danger(*args):
+    return admonition(nodes.danger, *args)
+
+danger.content = 1
+
+def error(*args):
+    return admonition(nodes.error, *args)
+
+error.content = 1
+
+def important(*args):
+    return admonition(nodes.important, *args)
+
+important.content = 1
+
+def note(*args):
+    return admonition(nodes.note, *args)
+
+note.content = 1
+
+def tip(*args):
+    return admonition(nodes.tip, *args)
+
+tip.content = 1
+
+def hint(*args):
+    return admonition(nodes.hint, *args)
+
+hint.content = 1
+
+def warning(*args):
+    return admonition(nodes.warning, *args)
+
+warning.content = 1

lib/python/docutils/parsers/rst/directives/references.py

+# Author: David Goodger, Dmitry Jemerov
+# Contact: goodger@users.sourceforge.net
+# Revision: $Revision: 1.2 $
+# Date: $Date: 2003/02/01 09:26:09 $
+# Copyright: This module has been placed in the public domain.
+
+"""
+Directives for references and targets.
+"""
+
+__docformat__ = 'reStructuredText'
+
+from docutils import nodes
+from docutils.transforms import references
+
+
+def target_notes(name, arguments, options, content, lineno,
+                 content_offset, block_text, state, state_machine):
+    """Target footnote generation."""
+    pending = nodes.pending(references.TargetNotes)
+    state_machine.document.note_pending(pending)
+    nodelist = [pending]
+    return nodelist