docutils-users — General discussions, questions, help requests.

Re: [Docutils-users] Visible comments?

[Guenter M. <mi...@us...>]

On 2017-04-28, Matěj Cepl wrote:
> On 2017-04-28, 00:02 GMT, David Goodger wrote:
>> There is no way currently.

>> There is a --leave-comments option will transform reST comments into
>><!-- HTML/XML comments -->. They won't show up in the output, but a
>> simple text substitution (after Docutils processing) could transform
>> them into something visible.

> I have already created 
> https://mcepl.fedorapeople.org/tmp/comments.js , but I hoped 
> there could be some better solution.

You could create a custom role "notes", say and "style it away" with CSS in
the final version.

Thre are no "rst-level" custom directives. If the comments/notes shall be
block-level elements, you might consider (ab)using an existing directive
that is not used otherwise in the document.
(There is even a "note" directive.)

With the new (development and upcoming 0.14) version, you can also style
(some) block-level elements in LaTeX.

Günter

Re: [Docutils-users] Visible comments?

[Matěj C. <mc...@ce...>]

On 2017-04-28, 00:02 GMT, David Goodger wrote:
> There is no way currently.
>
> There is a --leave-comments option will transform reST comments into
><!-- HTML/XML comments -->. They won't show up in the output, but a
> simple text substitution (after Docutils processing) could transform
> them into something visible.

I have already created 
https://mcepl.fedorapeople.org/tmp/comments.js , but I hoped 
there could be some better solution.

Matěj

-- 
https://matej.ceplovi.cz/blog/, Jabber: mc...@ce...
GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8
 
Of course I'm respectable. I'm old. Politicians, ugly buildings,
and whores all get respectable if they last long enough.
      --John Huston in "Chinatown."

[Docutils-users] Custom admonitions in rst2latex

[Sébastien D. <seb...@ch...>]

Hello,

I want to configure a user defined admonition with rst2latex.

Suppose I have this block in the rst document :

> .. admonition:: test
> 
>   This is a test


rst2latex transform this text into :

> \DUadmonition[admonition-test]{
> \DUtitle[admonition-test]{test}
> 
> This is a test
> }

Now I want to apply a custom style to this block, as described in « 
Generating latex with docutils » [1], but I cannot create a command 
named :

> \newcommand{\DUadmonitionadmonition-test}[1]{…}}

Latex does not allow to create a command with a « - »

You told me that the latex writer as been rewritten in the last docutils 
version. Is the problem still present ?

[1] http://docutils.sourceforge.net/docs/user/latex.html#admonitions

Thanks a lot !

-- 
Sébastien

Re: [Docutils-users] Visible comments?

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

On Thu, Apr 27, 2017 at 5:56 PM, Matěj Cepl <mc...@ce...> wrote:
> Hi,
>
> is there a way (perhaps rst2html5 option) to render comments
> visible? I would like to send a draft of my text as HTML5 (or
> PDF via rst2xetex) to somebody for review, and then my current
> comments may be useful for better understanding of context and
> what stands behind my text.
>
> Any ideas?

There is no way currently.

There is a --leave-comments option will transform reST comments into
<!-- HTML/XML comments -->. They won't show up in the output, but a
simple text substitution (after Docutils processing) could transform
them into something visible.

It would be straightforward to write a transform that converts
comments into some other form, like a "comment"-class admonition or
something.

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

[Docutils-users] Visible comments?

[Matěj C. <mc...@ce...>]

Hi,

is there a way (perhaps rst2html5 option) to render comments 
visible? I would like to send a draft of my text as HTML5 (or 
PDF via rst2xetex) to somebody for review, and then my current 
comments may be useful for better understanding of context and 
what stands behind my text.

Any ideas?

Matěj

-- 
https://matej.ceplovi.cz/blog/, Jabber: mc...@ce...
GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8
 
Of course I'm respectable. I'm old. Politicians, ugly buildings,
and whores all get respectable if they last long enough.
      --John Huston in "Chinatown."

[Docutils-users] EPub?

[Matěj C. <mc...@ce...>]

How do people here generate EPub archives from their rST? I see 
on http://docutils.sourceforge.net/docs/user/links.html#epub the 
following three options, but I am not happy with either:

1. pandoc — I just do not like HTML it produces, it does not 
   support some rST constructs I want to use (..include) and it 
   cannot work with some other tools for rST.

2. rst2epub from https://bitbucket.org/wierob/rst2epub — the 
   last commit from 2013-05-12 and it shows. Seems to break on 
   non-ASCII titles (I am Czech, so it is point of no way for 
   me), and of course it does not seem to support ..include.

3. rst2epub2 from https://github.com/mattharrison/rst2epub2 
   — last commit 2016-05-06 and that was mine pull request ;).  
   Again, it does not seem to work with non-ASCII titles, it 
   requires some weird virtualenv, and I was not able to make it 
   working at all.

4. sphinx — I would prefer plain docutils simple HTML (or 
   HTML5), sphinx seems to do too much for me to like it 
   (specific stylesheets etc.), also it requires fixed structure 
   of source files (or it is too complicated to persuade it).

Which gets me back to my original thought: why isn’t some 
rst2epub script part of docutils themselves? From looking to 
pages like 
https://www.thoughtco.com/create-epub-file-from-html-and-xml-3467282 
, https://www.ibm.com/developerworks/xml/tutorials/x-epubtut/index.html 
, or http://www.idpf.org/epub/301/spec/epub-contentdocs.html it 
doesn’t seem to be THAT complicated. Although, do we have 
support for generating XHTML?

Isn’t whole generating epub just stiching together HTML (which 
we know how to generate, hopefully) with some metadata (which we 
already have for generating ToC etc.)?

Best,

Matěj

-- 
https://matej.ceplovi.cz/blog/, Jabber: mc...@ce...
GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8
 
Of course I'm respectable. I'm old. Politicians, ugly buildings,
and whores all get respectable if they last long enough.
      --John Huston in "Chinatown."

Re: [Docutils-users] Question about restructured text tables

[Guenter M. <mi...@us...>]

On 2017-04-19, Suzanne Hillman wrote:

...

> I'm trying to figure out the best way to create basically a thumbnail grid
> using restructured text. My website is mostly in restructured text at this
> point, and I'd rather not have to make one of my pages plain HTML (or use
> the raw html directive).

> I took a look at the two ways to create tables (here:
> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#tables),
> and as far as I can tell, there is no way to tell restructured text that it
> doesn't need to be as wide as the widest text within it.

The `table directive`__ may be your friend.
Ther you can specify the column widths and (with a current Docutils) also
set the column width to "auto" (let the backend decide).

For your use case, also the `list table`__ may be an option.

Günter

__ http://docutils.sourceforge.net/docs/ref/rst/directives.html#table
__ http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table

[Docutils-users] Question about restructured text tables

[Suzanne H. <wi...@gm...>]

Hi everyone,

I'm not subscribed to this list, so please cc me?

I'm trying to figure out the best way to create basically a thumbnail grid
using restructured text. My website is mostly in restructured text at this
point, and I'd rather not have to make one of my pages plain HTML (or use
the raw html directive).

I took a look at the two ways to create tables (here:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#tables),
and as far as I can tell, there is no way to tell restructured text that it
doesn't need to be as wide as the widest text within it. Given that I've
got figure directives within the cells of the table, even with careful
multi-line things, individual columns are really wide and cumbersome.

If curious, the top-most bit on this page is what I'm working on (with only
the first column filled in):
https://suzannehillman.com/pages/design-artifacts.html

If my question is unclear, please let me know?

Thanks,

Suzanne

Re: [Docutils-users] Class parameter is not effective in code directive (rst2latex)

[Sébastien D. <seb...@ch...>]

Le 2017-04-19 13:06, Guenter Milde a écrit :

> 
> Yes, up to Docutils 0.13.1, class values for (almost all) block-level
> elements are ignored by the latex writer.
> 
> In the development version (and upcoming release 0.14) the latex writer
> will support class values for most block level elements:
> 
>   - Handle class arguments for block-level elements by wrapping them
>     in a "DUclass" environment. This replaces the special handling for
>     "epigraph" and "topic" elements.
> 

This is a good news ! Do you have an idea for the 0.14 release date ?

> 
> Customization is done by defining matching macros or environments.
> For details, see the latex writer documention docs/usre/latex.txt
> in the SVN repo.
> 
> 
> PS: Please don't cross-post, both lists are read by the developers.
> 

Thanks. I've cross-post the message because I've took a look in the code 
and found a simple patch which solve my problem.

Regards,

-- 
Sébastien

Re: [Docutils-users] Class parameter is not effective in code directive (rst2latex)

[Guenter M. <mi...@us...>]

On 2017-04-19, Sébastien Dailly wrote:
> Hello,

> I'm stuck with rst2latex : I want to customize the code-block rendering 
> with a dark background. rst2latex translate this directive to a quote 
> environnment which I can't override because it is already used elsewhere 
> in the document.

> I've tried to add a class parameter to the directive


>>   .. code-block:: C
>>     :class: darkBackground

>>     // Comment


> But this does not seems to work (the class parameter is discarded)

Yes, up to Docutils 0.13.1, class values for (almost all) block-level
elements are ignored by the latex writer.

In the development version (and upcoming release 0.14) the latex writer
will support class values for most block level elements:

  - Handle class arguments for block-level elements by wrapping them
    in a "DUclass" environment. This replaces the special handling for
    "epigraph" and "topic" elements.

your example input will then be converted to::

  \begin{DUclass}{code}
  \begin{DUclass}{C}
  \begin{DUclass}{darkbackground}
  \begin{quote}
  {\ttfamily \raggedright \noindent
  \DUrole{comment}{\DUrole{single}{//~Comment}}
  }
  \end{quote}
  \end{DUclass}
  \end{DUclass}
  \end{DUclass}


Customization is done by defining matching macros or environments.
For details, see the latex writer documention docs/usre/latex.txt
in the SVN repo.



> I've also tried to wrap the code directive inside a class one :

>> .. class:: darkBackground

>>   .. code-block:: C

>>     // Comment

> But this does not give the expected result.

Yes, this is converted to the same doctree (check with rst2xml or
rst2pseudoxml).


> Is this a known bug ? 

It is a known limitation (per specification, Docutils writers are free to
ingore class values).

It is solved in the development version.
http://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/


Günter 


PS: Please don't cross-post, both lists are read by the developers.

Re: [Docutils-users] Class parameter is not effective in code directive (rst2latex)

[Sébastien D. <seb...@ch...>]

Le 2017-04-19 09:36, Sébastien Dailly a écrit :
> Hello,
> 
> I'm stuck with rst2latex : I want to customize the code-block rendering
> with a dark background. rst2latex translate this directive to a quote
> environnment which I can't override because it is already used 
> elsewhere
> in the document.
> 
> I've tried to add a class parameter to the directive
> 
>> 
>>   .. code-block:: C
>>     :class: darkBackground
>> 
>>     // Comment
>> 
> 
> But this does not seems to work (the class parameter is discarded)
> 
>> \begin{quote}
>> {\ttfamily \raggedright \noindent
>> \DUrole{comment}{\DUrole{single}{//~Comment\\
>> }}~\\
> 
> I've also tried to wrap the code directive inside a class one :
> 
>> .. class:: darkBackground
>> 
>>   .. code-block:: C
>> 
>>     // Comment
> 
> But this does not give the expected result.
> 
> This seems to be a problem with the writer, because rst2html gives the
> class in the output :
> 
>> <pre class="code C darkBackground literal-block">
>>  <span class="comment single">// Comment
> 
> Is this a known bug ? Is there a workaround for this ?
> 
> Thanks a lot !


I've found a solution by editing the writer :

> $ diff -c5 __init__.py /cygdrive/t/__init__.py
> *** __init__.py 2017-04-19 10:33:56.977196800 +0200
> --- /cygdrive/t/__init__.py     2017-04-19 10:33:51.485961600 +0200
> ***************
> *** 2450,2459 ****
> --- 2450,2461 ----
>                       'lstlisting': r'\usepackage{listings}',
>                       'Verbatim': r'\usepackage{fancyvrb}',
>                       # 'verbatim': '',
>                       'verbatimtab': r'\usepackage{moreverb}'}
> 
> +         if node['classes']:
> +             self.visit_inline(node)
>           if node.get('ids'):
>               self.out += ['\n'] + self.ids_to_labels(node)
> 
>           if not self.active_table.is_open():
>               # no quote inside tables, to avoid vertical space between
> ***************
> *** 2493,2502 ****
> --- 2495,2506 ----
>           self.literal = False
>           self.verbatim = False
>           self.alltt = False
>           self.out.append(self.context.pop())
>           self.out.append(self.context.pop())
> +         if node['classes']:
> +             self.depart_inline(node)
> 
>       ## def visit_meta(self, node):
>       ##     self.out.append('[visit_meta]\n')
>           # TODO: set keywords for pdf?
>           # But:

It seems to be a bug in the writer (I'm ccing docutils-develop). I have 
no idea if this change can break other construction… Can you check if 
this change can be integrated in the project ?

Thanks !

-- 
Sébastien

[Docutils-users] Class parameter is not effective in code directive (rst2latex)

[Sébastien D. <seb...@ch...>]

Hello,

I'm stuck with rst2latex : I want to customize the code-block rendering 
with a dark background. rst2latex translate this directive to a quote 
environnment which I can't override because it is already used elsewhere 
in the document.

I've tried to add a class parameter to the directive

> 
>   .. code-block:: C
>     :class: darkBackground
> 
>     // Comment
> 

But this does not seems to work (the class parameter is discarded)

> \begin{quote}
> {\ttfamily \raggedright \noindent
> \DUrole{comment}{\DUrole{single}{//~Comment\\
> }}~\\

I've also tried to wrap the code directive inside a class one :

> .. class:: darkBackground
> 
>   .. code-block:: C
> 
>     // Comment

But this does not give the expected result.

This seems to be a problem with the writer, because rst2html gives the 
class in the output :

> <pre class="code C darkBackground literal-block">
>  <span class="comment single">// Comment

Is this a known bug ? Is there a workaround for this ?

Thanks a lot !

-- 
Sébastien

Re: [Docutils-users] Weirdly generated C code

[Matej C. <mc...@ce...>]

On 10/04/17 18:52, David Goodger wrote:
> You wrote to the wrong list.

Damn! Too many lists. I am sorry.

Matěj

-- 
https://matej.ceplovi.cz/blog/, Jabber: mc...@ce...
GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8

Of course I'm respectable. I'm old. Politicians, ugly buildings,
and whores all get respectable if they last long enough.
      --John Huston in "Chinatown."

Re: [Docutils-users] Weirdly generated C code

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

You wrote to the wrong list.

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


On Mon, Apr 10, 2017 at 11:25 AM, Matěj Cepl <mc...@ce...> wrote:
> Hi,
>
> when trying to build M2Crypto with swig 3.0.12 and gcc 7.0.1
> 20170327 on Fedora/Rawhide. Swig generates this C file
> (plain C, not C++)
> https://mcepl.fedorapeople.org/tmp/_m2crypto_wrap.c.bz2
>
> and when I try to build it with GCC I get the following errors
> (the full log is at
> https://mcepl.fedorapeople.org/tmp/python-clean-build-log.txt ).
>
> Any ideas how to make it working? Another problem is that
> I would need a solution which works from swig 2.0.10 upwards as
> M2Crypto should be able to be build and maintained on RHEL-7 as
> well. Any help?
>
> Best,
>
> Matěj
>
> --
> https://matej.ceplovi.cz/blog/, Jabber: mc...@ce...
> GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8
>
> Of course I'm respectable. I'm old. Politicians, ugly buildings,
> and whores all get respectable if they last long enough.
>        --John Huston in "Chinatown."
>
> ====================================================================
> SWIG/_m2crypto_wrap.c: In function ‘init_m2crypto’:
> SWIG/_m2crypto_wrap.c:33295:79: warning: implicit declaration of function ‘SWIG_From_wchar_t’; did you mean ‘SWIG_FromCharPtr’? [-Wimplicit-function-declaration]
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
>                                                                                 ^~~~~~~~~~~~~~~~~
>                                                                                 SWIG_FromCharPtr
> SWIG/_m2crypto_wrap.c:33295:120: error: stray ‘\’ in program
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
>                                                                                                                          ^
> SWIG/_m2crypto_wrap.c:33295:121: warning: missing terminating ' character
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
>                                                                                                                           ^
> SWIG/_m2crypto_wrap.c:33295:121: error: missing terminating ' character
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
>                                                                                                                           ^~~~~~~~~~~
> SWIG/_m2crypto_wrap.c:33295:119: error: ‘L’ undeclared (first use in this function)
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
>                                                                                                                         ^
> SWIG/_m2crypto_wrap.c:33295:119: note: each undeclared identifier is reported only once for each function it appears in
> SWIG/_m2crypto_wrap.c:33296:3: error: expected ‘)’ before ‘SWIG_Python_SetConstant’
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MIN",SWIG_From_int((int)((-(0x7fffffff+L'\0') -1))));
>     ^~~~~~~~~~~~~~~~~~~~~~~
> SWIG/_m2crypto_wrap.c:33345:118: error: stray ‘\’ in program
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
>                                                                                                                        ^
> SWIG/_m2crypto_wrap.c:33345:119: warning: missing terminating ' character
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
>                                                                                                                         ^
> SWIG/_m2crypto_wrap.c:33345:119: error: missing terminating ' character
>     SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
>                                                                                                                         ^~~~~~~~~~~
> SWIG/_m2crypto_wrap.c:33678:1: error: expected declaration or statement at end of input
>   }
>
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Docutils-users mailing list
> Doc...@li...
> https://lists.sourceforge.net/lists/listinfo/docutils-users
>
> Please use "Reply All" to reply to the list.
>

[Docutils-users] Weirdly generated C code

[Matěj C. <mc...@ce...>]

Hi,

when trying to build M2Crypto with swig 3.0.12 and gcc 7.0.1 
20170327 on Fedora/Rawhide. Swig generates this C file
(plain C, not C++) 
https://mcepl.fedorapeople.org/tmp/_m2crypto_wrap.c.bz2

and when I try to build it with GCC I get the following errors 
(the full log is at 
https://mcepl.fedorapeople.org/tmp/python-clean-build-log.txt ).

Any ideas how to make it working? Another problem is that 
I would need a solution which works from swig 2.0.10 upwards as 
M2Crypto should be able to be build and maintained on RHEL-7 as 
well. Any help?

Best,

Matěj

-- 
https://matej.ceplovi.cz/blog/, Jabber: mc...@ce...
GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8
  
Of course I'm respectable. I'm old. Politicians, ugly buildings,
and whores all get respectable if they last long enough.
       --John Huston in "Chinatown."

====================================================================
SWIG/_m2crypto_wrap.c: In function ‘init_m2crypto’:
SWIG/_m2crypto_wrap.c:33295:79: warning: implicit declaration of function ‘SWIG_From_wchar_t’; did you mean ‘SWIG_FromCharPtr’? [-Wimplicit-function-declaration]
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
                                                                                ^~~~~~~~~~~~~~~~~
                                                                                SWIG_FromCharPtr
SWIG/_m2crypto_wrap.c:33295:120: error: stray ‘\’ in program
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
                                                                                                                         ^
SWIG/_m2crypto_wrap.c:33295:121: warning: missing terminating ' character
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
                                                                                                                          ^
SWIG/_m2crypto_wrap.c:33295:121: error: missing terminating ' character
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
                                                                                                                          ^~~~~~~~~~~
SWIG/_m2crypto_wrap.c:33295:119: error: ‘L’ undeclared (first use in this function)
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
                                                                                                                        ^
SWIG/_m2crypto_wrap.c:33295:119: note: each undeclared identifier is reported only once for each function it appears in
SWIG/_m2crypto_wrap.c:33296:3: error: expected ‘)’ before ‘SWIG_Python_SetConstant’
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "__WCHAR_MIN",SWIG_From_int((int)((-(0x7fffffff+L'\0') -1))));
    ^~~~~~~~~~~~~~~~~~~~~~~
SWIG/_m2crypto_wrap.c:33345:118: error: stray ‘\’ in program
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
                                                                                                                       ^
SWIG/_m2crypto_wrap.c:33345:119: warning: missing terminating ' character
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
                                                                                                                        ^
SWIG/_m2crypto_wrap.c:33345:119: error: missing terminating ' character
    SWIG_Python_SetConstant(d, d == md ? public_interface : NULL, "WCHAR_MAX",SWIG_From_wchar_t((wchar_t)((0x7fffffff+L\'\\0\'))));
                                                                                                                        ^~~~~~~~~~~
SWIG/_m2crypto_wrap.c:33678:1: error: expected declaration or statement at end of input
  }

[Docutils-users] Hint with internal link in reStructuredtext

[Henning S. <bra...@ya...>]

 Hello, could you please help me with a hint how to make a link from the text Table 1: on line 5, to the text on line 18 below the table beginning: This is the simple...
Later on I intend to have text marking the link in a colour and italic as well as the text under the table too, if that is possible.(?)


Simple Table 1:
=====  =====  ====== 
   Inputs     Output 
------------  ------ 
  A      B    A or B 
=====  =====  ====== 
False  False  False 
True   False  True 
False  True   True 
True   True   True 
=====  =====  ======
This is the simple Table 1 text


Kindest regards
Yours sincerely
Henning Sundstedt

Re: [Docutils-users] Custom Admonitions?

[Tim D. <tu...@tu...>]

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.

Re: [Docutils-users] Custom Admonitions?

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

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>

[Docutils-users] Custom Admonitions?

[Tim D. <tu...@tu...>]

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?

[Docutils-users] new latex-writer class handling - please test

[Guenter M. <mi...@us...>]

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

Re: [Docutils-users] CSV table problems

[Alan I. <ala...@gm...>]

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

Re: [Docutils-users] CSV table problems

[Guenter M. <mi...@us...>]

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

[Docutils-users] CSV table problems

[Alan I. <ala...@gm...>]

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"

Re: [Docutils-users] docutils.conf and rst2html5

[Matěj C. <mc...@ce...>]

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

Re: [Docutils-users] docutils.conf and rst2html5

[Guenter M. <mi...@us...>]

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