From mboxrd@z Thu Jan  1 00:00:00 1970
From: Alan Schmitt <alan.schmitt@polytechnique.org>
Subject: Re: interaction between org-latex-custom-lang-environments and name
 when exporting to latex
Date: Fri, 27 Nov 2015 17:27:15 +0100
Message-ID: <m2egfbif18.fsf@wifi-eduroam-161006.inria.fr>
References: <m2ziyertfg.fsf@polytechnique.org>
	<m2d1v59kaq.fsf@charm-ecran.irisa.fr> <877fld3qcr.fsf@gmx.us>
	<m28u5p3r5p.fsf@charm-ecran.irisa.fr> <8737vw1u13.fsf@gmx.us>
	<m2poyz3jnz.fsf@charm-ecran.irisa.fr> <87vb8rbkum.fsf@gmx.us>
	<m2a8q2wlts.fsf@polytechnique.org> <87610qbdvx.fsf@gmx.us>
Mime-Version: 1.0
Content-Type: multipart/signed; boundary="==-=-=";
	micalg=pgp-sha512; protocol="application/pgp-signature"
Return-path: <emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:4830:134:3::10]:59993)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <alan.schmitt@polytechnique.org>) id 1a2Pqr-0003qt-GZ
	for emacs-orgmode@gnu.org; Fri, 27 Nov 2015 15:42:42 -0500
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <alan.schmitt@polytechnique.org>) id 1a2Pqn-0000JA-K7
	for emacs-orgmode@gnu.org; Fri, 27 Nov 2015 15:42:41 -0500
Received: from mail2-relais-roc.national.inria.fr ([192.134.164.83]:58721)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <alan.schmitt@polytechnique.org>) id 1a2Pqn-0000J0-97
	for emacs-orgmode@gnu.org; Fri, 27 Nov 2015 15:42:37 -0500
In-Reply-To: <87610qbdvx.fsf@gmx.us> (rasmus@gmx.us's message of "Wed, 25 Nov
	2015 10:57:06 +0100")
List-Id: "General discussions about Org-mode." <emacs-orgmode.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/emacs-orgmode>
List-Post: <mailto:emacs-orgmode@gnu.org>
List-Help: <mailto:emacs-orgmode-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=subscribe>
Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
To: Rasmus <rasmus@gmx.us>
Cc: emacs-orgmode@gnu.org

--==-=-=
Content-Type: multipart/mixed; boundary="=-=-="

--=-=-=
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable

Hi Rasmus,

Thanks a lot for the great comments. Here is an updated patch, with some
comments on your comments for the thing I did not change.

On 2015-11-25 10:57, Rasmus <rasmus@gmx.us> writes:

>> +  \\begin{listing}
>> +  \\begin{minted}{ocaml}
>> +  <src block body>
>> +  \\end{minted}
>> +  \\caption{<caption>}
>> +  \\label{<label>}
>> +  \\end{listing}")
>
> Nitpick: label should be inside caption in the example to be consistent
> with how captions are normally formatted by ox-latex.  Either way is fine
> though.

I chose this example because it's the code in the minted manual.

> Also, you need to denote that the defcustom was changed.
>
>   :version "25.1"
>   :package-version '(Org . "9.0")
>
> When you are at it, please add the missing tags, :group and :type.

It's not a defcustom but a defvar. (But maybe it should be a defcustom =E2=
=80=A6)


--=-=-=
Content-Type: text/x-patch
Content-Disposition: inline;
 filename=0001-ox-latex-Extend-custom-lang-environments.patch
Content-Transfer-Encoding: quoted-printable

From=20527635c2e674fe1f3ab9d5d3de96e238d0debf7b Mon Sep 17 00:00:00 2001
From: Alan Schmitt <alan.schmitt@polytechnique.org>
Date: Wed, 25 Nov 2015 08:48:58 +0100
Subject: [PATCH] ox-latex: Extend custom-lang-environments

* ox-latex.el (org-latex-custom-lang-environments): Extend the
  documentation string.
* ox-latex.el (org-latex-src-block): Allow a custom language environment
  to be a format string to be directly inserted.
=2D--
 lisp/ox-latex.el | 58 ++++++++++++++++++++++++++++++++++++++++++++--------=
----
 1 file changed, 46 insertions(+), 12 deletions(-)

diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el
index bbf7f41..0a9f7d4 100644
=2D-- a/lisp/ox-latex.el
+++ b/lisp/ox-latex.el
@@ -1025,17 +1025,44 @@ block-specific options, you may use the following s=
yntax:
   "Alist mapping languages to language-specific LaTeX environments.
=20
 It is used during export of src blocks by the listings and minted
=2Dlatex packages.  For example,
+latex packages.  The environment may either be a simple string,
+composed of only letters and numbers.  In this case, the string is
+directly the name of the latex environment to use.  The environment
+may also be a format string.  In this case the format string will be
+directly exported.  This format string may contain these elements:
+
+  %s for the formatted source
+  %c for the caption
+  %f for the float attribute
+  %l for an appropriate label=20
+
+For example,
=20
   (setq org-latex-custom-lang-environments
=2D     '((python \"pythoncode\")))
+     '((python \"pythoncode\")
+       (ocaml \"\\\\begin{listing}
+\\\\begin{minted}{ocaml}
+%s\\\\end{minted}
+\\\\caption{%c}
+\\\\label{%l}\")))
=20
=2Dwould have the effect that if org encounters begin_src python
=2Dduring latex export it will output
+would have the effect that if org encounters a Python source block
+during LaTeX export it will produce
=20
   \\begin{pythoncode}
   <src block body>
=2D  \\end{pythoncode}")
+  \\end{pythoncode}
+
+and if org encounters an Ocaml source block during LaTeX export it
+will produce
+
+  \\begin{listing}
+  \\begin{minted}{ocaml}
+  <src block body>
+  \\end{minted}
+  \\caption{<caption>}
+  \\label{<label>}
+  \\end{listing}")
=20
=20
 ;;;; Compilation
@@ -2756,13 +2783,20 @@ contextual information."
 			   (org-export-format-code-default src-block info))))))
        ;; Case 2.  Custom environment.
        (custom-env
=2D	(let ((caption-str (org-latex--caption/label-string src-block info)))
=2D	  (format "\\begin{%s}\n%s\\end{%s}\n"
=2D		  custom-env
=2D		  (concat (and caption-above-p caption-str)
=2D			  (org-export-format-code-default src-block info)
=2D			  (and (not caption-above-p) caption-str))
=2D		  custom-env)))
+	(let ((caption-str (org-latex--caption/label-string src-block info))
+              (formatted-src (org-export-format-code-default src-block inf=
o)))
+          (if (org-string-match-p "\\`[a-zA-Z0-9]+\\'" custom-env)
+	      (format "\\begin{%s}\n%s\\end{%s}\n"
+		      custom-env
+		      (concat (and caption-above-p caption-str)
+			      formatted-src
+			      (and (not caption-above-p) caption-str))
+		      custom-env)
+	    (format-spec custom-env
+			 `((?s . ,formatted-src)
+			   (?c . ,caption)
+			   (?f . ,float)
+			   (?l . ,(org-latex--label src-block info)))))))
        ;; Case 3.  Use minted package.
        ((eq listings 'minted)
 	(let* ((caption-str (org-latex--caption/label-string src-block info))
=2D-=20
2.6.3


--=-=-=
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable


Best,

Alan

=2D-=20
OpenPGP Key ID : 040D0A3B4ED2E5C7
Athmospheric CO=E2=82=82 (Updated November 22, 2015, Mauna Loa Obs.): 400.3=
5 ppm

--=-=-=--

--==-=-=
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBCgAGBQJWWIRjAAoJEAQNCjtO0uXHBTwIAMWqCqkmHsDMrBq5cnX4rb8B
V7yfX8deGkRXV2SMMhsHSqYE5zyN/IdY/fMSeE95Z3ToHtLDp5InQ6yyHKfs3grd
WdrzHwYxsA0DVmgGb/L9H9mcQDdc4HHsK0i8yXsQExdPI0eD/V75WS6AFNaDtaQL
Xq+nQt0SVKhTHGHgzoAgqrBEFcGUqHrAdNxI/7pyR+nxOEz5Cvy5jTIAhWMlPSaj
A7rdugnQVxAUQ7kqhF8PIY27N6t+dC4RsCHGnyPuIMMT/fjQbiaejslmao41gA21
pMX9fJcZntzz1ZKr1HW4oNarZIsnpA4dLyKLLyOQflVb5NQmcsc+OlYm/CNdCx0=
=th0u
-----END PGP SIGNATURE-----
--==-=-=--