bb7c9db7112735ea6e1a27b5f3893d2d98faa2a2
[worg.git] / org-contrib / babel / header-args.org
1 #+OPTIONS:    H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:{} -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
2 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate hideblocks
3 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
4 #+TAGS:       Write(w) Update(u) Fix(f) Check(c) noexport(n)
5 #+TITLE:      Header arguments and result types in Org Babel
6 #+AUTHOR:     Thorsten Jolitz
7 #+EMAIL:      tj[at]data-driven[dot]de
8 #+LANGUAGE:   en
9 #+STYLE:      <style type="text/css">#outline-container-introduction{ clear:both; }</style>
10 #+LINK_UP:    index.html
11 #+LINK_HOME:  http://orgmode.org/worg/
12 #+EXPORT_EXCLUDE_TAGS: noexport
13
14 # #+name: banner
15 # #+begin_html
16 #   <div id="subtitle" style="float: center; text-align: center;">
17 #   <p>
18 #   Org Mode support for <a href="http://picolisp.com/5000/!wiki?home/">PicoLisp</a>
19 #   </p>
20 #   <p>
21 #   <a href="http://picolisp.com/5000/!wiki?home/">
22 #   <img src="http://picolisp.com/5000/wiki/logo.png"/>
23 #   </a>
24 #   </p>
25 #   </div>
26 # #+end_html
27
28
29 * Common combinations of header-args and result types
30    Many combinations of header arguments and result types are
31    supported by Org Babel. Individual languages may even define
32    special header args. Like always in combinatorics, the number
33    of possible combinations increases rapidly when there are several
34    factors with several levels each that can be freely combined.
35
36    The following table shows combinations of header arguments and
37    result types that might be considered reasonable for many
38    programming languages.
39
40     #+tblname: header-args-combinations
41     | evaluation | collection | type              |
42     | (:session) | (:results) | (:results)        |
43     |------------+------------+-------------------|
44     | external   | value      | table (vector)    |
45     |            |            | scalar (verbatim) |
46     |            |            | file              |
47     |            |            | raw (org)         |
48     |            |            | html              |
49     |            |            | latex             |
50     |            |            | code              |
51     |            |            | pp                |
52     |            | output     | table (vector)    |
53     |            |            | scalar (verbatim) |
54     |            |            | file              |
55     |            |            | raw (org)         |
56     |            |            | html              |
57     |            |            | latex             |
58     |            |            | code              |
59     |            |            | pp                |
60     | session    | value      | table (vector)    |
61     |            |            | scalar (verbatim) |
62     |            |            | file              |
63     |            |            | raw (org)         |
64     |            |            | html              |
65     |            |            | latex             |
66     |            |            | code              |
67     |            |            | pp                |
68     |            | output     | table (vector)    |
69     |            |            | scalar (verbatim) |
70     |            |            | file              |
71     |            |            | raw (org)         |
72     |            |            | html              |
73     |            |            | latex             |
74     |            |            | code              |
75     |            |            | pp                |
76
77      
78     More special header arguments and their possible values are
79     summarized in the next table:
80    
81     #+tblname: other-header-args
82     
83     | header-arg |          | values  |          |         |
84     |------------+----------+---------+----------+---------|
85     | :results   | silent   | replace | append   | prepend |
86     | (handling) |          |         |          |         |
87     | :exports   | code     | results | both     | none    |
88     | :comments  | yes      | (no?)   |          |         |
89     | :noweb     | no       | yes     |          |         |
90     | :tangle    | yes      | no      | filename |         |
91     | :no-expand |          |         |          |         |
92     | :file      |          |         |          |         |
93     | :dir       |          |         |          |         |
94     | :cache     | no       | yes     |          |         |
95     | :var       | x=y      |         |          |         |
96     | :hlines    | no       | yes     |          |         |
97     | :colnames  | nil      | no      | yes      |         |
98     | :rownames  | no       | yes     |          |         |
99     | :shebang   | "string" |         |          |         |
100     | :eval      | never    | query   |          |         |
101
102