summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEric Schulte <schulte.eric@gmail.com>2011-06-24 15:22:42 -0700
committerEric Schulte <schulte.eric@gmail.com>2011-06-24 15:22:42 -0700
commit00c62aa65fae7367792b6bff8b91cf69f9477f24 (patch)
tree7dcb5a1d460a754cbf71197860b71148a6933b9a
parent5c3def4713ac99b7d493a34436128b8b1bd22e70 (diff)
downloadorg-mode-00c62aa65fae7367792b6bff8b91cf69f9477f24.tar.gz
doc: documenting the new option for inline call lines
* doc/org.texi (Evaluating code blocks): Documenting the new option for inline call lines.
-rw-r--r--doc/org.texi15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/org.texi b/doc/org.texi
index 934b84d..c884bf3 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -11593,11 +11593,20 @@ It is also possible to evaluate named code blocks from anywhere in an
Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
@code{#+function} or @code{#+lob}) lines can be used to remotely execute code
blocks located in the current Org-mode buffer or in the ``Library of Babel''
-(see @ref{Library of Babel}). These lines use the following syntax.
+(see @ref{Library of Babel}). These lines use the following syntax to place
+a call on a line by itself.
@example
#+call: <name>(<arguments>)
-#+call: <name>[<header arguments>](<arguments>) <header arguments>
+#+call: <name>[<header args>](<arguments>) <header args>
+@end example
+
+The following syntax can be used to place these calls within a block of
+prose.
+
+@example
+...prose... call_<name>(<arguments>) ...prose...
+...prose... call_<name>[<header args>](<arguments>)[<header args>] ...prose...
@end example
@table @code
@@ -11610,7 +11619,7 @@ block expressed using standard function call syntax. For example if the
original code block named @code{double} has the header argument @code{:var
n=2}, then the call line passing the number four to that block would be
written as @code{#+call: double(n=2)}.
-@item <header arguments>
+@item <header args>
Header arguments can be placed either inside the call to the code block or at
the end of the line as shown below.