emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [PATCH] doc/org-manual.org: Document `org-latex-src-block-backend'
@ 2023-05-12 13:24 Ihor Radchenko
  2023-05-24  4:03 ` Nick Dokos
  0 siblings, 1 reply; 5+ messages in thread
From: Ihor Radchenko @ 2023-05-12 13:24 UTC (permalink / raw)
  To: emacs-orgmode

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


Attaching tentative manual patch that explains about
`org-latex-src-block-backend'. There was no explanation about different
ways to export colored source blocks in the past.

Please try to read and let me know if anything is confusing.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-org-manual.org-Document-org-latex-src-block-back.patch --]
[-- Type: text/x-patch, Size: 2026 bytes --]

From fb77ae66d4d9c01a350140481bcb0f030a45fb69 Mon Sep 17 00:00:00 2001
Message-Id: <fb77ae66d4d9c01a350140481bcb0f030a45fb69.1683897756.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Fri, 12 May 2023 15:21:59 +0200
Subject: [PATCH] doc/org-manual.org: Document `org-latex-src-block-backend'

* doc/org-manual.org (Source blocks in LaTeX export): Explain possible
LaTeX export options for source blocks.
---
 doc/org-manual.org | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index ba9fdaf20..4e56a1e00 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -14181,6 +14181,37 @@ *** Source blocks in LaTeX export
 #+cindex: source blocks, in @LaTeX{} export
 #+cindex: @samp{ATTR_LATEX}, keyword
 
+#+vindex: org-latex-src-block-backend
+LaTeX export backend provides multiple ways to render src blocks in
+LaTeX, according to the value of ~org-latex-src-block-backend~:
+
+- =verbatim= (default) ::
+
+  Use =verbatim= LaTeX environment with no language-specific
+  fontification.
+
+- =listings= ::
+
+  Use =listings= environment provided by the corresponding LaTeX
+  package.  Org will not add the =listings= package to LaTeX preamble,
+  users need to customize ~org-latex-packages-alist~ or LaTeX headers
+  manually.
+
+- =minted= ::
+
+  Use more syntax-aware =minted= package.  Note that in addition to
+  customizing the LaTeX preamble, [[https://pygments.org][pygments]]
+  program should be installed and ~org-latex-pdf-process~ should pass
+  =-shell-escape= option to LaTeX executable.
+
+- =engraved= ::
+
+  Use =fvextra= LaTeX package and Emacs package
+  [[https://elpa.gnu.org/packages/engrave-faces][engrave-faces]]
+  available on GNU Elpa.  =engrave-faces= will use Emacs fontification
+  to colorize the source blocks in LaTeX output.
+
+
 The LaTeX export backend can make source code blocks into floating
 objects through the attributes =:float= and =:options=.  For =:float=:
 
-- 
2.40.0


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


-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

^ permalink raw reply related	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2023-06-03  8:29 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-12 13:24 [PATCH] doc/org-manual.org: Document `org-latex-src-block-backend' Ihor Radchenko
2023-05-24  4:03 ` Nick Dokos
2023-05-30 15:27   ` [PATCH v2] " Ihor Radchenko
2023-05-31  2:50     ` Nick Dokos
2023-06-03  8:33     ` Ihor Radchenko

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