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
  12 * Org-mode for developers
  13
  14 This page gather links to reference documentation and (forthcoming)
  15 tutorials on how to extend Org.
  16
  17 * Git workflow
  18
  19 Org development uses a two-branches git workflow.
  20
  21 - master :: This branch contains the latest development for Org.
  22             Temporary feature branches (either local or remote) should
  23             branch out from =master=.  New features should be introduced
  24             into org on master.  This branch is merged to the =maint=
  25             branch when a major release is made.
  26
  27 - maint :: This branch is the "production" branch for Org.  It
  28            contains stable releases and bug fixes against them.  Bugs
  29            present in a release should always be fixed on =maint=,
  30            which is then merged back into =master= so that the two
  31            branches keep the same bugfixes.  Minor releases are made
  32            so that not too many bug fixes are pending on maint.  The
  33            Org version on this branch is regularly sync'ed with the
  34            Emacs repository.
  35
  36 ** Git repositories
  37
  38 The git repository for Org is on =orgmode.org=:
  39
  40 - https://code.orgmode.org/bzg/org-mode
  41
  42 If you are a developer, you can clone it like this:
  43
  44 : ~$ git clone git@code.orgmode.org:bzg/org-mode.git
  45
  46 To clone a read-only version of the repo:
  47
  48 : ~$ git clone https://code.orgmode.org/bzg/org-mode.git
  49
  50 * Reference documentation
  51
  52 - [[file:org-syntax.org][Syntax reference (draft)]]
  53
  54 - [[file:org-element-api.org][Org Element API]] for the Org parser (=org-element.el=).
  55
  56 - [[file:org-export-reference.org][Reference documentation]] for the new export engine (=ox.el=) written
  57   by Nicolas Goaziou.
  58
  59 - [[../doc.org][Org-mode's doc ]]for all hooks, commands and options.
  60
  61 * Tips
  62
  63 - [[file:org-build-system.org][Org Build System]] (aka Makefile)