emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Thomas S. Dye" <tsd@tsdye.online>
To: org-mode <emacs-orgmode@gnu.org>
Subject: [PATCH] LaTeX export: arbitrary float environments
Date: Sun, 04 Apr 2021 08:46:18 -1000	[thread overview]
Message-ID: <87o8et6g79.fsf@tsdye.online> (raw)

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

Aloha all,

LaTeX users are able to define arbitrary float types, e.g. with 
the float package.  The attached patch makes them accessible from 
Org mode.

This is a follow on to my efforts several years ago to support the 
Tufte-LaTeX package in Org mode, and a suggestion at the time (by 
Rasmus iirc) to implement an :environment attribute for LaTeX 
export.  This patch achieves a similar goal, but is a bit lighter 

Let me know if you have questions.

All the best,

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: patch --]
[-- Type: text/x-diff, Size: 3545 bytes --]

From 5154901b781f93d08851f96431c976f010fc420c Mon Sep 17 00:00:00 2001
From: "Thomas S. Dye" <tsd@tsdye.online>
Date: Sun, 4 Apr 2021 08:11:40 -1000
Subject: [PATCH] LaTeX export: arbitrary float environments

* lisp/ox-latex.el (`org-latex--inline-image', `org-latex--decorate
table'): recognize arbitrary :float value.

LaTeX users are able to define arbitrary float types.  This patch
makes them accessible from Org mode.

* etc/ORG-NEWS: Announce new :float capability.
 etc/ORG-NEWS     |  6 +++++-
 lisp/ox-latex.el | 16 +++++++++++++++-
 2 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 9fc126b2f..cdfb1c727 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -12,6 +12,10 @@ Please send Org bug reports to mailto:emacs-orgmode@gnu.org.
 * Version 9.5 (not yet released)
 ** New options and settings
+*** LaTeX attribute ~:float~ now passes through arbitrary values
+LaTeX users are able to define arbitrary float types, e.g. with the float package.  The Org mode LaTeX exporter is now able to process and export arbitrary float types.  The user is responsible for ensuring that Org mode configures LaTeX to process any new float type.
 *** Option ~org-hidden-keywords~ now also applies to #+SUBTITLE:
 The option ~org-hidden-keywords~ previously applied
@@ -106,7 +110,7 @@ behavior.
 By default ox-html now inlines webp images.
 ** New features
-*** =ob-python= improvements to =:return= header argument 
+*** =ob-python= improvements to =:return= header argument
 The =:return= header argument in =ob-python= now works for session
 blocks as well as non-session blocks.  Also, it now works with the
diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el
index 376d27a07..514801d7c 100644
--- a/lisp/ox-latex.el
+++ b/lisp/ox-latex.el
@@ -2377,6 +2377,7 @@ used as a communication channel."
 			((string= float "sideways") 'sideways)
 			((string= float "multicolumn") 'multicolumn)
 			((and (plist-member attr :float) (not float)) 'nonfloat)
+                        (float float)
 			((or float
 			     (org-element-property :caption parent)
 			     (org-string-nw-p (plist-get attr :caption)))
@@ -2470,6 +2471,18 @@ used as a communication channel."
 						   nil t))))
     ;; Return proper string, depending on FLOAT.
     (pcase float
+      ((and (pred stringp) env-string)
+       (format "\\begin{%s}%s
+               env-string
+               placement
+               (if caption-above-p caption "")
+               (if center "\\centering" "")
+               comment-include image-code
+               (if caption-above-p "" caption)
+               env-string))
       (`wrap (format "\\begin{wrapfigure}%s
@@ -3200,7 +3213,7 @@ centered."
 (defun org-latex--decorate-table (table attributes caption above? info)
   "Decorate TABLE string with caption and float environment.
-ATTRIBUTES is the plist containing is LaTeX attributes.  CAPTION
+ATTRIBUTES is the plist containing LaTeX attributes.  CAPTION
 is its caption, as a string or nil.  It is located above the
 table if ABOVE? is non-nil.  INFO is the plist containing current
 export parameters.
@@ -3211,6 +3224,7 @@ Return new environment, as a string."
 	    (cond ((and (not float) (plist-member attributes :float)) nil)
 		  ((member float '("sidewaystable" "sideways")) "sidewaystable")
 		  ((equal float "multicolumn") "table*")
+                  (float float)
 		  ((or float (org-string-nw-p caption)) "table")
 		  (t nil))))

[-- Attachment #3: Type: text/plain, Size: 45 bytes --]

Thomas S. Dye

             reply	other threads:[~2021-04-04 18:48 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-04 18:46 Thomas S. Dye [this message]
2021-05-01 11:08 ` Timothy
2021-05-01 17:20   ` Thomas S. Dye
2021-05-01 17:31     ` Timothy
2021-05-15 13:22 ` Bastien

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:

  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=87o8et6g79.fsf@tsdye.online \
    --to=tsd@tsdye.online \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: [PATCH] LaTeX export: arbitrary float environments' \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:


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