Re: [PATCH] babel latex headers and image generation commands
Matt Huszagh writes: >> Can you provide a patch against etc/ORG-NEWS announce this? > > Attached. Let me know what you think. Applied (2af68d6a4) with a minor modification in the headline. Thanks, -- Bastien
Re: [PATCH] babel latex headers and image generation commands
Bastien writes: > sorry for the delayed answer. No worries! > Can you provide a patch against etc/ORG-NEWS announce this? Attached. Let me know what you think. Matt >From 51fb3ef9843ae45884803142f150c5d2f4f4d4c9 Mon Sep 17 00:00:00 2001 From: Matt Huszagh Date: Sat, 24 Oct 2020 09:36:56 -0700 Subject: [PATCH] etc/ORG-NEWS: Describe new behavior of babel LaTeX SVG images --- etc/ORG-NEWS | 22 ++ 1 file changed, 22 insertions(+) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 7f935bf52..b9b0c1271 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -35,6 +35,28 @@ omit a file description was to omit the header argument entirely, which made it difficult/impossible to provide a default value for =file-desc=. +*** New behavior for babel LaTeX SVG image files + +Org babel now uses a two-stage process for converting latex source +blocks to SVG image files (when the extension of the output file is +~.svg~). The first stage in the process converts the latex block into +a PDF file, which is then converted into an SVG file in the second +stage. The TeX->PDF part uses the existing infrastructure for +~org-babel-latex-tex-to-pdf~. The PDF->SVG part uses a command +specified in a new customization, +~org-babel-latex-pdf-svg-process~. By default, this uses inkscape for +conversion, but since it is fully customizable, any other command can +be used in its place. For instance, dvisvgm might be used here. This +two-part processing replaces the previous use of htlatex to process +LaTeX directly to SVG (htlatex is still used for HTML conversion). + +Conversion to SVG exposes a number of additional customizations that +give the user full control over the contents of the latex source +block. ~org-babel-latex-preamble~, ~org-babel-latex-begin-env~ and +~org-babel-latex-end-env~ are new customization options added to allow +the user to specify the preamble and code that preceedes and proceeds +the contents of the source block. + ** New features *** =ob-python= improvements to =:return= header argument -- 2.28.0
Re: [PATCH] babel latex headers and image generation commands
Hi Matt, sorry for the delayed answer. Matt Huszagh writes: > Bastien writes: > >> Prefer >> >> * lisp/ob-latex.el (org-babel-latex-preamble): New option for LaTeX >> preamble customization. >> >> "New option" is quite standard, an "option" being a customizable >> variable. In this case, "New option" would probably be enough, given >> the name of the option is quite self-explanatory. Also, some find it >> pedantic, but "LaTeX" is the correct spelling in a changelog I guess. > > Fixed in new patch (attached). Applied as ae35a3459, thanks! >> The first line of the docstring should contain a sentence, so you'd >> need to have a new paragraph after "runtime to the LaTeX preamble." > > Also fixed. Making the first line a full sentence means that some lines > are a little longer than 80 characters. Is this acceptable? > >> What for users who don't have inkscape? > > This is just a default, but I could use a dvisvgm command as the default > instead? Either way, converting a PDF to SVG will require an executable > outside Emacs, but I guess dvisvgm is more likely to be installed for > people using a texlive installation. My personal preference for inkscape > is because it should handle all PDF inputs, whereas there are some cases > where dvisvgm may fail (see > https://github.com/mgieseki/dvisvgm/issues/139) due to changes in > ghostscript. Still, dvisvgm generally does a very good job with PDF > inputs. Let me know your thoughts, I'd be happy to set the default to a > dvisvgm command instead. Let's see what people think when they try it after 9.5. Can you provide a patch against etc/ORG-NEWS announce this? Thanks, -- Bastien
Re: [PATCH] babel latex headers and image generation commands
Bastien writes:
> Prefer
>
> * lisp/ob-latex.el (org-babel-latex-preamble): New option for LaTeX
> preamble customization.
>
> "New option" is quite standard, an "option" being a customizable
> variable. In this case, "New option" would probably be enough, given
> the name of the option is quite self-explanatory. Also, some find it
> pedantic, but "LaTeX" is the correct spelling in a changelog I guess.
Fixed in new patch (attached).
> The first line of the docstring should contain a sentence, so you'd
> need to have a new paragraph after "runtime to the LaTeX preamble."
Also fixed. Making the first line a full sentence means that some lines
are a little longer than 80 characters. Is this acceptable?
> What for users who don't have inkscape?
This is just a default, but I could use a dvisvgm command as the default
instead? Either way, converting a PDF to SVG will require an executable
outside Emacs, but I guess dvisvgm is more likely to be installed for
people using a texlive installation. My personal preference for inkscape
is because it should handle all PDF inputs, whereas there are some cases
where dvisvgm may fail (see
https://github.com/mgieseki/dvisvgm/issues/139) due to changes in
ghostscript. Still, dvisvgm generally does a very good job with PDF
inputs. Let me know your thoughts, I'd be happy to set the default to a
dvisvgm command instead.
Matt
>From 1ff86f2267b653dff225837ccf13ebf417f7ed03 Mon Sep 17 00:00:00 2001
From: Matt Huszagh
Date: Fri, 28 Aug 2020 22:26:05 -0700
Subject: [PATCH] ob-latex.el: Make latex to svg compilation very customizable
* lisp/ob-latex.el (org-babel-latex-preamble): New option for LaTeX
preamble customization.
(org-babel-latex-begin-env): New option for LaTeX document environment
begin customization.
(org-babel-latex-end-env): New option for LaTeX document environment
end customization.
(org-babel-latex-pdf-svg-process): New option for converting a pdf to
svg.
(org-babel-execute:latex): Add specific case for svg generation from
LaTeX block.
---
lisp/ob-latex.el | 59 +---
1 file changed, 56 insertions(+), 3 deletions(-)
diff --git a/lisp/ob-latex.el b/lisp/ob-latex.el
index 4b343dd14..6a4f7a6ba 100644
--- a/lisp/ob-latex.el
+++ b/lisp/ob-latex.el
@@ -66,7 +66,46 @@
"LaTeX-specific header arguments.")
(defcustom org-babel-latex-htlatex "htlatex"
- "The htlatex command to enable conversion of latex to SVG or HTML."
+ "The htlatex command to enable conversion of LaTeX to SVG or HTML."
+ :group 'org-babel
+ :type 'string)
+
+(defcustom org-babel-latex-preamble
+ (lambda (_)
+"\\documentclass[preview]{standalone}
+\\def\\pgfsysdriver{pgfsys-tex4ht.def}
+")
+ "Closure which evaluates at runtime to the LaTeX preamble.
+
+It takes 1 argument which is the parameters of the source block."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-begin-env
+ (lambda (_)
+"\\begin{document}")
+ "Closure which evaluates at runtime to the begin part of the document environment.
+
+It takes 1 argument which is the parameters of the source block.
+This allows adding additional code that will be ignored when
+exporting the literal LaTeX source."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-end-env
+ (lambda (_)
+"\\end{document}")
+ "Closure which evaluates at runtime to the end part of the document environment.
+
+It takes 1 argument which is the parameters of the source block.
+This allows adding additional code that will be ignored when
+exporting the literal LaTeX source."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-pdf-svg-process
+ "inkscape --pdf-poppler %f -T -l -o %O"
+ "Command used to convert a PDF file to an SVG file when executing a latex source block."
:group 'org-babel
:type 'string)
@@ -114,12 +153,26 @@ This function is called by `org-babel-execute-src-block'."
(mapconcat #'identity headers "\n"
(org-create-formula-image
body out-file org-format-latex-options in-buffer)))
+ ((string= "svg" extension)
+ (with-temp-file tex-file
+ (insert (concat (funcall org-babel-latex-preamble params)
+ (mapconcat #'identity headers "\n")
+ (funcall org-babel-latex-begin-env params)
+ body
+ (funcall org-babel-latex-end-env params
+ (let ((tmp-pdf (org-babel-latex-tex-to-pdf tex-file)))
+ (let* ((log-buf (get-buffer-create "*Org Babel LaTeX Output*"))
+ (err-msg "org babel latex failed")
+ (img-out (org-compile-file
+ tmp-pdf
+ (list org-babel-latex-pdf-svg-process)
+ extension err-msg log-buf)))
+(shell-command (format "mv %s %s" img-out out-file)
((string-suffix-p ".tikz" out-file)
(when (file-exists-p out-file) (delete-file out-file))
(with-temp-file out-file
Re: [PATCH] babel latex headers and image generation commands
Hi Matt,
Matt Huszagh writes:
> Matt Huszagh writes:
>
>> I've added a few changes to the patch that additionally allow custom the
>> begin and end document environments. The purpose here is to allow latex
>> code within the document environment that is ignored by the body
>> export. For instance, I can set the page color with
>> {\color{some-color}...} and this doesn't mess up latex exports.
>
> I've fixed a minor bug with the previous patch.
Thanks -- that'd be for after 9.4 of course.
> From 1bcd1d28dde6625d0c648c92243260b46433e1eb Mon Sep 17 00:00:00 2001
> From: Matt Huszagh
> Date: Fri, 28 Aug 2020 22:26:05 -0700
> Subject: [PATCH] ob-latex.el: Make latex to svg compilation very customizable
>
> * lisp/ob-latex.el (org-babel-latex-preamble): Add latex preamble
> customization.
> (org-babel-latex-begin-env): Add latex document environment begin
> customization.
> (org-babel-latex-end-env): Add latex document environment end
> customization.
> (org-babel-latex-pdf-svg-process): Add customization for converting a
> pdf to svg.
> (org-babel-execute:latex): Add specific case for svg generation from
> latex block.
Prefer
* lisp/ob-latex.el (org-babel-latex-preamble): New option for LaTeX
preamble customization.
"New option" is quite standard, an "option" being a customizable
variable. In this case, "New option" would probably be enough, given
the name of the option is quite self-explanatory. Also, some find it
pedantic, but "LaTeX" is the correct spelling in a changelog I guess.
> +(defcustom org-babel-latex-preamble
> + (lambda (_)
> +"\\documentclass[preview]{standalone}
> +\\def\\pgfsysdriver{pgfsys-tex4ht.def}
> +")
> + "Closure which evaluates at runtime to the latex preamble. It
> +takes 1 argument which is the parameters of the source block."
> + :group 'org-babel
> + :type 'function)
The first line of the docstring should contain a sentence, so you'd
need to have a new paragraph after "runtime to the LaTeX preamble."
> +(defcustom org-babel-latex-pdf-svg-process
> + "inkscape --pdf-poppler %f -T -l -o %O"
> + "Command used to convert a PDF file to an SVG file when
> +executing a latex source block."
> + :group 'org-babel
> + :type 'string)
What for users who don't have inkscape?
Thanks,
--
Bastien
Re: [PATCH] babel latex headers and image generation commands
Matt Huszagh writes:
> I've added a few changes to the patch that additionally allow custom the
> begin and end document environments. The purpose here is to allow latex
> code within the document environment that is ignored by the body
> export. For instance, I can set the page color with
> {\color{some-color}...} and this doesn't mess up latex exports.
I've fixed a minor bug with the previous patch.
>From 1bcd1d28dde6625d0c648c92243260b46433e1eb Mon Sep 17 00:00:00 2001
From: Matt Huszagh
Date: Fri, 28 Aug 2020 22:26:05 -0700
Subject: [PATCH] ob-latex.el: Make latex to svg compilation very customizable
* lisp/ob-latex.el (org-babel-latex-preamble): Add latex preamble
customization.
(org-babel-latex-begin-env): Add latex document environment begin
customization.
(org-babel-latex-end-env): Add latex document environment end
customization.
(org-babel-latex-pdf-svg-process): Add customization for converting a
pdf to svg.
(org-babel-execute:latex): Add specific case for svg generation from
latex block.
---
lisp/ob-latex.el | 57 ++--
1 file changed, 55 insertions(+), 2 deletions(-)
diff --git a/lisp/ob-latex.el b/lisp/ob-latex.el
index 4b343dd14..991873e2e 100644
--- a/lisp/ob-latex.el
+++ b/lisp/ob-latex.el
@@ -70,6 +70,45 @@
:group 'org-babel
:type 'string)
+(defcustom org-babel-latex-preamble
+ (lambda (_)
+"\\documentclass[preview]{standalone}
+\\def\\pgfsysdriver{pgfsys-tex4ht.def}
+")
+ "Closure which evaluates at runtime to the latex preamble. It
+takes 1 argument which is the parameters of the source block."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-begin-env
+ (lambda (_)
+"\\begin{document}")
+ "Closure which evaluates at runtime to the begin part of the
+document environment. It takes 1 argument which is the
+parameters of the source block. This allows adding additional
+code that will be ignored when exporting the literal latex
+source."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-end-env
+ (lambda (_)
+"\\end{document}")
+ "Closure which evaluates at runtime to the end part of the
+document environment. It takes 1 argument which is the
+parameters of the source block. This allows adding additional
+code that will be ignored when exporting the literal latex
+source."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-pdf-svg-process
+ "inkscape --pdf-poppler %f -T -l -o %O"
+ "Command used to convert a PDF file to an SVG file when
+executing a latex source block."
+ :group 'org-babel
+ :type 'string)
+
(defcustom org-babel-latex-htlatex-packages
'("[usenames]{color}" "{tikz}" "{color}" "{listings}" "{amsmath}")
"Packages to use for htlatex export."
@@ -114,12 +153,26 @@ This function is called by `org-babel-execute-src-block'."
(mapconcat #'identity headers "\n"
(org-create-formula-image
body out-file org-format-latex-options in-buffer)))
+ ((string= "svg" extension)
+ (with-temp-file tex-file
+ (insert (concat (funcall org-babel-latex-preamble params)
+ (mapconcat #'identity headers "\n")
+ (funcall org-babel-latex-begin-env params)
+ body
+ (funcall org-babel-latex-end-env params
+ (let ((tmp-pdf (org-babel-latex-tex-to-pdf tex-file)))
+ (let* ((log-buf (get-buffer-create "*Org Babel LaTeX Output*"))
+ (err-msg "org babel latex failed")
+ (img-out (org-compile-file
+ tmp-pdf
+ (list org-babel-latex-pdf-svg-process)
+ extension err-msg log-buf)))
+(shell-command (format "mv %s %s" img-out out-file)
((string-suffix-p ".tikz" out-file)
(when (file-exists-p out-file) (delete-file out-file))
(with-temp-file out-file
(insert body)))
- ((and (or (string= "svg" extension)
- (string= "html" extension))
+ ((and (string= "html" extension)
(executable-find org-babel-latex-htlatex))
;; TODO: this is a very different way of generating the
;; frame latex document than in the pdf case. Ideally, both
--
2.28.0
Re: [PATCH] babel latex headers and image generation commands
Matt Huszagh writes:
> Ok, I've finally gotten around to taking a crack at this. The patch is
> attached. Basically, it allows a lot more control when converting a
> latex source block into an svg image file.
I've added a few changes to the patch that additionally allow custom the
begin and end document environments. The purpose here is to allow latex
code within the document environment that is ignored by the body
export. For instance, I can set the page color with
{\color{some-color}...} and this doesn't mess up latex exports.
Please comment with any questions/concerns/thoughts.
Thanks!
>From 6dbd5ae840f02333f83d40a9c27be06968279563 Mon Sep 17 00:00:00 2001
From: Matt Huszagh
Date: Fri, 28 Aug 2020 22:26:05 -0700
Subject: [PATCH] ob-latex.el: Make latex to svg compilation very customizable
* lisp/ob-latex.el (org-babel-latex-preamble): Add latex preamble
customization.
(org-babel-latex-begin-env): Add latex document environment begin
customization.
(org-babel-latex-end-env): Add latex document environment end
customization.
(org-babel-latex-pdf-svg-process): Add customization for converting a
pdf to svg.
(org-babel-execute:latex): Add specific case for svg generation from
latex block.
---
lisp/ob-latex.el | 57 ++--
1 file changed, 55 insertions(+), 2 deletions(-)
diff --git a/lisp/ob-latex.el b/lisp/ob-latex.el
index 4b343dd14..359179476 100644
--- a/lisp/ob-latex.el
+++ b/lisp/ob-latex.el
@@ -70,6 +70,45 @@
:group 'org-babel
:type 'string)
+(defcustom org-babel-latex-preamble
+ (lambda (_)
+"\\documentclass[preview]{standalone}
+\\def\\pgfsysdriver{pgfsys-tex4ht.def}
+")
+ "Closure which evaluates at runtime to the latex preamble. It
+takes 1 argument which is the parameters of the source block."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-begin-env
+ (lambda (_)
+"\\begin{document}")
+ "Closure which evaluates at runtime to the begin part of the
+document environment. It takes 1 argument which is the
+parameters of the source block. This allows adding additional
+code that will be ignored when exporting the literal latex
+source."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-end-env
+ (lambda (_)
+"\\end{document}")
+ "Closure which evaluates at runtime to the end part of the
+document environment. It takes 1 argument which is the
+parameters of the source block. This allows adding additional
+code that will be ignored when exporting the literal latex
+source."
+ :group 'org-babel
+ :type 'function)
+
+(defcustom org-babel-latex-pdf-svg-process
+ "inkscape --pdf-poppler %f -T -l -o %O"
+ "Command used to convert a PDF file to an SVG file when
+executing a latex source block."
+ :group 'org-babel
+ :type 'string)
+
(defcustom org-babel-latex-htlatex-packages
'("[usenames]{color}" "{tikz}" "{color}" "{listings}" "{amsmath}")
"Packages to use for htlatex export."
@@ -114,12 +153,26 @@ This function is called by `org-babel-execute-src-block'."
(mapconcat #'identity headers "\n"
(org-create-formula-image
body out-file org-format-latex-options in-buffer)))
+ ((string= "svg" extension)
+ (with-temp-file tex-file
+ (insert (concat (funcall org-babel-latex-preamble params)
+ (mapconcat #'identity headers "\n")
+ (funcall org-babel-latex-begin-env)
+ body
+ (funcall org-babel-latex-end-env
+ (let ((tmp-pdf (org-babel-latex-tex-to-pdf tex-file)))
+ (let* ((log-buf (get-buffer-create "*Org Babel LaTeX Output*"))
+ (err-msg "org babel latex failed")
+ (img-out (org-compile-file
+ tmp-pdf
+ (list org-babel-latex-pdf-svg-process)
+ extension err-msg log-buf)))
+(shell-command (format "mv %s %s" img-out out-file)
((string-suffix-p ".tikz" out-file)
(when (file-exists-p out-file) (delete-file out-file))
(with-temp-file out-file
(insert body)))
- ((and (or (string= "svg" extension)
- (string= "html" extension))
+ ((and (string= "html" extension)
(executable-find org-babel-latex-htlatex))
;; TODO: this is a very different way of generating the
;; frame latex document than in the pdf case. Ideally, both
--
2.28.0
