docutils-develop — For developer discussions of the implementation.

[Docutils-develop] Parsing oddness

[Richard J. <rj...@ek...>]

I've got some problems in parsing a document. The following biblio element 
results in errors:

>>>>> snip
:Organization: Computer and Information Sciences::

                 New Jersey Institute of Technology
                 University Heights
                 Newark, NJ, 07102
                 (address obsolescent).
<<<<< snip

Reporter: WARNING (2) Literal block expected at line 2; none found.
Reporter: WARNING (2) Cannot extract compound bibliographic field 
"Organization".


I've hit another error in a definition list... note the line number the error 
is reported at, and the line that is actually erroneous (the last one).

>>>>> snip
S.member(ob), D.member(arg,map), G.member(src,dst)
  respectively are membership tests for the types. Each returns 1 if the
  object or pair are members of the structure or 0 otherwise.

S.add(ob), D.add(arg,map), G.add(src,dst)
  respectively add new members to the object. These are equivalent to
  G[src]=dst, D[arg]=map, S[ob]=1 but the former may be preferrable for
  graphs and sets since they are less misleading. This is an "in
  place" mutation operation -- it will raise an error if the object has
  been hashed.

X.items()
  returns a list of the members of the structure. For example::

    >>> X = kjSet([0, 1, 2, 0, 1])
    >>> X.items()
    [1, 0, 2]
    >>> X = kjGraph([(3, 0), (2, 2), (1, 2), (2, 0), (2, 0), (3, 0)])
    >>> X.items()
    [(1, 2), (3, 0), (2, 2), (2, 0)]

G.keys(), G.values()
  return the left members and right members of pairs in the graph G
  respectively. For example::

    >>> G = kjGraph([(4, 8), (0, 9), (1, 10), (4, 9), (3, 7), (3, 8), (2,
    >>> 7)])
    >>> G.keys()
    [4, 0, 1, 3, 2]
    >>> G.values()
    [8, 9, 10, 9, 7, 8, 7]

  Note that keys eliminates redundancies, whereas values does not. These
  functions are also defined for dictionaries but are not defined for
sets.

<<<<< snip

Reporter: WARNING (2) Definition list ends without a blank line; unexpected 
unindent at line 5.



     Richard

[Docutils-develop] news

[David G. <go...@us...>]

I've just finished a major round of checkins (subscribe at
http://lists.sourceforge.net/lists/listinfo/docutils-checkins).  Here's a
summary of the changes I made:

- Changed a lot of 'longnamesthatlooklikethis' into
  'long_names_that_look_like_this'.  Improves readability methinks.
  This will break most docutils-dependent code out there.  Check in your
  code to the CVS tree and I'll help bring it up to date.  (Tony, do you
  have any changes for pysource?  Please send them if you can't CVS.)
- Added a PEP reader.  This provides support for RFC 2822 headers and
  recognizes 'PEP ####' and 'RFC ####' in the text as hyperlinks.  I'm
  still working on a directive and a front-end, then I'll convert PEP 287
  as a proof of concept.
- Extracted the inline markup parsing code into a class of its own,
  docutils.parsers.rst.states.Inliner.  This allows for easy subclassing
  (already in use by the PEP reader).
- Made the html4css1.py writer XHTML-compatible: switched to lowercase
  element & attribute names; empty tag format.  More may be required for
  full compatibility; I'll wait for bug reports.

For more details, see http://docutils.sf.net/HISTORY.html.

-- 
David Goodger  <go...@us...>  Open-source projects:
  - Python Docutils: http://docutils.sourceforge.net/
    (includes reStructuredText: http://docutils.sf.net/rst.html)
  - The Go Tools Project: http://gotools.sourceforge.net/

RE: [Docutils-develop] Re: ANN: Docutils 0.1 Released

[Tony J I. (Tibs) <to...@ls...>]

Engelbert Gruber wrote:
> is anyone working on writers and when on which one ?

David Goodger replied:
> I've written a simple HTML writer, but I'm now working on other
> components.  No definite plans for additional writers yet.

I've also got a simple HTML writer (one that doesn't use CSS) in
pysource - at some stage that's likely to become more like David's in
API - so getting ideas from David's Writer on how to do such things is
still a good idea.

I'd hope that someone will work on PDF at some point - I've still got an
outstanding promise to Andy Robinson to push that idea around a bit at
people.

Tibs

--
Tony J Ibbs (Tibs)      http://www.tibsnjoan.co.uk/
.. "equal" really means "in some sense the same, but maybe not
.. the sense you were hoping for", or, more succinctly, "is
.. confused with". (Gordon McMillan, Python list, Apr 1998)
My views! Mine! Mine! (Unless Laser-Scan ask nicely to borrow them.)

Re: [Docutils-develop] Re: ANN: Docutils 0.1 Released

[David G. <go...@us...>]

Engelbert Gruber wrote:
> is anyone working on writers and when on which one ?

I've written a simple HTML writer, but I'm now working on other
components.  No definite plans for additional writers yet.

> any hints on a latex or rtf backend ?

If you're volunteering to write one or both and are asking for help,
great!  I'll be happy to answer any questions you have.  As Richard
said, please take a look at the HTML writer for a start.

If you're asking when LaTeX and RTF writers will be ready, I couldn't
say.  I don't know of anyone working on them yet.  They're not a
priority on my list.  If they're important to you, please consider
writing one and contributing it back to the project!

Richard Jones wrote:
> I'd say start with the HTML writer and work from there. It
> implements formatting for most (all?) of the DOM.

The docutils.writers.html4css1 module should support all elements;
that's one if its goals.  If it doesn't, that's a bug.

-- 
David Goodger  <go...@us...>  Open-source projects:
  - Python Docutils: http://docutils.sourceforge.net/
  - The Go Tools Project: http://gotools.sourceforge.net/

Re: [Docutils-develop] Re: ANN: Docutils 0.1 Released

[Richard J. <rj...@ek...>]

On Fri, 26 Apr 2002 20:35, eng...@ss... wrote:
> is anyone working on writers and when on which one ?
>
> any hints on a latex or rtf backend ?

I'd say start with the HTML writer and work from there. It implements 
formatting for most (all?) of the DOM.


   Richard

[Docutils-develop] Re: ANN: Docutils 0.1 Released

[<eng...@ss...>]

is anyone working on writers and when on which one ?

any hints on a latex or rtf backend ?

cheers
-- 
 --- Engelbert Gruber ----+
 SSG Fintl,Gruber,Lassnig |
 A6410 Telfs Untermarkt 9 |
 Tel. ++43-5262-64727 ----+

[Docutils-develop] ANN: Docutils 0.1 Released

[David G. <go...@us...>]

The purpose of the Docutils project is to create a set of tools for
processing plaintext documentation into useful formats, such as HTML,
XML, and TeX.  It is the subject of PEPs 256 & 258.  Docutils
currently supports input from standalone files; soon it will process
PEPs, and eventually it will support inline documentation from Python
modules and packages.  Docutils uses the reStructuredText markup, the
subject of PEP 287; other markups are possible.  It produces simple
HTML for CSS; other formats will become available in time.

Quick link to the download:

    http://prdownloads.sf.net/docutils/docutils-0.1.tar.gz

Docutils home page: http://docutils.sourceforge.net/

To subscribe to the mailing lists:

- Development discussions (doc...@li...):
  http://lists.sourceforge.net/lists/listinfo/docutils-develop

- CVS checkin messages:
  http://lists.sourceforge.net/lists/listinfo/docutils-checkins

High-level discussions take place on the Python Doc-SIG mailing list:
http://mail.python.org/mailman/listinfo/doc-sig,
mailto:Do...@py...

A ReStructuredText Primer (gentle introduction):
http://docutils.sf.net/docs/rst/quickstart.html

Quick reStructuredText (user reference):
http://docutils.sf.net/docs/rst/quickref.html

There has been a lot of progress lately.  The reStructuredText parser
is feature-complete, there's a standalone input file reader, and a
simple HTML/CSS writer.  The web site's HTML files are generated from
reStructuredText source (the quickref being the only exception).
There are a few simple front-ends in docutils/tools; see the README:
http://docutils.sf.net/README.html.

There is still much work to be done.  Contributors are welcome!


Release 0.1 (2002-04-20)
========================

This is the first release of Docutils, merged from the now inactive
reStructuredText_ and `Docstring Processing System`_ projects.  For
the pre-Docutils history, see the `reStructuredText HISTORY`_ and
`DPS HISTORY`_ files.

.. _reStructuredText: http://structuredtext.sf.net/
.. _Docstring Processing System: http://docstring.sf.net/
.. _reStructuredText HISTORY:
   http://structuredtext.sf.net/HISTORY.html
.. _DPS HISTORY: http://docstring.sf.net/HISTORY.html

General changes: renamed 'dps' package to 'docutils'; renamed
'restructuredtext' subpackage to 'rst'; merged the codebases; merged
the test suites (reStructuredText's test/test_states renamed to
test/test_rst); and many modifications required to make it all work.

-- 
David Goodger  <go...@us...>  Open-source projects:
  - Python Docutils: http://docutils.sourceforge.net/
  - The Go Tools Project: http://gotools.sourceforge.net/