emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: hugo@heagren.com
To: Emacs Orgmode <emacs-orgmode@gnu.org>
Subject: [PATCH] lisp/ox-latex.el: put labels inside example blocks
Date: Thu, 01 Dec 2022 23:36:04 +0000	[thread overview]
Message-ID: <fe3a0278c9f0e006e5ef46bd3df415fe@heagren.com> (raw)

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

I exported an essay written in org mode to a LaTeX file (and then a pdf)
today. It had `example' blocks in several consequent sections, each with
a name (i.e. `#+name'). I have `org-latex-prefer-user-labels' set to t,
and used these names to refer to the examples later on.

I noticed that some of these labels were resolved wrong (i.e. printed as
the wrong number) in the resulting pdf. Examining the tex source, this
was because the labels had been printed outside (just before) the
example blocks, thus:

,---
|  \label{ex:foo}
|  \begin{example}
|     My example here
|  \end{example}
`---


In tnhese cases, sometimes LaTeX interpreted the surrounding section as
the subject of the label, and printed the number of that section when
the label was referred to.

The attached patch forces example environments to be printed thus:

,---
|  \begin{example}\label{ex:foo}
|     My example here
|  \end{example}
`---

This solves the problem.

The logic/conditions for when to print a label, and how it is generated
remain unchanged.

Hope this is helpful for someone else too!

Hugo

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-lisp-ox-latex.el-put-labels-inside-example-blocks.patch --]
[-- Type: text/x-diff; name=0001-lisp-ox-latex.el-put-labels-inside-example-blocks.patch, Size: 1423 bytes --]

From ce920752084eaa776a885d403c18ddd981e92203 Mon Sep 17 00:00:00 2001
From: Hugo Heagren <hugo@heagren.com>
Date: Thu, 1 Dec 2022 23:24:10 +0000
Subject: [PATCH] lisp/ox-latex.el: put labels inside example blocks

* lisp/ox-latex.el (org-latex-example-block): Instead of
`org-latex--wrap-label', manually add label after
\begin{<environment>}.

This produces proper label resolution in LaTeX. Labels before the
environment begins can be interpreted as referring to the surrounding
section.
---
 lisp/ox-latex.el | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el
index 3d18ee7ff..10e4292d2 100644
--- a/lisp/ox-latex.el
+++ b/lisp/ox-latex.el
@@ -2127,13 +2127,13 @@ information."
     (let ((environment (or (org-export-read-attribute
 			    :attr_latex example-block :environment)
 			   "verbatim")))
-      (org-latex--wrap-label
-       example-block
-       (format "\\begin{%s}\n%s\\end{%s}"
-	       environment
-	       (org-export-format-code-default example-block info)
-	       environment)
-       info))))
+      (format "\\begin{%s}%s\n%s\\end{%s}"
+	      environment
+              (if (org-element-property :name example-block)
+                  (org-latex--label example-block info nil 'full)
+                "")
+	      (org-export-format-code-default example-block info)
+	      environment))))
 
 
 ;;;; Export Block
-- 
2.20.1


             reply	other threads:[~2022-12-01 23:37 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-01 23:36 hugo [this message]
2022-12-08 11:39 ` [PATCH] lisp/ox-latex.el: put labels inside example blocks Ihor Radchenko
2022-12-08 12:36   ` Max Nikulin
2022-12-08 12:46     ` Ihor Radchenko
2022-12-08 12:54       ` Ihor Radchenko

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=fe3a0278c9f0e006e5ef46bd3df415fe@heagren.com \
    --to=hugo@heagren.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).