emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/org ffd832d5d6 06/14: org-manual: Update #+include bloc


From: ELPA Syncer
Subject: [elpa] externals/org ffd832d5d6 06/14: org-manual: Update #+include block parsing
Date: Sun, 22 Jan 2023 10:58:11 -0500 (EST)

branch: externals/org
commit ffd832d5d63549d054feb93b1e076efcc243ac84
Author: TEC <git@tecosaur.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    org-manual: Update #+include block parsing
    
    * doc/org-manual.org (Include Files): Mention that block names starting
    with ":" will need to be quoted, and reformat the paragraph for clarity
    while editing the mention of block name.
---
 doc/org-manual.org | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index d19f9b303b..77ae185468 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -12180,16 +12180,15 @@ example, to include your =.emacs= file, you could use:
 : #+INCLUDE: "~/.emacs" src emacs-lisp
 
 #+texinfo: @noindent
-The first parameter is the file name to include.  The optional second
-parameter specifies the block type: =example=, =export= or =src=.  The
-optional third parameter specifies the source code language to use for
-formatting the contents.  This is relevant to both =export= and =src=
-block types.
-
-If an included file is specified as having a markup language, Org
-neither checks for valid syntax nor changes the contents in any way.
-For example and source blocks, Org code-escapes the contents before
-inclusion.
+There are three positional arguments after the include keyword, they are:
+1. The file name, this is the sole mandatory argument.  Org neither
+   checks for correctness or validates the content in any way.
+2. The block name to wrap the file content in.  When this is
+   =example=, =export=, or =src= the content is escaped by
+   ~org-escape-code-in-string~.  Arbitrary block names may be given,
+   however block names starting with =:= must be quoted, i.e. =":name"=.
+3. The source code language to use for formatting the contents.  This is 
relevant
+   to both =export= and =src= block types.
 
 #+cindex: @samp{minlevel}, include
 If an included file is not specified as having any markup language,



reply via email to

[Prev in Thread] Current Thread [Next in Thread]