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

Re: [Docutils-users] publish_parts and table of contents?

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

On 2017-07-18, Tony Narlock wrote:

> Is there a way to get the equivalent to “.. contents::” from publish_parts?

According to
http://docutils.sourceforge.net/docs/api/publisher.html#publish-parts-details,
no.

> If not, is there any way to get the table of contents programmatically?

This could be done in a wrapper; or a custom writer or front-end.

Places to look include the transforms.parts.Content() and the used HTML
writer.

> If not, is there any reason / issue with it being a feature?

I don't know.

> The practical use is a developer pulling out parts the HTML output would
> like control over the table of contents output.

The simple and secure approach would be CSS styling --- unless the task is
more complicated.

Günter

Re: [Docutils-users] indirect references to citations

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

On 2017-07-18, Alan Isaac wrote:
I expected this_ to work, but it produced an invalid link.

.. this:: [mycite]_

.. [mycite]
    My Citation Details.

> Are such indirect references allowed?

Yes, if you use the correct syntax::

  .. _this: [mycite]_
  
  .. [mycite]
      My Citation Details.

(In your example, you used a *directive* "this".)

Günter

[Docutils-users] indirect references to citations

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

I expected this_ to work, but it produced an invalid link.

.. this:: [mycite]_

.. [mycite]
    My Citation Details.

Are such indirect references allowed?

Thanks,
Alan Isaac
(using rst2html5)

[Docutils-users] publish_parts and table of contents?

[Tony N. <to...@gi...>]

Hello docutils users,

Is there a way to get the equivalent to “.. contents::” from publish_parts?

http://docutils.sourceforge.net/0.4/docs/api/publisher.html

If not, is there any way to get the table of contents programmatically?

If not, is there any reason / issue with it being a feature?

The practical use is a developer pulling out parts the HTML output would
like control over the table of contents output.

Re: [Docutils-users] Omit substitution text in section link?

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

On Wed, Jun 21, 2017 at 8:57 AM, Luis Gomez <lui...@gm...> wrote:
> Hello,
>
> I'm using substitutions to insert images in section headings, but it's less
> than ideal when I have to link to those sections
>
> Take, for example, the following ReST:
>
> |icon1| My Section
> ================
>
> This will result in a section link of "icon1-my-section". To refer to this
> section elsewhere in the document, I have to write `icon1 My Section`_.
>
> I would like a way to allow that same section to be referred by `My
> Section`_, and the resulting link to be "my-section", as if the substitution
> text wasn't there. Is it possible to omit the text content of a substitution
> in a section heading?

Not currently.

Workaround that will give you what you want:

.. _My Section:

|icon1| My Section
================

If your output is HTML, you could also add an icon via CSS styling.

> If not, could this be considered for a future feature?

Please add a feature request, else it will be forgotten:
https://sourceforge.net/p/docutils/feature-requests/

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

[Docutils-users] Omit substitution text in section link?

[Luis G. <lui...@gm...>]

Hello,

I'm using substitutions to insert images in section headings, but it's less
than ideal when I have to link to those sections

Take, for example, the following ReST:

|icon1| My Section
================

This will result in a section link of "icon1-my-section". To refer to this
section elsewhere in the document, I have to write `icon1 My Section`_.

I would like a way to allow that same section to be referred by `My
Section`_, and the resulting link to be "my-section", as if the
substitution text wasn't there. Is it possible to omit the text content of
a substitution in a section heading? If not, could this be considered for a
future feature?

Thanks!

Luis Gomez

p.s. I'm not subscribed to the mailing list.

Re: [Docutils-users] toggle code

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

On 2017-06-07, Benoit Barthelet wrote:

> [-- Type: text/plain, Encoding:  --]

> Hello,

> I'm finding myself writing in rst and pasting long parts of code using the
> .. code:: directive

(BTW For complete code files, you can also use the "include" directive
with the "code" option.
http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment
)

> I'd like to be able to have togglable code when using rst2html.

> If I'm correct I can achieve that with or without javascript, in both case
> I seem to be missing one part of the puzzle to make it work effortlessly.

> With javascript, as described in
> https://stackoverflow.com/a/25543713/3581357 I can create a container and
> have the js code handle the toggle, this works fine for me, except that I'm
> unable to find a way to add the js code in question to the rst2html cli.

You can specify a custom html template to replace the default
docutils/writers/html4css1/template.txt
http://docutils.sourceforge.net/docs/user/config.html#template


Also, you can pass class arguments to (almost) any rST element using either
the "class" directive or (for directives) the "class" option::

  .. code-block:: xml
     :class: toggle-hide

So, maybe you don't need to wrap in a "container".



> I see there is a --script flag but only for rst2html5.

There is no such thing for rst2html5.py shipping with docutils.
http://docutils.sourceforge.net/docs/user/config.html#html5-writer



> Without javascript it seems like css can be used to get the toggle effect
> as described here:
> https://siongui.github.io/2017/02/27/css-only-toggle-dom-element/

> That solution would be quite elegant, ids could be changed to classes and
> the css modified accordingly, but I don't see a way to add a <input
> id="element-toggle" type="checkbox" /> which this solution is ultimately
> based on.

There is indeed not rST for an HTML <input> element.
You could use raw HTML.

> Is it where I should write my own directive as described here
> http://docutils.sourceforge.net/docs/howto/rst-directives.html ?

You would not only need a custom directive, but also an extension to the
HTML writer (unless you let the custom directive generate raw HTML). 

Günter

[Docutils-users] toggle code

[Benoit B. <ben...@gm...>]

Hello,

I'm finding myself writing in rst and pasting long parts of code using the
.. code:: directive

I'd like to be able to have togglable code when using rst2html.

If I'm correct I can achieve that with or without javascript, in both case
I seem to be missing one part of the puzzle to make it work effortlessly.

With javascript, as described in
https://stackoverflow.com/a/25543713/3581357 I can create a container and
have the js code handle the toggle, this works fine for me, except that I'm
unable to find a way to add the js code in question to the rst2html cli.

I see there is a --script flag but only for rst2html5.

Without javascript it seems like css can be used to get the toggle effect
as described here:
https://siongui.github.io/2017/02/27/css-only-toggle-dom-element/

That solution would be quite elegant, ids could be changed to classes and
the css modified accordingly, but I don't see a way to add a <input
id="element-toggle" type="checkbox" /> which this solution is ultimately
based on.

Is it where I should write my own directive as described here
http://docutils.sourceforge.net/docs/howto/rst-directives.html ?

thanks for your pointers for a beginner rst writer

-- 
benoit barthelet
http://pgp.mit.edu/pks/lookup?op=get&search=0xF150E01A72F6D2EE

Re: [Docutils-users] weird footnotes in the generated LaTeX

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

On 2017-01-28, Matěj Cepl wrote:

> I have written a bit longer document using rST (all discussed 
> files are in https://mcepl.fedorapeople.org/tmp/harry_potter/), 
> and then convered it to LaTeX just with plain rst2xetex (using 
> 0.13.1).

Mind, that despite the name, rst2xetex does not generate plain TeX for XeTeX
but LaTeX for XeTeX/LuaTeX (compile with `xelatex` or `xeluatex` commands).

> The resulting file is 
>   https://mcepl.fedorapeople.org/tmp/harry_potter/harry-potter-odpoved-brachovi.pdf
> and the problem I have it is that footnotes are quite often not 
> on the page they referred to (see page 8 for an example). 

This is a know problem of the LaTeX writer.

> Is there some configuration or something which would persuade 
> docutils not to mess with footenotes and use plain \footnote{} 
> in LaTeX?

There is just a TODO entry in docs/dev/todo.txt:

 * footnotes

  + True footnotes with LaTeX auto-numbering (as option ``--latex-footnotes``)
    (also for target-footnotes):

    - attach footnote text to footnote-symbol node
    - write \footnote{<footnote text>}
    - consider cases where LaTeX does not support footnotes
      (inside tables, headings, ...)?
    - consider multiple footnote refs to common footnote text.

The problem is that in the source, the footnote text is not known when the
footnote mark is parsed. We would need a transform to connect these so that
the footnote-mark is written as \footnote{<footnote text>}

Günter

Re: [Docutils-users] docutils latest version contains string

[engelbert g. <eng...@gm...>]

On 29 May 2017 at 04:37, Ben Finney <ben...@be...> wrote:

> Ben Finney <ben...@be...> writes:
>
> > Version parsing of Python distributions should accept […]
>
> My apologies, I gave the wrong PEP reference. That should be:
>
> Version parsing of Python distributions should accept PEP 386 values
> <URL:https://www.python.org/dev/peps/pep-0386/>.
>

superceeded by https://www.python.org/dev/peps/pep-0440/


> --
>  \          “When [science] permits us to see the far side of some new |
>   `\      horizon, we remember those who prepared the way – seeing for |
> _o__)                          them also.” —Carl Sagan, _Cosmos_, 1980 |
> Ben Finney
>
>
> ------------------------------------------------------------
> ------------------
> 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] docutils latest version contains string

[Ben F. <ben...@be...>]

Ben Finney <ben...@be...> writes:

> Version parsing of Python distributions should accept […]

My apologies, I gave the wrong PEP reference. That should be:

Version parsing of Python distributions should accept PEP 386 values
<URL:https://www.python.org/dev/peps/pep-0386/>.

-- 
 \          “When [science] permits us to see the far side of some new |
  `\      horizon, we remember those who prepared the way – seeing for |
_o__)                          them also.” —Carl Sagan, _Cosmos_, 1980 |
Ben Finney

Re: [Docutils-users] docutils latest version contains string

[Ben F. <ben...@be...>]

Kfir Ilani <kfi...@ir...> writes:

> docutils latest package version is 0.14rc1
> while other packages try to parse the version (such as sphinx), it fails
> due to parse error for int()

What are the “other packages”?

Version parsing of Python distributions should accept PEP 396 values
<URL:https://www.python.org/dev/peps/pep-0396/>.

> Can you please update docutils version to contains only integers (as
> universal format)

Rather, the tool needs to be updated to accept the standard PEP 396
version format.

-- 
 \                “The supreme vice is shallowness.” —Oscar Wilde, _De |
  `\                                                  Profundis_, 1897 |
_o__)                                                                  |
Ben Finney

[Docutils-users] docutils latest version contains string

[Kfir I. <kfi...@ir...>]

docutils latest package version is 0.14rc1
while other packages try to parse the version (such as sphinx), it fails
due to parse error for int()

File
"/Users/ci/workspace/wrk_automation_utils_mac_debug/.eggs/Sphinx-1.3.1-py2.7.egg/sphinx/util/compat.py",
line 17, in
docutils_version = tuple(int(x) for x in _du_version.split('.')[:2])
ValueError: invalid literal for int() with base 10: '14rc1'

Can you please update docutils version to contains only integers (as
universal format)


Thanks
Kfir Ilani

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

[Dave K. <dku...@da...>]

Günter,

Here is an update -- I did the following:

1. Merged your change for Jython import of locale module.

2. Added notes to HISTORY.txt.

3. Committed changes to the central repository.

Dave K


On Sun, May 21, 2017 at 10:22:39AM +0000, Guenter Milde wrote:
> Dear Dave,
> 
> On 2017-05-19, Dave Kuhlman wrote:
> 
> > I did the following:
> 
> > 1. Merged your changes (patch file below) into my local repository.
> 
> > 2. Did a bit of testing.  I had an exception when a document
> >    contained an admonition.  I fixed that.
> 
> > 3. Committed these changes to the central repository.
> 
> > Thank you for your help with this.  
> 
> > Let me know if/when there is something more I can do.
> 
> I have one more patch that makes the code failsafe for Python
> implementations missing the locale module (e.g. Jython).
> 
> If you could add a short summary of changed to the HISTORY.txt file,
> we should be ready for release.
> 
> Thanks,
> 
> Günter
> 
> 
> 
> Index: __init__.py
> ===================================================================
> --- __init__.py	(Revision 8070)
> +++ __init__.py	(Arbeitskopie)
> @@ -24,7 +24,10 @@
>  import copy
>  import urllib2
>  import docutils
> -import locale
> +try:
> +    import locale # module missing in Jython
> +except ImportError:
> +    pass
>  from docutils import frontend, nodes, utils, writers, languages
>  from docutils.readers import standalone
>  from docutils.transforms import references
> @@ -589,7 +592,10 @@
>                  elif len(subtag) == 1:
>                      break   # 1-letter tag is never before valid region tag
>              if region_code is None:
> -                rcode = locale.normalize(language_code)
> +                try:
> +                    rcode = locale.normalize(language_code)
> +                except NameError:
> +                    rcode = language_code
>                  rcode = rcode.split('_')
>                  if len(rcode) > 1:
>                      rcode = rcode[1].split('.')
> @@ -596,11 +602,10 @@
>                      region_code = rcode[0]
>                  if region_code is None:
>                      self.document.reporter.warning(
> -                        'invalid language-region.  '
> -                        'Could not find region with locale.normalize().  '
> -                        'If language is supplied, then you must specify '
> -                        'both language and region (ll-RR).  Examples: '
> -                        'es-MX (Spanish, Mexico), en-AU (English, Australia).')
> +                        'invalid language-region.\n'
> +                        '  Could not find region with locale.normalize().\n'
> +                        '  Please specify both language and region (ll-RR).\n'
> +                        '  Examples: es-MX (Spanish, Mexico), en-AU (English, Australia).')
>          # Update the style ElementTree with the language and region.
>          # Note that we keep a reference to the modified node because
>          # it is possible that ElementTree will throw away the Python
> 
> 
> ------------------------------------------------------------------------------
> 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.

-- 

Dave Kuhlman
http://www.davekuhlman.org

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

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

Dear Dave,

On 2017-05-19, Dave Kuhlman wrote:

> I did the following:

> 1. Merged your changes (patch file below) into my local repository.

> 2. Did a bit of testing.  I had an exception when a document
>    contained an admonition.  I fixed that.

> 3. Committed these changes to the central repository.

> Thank you for your help with this.  

> Let me know if/when there is something more I can do.

I have one more patch that makes the code failsafe for Python
implementations missing the locale module (e.g. Jython).

If you could add a short summary of changed to the HISTORY.txt file,
we should be ready for release.

Thanks,

Günter



Index: __init__.py
===================================================================
--- __init__.py	(Revision 8070)
+++ __init__.py	(Arbeitskopie)
@@ -24,7 +24,10 @@
 import copy
 import urllib2
 import docutils
-import locale
+try:
+    import locale # module missing in Jython
+except ImportError:
+    pass
 from docutils import frontend, nodes, utils, writers, languages
 from docutils.readers import standalone
 from docutils.transforms import references
@@ -589,7 +592,10 @@
                 elif len(subtag) == 1:
                     break   # 1-letter tag is never before valid region tag
             if region_code is None:
-                rcode = locale.normalize(language_code)
+                try:
+                    rcode = locale.normalize(language_code)
+                except NameError:
+                    rcode = language_code
                 rcode = rcode.split('_')
                 if len(rcode) > 1:
                     rcode = rcode[1].split('.')
@@ -596,11 +602,10 @@
                     region_code = rcode[0]
                 if region_code is None:
                     self.document.reporter.warning(
-                        'invalid language-region.  '
-                        'Could not find region with locale.normalize().  '
-                        'If language is supplied, then you must specify '
-                        'both language and region (ll-RR).  Examples: '
-                        'es-MX (Spanish, Mexico), en-AU (English, Australia).')
+                        'invalid language-region.\n'
+                        '  Could not find region with locale.normalize().\n'
+                        '  Please specify both language and region (ll-RR).\n'
+                        '  Examples: es-MX (Spanish, Mexico), en-AU (English, Australia).')
         # Update the style ElementTree with the language and region.
         # Note that we keep a reference to the modified node because
         # it is possible that ElementTree will throw away the Python

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

[Dave K. <dku...@da...>]

Günter,

I did the following:

1. Merged your changes (patch file below) into my local repository.

2. Did a bit of testing.  I had an exception when a document
   contained an admonition.  I fixed that.

3. Committed these changes to the central repository.

Thank you for your help with this.  Let me know if/when there is
something more I can do.

Dave K


On Thu, May 18, 2017 at 07:42:35PM +0000, Guenter Milde wrote:
> Dear Dave,
> 
> On 2017-05-16, Dave Kuhlman wrote:
> 
> > I did the commit.
> 
> > And, before I did so, I took Matěj's suggestion about using
> > ``locale.normalize(lang), so now you can use::
> 
> >     $ rst2odt.py -l cs somedoc.txt somedoc.odt
> >     $ rst2odt.py -l es somedoc.txt somedoc.odt
> 
> > to get Czech and Spanish (Spain).
> 
> Fine.
> 
> > And, of course, you can override the region, for example::
> 
> >     $ rst2odt.py -l cs-GB  somedoc.txt somedoc.odt
> >     $ rst2odt.py -l es-mx somedoc.txt somedoc.odt
> 
> > to get British English and Mexican Spanish.
> 
> 
> I suggest the patch below to allow for BCP 47 tags like
> 
>   de-Latf-AT        # second tag is script, region in 3rd position
>   de-latf           # second tag is script, no region given
>   de-1901           # second tag is variant (here: spelling), no region given
>   
> 
> Further changes:
> 
> The RuntimeError if locale.normalize fails to find a region tag is
> replaced with a Warning: a missing region tag does not prevent export
> of a functional output document.
> 
> The RuntimeError for empty "self.visitor.language_code" is removed on the
> assumption that if a user calls ``--language=""``, this indicates that no
> language should be written into the output --- which is exactly what happens
> in this case.
> 
> From the function "languages.normalize_language_tag()", we only need the
> replacement of "_" by "-". This is better done with a string method.
> 
> 
> Günter
> 
> 
> Dir: /home/milde/Code/Python/docutils-svn/docutils/docutils/writers/odf_odt/
> 
> Index: __init__.py
> ===================================================================
> --- __init__.py	(Revision 8069)
> +++ __init__.py	(Arbeitskopie)
> @@ -572,38 +572,35 @@
>          s1 = self.get_stylesheet()
>          # Set default language in document to be generated.
>          # Language is specified by the -l/--language command line option.
> -        # Allowed values are "ll", "ll-rr" or "ll_rr", where ll is language
> -        # and rr is region.  If region is omitted, we use
> +        # The format is described in BCP 47.  If region is omitted, we use
>          # local.normalize(ll) to obtain a region.
>          language_code = None
>          region_code = None
> -        if len(self.visitor.normalized_language_code) > 0:
> -            language_ids = self.visitor.normalized_language_code[0].split('-')
> -            if len(language_ids) == 2:
> -                language_code = language_ids[0]
> -                region_code = language_ids[1]
> -            elif len(language_ids) == 1:
> -                language_code = language_ids[0]
> +        if self.visitor.language_code:
> +            language_ids = self.visitor.language_code.replace('_','-')
> +            language_ids = language_ids.split('-')
> +            # first tag is primary language tag
> +            language_code = language_ids[0].lower()
> +            # 2-letter region subtag may follow in 2nd or 3rd position
> +            for subtag in language_ids[1:]:
> +                if len(subtag) == 2 and subtag.isalpha():
> +                    region_code = subtag.upper()
> +                    break
> +                elif len(subtag) == 1:
> +                    break # 1-letter tag is never before valid region tag
> +            if region_code is None:
>                  rcode = locale.normalize(language_code)
>                  rcode = rcode.split('_')
>                  if len(rcode) > 1:
> -                    rcode = rcode[1]
> -                    rcode = rcode.split('.')
> -                    if len(rcode) >= 1:
> -                        region_code = rcode[0]
> +                    rcode = rcode[1].split('.')
> +                    region_code = rcode[0]
>                  if region_code is None:
> -                    raise RuntimeError(
> +                    self.document.reporter.warning(
>                          'invalid language-region.  '
>                          'Could not find region with locale.normalize().  '
>                          'If language is supplied, then you must specify '
> -                        'both lanauge and region (ll-rr).  Examples: '
> -                        'es-mx (Spanish, Mexico), en-au (English, Australia).')
> -        else:
> -            raise RuntimeError(
> -                'invalid language-region. '
> -                'Format must be "ll-rr" or "ll_rr", where ll is language '
> -                'and rr is region. '
> -                'See https://en.wikipedia.org/wiki/IETF_language_tag')
> +                        'both language and region (ll-RR).  Examples: '
> +                        'es-MX (Spanish, Mexico), en-AU (English, Australia).')
>          # Update the style ElementTree with the language and region.
>          # Note that we keep a reference to the modified node because
>          # it is possible that ElementTree will throw away the Python
> @@ -888,8 +885,6 @@
>          self.language = languages.get_language(
>              self.language_code,
>              document.reporter)
> -        self.normalized_language_code = languages.normalize_language_tag(
> -            self.language_code)
>          self.format_map = {}
>          if self.settings.odf_config_file:
>              from ConfigParser import ConfigParser
>   
> 
> 
> ------------------------------------------------------------------------------
> 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.

-- 

Dave Kuhlman
http://www.davekuhlman.org

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

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

Dear Dave,

On 2017-05-16, Dave Kuhlman wrote:

> I did the commit.

> And, before I did so, I took Matěj's suggestion about using
> ``locale.normalize(lang), so now you can use::

>     $ rst2odt.py -l cs somedoc.txt somedoc.odt
>     $ rst2odt.py -l es somedoc.txt somedoc.odt

> to get Czech and Spanish (Spain).

Fine.

> And, of course, you can override the region, for example::

>     $ rst2odt.py -l cs-GB  somedoc.txt somedoc.odt
>     $ rst2odt.py -l es-mx somedoc.txt somedoc.odt

> to get British English and Mexican Spanish.


I suggest the patch below to allow for BCP 47 tags like

  de-Latf-AT        # second tag is script, region in 3rd position
  de-latf           # second tag is script, no region given
  de-1901           # second tag is variant (here: spelling), no region given
  

Further changes:

The RuntimeError if locale.normalize fails to find a region tag is
replaced with a Warning: a missing region tag does not prevent export
of a functional output document.

The RuntimeError for empty "self.visitor.language_code" is removed on the
assumption that if a user calls ``--language=""``, this indicates that no
language should be written into the output --- which is exactly what happens
in this case.

>From the function "languages.normalize_language_tag()", we only need the
replacement of "_" by "-". This is better done with a string method.


Günter


Dir: /home/milde/Code/Python/docutils-svn/docutils/docutils/writers/odf_odt/

Index: __init__.py
===================================================================
--- __init__.py	(Revision 8069)
+++ __init__.py	(Arbeitskopie)
@@ -572,38 +572,35 @@
         s1 = self.get_stylesheet()
         # Set default language in document to be generated.
         # Language is specified by the -l/--language command line option.
-        # Allowed values are "ll", "ll-rr" or "ll_rr", where ll is language
-        # and rr is region.  If region is omitted, we use
+        # The format is described in BCP 47.  If region is omitted, we use
         # local.normalize(ll) to obtain a region.
         language_code = None
         region_code = None
-        if len(self.visitor.normalized_language_code) > 0:
-            language_ids = self.visitor.normalized_language_code[0].split('-')
-            if len(language_ids) == 2:
-                language_code = language_ids[0]
-                region_code = language_ids[1]
-            elif len(language_ids) == 1:
-                language_code = language_ids[0]
+        if self.visitor.language_code:
+            language_ids = self.visitor.language_code.replace('_','-')
+            language_ids = language_ids.split('-')
+            # first tag is primary language tag
+            language_code = language_ids[0].lower()
+            # 2-letter region subtag may follow in 2nd or 3rd position
+            for subtag in language_ids[1:]:
+                if len(subtag) == 2 and subtag.isalpha():
+                    region_code = subtag.upper()
+                    break
+                elif len(subtag) == 1:
+                    break # 1-letter tag is never before valid region tag
+            if region_code is None:
                 rcode = locale.normalize(language_code)
                 rcode = rcode.split('_')
                 if len(rcode) > 1:
-                    rcode = rcode[1]
-                    rcode = rcode.split('.')
-                    if len(rcode) >= 1:
-                        region_code = rcode[0]
+                    rcode = rcode[1].split('.')
+                    region_code = rcode[0]
                 if region_code is None:
-                    raise RuntimeError(
+                    self.document.reporter.warning(
                         'invalid language-region.  '
                         'Could not find region with locale.normalize().  '
                         'If language is supplied, then you must specify '
-                        'both lanauge and region (ll-rr).  Examples: '
-                        'es-mx (Spanish, Mexico), en-au (English, Australia).')
-        else:
-            raise RuntimeError(
-                'invalid language-region. '
-                'Format must be "ll-rr" or "ll_rr", where ll is language '
-                'and rr is region. '
-                'See https://en.wikipedia.org/wiki/IETF_language_tag')
+                        'both language and region (ll-RR).  Examples: '
+                        'es-MX (Spanish, Mexico), en-AU (English, Australia).')
         # Update the style ElementTree with the language and region.
         # Note that we keep a reference to the modified node because
         # it is possible that ElementTree will throw away the Python
@@ -888,8 +885,6 @@
         self.language = languages.get_language(
             self.language_code,
             document.reporter)
-        self.normalized_language_code = languages.normalize_language_tag(
-            self.language_code)
         self.format_map = {}
         if self.settings.odf_config_file:
             from ConfigParser import ConfigParser
  

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

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

On 2017-05-16, 21:48 GMT, Dave Kuhlman wrote:
> And, Matěj, thanks for being patient with me and thank you for 
> all your help with this.

You did all the real work. Thank you!

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] Is rst2odt -l cs supposed to work?

[Dave K. <dku...@da...>]

> Thank you for that suggestion, Matěj.  I did know about that.

Rats.  Meant to say I did *not* know.

And, Matěj, thanks for being patient with me and thank you for all
your help with this.

Dave K.

On Tue, May 16, 2017 at 02:29:00PM -0700, Dave Kuhlman wrote:
> Günter and Matěj,
> 
> I did the commit.
> 
> And, before I did so, I took Matěj's suggestion about using
> ``locale.normalize(lang), so now you can use::
> 
>     $ rst2odt.py -l cs somedoc.txt somedoc.odt
>     $ rst2odt.py -l es somedoc.txt somedoc.odt
> 
> to get Czech and Spanish (Spain).
> 
> And, of course, you can override the region, for example::
> 
>     $ rst2odt.py -l cs-GB  somedoc.txt somedoc.odt
>     $ rst2odt.py -l es-mx somedoc.txt somedoc.odt
> 
> to get British English and Mexican Spanish.
> 
> Thank you for that suggestion, Matěj.  I did know about that.
> 
> Dave K.
> 
> 
> On Tue, May 16, 2017 at 12:10:04PM +0000, Guenter Milde wrote:
> > On 2017-05-16, Matej Cepl wrote:
> > > On 16/05/17 01:42, Dave Kuhlman wrote:
> > 
> > >> 1. Images that use ":width: xx%" are scaled to the line width.
> > ...
> > 
> > >> 2. The header/title of an admonition (for example, a note) now
> > >>    follows the style of the admonition header
> > ...
> > 
> > >> 3. The unit test error that you found is fixed.
> > ...
> > 
> > Wonderfull. Thanks a lot for taking care of this.
> > 
> > >> Please let me know if we are getting closer, what else needs fixing,
> > >> etc.
> > 
> > > This works for me. As far as me I would get this let be released.
> > 
> > I second this, please commit and then it may be really time for 0.14!
> > 
> > 
> > I have one remaining question:
> > 
> > I understand, that LO/OO expects both, language and region tag of a document
> > to be set. 
> > I also understand that auto-filling the region tag is tricky.
> > 
> > What happens exactly, if in an rst2odt-exported document the language tag is
> > set but the region tag is missing:
> > 
> > a) an error/warning
> > b) the region is set to "US"
> > c) the region is set according to the users locale?
> > 
> > What should Docutils do in these cases?
> > 
> > >> By default, it was passing in "en" as the language, whereas now it
> > >> needs to be "en-US" or to be omitted.  I overrode it with "en-US".
> > 
> > Ther problem here is, that according to our specs, the default for
> > "language-code" is
> > 
> >   Default: English ("en").  Options: ``--language, -l``.
> > 
> > Unless absolutely required otherwise, I suggest passing just "en".
> > 
> > If this is not possible, the odt writer could use a different default
> > (this needs to be documented).
> > 
> > Rationale: not only Mexican and Castillean Spaniards disagree about the
> > default region tag for a language, narrowing "en" to American English 
> > must at least be documented.
> > 
> > But this may also be sorted out later.
> > 
> > 
> > Thanks again,
> > 
> > Günter
> > 
> > 
> > ------------------------------------------------------------------------------
> > 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.
> 
> -- 
> 
> Dave Kuhlman
> http://www.davekuhlman.org
> 
> ------------------------------------------------------------------------------
> 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.

-- 

Dave Kuhlman
http://www.davekuhlman.org

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

[Dave K. <dku...@da...>]

Günter and Matěj,

I did the commit.

And, before I did so, I took Matěj's suggestion about using
``locale.normalize(lang), so now you can use::

    $ rst2odt.py -l cs somedoc.txt somedoc.odt
    $ rst2odt.py -l es somedoc.txt somedoc.odt

to get Czech and Spanish (Spain).

And, of course, you can override the region, for example::

    $ rst2odt.py -l cs-GB  somedoc.txt somedoc.odt
    $ rst2odt.py -l es-mx somedoc.txt somedoc.odt

to get British English and Mexican Spanish.

Thank you for that suggestion, Matěj.  I did know about that.

Dave K.


On Tue, May 16, 2017 at 12:10:04PM +0000, Guenter Milde wrote:
> On 2017-05-16, Matej Cepl wrote:
> > On 16/05/17 01:42, Dave Kuhlman wrote:
> 
> >> 1. Images that use ":width: xx%" are scaled to the line width.
> ...
> 
> >> 2. The header/title of an admonition (for example, a note) now
> >>    follows the style of the admonition header
> ...
> 
> >> 3. The unit test error that you found is fixed.
> ...
> 
> Wonderfull. Thanks a lot for taking care of this.
> 
> >> Please let me know if we are getting closer, what else needs fixing,
> >> etc.
> 
> > This works for me. As far as me I would get this let be released.
> 
> I second this, please commit and then it may be really time for 0.14!
> 
> 
> I have one remaining question:
> 
> I understand, that LO/OO expects both, language and region tag of a document
> to be set. 
> I also understand that auto-filling the region tag is tricky.
> 
> What happens exactly, if in an rst2odt-exported document the language tag is
> set but the region tag is missing:
> 
> a) an error/warning
> b) the region is set to "US"
> c) the region is set according to the users locale?
> 
> What should Docutils do in these cases?
> 
> >> By default, it was passing in "en" as the language, whereas now it
> >> needs to be "en-US" or to be omitted.  I overrode it with "en-US".
> 
> Ther problem here is, that according to our specs, the default for
> "language-code" is
> 
>   Default: English ("en").  Options: ``--language, -l``.
> 
> Unless absolutely required otherwise, I suggest passing just "en".
> 
> If this is not possible, the odt writer could use a different default
> (this needs to be documented).
> 
> Rationale: not only Mexican and Castillean Spaniards disagree about the
> default region tag for a language, narrowing "en" to American English 
> must at least be documented.
> 
> But this may also be sorted out later.
> 
> 
> Thanks again,
> 
> Günter
> 
> 
> ------------------------------------------------------------------------------
> 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.

-- 

Dave Kuhlman
http://www.davekuhlman.org

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

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

On 2017-05-16, 12:10 GMT, Guenter Milde wrote:
> Unless absolutely required otherwise, I suggest passing just 
> "en".
>
> If this is not possible, the odt writer could use a different default
> (this needs to be documented).
>
> Rationale: not only Mexican and Castillean Spaniards disagree about the
> default region tag for a language, narrowing "en" to American English 
> must at least be documented.

What about locale.normalize() (https://is.gd/dZe2bZ)?

    In [1]: import locale

    In [2]: locale.normalize('en')
    Out[2]: 'en_US.ISO8859-1'

    In [3]: locale.normalize('cs')
    Out[3]: 'cs_CZ.ISO8859-2'

    In [4]: locale.normalize('es')
    Out[4]: 'es_ES.ISO8859-1'

    In [5]: locale.normalize('fr')
    Out[5]: 'fr_FR.ISO8859-1'

    In [6]:

(that encoding is bad, I would prefer UTF-8 all the time, but 
that’s another point)

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] Is rst2odt -l cs supposed to work?

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

On 2017-05-16, Matej Cepl wrote:
> On 16/05/17 01:42, Dave Kuhlman wrote:

>> 1. Images that use ":width: xx%" are scaled to the line width.
...

>> 2. The header/title of an admonition (for example, a note) now
>>    follows the style of the admonition header
...

>> 3. The unit test error that you found is fixed.
...

Wonderfull. Thanks a lot for taking care of this.

>> Please let me know if we are getting closer, what else needs fixing,
>> etc.

> This works for me. As far as me I would get this let be released.

I second this, please commit and then it may be really time for 0.14!


I have one remaining question:

I understand, that LO/OO expects both, language and region tag of a document
to be set. 
I also understand that auto-filling the region tag is tricky.

What happens exactly, if in an rst2odt-exported document the language tag is
set but the region tag is missing:

a) an error/warning
b) the region is set to "US"
c) the region is set according to the users locale?

What should Docutils do in these cases?

>> By default, it was passing in "en" as the language, whereas now it
>> needs to be "en-US" or to be omitted.  I overrode it with "en-US".

Ther problem here is, that according to our specs, the default for
"language-code" is

  Default: English ("en").  Options: ``--language, -l``.

Unless absolutely required otherwise, I suggest passing just "en".

If this is not possible, the odt writer could use a different default
(this needs to be documented).

Rationale: not only Mexican and Castillean Spaniards disagree about the
default region tag for a language, narrowing "en" to American English 
must at least be documented.

But this may also be sorted out later.


Thanks again,

Günter

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

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

On 16/05/17 01:42, Dave Kuhlman wrote:
> 1. Images that use ":width: xx%" are scaled to the line width.  Note
>    that if, after generating the .odt file, you edit it with
>    LibreOffice Writer, and you use menu item Format/Page to modify
>    the page width, the image size does *not* automatically adjust.
>    Is this a needed feature?  If it is, you could try to right-click
>    on the image and edit its properties.  But, none of that seemed
>    satisfactory to me.

I don’t think it is necessary. I believe that the primary use of rst2odt
is for sharing the document for review (tracking changes and notes are
working really well with LOWriter) or for providing camera-ready copies
of documents for those who prefer Word-like format. For both cases I
would just need to be sure that images look like when run through other
rst2* programs. If somebody wants to take .odt for serious editing, she
can very well make sure images work for her.

> 2. The header/title of an admonition (for example, a note) now
>    follows the style of the admonition header (for example,
>    rststyle-admon-note-hdr, rststyle-admon-warning-hdr, etc).  I was
>    mistakenly using the admonition title after it had been
>    translated (for example, to "Poznámka!") to generate the style.
>    And, there is no style named "rststyle-admon-Poznámka!-hdr".

Perfect. Thanks.

> 3. The unit test error that you found is fixed.  By default, it was
>    passing in "en" as the language, whereas now it needs to be
>    "en-US" or to be omitted.  I overrode it with "en-US".

Awesome.

> Wow.  This is turning out to be more fun than I thought it would.
> 
> Please let me know if we are getting closer, what else needs fixing,
> etc.

This works for me. As far as me I would get this let be released.

Thank you very much,

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] Is rst2odt -l cs supposed to work?

[Dave K. <dku...@da...>]

Matěj,

Here is what I believe I fixed:

1. Images that use ":width: xx%" are scaled to the line width.  Note
   that if, after generating the .odt file, you edit it with
   LibreOffice Writer, and you use menu item Format/Page to modify
   the page width, the image size does *not* automatically adjust.
   Is this a needed feature?  If it is, you could try to right-click
   on the image and edit its properties.  But, none of that seemed
   satisfactory to me.

2. The header/title of an admonition (for example, a note) now
   follows the style of the admonition header (for example,
   rststyle-admon-note-hdr, rststyle-admon-warning-hdr, etc).  I was
   mistakenly using the admonition title after it had been
   translated (for example, to "Poznámka!") to generate the style.
   And, there is no style named "rststyle-admon-Poznámka!-hdr".

3. The unit test error that you found is fixed.  By default, it was
   passing in "en" as the language, whereas now it needs to be
   "en-US" or to be omitted.  I overrode it with "en-US".

The modified files are attached to a separate message.

Wow.  This is turning out to be more fun than I thought it would.

Please let me know if we are getting closer, what else needs fixing,
etc.

Dave

-- 

Dave Kuhlman
http://www.davekuhlman.org

Re: [Docutils-users] Is rst2odt -l cs supposed to work?

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

On 13/05/17 00:33, Dave Kuhlman wrote:
>    The reason for the small scale factor is that your image is quite
>    large.  The size returned by PIL (the Python Image Library)
>    for your image (frantisek_xaversky.jpg) is 2448 X 3264.  That's
>    pixels, I suppose.  The conversion factor that I found at
>    http://www.unitconversion.org/unit_converter/typography-ex.html
>    is 1 px = 0.0264 cm.  So, for example, 2448 * 0.0264 * .15 =
>    9.69 cm, which is a reasonable starting width for your image on a
>    page, and you can adjust from there.

I think we have misunderstanding here.
http://docutils.sourceforge.net/docs/ref/rst/directives.html#image says,
that ``width`` parameter has as units “length or percentage of the
current line width”. It seems to me you think that percent means the
scaling factor. It doesn’t. rst2xetex does it perfectly well (see PDF I
have attached to one of the earlier emails to you).

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."