From 15ced3a12b8882292f43eb7351988be4ddf3d63f Mon Sep 17 00:00:00 2001 From: Aaron Ecay Date: Sat, 23 Aug 2014 03:16:11 -0400 Subject: [PATCH] ox-latex: support :float nil with caption for minted listings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * lisp/ox-latex.el (org-latex-src-block): Support :float nil with caption for minted. (org-latex-listings): Edit docstring to describe this usecase. * lisp/org.el (org-latex-default-packages-alist): Add “capt-of” package. This takes advantage of the capt-of package’s \captionof command, which allows to insert a caption (with autogenerated number and \ref-able label) without creating a floating environment. One example of where this is useful is in the case of a minted source code listing that spans more than one page. (Latex floats can’t be larger than a page, generally speaking.) The listings package handles this case using its own mechanism. --- etc/ORG-NEWS | 11 +++++++---- lisp/org.el | 2 ++ lisp/ox-latex.el | 18 +++++++++++++++++- 3 files changed, 26 insertions(+), 5 deletions(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 62181cb..08f813b 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -84,6 +84,9 @@ parameters are now supported: ~:raw~, ~:backend~. Moreover, there are new parameters specific to some pre-defined translators, e.g., ~:environment~ and ~:booktabs~ for ~orgtbl-to-latex~. See translators docstrings (including ~orgtbl-to-generic~) for details. +*** Non-floating minted listings in Latex export +It is not possible to specify =#+attr_latex: :float nil= in conjunction with +source blocks exported by the minted package. ** Miscellaneous *** File names in links accept are now compatible with URI syntax Absolute file names can now start with =///= in addition to =/=. E.g., @@ -137,7 +140,7 @@ So you need to replace : #+HTML_INCLUDE_STYLE: t -by +by : #+OPTIONS: :html-include-style t @@ -191,13 +194,13 @@ of the list. now use =amssymb= symbols by default instead. *** New functions for paragraph motion - + The commands =C-down= and =C-up= now invoke special commands that use knowledge from the org-elements parser to move the cursor in a paragraph-like way. *** New entities in =org-entities.el= - + Add support for ell, imath, jmath, varphi, varpi, aleph, gimel, beth, dalet, cdots, S (§), dag, ddag, colon, therefore, because, triangleq, leq, geq, lessgtr, lesseqgtr, ll, lll, gg, ggg, prec, preceq, @@ -305,7 +308,7 @@ instructions: - when updating through ELPA (either from GNU ELPA or from Org ELPA), you have to install Org's ELPA package in a session where no Org function has been called already. - + When in doubt, run =M-x org-version RET= and see if you have a mixed-up installation. diff --git a/lisp/org.el b/lisp/org.el index cd57ec7..1f023be 100755 --- a/lisp/org.el +++ b/lisp/org.el @@ -4000,6 +4000,7 @@ header, or they will be appended." ("" "marvosym" t) ("" "wasysym" t) ("" "amssymb" t) + ("" "capt-of" nil) ("" "hyperref" nil) "\\tolerance=1000") "Alist of default packages to be inserted in the header. @@ -4021,6 +4022,7 @@ Org mode to function properly: - textcomp, marvosymb, wasysym, amssymb: for various symbols used for interpreting the entities in `org-entities'. You can skip some of these packages if you don't use any of their symbols. +- capt-of: for captions on `:float nil' source blocks - hyperref: for cross references Therefore you should not modify this variable unless you know diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el index f59d6b2..5d0a31c 100644 --- a/lisp/ox-latex.el +++ b/lisp/ox-latex.el @@ -725,6 +725,18 @@ using customize, or with \(require 'ox-latex) \(add-to-list 'org-latex-packages-alist '(\"\" \"minted\")) +You can have listings with a caption which nonetheless do not +float. This is useful in case the source code takes up more than +a page, in which case trying to float it will also truncate it. +To achieve this, you should specifying the following attributes +on the source block: + + #+caption: ... + #+attr_latex: :float no + #+begin_src + ... + #+end_src + In addition, it is necessary to install pygments \(http://pygments.org), and to configure the variable `org-latex-pdf-process' so that the -shell-escape option is @@ -2300,7 +2312,11 @@ contextual information." ((eq listings 'minted) (let* ((caption-str (org-latex--caption/label-string src-block info)) (float-env - (cond ((and (not float) (plist-member attributes :float)) "%s") + (cond ((and (not float) (plist-member attributes :float) caption) + (format "%%s\n%s" (replace-regexp-in-string + "\\\\caption" "\\captionof{listing}" + caption-str t t))) + ((and (not float) (plist-member attributes :float)) "%s") ((string= "multicolumn" float) (format "\\begin{listing*}\n%%s\n%s\\end{listing*}" caption-str)) -- 2.1.0