Commits

Anonymous committed 4e02767

README.org: Updated readme, added settings for key bindings and theme.

Comments (0)

Files changed (1)

 ==========================
 
 * About
-
   My shot on bringing Org-Mode {3} to Sublime Text 2 {4}. This project is still in very early development. Nobody knows what will come next :). This won't be a simple copycat of the original one. I want to "port" useful things in a way that works best for Sublime Text 2. So there may be things that aren't in either version or just behave more or less differently.
 
 * Features
-
   Here's a list of all the features implemented so far:
 
   - Context sensitive highlighting
     - External link opener on pressing enter
       (currently only working on OSX)
 
-* Todo [0/5]
+* Installation
 
+** Codebase
+   Clone or copy the contents into an Packages/orgmode folder.
+
+** Key bindings for interaction
+   See "Key bindings for interaction" under "Attachments" below for details.
+
+** Theme additions for proper syntax highlighting
+   See "Theme additions for proper syntax highlighting" under "Attachments" below for details.
+
+* Todo [1/9]
   - [ ] External link opener on pressing enter [1/3]
     - [X] on OSX
     - [ ] on Linux
     - [ ] on Windows
-  - [ ] Recalc number of children in checkbox summary on pressing enter.
+  - [X] Recalc number of children in checkbox summary on pressing enter.
   - [ ] When (un-)checking *all* checkboxes of siblings, toggle parent checkbox.
   - [ ] Either make highlight_code_remarks.py configurable thru view settings so that orgmode can control its regex patterns or fork/extend it to archive an equal goal.
   - [ ] Inter-document links
     - [ ] Highlighting
     - [ ] Jump between similar numbers on pressing enter
+  - [ ] Export into formatted text file
+  - [ ] Automatic export after save into given format if mark found in org file.
+  - [ ] Fix subsequent indents
+  - [ ] Fix cursor position after filling checkbox summary on checkbox toggle
 
 * Known Issues
-
   - When creating an empty checkbox summary and hitting an checkbox below the cursor will be placed a little bit to the left. Seems like the selection is being rebuilt incorrectly due to the added chars for the summary.
   - Subsequent indent of wrapped paragraphs don't respect stars, tacks and checkboxes.
   
 * External links
-
   {1} Homepage [[https://bitbucket.org/theblacklion/sublime_orgmode/]]
   {2} Issue tracker [[https://bitbucket.org/theblacklion/sublime_orgmode/issues?status=new&status=open]]
   {3} Sublime Text 2 [[http://www.sublimetext.com/2]]
   {4} Org-Mode for Emacs [[http://orgmode.org/]]
+
+* Attachments
+
+** Key bindings for interaction
+   Put the following into your key bindings file:
+
+   [code]
+   { "keys": ["enter"], "command": "orgmode_toggle_checkbox", "context":
+     [
+       { "key": "selector", "operator": "equal", "operand": "checkbox.orgmode" }
+     ]
+   },
+   { "keys": ["enter"], "command": "orgmode_recalc_checkbox_summary", "context":
+     [
+       { "key": "selector", "operator": "equal", "operand": "summary.checkbox.orgmode" }
+     ]
+   },
+   { "keys": ["enter"], "command": "orgmode_open_link", "context":
+     [
+       { "key": "selector", "operator": "equal", "operand": "link.orgmode" }
+     ]
+   }
+   [/code]
+
+** Theme additions for proper syntax highlighting
+   Put the following into your theme file:
+
+   [code]
+   <dict>
+       <key>name</key>
+       <string>orgmode link</string>
+       <key>scope</key>
+       <string>link.orgmode</string>
+       <key>settings</key>
+       <dict>
+         <key>foreground</key>
+         <string>#FB9A4B</string>
+         <key>fontStyle</key>
+         <string>underline</string>
+      </dict>
+   </dict>
+   <dict>
+       <key>name</key>
+       <string>orgmode page</string>
+       <key>scope</key>
+       <string>page.orgmode</string>
+       <key>settings</key>
+       <dict>
+         <key>foreground</key>
+         <string>#FFFFAA</string>
+      </dict>
+   </dict>
+   <dict>
+       <key>name</key>
+       <string>orgmode break</string>
+       <key>scope</key>
+       <string>break.orgmode</string>
+       <key>settings</key>
+       <dict>
+         <key>foreground</key>
+         <string>#FFAAAA</string>
+      </dict>
+   </dict>
+   <dict>
+       <key>name</key>
+       <string>orgmode headline</string>
+       <key>scope</key>
+       <string>headline.orgmode</string>
+       <key>settings</key>
+       <dict>
+         <key>foreground</key>
+         <string>#9EFFFF</string>
+      </dict>
+   </dict>
+   <dict>
+       <key>name</key>
+       <string>orgmode tack</string>
+       <key>scope</key>
+       <string>tack.orgmode</string>
+       <key>settings</key>
+       <dict>
+         <key>foreground</key>
+         <string>#FFFFAA</string>
+      </dict>
+   </dict>
+   <dict>
+       <key>name</key>
+       <string>orgmode checkbox</string>
+       <key>scope</key>
+       <string>checkbox.orgmode</string>
+       <key>settings</key>
+       <dict>
+         <key>foreground</key>
+         <string>#FFFFAA</string>
+      </dict>
+   </dict>
+   <dict>
+       <key>name</key>
+       <string>orgmode checkbox summary</string>
+       <key>scope</key>
+       <string>summary.checkbox.orgmode</string>
+       <key>settings</key>
+       <dict>
+         <key>foreground</key>
+         <string>#FFFFAA</string>
+      </dict>
+   </dict>
+   [/code]
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.