Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated README.org

  • Loading branch information...
commit 815565115a8bb14c0da2cb60cc6f62734b23e13a 1 parent 8908964
@chrismgray authored
Showing with 29 additions and 12 deletions.
  1. +11 −12 README.org
  2. +18 −0 TODO.org
View
23 README.org
@@ -1,11 +1,13 @@
* Ikiwiki Org Plugin
- This is intended to be a plugin for the [[http://ikiwiki.info][ikiwiki]] wiki compiler that
- interprets [[http://orgmode.org][org-mode]] files.
+ This is a plugin for the [[http://ikiwiki.info][ikiwiki]] wiki compiler that interprets
+ [[http://orgmode.org][org-mode]] files.
- It is currently in a very alpha state, and the [[http://ikiwiki.info/todo/org_mode/][existing org-mode
- plugin]] for ikiwiki should probably be used instead.
+ The plugin is in a beta state -- it should be monitored to ensure
+ that it is not hanging -- but is nearly feature-complete and can be
+ used instead of the [[http://ikiwiki.info/todo/org_mode/][existing org-mode plugin]]. An example of it in
+ action is my [[http://chrismgray.github.com/][blog]].
* Motivation
@@ -24,24 +26,21 @@
directives like =#+TITLE= or =#+AUTHOR=. These are not hard to
parse out of the files with Perl, but the better solution is to
allow org-mode itself to parse the files, and get the information
- from org-mode's internal structures.
+ from org-mode's internal structures.
* Installation
There are two main files: =sh/new-org= and
=lisp/ikiwiki-org-plugin.el=. The first needs to go in the
=~/.ikiwiki/plugins= directory and the second needs to go somewhere
- in the emacs =load-path=.
+ in the emacs =load-path=. However, it is not recommended that you
+ =require= the =ikiwiki-org-plugin= file from your usually-running
+ emacs -- a new emacs instance is started by the plugin which will
+ =require= it for you.
The plugin must be enabled in your =wiki.setup= or =blog.setup=
file. This is done by adding =new-org= to the =add_plugins= list.
- Right now, the best chance of things working is if you start a new
- emacs instance and set the =server-name= to =org-ikiwiki-compiler=
- and then run =M-x start-server=. Setting the =server-name= in your
- primary emacs instance will cause it to hang every time that ikiwiki
- recompiles your wiki.
-
* License
Copyright (C) 2011, Chris Gray.
View
18 TODO.org
@@ -43,3 +43,21 @@
CLOCK: [2011-12-15 Thu 10:47]--[2011-12-15 Thu 11:03] => 0:16
:END:
*** TODO Allow for slashes before wikilinks
+** readme
+*** DONE Remove warnings about alpha state
+ CLOSED: [2011-12-16 Fri 11:22]
+ :LOGBOOK:
+ - State "DONE" from "STARTED" [2011-12-16 Fri 11:22]
+ - State "STARTED" from "TODO" [2011-12-16 Fri 11:11]
+ CLOCK: [2011-12-16 Fri 11:11]--[2011-12-16 Fri 11:22] => 0:11
+ :END:
+*** DONE Put in link to blog
+ CLOSED: [2011-12-16 Fri 11:19]
+ :LOGBOOK:
+ - State "DONE" from "TODO" [2011-12-16 Fri 11:19]
+ :END:
+*** DONE Reword installation to reflect sh is now working
+ CLOSED: [2011-12-16 Fri 11:20]
+ :LOGBOOK:
+ - State "DONE" from "TODO" [2011-12-16 Fri 11:20]
+ :END:
Please sign in to comment.
Something went wrong with that request. Please try again.