Browse Source

Documentation updates.

Carsten Dominik 17 years ago
parent
commit
7b73413b08
2 changed files with 37 additions and 29 deletions
  1. 31 24
      ORGWEBPAGE/Changes.org
  2. 6 5
      ORGWEBPAGE/index.org

+ 31 - 24
ORGWEBPAGE/Changes.org

@@ -21,27 +21,11 @@
   now `t'.  The main reason for this is that it is easier to
   now `t'.  The main reason for this is that it is easier to
   explain in the manual and will lead to fewer surprises.
   explain in the manual and will lead to fewer surprises.
 
 
-** Details
+- The former CONTRIB directory is now called "contrib".  This was
-*** New properties for customizing subtree export.
+  already the case in the git distribution, but the tar and zip
-When exporting a subtree by selecting it before calling the
+  archives still did this wrong.
-export command, you can now use the properties =EXPORT_TITLE=,
-=EXPORT_TEXT=, and =EXPORT_OPTIONS= to overrule the global
-=#+TITLE=, =#+TEXT=, and =#+OPTIONS= settings.  You can also the
-an export file name with =EXPORT_FILE_NAME= that will overrule
-the file name derived from the buffers file name.  As far as the
-options are concerned, the global =#+OPTIONS= will still be read,
-and only the options you give in the property will be
-overwritten.  For example:
 
 
-#+begin_src org
+** Details
-,#+OPTIONS: skip:nil
-,* Computer Tricks
-,  :PROPERTIES:
-,  :EXPORT_FILE_NAME: ct.html
-,  :EXPORT_TITLE: Steve's collected computer tricks
-,  :EXPORT_OPTIONS: h:2 toc:nil
-,  :END:
-#+end_src
  
  
 *** Statistics for TODO entries
 *** Statistics for TODO entries
 
 
@@ -53,18 +37,19 @@ that are neither TODO nor DONE are ignored.
 
 
 There have already been requests to automatically switch the
 There have already been requests to automatically switch the
 parent headline to DONE when all children are done.  I am not
 parent headline to DONE when all children are done.  I am not
-makeing this a default feature, because one needs to make many
+making this a default feature, because one needs to make many
 decisions about which keyword to use etc.  Instead of a complex
 decisions about which keyword to use etc.  Instead of a complex
 customization variable, I am providing a hook that can be used.
 customization variable, I am providing a hook that can be used.
 This hook will be called each time a TODO statistics cookie is
 This hook will be called each time a TODO statistics cookie is
 updated, with the cursor in the corresponding line.  Each
 updated, with the cursor in the corresponding line.  Each
 function in the hook will receive two arguments, the number of
 function in the hook will receive two arguments, the number of
-done entries, and the number of not-done entries.  Here is a
+done entries, and the number of not-done entries, and you can use
-example implementation:
+the hook to change the state of the headline.  Here is an example
+implementation:
 
 
 #+begin_src emacs-lisp
 #+begin_src emacs-lisp
 (defun org-summary-todo (n-done n-not-done)
 (defun org-summary-todo (n-done n-not-done)
-  "Switch entry to DONE when all subentries are done, to TODO otherwise."
+  "Switch entry to DONE when all sub-entries are done, to TODO otherwise."
   (let (org-log-done org-log-states)   ; turn off logging
   (let (org-log-done org-log-states)   ; turn off logging
     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
     (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
 
 
@@ -94,6 +79,28 @@ the inclusion of the entry.  In this way the UID remains unique,
 but a synchronization program can still figure out from which
 but a synchronization program can still figure out from which
 entry all the different instances originate.
 entry all the different instances originate.
 
 
+*** New properties for customizing subtree export.
+
+When exporting a subtree by selecting it before calling the
+export command, you can now use the properties =EXPORT_TITLE=,
+=EXPORT_TEXT=, and =EXPORT_OPTIONS= to overrule the global
+=#+TITLE=, =#+TEXT=, and =#+OPTIONS= settings.  You can also set
+an export file name with =EXPORT_FILE_NAME= that will overrule
+the file name derived from the buffer's file name.  As far as the
+options are concerned, the global =#+OPTIONS= will still be read,
+and only the options you give in the property will be
+overwritten.  For example:
+
+#+begin_src org
+,#+OPTIONS: skip:nil
+,* Computer Tricks
+,  :PROPERTIES:
+,  :EXPORT_FILE_NAME: ct.html
+,  :EXPORT_TITLE: Steve's collected computer tricks
+,  :EXPORT_OPTIONS: h:2 toc:nil
+,  :END:
+#+end_src
+
 * Version 6.03
 * Version 6.03
 
 
 ** Overview
 ** Overview

+ 6 - 5
ORGWEBPAGE/index.org

@@ -30,11 +30,12 @@ are extensive, to avoid that people will be printing the manual after
 each incremental release.  If you have an older version of the manual,
 each incremental release.  If you have an older version of the manual,
 just check the release notes and you will be up-to-date.
 just check the release notes and you will be up-to-date.
 
 
-This package works on Emacs 22, and (with minor restrictions) on Emacs
+This package works on Emacs 23 and 22, and (with minor restrictions)
-21 and XEmacs 21 (where you must also use /noutline.el/ shipped with
+on Emacs 21 and XEmacs 21 (where you must also use
-Org-mode).  The Emacs 22.1 release ships with Org-mode version 4.67c.
+/xemacs/noutline.el/ shipped with Org-mode).  The Emacs 22.2 release
-The latest CVS emacs trunk usually contains a fairly recent version,
+ships with Org-mode version 4.67d.  The latest CVS emacs trunk usually
-but may lag a bit behind the website release.
+contains a fairly recent version, but may lag a bit behind the website
+release.
 
 
 * Downloads
 * Downloads