summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Dye <tsd@tsdye.com>2011-01-01 10:21:40 -1000
committerEric Schulte <schulte.eric@gmail.com>2011-01-05 09:09:29 -0700
commitc867ce2c021ea58be4b06c9c9bcbd42b7242a867 (patch)
tree81ad0dde3b1ec89bd0f3adb816b74a3290a1db93
parentde39bf05bea84b842711faa49e560ea4bc087211 (diff)
downloadorg-mode-c867ce2c021ea58be4b06c9c9bcbd42b7242a867.tar.gz
Documentation of multi-line header arguments.
* doc/org.texi (Code block specific header arguments): Documentation of multi-line header arguments.
-rw-r--r--doc/org.texi27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/org.texi b/doc/org.texi
index 994cc24..590a022 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -11603,6 +11603,33 @@ Similarly, it is possible to set header arguments for inline code blocks:
src_haskell[:exports both]@{fac 5@}
@end example
+Code block header arguments can span multiple lines using =#+header:= or
+=#+headers:= lines preceding a code block or nested in between the name and
+body of a named code block.
+
+Multi-line header arguments on an un-named code block:
+@example
+ #+headers: :var data1=1
+ #+begin_src emacs-lisp :var data2=2
+ (message "data1:%S, data2:%S" data1 data2)
+ #+end_src
+
+ #+results:
+ : data1:1, data2:2
+@end example
+
+Multi-line header arguments on a named code block:
+@example
+ #+source: named-block
+ #+header: :var data=2
+ #+begin_src emacs-lisp
+ (message "data:%S" data)
+ #+end_src
+
+ #+results: named-block
+ : data:2
+@end example
+
@node Header arguments in function calls, , Code block specific header arguments, Using header arguments
@comment node-name, next, previous, up
@subsubheading Header arguments in function calls