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_LINK_UP:    index.html
  10 #+HTML_LINK_HOME:  https://orgmode.org/worg/
  11 #+EXCLUDE_TAGS: noexport
  12
  13 #+name: banner
  14 #+begin_export html
  15   <div id="subtitle" style="float: center; text-align: center;">
  16   <p>
  17   Org Mode support for <a href="http://language-site/">Language</a>
  18   </p>
  19   <p>
  20   <a href="http://language-site/">
  21   <img src="http://language-site/graphic.file"/>
  22   </a>
  23   </p>
  24   </div>
  25 #+end_export
  26
  27 * Template Checklist [0/13]                                        :noexport:
  28   - [ ] Revise #+TITLE:
  29   - [ ] Indicate #+AUTHOR:
  30   - [ ] Add #+EMAIL:
  31   - [ ] Revise banner source block [0/3]
  32     - [ ] Add link to a useful language web site
  33     - [ ] Replace "Language" with language name
  34     - [ ] Find a suitable graphic and use it to link to the language
  35       web site
  36   - [ ] Write an [[Introduction]]
  37   - [ ] Describe [[Requirements%20and%20Setup][Requirements and Setup]]
  38   - [ ] Replace "Language" with language name in [[Org%20Mode%20Features%20for%20Language%20Source%20Code%20Blocks][Org Mode Features for Language Source Code Blocks]]
  39   - [ ] Describe [[Header%20Arguments][Header Arguments]]
  40   - [ ] Describe support for [[Sessions]]
  41   - [ ] Describe [[Result%20Types][Result Types]]
  42   - [ ] Describe [[Other]] differences from supported languages
  43   - [ ] Provide brief [[Examples%20of%20Use][Examples of Use]]
  44 * Introduction
  45   - Brief description of language.
  46   - Range of typical uses within Org Mode.
  47 * Requirements and Setup
  48   - Installation and configuration of language software
  49   - Emacs configuration
  50   - Org-mode configuration (org-babel-do-load-languages)
  51 * Org Mode Features for Language Source Code Blocks
  52 ** Header Arguments
  53    - Language-specific default values
  54    - Language-specific header arguments
  55 ** Sessions
  56    - Support or not
  57    - Typical use for sessions
  58 ** Result Types
  59    - Which result types are supported?
  60 ** Other
  61    - Differences from other supported languages
  62 * Examples of Use
  63   - Hello World!
  64   - Common uses
  65   - Links to tutorials and other resources