Re: [Docutils-users] Google Summer of Code

[Lea W. <lew...@gm...>]

I've just submitted a proposal for adding embedded formula/plot/graph 
support to Docutils/reStructuredText.

Here's the abstract:

------------------------------------------------------------------------
I propose to add image embedding support to the Docutils framework, 
including getting LaTeX formula, graphviz graph and gnuplot plot 
support, so that you can embed LaTeX/graphviz/gnuplot code in 
reStructuredText documents, and any of these programs can be 
automatically called to generate images that are then embedded into the 
output document.

This is especially helpful for the scientic Python community, since they 
frequently need to include formulas and plots.  Also, graphviz is 
*really* handy for creating graphs, which would improve our ability to 
quickly create graphical illustrations for software.
------------------------------------------------------------------------

Proposal text:

------------------------------------------------------------------------
  I propose to add image embedding support to the Docutils framework. 
This means that it should be easy to write plugins that generate images, 
and the framework takes care of writing those images to disk and 
referencing them appropriately.  Currently, images are only supported by 
URI reference, which is awkward and does not work reliably across writers.

Timeline (I have ~9 weeks due to being on vacation with my family):

* 1st-3rd week: Design and implement a framework that allows plugins to 
generate images and let Docutils take care of embedding them into the 
document.

* 4th-6th week: Port the existing (not widely used) LaTeX formula, 
graphviz, and ASCII-art-to-PNG support to the new framework.  Fill in 
implementations where necessary, so rendering to HTML documents 
(requiring PNG images) and to PDF documents through LaTeX (requiring PDF 
or EPS images) works transparently.  (For instance, there are different 
LaTeX formula plugins, for either LaTeX or HTML, but there is no 
existing output-format-independent support.)  Clean up code, where 
necessary.  Have a discussion on the mailing list about how to make the 
syntax for embedding LaTeX/graphviz/gnuplot code in reStructuredText 
consistent, and implement the reStructuredText syntax.

* 7th week: Design and implement gnuplot support.

* 8th week: Documentation.

* 9th week: Buffer time.  Perhaps try to merge the LaTeX, graphviz, 
gnuplot, and ASCII art support into the core, so no plugins have to be 
installed.  (But I cannot promise that this will be possible at this 
time -- it will require discussion on the mailing list.)

David Goodger is willing to mentor me, like last year -- thanks, David!
------------------------------------------------------------------------

Best wishes,

     Lea