exporters/ox-template.org

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