dev/index.org

   1 #+TITLE:      Org-mode for developers
   2 #+AUTHOR:     Worg people
   3 #+EMAIL:      mdl AT imapmail DOT org
   4 #+STARTUP:    align fold nodlcheck hidestars oddeven intestate
   5 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
   6 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
   7 #+LANGUAGE:   en
   8 #+PRIORITIES: A C B
   9 #+CATEGORY:   worg
  10 #+OPTIONS:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
  11 #+HTML_LINK_UP:    ../index.html
  12 #+HTML_LINK_HOME:  https://orgmode.org/worg/
  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 * Org-mode for developers
  19
  20 This page gather links to reference documentation and (forthcoming)
  21 tutorials on how to extend Org.
  22
  23 * Git workflow
  24
  25 Org development uses a two-branches git workflow.
  26
  27 - master :: This branch contains the latest development for Org.
  28             Temporary feature branches (either local or remote) should
  29             branch out from =master=.  New features should be introduced
  30             into org on master.  This branch is merged to the =maint=
  31             branch when a major release is made.
  32
  33 - maint :: This branch is the "production" branch for Org.  It
  34            contains stable releases and bug fixes against them.  Bugs
  35            present in a release should always be fixed on =maint=,
  36            which is then merged back into =master= so that the two
  37            branches keep the same bugfixes.  Minor releases are made
  38            so that not too many bug fixes are pending on maint.  The
  39            Org version on this branch is regularly sync'ed with the
  40            Emacs repository.
  41
  42 ** Git repositories
  43
  44 The git repository for Org is on =orgmode.org=:
  45
  46 - https://git.savannah.gnu.org/cgit/emacs/org-mode.git/
  47
  48 If you are a developer, you can clone it like this:
  49
  50 : ~$ git clone git://git.savannah.gnu.org/emacs/org-mode.git
  51
  52 To clone a read-only version of the repo:
  53
  54 : ~$ git clone https://git.savannah.gnu.org/git/emacs/org-mode.git
  55
  56 * Reference documentation
  57
  58 - [[file:org-syntax.org][Syntax reference (draft)]]
  59
  60 - [[file:org-element-api.org][Org Element API]] for the Org parser (=org-element.el=).
  61
  62 - [[file:org-export-reference.org][Reference documentation]] for the new export engine (=ox.el=) written
  63   by Nicolas Goaziou.
  64
  65 - [[../doc.org][Org-mode's doc ]]for all hooks, commands and options.
  66
  67 * Tips
  68
  69 - [[file:org-build-system.org][Org Build System]] (aka Makefile)