From: "Štěpán Němec" <stepnem@gmail.com>
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: emacs-orgmode@gnu.org
Subject: Re: Org syntax inside verbatim/literal blocks
Date: Thu, 15 Aug 2019 12:16:59 +0200 [thread overview]
Message-ID: <87lfvuohr8.fsf@gmail.com> (raw)
In-Reply-To: <87ef1mg829.fsf@nicolasgoaziou.fr>
[-- Attachment #1: Type: text/plain, Size: 363 bytes --]
> Certainly. Would you want to provide a patch to the manual?
Yes, thank you, patch attached (on top of current maint branch).
I don't know how robust the footnote indexing is, e.g. putting #+cindex
above instead of below [fn] lead to errors during 'make info'; but the
version attached does work (for the texinfo export at least).
--
Štěpán
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-manual-Index-and-link-to-information-on-literal-.patch --]
[-- Type: text/x-patch, Size: 1889 bytes --]
From bcd5049620e938c8687f239c10248db3805de721 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= <stepnem@gmail.com>
Date: Thu, 15 Aug 2019 11:57:17 +0200
Subject: [PATCH] org-manual: Index and link to information on literal block
comma escape
* doc/org-manual.org (Escape Character): Mention comma and link to the "Literal
Examples" section.
(Footnotes): Index explanation of comma escape inside literal blocks.
---
doc/org-manual.org | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 1418abb50..06d5eb262 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -18292,8 +18292,9 @@ init file[fn:146].
You may sometimes want to write text that looks like Org syntax, but
should really read as plain text. Org may use a specific escape
character in some situations, e.g., a backslash in macros (see [[*Macro
-Replacement]]). In the general case, however, we suggest to use the
-zero width space. You can get it with one of the following:
+Replacement]]) or a comma in source code and example blocks (see
+[[*Literal Examples]]). In the general case, however, we suggest to use
+the zero width space. You can get it with one of the following:
: C-x 8 <RET> zero width space <RET>
: C-x 8 <RET> 200B <RET>
@@ -21354,7 +21355,10 @@ information on evaluating code blocks.
while using line numbers for the links, which might be useful to
explain those in an Org mode example code.
-[fn:117] Upon exit, lines starting with =*=, =,*=, =#+= and =,#+= get
+[fn:117]
+#+cindex: escape character
+#+cindex: comma
+Upon exit, lines starting with =*=, =,*=, =#+= and =,#+= get
a comma prepended, to keep them from being interpreted by Org as
outline nodes or special syntax. These commas are stripped when
editing with {{{kbd(C-c ')}}}, and also before export.
--
2.22.0
next prev parent reply other threads:[~2019-08-15 10:17 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-09 19:02 Org syntax inside verbatim/literal blocks Štěpán Němec
2019-08-09 20:39 ` Nicolas Goaziou
2019-08-09 21:02 ` Štěpán Němec
2019-08-15 8:13 ` Nicolas Goaziou
2019-08-15 10:16 ` Štěpán Němec [this message]
2019-08-17 13:24 ` Nicolas Goaziou
2019-08-17 14:00 ` Štěpán Němec
2019-08-17 14:36 ` Nicolas Goaziou
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:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
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=87lfvuohr8.fsf@gmail.com \
--to=stepnem@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=mail@nicolasgoaziou.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* 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
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).