Move org-people.org to FIXME/

[worg.git] / org-tools / index.org

#+TITLE:      Org Mode tools!
#+AUTHOR:     Worg people
#+EMAIL:      mdl AT imapmail DOT org
#+STARTUP:    align fold nodlcheck hidestars oddeven intestate
#+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
#+TAGS:       Write(w) Update(u) Fix(f) Check(c)
#+LANGUAGE:   en
#+PRIORITIES: A C B
#+CATEGORY:   worg
#+OPTIONS:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc

This page lists external tools useful for handling Org files.

* Org-mode parsers

** Orgile - a PHP Org parser

See [[http://toshine.org/etc/orgile-emacs-org-mode-file-html-parser-php-publishing-tool/][this blog entry]] for details, the repo is on [[https://github.com/mashdot/orgile][github]].

** [[https://bitbucket.org/joebo/pico-org/src][pico-org]] - A PicoLisp parser

[[http://thread.gmane.org/gmane.lisp.picolisp.general/3679][Message]] from the developer Joe Bogner:

: I've written a tiny org-mode parser and hooked it up with my mustache
: implementation to create a simple web page that dumps out the org
: structure. I'm not sure where I'm going to go next but figured I'd
: share it since I enjoy reading other's code as well.

** [[http://common-lisp.net/project/cl-org-mode/][cl-org-mode]] - A Common lisp parser for org-mode outlines

Abstract: CL-ORG-MODE is a parser for org-mode files that uses an
extensible CLOS-based recursive descent parser to create a tree of org-mode
nodes. Also included is a (primitive) system for literate programming using
org-mode

** orgnode.py - python library for parsing Org files

- Author: Charles Cave
- Homepage: http://members.optusnet.com.au/~charles57/GTD/orgnode.html

: The Orgnode module contains one class, called Orgnode and a routine to read
: an org-mode file and create a list of Orgnode objects.
: 
: The module is for reading an org-mode file. There are no methods for
: writing org-mode since since I have no need for this functionality.
: 
: You are welcome to extend the functionality of the __repr__ method of the
: Orgnode class if you would like this functionality.
** [[http://gioorgi.com/org-mode-parser/][org-mode-parser for nodejs]] by Giovanni Giorgi
** PyOrgMode - python library for creating and parsing Org files

- Author: Jonathan Bisson (on gmail : bissonjonathan)
- Homepage: https://github.com/bjonnh/PyOrgMode

: This python module allows for the creation and parsing of org-files. The
: org-files are loaded into python objects allowing the modification of the
: different recognized elements.
: 
: The objects are defined in a plug-in way, allowing the user of this
: module to add easily a new kind of data and the relative functions.
: 
: Current objects are : 
: - Schedule elements
: - Drawers
: - Tables
: - Nodes
: 
: The project is contained in an unique tangle org-file which contains the
: documentation, the python files and the test suite.

** NEO - No Emacs Org in Python

- Author: Olivier Schwander
- Homepage: http://redmine.chadok.info/projects/neo
- Announcement: http://lists.gnu.org/archive/html/emacs-orgmode/2011-04/msg00598.html

: Another Python tool for parsing org mode files
: 
: Current features 
: ~~~~~~~~~~~~~~~~~
:   - Org file parser
:   - Agenda builder
:   - Todo-list builder
:   - Custom todo keywords
:   - Command line interface for agenda and todo-lists

** Org::Parser - Perl module for parsing Org files

- Author: Steven Haryanto
- Homepage: http://search.cpan.org/dist/Org-Parser

There are several other Org-related modules on CPAN at various development
stages, all utilizing Org::Parser: App::OrgUtils (some utilities for Org
documents), Org::To::* (convert Org mode to various other formats).

** [[https://github.com/bdewey/org-ruby][org-ruby (used on github)]] by Brian Dewey

#+begin_quote
This gem contains Ruby routines for parsing org-mode files. The most
significant thing this library does today is convert org-mode files to HTML
or textile.
#+end_quote

Read [[http://orgmode.org/worg/org-tutorials/org-ruby.html][the org-ruby tutorial for details.]]

** [[https://github.com/mooz/org-js][org-js]] by Masafumi Oyamada

org-js is a javascript parser and converter for org-mode
(http://orgmode.org/) notation.

For a working example of an interactive editor, see
http://mooz.github.com/org-js/editor/.

* Specific purpose tools

** orgmode for drupal

[[https://www.drupal.org/project/orgmode][Orgmode for drupal]] import org files into drupal nodes. 

** nakkaya: a static site generator parsing Org's files (and MarkDown)

Static is a simple static site generator written in Clojure.  For a sample
site build using static see http://nakkaya.com

You can grab the latest version of nakkaya from [[https://github.com/nakkaya/static][its github repository]].

** orgitdown - use Org keybindings in HTML text areas

[[https://github.com/gnowgi/orgitdown][orgitdown]] is based on [[http://markitup.jaysalvat.com/home/][markitup]] and allows to use Org keybindings in text
areas through some javascript magic.  The text inserted is using Org's
syntax, and can be further processed with Emacs in batch mode on the
server.

Check [[http://mid.gmane.org/CADSSMeg5BDkZMBWEhXF2K7kssrEsX6SkZE%2BOjvXFpHY5aTcgmQ@mail.gmail.com][Nagarjuna G announcement on the mailing list]].

** Exporter for the Octopress blogging engine

#+BEGIN_QUOTE
Octopress is a framework designed by Brandon Mathis for Jekyll, the blog
aware static site generator powering Github Pages. To start blogging with
Jekyll, you have to write your own HTML templates, CSS, Javascripts and set
up your configuration. But with Octopress All of that is already taken care
of. Simply clone or fork Octopress, install dependencies and the theme, and
you’re set.
#+END_QUOTE

You can clone Octopress from [[https://github.com/imathis/octopress][the github repository]].

[[https://github.com/craftkiller/orgmode-octopress][orgmode-octopress]] is an exporter for Emacs Org-Mode to Octopress by
craftkiller.  For setup instructions, check [[http://blog.paphus.com/blog/2012/08/01/introducing-octopress-blogging-for-org-mode/][this blog entry]].  Note that
orgmode-octopress will not work with the new export engine in Org 8.0.

** Export OmniFocus to Org-mode files

Jay McCarthy wrote [[https://github.com/jeapostrophe/exp/blob/master/of2org.rkt][this]], using [[http://racket-lang.org/][Racket]].

** Convert from Planner to Org

See this message from [[http://mid.gmane.org/8ay5hehupe.fsf@faepop01.tu-graz.ac.at][Andreas Hirczy]]:

I have written yet another converter from planner to org:
<http://itp.tugraz.at/~ahi/Computer/SW/muse2org.html>
<http://itp.tugraz.at/~ahi/Computer/SW/muse2org>

** Export vCard to org-mode entries

[[http://mid.gmane.org/50B28EA7.6020900@gmx.de][Simon Thum]] shared some [[https://gist.github.com/4145201][Ruby code]] to export vCards to Org-mode entries.

** ews-orgmode - Exchange calendar to orgmode

https://github.com/kautsig/ews-orgmode

See [[http://mid.gmane.org/50B78A90.3040609@kautsig.org][this message]] from Chris Raschl:

: I recently wrote a python script to fetch my calendar from the corporate
: exchange server into an orgmode file to view it in my agenda.
: It uses the exchange webservices (ews).

** michel-orgmode - script for pushing to / pulling from Google-Tasks lists

- Authors: Mark Edgington, Christophe-Marie Duquesne
- Homepage: https://bitbucket.org/edgimar/michel-orgmode

Michel-orgmode is a python script which serves as a bridge between an
org-mode textfile and a Google-tasks task list.  It can pull the contents
of a Google-tasks list into an org-mode file, or push an org-mode file's
contents to a Google-tasks list.  It supports bidirectional sync.

** Using GData API to import events in an Org file

Mon, 11 Jul 2011, Felix Geller wrote:

: I wrote a Python [[https://bitbucket.org/fgeller/gcal2org/src/8fa7d2b83ab3/gcal2org.py][script]] that uses the GData API to download events for your
: Google Calendar and prints them to a given org-file. It is a very tiny
: script, but perhaps it is of use to other people as well.
:
: Small disclaimer: I've tested this on Mac OS X only, using Python 2.7.2.

The script can be found here: [[https://bitbucket.org/fgeller/gcal2org/src/8fa7d2b83ab3/gcal2org.py][gcal2org.py]]

** Migrating from Tomboy to Org

In [[http://article.gmane.org/gmane.emacs.orgmode/45239][this email]], Attila shared a script to move notes from Tomboy to
Org-mode -- see his message:

: I'm moving my note-taking from GNote (C++ rewrite of Tomboy Notes) to
: org-mode.  As I have a lot of notes all over the place, I wrote a script to
: convert from the XML format used by the Tomboy-style tools to org-mode.

You can find the script here: https://github.com/StAlphonsos/scriptologie

** orgutil - TCL script to manipulate org files

- Author: Patrick Brennan
- Homepage: http://sourceforge.net/projects/orgutil/

: Script for converting files into and out of Org-mode, and for performing
: various analyses and conversions. The primary use case for this utility is
: to convert between Org-mode outline text and AbstractSpoon's ToDoList.

** ical2org.awk - convert ics files to Org

- Author: Eric S Fraga
- Code: [[file:../code/awk/ical2org.awk][ical2org.awk]]

See [[file:../org-tutorials/org-google-sync.org][the org-google-sync tutorial]] for explanations on how to use this
script.

** ical2org.rb - convert ics files to Org
   - Author: Simon Thum
   - Code: [[https://github.com/simonthum/ical2org][ical2org]]
   - handles events and TODOs
   - all sorts of repeating events
   - and timezones!
   - one-way only though
     - except if you have a REST-capable ical server, see README
** org2remind - perl script to convert org appointments to remind

 - Author: Matt Lundin
 - Code: [[file:../code/perl/org2remind.pl][org2remind]]

Remind is a command line calendar application for Unix/Linux that
can, among other things, spit out formatted plain text calendars and
agendas.

http://www.roaringpenguin.com/products/remind

: To convert org-mode appointments to remind data, simply call the
: script on one or more org files:
: 
: perl org2remind.pl ~/org/*.org
: 
: (Optionally, add the script to your path and make it executable.)
: 
: The results of this script can saved in a file...
: 
: perl org2remind.pl ~/org/*.org >> org.rem 
: 
: ...or piped directly into a remind command...
: 
: perl org2remind.pl ~/org/*.org | remind -
: 
: For a nice calendar of the current month, use the following: 
: 
: perl org2remind.pl ~/org/*.org | remind -c -
: 
: This script is similar to org2rem.el (in the contrib directory of the
: org-mode repository), except that, instead of saving files from within
: org-mode, it allows for easier and faster access to org/remind data
: from the command line.
: 
: Currently, the script supports appointments (i.e., active timestamps)
: and the org-diary-class sexp.

** org-manage - locate and manage your org files
    - Author: Daniel German
    - Code:   [[http://github.com/dmgerman/org-manage][org-manage]] (based on [[https://github.com/yoshinari-nomura/org-octopress][org-octopress]])
    - Lists all org files in a given directory and its subdirectories,
      providing a table of org files, including their title and category.

#+begin_quote
This is a module to help managing a large collection of org files. It
is based on org-octopress by Yoshinari Nomura.

org-manage scans a given directory (recursively) looking for org
files. For each, an entry is created. The title is extracted from the
attribute #+TITLE: in the org file. The category is extracted from the
first #+CATEGORY in the file (I suggest you add a default category to
each file.
#+end_quote

** vimwiki2org - convert vimwiki files to Org
   - Author: Xu FaSheng
   - Homepage: https://github.com/fasheng/vimwiki2org

** Org Blog Wiki tools

See the page [[file:../org-blog-wiki.org][Org Blogs and Wikis]].

** orgFixLinks.py: a Python command-line utility for repairing broken links to local files
    - Author: GitHub user cashTangoTangoCash
    - website: https://github.com/cashTangoTangoCash/orgFixLinks
    - repairs broken links in org files
    - currently Linux-only, but probably straighforward to port to Win/Mac?

#+begin_quote
 A stand-alone Python script designed to interactively repair broken
links to local files in one, many, or all of your org files.  OK, it's
an amateur command line script that likely needs more refinement, and
it chooses to do things that not everyone desires, but you can fork it
on GitHub, and adapt it to your own purposes.  If you are frustrated
by broken links to the degree that you are ready to debug a lengthy
Python script, why not play with it.  The GitHub wiki
https://github.com/cashTangoTangoCash/orgFixLinks/wiki provides a
degree of documentation.
#+end_quote