org.texi: Document missing OPTIONS item
[org-mode.git] / testing / examples / babel.org
blob7c30ab2e31c64cea1528e38f4d0956cd1359b8cf
1 #+Title: a collection of examples for Babel tests
2 #+OPTIONS: ^:nil
4 * =:noweb= header argument expansion
5   :PROPERTIES:
6   :ID:       eb1f6498-5bd9-45e0-9c56-50717053e7b7
7   :END:
9 #+name: noweb-example
10 #+begin_src emacs-lisp :results silent :exports code
11   (message "expanded1")
12 #+end_src
14 #+name: noweb-example2
15 #+begin_src emacs-lisp :results silent
16   (message "expanded2")
17 #+end_src
19 #+begin_src emacs-lisp :noweb yes :results silent
20 ;; noweb-1-yes-start
21   <<noweb-example>>
22 #+end_src
24 #+begin_src emacs-lisp :noweb no  :results silent
25 ;; noweb-no-start
26   <<noweb-example1>>
27 #+end_src
29 #+begin_src emacs-lisp :noweb yes :results silent
30 ;; noweb-2-yes-start
31   <<noweb-example2>>
32 #+end_src
34 #+begin_src emacs-lisp :noweb tangle :results silent
35   ;; noweb-tangle-start
36   <<noweb-example1>>
37   <<noweb-example2>>
38 #+end_src
40 * =:noweb= header argument expansion using :exports results
41   :PROPERTIES:
42   :ID:       8701beb4-13d9-468c-997a-8e63e8b66f8d
43   :END:
45 #+name: noweb-example
46 #+begin_src emacs-lisp :exports results
47   (message "expanded1")
48 #+end_src
50 #+name: noweb-example2
51 #+begin_src emacs-lisp :exports results
52   (message "expanded2")
53 #+end_src
55 #+begin_src emacs-lisp :noweb yes :exports results
56 ;; noweb-1-yes-start
57   <<noweb-example>>
58 #+end_src
60 #+begin_src emacs-lisp :noweb no :exports code
61 ;; noweb-no-start
62   <<noweb-example1>>
63 #+end_src
65 #+begin_src emacs-lisp :noweb yes :exports results
66 ;; noweb-2-yes-start
67   <<noweb-example2>>
68 #+end_src
70 #+begin_src emacs-lisp :noweb tangle :exports code
71   <<noweb-example1>>
72   <<noweb-example2>>
73 #+end_src
75 * excessive id links on tangling
76   :PROPERTIES:
77   :ID:       ef06fd7f-012b-4fde-87a2-2ae91504ea7e
78   :END:
80 ** no, don't give me an ID
81 #+begin_src emacs-lisp :tangle no
82   (message "not to be tangled")
83 #+end_src
85 ** yes, I'd love an ID
86    :PROPERTIES:
87    :ID:       ae7b55ca-9ef2-4d30-bd48-da30e35fd0f3
88    :END:
89 #+begin_src emacs-lisp :tangle no
90   (message "for tangling")
91 #+end_src
92 * simple named code block
93   :PROPERTIES:
94   :ID:       0d82b52d-1bb9-4916-816b-2c67c8108dbb
95   :END:
97 #+name: i-have-a-name
98 #+begin_src emacs-lisp
99   42
100 #+end_src
102 #+name:
103 : 42
105 #+name: i-have-a-name
106 : 42
108 * Pascal's Triangle -- exports both test
109   :PROPERTIES:
110   :ID:       92518f2a-a46a-4205-a3ab-bcce1008a4bb
111   :END:
113 #+name: pascals-triangle
114 #+begin_src emacs-lisp :var n=5 :exports both
115   (require 'cl)
116   (defalias 'my-map (if (org-version-check "24.2.50" "cl" :predicate)
117                         'cl-map
118                       'map))
119   (defun pascals-triangle (n)
120     (if (= n 0)
121         (list (list 1))
122       (let* ((prev-triangle (pascals-triangle (- n 1)))
123              (prev-row (car (reverse prev-triangle))))
124         (append prev-triangle
125                 (list (my-map 'list #'+
126                               (append prev-row '(0))
127                               (append '(0) prev-row)))))))
128   
129   (pascals-triangle n)
130 #+end_src
132 * calling code blocks from inside table
133   :PROPERTIES:
134   :ID:       6d2ff4ce-4489-4e2a-9c65-e3f71f77d975
135   :END:
137 #+name: take-sqrt
138 #+begin_src emacs-lisp :var n=9
139   (sqrt n)
140 #+end_src
142 * executing an lob call line
143   :PROPERTIES:
144   :results:  silent
145   :ID:       fab7e291-fde6-45fc-bf6e-a485b8bca2f0
146   :END:
148 #+call: echo(input="testing")
149 #+call: echo(input="testing") :results vector
150 #+call: echo[:var input="testing"]()
151 #+call: echo[:var input="testing"]() :results vector
152 #+call: echo("testing")
153 #+call: echo("testing") :results vector
154 This is an inline call call_echo(input="testing") embedded in prose.
155 This is an inline call call_echo(input="testing")[:results vector] embedded in prose.
156 #+call: lob-minus(8, 4)
157 call_echo("testing")
158 call_concat(1,2,3)
160 #+name: concat
161 #+begin_src emacs-lisp :var a=0 :var b=0 :var c=0
162   (format "%S%S%S" a b c)
163 #+end_src
165 * exporting an lob call line
166   :PROPERTIES:
167   :ID:       72ddeed3-2d17-4c7f-8192-a575d535d3fc
168   :END:
170 #+name: double
171 #+begin_src emacs-lisp :var it=0
172   (* 2 it)
173 #+end_src
175 The following exports as a normal call line
176 #+call: double(it=0)
178 Now here is an inline call call_double(it=1) stuck in the middle of
179 some prose.
181 This one should not be exported =call_double(it=2)= because it is
182 quoted.
184 Finally this next one should export, even though it starts a line
185 call_double(it=3) because sometimes inline blocks fold with a
186 paragraph.
188 And, a call with raw results call_double(4)[:results raw] should not
189 have quoted results.
191 The following 2*5=call_double(5) should export even when prefixed by
192 an = sign.
194 * inline source block
195   :PROPERTIES:
196   :results:  silent
197   :ID:       54cb8dc3-298c-4883-a933-029b3c9d4b18
198   :END:
199 Here is one in the middle src_sh{echo 1} of a line.
200 Here is one at the end of a line. src_sh{echo 2}
201 src_sh{echo 3} Here is one at the beginning of a line.
203 * mixed blocks with exports both
204   :PROPERTIES:
205   :ID:       5daa4d03-e3ea-46b7-b093-62c1b7632df3
206   :END:
208 #+name: a-list
209 - a
210 - b
211 - c
213 #+begin_src emacs-lisp :exports both
214     "code block results"
215 #+end_src
217 #+begin_src emacs-lisp :var lst=a-list :results list :exports both
218   (reverse lst)
219 #+end_src
221 * using the =:noweb-ref= header argument
222   :PROPERTIES:
223   :ID:       54d68d4b-1544-4745-85ab-4f03b3cbd8a0
224   :noweb-sep: ""
225   :END:
227 #+begin_src sh :tangle yes :noweb yes :shebang #!/bin/sh
228   <<fullest-disk>>
229 #+end_src
231 ** query all mounted disks
232 #+begin_src sh :noweb-ref fullest-disk
233   df
234 #+end_src
236 ** strip the header row
237 #+begin_src sh :noweb-ref fullest-disk
238   |sed '1d'
239 #+end_src
241 ** sort by the percent full
242 #+begin_src sh :noweb-ref fullest-disk
243   |awk '{print $5 " " $6}'|sort -n |tail -1
244 #+end_src
246 ** extract the mount point
247 #+begin_src sh :noweb-ref fullest-disk
248   |awk '{print $2}'
249 #+end_src
250 * resolving sub-trees as references
251   :PROPERTIES:
252   :ID:       2409e8ba-7b5f-4678-8888-e48aa02d8cb4
253   :results:  silent
254   :END:
256 #+begin_src emacs-lisp :var text=d4faa7b3-072b-4dcf-813c-dd7141c633f3
257   (length text)
258 #+end_src
260 #+begin_src org :noweb yes
261   <<simple-subtree>>
262   <<d4faa7b3-072b-4dcf-813c-dd7141c633f3>>
263 #+end_src
265 ** simple subtree with custom ID
266    :PROPERTIES:
267    :CUSTOM_ID: simple-subtree
268    :END:
269 this is simple
271 ** simple subtree with global ID
272    :PROPERTIES:
273    :ID:       d4faa7b3-072b-4dcf-813c-dd7141c633f3
274    :END:
275 has length 14
277 * org-babel-get-inline-src-block-matches
278   :PROPERTIES:
279   :results:  silent
280   :ID:       0D0983D4-DE33-400A-8A05-A225A567BC74
281   :END:
282 src_sh{echo "One"} block at start of line
283  One spaced block in  src_sh{ echo "middle" } of line
284 src_sh{echo 2} blocks on the src_emacs-lisp{"same"} line
285  Inline block with src_sh[:results silent]{ echo "parameters" }.
286 * exporting a code block with a name
287   :PROPERTIES:
288   :ID:       b02ddd8a-eeb8-42ab-8664-8a759e6f43d9
289   :END:
291 exporting a code block with a name
292 #+name: qux
293 #+begin_src sh :foo "baz"
294   echo bar
295 #+end_src
296 * noweb no-export and exports both
297   :PROPERTIES:
298   :ID:       8a820f6c-7980-43db-8a24-0710d33729c9
299   :END:
300 Weird interaction.
302 here is one block
304 #+name: noweb-no-export-and-exports-both-1
305 #+BEGIN_SRC sh :exports none
306   echo 1
307 #+END_SRC
309 and another
311 #+BEGIN_SRC sh :noweb no-export :exports both
312   # I am inside the code block
313   <<noweb-no-export-and-exports-both-1>>
314 #+END_SRC
316 * in order evaluation on export
317   :PROPERTIES:
318   :exports: results
319   :ID:       96cc7073-97ec-4556-87cf-1f9bffafd317
320   :END:
322 First.
323 #+name: foo-for-order-of-evaluation
324 #+begin_src emacs-lisp :var it=1
325   (push it *evaluation-collector*)
326 #+end_src
328 Second
329 #+begin_src emacs-lisp
330   (push 2 *evaluation-collector*)
331 #+end_src
333 Third src_emacs-lisp{(push 3 *evaluation-collector*)}
335 Fourth
336 #+call: foo-for-order-of-evaluation(4)
338 Fifth
339 #+begin_src emacs-lisp
340   (push 5 *evaluation-collector*)
341 #+end_src
342 * exporting more than just results from a call line
343   :PROPERTIES:
344   :ID:       bec63a04-491e-4caa-97f5-108f3020365c
345   :END:
346 Here is a call line with more than just the results exported.
347 #+call: double(8)
348 * strip noweb references on export
349   :PROPERTIES:
350   :ID:       8e7bd234-99b2-4b14-8cd6-53945e409775
351   :END:
353 #+name: strip-export-1
354 #+BEGIN_SRC sh :exports none
355   i="10"
356 #+END_SRC
358 #+BEGIN_SRC sh :noweb strip-export :exports code :results silent
359   <<strip-export-1>>
360   echo "1$i"
361 #+END_SRC