Fixed 1349: HEAD doesn't have rest-header-level

Updated docutils including a fix for 1426:  System locale breaks reStructuredText horribly
Added rest-language-code to zope.conf schema. it's used instead of the locales

lib/python/App/config.py

@@ -93,3 +93,4 @@ class DefaultConfiguration:
         self.rest_input_encoding = default_enc
         self.rest_output_encoding = default_enc
         self.rest_header_level = 3
+        self.rest_language_code = 'en'

lib/python/Interface/pprint.py

@@ -19,7 +19,7 @@ def trim_doc_string(text):
                 min_indent=indent
         for line in lines[1:]:
             nlines.append(line[min_indent:])
-    return '\n'.join(nlines, '\n')
+    return '\n'.join(nlines)
 
 
 

lib/python/Zope/Startup/handlers.py

@@ -83,6 +83,14 @@ def rest_output_encoding(value):
     value and _setenv('REST_OUTPUT_ENCODING' , value)
     return value
 
+def rest_header_level(value):
+    value and _setenv('REST_DEFAULT_LEVEL' , value)
+    return value
+
+def rest_language_code(value):
+    value and _setenv('REST_LANGUAGE_CODE' , value)
+    return value
+
 # server handlers
 
 def root_handler(config):

lib/python/Zope/Startup/zopeschema.xml

@@ -482,6 +482,25 @@
     <metadefault>unset</metadefault>
   </key>
 
+  <key name="rest-header-level" datatype="integer" default="3"
+       handler="rest_header_level">
+    <description>
+     Set the default starting HTML header level for restructured text
+     documents. The default is 3, which implies that top-level headers
+     will be created with an H3 HTML tag.
+    </description>
+    <metadefault>3</metadefault>
+  </key>
+
+  <key name="rest-language-code" handler="rest_language_code" default="en">
+    <description>
+     Language code used for some internal translations inside of the docutils
+     package and for DTD bibliographic elements mapping. See
+     lib/python/docutils/languages/ for a list of supported language codes.
+    </description>
+    <metadefault>en</metadefault>
+  </key>
+
   <key name="publisher-profile-file">
     <description>
      Causing this directive to point to a file on the filesystem will

lib/python/docutils/__init__.py

@@ -52,13 +52,11 @@ Subpackages:
 __docformat__ = 'reStructuredText'
 
 __version__ = '0.3.4'
-"""``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 or significant new functionality, and at any alpha or beta
-release.  The minor number is bumped whenever there is a stable
-project release.  The major number will be bumped when the project is
-feature-complete, and perhaps if there is a major change in the
-design."""
+"""``major.minor.micro`` version number.  The micro number is bumped for API
+changes, for new functionality, and for interim project releases.  The minor
+number is bumped whenever there is a significant project release.  The major
+number will be bumped when the project is feature-complete, and perhaps if
+there is a major change in the design."""
 
 
 class ApplicationError(StandardError): pass
@@ -76,22 +74,36 @@ class SettingsSpec:
     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`; a group title of `None` implies no
-    group, just a list of single options.  The "keyword arguments" dictionary
-    contains arguments to the OptionParser/OptionGroup ``add_option`` method,
-    with the addition of a "validator" keyword (see the
-    `docutils.frontend.OptionParser.validators` instance attribute).  Runtime
-    settings names are derived implicitly from long option names
-    ("--a-setting" becomes ``settings.a_setting``) or explicitly from the
-    "dest" keyword argument."""
+    Defines runtime settings and associated command-line options, as used by
+    `docutils.frontend.OptionParser`.  This is a tuple of:
+
+    - Option group title (string or `None` which implies no group, just a list
+      of single options).
+    
+    - Description (string or `None`).
+    
+    - A sequence of option tuples.  Each consists of:
+
+      - Help text (string)
+      
+      - List of option strings (e.g. ``['-Q', '--quux']``).
+      
+      - Dictionary of keyword arguments.  It contains arguments to the
+        OptionParser/OptionGroup ``add_option`` method, possibly with the
+        addition of a 'validator' keyword (see the
+        `docutils.frontend.OptionParser.validators` instance attribute).  Runtime
+        settings names are derived implicitly from long option names
+        ('--a-setting' becomes ``settings.a_setting``) or explicitly from the
+        'dest' keyword argument.  See optparse docs for more details.
+
+    - More triples of group title, description, options, as many times as
+      needed.  Thus, `settings_spec` tuples can be simply concatenated.
+    """
 
     settings_defaults = None
-    """A dictionary of defaults for internal or inaccessible (by command-line
-    or config file) settings.  Override in subclasses."""
+    """A dictionary of defaults for settings not in `settings_spec` (internal
+    settings, intended to be inaccessible by command-line and config file).
+    Override in subclasses."""
 
     settings_default_overrides = None
     """A dictionary of auxiliary defaults, to override defaults for settings
@@ -126,14 +138,21 @@ class TransformSpec:
     """Transforms required by this class.  Override in subclasses."""
     
     unknown_reference_resolvers = ()
-    """List of functions to try to resolve unknown references.  Called when
-    FinalCheckVisitor is unable to find a correct target.  The list should
-    contain functions which will try to resolve unknown references, with the
-    following signature::
+    """List of functions to try to resolve unknown references.  Unknown
+    references have a 'refname' attribute which doesn't correspond to any
+    target in the document.  Called when FinalCheckVisitor is unable to find a
+    correct target.  The list should contain functions which will try to
+    resolve unknown references, with the following signature::
 
         def reference_resolver(node):
             '''Returns boolean: true if resolved, false if not.'''
 
+    If the function is able to resolve the reference, it should also remove
+    the 'refname' attribute and mark the node as resolved::
+
+        del node['refname']
+        node.resolved = 1
+
     Each function must have a "priority" attribute which will affect the order
     the unknown_reference_resolvers are run::
 

lib/python/docutils/frontend.py

@@ -43,7 +43,7 @@ from optparse import Values, SUPPRESS_HELP
 def store_multiple(option, opt, value, parser, *args, **kwargs):
     """
     Store multiple values in `parser.values`.  (Option callback.)
-    
+
     Store `None` for each attribute named in `args`, and store the value for
     each key (attribute name) in `kwargs`.
     """
@@ -77,10 +77,10 @@ def validate_encoding_error_handler(setting, value, option_parser,
     try:
         codecs.lookup_error(value)
     except AttributeError:              # prior to Python 2.3
-        if value not in ('strict', 'ignore', 'replace'):
+        if value not in ('strict', 'ignore', 'replace', 'xmlcharrefreplace'):
             raise (LookupError(
                 'unknown encoding error handler: "%s" (choices: '
-                '"strict", "ignore", or "replace")' % value),
+                '"strict", "ignore", "replace", or "xmlcharrefreplace")' % value),
                    None, sys.exc_info()[2])
     except LookupError:
         raise (LookupError(
@@ -143,6 +143,15 @@ def validate_colon_separated_string_list(
         value.extend(last.split(':'))
     return value
 
+def validate_url_trailing_slash(
+    setting, value, option_parser, config_parser=None, config_section=None):
+    if not value:
+        return './'
+    elif value.endswith('/'):
+        return value
+    else:
+        return value + '/'
+
 def make_paths_absolute(pathdict, keys, base_path=None):
     """
     Interpret filesystem path settings relative to the `base_path` given.
@@ -311,8 +320,9 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
           ['--quiet', '-q'], {'action': 'store_const', 'const': 'none',
                               'dest': 'report_level'}),
          ('Set the threshold (<level>) at or above which system messages are '
-          'converted to exceptions, halting execution immediately.  Levels '
-          'as in --report.  Default is 4 (severe).',
+          'converted to exceptions, halting execution immediately by '
+          'exiting (or propagating the exception if --traceback set).  '
+          'Levels as in --report.  Default is 4 (severe).',
           ['--halt'], {'choices': threshold_choices, 'dest': 'halt_level',
                        'default': 4, 'metavar': '<level>',
                        'validator': validate_threshold}),
@@ -323,9 +333,10 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
           'system messages (at or above <level>) were generated.  Levels as '
           'in --report.  Default is 5 (disabled).  Exit status is the maximum '
           'system message level plus 10 (11 for INFO, etc.).',
-          ['--exit'], {'choices': threshold_choices, 'dest': 'exit_level',
-                       'default': 5, 'metavar': '<level>',
-                       'validator': validate_threshold}),
+          ['--exit-status'], {'choices': threshold_choices,
+                              'dest': 'exit_status_level',
+                              'default': 5, 'metavar': '<level>',
+                              'validator': validate_threshold}),
          ('Report debug-level system messages and generate diagnostic output.',
           ['--debug'], {'action': 'store_true', 'validator': validate_boolean}),
          ('Do not report debug-level system messages or generate diagnostic '
@@ -333,7 +344,9 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
           ['--no-debug'], {'action': 'store_false', 'dest': 'debug'}),
          ('Send the output of system messages (warnings) to <file>.',
           ['--warnings'], {'dest': 'warning_stream', 'metavar': '<file>'}),
-         ('Enable Python tracebacks when an error occurs.',
+         ('Enable Python tracebacks when halt-level system messages and '
+          'other exceptions occur.  Useful for debugging, and essential for '
+          'issue reports.',
           ['--traceback'], {'action': 'store_true', 'default': None,
                             'validator': validate_boolean}),
          ('Disable Python tracebacks when errors occur; report just the error '
@@ -343,23 +356,31 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
           ['--input-encoding', '-i'],
           {'metavar': '<name>', 'validator': validate_encoding}),
          ('Specify the text encoding for output.  Default is UTF-8.  '
-          'Optionally also specify the encoding error handler for unencodable '
-          'characters (see "--error-encoding"); default is "strict".',
+          'Optionally also specify the error handler for unencodable '
+          'characters, after a colon (":"); default is "strict".  (See '
+          '"--output-encoding-error-encoding".)',
           ['--output-encoding', '-o'],
           {'metavar': '<name[:handler]>', 'default': 'utf-8',
            'validator': validate_encoding_and_error_handler}),
-         (SUPPRESS_HELP,                # usually handled by --output-encoding
+         ('Specify the error handler for unencodable characters in '
+          'the output.  Acceptable values include "strict", "ignore", '
+          '"replace", "xmlcharrefreplace", and '
+          '"backslashreplace" (in Python 2.3+).  Default is "strict".  '
+          'Usually specified as part of --output-encoding.',
           ['--output-encoding-error-handler'],
           {'default': 'strict', 'validator': validate_encoding_error_handler}),
          ('Specify the text encoding for error output.  Default is ASCII.  '
-          'Optionally also specify the encoding error handler for unencodable '
-          'characters, after a colon (":").  Acceptable values are the same '
-          'as for the "error" parameter of Python\'s ``encode`` string '
-          'method.  Default is "%s".' % default_error_encoding_error_handler,
+          'Optionally also specify the error handler for unencodable '
+          'characters, after a colon (":"); default is "%s".  (See '
+          '"--output-encoding-error-encoding".'
+          % default_error_encoding_error_handler,
           ['--error-encoding', '-e'],
           {'metavar': '<name[:handler]>', 'default': 'ascii',
            'validator': validate_encoding_and_error_handler}),
-         (SUPPRESS_HELP,                # usually handled by --error-encoding
+         ('Specify the error handler for unencodable characters in '
+          'error output.  See --output-encoding-error-handler for acceptable '
+          'values.  Default is "%s".  Usually specified as part of '
+          '--error-encoding.' % default_error_encoding_error_handler,
           ['--error-encoding-error-handler'],
           {'default': default_error_encoding_error_handler,
            'validator': validate_encoding_error_handler}),
@@ -386,7 +407,9 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
     ends.  Setting specs specific to individual Docutils components are also
     used (see `populate_from_components()`)."""
 
-    settings_defaults = {'_disable_config': None}
+    settings_defaults = {'_disable_config': None,
+                         '_source': None,
+                         '_destination': None}
     """Defaults for settings that don't have command-line option equivalents."""
 
     relative_path_settings = ('warning_stream',)
@@ -425,16 +448,13 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
         self.relative_path_settings = list(self.relative_path_settings)
         self.components = (self,) + tuple(components)
         self.populate_from_components(self.components)
-        defaults = defaults or {}
+        self.set_defaults(**(defaults or {}))
         if read_config_files and not self.defaults['_disable_config']:
             try:
                 config_settings = self.get_standard_config_settings()
             except ValueError, error:
                 self.error(error)
-            defaults.update(config_settings.__dict__)
-        # Internal settings with no defaults from settings specifications;
-        # initialize manually:
-        self.set_defaults(_source=None, _destination=None, **defaults)
+            self.set_defaults(**config_settings.__dict__)
 
     def populate_from_components(self, components):
         """
@@ -446,11 +466,10 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
         for component in components:
             if component is None:
                 continue
-            i = 0
             settings_spec = component.settings_spec
             self.relative_path_settings.extend(
                 component.relative_path_settings)
-            while i < len(settings_spec):
+            for i in range(0, len(settings_spec), 3):
                 title, description, option_spec = settings_spec[i:i+3]
                 if title:
                     group = optparse.OptionGroup(self, title, description)
@@ -472,7 +491,6 @@ class OptionParser(optparse.OptionParser, docutils.SettingsSpec):
                         self.lists[option.dest] = 1
                 if component.settings_defaults:
                     self.defaults.update(component.settings_defaults)
-                i += 3
         for component in components:
             if component and component.settings_default_overrides:
                 self.defaults.update(component.settings_default_overrides)
@@ -552,8 +570,8 @@ class ConfigParser(CP.ConfigParser):
     old_warning = """
 The "[option]" section is deprecated.  Support for old-format configuration
 files may be removed in a future Docutils release.  Please revise your
-configuration files.  See <http://docutils.sf.net/docs/config.html>, section
-"Old-Format Configuration Files".
+configuration files.  See <http://docutils.sf.net/docs/user/config.html>,
+section "Old-Format Configuration Files".
 """
 
     def read(self, filenames, option_parser):

lib/python/docutils/io.py

@@ -121,13 +121,32 @@ class Output(TransformSpec):
                 % (self.__class__, self.destination, self.destination_path))
 
     def write(self, data):
+        """`data` is a Unicode string, to be encoded by `self.encode`."""
         raise NotImplementedError
 
     def encode(self, data):
         if self.encoding and self.encoding.lower() == 'unicode':
             return data
         else:
-            return data.encode(self.encoding, self.error_handler)
+            try:
+                return data.encode(self.encoding, self.error_handler)
+            except ValueError:
+                # ValueError is raised if there are unencodable chars
+                # in data and the error_handler isn't found.
+                if self.error_handler == 'xmlcharrefreplace':
+                    # We are using xmlcharrefreplace with a Python
+                    # version that doesn't support it (2.1 or 2.2), so
+                    # we emulate its behavior.
+                    return ''.join([self.xmlcharref_encode(char) for char in data])
+                else:
+                    raise
+
+    def xmlcharref_encode(self, char):
+        """Emulate Python 2.3's 'xmlcharrefreplace' encoding error handler."""
+        try:
+            return char.encode(self.encoding, 'strict')
+        except UnicodeError:
+            return '&#%i;' % ord(char)
 
 
 class FileInput(Input):
@@ -172,7 +191,9 @@ class FileInput(Input):
                 pass
 
     def read(self):
-        """Read and decode a single file and return the data."""
+        """
+        Read and decode a single file and return the data (Unicode string).
+        """
         data = self.source.read()
         if self.autoclose:
             self.close()

lib/python/docutils/languages/__init__.py

@@ -18,6 +18,9 @@ _languages = {}
 def get_language(language_code):
     if _languages.has_key(language_code):
         return _languages[language_code]
-    module = __import__(language_code, globals(), locals())
+    try:
+        module = __import__(language_code, globals(), locals())
+    except ImportError:
+        return None
     _languages[language_code] = module
     return module

lib/python/docutils/languages/pt_br.py

@@ -20,43 +20,43 @@ labels = {
       # fixed: language-dependent
       'author': u'Autor',
       'authors': u'Autores',
-      'organization': unicode('Organizao', 'latin1'),
-      'address': unicode('Endereo', 'latin1'),
+      'organization': u'Organiza\u00E7\u00E3o',
+      'address': u'Endere\u00E7o',
       'contact': u'Contato',
-      'version': unicode('Verso', 'latin1'),
-      'revision': unicode('Reviso', 'latin1'),
+      'version': u'Vers\u00E3o',
+      'revision': u'Revis\u00E3o',
       'status': u'Estado',
       'date': u'Data',
       'copyright': u'Copyright',
-      'dedication': unicode('Dedicatria', 'latin1'),
+      'dedication': u'Dedicat\u00F3ria',
       'abstract': u'Resumo',
-      'attention': unicode('Atteno!', 'latin1'),
+      'attention': u'Atten\u00E7\u00E3o!',
       'caution': u'Cuidado!',
       'danger': u'PERIGO!',
       'error': u'Erro',
-      'hint': unicode('Sugesto', 'latin1'),
+      'hint': u'Sugest\u00E3o',
       'important': u'Importante',
       'note': u'Nota',
       'tip': u'Dica',
       'warning': u'Aviso',
-      'contents': unicode('Sumrio', 'latin1')}
+      'contents': u'Sum\u00E1rio'}
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
       # language-dependent: fixed
       u'autor': 'author',
       u'autores': 'authors',
-      unicode('organizao', 'latin1'): 'organization',
-      unicode('endereo', 'latin1'): 'address',
+      u'organiza\u00E7\u00E3o': 'organization',
+      u'endere\u00E7o': 'address',
       u'contato': 'contact',
-      unicode('verso', 'latin1'): 'version',
-      unicode('reviso', 'latin1'): 'revision',
+      u'vers\u00E3o': 'version',
+      u'revis\u00E3o': 'revision',
       u'estado': 'status',
       u'data': 'date',
       u'copyright': 'copyright',
-      unicode('dedicatria', 'latin1'): 'dedication',
+      u'dedicat\u00F3ria': 'dedication',
       u'resumo': 'abstract'}
-"""English (lowcased) to canonical name mapping for bibliographic fields."""
+"""Brazilian Portuguese (lowcased) to canonical name mapping for bibliographic fields."""
 
 author_separators = [';', ',']
 """List of separator strings for the 'Authors' bibliographic field. Tried in

lib/python/docutils/nodes.py

@@ -18,7 +18,7 @@ is represented by abstract base classes (`Root`, `Structural`, `Body`,
 ``isinstance(node, base_class)`` to determine the position of the node in the
 hierarchy.
 
-.. _DTD: http://docutils.sourceforge.net/spec/docutils.dtd
+.. _DTD: http://docutils.sourceforge.net/docs/ref/docutils.dtd
 """
 
 __docformat__ = 'reStructuredText'
@@ -1123,8 +1123,8 @@ class pending(Special, Invisible, PreBibliographic, Element):
 
     But the "contents" directive can't do its work until the entire document
     has been parsed and possibly transformed to some extent.  So the directive
-    code leaves a placeholder behind that will trigger the second phase of the
-    its processing, something like this::
+    code leaves a placeholder behind that will trigger the second phase of its
+    processing, something like this::
 
         <pending ...public attributes...> + internal attributes
 

lib/python/docutils/parsers/rst/__init__.py

@@ -88,12 +88,21 @@ class Parser(docutils.parsers.Parser):
     settings_spec = (
         'reStructuredText Parser Options',
         None,
-        (('Recognize and link to PEP references (like "PEP 258").',
+        (('Recognize and link to standalone PEP references (like "PEP 258").',
           ['--pep-references'],
           {'action': 'store_true', 'validator': frontend.validate_boolean}),
-         ('Recognize and link to RFC references (like "RFC 822").',
+         ('Base URL for PEP references '
+          '(default "http://www.python.org/peps/").',
+          ['--pep-base-url'],
+          {'metavar': '<URL>', 'default': 'http://www.python.org/peps/',
+           'validator': frontend.validate_url_trailing_slash}),
+         ('Recognize and link to standalone RFC references (like "RFC 822").',
           ['--rfc-references'],
           {'action': 'store_true', 'validator': frontend.validate_boolean}),
+         ('Base URL for RFC references (default "http://www.faqs.org/rfcs/").',
+          ['--rfc-base-url'],
+          {'metavar': '<URL>', 'default': 'http://www.faqs.org/rfcs/',
+           'validator': frontend.validate_url_trailing_slash}),
          ('Set number of spaces for tab expansion (default 8).',
           ['--tab-width'],
           {'metavar': '<width>', 'type': 'int', 'default': 8}),

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

@@ -20,11 +20,12 @@ The interface for directive functions is as follows::
 
 Parameters:
 
-- ``name`` is the directive type or name.
+- ``name`` is the directive type or name (string).
 
-- ``arguments`` is a list of positional arguments.
+- ``arguments`` is a list of positional arguments (strings).
 
-- ``options`` is a dictionary mapping option names to values.
+- ``options`` is a dictionary mapping option names (strings) to values (type
+  depends on option conversion functions; see below).
 
 - ``content`` is a list of strings, the directive content.
 
@@ -63,6 +64,10 @@ directive function):
   options to parse.  Several directive option conversion functions are defined
   in this module.
 
+  Option conversion functions take a single parameter, the option argument (a
+  string or ``None``), validate it and/or convert it to the appropriate form.
+  Conversion functions may raise ``ValueError`` and ``TypeError`` exceptions.
+
 - ``content``: A boolean; true if content is allowed.  Client code must handle
   the case where content is required but not supplied (an empty content list
   will be supplied).
@@ -74,11 +79,12 @@ empty list).
 See `Creating reStructuredText Directives`_ for more information.
 
 .. _Creating reStructuredText Directives:
-   http://docutils.sourceforge.net/spec/howto/rst-directives.html
+   http://docutils.sourceforge.net/docs/howto/rst-directives.html
 """
 
 __docformat__ = 'reStructuredText'
 
+import re
 from docutils import nodes
 from docutils.parsers.rst.languages import en as _fallback_language_module
 
@@ -102,8 +108,9 @@ _directive_registry = {
       'epigraph': ('body', 'epigraph'),
       'highlights': ('body', 'highlights'),
       'pull-quote': ('body', 'pull_quote'),
-      'table': ('body', 'table'),
       #'questions': ('body', 'question_list'),
+      'table': ('tables', 'table'),
+      'csv-table': ('tables', 'csv_table'),
       'image': ('images', 'image'),
       'figure': ('images', 'figure'),
       'contents': ('parts', 'contents'),
@@ -193,12 +200,12 @@ def directive(directive_name, language_module, document):
         return None, messages
     return function, messages
 
-def register_directive(name, directive):
+def register_directive(name, directive_function):
     """
     Register a nonstandard application-defined directive function.
     Language lookups are not needed for such functions.
     """
-    _directives[name] = directive
+    _directives[name] = directive_function
 
 def flag(argument):
     """
@@ -278,6 +285,60 @@ def class_option(argument):
         raise ValueError('cannot make "%s" into a class name' % argument)
     return class_name
 
+unicode_pattern = re.compile(
+    r'(?:0x|x|\\x|U\+?|\\u)([0-9a-f]+)$|&#x([0-9a-f]+);$', re.IGNORECASE)
+
+def unicode_code(code):
+    r"""
+    Convert a Unicode character code to a Unicode character.
+
+    Codes may be decimal numbers, hexadecimal numbers (prefixed by ``0x``,
+    ``x``, ``\x``, ``U+``, ``u``, or ``\u``; e.g. ``U+262E``), or XML-style
+    numeric character entities (e.g. ``☮``).  Other text remains as-is.
+    """
+    try:
+        if code.isdigit():                  # decimal number
+            return unichr(int(code))
+        else:
+            match = unicode_pattern.match(code)
+            if match:                       # hex number
+                value = match.group(1) or match.group(2)
+                return unichr(int(value, 16))
+            else:                           # other text
+                return code
+    except OverflowError, detail:
+        raise ValueError('code too large (%s)' % detail)
+
+
+def single_char_or_unicode(argument):
+    char = unicode_code(argument)
+    if len(char) > 1:
+        raise ValueError('%r invalid; must be a single character or '
+                         'a Unicode code' % char)
+    return char
+
+def single_char_or_whitespace_or_unicode(argument):
+    if argument == 'tab':
+        char = '\t'
+    elif argument == 'space':
+        char = ' '
+    else:
+        char = single_char_or_unicode(argument)
+    return char
+
+def positive_int(argument):
+    value = int(argument)
+    if value < 1:
+        raise ValueError('negative or zero value; must be positive')
+    return value
+
+def positive_int_list(argument):
+    if ',' in argument:
+        entries = argument.split(',')
+    else:
+        entries = argument.split()
+    return [positive_int(entry) for entry in entries]
+
 def format_values(values):
     return '%s, or "%s"' % (', '.join(['"%s"' % s for s in values[:-1]]),
                             values[-1])

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

@@ -15,7 +15,7 @@ import sys
 from docutils import nodes
 from docutils.parsers.rst import directives
 
-
+              
 def topic(name, arguments, options, content, lineno,
           content_offset, block_text, state, state_machine,
           node_class=nodes.topic):
@@ -74,6 +74,7 @@ def line_block(name, arguments, options, content, lineno,
     text = '\n'.join(content)
     text_nodes, messages = state.inline_text(text, lineno)
     node = node_class(text, '', *text_nodes, **options)
+    node.line = content_offset + 1
     return [node] + messages
 
 line_block.options = {'class': directives.class_option}
@@ -121,38 +122,3 @@ def pull_quote(name, arguments, options, content, lineno,
     return [block_quote] + messages
 
 pull_quote.content = 1
-
-def table(name, arguments, options, content, lineno,
-          content_offset, block_text, state, state_machine):
-    if not content:
-        warning = state_machine.reporter.warning(
-            'Content block expected for the "%s" directive; none found.'
-            % name, nodes.literal_block(block_text, block_text),
-            line=lineno)
-        return [warning]
-    if arguments:
-        title_text = arguments[0]
-        text_nodes, messages = state.inline_text(title_text, lineno)
-        title = nodes.title(title_text, '', *text_nodes)
-    else:
-        title = None
-    node = nodes.Element()          # anonymous container for parsing
-    text = '\n'.join(content)
-    state.nested_parse(content, content_offset, node)
-    if len(node) != 1 or not isinstance(node[0], nodes.table):
-        error = state_machine.reporter.error(
-            'Error parsing content block for the "%s" directive: '
-            'exactly one table expected.'
-            % name, nodes.literal_block(block_text, block_text),
-            line=lineno)
-        return [error]
-    table_node = node[0]
-    if options.has_key('class'):
-        table_node.set_class(options['class'])
-    if title:
-        table_node.insert(0, title)
-    return [table_node]
-
-table.arguments = (0, 1, 1)
-table.options = {'class': directives.class_option}
-table.content = 1

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

@@ -28,6 +28,7 @@ def align(argument):
 
 def image(name, arguments, options, content, lineno,
           content_offset, block_text, state, state_machine):
+    messages = []
     reference = ''.join(arguments[0].split('\n'))
     if reference.find(' ') != -1:
         error = state_machine.reporter.error(
@@ -35,23 +36,26 @@ def image(name, arguments, options, content, lineno,
               nodes.literal_block(block_text, block_text), line=lineno)
         return [error]
     options['uri'] = reference
+    reference_node = None
     if options.has_key('target'):
         block = states.escape2null(options['target']).splitlines()
         block = [line for line in block]
         target_type, data = state.parse_target(block, block_text, lineno)
         if target_type == 'refuri':
-            node_list = nodes.reference(refuri=data)
+            reference_node = nodes.reference(refuri=data)
         elif target_type == 'refname':
-            node_list = nodes.reference(
+            reference_node = nodes.reference(
                 refname=data, name=whitespace_normalize_name(options['target']))
-            state.document.note_refname(node_list)
+            state.document.note_refname(reference_node)
         else:                           # malformed target
-            node_list = [data]          # data is a system message
+            messages.append(data)       # data is a system message
         del options['target']
+    image_node = nodes.image(block_text, **options)
+    if reference_node:
+        reference_node += image_node
+        return messages + [reference_node]
     else:
-        node_list = []
-    node_list.append(nodes.image(block_text, **options))
-    return node_list
+        return messages + [image_node]
 
 image.arguments = (1, 0, 1)
 image.options = {'alt': directives.unchanged,

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

@@ -117,7 +117,7 @@ def raw(name, arguments, options, content, lineno,
                   nodes.literal_block(block_text, block_text), line=lineno)
             return [severe]
         text = raw_file.read()
-        raw_file.close()        
+        raw_file.close()
         attributes['source'] = options['file']
     else:
         error = state_machine.reporter.warning(
@@ -185,29 +185,19 @@ def unicode_directive(name, arguments, options, content, lineno,
     element = nodes.Element()
     for code in codes:
         try:
-            if code.isdigit():
-                element += nodes.Text(unichr(int(code)))
-            else:
-                match = unicode_pattern.match(code)
-                if match:
-                    value = match.group(1) or match.group(2)
-                    element += nodes.Text(unichr(int(value, 16)))
-                else:
-                    element += nodes.Text(code)
-        except (ValueError, OverflowError), err:
+            decoded = directives.unicode_code(code)
+        except ValueError, err:
             error = state_machine.reporter.error(
                 'Invalid character code: %s\n%s: %s'
                 % (code, err.__class__.__name__, err),
                 nodes.literal_block(block_text, block_text), line=lineno)
             return [error]
+        element += nodes.Text(decoded)
     return element.children
 
 unicode_directive.arguments = (1, 0, 1)
-unicode_pattern = re.compile(
-    r'(?:0x|x|\\x|U\+?|\\u)([0-9a-f]+)$|&#x([0-9a-f]+);$', re.IGNORECASE)
 unicode_comment_pattern = re.compile(r'( |\n|^).. ')
 
-
 def class_directive(name, arguments, options, content, lineno,
                        content_offset, block_text, state, state_machine):
     """"""
@@ -259,7 +249,7 @@ def role(name, arguments, options, content, lineno,
             return messages + [error]
     else:
         base_role = roles.generic_custom_role
-    assert not hasattr(base_role, 'arguments'), ( 
+    assert not hasattr(base_role, 'arguments'), (
         'Supplemental directive arguments for "%s" directive not supported'
         '(specified by "%r" role).' % (name, base_role))
     try:

lib/python/docutils/parsers/rst/languages/af.py

@@ -36,10 +36,11 @@ directives = {
       'epigraaf': 'epigraph',
       'hoogtepunte': 'highlights',
       'pull-quote (translation required)': 'pull-quote',
-      'table (translation required)': 'table',
       #'vrae': 'questions',
       #'qa': 'questions',
       #'faq': 'questions',
+      'table (translation required)': 'table',
+      'csv-table (translation required)': 'csv-table',
       'meta': 'meta',
       #'beeldkaart': 'imagemap',
       'beeld': 'image',

lib/python/docutils/parsers/rst/languages/cs.py

@@ -37,10 +37,11 @@ directives = {
       u'moto': 'epigraph',
       u'highlights': 'highlights',
       u'pull-quote': 'pull-quote',
-      u'table (translation required)': 'table',
       #'questions': 'questions',
       #'qa': 'questions',
       #'faq': 'questions',
+      u'table (translation required)': 'table',
+      u'csv-table (translation required)': 'csv-table',
       u'meta': 'meta',
       #'imagemap': 'imagemap',
       u'image': 'image',   # obrazek

lib/python/docutils/parsers/rst/languages/de.py

@@ -37,10 +37,11 @@ directives = {
       'epigraph (translation required)': 'epigraph',
       'highlights (translation required)': 'highlights',
       'pull-quote (translation required)': 'pull-quote', # kasten too ?
-      'table (translation required)': 'table',
       #'questions': 'questions',
       #'qa': 'questions',
       #'faq': 'questions',
+      'table (translation required)': 'table',
+      'csv-table (translation required)': 'csv-table',
       'meta': 'meta',
       #'imagemap': 'imagemap',
       'bild': 'image',

lib/python/docutils/parsers/rst/languages/en.py

@@ -37,8 +37,9 @@ directives = {
       'epigraph': 'epigraph',
       'highlights': 'highlights',
       'pull-quote': 'pull-quote',
-      'table': 'table',
       #'questions': 'questions',
+      'table': 'table',
+      'csv-table': 'csv-table',
       #'qa': 'questions',
       #'faq': 'questions',
       'meta': 'meta',

lib/python/docutils/parsers/rst/languages/eo.py

@@ -40,10 +40,12 @@ directives = {
       u'elstara\u0135oj': 'highlights',
       u'ekstera-citajxo': 'pull-quote',
       u'ekstera-cita\u0135o': 'pull-quote',
-      u'tabelo': 'table',
       #'questions': 'questions',
       #'qa': 'questions',
       #'faq': 'questions',
+      u'tabelo': 'table',
+      u'tabelo-vdk': 'csv-table', # "valoroj disigitaj per komoj"
+      u'tabelo-csv': 'csv-table',
       u'meta': 'meta',
       #'imagemap': 'imagemap',
       u'bildo': 'image',

lib/python/docutils/parsers/rst/languages/es.py

@@ -42,10 +42,12 @@ directives = {
       u'epigrafe': 'epigraph',
       u'destacado': 'highlights',
       u'cita-destacada': 'pull-quote',
-      u'tabla': 'table',
       #'questions': 'questions',
       #'qa': 'questions',
       #'faq': 'questions',
+      u'tabla': 'table',
+      u'tabla-vsc': 'csv-table',
+      u'tabla-csv': 'csv-table',
       u'meta': 'meta',
       #'imagemap': 'imagemap',
       u'imagen': 'image',

lib/python/docutils/parsers/rst/languages/fr.py

@@ -38,10 +38,11 @@ directives = {
       u'\u00E9pigraphe': 'epigraph',
       u'chapeau': 'highlights',
       u'accroche': 'pull-quote',
-      u'tableau': 'table',
       #u'questions': 'questions',
       #u'qr': 'questions',
       #u'faq': 'questions',
+      u'tableau': 'table',
+      u'csv-table (translation required)': 'csv-table',
       u'm\u00E9ta': 'meta',
       #u'imagemap (translation required)': 'imagemap',
       u'image': 'image',

lib/python/docutils/parsers/rst/languages/it.py

@@ -31,10 +31,11 @@ directives = {
       'epigrafe': 'epigraph',
       'evidenzia': 'highlights',
       'pull-quote (translation required)': 'pull-quote',
-      'tabella': 'table',
       #'questions': 'questions',
       #'qa': 'questions',
       #'faq': 'questions',
+      'tabella': 'table',
+      'csv-table (translation required)': 'csv-table',
       'meta': 'meta',
       #'imagemap': 'imagemap',
       'immagine': 'image',

lib/python/docutils/parsers/rst/languages/pt_br.py

@@ -20,78 +20,79 @@ __docformat__ = 'reStructuredText'
 
 directives = {
       # language-dependent: fixed
-      u'ateno': 'attention',
+      u'aten\u00E7\u00E3o': 'attention',
       'cuidado': 'caution',
       'perigo': 'danger',
       'erro': 'error',
-      u'sugesto': 'hint',
+      u'sugest\u00E3o': 'hint',
       'importante': 'important',
       'nota': 'note',
       'dica': 'tip',
       'aviso': 'warning',
-      u'exortao': 'admonition',
+      u'exorta\u00E7\u00E3o': 'admonition',
       'barra-lateral': 'sidebar',
-      u'tpico': 'topic',
+      u't\u00F3pico': 'topic',
       'bloco-de-linhas': 'line-block',
       'literal-interpretado': 'parsed-literal',
       'rubrica': 'rubric',
-      u'epgrafo': 'epigraph',
+      u'ep\u00EDgrafo': 'epigraph',
       'destaques': 'highlights',
-      u'citao-destacada': 'pull-quote',
-      u'table (translation required)': 'table',
+      u'cita\u00E7\u00E3o-destacada': 'pull-quote',
       #'perguntas': 'questions',
       #'qa': 'questions',
       #'faq': 'questions',
+      u'table (translation required)': 'table',
+      u'csv-table (translation required)': 'csv-table',
       'meta': 'meta',
       #'imagemap': 'imagemap',
       'imagem': 'image',
       'figura': 'figure',
-      u'incluso': 'include',
+      u'inclus\u00E3o': 'include',
       'cru': 'raw',
-      u'substituio': 'replace',
+      u'substitui\u00E7\u00E3o': 'replace',
       'unicode': 'unicode',
       'classe': 'class',
       'role (translation required)': 'role',
-      u'ndice': 'contents',
+      u'\u00EDndice': 'contents',
       'numsec': 'sectnum',
-      u'numerao-de-sees': 'sectnum',
-      #u'notas-de-rorap': 'footnotes',
-      #u'citaes': 'citations',
-      u'links-no-rodap': 'target-notes',
+      u'numera\u00E7\u00E3o-de-se\u00E7\u00F5es': 'sectnum',
+      #u'notas-de-rorap\u00E9': 'footnotes',
+      #u'cita\u00E7\u00F5es': 'citations',
+      u'links-no-rodap\u00E9': 'target-notes',
       'restructuredtext-test-directive': 'restructuredtext-test-directive'}
-"""English name to registered (in directives/__init__.py) directive name
-mapping."""
+"""Brazilian Portuguese name to registered (in directives/__init__.py)
+directive name mapping."""
 
 roles = {
     # language-dependent: fixed
-    u'abbreviao': 'abbreviation',
+    u'abbrevia\u00E7\u00E3o': 'abbreviation',
     'ab': 'abbreviation',
-    u'acrnimo': 'acronym',
+    u'acr\u00F4nimo': 'acronym',
     'ac': 'acronym',
-    u'ndice-remissivo': 'index',
+    u'\u00EDndice-remissivo': 'index',
     'i': 'index',
     'subscrito': 'subscript',
     'sub': 'subscript',
     'sobrescrito': 'superscript',
     'sob': 'superscript',
-    u'referncia-a-ttulo': 'title-reference',
-    u'ttulo': 'title-reference',
+    u'refer\u00EAncia-a-t\u00EDtulo': 'title-reference',
+    u't\u00EDtulo': 'title-reference',
     't': 'title-reference',
-    u'referncia-a-pep': 'pep-reference',
+    u'refer\u00EAncia-a-pep': 'pep-reference',
     'pep': 'pep-reference',
-    u'referncia-a-rfc': 'rfc-reference',
+    u'refer\u00EAncia-a-rfc': 'rfc-reference',
     'rfc': 'rfc-reference',
-    u'nfase': 'emphasis',
+    u'\u00EAnfase': 'emphasis',
     'forte': 'strong',
     'literal': 'literal',
-    u'referncia-por-nome': 'named-reference',
-    u'referncia-annima': 'anonymous-reference',
-    u'referncia-a-nota-de-rodap': 'footnote-reference',
-    u'referncia-a-citao': 'citation-reference',
-    u'referncia-a-substituio': 'substitution-reference',
+    u'refer\u00EAncia-por-nome': 'named-reference',
+    u'refer\u00EAncia-an\u00F4nima': 'anonymous-reference',
+    u'refer\u00EAncia-a-nota-de-rodap\u00E9': 'footnote-reference',
+    u'refer\u00EAncia-a-cita\u00E7\u00E3o': 'citation-reference',
+    u'refer\u00EAncia-a-substitui\u00E7\u00E3o': 'substitution-reference',
     'alvo': 'target',
-    u'referncia-a-uri': 'uri-reference',
+    u'refer\u00EAncia-a-uri': 'uri-reference',
     'uri': 'uri-reference',
     'url': 'uri-reference',}
-"""Mapping of English role names to canonical role names for interpreted text.
-"""
+"""Mapping of Brazilian Portuguese role names to canonical role names
+for interpreted text."""

lib/python/docutils/parsers/rst/languages/ru.py

@@ -24,6 +24,7 @@ directives = {
  u'\u0432\u044b\u0434\u0435\u043b\u0435\u043d\u043d\u0430\u044f-\u0446\u0438\u0442\u0430\u0442\u0430':
  u'pull-quote',
  u'table (translation required)': 'table',
+ u'csv-table (translation required)': 'csv-table',
  u'\u0441\u044b\u0440\u043e\u0439': u'raw',
  u'\u0437\u0430\u043c\u0435\u043d\u0430': u'replace',
  u'\u0442\u0435\u0441\u0442\u043e\u0432\u0430\u044f-\u0434\u0438\u0440\u0435\u043a\u0442\u0438\u0432\u0430-restructuredtext':

lib/python/docutils/parsers/rst/languages/sk.py

@@ -36,10 +36,11 @@ directives = {
       u'epigraph (translation required)': 'epigraph',
       u'highlights (translation required)': 'highlights',
       u'pull-quote (translation required)': 'pull-quote',
-      u'table (translation required)': 'table',
       #u'questions': 'questions',
       #u'qa': 'questions',
       #u'faq': 'questions',
+      u'table (translation required)': 'table',
+      u'csv-table (translation required)': 'csv-table',
       u'meta': 'meta',
       #u'imagemap': 'imagemap',
       u'obr\xe1zok': 'image',

lib/python/docutils/parsers/rst/languages/sv.py

@@ -35,11 +35,12 @@ directives = {
       u'epigraph (translation required)': 'epigraph',
       u'highlights (translation required)': 'highlights',
       u'pull-quote (translation required)': 'pull-quote',
-      u'table (translation required)': 'table',
       # u'fr\u00e5gor': 'questions',
       # NOTE: A bit long, but recommended by http://www.nada.kth.se/dataterm/:
       # u'fr\u00e5gor-och-svar': 'questions',
       # u'vanliga-fr\u00e5gor': 'questions',  
+      u'table (translation required)': 'table',
+      u'csv-table (translation required)': 'csv-table',
       u'meta': 'meta',
       # u'bildkarta': 'imagemap',   # FIXME: Translation might be too literal.
       u'bild': 'image',

lib/python/docutils/parsers/rst/roles.py

@@ -263,7 +263,7 @@ def pep_reference_role(role, rawtext, text, lineno, inliner,
         prb = inliner.problematic(rawtext, rawtext, msg)
         return [prb], [msg]
     # Base URL mainly used by inliner.pep_reference; so this is correct:
-    ref = inliner.pep_url % pepnum
+    ref = inliner.document.settings.pep_base_url + inliner.pep_url % pepnum
     return [nodes.reference(rawtext, 'PEP ' + text, refuri=ref, **options)], []
 
 register_canonical_role('pep-reference', pep_reference_role)
@@ -281,7 +281,7 @@ def rfc_reference_role(role, rawtext, text, lineno, inliner,
         prb = inliner.problematic(rawtext, rawtext, msg)
         return [prb], [msg]
     # Base URL mainly used by inliner.rfc_reference, so this is correct:
-    ref = inliner.rfc_url % rfcnum
+    ref = inliner.document.settings.rfc_base_url + inliner.rfc_url % rfcnum
     node = nodes.reference(rawtext, 'RFC ' + text, refuri=ref, **options)
     return [node], []
 

lib/python/docutils/parsers/rst/states.py

@@ -556,14 +556,19 @@ class Inliner:
     # Valid URI characters (see RFC 2396 & RFC 2732);
     # final \x00 allows backslash escapes in URIs:
     uric = r"""[-_.!~*'()[\];/:@&=+$,%a-zA-Z0-9\x00]"""
+    # Delimiter indicating the end of a URI (not part of the URI):
+    uri_end_delim = r"""[>]"""
     # Last URI character; same as uric but no punctuation:
-    urilast = r"""[_~/a-zA-Z0-9]"""
+    urilast = r"""[_~*/=+a-zA-Z0-9]"""
+    # End of a URI (either 'urilast' or 'uric followed by a
+    # uri_end_delim'):
+    uri_end = r"""(?:%(urilast)s|%(uric)s(?=%(uri_end_delim)s))""" % locals()
     emailc = r"""[-_!~*'{|}/#?^`&=+$%a-zA-Z0-9\x00]"""
     email_pattern = r"""
           %(emailc)s+(?:\.%(emailc)s+)*   # name
           @                               # at
           %(emailc)s+(?:\.%(emailc)s*)*   # host
-          %(urilast)s                     # final URI char
+          %(uri_end)s                     # final URI char
           """
     parts = ('initial_inline', start_string_prefix, '',
              [('start', '', non_whitespace_after,  # simple start-strings
@@ -642,15 +647,15 @@ class Inliner:
                       (                       # either:
                         (//?)?                  # hierarchical URI
                         %(uric)s*               # URI characters
-                        %(urilast)s             # final URI char
+                        %(uri_end)s             # final URI char
                       )
                       (                       # optional query
                         \?%(uric)s*
-                        %(urilast)s
+                        %(uri_end)s
                       )?
                       (                       # optional fragment
                         \#%(uric)s*
-                        %(urilast)s
+                        %(uri_end)s
                       )?
                     )
                   )
@@ -954,9 +959,7 @@ class Inliner:
         else:                   # not a valid scheme
             raise MarkupMismatch
 
-    pep_url_local = 'pep-%04d.html'
-    pep_url_absolute = 'http://www.python.org/peps/pep-%04d.html'
-    pep_url = pep_url_absolute
+    pep_url = 'pep-%04d.html'
 
     def pep_reference(self, match, lineno):
         text = match.group(0)
@@ -966,17 +969,17 @@ class Inliner:
             pepnum = int(match.group('pepnum2'))
         else:
             raise MarkupMismatch
-        ref = self.pep_url % pepnum
+        ref = self.document.settings.pep_base_url + self.pep_url % pepnum
         unescaped = unescape(text, 0)
         return [nodes.reference(unescape(text, 1), unescaped, refuri=ref)]
 
-    rfc_url = 'http://www.faqs.org/rfcs/rfc%d.html'
+    rfc_url = 'rfc%d.html'
 
     def rfc_reference(self, match, lineno):
         text = match.group(0)
         if text.startswith('RFC'):
             rfcnum = int(match.group('rfcnum'))
-            ref = self.rfc_url % rfcnum
+            ref = self.document.settings.rfc_base_url + self.rfc_url % rfcnum
         else:
             raise MarkupMismatch
         unescaped = unescape(text, 0)
@@ -2542,9 +2545,10 @@ class Text(RSTState):
             indented.trim_end()
         if not indented:
             return self.quoted_literal_block()
-        nodelist = []
         data = '\n'.join(indented)
-        nodelist.append(nodes.literal_block(data, data))
+        literal_block = nodes.literal_block(data, data)
+        literal_block.line = offset + 1
+        nodelist = [literal_block]
         if not blank_finish:
             nodelist.append(self.unindent_warning('Literal block'))
         return nodelist

lib/python/docutils/readers/pep.py

@@ -16,15 +16,6 @@ from docutils.transforms import peps, references
 from docutils.parsers import rst
 
 
-class Inliner(rst.states.Inliner):
-
-    """
-    Extend `rst.Inliner` for local PEP references.
-    """
-
-    pep_url = rst.states.Inliner.pep_url_local
-
-
 class Reader(standalone.Reader):
 
     supported = ('pep',)
@@ -52,7 +43,7 @@ class Reader(standalone.Reader):
 
     settings_default_overrides = {'pep_references': 1, 'rfc_references': 1}
 
-    inliner_class = Inliner
+    inliner_class = rst.states.Inliner
 
     def __init__(self, parser=None, parser_name=None):
         """`parser` should be ``None``."""

lib/python/docutils/readers/python/__init__.py

 # Author: David Goodger
 # Contact: goodger@users.sourceforge.net
-# Revision: $Revision: 1.3.2.1.8.1 $
-# Date: $Date: 2004/05/12 19:57:53 $
+# Revision: $Revision: 1.7 $
+# Date: $Date: 2004/07/25 01:45:26 $
 # Copyright: This module has been placed in the public domain.
 
 """
 This package contains the Python Source Reader modules.
+
+It requires Python 2.2 or higher (`moduleparser` depends on `compiler` and
+`tokenizer` modules).
 """
 
 __docformat__ = 'reStructuredText'

lib/python/docutils/readers/python/moduleparser.py

 # Author: David Goodger
 # Contact: goodger@users.sourceforge.net
-# Revision: $Revision: 1.3.2.1.8.1 $
-# Date: $Date: 2004/05/12 19:57:53 $
+# Revision: $Revision: 1.14 $
+# Date: $Date: 2004/07/25 01:45:26 $
 # Copyright: This module has been placed in the public domain.
 
 """
-Parser for Python modules.
+Parser for Python modules.  Requires Python 2.2 or higher.
 
 The `parse_module()` function takes a module's text and file name,
 runs it through the module parser (using compiler.py and tokenize.py)

lib/python/docutils/readers/python/pynodes.py

@@ -3,8 +3,8 @@
 """
 :Author: David Goodger
 :Contact: goodger@users.sourceforge.net
-:Revision: $Revision: 1.1.2.1 $
-:Date: $Date: 2004/05/12 19:57:53 $
+:Revision: $Revision: 1.3 $
+:Date: $Date: 2004/03/23 23:21:11 $
 :Copyright: This module has been placed in the public domain.
 
 """

lib/python/docutils/statemachine.py

@@ -344,6 +344,10 @@ class StateMachine:
         finally:
             self.notify_observers()
 
+    def get_source(self, line_offset):
+        """Return source of line at absolute line offset `line_offset`."""
+        return self.input_lines.source(line_offset - self.input_offset)
+
     def abs_line_offset(self):
         """Return line offset of current line, from beginning of file."""
         return self.line_offset + self.input_offset

lib/python/docutils/transforms/peps.py

@@ -118,7 +118,9 @@ class Headers(Transform):
                 for refpep in re.split(',?\s+', body.astext()):
                     pepno = int(refpep)
                     newbody.append(nodes.reference(
-                          refpep, refpep, refuri=self.pep_url % pepno))
+                        refpep, refpep,
+                        refuri=(self.document.settings.pep_base_url
+                                + self.pep_url % pepno)))
                     newbody.append(space)
                 para[:] = newbody[:-1] # drop trailing space
             elif name == 'last-modified':
@@ -128,7 +130,7 @@ class Headers(Transform):
                     para[:] = [nodes.reference('', date, refuri=cvs_url)]
             elif name == 'content-type':
                 pep_type = para.astext()
-                uri = self.pep_url % 12
+                uri = self.document.settings.pep_base_url + self.pep_url % 12
                 para[:] = [nodes.reference('', pep_type, refuri=uri)]
             elif name == 'version' and len(body):
                 utils.clean_rcs_keywords(para, self.rcs_keyword_substitutions)
@@ -266,7 +268,8 @@ class PEPZeroSpecial(nodes.SparseNodeVisitor):
                 text = p.astext()
                 try:
                     pep = int(text)
-                    ref = self.pep_url % pep
+                    ref = (self.document.settings.pep_base_url
+                           + self.pep_url % pep)
                     p[0] = nodes.reference(text, text, refuri=ref)
                 except ValueError:
                     pass

lib/python/docutils/utils.py

@@ -25,6 +25,9 @@ class SystemMessage(ApplicationError):
         self.level = level
 
 
+class SystemMessagePropagation(ApplicationError): pass
+
+
 class Reporter:
 
     """
@@ -52,7 +55,7 @@ class Reporter:
     is compared to the thresholds stored in the category, and a warning or
     error is generated as appropriate.  Debug messages are produced iff the
     stored debug switch is on.  Message output is sent to the stored warning
-    stream.
+    stream if not set to ''.
 
     The default category is '' (empty string).  By convention, Writers should
     retrieve reporting conditions from the 'writer' category (which, unless
@@ -89,7 +92,8 @@ class Reporter:
               exceptions will be raised, halting execution.
             - `debug`: Show debug (level=0) system messages?
             - `stream`: Where warning output is sent.  Can be file-like (has a
-              ``.write`` method), a string (file name, opened for writing), or
+              ``.write`` method), a string (file name, opened for writing), 
+              '' (empty string, for discarding all stream messages) or
               `None` (implies `sys.stderr`; default).
             - `encoding`: The encoding for stderr output.
             - `error_handler`: The error handler for stderr output encoding.
@@ -100,7 +104,12 @@ class Reporter:
         if stream is None:
             stream = sys.stderr
         elif type(stream) in (StringType, UnicodeType):
-            raise NotImplementedError('This should open a file for writing.')
+            # Leave stream untouched if it's ''.
+            if stream != '':
+                if type(stream) == StringType:
+                    stream = open(stream, 'w')
+                elif type(stream) == UnicodeType:
+                    stream = open(stream.encode(), 'w')
 
         self.encoding = encoding
         """The character encoding for the stderr output."""
@@ -175,7 +184,7 @@ class Reporter:
                                    type=self.levels[level],
                                    *children, **attributes)
         debug, report_level, halt_level, stream = self[category].astuple()
-        if level >= report_level or debug and level == 0:
+        if (level >= report_level or debug and level == 0) and stream:
             msgtext = msg.astext().encode(self.encoding, self.error_handler)
             if category:
                 print >>stream, msgtext, '[%s]' % category
@@ -265,6 +274,8 @@ def extract_extension_options(field_list, options_spec):
         - `KeyError` for unknown option names.
         - `ValueError` for invalid option values (raised by the conversion
            function).
+        - `TypeError` for invalid option value types (raised by conversion
+           function).
         - `DuplicateOptionError` for duplicate options.
         - `BadOptionError` for invalid fields.
         - `BadOptionDataError` for invalid option data (missing name,
@@ -321,6 +332,8 @@ def assemble_option_dict(option_list, options_spec):
         - `DuplicateOptionError` for duplicate options.
         - `ValueError` for invalid option values (raised by conversion
            function).
+        - `TypeError` for invalid option value types (raised by conversion
+           function).
     """
     options = {}
     for name, value in option_list:

lib/python/docutils/writers/__init__.py

@@ -36,13 +36,15 @@ class Writer(Component):
     """The document to write (Docutils doctree); set by `write`."""
 
     output = None
-    """Final translated form of `document`; set by `translate`."""
+    """Final translated form of `document` (Unicode string);
+    set by `translate`."""
 
     language = None
     """Language module for the document; set by `write`."""
 
     destination = None
-    """`docutils.io` IO object; where to write the document.  Set by `write`."""
+    """`docutils.io` Output object; where to write the document.
+    Set by `write`."""
 
     def __init__(self):
 
@@ -73,8 +75,8 @@ class Writer(Component):
 
     def translate(self):
         """
-        Do final translation of `self.document` into `self.output`.
-        Called from `write`.  Override in subclasses.
+        Do final translation of `self.document` into `self.output` (Unicode
+        string).  Called from `write`.  Override in subclasses.
 
         Usually done with a `docutils.nodes.NodeVisitor` subclass, in
         combination with a call to `docutils.nodes.Node.walk()` or

lib/python/docutils/writers/docutils_xml.py

@@ -50,7 +50,7 @@ class Writer(writers.Writer):
     doctype = (
         '<!DOCTYPE document PUBLIC'
         ' "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML"'
-        ' "http://docutils.sourceforge.net/spec/docutils.dtd">\n')
+        ' "http://docutils.sourceforge.net/docs/ref/docutils.dtd">\n')
     generator = '<!-- Generated by Docutils %s -->\n'
 
     def translate(self):

lib/python/docutils/writers/html4css1.py

@@ -418,7 +418,6 @@ class HTMLTranslator(nodes.NodeVisitor):
         self.body.append(self.starttag(node, 'table', CLASS='citation',
                                        frame="void", rules="none"))
         self.body.append('<colgroup><col class="label" /><col /></colgroup>\n'
-                         '<col />\n'
                          '<tbody valign="top">\n'
                          '<tr>')
         self.footnote_backrefs(node)
@@ -1143,7 +1142,7 @@ class HTMLTranslator(nodes.NodeVisitor):
         self.body.append(
               # "border=None" is a boolean attribute;
               # it means "standard border", not "no border":
-              self.starttag(node, 'table', CLASS="table", border=None))
+              self.starttag(node, 'table', CLASS="table", border="1"))
 
     def depart_table(self, node):
         self.body.append('</table>\n')

lib/python/reStructuredText/__init__.py

@@ -15,6 +15,19 @@
 This implementation requires docutils 0.3.4+ from http://docutils.sf.net/
 """
 
+try:
+    import docutils
+except ImportError:
+    raise ImportError, 'Please install docutils 0.3.3+ from http://docutils.sourceforge.net/#download.'
+
+version = docutils.__version__.split('.')
+if version < ['0', '3', '3']:
+    raise ImportError, """Old version of docutils found:
+Got: %(version)s, required: 0.3.3+
+Please remove docutils from %(path)s and replace it with a new version. You
+can download docutils at http://docutils.sourceforge.net/#download.
+""" % {'version' : docutils.__version__, 'path' : docutils.__path__[0] }
+
 import sys, os, locale
 from App.config import getConfiguration
 from docutils.core import publish_parts
@@ -28,10 +41,10 @@ default_input_encoding = getConfiguration().rest_input_encoding or default_enc
 default_level = 3
 initial_header_level = getConfiguration().rest_header_level or default_level
 
-# default language
-default_lang = getConfiguration().locale or locale.getdefaultlocale()[0]
-if default_lang and '_' in default_lang:
-    default_lang = default_lang[:default_lang.index('_')]
+# default language used for internal translations and language mappings for DTD
+# elements
+default_lang = 'en'
+default_language_code = getConfiguration().rest_language_code or default_language
 
 
 class Warnings:
@@ -48,7 +61,7 @@ def render(src,
            stylesheet='default.css',
            input_encoding=default_input_encoding,
            output_encoding=default_output_encoding,
-           language_code=default_lang,
+           language_code=default_language_code,
            initial_header_level = initial_header_level,
            settings = {}):
     """get the rendered parts of the document the and warning object
@@ -60,7 +73,7 @@ def render(src,
     settings['stylesheet'] = stylesheet
     settings['language_code'] = language_code
     # starting level for <H> elements:
-    settings['initial_header_level'] = initial_header_level
+    settings['initial_header_level'] = initial_header_level + 1
     # set the reporting level to something sane:
     settings['report_level'] = report_level
     # don't break if we get errors:
@@ -80,7 +93,7 @@ def HTML(src,
          stylesheet='default.css',
          input_encoding=default_input_encoding,
          output_encoding=default_output_encoding,
-         language_code=default_lang,
+         language_code=default_language_code,
          initial_header_level = initial_header_level,
          warnings = None,
          settings = {}):
@@ -119,17 +132,23 @@ def HTML(src,
                                    initial_header_level = initial_header_level,
                                    settings = settings)
 
-    output = ('<h%(level)s class="title">%(title)s</h%(level)s>\n'
-              '%(docinfo)s%(body)s' % {
+    header = '<h%(level)s class="title">%(title)s</h%(level)s>\n' % {
                   'level': initial_header_level,
                   'title': parts['title'],
+             }
+
+    body = '%(docinfo)s%(body)s' % {
                   'docinfo': parts['docinfo'],
-                  'body': parts['body']
-              }).encode(output_encoding)
+                  'body': parts['body'],
+             }
 
-    warnings = ''.join(warning_stream.messages)
+    if parts['title']:
+        output = header + body
+    else:
+        output = body
 
-    return output
+    warnings = ''.join(warning_stream.messages)
 
+    return output.encode(output_encoding)
 
 __all__ = ("HTML", 'render')

skel/etc/zope.conf.in

@@ -335,6 +335,32 @@ instancehome $INSTANCE
 #
 #    rest-output-encoding iso-8859-15
 
+# Directive: rest-header-level
+#
+# Description:
+#     Set the default starting HTML header level for restructured text
+#     documents. The default is 3, which implies that top-level headers
+#     will be created with an <H3> tag.
+#
+# Default: 3
+#
+# Example:
+#
+#    rest-header-level 2
+
+# Directive: rest-language-code
+#
+# Description:
+#    Language code used for some internal translations inside of the docutils
+#    package and for DTD bibliographic elements mapping. See
+#    lib/python/docutils/languages/ for a list of supported language codes.
+#
+# Default: en
+#
+# Example:
+#
+#    rest-language-code de
+
 # Directive: cgi-environment
 #
 # Description: