From mboxrd@z Thu Jan 1 00:00:00 1970 From: =?utf-8?B?xaB0xJtww6FuIE7Em21lYw==?= Subject: Re: Org syntax inside verbatim/literal blocks Date: Thu, 15 Aug 2019 12:16:59 +0200 Message-ID: <87lfvuohr8.fsf@gmail.com> References: <87tvaqduwe.fsf_-_@gmail.com> <87wofmf4z3.fsf@nicolasgoaziou.fr> <87pnledpdf.fsf@gmail.com> <87ef1mg829.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:470:142:3::10]:51289) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1hyCoZ-00041W-On for emacs-orgmode@gnu.org; Thu, 15 Aug 2019 06:17:04 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hyCoY-0004gX-ID for emacs-orgmode@gnu.org; Thu, 15 Aug 2019 06:17:03 -0400 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]:36761) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hyCoY-0004eG-0s for emacs-orgmode@gnu.org; Thu, 15 Aug 2019 06:17:02 -0400 Received: by mail-wm1-x32c.google.com with SMTP id g67so837565wme.1 for ; Thu, 15 Aug 2019 03:17:01 -0700 (PDT) In-Reply-To: <87ef1mg829.fsf@nicolasgoaziou.fr> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Nicolas Goaziou Cc: emacs-orgmode@gnu.org --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable > 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). --=20 =C5=A0t=C4=9Bp=C3=A1n --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=0001-org-manual-Index-and-link-to-information-on-literal-.patch >From bcd5049620e938c8687f239c10248db3805de721 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=A0t=C4=9Bp=C3=A1n=20N=C4=9Bmec?= 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 zero width space : C-x 8 200B @@ -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 --=-=-=--