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

Re: [Docutils-users] Replace bug

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

On 17 April 2018 at 16:05,  <mic...@gm...> wrote:
> The following fails:
>
> replace_bug.rst:
>
>     |Bug|_
>
>     .. |Bug| replace::
>         A. Bug: the initial causes problems.
>     .. _Bug:
>
>
> Failure:
>
>     $ rst2html.py --version
>     rst2html.py (Docutils 0.14, Python 2.7.13, on darwin)
>
>     $ rst2html.py replace_bug.rst > replace_bug.html
>     replace_bug.rst:3: (ERROR/3) Error in "replace" directive: may contain a single paragraph only.
>     replace_bug.rst:3: (WARNING/2) Substitution definition "Bug" empty or invalid.
>
>     .. |Bug| replace::
>              A. Bug: the initial causes problems.
>     replace_bug.rst:1: (ERROR/3) Undefined substitution referenced: "Bug".

This is expected behavior. Try processing just the content of the
replace directive (without the directive itself) to see why this
happens.

> This was based on the replacement example from the documentation:
>
>
> |Python|_
>
> .. |Python| replace::
>          Python: A great language!
> .. _Python:
>
> A workaround is to escape the space *and* include an additional space, but this is very ugly.  Is there a better solution?

Yes. A single backslash-escape will do, to prevent the "A." from being
parsed as a list item::

    |Bug|_

    .. |Bug| replace::
        \A. Bug: the initial causes problems.
    .. _Bug:

> Am I misreading the documentation/misusing replacements or should I file a bug report?

I don't know if you're misusing replacements; depends on what you're
trying to do. Not a bug AFAIC. Do you understand why?

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

[Docutils-users] Replace bug

[<mic...@gm...>]

The following fails:

replace_bug.rst:

    |Bug|_
    
    .. |Bug| replace::
        A. Bug: the initial causes problems.
    .. _Bug: 


Failure:

    $ rst2html.py --version
    rst2html.py (Docutils 0.14, Python 2.7.13, on darwin)
    
    $ rst2html.py replace_bug.rst > replace_bug.html
    replace_bug.rst:3: (ERROR/3) Error in "replace" directive: may contain a single paragraph only.
    replace_bug.rst:3: (WARNING/2) Substitution definition "Bug" empty or invalid.
    
    .. |Bug| replace::
             A. Bug: the initial causes problems.
    replace_bug.rst:1: (ERROR/3) Undefined substitution referenced: "Bug".


This was based on the replacement example from the documentation:

			
|Python|_ 

.. |Python| replace::
	 Python: A great language!
.. _Python:

A workaround is to escape the space *and* include an additional space, but this is very ugly.  Is there a better solution?

|Workaround|_

 .. |Workaround| replace::
	 A.\  Bug: the initial causes problems.

.. _Workaround:

Am I misreading the documentation/misusing replacements or should I file a bug report?

Re: [Docutils-users] How to create and reference custom heading ids with reStructuredText?

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

On 2018-02-20, Alan Isaac wrote:
> On 2/18/2018 4:45 PM, Guenter Milde via Docutils-users wrote:
>> The separate div is the HTML4-compatible representation of the section
>> element (with the HTML5 writer this will eventually become a <section>
>> element, too).

> Yea! (Although by "too" I hope you mean "instead".)

No, I mean "too": the "section" node should be represented by a <section>
element not only in Docutils-XML but also in HTML5.

> Please announce when you do this.

Currently, I stopped working on Docutils while waiting for the green light
to commit the fixes to keep info about escape characters in the doctree.

Günter

Re: [Docutils-users] How to create and reference custom heading ids with reStructuredText?

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

On 2/18/2018 4:45 PM, Guenter Milde via Docutils-users wrote:
> The separate div is the HTML4-compatible representation of the section
> element (with the HTML5 writer this will eventually become a <section>
> element, too).

Yea! (Although by "too" I hope you mean "instead".)
Please announce when you do this.
Cheers,
Alan

Re: [Docutils-users] many-character option list

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

On Tue, Feb 27, 2018 at 11:53 AM, Gary Mamon <ga...@ia...> wrote:
> * How can I make a many-character non-POSIX (i.e. single dash signs) option
> list, i.e.
>
> -data file # data filename
>
> OR
>
> -data file -> data filename

You cannot, per the reStructuredText Markup Specification:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists

The 4 types of option markup allowed are:

* Short POSIX
* Long POSIX
* Old GNU-style "plus"
* DOS/VMS "slash"

> where the first data is highlighted as a literal, the “file” is highlighted
> as emphasis (italics), and the tabulation between “file” and “#” or “->” is
> a real tab so that subsequent lines are vertically aligned?

Note: tabs are not used. Tables or other markup are used.

> Using standard option lists doesn’t work:
> 1) multiple-character options have their first letter in literal and the
> next ones in emphasis, which is weird.

Not weird once you understand what's going on. A line like:

    -option    description

is simply interpreted as the short POSIX option "-o" followed by the
argument "ption" and a description.

Trying to mix single-dash long options with short options is ambiguous
at best, and not supported by reStructuredText.

> 2) some lines with arguments fail to process correctly.

See the spec for correct syntax. Non-POSIX styles are not supported though.

> * As an alternative, I could enclose all lines in a literal block. But then,
> how can I place emphasis on some of the words within the literal block?

You could use a parsed literal block:
http://docutils.sourceforge.net/docs/ref/rst/directives.html#parsed-literal-block

> * A 3rd possibility is do the mark-up word by word. But then, how can I
> insert tabs to enforce vertical alignment?

Again, there are no tabs. You could use a table.

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

[Docutils-users] many-character option list

[Gary M. <ga...@ia...>]

* How can I make a many-character non-POSIX (i.e. single dash signs) option list, i.e.

-data file	# data filename

OR

-data file	-> data filename

where the first data is highlighted as a literal, the “file” is highlighted as emphasis (italics), and the tabulation between “file” and “#” or “->” is a real tab so that subsequent lines are vertically aligned?

Using standard option lists doesn’t work: 
1) multiple-character options have their first letter in literal and the next ones in emphasis, which is weird. 
2) some lines with arguments fail to process correctly.

* As an alternative, I could enclose all lines in a literal block. But then, how can I place emphasis on some of the words within the literal block?

* A 3rd possibility is do the mark-up word by word. But then, how can I insert tabs to enforce vertical alignment?

	thanks in advance

	Gary Mamon

Re: [Docutils-users] How to create and reference custom heading ids with reStructuredText?

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

On 2018-02-14, Ciro Santilli wrote:

> Please CC.

This doesn't work with slrn via GMANE, sorry.

> Cross post:
> https://stackoverflow.com/questions/48759542/how-to-create-and-reference-custom-heading-ids-with-restructuredtext

> Currently, if I have:

>     My header
>     =========

>     `My header`_
 
> `rst2html` Docutils 0.14 produces:

>     <div class="document" id="my-header">
>     <h1 class="title">My header</h1>

>     <p><a class="reference internal" href="#my-header">My header</a></p>

> Is it possible to obtain the following ouptut instead:

>     <h1 class="title" id="my-custom-header">My header</h1>

>     <p><a class="reference internal" href="#my-custom-header">My
> header</a></p>

Not easily, but see below.

> So note how I want two changes:

> - the id to be inside the heading, not on a separate div

The separate div is the HTML4-compatible representation of the section
element (with the HTML5 writer this will eventually become a <section>
element, too). With Docutils, the id is given to the <section>, not the
section's <title>.

> - control over the actual id

In Docutils, an element can have multiple ids but for the HTML
representation these need to be put on separate elements.
The current mechanism works for most practical purposes -- you may create a
custom HTML writer or propose a patch (and good resons for a change) to have
the custom id replacing the auto-generated one.

> The closest I could get was:

>     <div class="document" id="my-header">
>     <span id="my-custom-header"></span>
>     <h1 class="title">My header</h1>

>     <p><a class="reference external" href="my-custom-header">My
> header</a></p>

> but this is still not ideal, as I now have multiple ids floating around,
> and not inside the `h1`.

> Asciidoc for example has that covered with:

>     [[my-custom-header]]
>     == My header

>     <<my-custom-header>>

Well, the input is quite similar to the rST you probably used to get the
"close version"::


    .. _my custom header:
    
    My header
    =========
  
    `my custom header`_

This is translated to the internal representation::

  <document source="/tmp/foo.rst">
      <target refid="my-custom-header"></target>
      <section ids="my-header my-custom-header" 
               names="my\ header my\ custom\ header">
          <title>My header</title>
          <paragraph><reference name="my custom header"
                                refid="my-custom-header">my custom
                     header</reference></paragraph>
      </section>
  </document>

So everything is there to get the desired HTML output via a custom writer.
But is it worth the effort?


Günter

   

[Docutils-users] How to create and reference custom heading ids with reStructuredText?

[Ciro S. <cir...@gm...>]

Please CC.

Cross post:
https://stackoverflow.com/questions/48759542/how-to-create-and-reference-custom-heading-ids-with-restructuredtext

Currently, if I have:

    My header
    =========

    `My header`_

`rst2html` Docutils 0.14 produces:

    <div class="document" id="my-header">
    <h1 class="title">My header</h1>

    <p><a class="reference internal" href="#my-header">My header</a></p>

Is it possible to obtain the following ouptut instead:

    <h1 class="title" id="my-custom-header">My header</h1>

    <p><a class="reference internal" href="#my-custom-header">My
header</a></p>

So note how I want two changes:

- the id to be inside the heading, not on a separate div
- control over the actual id

The closest I could get was:

    <div class="document" id="my-header">
    <span id="my-custom-header"></span>
    <h1 class="title">My header</h1>

    <p><a class="reference external" href="my-custom-header">My
header</a></p>

but this is still not ideal, as I now have multiple ids floating around,
and not inside the `h1`.

Asciidoc for example has that covered with:

    [[my-custom-header]]
    == My header

    <<my-custom-header>>

Re: [Docutils-users] citation syntax

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

On 2018-01-12, Alan Isaac wrote:
> Might it be possible to consider supporting an extension
> to the citation syntax?

I cannot tell how simple or difficult this becomes but I'd rather
concentrate on an integrated `Footnote & Citation Gathering`__.
Would you like to cooperate on this?

__ http://docutils.sourceforge.net/docs/dev/todo.html#unimplemented-transforms

Meanwhile I tried to turn your example into an MWE and think about a
temporary workaround.

Thanks Günter


At the moment, I find myself often supporting anonymous links to
citations like `Isaac and Jass (2011)`__.

The reason is that the standard citation reference must occur in the
document if we are to extract the references for processing into
a citation list (e.g., with bibstuff).

__ isaac-2011-jasss_
.. [isaac-2011-jasss]_


__ http://docutils.sourceforge.net/docs/dev/todo.html#unimplemented-transforms

An alternative workaround would be to use aliases like `Milde and Monecke (1989)
<ref:the_bib_key_>`__. A reference manager (extended bibstuff, say) would
need to scan for `ref: ...` links and insert the citation target.

The references section would be inserted by the reference manager

References
==========

.. [isaac-2011-jasss] fist example reference, 2011.
.. _`ref:the_bib_key`:
.. [mm89] second example reference, 1989.

[Docutils-users] citation syntax

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

Might it be possible to consider supporting an extension
to the citation syntax?  At the moment, I find myself
often supporting anonymous links to citations by e.g.

   __ isaac-2011-jasss_
   .. [isaac-2011-jasss]_

The reason is that the standard citation reference must occur in the
document if we are to extract the references for processing into
a citation list (e.g., with bibstuff).  It would be nice if we
could just write

   __ [isaac-2011-jasss]_

Would allowing the identifier of indirect links to be in brackets
break things?

Thanks for considering,
Alan Isaac

Re: [Docutils-users] Slide Presentations In RestructuredText?

[Gour <go...@at...>]

On Sat, 16 Aug 2014 11:41:38 +0200
Valentin Haenel <val...@gm...> wrote:

It's an old thread, but the question is really the same, iow. what would you
recommend **today** to create slide-show presentations by using rst markup, preferrably
PDF-based so that I can use e.g. pdfpc (https://pdfpc.github.io/) to easily
incorporate speaker notes.

> I do have my own fork on github and use a custom template, but
> wouldn't recommend it actually.

What about this one: https://github.com/myint/rst2beamer ?

> And lastly -- this is my favorite option right now -- you can use
> pandoc to make beamer slides from RST:

Hmm, I thought that e.g. it's not possible to do:

rst –> beamer 

with pandoc?

I have also found the following projects:

- hieroglyph: https://github.com/nyergler/hieroglyph and

- rst2html5:https://github.com/marianoguerra/rst2html5

but both projects create HTML/JS-powered presentations, while I'd prefer PDF
although I abandoned idea to learn & use ConTeXt.

Any recent experience?


Sincerely,
Gour

-- 
For him who has conquered the mind, the mind is the best of
friends; but for one who has failed to do so, his mind will
remain the greatest enemy.

Re: [Docutils-users] ISBN URL?

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

On 2017-12-22, Matěj Cepl wrote:
> On 2017-05-11, 21:30 GMT, Guenter Milde wrote:
>> Unfortunately, this does not help in praxi, as

>>   Your browser would have to have a "resolver" installed for ISBN numbers
>>   that would find a URL for the resource. As far as I know, no browsers
>>   have taken a stab at implementing resolvers as called for by the RFC.
>>   –- Stephen Ostermiller Feb 24 at 8:57 

> So, to translate your post into English: there is nothing to 
> help you. Right?

To rephrase my answer:

  While Docutils already supports isbn URLs in the rst source (e.g. `The
  Four Loves <urn:isbn:0156329301>`__), this will most likely not work
  with current browsers which lack support for RFC 2187 and just return an
  error when told to go to "urn:isbn:0156329301".
  
Taking in account the current state of browser (non)support, I can imagine
a transform mapping ISBN URLs to a configurable HTML URL like ::

  'https://en.wikipedia.org/wiki/Special:BookSources?isbn=%s' % isbn_no
  
Patches welcome.

Günter

Re: [Docutils-users] unintentional print?

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

Dear Alan,

thank you for reporting. This is fixed now in the SVN repo.

On 2018-01-03, Alan Isaac wrote:
> I'm guessing that 2to3 conversion is used to support Python 3,

Yes, this is still required. (For fast install, we provide pre-converted
"wheels" on pypi.)

> but somehow I recently managed to choke on:

> File "docutils\utils\math\tex2mathml_extern.py", line 130
>      print err

> Although this could be "fixed" with parentheses, but
> I'm guessing the very existence of this line is an oversight.

> Cheers,
> Alan Isaac

> PS While looking, I noticed old style exception syntax in use.
> I assume this is intentional (i.e., let the converter handle it)
> and that you know Python 2's

>      except IOError, err:

> could be written without any need for 2to3 conversion as

>      except IOError:
>          err = sys.exc_info()[1]

Actually, since we dropped support for Python < 2.6 we can now also use the
simpler

   except IOError as err:
   
and other python-3-save constructs.

Günter   

[Docutils-users] unintentional print?

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

I'm guessing that 2to3 conversion is used to support Python 3,
but somehow I recently managed to choke on:

File "docutils\utils\math\tex2mathml_extern.py", line 130
     print err

Although this could be "fixed" with parentheses, but
I'm guessing the very existence of this line is an oversight.

Cheers,
Alan Isaac

PS While looking, I noticed old style exception syntax in use.
I assume this is intentional (i.e., let the converter handle it)
and that you know Python 2's

     except IOError, err:

could be written without any need for 2to3 conversion as

     except IOError:
         err = sys.exc_info()[1]

Re: [Docutils-users] ISBN URL?

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

On 2017-05-11, 21:30 GMT, Guenter Milde wrote:
> Unfortunately, this does not help in praxi, as
>         
>   Your browser would have to have a "resolver" installed for ISBN numbers
>   that would find a URL for the resource. As far as I know, no browsers
>   have taken a stab at implementing resolvers as called for by the RFC.
>   –- Stephen Ostermiller Feb 24 at 8:57 

So, to translate your post into English: there is nothing to 
help you. Right?

Best,

Matěj
-- 
http://matej.ceplovi.cz/blog/, Jabber: mcepl<at>ceplovi.cz
GPG Finger: 3C76 A027 CA45 AD70 98B5  BC1D 7920 5802 880B C9D8
 
The truth is a beautiful and terrible thing, and should therefore
be treated with caution.
  -- Albus Dumbledore

Re: [Docutils-users] Using attributes in the "class" directive

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

On Thu, Dec 21, 2017 at 7:41 AM,
<doc...@ay...> wrote:
> According to the spec, the "class" attribute accepts class names and also
> attribute values as directive arguments [1].
>
> [1] http://docutils.sourceforge.net/docs/ref/rst/directives.html#class

You misunderstand the spec. The class names *become* the "classes"
attribute of its contents or the immediately-following element.

> The examples for the "class" attribute only include class names but not
> attribute values.

This reST::

    .. class:: special

    This is a "special" paragraph.

becomes this doctree fragment (XML)::

    <paragraph classes="special">This is a "special" paragraph.</paragraph>

> Is it really possible to assign attributes to a class name
> by using the "class" directive?

No, that doesn't make sense.

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

[Docutils-users] Using attributes in the "class" directive

[<doc...@ay...>]

According to the spec, the "class" attribute accepts class names and 
also attribute values as directive arguments [1].

The examples for the "class" attribute only include class names but not 
attribute values. Is it really possible to assign attributes to a class 
name by using the "class" directive?

Gökçe

[1] http://docutils.sourceforge.net/docs/ref/rst/directives.html#class

Re: [Docutils-users] HTML <div style="width:40%">

[Gökçe A. <doc...@ay...>]

Thank you Günter and David. It makes sense that rST does not support 
direct styling — this is what stylesheets are for.

I'll explain the background of my question: Pandoc can generate beamer 
slides. For slides, it is also possible to generate columns and specify 
the width in Pandoc's Markdown as follows [1]:

:::::::::::::: {.columns}
::: {.column width="40%"}
contents...
:::
::: {.column width="60%"}
contents...
:::
::::::::::::::

This block generates the following HTML:

<div class="columns">
   <div class="column" style="width:40%;">
     <p>contents…</p>
   </div>
   <div class="column" style="width:60%;">
     <p>contents…</p>
   </div>
</div>

I wanted to do the same with rST. As you have suggested I tried with 
container:: and class:: directives, which could generate a beamer slide 
with columns in pandoc:

.. class:: columns

    .. class:: column

       - first

    .. class:: column

       - second

Note that also container:: directive can be used in the preceding 
example. I could not figure out how to create the style attribute when 
using rST as input in Pandoc. Although Pandoc accepts CSS for 
HTML/CSS-to-pdf output, it does not support CSS input along with rST I 
suppose. I will create a request for that.

Gökçe

[1] https://pandoc.org/MANUAL.html#columns


Am 2017-11-22 22:43, schrieb David Goodger:
> Yes, it's possible. But not recommended. Directly, the only way is
> with the "raw" directive:
> http://docutils.sourceforge.net/docs/ref/rst/directives.html#raw-data-pass-through
> But that is a last resort only. I do NOT recommend it.
> 
> What you're talking about is styling your HTML. You should use
> stylesheets for that:
> http://docutils.sourceforge.net/docs/howto/html-stylesheets.html
> 
> Use the "class" directive (or "class" option on an existing directive)
> to assign custom classes if necessary:
> http://docutils.sourceforge.net/docs/ref/rst/directives.html#class
> 
> What, in your document, are you trying to style?
> 
> David Goodger
> <http://python.net/~goodger>
> 
> 
> On Wed, Nov 22, 2017 at 8:55 AM, Gökçe Aydos
> <doc...@ay...> wrote:
>> Is it possible to generate HTML output as follows?
>> 
>> <div style="width:40%">
>> contents...
>> </div>
>> 
>> Regards, Gökçe
>> 
>> ------------------------------------------------------------------------------
>> 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.

Re: [Docutils-users] HTML <div style="width:40%">

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

Yes, it's possible. But not recommended. Directly, the only way is
with the "raw" directive:
http://docutils.sourceforge.net/docs/ref/rst/directives.html#raw-data-pass-through
But that is a last resort only. I do NOT recommend it.

What you're talking about is styling your HTML. You should use
stylesheets for that:
http://docutils.sourceforge.net/docs/howto/html-stylesheets.html

Use the "class" directive (or "class" option on an existing directive)
to assign custom classes if necessary:
http://docutils.sourceforge.net/docs/ref/rst/directives.html#class

What, in your document, are you trying to style?

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


On Wed, Nov 22, 2017 at 8:55 AM, Gökçe Aydos
<doc...@ay...> wrote:
> Is it possible to generate HTML output as follows?
>
> <div style="width:40%">
> contents...
> </div>
>
> Regards, Gökçe
>
> ------------------------------------------------------------------------------
> 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.

Re: [Docutils-users] HTML <div style="width:40%">

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

On 2017-11-22, Gökçe Aydos wrote:
> Is it possible to generate HTML output as follows?

><div style="width:40%">
> contents...
></div>

This can be done with raw HTML only.

OTOH, you could use the rST equivalent to a <div> and give it a class argument
that can be styled via a custom CSS stylesheet::

  .. container:: custom

     This paragraph might be rendered in a custom way.
     
becomes::

 <div class="custom docutils container">
 <p>This paragraph might be rendered in a custom way.</p>
 </div>
 
Günter    

[Docutils-users] HTML <div style="width:40%">

[Gökçe A. <doc...@ay...>]

Is it possible to generate HTML output as follows?

<div style="width:40%">
contents...
</div>

Regards, Gökçe

Re: [Docutils-users] Test suite failure

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

Please provide some details:
http://docutils.sourceforge.net/BUGS.html#how-to-report-a-bug

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


On Tue, Nov 21, 2017 at 12:00 AM, Gabrielle Lundie
<gab...@gm...> wrote:
>
> ------------------------------------------------------------------------------
> 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] Test suite failure

[Gabrielle L. <gab...@gm...>]

Re: [Docutils-users] camelCase directives not working

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

This is a feature, or at least part of the spec. According to
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#directives:

"Directive types are case-insensitive single
words (alphanumerics plus isolated internal hyphens, underscores,
plus signs, colons, and periods; no whitespace)."

The directive "type" is its name. What "case-insensitive" means here
is that in documents, you can refer to your directive as
"eventListner" or "EventListner" or "eventlistner" or "eVeNtLiStNeR"
or whatever. This is achieved by normalizing the directive name in the
document to "eventlistner", all lowercase. To match, the directive
name must also be all-lowercase at registration time; no normalization
happens then. Registering your directive as "eventListner", with mixed
case, made it impossible to match the name to its use in documents.

Directive names are effectively case-sensitive at registration time,
and must be lowercase. We could add name normalization code to ensure
that this is always true, or a check to warn if it isn't true. As this
is the first time I've seen this, I don't know if it's worth the
effort, small as it may be. I wouldn't object to such a change.

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


On Sun, Oct 22, 2017 at 6:33 AM, Robin Shannon <rj...@ro...> wrote:
>
> I created a custom directive called 'eventListner'. After registering it and
> trying out a test reST document docutils told me that this was an unknown
> directive. Much confusion later, I finally figured out that if I renamed the
> directive to 'eventlistner' everything worked fine. Is this a feature or a
> bug? I looked through the list archive but couldn't find anything obvious
> about this.
>
> I admit that camelCase as a directive name is probably generally not a good
> idea, but since this is a shortcut for the javascript function
> 'eventListner' it seemed appropriate.
>
> Cheers,
> Robin.
>
>
> ------------------------------------------------------------------------------
> 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] camelCase directives not working

[Robin S. <rj...@ro...>]

I created a custom directive called 'eventListner'. After registering it
and trying out a test reST document docutils told me that this was an
unknown directive. Much confusion later, I finally figured out that if I
renamed the directive to 'eventlistner' everything worked fine. Is this a
feature or a bug? I looked through the list archive but couldn't find
anything obvious about this.

I admit that camelCase as a directive name is probably generally not a good
idea, but since this is a shortcut for the javascript function
'eventListner' it seemed appropriate.

Cheers,
Robin.