[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [O] Org syntax inside verbatim/literal blocks
From: |
Štěpán Němec |
Subject: |
Re: [O] Org syntax inside verbatim/literal blocks |
Date: |
Thu, 15 Aug 2019 12:16:59 +0200 |
User-agent: |
Notmuch/0.29.1 (https://notmuchmail.org) Emacs/27.0.50 (x86_64-pc-linux-gnu) |
> 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
>From bcd5049620e938c8687f239c10248db3805de721 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= <address@hidden>
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