LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Rudolf Adamkovič]

REPRODUCTION:

1. Create a file containing:

   #+OPTIONS: num:nil
   
   * Test
   :PROPERTIES:
   :ALT_TITLE: alt
   :END:
   
   This is a test.

2. Open the file.
3. Export to a PDF file with LaTeX.

EXPECTED:

  Test

  This is a test.

ACTUAL:

  [
  alt]Test This is a test.

Rudy
-- 
"Programming reliably -- must be an activity of an undeniably
mathematical nature […] You see, mathematics is about thinking, and
doing mathematics is always trying to think as well as possible."
--- Edsger W. Dijkstra, 1981

Rudolf Adamkovič <rudolf@adamkovic.org> [he/him]
http://adamkovic.org

Re: LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Ihor Radchenko]

Rudolf Adamkovič <rudolf@adamkovic.org> writes:

> REPRODUCTION:
>
> 1. Create a file containing:
>
>    #+OPTIONS: num:nil
>    
>    * Test
>    :PROPERTIES:
>    :ALT_TITLE: alt
>    :END:
>    
>    This is a test.
>
> 2. Open the file.
> 3. Export to a PDF file with LaTeX.

Confirmed.
This is because [<alt-title>] is inserted into the sectioning command
unconditionally, regardless whether sectioning command supports such an
optional argument.

I suspect that the proper way to handle this problem is changing
structure of `org-latex-classes' to explicitly specify alt-title
placeholder.

-- 
Ihor Radchenko // yantar92,
Org mode maintainer,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Pedro Andres Aranda Gutierrez]

Hi Rudolf,

After playing around with the generated LaTeX in overleaf, I have to conclude that the problem is that ALT_TITLE should be not generated for unnumbered chapters, sections, etc. As far as my LaTeX goes, you use the [alt_title] to get something different in the TOC, so it makes no sense and LaTeX doesn’t cater for it.

Solutions from the org-mode side: 
1. You don’t use ALT_TITLE if section is unnumbered (easier)
2. We make org-mode throw an error in this case (???)

Discussion open ;-)

Seasons greetings,
/PA

Re: LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Pedro Andres Aranda Gutierrez]

A MWE:

——
\documentclass{article}

\title{test}
\author{paranda }
\date{December 2024}

\begin{document}

\maketitle
\tableofcontents

\section{Introduction}

\subsection[Sub - shown 1]{Sub intro - shown}
This section shows up with a modified heading
\subsection*{Sub intro - hidden}
This subsection doesn't show up in the ToC
\subsection{Sub intro - shown 2}
This subsection shows up as is in the ToC
\end{document}
—— 
> El 26 dic 2024, a las 18:08, Pedro Andres Aranda Gutierrez <paaguti@gmail.com> escribió:
> 
> Hi Rudolf,
> 
> After playing around with the generated LaTeX in overleaf, I have to conclude that the problem is that ALT_TITLE should be not generated for unnumbered chapters, sections, etc. As far as my LaTeX goes, you use the [alt_title] to get something different in the TOC, so it makes no sense and LaTeX doesn’t cater for it.
> 
> Solutions from the org-mode side: 
> 1. You don’t use ALT_TITLE if section is unnumbered (easier)
> 2. We make org-mode throw an error in this case (???)
> 
> Discussion open ;-)
> 
> Seasons greetings,
> /PA

Re: LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Pedro Andres Aranda Gutierrez]

[-- Attachment #1.1: Type: text/plain, Size: 2064 bytes --]

Hi,

A quick fix (on main) attached. With this ALT_TITLE is ignored in the
document with #+OPTIONS: num:nil and if #+OPTIONS: num:t and :PROPERTIES:
:UNNUMBERED: t

MWE:
----
#+OPTIONS: num:t

* Test
:PROPERTIES:
:UNNUMBERED: t
:ALT_TITLE: alt
:END:

This is a test.

* Numbered test
:PROPERTIES:
:alt_title: alt numbered
:END:

This is the second part of the test.
----

PS: maybe a rework of this part to make it more readable could be
desirable....

Seasons greetings, /PA

On Thu, 26 Dec 2024 at 18:15, Pedro Andres Aranda Gutierrez <
paaguti@gmail.com> wrote:

> A MWE:
>
> ——
> \documentclass{article}
>
> \title{test}
> \author{paranda }
> \date{December 2024}
>
> \begin{document}
>
> \maketitle
> \tableofcontents
>
> \section{Introduction}
>
> \subsection[Sub - shown 1]{Sub intro - shown}
> This section shows up with a modified heading
> \subsection*{Sub intro - hidden}
> This subsection doesn't show up in the ToC
> \subsection{Sub intro - shown 2}
> This subsection shows up as is in the ToC
> \end{document}
> ——
> > El 26 dic 2024, a las 18:08, Pedro Andres Aranda Gutierrez <
> paaguti@gmail.com> escribió:
> >
> > Hi Rudolf,
> >
> > After playing around with the generated LaTeX in overleaf, I have to
> conclude that the problem is that ALT_TITLE should be not generated for
> unnumbered chapters, sections, etc. As far as my LaTeX goes, you use the
> [alt_title] to get something different in the TOC, so it makes no sense and
> LaTeX doesn’t cater for it.
> >
> > Solutions from the org-mode side:
> > 1. You don’t use ALT_TITLE if section is unnumbered (easier)
> > 2. We make org-mode throw an error in this case (???)
> >
> > Discussion open ;-)
> >
> > Seasons greetings,
> > /PA
>
>

-- 
Fragen sind nicht da, um beantwortet zu werden,
Fragen sind da um gestellt zu werden
Georg Kreisler

Headaches with a Juju log:
unit-basic-16: 09:17:36 WARNING juju.worker.uniter.operation we should run
a leader-deposed hook here, but we can't yet

[-- Attachment #1.2: Type: text/html, Size: 2944 bytes --]

[-- Attachment #2: fix.diff --]
[-- Type: text/x-patch, Size: 899 bytes --]

diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el
index 4b2e797d0..6507a1c42 100644
--- a/lisp/ox-latex.el
+++ b/lisp/ox-latex.el
@@ -2402,10 +2402,10 @@ holding contextual information."
 				  (string-match-p "\\<local\\>" v)
 				  (format "\\stopcontents[level-%d]" level)))))
 		    info t)))))
-	  (if (and (or (and opt-title (not (equal opt-title full-text)))
+	  (if (and numberedp (or (and opt-title (not (equal opt-title full-text)))
                        ;; Heading contains footnotes.  Add optional title
                        ;; version without footnotes to avoid footnotes in
-                       ;; TOC/footers.
+                       ;; TOC/footers for numbered sections *only*
                        (and (not (equal full-text-no-footnote full-text))
                             (setq opt-title full-text-no-footnote)))
 		   (string-match "\\`\\\\\\(.+?\\){" section-fmt))

Re: LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Ihor Radchenko]

Pedro Andres Aranda Gutierrez <paaguti@gmail.com> writes:

> A quick fix (on main) attached. With this ALT_TITLE is ignored in the
> document with #+OPTIONS: num:nil and if #+OPTIONS: num:t and :PROPERTIES:
> :UNNUMBERED: t

Thanks!
I am slightly concerned about generality of dropping ALT_TITLE from
unnumbered sectioning command.

From LaTeX2e reference manual, I see

    Structure your text into divisions: parts, chapters, sections, etc. All sectioning commands
    have the same form, one of:
    
      sectioning-command{title}
      sectioning-command*{title}
      sectioning-command[toc-title]{title}

But can we assume that unnumbered entries never appear in the table of
contents?

> MWE:
> ----
> #+OPTIONS: num:t
>
> * Test
> :PROPERTIES:
> :UNNUMBERED: t
> :ALT_TITLE: alt
> :END:
>
> This is a test.
>
> * Numbered test
> :PROPERTIES:
> :alt_title: alt numbered
> :END:
>
> This is the second part of the test.
> ----
>
> PS: maybe a rework of this part to make it more readable could be
> desirable....

Even better would be a test and a proper patch with commit message.
Do you have time for that?

-- 
Ihor Radchenko // yantar92,
Org mode maintainer,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Pedro Andres Aranda Gutierrez]

[-- Attachment #1: Type: text/plain, Size: 2429 bytes --]

Hi

On Fri, 27 Dec 2024 at 18:42, Ihor Radchenko <yantar92@posteo.net> wrote:

> Pedro Andres Aranda Gutierrez <paaguti@gmail.com> writes:
>
> > A quick fix (on main) attached. With this ALT_TITLE is ignored in the
> > document with #+OPTIONS: num:nil and if #+OPTIONS: num:t and :PROPERTIES:
> > :UNNUMBERED: t
>
> Thanks!
> I am slightly concerned about generality of dropping ALT_TITLE from
> unnumbered sectioning command.
>
> From LaTeX2e reference manual, I see
>
>     Structure your text into divisions: parts, chapters, sections, etc.
> All sectioning commands
>     have the same form, one of:
>
>       sectioning-command{title}
>       sectioning-command*{title}
>       sectioning-command[toc-title]{title}
>
> But can we assume that unnumbered entries never appear in the table of
> contents?
>

I do think we can. Unnumbered sectioning commands never appear in the ToC...
Unless you use additional magic like, for example,
https://tex.stackexchange.com/questions/11668/adding-unnumbered-sections-to-toc
.
So I suppose the quick fix is what I sent and then we can try to implement
something like:
```

\section*{Introduction}\addcontentsline{toc}{section}{Introduction}

```
or
```

% Package 'hyperref' needed for command
'\nameref'\section*{Introduction}\label{sec:intro}

\addcontentsline{toc}{section}{\nameref{sec:intro}}
```
Although it goes quite against the \section vs \section* philosophy and it
would need more that a quick fix.

Best, /PA


> > MWE:
> > ----
> > #+OPTIONS: num:t
> >
> > * Test
> > :PROPERTIES:
> > :UNNUMBERED: t
> > :ALT_TITLE: alt
> > :END:
> >
> > This is a test.
> >
> > * Numbered test
> > :PROPERTIES:
> > :alt_title: alt numbered
> > :END:
> >
> > This is the second part of the test.
> > ----
> >
> > PS: maybe a rework of this part to make it more readable could be
> > desirable....
>
> Even better would be a test and a proper patch with commit message.
> Do you have time for that?
>
> --
> Ihor Radchenko // yantar92,
> Org mode maintainer,
> Learn more about Org mode at <https://orgmode.org/>.
> Support Org development at <https://liberapay.com/org-mode>,
> or support my work at <https://liberapay.com/yantar92>
>


-- 
Fragen sind nicht da, um beantwortet zu werden,
Fragen sind da um gestellt zu werden
Georg Kreisler

Headaches with a Juju log:
unit-basic-16: 09:17:36 WARNING juju.worker.uniter.operation we should run
a leader-deposed hook here, but we can't yet

[-- Attachment #2: Type: text/html, Size: 8442 bytes --]

Re: LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Ihor Radchenko]

Pedro Andres Aranda Gutierrez <paaguti@gmail.com> writes:

>> I am slightly concerned about generality of dropping ALT_TITLE from
>> unnumbered sectioning command.
> ...
> I do think we can. Unnumbered sectioning commands never appear in the ToC...
> Unless you use additional magic like, ...

Good. I am not concerned about hacks, I am concerned about users who
customized `org-latex-classes' to use something non-standard for
sectioning.

But if doing so is not expected in general, I'd rather accept your fix
until someone comes and complains. Fixing the existing bug with default
settings is more important than fixing possible bug (affecting less
users) with custom sectioning.

-- 
Ihor Radchenko // yantar92,
Org mode maintainer,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: LaTeX export is broken with 'num:nil` and 'ALT_TITLE`

[Pedro Andres Aranda Gutierrez]

[-- Attachment #1: Type: text/plain, Size: 1396 bytes --]

@Rudolf, WDYT?
How can I phrase it? It looks like you were trying something that LaTeX
doesn't allow...

Best, /PA

On Fri, 27 Dec 2024 at 19:00, Ihor Radchenko <yantar92@posteo.net> wrote:

> Pedro Andres Aranda Gutierrez <paaguti@gmail.com> writes:
>
> >> I am slightly concerned about generality of dropping ALT_TITLE from
> >> unnumbered sectioning command.
> > ...
> > I do think we can. Unnumbered sectioning commands never appear in the
> ToC...
> > Unless you use additional magic like, ...
>
> Good. I am not concerned about hacks, I am concerned about users who
> customized `org-latex-classes' to use something non-standard for
> sectioning.
>
> But if doing so is not expected in general, I'd rather accept your fix
> until someone comes and complains. Fixing the existing bug with default
> settings is more important than fixing possible bug (affecting less
> users) with custom sectioning.
>
> --
> Ihor Radchenko // yantar92,
> Org mode maintainer,
> Learn more about Org mode at <https://orgmode.org/>.
> Support Org development at <https://liberapay.com/org-mode>,
> or support my work at <https://liberapay.com/yantar92>
>


-- 
Fragen sind nicht da, um beantwortet zu werden,
Fragen sind da um gestellt zu werden
Georg Kreisler

Headaches with a Juju log:
unit-basic-16: 09:17:36 WARNING juju.worker.uniter.operation we should run
a leader-deposed hook here, but we can't yet

[-- Attachment #2: Type: text/html, Size: 2397 bytes --]