Re: [Docutils-users] Re: figure that is not an image

[G. M. <g....@we...>]

On 28.07.05, David Goodger wrote:
> [Martin Blais]
> >> Is it possible to create a figure that does not consist of an image?
 
> I don't think the figure name should cause numbering.  The name should
> just be a name, to refer to.  Instead, an explicit option should cause
> numbering, such as ":numbered:" and/or ":sequence: name" (which
> implies ":numbered:"; the name allows for multiple independent
> sequences).

I would propose an auto-numbering similar to the foonotes, e.g. with

    .. figure:: Figure #: auto-numbered figure
       [options]

       content

the caption label is "Figure" and auto-numbering is on.
 
 
> > * Besides i18n, what if the user wants to use a different term than
> >   "Figure", e.g. "Image", "Table", or "Diagram"?
> 
> I think providing two directives, "figure" and "table", will suffice
> for most users.  For example, a new "sequence" directive could be
> added for user-defined a terms or patterns, and "figure" could be
> extended to support it.  For example::
> 
>     .. sequence:: diagram
>        :pattern: Diagram #.


 
> "sequence" could also allow for arbitrary initial values, enumerations
> (1/a/A/i/I), and relationships (figure sequence depends on chapter
> sequence, restarting at 1 whenever chapter changes, and rendered as
> <chapter>.<figure>).

So, "figure" and "table" would become special cases of "sequence"?

Another option would be to use "figure" as generic 'sequence directive'
(with "table" as special case). 

:pattern: defaults to "Figure #." Every different :pattern:
starts a separate counter.

Combined with my above proposal this becomes::

  .. figure:: Diagram #: auto-numbered diagramm
  
     .. image:: diagram.eps


The syntax for the pattern specification needs carefull consideration.
Some thoughts::

  .. figure:: Figure #: title    + simple
                                 + close to appearance in the output
                                 ? should the colon be part of :pattern:?
                                 
  .. figure:: Figure #. title    + close to appearance in the output
                                 - maybe ambiguous (Where does the
                                   :pattern: end and the title start?)
                                 
  .. figure:: Figure #.: title   + explicit
                                 - ugly
                                 
  .. figure:: [Figure #.] title  + explicit
                                 + precedence case: optional labels in LaTeX
                                 - square brackets are hard to type on
                                   German keyboards

  .. figure:: title              + standard rst directive syntax
     :pattern: Figure #.         - does not resemble final appearance
     

Sincerely

Guenter
     
-- 
G.Milde web.de