ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / todo / org_mode.mdwn
1 [[!template id=gitbranch branch=wtk/org author="[[wtk]]"]]
2
3 summary
4 =======
5
6 Add a plugin for handling files written in [org-mode][].
7
8 notes
9 =====
10
11 This is an updated form of [Manoj Srivastava's plugin][MS].  You can
12 see the plugin [in action][example] on my blog.
13
14 For reasons discussed in the [[reStructuredText plugin|plugins/rst]],
15 wikilinks and other ikiwiki markup that inserts raw HTML can cause
16 problems.  Org-mode provides a [means for processing raw HTML][raw],
17 but Ikiwiki currently (as far as I know) lacks a method to escape
18 inserted HTML depending on which plugins will be used during the
19 [[htmlize phase|plugins/write#index11h3]].
20
21 new plugin
22 ==========
23
24 A complete rewrite of the plugin can be found
25 [here][chrismgray-rewrite].  It uses a
26 dedicated emacs instance to parse the org-mode files.  Thus, it should
27 be a bit faster than the older plugin, as well as properly handling
28 [[wikilinks|ikiwiki/wikilink]] and images, two features not present in the older
29 plugin.  An example of its use can be found at my [blog][chrismgray-blog].
30
31 [org-mode]: http://orgmode.org/
32 [MS]: http://www.golden-gryphon.com/blog/manoj/blog/2008/06/08/Using_org-mode_with_Ikiwiki/
33 [example]: http://blog.tremily.us/posts/Git/notes/
34 [raw]: http://orgmode.org/manual/Quoting-HTML-tags.html
35 [chrismgray-rewrite]: https://github.com/chrismgray/ikiwiki-org-plugin
36 [chrismgray-blog]: http://chrismgray.github.com