Re: [Docutils-develop] QuickRef (was RE: Figure references)

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

Tony J Ibbs (Tibs) wrote:
> David may answer this better than I can (he's *much* better at
> designing directives!).
> 
> But the idea, as I would see it, is that one doesn't write::
> 
>     +-----+--------------------+
>     | raw | the same formatted |
>     +-----+--------------------+
> 
> but instead something like::
> 
>     ..examples::
>       rst::
>          The *raw* text we want
>       rst::
>          Another such.

I see, you're using "rst::" as a delimiter between examples,
effectively generating rows in an "example table".  Since "rst" is
assumes, this could be done more easily, perhaps with indentation and
".."::

    .. examples::
           The *raw* text we want.
       ..
           Another such.

>     ..examples::
>       rst::
>          The *raw* text we want.
> 
>          Which spans two paragraphs.
>       rst::
>          And might be a title
>          ====================
>          Or subtitle
>          -----------

The latter would be tricky, since section headers can only occur in
certain contexts (e.g., not within a block quote, and certainly not
within a table).  They may have to be simulated somehow.

> Since a directive can do "anything it likes" (that *may* be a quote)
> with the stuff "inside" it, this approach seems like it should work...

Given enough effort, anything's possible. :-)

-- 
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/