Re: [Docutils-users] like ".. important::"

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

David Abrahams wrote:
> I'd like to add a callout box to my documents that's similar to what
> you get by writing
> 
>    .. important::
> 
> but instead of "important", it should say "definition".  Is that
> possible?

You could adapt the "topic" or "sidebar" directives for this; the titles are
author-supplied.  The problem here is that topics and sidebars cannot appear
just anywhere; only where sections are possible.  I.E., you can't have one
between two paragraphs.

A new admonition type could be added to the current set of 9 ("attention",
"caution", "danger", "error", "hint", "important", "note", "tip",
"warning").  "Definition" seems general-purpose enough to be added to the
Docutils document model.  Would this increase the document model's richness
(a good thing), or just its bloat?

The alternative is to add a generic admonition that could be given any title
desired::

    .. admonition:: Definition

       Definition body here.

Although this would add flexibility to the document model, I'm reluctant to
add it.  It may be too flexible.

-- David Goodger    http://starship.python.net/~goodger

Programmer/sysadmin for hire: http://starship.python.net/~goodger/cv