d3477b46ce82489f08adadd41d1353c0a5a39775
[worg.git] / exporters / ox-template.org
1 #+OPTIONS:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
2 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
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:      Using the Org-mode Fill-In-Blank exporter (ox-*)
6 #+AUTHOR:     Your name
7 #+EMAIL:      you[at]email[dot]org
8 #+LANGUAGE:   en
9 #+STYLE:      <style type="text/css">#outline-container-introduction{ clear:both; }</style>
10 #+LINK_UP:    ../ox-overview.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://exporter-site/">Exporter Name</a>
19   </p>
20   <p>
21   <a href="http://exporter-site/">
22   <img src="http://exporter-site/graphic.file"/>
23   </a>
24   </p>
25   </div>
26 #+end_html
27
28 * Template Checklist [0/9]                                         :noexport:
29   - [ ] Save this template as a new file
30     - Create new directory, =worg.git/exporters/backend/=
31     - Save as =worg.git/exporters/backend/ox-backend.org= with =C-x C-w ox-backend.org RET=
32   - [ ] Revise #+TITLE:
33   - [ ] Indicate #+AUTHOR:
34   - [ ] Add #+EMAIL:
35   - [ ] Revise banner source block [0/3]
36     - [ ] Add link to a useful exporter web site (e.g. LaTeX home page, markdown wiki
37       page, etc.)
38     - [ ] Replace "Exporter Name" with Exporter name (see table at ox-overview)
39     - [ ] Find a suitable graphic and use it to link to the language web site
40   - [ ] Write an [[Introduction]]
41   - [ ] Describe [[Requirements%20and%20Setup][Requirements and Setup]]
42   - [ ] Overview of [[Org-mode%20features%20and%20usage%20of%20export%20backend][Org-mode features and usage of export backend]]
43   - [ ] Provide brief [[Usage%20examples][Usage examples]]
44
45 * Introduction
46   - Brief description of backend (e.g. What is the native backend used for?
47   - Range of typical uses within Org Mode.
48     - 
49 * Requirements and Setup
50   - Installation and configuration of language software
51   - Emacs configuration (=require('ox-*)=)
52   - Org-mode configuration (=#+options:= variables, file-keywords/variables, etc.)
53
54 * Org-mode features and usage of export backend
55
56 Fill in this section with specifics about how to accomplish typical goals when using this
57 backend. For example:
58
59 - Explanation of exporter sub-options (what appears upon =C-c C-e=)
60 - Use case options and tweaking explanation
61   - Sizing/positioning images
62   - Inserting links
63   - Fontification (e.g. *word*, /word/, =word=, sub/superscript, etc.)
64   - Page breaking
65   - Inserting white space (e.g. =\vspace{Xcm}=, =<br />=, etc.)
66   - Formatting tables
67   - Styles, for example accessing css functionality or setting
68     =\usepackage[options]{package}= 
69 - Other ~#+attr_backend~ options of interest
70 - Converting output format to some other format (if applicable)
71
72
73 * Usage examples
74   - Sample document: ideally, this would be a reproducible
75     sample document of some sort that displays a wide range of functionality.
76   - Specific walkthrough of what the options in the sample document are doing, if not
77     clearly laid out above.
78   - Specific example of fine tuning some aspect of the output (placing an image here
79     vs. there, how to control text wrap, etc.).
80
81 * References
82   - Links to tutorials and other resources.
83   - Link to the ox-*.el file itself