org-watchdoc.org: docu updated.
authortj <tj@data-driven.de>
Wed, 9 Apr 2014 23:38:14 +0000 (01:38 +0200)
committertj <tj@data-driven.de>
Wed, 9 Apr 2014 23:38:14 +0000 (01:38 +0200)
org-contrib/org-watchdoc.org

index a966b38..d150a7f 100644 (file)
@@ -1,4 +1,4 @@
-# Created 2014-04-10 Do 00:58
+# Created 2014-04-10 Do 01:36
 #+TITLE: Org-watchdoc
 #+DATE: <2014-04-09 Mi>
 #+AUTHOR: Thorsten Jolitz
@@ -92,8 +92,10 @@ is specified. However, its commands can be used interactively:
 
 In interactive use, this would be the typical order of actions:
 
-1. Export first buffer tree to desired doc files
-   (e.g. README-GH.md or README-WORG.html)
+1. Export first buffer tree to desired doc files (e.g. README-GH.md
+   or README-WORG.html). Optional, since adding non-exiting
+   target-files in step 2 will cause the exporter to write them the
+   when exiting the edit-buffer.
 
 2. Add targets with point on first buffer headline.
 
@@ -101,19 +103,19 @@ In interactive use, this would be the typical order of actions:
    export-template files to be inserted before the exporter does
    its work, and backends the exporter should export to, e.g.
 
-#+BEGIN_EXAMPLE
-"/home/me/proj/README-GH.md /home/me/proj/gh-tmpl.org gfm"
-"/home/me/proj/README-WORG.html /home/me/proj/worg-tmpl.org html"
-#+END_EXAMPLE
+   #+BEGIN_EXAMPLE
+   "/home/me/proj/README-GH.md /home/me/proj/gh-tmpl.org gfm"
+   "/home/me/proj/README-WORG.html /home/me/proj/worg-tmpl.org html"
+   #+END_EXAMPLE
 
-The three elements of such a combination are prompted from
-the user.
+   The three elements of such a combination are prompted from
+   the user.
 
-1. Save and set md5 variable.
+3. Save and set md5 variable.
 
-2. Edit the (narrowed) first buffer tree and save
+4. Edit the (narrowed) first buffer tree and save
 
-3. Propagate changes.
+5. Propagate changes.
 
    Since md5 has changed due to the edits, all registered target
    combinations are automatically re-exported.
@@ -126,6 +128,10 @@ Assuming outshine and outorg are installed and active, do once:
   In the *outorg-edit-buffer* do steps 1 and 2 described above
   for direct interactive use.
 
+#+BEGIN_EXAMPLE
+M-x outorg-edit-comments-and-propagate-changes
+#+END_EXAMPLE
+
 Then whenever you want to edit the source-buffer's
 comment-section and propagate the changes to the watched doc
 files, do:
@@ -150,6 +156,28 @@ This will
 - Check if buffer md5 has changed when editing is quitted. If so,
   propagate the changes to the doc files registered in the subtrees
   watchlist.
+*** Keybindings in Outshine
+
+Here are the keybindings I added to outshine.el:
+
+#+BEGIN_EXAMPLE
+;; edit comment-section with `outorg' and propagate changes
+
+;; best used with prefix-key 'C-c' 
+(define-key map "`" 'outorg-edit-comments-and-propagate-changes)
+
+;; best used with prefix-key 'M-#'
+(define-key map "\M-+" 'outorg-edit-comments-and-propagate-changes)
+(define-key map "+" 'outorg-edit-comments-and-propagate-changes)
+#+END_EXAMPLE
+
+So just like editing e.g. an Emacs Lisp buffer or subtree (with
+outshine activated) in full Org-mode only involves pressing M-# M-#
+once to start editing, and then M-# to exit the edit-buffer, edting
+the comment-section of such a source-buffer and propagating the
+changes to several export-targets only involves pressing M-# M-+ once
+to start editing, and then M-# to exit the edit buffer (when M-# was
+set as outline-minor-mode prefix). 
 *** ChangeLog
 
 | date            | author(s)       | version |