Rephrase the link to MobileOrg for Android
[Worg.git] / org-tools / index.org
blob50cf5e2651b967ea40f51de9fddbb6c46d56516f
1 #+STARTUP:    align fold nodlcheck hidestars oddeven intestate
2 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
3 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
4 #+TITLE:      Org Mode tools!
5 #+AUTHOR:     Worg people
6 #+EMAIL:      mdl AT imapmail DOT org
7 #+LANGUAGE:   en
8 #+PRIORITIES: A C B
9 #+CATEGORY:   worg
10 #+OPTIONS:    H:3 num:nil toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
12 This page lists external tools useful for handling Org files.
14 * Org-mode parsers
16 ** orgnode.py - python library for parsing Org files
18 - Author: Charles Cave
19 - Homepage: http://members.optusnet.com.au/~charles57/GTD/orgnode.html
21 : The Orgnode module contains one class, called Orgnode and a routine to read
22 : an org-mode file and create a list of Orgnode objects.
23
24 : The module is for reading an org-mode file. There are no methods for
25 : writing org-mode since since I have no need for this functionality.
26
27 : You are welcome to extend the functionality of the __repr__ method of the
28 : Orgnode class if you would like this functionality.
29 ** [[http://gioorgi.com/org-mode-parser/][org-mode-parser for nodejs]] by Giovanni Giorgi
30 ** PyOrgMode - python library for creating and parsing Org files
32 - Author: Jonathan Bisson (on gmail : bissonjonathan)
33 - Homepage: https://github.com/bjonnh/PyOrgMode
35 : This python module allows for the creation and parsing of org-files. The
36 : org-files are loaded into python objects allowing the modification of the
37 : different recognized elements.
38
39 : The objects are defined in a plug-in way, allowing the user of this
40 : module to add easily a new kind of data and the relative functions.
41
42 : Current objects are : 
43 : - Schedule elements
44 : - Drawers
45 : - Tables
46 : - Nodes
47
48 : The project is contained in an unique tangle org-file which contains the
49 : documentation, the python files and the test suite.
51 ** NEO - No Emacs Org in Python
53 - Author: Olivier Schwander
54 - Homepage: http://redmine.chadok.info/projects/neo
55 - Announcement: http://lists.gnu.org/archive/html/emacs-orgmode/2011-04/msg00598.html
57 : Another Python tool for parsing org mode files
58
59 : Current features 
60 : ~~~~~~~~~~~~~~~~~
61 :   - Org file parser
62 :   - Agenda builder
63 :   - Todo-list builder
64 :   - Custom todo keywords
65 :   - Command line interface for agenda and todo-lists
67 ** Org::Parser - Perl module for parsing Org files
69 - Author: Steven Haryanto
70 - Homepage: http://search.cpan.org/dist/Org-Parser
72 There are several other Org-related modules on CPAN at various development
73 stages, all utilizing Org::Parser: App::OrgUtils (some utilities for Org
74 documents), Org::To::* (convert Org mode to various other formats).
76 ** [[https://github.com/bdewey/org-ruby][org-ruby (used on github)]] by Brian Dewey
78 #+begin_quote
79 This gem contains Ruby routines for parsing org-mode files. The most
80 significant thing this library does today is convert org-mode files to HTML
81 or textile.
82 #+end_quote
84 Read [[http://orgmode.org/worg/org-tutorials/org-ruby.html][the org-ruby tutorial for details.]]
86 * Specific-purpose tools
88 ** Using GData API to import events in an Org file
90 Mon, 11 Jul 2011, Felix Geller wrote:
92 : I wrote a Python [[https://bitbucket.org/fgeller/gcal2org/src/8fa7d2b83ab3/gcal2org.py][script]] that uses the GData API to download events for your
93 : Google Calendar and prints them to a given org-file. It is a very tiny
94 : script, but perhaps it is of use to other people as well.
96 : Small disclaimer: I've tested this on Mac OS X only, using Python 2.7.2.
98 The script can be found here: [[https://bitbucket.org/fgeller/gcal2org/src/8fa7d2b83ab3/gcal2org.py][gcal2org.py]]
100 ** Migrating from Tomboy to Org
102 In [[http://article.gmane.org/gmane.emacs.orgmode/45239][this email]], Attila shared a script to move notes from Tomboy to
103 Org-mode -- see his message:
105 : I'm moving my note-taking from GNote (C++ rewrite of Tomboy Notes) to
106 : org-mode.  As I have a lot of notes all over the place, I wrote a script to
107 : convert from the XML format used by the Tomboy-style tools to org-mode.
109 You can find the script here: https://github.com/StAlphonsos/scriptologie
111 ** orgutil - TCL script to manipulate org files
113 - Author: Patrick Brennan
114 - Homepage: http://sourceforge.net/projects/orgutil/
116 : Script for converting files into and out of Org-mode, and for performing
117 : various analyses and conversions. The primary use case for this utility is
118 : to convert between Org-mode outline text and AbstractSpoon's ToDoList.
120 ** ical2org.awk - convert ics files to Org
122 - Author: Eric S Fraga
123 - Code: [[file:../code/awk/ical2org.awk][ical2org.awk]]
125 See [[file:../org-tutorials/org-google-sync.org][the org-google-sync tutorial]] for explanations on how to use this
126 script.
128 ** org2remind - perl script to convert org appointments to remind
130  - Author: Matt Lundin
131  - Code: [[file:../code/perl/org2remind.pl][org2remind]]
133 Remind is a command line calendar application for Unix/Linux that
134 can, among other things, spit out formatted plain text calendars and
135 agendas.
137 http://www.roaringpenguin.com/products/remind
139 : To convert org-mode appointments to remind data, simply call the
140 : script on one or more org files:
142 : perl org2remind.pl ~/org/*.org
144 : (Optionally, add the script to your path and make it executable.)
146 : The results of this script can saved in a file...
148 : perl org2remind.pl ~/org/*.org >> org.rem 
150 : ...or piped directly into a remind command...
152 : perl org2remind.pl ~/org/*.org | remind -
154 : For a nice calendar of the current month, use the following: 
156 : perl org2remind.pl ~/org/*.org | remind -c -
158 : This script is similar to org2rem.el (in the contrib directory of the
159 : org-mode repository), except that, instead of saving files from within
160 : org-mode, it allows for easier and faster access to org/remind data
161 : from the command line.
163 : Currently, the script supports appointments (i.e., active timestamps)
164 : and the org-diary-class sexp.