[ox/ox-latex] Footnotes in titles

[ox/ox-latex] Footnotes in titles

[Rasmus]

Hi,

Consider the following example

    #+TITLE: [ox-latex, bug] footnotes in titles[fn:1]
    #+AUTHOR: Rasmus[fn:2]

    [fn:1] I'd like to thank Nicolas for considering this bug
    [fn:2] spammer of the org mailing list

The desired ox-latex output is something like:

    \author{Rasmus\thanks{spammer of the org mailing list}}
    \title{[ox-latex, bug] footnotes in titles%
      \thanks{I'd like to thank Nicolas for considering this bug}}

But actual output is something like:

    \author{Rasmus\footnotemark[nil]{}}
    \date{\today}
    \title{[ox-latex, bug] footnotes in titles\footnotemark[nil]{}}

It's not too bad: ox-html breaks on this document.

I guess it's a limitation of org-element, since 

    (org-element-map (org-element-parse-buffer) 'footnote-reference
                     (lambda (fn) (org-element-property :label fn)))
    => ("fn:2")                 

Footnote in titles are often used for acknowledgments.
Footnote for authors are sometimes for associations.

Is the current treatment the desired treatment?

Thanks,
Rasmus

-- 
Hooray!

Re: [ox/ox-latex] Footnotes in titles

[Nicolas Goaziou]

Hello,

Rasmus <rasmus@gmx.us> writes:

> Consider the following example
>
>     #+TITLE: [ox-latex, bug] footnotes in titles[fn:1]
>     #+AUTHOR: Rasmus[fn:2]
>
>     [fn:1] I'd like to thank Nicolas for considering this bug
>     [fn:2] spammer of the org mailing list
>
> The desired ox-latex output is something like:
>
>     \author{Rasmus\thanks{spammer of the org mailing list}}
>     \title{[ox-latex, bug] footnotes in titles%
>       \thanks{I'd like to thank Nicolas for considering this bug}}
>
> But actual output is something like:
>
>     \author{Rasmus\footnotemark[nil]{}}
>     \date{\today}
>     \title{[ox-latex, bug] footnotes in titles\footnotemark[nil]{}}
>
> It's not too bad: ox-html breaks on this document.
>
> I guess it's a limitation of org-element, since 
>
>     (org-element-map (org-element-parse-buffer) 'footnote-reference
>                      (lambda (fn) (org-element-property :label fn)))
>     => ("fn:2")                 
>
> Footnote in titles are often used for acknowledgments.
> Footnote for authors are sometimes for associations.
>
> Is the current treatment the desired treatment?

In fact, I have a local branch that tries to properly support footnotes
in TITLE. However, I don't think it can work in the general case.

Indeed, there is no way for the export process to know whether the title
is going to be exported or not. Note that :with-title is not sufficient,
because the export back-end may ignore its value. Current export could
also be "body only", but, again, some back-ends may use title within
body, and not template. During a "subtree" export, the TITLE keyword
could be overridden by an EXPORT_TITLE property...

If the export process cannot have this information,
`org-export-get-footnote-number' and
`org-export-footnote-first-reference-p' return values are not reliable
anymore.

As a consequence, I have /another/ local branch that disables footnotes
in keywords altogether.


Regards,

-- 
Nicolas Goaziou

Re: [ox/ox-latex] Footnotes in titles

[Rasmus]

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> Indeed, there is no way for the export process to know whether the title
> is going to be exported or not. Note that :with-title is not sufficient,
> because the export back-end may ignore its value. Current export could
> also be "body only", but, again, some back-ends may use title within
> body, and not template. During a "subtree" export, the TITLE keyword
> could be overridden by an EXPORT_TITLE property...

But footnotes in titles are set with symbols, e.g. * † ‡ and so forth.
IOW they are independent of the regular footnote counter, and don't
consume a number.

Footnotes in EXPORT_TITLE properties would be weird.  I don't know if you
can have that.  You tell me.

—Rasmus

-- 
Tack, ni svenska vakttorn. Med plutonium tvingar vi dansken på knä!

Re: [ox/ox-latex] Footnotes in titles

[Nicolas Goaziou]

Rasmus <rasmus@gmx.us> writes:

> But footnotes in titles are set with symbols, e.g. * † ‡ and so forth.
> IOW they are independent of the regular footnote counter, and don't
> consume a number.

But then it requires to implement a special handler in every export
back-end and probably helper functions in ox.el. There are also DATE and
AUTHOR to consider.

> Footnotes in EXPORT_TITLE properties would be weird.  I don't know if you
> can have that.  You tell me.

This is not possible. But then, it is asymmetric if we allow footnotes
in TITLE.

For now, I pushed the "no footnote reference in keywords" branch, just
to be on the safe side wrt CAPTION keywords.

We can still discuss about making a special case for TITLE and al.

Regards,

Re: [ox/ox-latex] Footnotes in titles

[Rasmus]

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> Rasmus <rasmus@gmx.us> writes:
>
>> But footnotes in titles are set with symbols, e.g. * † ‡ and so forth.
>> IOW they are independent of the regular footnote counter, and don't
>> consume a number.
>
> But then it requires to implement a special handler in every export
> back-end and probably helper functions in ox.el. There are also DATE and
> AUTHOR to consider.

I didn't grasp the workings of the footnote functionality in ox so excuse
my ignorance.

Would it not be possible to allow different "counters"?  (Like LaTeX).  So
that for org-element-document-properties (at least author and title), one
would use the ox footnote functionality with an auxiliary counter.  

On the backend-side LaTeX would work normally but use \thanks.  In html
fancy entities would be used instead of arabic numbers.  Same in ox-ascii.

>> Footnotes in EXPORT_TITLE properties would be weird.  I don't know if you
>> can have that.  You tell me.
>
> This is not possible. But then, it is asymmetric if we allow footnotes
> in TITLE.

OK with me.  How about inline footnotes in properties?

 :export_title: My Title[fn::X helped a lot].

—Rasmus

-- 
Don't panic!!!