mirrors
/
org-mode
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git
0
0
Fork 1
Code Releases Activity

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.
This commit is contained in:
TEC 2023-01-22 22:05:46 +08:00 committed by Ihor Radchenko
parent 7e649050c7
commit ffd832d5d6
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/org-manual.org
View File

@ -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,