docutils-users Mailing List for Docutils: Documentation Utilities

On 03/20/2017 09:36 PM, David Goodger wrote:
> On Mon, Mar 20, 2017 at 5:28 PM, Tim Daneliuk <tu...@tu...> wrote:
>> I am a fairly casual RST user, but have a problem that would be most easily
>> solved if I could create custom admonitions.  For example, instead of "Note",
>> I might want the admonition to say "Notify-Larry".
>>
>> Is there a simple way to do this?
> 
> http://docutils.sourceforge.net/docs/ref/rst/directives.html#generic-admonition
> 
> David Goodger
> <http://python.net/~goodger>
> 

Perfect.  Thanks very much.

On Mon, Mar 20, 2017 at 5:28 PM, Tim Daneliuk <tu...@tu...> wrote:
> I am a fairly casual RST user, but have a problem that would be most easily
> solved if I could create custom admonitions.  For example, instead of "Note",
> I might want the admonition to say "Notify-Larry".
>
> Is there a simple way to do this?

http://docutils.sourceforge.net/docs/ref/rst/directives.html#generic-admonition

David Goodger
<http://python.net/~goodger>

I am a fairly casual RST user, but have a problem that would be most easily
solved if I could create custom admonitions.  For example, instead of "Note",
I might want the admonition to say "Notify-Larry".

Is there a simple way to do this?

Dear Docutils users,

today I ask for feedback on a new feature of the latex writer.

Since `SVN revision 8044`__, the Docutils LaTeX writer handles class
arguments for block-level elements by wrapping them in a "DUclass"
environment.

__ https://sourceforge.net/p/docutils/code/8044/

With this addition, inline elements are handled via the ``\DUrole{}`` macro,
block level elements are wrapped in ``DUclass`` environments. Customization
is done by defining matching macros or environments.

Example: Use small caps font inside elements with class value "custom".

Inline elements
  The LaTeX function ``\textsc`` sets the argument in small caps::

    \newcommand{\DUrolesmallcaps}[1]{\textsc{#1}}

Block-level elements
  The LaTeX directive (macro without argument) ``\scshape`` switches to
  the small caps font. Its effect is confined to the wrapper ``DUclass``
  environment::

    \newcommand*{\DUCLASScustom}{\scshape}

For details and more examples, see latex.txt__

__ https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/docs/user/latex.txt?format=raw


The "DUclass" wrapper also replaces the special handling for "epigraph" and
"topic" elements.  (Failure to compile epigraphs with more than one
paragraph triggered the change.)


Qustions:

a) Change the class handling of paragraphs to "CUclass" environment?

   Currently, paragraphs with a class argument are wrapped in
   \DUrole{<classargument>}{<content>}

   Should we change this to
   \begin{DUclass}{<classargument>}
      <content>
   \end{DUclass}
   or leave as-is for backwards compatibility.

b) Adjust the naming of the optional styling commands styling an element with
   class value "spam" from
     \DUrolespam         \begin{DUCLASSspam} \end{DUCLASSspam}
   to
     \DUROLEspam         \begin{DUCLASSspam} \end{DUCLASSspam}
   or
     \DUrolespam         \begin{DUclassspam} \end{DUclassspam}
   ?

c) other ideas, problems, and suggestions?

Thanks,
Günter

On 3/11/2017 3:32 PM, Guenter Milde wrote:
> you cannot put only a part of the expression in quotes and
> whitespace is not stripped.


Got it.  I misread the following (by ignoring the "following"):
"Treat whitespace immediately following the delimiter as significant.
The default is to ignore such whitespace."

Thank you for the patient correction.

Alan

On 2017-03-10, Alan Isaac wrote:
> Output for the first line of Test Table 1 is OK,
> if the last line is deleted.
> The last is not OK (because of the commas).

Yes, you need to have valid rST in every field. 
The last line contains 4 fields (because of the commas).

How about setting a different deliminator?
(See docs/ref/rst/directives.html#id4)


> It *is* possible to put the expressions in quotes.
> BUT:

> Output for the first line of Test Table 2 is OK,
> if the last line is deleted.
> The last is not OK (because of the space before the comma).

Yes, because you cannot put only a part of the expression in quotes and
whitespace is not stripped.

BUT, you can simply ensure that there is no whitespace between " and the
deliminator.


Test CSV Tables

.. csv-table:: Test Table 1
    :delim: ;
    :header: code; math

    :code:`int`        ; :math:`33`
    :code:`(int,int)`  ; :math:`(33,33)`

.. csv-table:: Test Table 2
    :header: hthis, hthat

    "test","this","that"
    "test","this","that"


Günter

Output for the first line of Test Table 1 is OK,
if the last line is deleted.
The last is not OK (because of the commas).

It *is* possible to put the expressions in quotes.
BUT:

Output for the first line of Test Table 2 is OK,
if the last line is deleted.
The last is not OK (because of the space before the comma).

Cheers,
Alan Isaac

Test CSV Tables
----------------

.. csv-table:: Test Table 1
    :header: code, math

    :code:`int`        , :math:`33`
    :code:`(int,int)`  , :math:`(33,33)`

.. csv-table:: Test Table 2
    :header: hthis, hthat

    "test","this","that"
    "test","this" , "that"

On 2017-03-01, 11:04 GMT, Guenter Milde wrote:
> You found a bug. The html5 writer used the wrong config 
> section. (I missed this during the renaming from html-plain.)
>
> This is fixed now (Revision 8041).

Perfect, builds in Fedora 25 with testsuite running
https://koji.fedoraproject.org/koji/taskinfo?taskID=18150497

Best,

Matěj

-- 
https://matej.ceplovi.cz/blog/, Jabber: mc...@ce...
GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8
 
Besides, the determined Real Programmer can write Fortran
programs in any language.
      -- Ed Post, Real Programmers Don't Use Pascal

On 2017-02-28, Matěj Cepl wrote:
> Using “rst2html5 (Docutils 0.13.1 [release], Python 2.7.13, on 
> linux2)” and this docutils.conf in the directory with my *.rst 
> file:

...
> [html5 writer]
...

> I get no stylesheet or template used. However, when I run 

>     $ rst2html5 --template=layout.tpl \
>         --stylesheet-path=minimal.css,plain.css,mystyle.css \
>         source.rst >output.html

> both template and stylesheets are used.

> What’s the difference?

You found a bug. The html5 writer used the wrong config section. (I missed
this during the renaming from html-plain.)

This is fixed now (Revision 8041).

Thank you for reporting and sorry for the inconvenience,

Günter