Products/0000700000076500001200000000000010322233244013053 5ustar ajungadmin00000000000000Products/ZReST/0000700000076500001200000000000010322233316014022 5ustar ajungadmin00000000000000Products/ZReST/__init__.py0000600000076500001200000000056610322223000016131 0ustar ajungadmin00000000000000# # $Id: __init__.py 24763 2004-05-17 05:59:28Z philikon $ # __version__='1.0' # product initialisation import ZReST def initialize(context): context.registerClass( ZReST.ZReST, meta_type = 'ReStructuredText Document', icon='www/zrest.gif', constructors = ( ZReST.manage_addZReSTForm, ZReST.manage_addZReST ) ) Products/ZReST/dtml/0000700000076500001200000000000010322233316014762 5ustar ajungadmin00000000000000Products/ZReST/dtml/manage_addZReSTForm.dtml0000600000076500001200000000205710312206435021427 0ustar ajungadmin00000000000000

You may optionally select a file to upload from your local computer by clicking the Browse button.

Id
File
Products/ZReST/dtml/manage_editForm.dtml0000600000076500001200000000477610312206435020746 0ustar ajungadmin00000000000000

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 browse button to select a local file to upload. 

&dtml-warnings;

Help: ReStructuredText primer for beginners, quick reference for the more advanced and home page for all the details.

Locked by WebDAV   
File  
Locked by WebDAV
Products/ZReST/Makefile0000600000076500001200000000062710322222775015500 0ustar ajungadmin00000000000000FILES = 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 Products/ZReST/README.txt0000600000076500001200000000164310322222775015535 0ustar ajungadmin00000000000000---------------------------------- ReStructuredText Document for Zope ---------------------------------- 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 Character set encoding issues ============================= ZReST instances have a property "input_encoding" to specify the encoding of your reST document. "output_encoding" is used the encoding of the output. You can specify any valid encoding that is known to Python (e.g. "iso-8859-1" or "utf-8"). Footnotes ========= This product was written by Richard Jones, rjones@ekit-inc.com. Minor extensions for the Zope 2.7 integration by Andreas Jung, andreas@andreas-jung.com. Please direct questions about ReStructureText to the docutils mailing lists. This package is placed in the Public Domain. Products/ZReST/refresh.txt0000600000076500001200000000010710322222775016230 0ustar ajungadmin00000000000000This is a flag that tells Zope that the product may be auto-refreshed. Products/ZReST/TODO.txt0000600000076500001200000000031010322222775015333 0ustar ajungadmin00000000000000. 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 Products/ZReST/version.txt0000600000076500001200000000000410322222775016253 0ustar ajungadmin000000000000001.1 Products/ZReST/www/0000700000076500001200000000000010322233316014646 5ustar ajungadmin00000000000000Products/ZReST/www/zrest.gif0000600000076500001200000000032110312206435016503 0ustar ajungadmin00000000000000GIF89aQQQ2e!,xwwwffhfawwhDDfqxwaDDhfqffhfwh&"bxwafffhVpfh33whffffxwaaVpffhffwhfaxwafffhFpa(""wXUEUUxw;Products/ZReST/ZReST.py0000600000076500001200000002473610322223170015356 0ustar ajungadmin00000000000000# # $Id: ZReST.py 39011 2005-10-09 14:30:31Z andreasjung $ # ''' ReStructuredText Product for Zope This Product stores two texts - a "source" text in ReStructureText format, and a HTML "formatted" version of that text. ''' import docutils.core, docutils.io from Globals import InitializeClass, DTMLFile from OFS.SimpleItem import Item from OFS.PropertyManager import PropertyManager from OFS.History import Historical, html_diff from Acquisition import Implicit from Persistence import Persistent from AccessControl import ClassSecurityInfo from AccessControl import ModuleSecurityInfo from DateTime.DateTime import DateTime from App.config import getConfiguration import sys modulesecurity = ModuleSecurityInfo() modulesecurity.declareProtected('View management screens', 'manage_addZReSTForm') manage_addZReSTForm = DTMLFile('dtml/manage_addZReSTForm', globals()) modulesecurity.declareProtected('Add Z Roundups', 'manage_addZReST') def manage_addZReST(self, id, file='', REQUEST=None): """Add a ZReST product """ # validate the instance_home self._setObject(id, ZReST(id)) self._getOb(id).manage_upload(file) if REQUEST is not None: return self.manage_main(self, REQUEST) class Warnings: def __init__(self): self.messages = [] def write(self, message): self.messages.append(message) class ZReST(Item, PropertyManager, Historical, Implicit, Persistent): '''An instance of this class provides an interface between Zope and ReStructuredText for one text. ''' meta_type = 'ReStructuredText Document' security = ClassSecurityInfo() def __init__(self, id,output_encoding=None, input_encoding=None): self.id = id self.title = id self.stylesheet = 'default.css' self.report_level = '2' self.source = self.formatted = '' from reStructuredText import default_output_encoding, \ default_input_encoding self.input_encoding = input_encoding or \ default_input_encoding self.output_encoding = output_encoding or \ default_output_encoding # define the properties that define this object _properties = ( {'id':'stylesheet', 'type': 'string', 'mode': 'w', 'default': 'default.css'}, {'id':'report_level', 'type': 'string', 'mode': 'w', 'default': '2'}, {'id':'input_encoding', 'type': 'string', 'mode': 'w', 'default': 'iso-8859-15'}, {'id':'output_encoding', 'type': 'string', 'mode': 'w', 'default': 'iso-8859-15'}, ) property_extensible_schema__ = 0 # define the tabs for the management interface manage_options= ( {'label': 'Edit', 'action':'manage_main'}, {'label': 'View', 'action':'index_html'}, {'label': 'Source', 'action':'source_txt'}, ) \ + PropertyManager.manage_options \ + Historical.manage_options \ + Item.manage_options # access to the source text and formatted text security.declareProtected('View', 'index_html') def index_html(self, REQUEST=None): ''' Getting the formatted text ''' if REQUEST is not None: REQUEST.RESPONSE.setHeader('content-type', 'text/html; charset=%s' % self.output_encoding) return self.formatted security.declareProtected('View', 'source_txt') def source_txt(self, REQUEST=None): ''' Getting the source text ''' if REQUEST is not None: REQUEST.RESPONSE.setHeader('content-type', 'text/plain; charset=%s' % self.input_encoding) return self.source # edit form, which is also the primary interface security.declareProtected('Edit ReStructuredText', 'manage_main') manage_main = DTMLFile('dtml/manage_editForm', globals()) # edit action security.declareProtected('Edit ReStructuredText', 'manage_edit') def manage_edit(self, data, SUBMIT='Change',dtpref_cols='50', dtpref_rows='20', REQUEST=None): '''Alias index_html to roundup's index ''' if self._size_changes.has_key(SUBMIT): return self._er(data, SUBMIT, dtpref_cols, dtpref_rows, REQUEST) if data != self.source: self.source = data self.render() if REQUEST is not None: message="Saved changes." return self.manage_main(self, REQUEST, manage_tabs_message=message) # handle edit window size changes _size_changes = { 'Bigger': (5,5), 'Smaller': (-5,-5), 'Narrower': (0,-5), 'Wider': (0,5), 'Taller': (5,0), 'Shorter': (-5,0), } def _er(self, data, SUBMIT, dtpref_cols, dtpref_rows, REQUEST): dr,dc = self._size_changes[SUBMIT] rows = str(max(1, int(dtpref_rows) + dr)) cols = str(dtpref_cols) if cols.endswith('%'): cols = str(min(100, max(25, int(cols[:-1]) + dc))) + '%' else: cols = str(max(35, int(cols) + dc)) e = (DateTime("GMT") + 365).rfc822() setCookie = REQUEST["RESPONSE"].setCookie setCookie("dtpref_rows", rows, path='/', expires=e) setCookie("dtpref_cols", cols, path='/', expires=e) REQUEST.other.update({"dtpref_cols":cols, "dtpref_rows":rows}) return self.manage_main(self, REQUEST, __str__=self.quotedHTML(data)) security.declarePrivate('quotedHTML') def quotedHTML(self, text=None, character_entities=( (('&'), '&'), (("<"), '<' ), ((">"), '>' ), (('"'), '"'))): #" if text is None: text=self.read_raw() for re,name in character_entities: if text.find(re) >= 0: text=name.join(text.split(re)) return text # handle uploads too security.declareProtected('Edit ReStructuredText', 'manage_upload') def manage_upload(self, file='', REQUEST=None): ''' Replaces the current source with the upload. ''' if isinstance(file, type('')): self.source = file else: self.source = file.read() self.render() if REQUEST is not None: message="Saved changes." return self.manage_main(self, REQUEST, manage_tabs_message=message) security.declarePrivate('render') def render(self): ''' Render the source to HTML ''' # format with strings pub = docutils.core.Publisher() pub.set_reader('standalone', None, 'restructuredtext') pub.set_writer('html') # go with the defaults pub.get_settings() # this is needed, but doesn't seem to do anything pub.settings._destination = '' # use the stylesheet chosen by the user pub.settings.stylesheet = self.stylesheet # set the reporting level to something sane pub.settings.report_level = int(self.report_level) # Disallow inclusion of files for security reasons pub.settings.file_insertion_enabled = 0 # don't break if we get errors pub.settings.halt_level = 6 # remember warnings pub.settings.warning_stream = Warnings() pub.source = docutils.io.StringInput( source=self.source, encoding=self.input_encoding) # output - not that it's needed pub.settings.output_encoding = self.output_encoding pub.destination = docutils.io.StringOutput( encoding=self.output_encoding) # parse! document = pub.reader.read(pub.source, pub.parser, pub.settings) # transform pub.apply_transforms(document) self.warnings = ''.join(pub.settings.warning_stream.messages) if document.children: item = document.children[0] if item.tagname == 'title': self.title = item.children[0].astext() # do the format self.formatted = pub.writer.write(document, pub.destination) security.declareProtected('Edit ReStructuredText', 'PUT', 'manage_FTPput') def PUT(self, REQUEST, RESPONSE): ''' Handle HTTP PUT requests ''' data = REQUEST.get('BODY', '') if data != self.source: if data.startswith('.. '): data = data.splitlines() new = [] for i in range(len(data)): line = data[i] if not line.startswith('.. '): break if line.startswith('.. stylesheet='): self.stylesheet = line.split('=')[1] elif line.startswith('.. report_level='): self.report_level = line.split('=')[1] else: pass # ignore data = '\n'.join(new) + '\n'.join(data[i:]) self.source = data self.render() RESPONSE.setStatus(204) return RESPONSE manage_FTPput = PUT def manage_FTPget(self): ''' Get source for FTP download ''' self.REQUEST.RESPONSE.setHeader('Content-Type', 'text/plain') s = [ '.. This is a ReStructuredText Document. Initial comment lines ' '(".. ") will be stripped.', '.. stylesheet='+self.stylesheet, '.. report_level='+self.report_level ] if self.warnings: s.append('.. ') s.append('.. ' + '\n.. '.join(self.warnings.splitlines())) s.append('.. ') return '\n'.join(s) + '\n' + self.source def __str__(self): ''' Stringfy .. return the source ''' return self.quotedHTML(self.source) __call__ = __str__ def PrincipiaSearchSource(self): ''' Support for searching - the document's contents are searched. ''' return self.source def manage_historyCompare(self, rev1, rev2, REQUEST, historyComparisonResults=''): return ZReST.inheritedAttribute('manage_historyCompare')( self, rev1, rev2, REQUEST, historyComparisonResults=html_diff(rev1.source, rev2.source)) def manage_editProperties(self, REQUEST): """ re-render the page after changing the properties (encodings!!!) """ result = PropertyManager.manage_editProperties(self, REQUEST) self.render() return result InitializeClass(ZReST) modulesecurity.apply(globals()) # vim: set filetype=python ts=4 sw=4 et si docutils/0000700000076500001200000000000010322233316013076 5ustar ajungadmin00000000000000docutils/__init__.py0000600000076500001200000001372310312206425015217 0ustar ajungadmin00000000000000# Author: David Goodger # Contact: goodger@python.org # Revision: $Revision: 1.2.10.9 $ # Date: $Date: 2005/01/07 13:26:01 $ # Copyright: This module has been placed in the public domain. """ This is the Docutils (Python Documentation Utilities) package. Package Structure ================= Modules: - __init__.py: Contains component base classes, exception classes, and Docutils `__version__`. - core.py: Contains the ``Publisher`` class and ``publish_*()`` convenience functions. - frontend.py: Runtime settings (command-line interface, configuration files) 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. - 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.3.7' """``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 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. 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 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 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.""" config_section = None """The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.""" config_section_dependencies = None """A list of names of config file sections that are to be applied before `config_section`, in order (from general to specific). In other words, the settings in `config_section` are to be overlaid on top of the settings from these sections. The "general" section is assumed implicitly. Override in subclasses.""" 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.""" unknown_reference_resolvers = () """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:: reference_resolver.priority = 100 Override in subclasses.""" class Component(SettingsSpec, TransformSpec): """Base class for Docutils components.""" component_type = None """Name of the component type ('reader', 'parser', 'writer'). 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 docutils/BUGS.txt0000600000076500001200000002105610322221304014377 0ustar ajungadmin00000000000000================ Docutils_ Bugs ================ :Author: David Goodger; open to all Docutils developers :Contact: goodger@python.org :Date: $Date: 2005/01/07 15:11:43 $ :Revision: $Revision: 1.1.2.1 $ :Copyright: This document has been placed in the public domain. .. _Docutils: http://docutils.sourceforge.net/ Bugs in Docutils?!? Yes, we do have a few. Some are old-timers that tend to stay in the shadows and don't bother anybody. Once in a while new bugs are born. From time to time some bugs (new and old) crawl out into the light and must be dealt with. Icky. This document describes how to report a bug, and lists known bugs. .. contents:: How To Report A Bug =================== If you think you've discovered a bug, please read through these guidelines before reporting it. First, make sure it's a new bug: * Please check the list of `known bugs`_ below and the `SourceForge Bug Tracker`_ to see if it has already been reported. * Are you using the very latest version of Docutils? The bug may have already been fixed. Please get the latest version of Docutils from CVS_ or from the `development snapshot`_ and check again. Even if your bug has not been fixed, others probably have, and you're better off with the most up-to-date code. If you don't have time to check the latest snapshot, please report the bug anyway. We'd rather tell you that it's already fixed than miss reports of unfixed bugs. * If Docutils does not behave the way you expect, look in the documentation_ (don't forget the FAQ_!) and `mailing list archives`_ for evidence that it should behave the way you expect. If you're not sure, please ask on the docutils-users@lists.sourceforge.net [1]_ mailing list first. If it's a new bug, the most important thing you can do is to write a simple description and a recipe that reproduces the bug. Try to create a minimal document that demonstrates the bug. The easier you make it to understand and track down the bug, the more likely a fix will be. Now you're ready to write the bug report. Please include: * A clear description of the bug. Describe how you expected Docutils to behave, and contrast that with how it actually behaved. While the bug may seem obvious to you, it may not be so obvious to someone else, so it's best to avoid a guessing game. * A complete description of the environment in which you reproduced the bug: - Your operating system & version. - The version of Python (``python -V``). - The version of Docutils (use the "-V" option to most Docutils front-end tools). - Any private modifications you made to Docutils. - Anything else that could possibly be relevant. Err on the side of too much information, rather than too little. * A literal transcript of the *exact* command you ran, and the *exact* output. Use the "--traceback" option to get a complete picture. * The exact input and output files. Better to attach complete files to your bug report than to include just a summary or excerpt. * If you also want to include speculation as to the cause, and even a patch to fix the bug, that would be great! The best place to send your bug report is to the `SourceForge Bug Tracker`_. That way, it won't be misplaced or forgotten. In fact, an open bug report on SourceForge is a constant irritant that begs to be squashed. Thank you! (This section was inspired by the `Subversion project's`__ BUGS__ file.) .. [1] Due to overwhelming amounts of spam, the docutils-users@lists.sourceforge.net mailing list has been set up for subscriber posting only. Non-subscribers who post to docutils-users will receive a message with "Subject: Your message to Docutils-users awaits moderator approval". Legitimate messages are accepted and posted as soon as possible (a list administrator must verify the message manually). If you'd like to subscribe to docutils-users, please visit . __ http://subversion.tigris.org/ __ http://svn.collab.net/viewcvs/svn/trunk/BUGS?view=markup .. _CVS: http://sourceforge.net/cvs/?group_id=38414 .. _development snapshot: http://docutils.sf.net/#development-snapshot .. _documentation: docs/ .. _FAQ: FAQ.html .. _mailing list archives: http://docutils.sf.net/#mailing-lists .. _SourceForge Bug Tracker: http://sourceforge.net/tracker/?group_id=38414&atid=422030 Known Bugs ========== Also see the `SourceForge Bug Tracker`_. * .. _unencoded stylesheet reference: ``--stylesheet='foo&bar'`` causes an invalid stylesheet reference to be inserted in an HTML file, because the ``&`` isn't encoded as ``&``. * ``utils.relative_path()`` sometimes returns absolute _`paths on Windows` (like ``C:/test/foo.css``) where it could have chosen a relative path. Furthermore, absolute pathnames are inserted verbatim, like ``href="C:/test/foo.css"`` instead of ``href="file:///C:/test/foo.css"``. For details, see `this posting by Alan G. Isaac `_. * .. _empty csv-table: When supplying an empty file for the csv-table directive, Docutils crashes with a zero-division error. Example:: .. csv-table:: :file: empty.txt * _`Line numbers` in system messages are inconsistent in the parser. - In text inserted by the "include" directive, errors are often not reported with the correct "source" or "line" numbers. Perhaps all Reporter calls need "source" and "line" keyword arguments. Elements' .line assignments should be checked. (Assign to .source too? Add a set_info method? To what?) There's a test in test/test_parsers/test_rst/test_directives/test_include.py. - Some line numbers in elements are not being set properly (explicitly), just implicitly/automatically. See rev. 1.74 of docutils/parsers/rst/states.py for an example of how to set. * .. _none source: Quite a few nodes are getting a "None" source attribute as well. In particular, see the bodies of definition lists. * .. _mislocated targets: Explicit targets are sometimes mis-located. In particular, placing a target before a section header puts the target at the end of the previous section instead of the start of the next section. The code in docutils.transforms.misc.ClassAttribute could be used to fix this. (Reported by David Priest.) * David Abrahams pointed out that _`doubly-indirect substitutions` have a bug, but only when there's multiple references:: |substitute| my coke for gin |substitute| you for my mum at least I'll get my washing done .. |substitute| replace:: |replace| .. |replace| replace:: swap This is tricky. Substitutions have to propagate back completely. * .. _substitutions and references: Another bug from David Abrahams (run with ``rst2html.py --traceback``):: |substitution| and again a |substitution|. .. |substitution| replace:: ref__ __ a.html __ b.html Change the references.Substitutions tranform's priority from 220 to 680, so it happens after reference resolution? Then we have to deal with multiple IDs. Perhaps the Substitution transform should remove all IDs from definitions after the first substitution reference is processed. * Footnote label "5" should be "4":: $ rst2pseudoxml.py < ref [#abc]_ [#]_ [1]_ [#4]_ > > .. [#abc] footnote > .. [#] two > .. [1] one > .. [#4] four > EOF ref 2 3 1 5