Added information page and org-mode and Mac OS X
authorChristopher Suckling <suckling@gmail.com>
Mon, 20 Jul 2009 22:32:10 +0000 (23:32 +0100)
committerChristopher Suckling <suckling@gmail.com>
Mon, 20 Jul 2009 22:32:10 +0000 (23:32 +0100)
index.org
org-mac.org [new file with mode: 0644]
org-web.org

index 5646b9b..1f71812 100644 (file)
--- a/index.org
+++ b/index.org
@@ -74,6 +74,7 @@ Last update: 24-04-2009 16:38
 - [[file:org-translators.org][Org Translators]]
 - [[file:org-hacks.org][Hacks around Org]]
 - [[file:blorgit.org][Org blogging engine]]
+- [[file:org-mac.org][Org and Mac OS X]]
 
 # FIXME: should we add this?
 
diff --git a/org-mac.org b/org-mac.org
new file mode 100644 (file)
index 0000000..96c864c
--- /dev/null
@@ -0,0 +1,209 @@
+#+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
+#+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
+#+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
+#+TAGS:       Write(w) Update(u) Fix(f) Check(c)
+#+TITLE:      Org and Mac OS X
+#+AUTHOR:     Worg people
+#+EMAIL:      bzg AT altern DOT org
+#+LANGUAGE:   en
+#+PRIORITIES: A C B
+#+CATEGORY:   worg
+
+# This file is the default header for new Org files in Worg.  Feel free
+# to tailor it to your needs.
+
+[[file:index.org][{Back to Worg's index}]]
+
+Assorted hacks to interact with org-mode whilst working in OS X
+applications other than Emacs...
+
+* [[file:org-contrib/org-mac-ical.org][org-mac-ical]]-- import OS X iCal.app events into Emacs diary
+  Written by /Christopher Suckling/.
+  [[repofile:contrib/lisp/org-mac-iCal.el][Link to raw file]].
+
+
+* [[file:org-contrib/org-mac-message.org][org-mac-message]] -- linking to messages in OS X Mail.app
+  Create links to selected or flagged messages in Mail.app.
+  Written by /John Wiegley/ and /Christopher Suckling/.
+  [[repofile:lisp/org-mac-message.el][Link to raw file]].
+
+* org-mac-protocol -- interact with [[file:org-contrib/org-protocol.org][org-protocol]] from OS X applications
+  Written by /Christopher Suckling/.
+ : Version: 0.628
+
+ A suite of scripts that allow the user to annotate their org-mode
+ buffers without switching focus from other OS X applications
+ to Emacs.
+
+ The AppleScripts interface with org-protocol.el to extract content
+ from, and link to, documents and applications. 
+
+ Three modes of interaction are provided:
+
+ =org-link= creates an org-mode link and adds it to =*Org Links*= and
+ the kill-ring.
+
+ =org-remember= pops up a small =*Remember*= frame with links and,
+ where possible, extracted content embedded.
+
+ =org-note= pops up a small =*Remember*= frame for note taking
+ independent of the document being worked on.
+
+** Obtaining
+
+   An archive can be downloaded [[http://claviclaws.net/org/org-mac-protocol.dmg][here]].
+
+** Included files
+   
+   - org-mac-protocol.pkg (installer package)
+   - sources (including Scripting Additions sources)
+   - org-mac-protocol.org (this manual)
+
+** Requirements
+
+   - OS X 10.5 (untested on previous versions)
+
+   - [[http://orgmode.org][Org-Mode]] 6.28 or above (untested on previous versions)
+   - [[https://gna.org/p/remember-el][Remember]]
+
+** Installation and configuration
+*** Install files
+**** =org-mac-protocol.pkg= - OS X 10.5 only 
+
+    - Launch the installer and follow on screen instructions.  You
+      must set a location for org-mac-protocol.el that is on your
+      Emacs load-path.
+
+**** Manual installation - OS X 10.4
+
+    - Copy files from the =sources= directory to their relevant
+      locations.
+      
+      =org-mac-protocol.el= should be placed on your Emacs load-path.
+
+      The contents of the =Scripts= directory should be placed in
+      =~/Library/Scripts/=.
+
+      =URI Escape.osax= should be placed in
+      =~/Library/ScriptingAdditions/=, creating the directory if
+      necessary. =URI Escape.osax= is found on the
+      =URIEscape1.1.2.dmg= disk image.
+
+
+*** Edit your .emacs
+**** Require org-mac-protocol.el
+
+     : (require 'org-mac-protocol)
+
+     or
+     
+     : (add-to-list 'org-modules 'org-mac-protocol)
+
+     (must be set before org-mode is loaded)
+
+**** Start emacsserver
+
+     : (server-start)
+
+**** /Optional:/ Edit the default =*Remember*= templates
+
+     Two default =*Remember*= templates are provided by
+     org-mac-protocol.el.
+     
+     - These can be edited to your tastes
+
+       The defaults are:
+
+       : ("AppleScript remember" ?y "* %?\n\n  Source: %u, %c\n\n  %i" (concat org-directory "inbox.org") "Remember")
+       
+       : ("AppleScript note" ?z "* %?\n\n  Source: %u\n" (concat org-directory "inbox.org") "Notes")
+       
+       This template can be fairly flexible. The only essential items
+       are =?y= and =?z= (the template selection characters), and, for
+       =org-remember=, =%c= (the link to the document), and =%i= (the
+       selection within the document).
+
+       If you choose to alter the template selection characters, you
+       *must* alter =theProtocol= variable in =org-remember.scpt= and
+       =org-note.scpt= to reflect your changes.
+
+       Please see the [[http://orgmode.org/manual/Remember-templates.html#Remember-templates][org manual]] and the [[http://orgmode.org/worg/org-contrib/org-protocol.php][org-protocol.el manual]] for
+       further details on template customisation.
+
+**** Eval .emacs
+*** Edit orgQSLib/getEmacsClient.scpt
+    
+    - Set =theEmacsClient= to point to emacsclient for your flavour of Emacs.
+      
+      The default setting should work with Carbon Emacs and CVS Emacs.
+      Aquamacs users will have to edit this variable.
+
+** Usage
+   There are three scripts that can be invoked; =org-link=,
+   =org-note=, and =org-remember=. These scripts can be called by
+   various methods, for example, the [[file://Applications/AppleScript/AppleScript%20Utility.app/][Script menu]] in the menu bar,
+   [[http://code.google.com/p/blacktree-alchemy/][Quicksilver]], [[http://www.red-sweater.com/fastscripts/][FastScripts]] etc.
+
+*** Currently supported applications
+
+    |          | org-link           | org-note | org-remember                     |
+    |----------+--------------------+----------+----------------------------------|
+    | Finder   | Link: file         | Yes      | Content: no                      |
+    | Safari   | Link: URL          | Yes      | Content: current selection       |
+    | Mail     | Link: message      | Yes      | Content: entire message          |
+    | Skim     | Link: PDF          | Yes      | Content: current selection       |
+    | BibDesk  | Link: entry        | Yes      | Content: Harvard style citation  |
+    | Terminal | Link: Terminal.app | Yes      | Content: current window contents |
+
+
+    - Unsupported applications that are AppleScript aware will attempt
+      to create links to the front document, but do not support
+      selected content.      
+
+    - Preview.app is /not/ AppleScript aware and Firefox has such
+      limited AppleScript support as to be useless.
+      
+*** org-link
+    Creates an org-mode link from the front document and passes it to
+    emacsclient, adding it to =*Org Links*= and the kill-ring.
+
+    - Run =org-link=
+
+*** org-note
+    Creates a note in an org-mode buffer. Does not link to the front
+    document.
+
+    - Run =org-note=
+    - Enter note in pop-up =*Remember*= buffer
+    - File note to return to previous application
+      
+*** org-remember
+    Creates a note in an org-mode buffer. Links to the file of the
+    front document, and uses selection in front document as
+    initial content of the =*Remember*= buffer.
+
+    - Run =org-remember=
+    - Enter note in pop-up =*Remember*= buffer
+    - File note to return to previous application
+       
+** TODO
+   Support for further applications will also require defining [[http://orgmode.org/manual/Adding-hyperlink-types.html#Adding-hyperlink-types][new
+   org-mode hyperlinks]], as will improvements to linking for PDF files
+   and Terminal. Planned support includes:
+
+   - [ ] Skim (improved)
+   - [ ] Terminal (improved)
+   - [ ] iCal
+   - [ ] Microsoft Office
+   - [ ] iTunes
+   - [ ] iPhoto
+   - [ ] Firefox (if AppleScript support is improved)
+
+** Acknowledgements
+   
+   The pop up remember buffer is developed from a blog post by [[http://metajack.im/2008/12/30/gtd-capture-with-emacs-orgmode/][Jack Moffitt]].
+
+   [[http://homepage.mac.com/tkurita/scriptfactory/Softwares/OSAX/URIEscape/manual/en/index.html][URI Escape]] is by Tetsuro Kurita.
+
+   org-info.js and CSS stylesheet by [[http://orgmode.org/worg/code/org-info-js/][Sebastian Rose]]
+  
index 643e371..22c0835 100644 (file)
@@ -55,7 +55,7 @@ This page contains links to web sites made with org-mode. Add more links at your
 - [[http://www.nongnu.org/self-platform/][Nagarjuna G: SELF Platform Documentation]]
 - [[http://lists.w3.org/Archives/Public/public-html/2008Aug/att-0829/image-alt.html][T.V. Raman: The alt attribute on the HTML img tag]]
 - [[http://google-axsjax.googlecode.com/svn/trunk/docs/tutorial/tutorial.html][T.V. Raman, Charles L. Chenn: Writing AxsJAX Scripts]]
-- [[http://claviclaws.net/org/][Christopher Suckling: Org-Annotation-Quicksilver Manual]]
+- [[http://claviclaws.net/org/][Christopher Suckling: org-mac-protocol Manual]]
 - [[http://www-personal.umich.edu/~swolchok/eecspointers.html][Scott Wolchok: EECS Pointers]]
 - [[http://liinwww.ira.uka.de/courses/vl/gbi/2008/][Thomas Worsch: Grundbegriffe der Informatik]]
 - [[http://liinwww.ira.uka.de/~thw/vl-alg-za/][Thomas Worsch: Volesung Algorithmen in Zellularautomaten]]