new odt-exporter: problems with formatting in captions

new odt-exporter: problems with formatting in captions

[Martin Gürtler]

Hi,

I just converted a 150 page document I used to convert to odt with the old
exporter. Following problems occurred:

1. table with #+CAPTION
   If the caption contains formatting (~, ==, _, ^), the exporter
   produces an invalid content.xml.  

   minimal example:

---8<------------------------------------------------------------
#+OPTIONS:   num:t toc:nil \n:nil @:t ::t |:t ^:{} -:t f:t *:t <:nil

* First paragraph
#+CAPTION: A_{1}^{2}
| head 1    | head2    |
|-----------+----------|
| content 1 | content2 |
---8<------------------------------------------------------------

The problem can be seen in the following xml fragment:

---8<------------------------------------------------------------
<table:table table:style-name="OrgTable" 
 table:name="A&lt;text:span 
 text:style-name="OrgSubscript"&gt;1&lt;/text:span&gt;&lt;text:span 
 text:style-name="OrgSuperscript"&gt;2&lt;/text:span&gt;">
---8<------------------------------------------------------------

The table:name attribute ends prematurely at the "OrgSubscript". This
could probably be mended by using single quotes for these attributes
inside attributes.

2. again #+CAPTION

   if the caption contains a string with /escaped/ underlines (please
   note the #+OPTION ^:t)
   
---8<------------------------------------------------------------
#+OPTIONS:   num:t toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:nil

* First paragraph
#+CAPTION: YYYYMMDD\_hhmmss.csv. 
| head 1    | head2    |
|-----------+----------|
| content 1 | content2 |
---8<------------------------------------------------------------

    The escaped _ is not detected; instead, a literal \ and subscript
    are detected, and teh document is invalid as above. This escaping
    seems not to be mentioned in the documentation, probably because it
    is no longer valid. Might be of interest to people who want to
    convert old documents.

3. the \ref syntax seems not to work anymore; substituting by \ref{text}
   by [[text]] worked.       

4. Empty lines between #+NAME and the respective table are no longer tolerated

remarks: I like the new smart quotes. More comfortable than putting in
the utf characters via C-8-RET (which is handy, though, for simple
formulae).

Regards

Martin

-- 
Dr. Martin Gürtler 
Phone: +49-341-2254303
Mobile: +49-1578-4469069
 

Re: new odt-exporter: problems with formatting in captions

[Jambunathan K]

Wrt items (1) and (2), I am planning to remove the support for short
captions.  (The caption going as part of table:name or draw:name) as
part of fix for

http://lists.gnu.org/archive/html/emacs-orgmode/2013-12/msg00100.html

The fix is not ready yet.  I am just feeling lazy after having not
looked at the code for almost an year now.

NOTE: If someone knows how to accommodate short captions (so that an
that an Index/TOC could be generated from within LibreOffice based on
it, please let me know.)

----------------------------------------------------------------

For the benefit of audience, if you use embedded images in your document
the document produced by the ODT exporter will be openable by
LibreOffice < 4.0 but not with LibreOffice > 4.1.  (In other words,
LibreOffice folks have introduced some backward incompatible changes.)

To ensure that the document produced by the exporter is usable resave
the document from within LibreOffice.  (i.e., make some trivial changes
to the ODT document and do a save again).  This way the XML produced by
the exporter will be re-written by LibreOffice and the problem will be
averted.

----------------------------------------------------------------

As a side note, I am discussing with Emacs maintainers whether they
would be comfortable about having me maintain the exporter right from
within Emacs repo.  I am not sure how the discussion will go.

http://lists.gnu.org/archive/html/emacs-devel/2013-12/msg00509.html


martin.guertler@gmx.de (Martin Gürtler) writes:

> Hi,
>
> I just converted a 150 page document I used to convert to odt with the old
> exporter. Following problems occurred:
>
> 1. table with #+CAPTION
>    If the caption contains formatting (~, ==, _, ^), the exporter
>    produces an invalid content.xml.  
>
>    minimal example:
>
> ---8<------------------------------------------------------------
> #+OPTIONS:   num:t toc:nil \n:nil @:t ::t |:t ^:{} -:t f:t *:t <:nil
>
> * First paragraph
> #+CAPTION: A_{1}^{2}
> | head 1    | head2    |
> |-----------+----------|
> | content 1 | content2 |
> ---8<------------------------------------------------------------
>
> The problem can be seen in the following xml fragment:
>
> ---8<------------------------------------------------------------
> <table:table table:style-name="OrgTable" 
>  table:name="A&lt;text:span 
>  text:style-name="OrgSubscript"&gt;1&lt;/text:span&gt;&lt;text:span 
>  text:style-name="OrgSuperscript"&gt;2&lt;/text:span&gt;">
> ---8<------------------------------------------------------------
>
> The table:name attribute ends prematurely at the "OrgSubscript". This
> could probably be mended by using single quotes for these attributes
> inside attributes.
>
> 2. again #+CAPTION
>
>    if the caption contains a string with /escaped/ underlines (please
>    note the #+OPTION ^:t)
>    
> ---8<------------------------------------------------------------
> #+OPTIONS:   num:t toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:nil
>
> * First paragraph
> #+CAPTION: YYYYMMDD\_hhmmss.csv. 
> | head 1    | head2    |
> |-----------+----------|
> | content 1 | content2 |
> ---8<------------------------------------------------------------
>
>     The escaped _ is not detected; instead, a literal \ and subscript
>     are detected, and teh document is invalid as above. This escaping
>     seems not to be mentioned in the documentation, probably because it
>     is no longer valid. Might be of interest to people who want to
>     convert old documents.
>
> 3. the \ref syntax seems not to work anymore; substituting by \ref{text}
>    by [[text]] worked.       
>
> 4. Empty lines between #+NAME and the respective table are no longer tolerated
>
> remarks: I like the new smart quotes. More comfortable than putting in
> the utf characters via C-8-RET (which is handy, though, for simple
> formulae).
>
> Regards
>
> Martin

Re: new odt-exporter: problems with formatting in captions

[Andreas Leha]

martin.guertler@gmx.de (Martin Gürtler) writes:

> Hi,
>
> I just converted a 150 page document I used to convert to odt with the old
> exporter. Following problems occurred:
>
> 1. table with #+CAPTION
>    If the caption contains formatting (~, ==, _, ^), the exporter
>    produces an invalid content.xml.  
>
>    minimal example:
>
> ---8<------------------------------------------------------------
> #+OPTIONS:   num:t toc:nil \n:nil @:t ::t |:t ^:{} -:t f:t *:t <:nil
>
> * First paragraph
> #+CAPTION: A_{1}^{2}
> | head 1    | head2    |
> |-----------+----------|
> | content 1 | content2 |
> ---8<------------------------------------------------------------
>
> The problem can be seen in the following xml fragment:
>
> ---8<------------------------------------------------------------
> <table:table table:style-name="OrgTable" 
>  table:name="A&lt;text:span 
>  text:style-name="OrgSubscript"&gt;1&lt;/text:span&gt;&lt;text:span 
>  text:style-name="OrgSuperscript"&gt;2&lt;/text:span&gt;">
> ---8<------------------------------------------------------------
>
> The table:name attribute ends prematurely at the "OrgSubscript". This
> could probably be mended by using single quotes for these attributes
> inside attributes.
>
> 2. again #+CAPTION
>
>    if the caption contains a string with /escaped/ underlines (please
>    note the #+OPTION ^:t)
>    
> ---8<------------------------------------------------------------
> #+OPTIONS:   num:t toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t <:nil
>
> * First paragraph
> #+CAPTION: YYYYMMDD\_hhmmss.csv. 
> | head 1    | head2    |
> |-----------+----------|
> | content 1 | content2 |
> ---8<------------------------------------------------------------
>
>     The escaped _ is not detected; instead, a literal \ and subscript
>     are detected, and teh document is invalid as above. This escaping
>     seems not to be mentioned in the documentation, probably because it
>     is no longer valid. Might be of interest to people who want to
>     convert old documents.
>
> 3. the \ref syntax seems not to work anymore; substituting by \ref{text}
>    by [[text]] worked.       
>
> 4. Empty lines between #+NAME and the respective table are no longer tolerated
>
> remarks: I like the new smart quotes. More comfortable than putting in
> the utf characters via C-8-RET (which is handy, though, for simple
> formulae).
>
> Regards
>
> Martin


Hi Martin,

I think 1-2 are related to an earlier report [fn:1].  As it seems this
is on the todo-list of the right person.

Regards,
Andreas



Footnotes:

[fn:1] http://article.gmane.org/gmane.emacs.orgmode/77937

Re: new odt-exporter: problems with formatting in captions

[Martin Gürtler]

>>>>> "J" == Jambunathan K <kjambunathan@gmail.com> writes:

J> NOTE: If someone knows how to accommodate short captions (so that an
J> that an Index/TOC could be generated from within LibreOffice based on
J> it, please let me know.)

The openDocument standard says in 7.4.1

Use Caption
Each object contained in a text document has a name. In addition, images also have a caption.
The image caption or the image name can be gathered for the index of illustrations.

<define name="text-illustration-index-source-attrs" combine="interleave">
<optional>
<attribute name="text:use-caption" a:defaultValue="true">
<ref name="boolean"/>
</attribute>
</optional>
</define>

Looks to me like one should have #+NAME and #+CAPTION in the org file,
I'd consider the former a candidate for the short caption.

HTH,

Martin