Merge branch 'master' of orgmode.org:worg
[worg.git] / org-contrib / babel / languages / ob-doc-template.org
1 #+OPTIONS:    H:3 num:nil toc:2 \n:nil ::t |:t ^:{} -:t f:t *:t tex:t 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:      Language Source Code Blocks in Org Mode
6 #+AUTHOR:     Your name
7 #+EMAIL:      you[at]email[dot]org
8 #+LANGUAGE:   en
9 #+HTML_HEAD:      <style type="text/css">#outline-container-introduction{ clear:both; }</style>
10 #+LINK_UP:    ../languages.html
11 #+LINK_HOME:  http://orgmode.org/worg/
12 #+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://language-site/">Language</a>
19   </p>
20   <p>
21   <a href="http://language-site/">
22   <img src="http://language-site/graphic.file"/>
23   </a>
24   </p>
25   </div>
26 #+end_html
27
28 * Template Checklist [0/13]                                        :noexport:
29   - [ ] Revise #+TITLE:
30   - [ ] Indicate #+AUTHOR:
31   - [ ] Add #+EMAIL:
32   - [ ] Revise banner source block [0/3]
33     - [ ] Add link to a useful language web site
34     - [ ] Replace "Language" with language name
35     - [ ] Find a suitable graphic and use it to link to the language
36       web site
37   - [ ] Write an [[Introduction]]
38   - [ ] Describe [[Requirements%20and%20Setup][Requirements and Setup]]
39   - [ ] Replace "Language" with language name in [[Org%20Mode%20Features%20for%20Language%20Source%20Code%20Blocks][Org Mode Features for Language Source Code Blocks]]
40   - [ ] Describe [[Header%20Arguments][Header Arguments]]
41   - [ ] Describe support for [[Sessions]]
42   - [ ] Describe [[Result%20Types][Result Types]]
43   - [ ] Describe [[Other]] differences from supported languages
44   - [ ] Provide brief [[Examples%20of%20Use][Examples of Use]]
45 * Introduction
46   - Brief description of language.
47   - Range of typical uses within Org Mode.
48 * Requirements and Setup
49   - Installation and configuration of language software
50   - Emacs configuration
51   - Org-mode configuration (org-babel-do-load-languages)
52 * Org Mode Features for Language Source Code Blocks
53 ** Header Arguments
54    - Language-specific default values
55    - Language-specific header arguments
56 ** Sessions
57    - Support or not
58    - Typical use for sessions
59 ** Result Types
60    - Which result types are supported?
61 ** Other
62    - Differences from other supported languages
63 * Examples of Use
64   - Hello World!
65   - Common uses
66   - Links to tutorials and other resources