emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: Nick Dokos <ndokos@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: [PATCH v2] doc/org-manual.org: Document `org-latex-src-block-backend'
Date: Tue, 30 May 2023 15:27:18 +0000	[thread overview]
Message-ID: <87pm6hdell.fsf@localhost> (raw)
In-Reply-To: <87wn0yz88a.fsf@alphaville.usersys.redhat.com>

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

Nick Dokos <ndokos@gmail.com> writes:

>> Please try to read and let me know if anything is confusing.
> To me, it does not seem necessary to include the various descriptions. Just
> the first three lines of the patch, perhaps with a prompt to consult
> the doc string of the variable which describes these options in
> detail, seems enough IMO.

I feel that we at least need to tell people briefly what is possible.
What about the attached, shorter, patch?

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

From c45b8c6f82bdcbb687c1eb94410fe34d8cee33da Mon Sep 17 00:00:00 2001
Message-Id: <c45b8c6f82bdcbb687c1eb94410fe34d8cee33da.1685460418.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Fri, 12 May 2023 15:21:59 +0200
Subject: [PATCH v2] 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 | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index ab5c10c1d..a86db2848 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -14203,6 +14203,15 @@ *** 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~.  The
+default value =verbatim= renders the src code verbatim, without any
+extra styling.  Alternative values allow more colorful styling, but
+require additional LaTeX (=listings=, =minted=), system (=minted=), or
+Emacs (=engraved=) packages.  See the ~org-latex-src-block-backend~
+docstring for more details.
 The LaTeX export backend can make source code blocks into floating
 objects through the attributes =:float= and =:options=.  For =:float=:

[-- 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>

  reply	other threads:[~2023-05-30 15:24 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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   ` Ihor Radchenko [this message]
2023-05-31  2:50     ` [PATCH v2] " Nick Dokos
2023-06-03  8:33     ` Ihor Radchenko

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=87pm6hdell.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=ndokos@gmail.com \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public 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).