Browse Source

Added a few index entries. (Work in progress.)

Bastien Guerry 7 years ago
parent
commit
f53a808a29

+ 14 - 12
index.org

@@ -50,20 +50,19 @@ backed up and synced (e.g.  by Dropbox), imported/exported, and accessed on
 the go (e.g. on an iPhone or Android smartphone).  It can even be used for
 authoring web pages and documents.
 
-Check out some [[file:org-screenshots.org][screenshots of Org-mode]] in action.  See [[file:org-quotes.org][what people have to say]] about
-Org-mode, and read a few [[file:org-testimonies/index.org][user stories]]!
+Check out some [[file:org-screenshots.org][screenshots of Org-mode]] in action.  See [[file:org-quotes.org][what people have to
+say]] about Org-mode, and read a few [[file:org-testimonies/index.org][user stories]]!
 
-Org-mode is distributed as part of the popular [[http://www.gnu.org/software/emacs/][Emacs]] text editor and runs wherever
-Emacs runs, including on Linux, Windows, and Mac.
-Written by Carsten Dominik, it is currently maintained by Bastien Guerry
-and used by many helpful people who, like you, are desperate to get and stay
-organized.
+Org-mode is distributed as part of the popular [[http://www.gnu.org/software/emacs/][Emacs]] text editor and runs
+wherever Emacs runs, including on Linux, Windows, and Mac.  Written by
+Carsten Dominik, it is currently maintained by Bastien Guerry and used by
+many helpful people who, like you, are desperate to get and stay organized.
 
-The page you're reading is part of =Worg=, a section of the [[http://orgmode.org/][Org-mode web site]]
-that is written by a volunteer community of Org-mode fans.
-It includes tutorials, ideas, code snippets, etc., shared to make your introduction
-and customization of Org-mode as easy as possible.  Worg is maintained by
-Matthew Lundin, a group of [[file:worgers.org][Worg contributors]], and maybe [[file:worg-todo.org][you]].
+The page you're reading is part of =Worg=, a section of the [[http://orgmode.org/][Org-mode web
+site]] that is written by a volunteer community of Org-mode fans.  It
+includes tutorials, ideas, code snippets, etc., shared to make your
+introduction and customization of Org-mode as easy as possible.  Worg is
+maintained by Matthew Lundin, a group of [[file:worgers.org][Worg contributors]], and maybe [[file:worg-todo.org][you]].
 
 * Org-Mode Resources
   :PROPERTIES:
@@ -72,6 +71,9 @@ Matthew Lundin, a group of [[file:worgers.org][Worg contributors]], and maybe [[
 
 ** Learn Org-Mode
 
+#+index: Tutorials
+#+index: Glossary
+
 - [[http://orgmode.org/][Org-mode Main Page]]      : The official page for Org-mode
 - [[file:org-tutorials/index.org][Org-mode Tutorials]]      : Your best starting point
 - [[file:org-glossary.org][Org-mode Glossary]]       : An explanation of org-mode terminology

+ 4 - 2
org-color-themes.org

@@ -16,7 +16,6 @@
 
 [[file:index.org][{Back to Worg's index}]]
 
-
 # Contributing Screenshots to this page.
 #
 # To make an addition to this page
@@ -29,7 +28,10 @@
 #    color theme and the link to your screen-shot respectively to the
 #    =screenshot= macro
 
-* Org Colour Themes.
+* Org Colour Themes
+
+#+index: Themes
+
 A popular way of customizing Emacs colours is to use the color-theme
 package (see [[http://www.emacswiki.org/emacs/ColorTheme][color-theme emacswiki page]].)
 

+ 2 - 0
org-conference.org

@@ -16,6 +16,8 @@
 
 This page gathers ideas and plans for a possible Org-mode conference.
 
+#+index: Conferences
+
 * List ideas of things we would do there
 
 * Find out what would be the best location/date

+ 3 - 2
org-configs/index.org

@@ -15,8 +15,9 @@ This page contains general information about Org-mode customization.
 
 * Org customization
 
-Org-mode is highly customizable, but can be used with very little
-setup.
+#+index: Customization
+
+Org-mode is highly customizable, but can be used with very little setup.
 
 - [[file:org-customization-guide.org][Org customization guide for beginners]]
 - [[file:org-customization-survey.org][Org customization survey results]]

+ 46 - 38
org-configs/org-config-examples.org

@@ -14,43 +14,50 @@
 
 * GTD setups
 
+#+index: GTD!Setup
+
 - David O'Toole [[http://orgmode.org/worg/code/elisp/dto-org-gtd.el][GTD configuration file]]
 
 * General Configuration/Customization
 
 ** Some useful keybindings
 
+#+index: Keybindings
+
 Here is a subset of my personal org-mode key-bindings that others may
 find useful.
 
 # please anyone else should feel free to edit/change/remove parts of
 # this example
 
-#+begin_example
-  (add-hook 'org-mode-hook (lambda ()
-                             (local-set-key "\M-n" 'outline-next-visible-heading)
-                             (local-set-key "\M-p" 'outline-previous-visible-heading)
-                             ;; table
-                             (local-set-key "\M-\C-w" 'org-table-copy-region)
-                             (local-set-key "\M-\C-y" 'org-table-paste-rectangle)
-                             (local-set-key "\M-\C-l" 'org-table-sort-lines)
-                             ;; display images
-                             (local-set-key "\M-I" 'org-toggle-iimage-in-org)
-                             ;; fix tab
-                             (local-set-key "\C-y" 'yank)
-                             ;; yasnippet (allow yasnippet to do it's thing in org files)
-                             (org-set-local 'yas/trigger-key [tab])
-                             (define-key yas/keymap [tab] 'yas/next-field-group)))
-#+end_example
+#+begin_src emacs-lisp
+  (add-hook 'org-mode-hook 
+            (lambda ()
+              (local-set-key "\M-n" 'outline-next-visible-heading)
+              (local-set-key "\M-p" 'outline-previous-visible-heading)
+              ;; table
+              (local-set-key "\M-\C-w" 'org-table-copy-region)
+              (local-set-key "\M-\C-y" 'org-table-paste-rectangle)
+              (local-set-key "\M-\C-l" 'org-table-sort-lines)
+              ;; display images
+              (local-set-key "\M-I" 'org-toggle-iimage-in-org)
+              ;; fix tab
+              (local-set-key "\C-y" 'yank)
+              ;; yasnippet (allow yasnippet to do it's thing in org files)
+              (org-set-local 'yas/trigger-key [tab])
+              (define-key yas/keymap [tab] 'yas/next-field-group)))
+#+end_src
+
+References and explanations of the above:
 
-References and Explanations of the above:
-- see [[* iimage in org (display images in org files)]] for an explanation
-  of the =org-toggle-iimage-in-org= function (inline images in
-  org-mode files).
-- [[http://code.google.com/p/yasnippet/][yasnippet]] is a tools for snippet expansion in Emacs.  Since Org-Mode
-  is descendant of text-mode, all text snippets will work inside of
-  org files, I also use the following to simplify the creation of
-  example and source code blocks.
+- see [[* iimage in org (display images in org files)]] for an explanation of
+  the =org-toggle-iimage-in-org= function (inline images in org-mode
+  files).
+
+- [[http://code.google.com/p/yasnippet/][yasnippet]] is a tools for snippet expansion in Emacs.  Since Org-mode is
+  descendant of text-mode, all text snippets will work inside of org files,
+  I also use the following to simplify the creation of example and source
+  code blocks.
 
 block
 #+begin_example
@@ -63,19 +70,20 @@ $0
 
 
 ** iimage in org (display images in org files)
+
 Thanks to many on the mailing list for this great addition to
-Org-Mode.  See [[http://www.netlaputa.ne.jp/~kose/Emacs/iimage.html][iimage]] for information on iimage-minor-mode.
+Org-Mode.  See [[http://www.netlaputa.ne.jp/~kose/Emacs/iimage.html][iimage]] for information on =iimage-minor-mode=.
 
-#+begin_example
-(add-to-list 'iimage-mode-image-regex-alist
-	     (cons (concat "\\[\\[file:\\(~?" iimage-mode-image-filename-regex
-			   "\\)\\]")  1))
-
-(defun org-toggle-iimage-in-org ()
-  "display images in your org file"
-  (interactive)
-  (if (face-underline-p 'org-link)
-      (set-face-underline-p 'org-link nil)
-      (set-face-underline-p 'org-link t))
-  (iimage-mode))
-#+end_example
+#+begin_src emacs-lisp
+  (add-to-list 'iimage-mode-image-regex-alist
+               (cons (concat "\\[\\[file:\\(~?" iimage-mode-image-filename-regex
+                             "\\)\\]")  1))
+  
+  (defun org-toggle-iimage-in-org ()
+    "display images in your org file"
+    (interactive)
+    (if (face-underline-p 'org-link)
+        (set-face-underline-p 'org-link nil)
+        (set-face-underline-p 'org-link t))
+    (iimage-mode))
+#+end_src

+ 76 - 33
org-configs/org-customization-guide.org

@@ -4,60 +4,68 @@
 #+LANGUAGE:  en
 #+OPTIONS:   H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:{} -:t f:t *:t TeX:t LaTeX:nil skip:t d:nil tags:not-in-toc
 
+
 * Introduction
   :PROPERTIES:
   :ID:       68EE02FB-4F09-4BDC-8577-AD4F60DE1B1B
   :END:
 
-Org-mode is a highly customizable package.  It currently contains
-close to 400 customization variables that can be changed to tweak
-every detail, and more than 260 are known to be actually used out
-there.
+#+index: Customization!Introduction
 
-However, as a beginner you do not care about this kind of flexibility.
-On this page, we have a list of five settings that you might want to
-try first in order to personalize your system.
+Org-mode is a highly customizable package.  It currently contains close to
+400 customization variables that can be changed to tweak every detail, and
+more than 260 are known to be actually used out there.
 
-Once you are done with that, we also have a list of some 40 variables
-that are [[http://orgmode.org/worg/org-configs/org-customization-survey.php][changed by many users]].
+However, as a beginner you do not care about this kind of flexibility.  On
+this page, we have a list of five settings that you might want to try first
+in order to personalize your system.
 
+Once you are done with that, we also have a list of some 40 variables that
+are [[http://orgmode.org/worg/org-configs/org-customization-survey.php][changed by many users]].
 
 * The Basics
 
+#+index: Customization!Basics
+
 ** Minimal customization
 
-The minimal customization needed to use Org-mode is -- *Nothing at
-all!* \par Org-mode works out of the box, and besides the steps described
-in the manual to [[http://orgmode.org/manual/Activation.html#Activation][activate]] it, /nothing is needed at all/.  Just open a
-/.org/ file, press =C-c [= to tell org that this is a file you want to
-use in your agenda, and start putting your life into plain text.
+#+index: Customization!Minimal
+
+The minimal customization needed to use Org-mode is -- *Nothing at all!*
+\par Org-mode works out of the box, and besides the steps described in the
+manual to [[http://orgmode.org/manual/Activation.html#Activation][activate]] it, /nothing is needed at all/.  Just open a /.org/
+file, press =C-c [= to tell org that this is a file you want to use in your
+agenda, and start putting your life into plain text.
 
 OK, for completeness, let's just repeat what is needed to activate
 Org-mode in files with /.org/ extension, and a few important key
 assignments.
 
 #+begin_src emacs-lisp
-(add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
-(global-set-key "\C-cl" 'org-store-link)
-(global-set-key "\C-ca" 'org-agenda)
-(global-font-lock-mode 1)
+  (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
+  (global-set-key "\C-cl" 'org-store-link)
+  (global-set-key "\C-ca" 'org-agenda)
+  (global-font-lock-mode 1)
 #+end_src
 
 ** Five small steps toward a personalized system
-
+   
 *** One: More TODO keywords
 
+#+index: Todo Keywords
+
 Define the TODO states you find useful and single letters for fast
-selection.  Customize the variable =org-todo-keywords= or simply do
-this right in the file with[fn:1:press =C-c C-c= in the line after
-changing it]:
+selection.  Customize the variable =org-todo-keywords= or simply do this
+right in the file with[fn:1:press =C-c C-c= in the line after changing it]:
 
 #+begin_src org
-,#+TODO: TODO(t) STARTED(s) WAITING(w) | DONE(d) CANCELED(c)
+  ,#+TODO: TODO(t) STARTED(s) WAITING(w) | DONE(d) CANCELED(c)
 #+end_src
 
 *** Two: Which tags do you use most?
 
+#+index: Tag
+
 You can always add tags freely and by hand, but if you configure the
 most important ones along with fast-access keys, life will be better.
 Configure the variable =org-tags-alist= or simply do this right in the
@@ -69,6 +77,8 @@ file with[fn:1]
 
 *** Three: Which files are relevant for the agenda?
 
+#+index: Agenda
+
 When Org compiles agenda views like the the agenda for the current
 week (=C-c a a=) or the global TODO list (=C-c a t=), it checks all
 files in the variable =org-agenda-files=.  Instead of setting this
@@ -88,14 +98,17 @@ as well.
 
 *** Five: Capture ideas with predefined templates
 
+#+index: Capture
+
 Use /remember/ to quickly capture ideas, tasks, and notes.  Add
+
 #+begin_src emacs-lisp
 (org-remember-insinuate)
 #+end_src
-to your setup and populate[fn:3: =M-x customize-variable RET
-org-remember-templates RET=] the variable =org-remember-templates=
-with templates and target locations.
 
+to your setup and populate[fn:3: M-x customize-variable RET
+org-remember-templates RET] the variable =org-remember-templates= with
+templates and target locations.
 
 * Pretend to be a power-user
 
@@ -106,12 +119,18 @@ frequently in the [[http://orgmode.org/worg/org-configs/org-customization-survey
 
 *** Basic setup
 
+#+index: Directory
+#+index: Agenda!Files
+#+index: Startup
+#+index: Archive!Location
+
 Here are a few things about basic setup that many people change.
 
 - org-directory :: Where are my Org files typically located?  Org
      acutally uses this variable only under rare circumstances, like
      when filing remember notes in an interactive way and prompting
      you for an Org file to put the note into.
+		   
 
 - org-agenda-files :: Which [[http://orgmode.org/manual/Agenda-files.html#Agenda-files][files]] do I want to be checked for entries
      when compiling my agenda?  Many people do not customize this one,
@@ -126,6 +145,13 @@ Here are a few things about basic setup that many people change.
 
 *** Editing behavior and appearance
 
+#+index: Appearance
+#+index: Follow links
+#+index: Completion
+#+index: Ido
+#+index: Levels
+#+index: Blank
+
 Besides being an organizer, Org-mode is also a text mode for writing
 and taking notes.  The following variables that influence basic
 editing behavior and the appearance of the buffer are often
@@ -159,6 +185,11 @@ customized:
 
 *** The TODO keywords
 
+#+index: Todo Keywords
+#+index: Todo Keywords!Faces
+#+index: Todo Keywords!Dependencies
+#+index: Checkbox
+
 - org-todo-keywords :: Which [[http://orgmode.org/manual/TODO-extensions.html#TODO-extensions][TODO keywords]] should be used?  Also you
      can define keys for [[http://orgmode.org/manual/Fast-access-to-TODO-states.html#Fast-access-to-TODO-states][fast access]] here.  Very many people use this,
      or define the keywords with a =#+TODO:= setting in the buffer.
@@ -174,6 +205,8 @@ customized:
 
 *** Tags
 
+#+index: Tag
+
 - org-tag-alist :: Which [[http://orgmode.org/manual/Tags.html#Tags][tags]] should be available?  Note that tags
      besides the configured ones can be used, but for the important
      ones you can define keys for [[http://orgmode.org/manual/Setting-tags.html#Setting-tags][fast access]] here.
@@ -186,12 +219,19 @@ customized:
 
 *** Progress logging
 
+#+index: Progress!Logging
+#+index: Logging
+
 - org-log-done :: Do you want to [[http://orgmode.org/manual/Progress-logging.html#Progress-logging][capture]] time stamps and/or notes when
      TODO state changes, in particular when a task is DONE?  A simple
      setting that many use is =(setq org-log-done 'time)=.
 
 *** Remember and Refile
 
+#+index: Remember
+#+index: Capture
+#+index: Refile
+
 - org-reverse-note-order :: When adding new entries (or tasks) to a
      list, do I want the entry to be first or last in the list?
 
@@ -217,6 +257,8 @@ location to the correct project.
 
 *** Agenda Views
 
+#+index: Agenda!Views
+
 - org-agenda-start-on-weekday :: Should the [[http://orgmode.org/manual/Weekly_002fdaily-agenda.html#Weekly_002fdaily-agenda][agenda]] start on Monday, or
      better today?
 
@@ -270,6 +312,9 @@ tasks in the agenda anyway.
 
 *** Export/Publishing setup
 
+#+index: Export
+#+index: Publish!Setup
+
 - org-export-with-LaTeX-fragments :: Should [[http://orgmode.org/manual/LaTeX-fragments.html#LaTeX-fragments][LaTeX fragments]] be
      converted to inline images for HTML output?
 
@@ -279,13 +324,11 @@ tasks in the agenda anyway.
 - org-publish-project-alist :: Set up projects that allow many files
      to be exported and [[http://orgmode.org/manual/Publishing.html#Publishing][published]] with a single command.
 
-
 * Become a true power user
 
-If you want to become a true power user, [[http://thread.gmane.org/gmane.emacs.orgmode/10804][see]] for yourself what
-some users do.  The Emacs customization system[fn:5:=M-x
-org-customize RET=] organizes all variables into a structure that can
-be used to easily [[http://orgmode.org/worg/org-tutorials/org-customize.html][find the one particular option]] you might be looking
-for.  Also, the [[http://orgmode.org/manual/][Org-mode manual]] and the [[http://orgmode.org/worg/org-faq.html][FAQ]] mention many variables in
-the appropriate context.
+If you want to become a true power user, [[http://thread.gmane.org/gmane.emacs.orgmode/10804][see]] for yourself what some users
+do.  The Emacs customization system[fn:5:=M-x org-customize RET=] organizes
+all variables into a structure that can be used to easily [[http://orgmode.org/worg/org-tutorials/org-customize.html][find the one
+particular option]] you might be looking for.  Also, the [[http://orgmode.org/manual/][Org-mode manual]] and
+the [[http://orgmode.org/worg/org-faq.html][FAQ]] mention many variables in the appropriate context.
 

+ 2 - 2
org-configs/org-customization-survey.org

@@ -6,6 +6,8 @@
 
 * Introduction
 
+#+index: Customization!Survey
+
 Here are the results from an Org-mode customization survey, done in
 January 2009.  Thanks to Manish for collecting and organizing the
 results!  These are just the most basic statistics you can run on
@@ -205,7 +207,6 @@ escape it so I replaced it with `#'.
 | 35. | Shaun Johnson         |                2 |
 | 36. | Scot Becker           |                2 |
 
-
 * The raw data
 
 # davison's r formulas for analysis
@@ -215,7 +216,6 @@ escape it so I replaced it with `#'.
 #+TBLR: table:org-variables-table
 #+TBLNAME: org-variables-table
 
-
 | / | <3> | <35>                                | <30>                           | <30>                           | Non-default? | <30>                           |
 |   | Submitter | Variable                            | Customized To                  | Default                        |              | Comment                        |
 |---+-----+-------------------------------------+--------------------------------+--------------------------------+--------------+--------------------------------|

+ 3 - 0
org-configs/org-hooks.org

@@ -16,6 +16,7 @@
 This is the list of Org-mode hooks and function variables, with their
 documentation strings:
 
+#+index: Hooks
 
 * Hooks and Function variables
 
@@ -1159,6 +1160,8 @@ Defined in: /org-xoxo.el/
 
 * Examples for using hooks
 
+#+index: Hooks!Examples
+
 Feel free to give example of how do you use these hooks.  Ideas for
 other hooks are also welcome.
 

+ 41 - 12
org-contribute.org

@@ -14,6 +14,8 @@
 
 [[file:index.org][{Back to Worg's index}]]
 
+#+index: Contribute
+
 * Types of contributions
 
 Every contribution to Org is very welcome.  Here is a list of areas where
@@ -51,6 +53,10 @@ your contribution will be useful:
 
 * Copyright issues when contributing to Emacs org-mode
 
+#+index: Copyright
+#+index: FSF
+#+index: Assignment
+
 Org is made of many files.  Most of them are also distributed as part of
 GNU Emacs.  These files are called the /Org core/, and they are all
 copyrighted by the [[http://www.fsf.org][Free Software Foundation, Inc]].  If you consider
@@ -59,26 +65,30 @@ your works in GNU Emacs to the FSF.  For this you need to complete [[http://orgm
 form]], send it to [[mailto:assign@gnu.org][assign@gnu.org]], and tell the Org-mode maintainer when this
 process is complete.  Some people consider this a hassle.  I don't want to
 discuss this in detail here - there are some good reasons for getting the
-copyright registered, an example is discussed in this [[http://twit.tv/floss117][FLOSS weekly podcast]].
-Furthermore, by playing according to the Emacs rules, we gain the fantastic
-advantage that every version of Emacs ships with Org-mode already fully
-built in.  So please consider doing this - it makes our work as maintainers
-so much easier, because we can then take your patches without any
-additional work.
+copyright registered, an example is discussed in this [[http://twit.tv/floss117][FLOSS weekly
+podcast]].  Furthermore, by playing according to the Emacs rules, we gain the
+fantastic advantage that every version of Emacs ships with Org-mode already
+fully built in.  So please consider doing this - it makes our work as
+maintainers so much easier, because we can then take your patches without
+any additional work.
 
-If you want to learn more about /why/ copyright assignments are
-collected, read this: [[http://www.gnu.org/licenses/why-assign.html][Why the FSF gets copyright assignments from
-contributors?]]
+If you want to learn more about /why/ copyright assignments are collected,
+read this: [[http://www.gnu.org/licenses/why-assign.html][Why the FSF gets copyright assignments from contributors?]]
 
 * For Org developers
-:PROPERTIES:
-:CUSTOM_ID: devs
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: devs
+  :END:
+
+#+index: Public key
 
 1. Send your public key to [[mailto:jasondunsmore%20AT%20gmail%20DOT%20com][Jason Dunsmore]].
+
 2. Wait for confirmation that your public key has been added to the server.
+
 3. Clone =org-mode.git= repository like this:
    : ~$ git clone orgmode@orgmode.org:org-mode.git
+
 4. Commit your changes and push them.
 
 If you are undertaking big changes, please create a dedicated branch for
@@ -88,11 +98,16 @@ them.
 
 ** Coding conventions
 
+#+index: Coding!Conventions
+
 Org is part of Emacs, so any contribution should follow the [[http://www.gnu.org/software/emacs/elisp/html_node/Coding-Conventions.html][GNU Emacs Lisp
 coding conventions]] described in Emacs manual.
 
 ** Sending patch with git
 
+#+index: Patch
+#+index: Git
+
 Org-mode is developed using /git/ as the version control system.  Git
 provides an amazing framework to collaborate on a project.  Git can be used
 to make patches and send them via email -- this is perfectly fine for minor
@@ -100,6 +115,9 @@ changes.
 
 ** Patches get caught on patchwork
 
+#+index: Patch
+#+index: Patchwork
+
 As long as these patches are formatted properly, they will be automatically
 registered at [[http://patchwork.newartisans.com/project/org-mode][John Wiegley's patchwork server]] and will then be accepted,
 rejected, or sent back to the author with a request for modification.
@@ -120,6 +138,8 @@ reformatting is not a problem.
 
 ** Sending quick fixes
 
+#+index: Fixes
+
 #+begin_quote
   This command will make a patch between the staging area (in your
   computer), and the file you modified:
@@ -138,6 +158,8 @@ reformatting is not a problem.
 
 ** Sending commits
 
+#+index: Commits
+
 For more significant changes, you might want to work in several steps and
 send each commit separately.  Here is the suggested workflow
 
@@ -165,6 +187,8 @@ commit message.
 
 ** Sharing changes from a public branch
 
+#+index: Git!Branch
+
 For more significant contributions, the best way to submit patches is
 through public branches of your repository clone.
 
@@ -211,6 +235,9 @@ through public branches of your repository clone.
 
 * Commit messages and ChangeLog entries
 
+#+index: ChangeLog
+#+index: Commit!Message
+
 We have decided to no longer keep a ChangeLog file to record changes to
 individual functions.  In a modern version control system like git,
 ChangeLog is duplicating information that should be in the commit message,
@@ -260,6 +287,8 @@ commit message and remove the indentation.
 
 * Copyrighted contributors to Org-mode
 
+#+index: Contributors
+
 Here is the list of people who have contributed actual code to the
 Org-mode core.  Note that the manual contains a more extensive list
 with acknowledgments, including contributed ideas!  The lists below

+ 56 - 53
org-dependencies.org

@@ -3,6 +3,8 @@
 
 * Dependencies
 
+#+index: Dependencies
+
 Certain parts of org-mode have dependencies on external packages. This
 file documents these dependencies. Many sections are placeholders,
 waiting for input. If you can, please contribute. If you think that
@@ -17,45 +19,49 @@ the job. Thanks!
 Version: Org-mode version 7.01trans (release_7.01h.224.gf6c09)
 
 ** TODO Exporting in general.
+
 Anything here?
 
 ** STARTED LaTeX export.
+
 The LaTeX class is selected using the construct
 
-:#+LaTeX_CLASS: <class>
+: #+LaTeX_CLASS: <class>
 
-org-latex predefines the treatment of the following LaTeX classes
-article, report, book, beamer - or you can roll your own. And
-you can, of course, customize the treatment to your heart's content.
-This assumes a standard LaTeX install.
+org-latex predefines the treatment of the following LaTeX classes article,
+report, book, beamer - or you can roll your own. And you can, of course,
+customize the treatment to your heart's content.  This assumes a standard
+LaTeX install.
 
-On Linux/Mac OSX/BSD, the TeXlive distribution is recommended.
-On Windows, most people prefer  MikTeX.
+On Linux/Mac OSX/BSD, the TeXlive distribution is recommended.  On Windows,
+most people prefer MikTeX.
 
 ** Where to get packages
-The best way to get these packages is by using the package manager
-that comes with your operating system. These generally contain many
-useful LaTeX packages.
-
-If that is not possible, then you can get individual LaTeX packages
-from the CTAN sites (see [[http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives][CTAN archives]] for more information), but the
-installation process is less straightforward (but more portable):
-generally speaking, a LaTeX package comes in two files: a .ins file
-and a .dtx file (usually packed in a zip or tgz archive). Processing
-the .ins file through latex separates out the code from the .dtx file
-and produces the pieces that need to be installed on your system, but
-then it is up to you to figure out where to copy these files on your
-system for TeX and friends to find them. Processing the .dtx file
-directly through latex produces the documentation of the package:
+
+The best way to get these packages is by using the package manager that
+comes with your operating system. These generally contain many useful LaTeX
+packages.
+
+If that is not possible, then you can get individual LaTeX packages from
+the CTAN sites (see [[http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives][CTAN archives]] for more information), but the
+installation process is less straightforward (but more portable): generally
+speaking, a LaTeX package comes in two files: a .ins file and a .dtx file
+(usually packed in a zip or tgz archive). Processing the .ins file through
+latex separates out the code from the .dtx file and produces the pieces
+that need to be installed on your system, but then it is up to you to
+figure out where to copy these files on your system for TeX and friends to
+find them. Processing the .dtx file directly through latex produces the
+documentation of the package:
 
     - latex foo.ins -> foo.sty, etc.
     - pdflatex foo.dtx -> foo.pdf
 
-Many questions are answered by the [[http://www.tex.ac.uk/cgi-bin/texfaq2html?introduction=yes][TeX FAQ]] site, although the
-search capability is fairly primitive by today's standards: you
-will have to search a bit more diligently.
+Many questions are answered by the [[http://www.tex.ac.uk/cgi-bin/texfaq2html?introduction=yes][TeX FAQ]] site, although the search
+capability is fairly primitive by today's standards: you will have to
+search a bit more diligently.
 
 *** STARTED article, book, report
+
 The LaTeX packages included by default are as follows:
 
 | LaTeX package | Ubuntu container package  | Options | Comments                          |
@@ -76,8 +82,6 @@ The LaTeX packages included by default are as follows:
 | amssymb       | texlive-base              |         | Math symbols                      |
 | hyperref      | texlive-latex-base        |         |                                   |
 
-
-
 *** TODO beamer
 *** STARTED Symbols
 
@@ -90,39 +94,37 @@ by basic LaTeX, but some require the presence of extra packages.
 | =\EUR=      | \EUR                     | marvosym      | texlive-fonts-recommended |
 | =\euro=     | \euro                    | eurosym       | texlive-fonts-recommended |
 
-Note that marvosym is now included as part of the default setup so you
-do not need to include the package explicitly.
+Note that marvosym is now included as part of the default setup so you do
+not need to include the package explicitly.
 
 ** STARTED PDF export.
 
 PDF export goes through LaTeX export first, so all the LaTeX dependencies
 apply here as well.
 
-Certain PDF viewers have been reported to produce more or less
-unreadable files if Adobe Type3 fonts are used in the document.
-Evince has been identified as one of those. One way around this
-problem is to not use Type3 fonts. Another is to use a viewer that
-does not mistreat Type 3 fonts.
+Certain PDF viewers have been reported to produce more or less unreadable
+files if Adobe Type3 fonts are used in the document.  Evince has been
+identified as one of those. One way around this problem is to not use Type3
+fonts. Another is to use a viewer that does not mistreat Type 3 fonts.
 
 You can find more information about this problem in the TeX FAQ:
 
 To find out whether a document uses Type3 fonts, open it with Acrobat
-Reader/Evince, select Properties from the File menu and then select
-the Fonts tab; alternatively, use the pdffonts program (part of the
-xpdf-reader package) from the command line.
+Reader/Evince, select Properties from the File menu and then select the
+Fonts tab; alternatively, use the pdffonts program (part of the xpdf-reader
+package) from the command line.
 
 It is probably impossible to get rid of Type3 fonts completely
-(particularly if you are using special symbols or languages that
-don't use the Latin alphabet: in such cases, font availability is more
-limited and you just might not be able to find Type1 fonts to do the
-job).
-
-For standard latin-alphabet languages that use the Computer
-Modern fonts (including small variations e.g. Polish and Czech), you
-*can* find Type1 versions: (XXX-needs fixing) the texlive-fonts-extra package (on
-Ubuntu/Debian) e.g. includes the AMS CM fonts which work well.
-Similar packages exist for other Linux distributions and probably
-for other operating systems as well.
+(particularly if you are using special symbols or languages that don't use
+the Latin alphabet: in such cases, font availability is more limited and
+you just might not be able to find Type1 fonts to do the job).
+
+For standard latin-alphabet languages that use the Computer Modern fonts
+(including small variations e.g. Polish and Czech), you *can* find Type1
+versions: (XXX-needs fixing) the texlive-fonts-extra package (on
+Ubuntu/Debian) e.g. includes the AMS CM fonts which work well.  Similar
+packages exist for other Linux distributions and probably for other
+operating systems as well.
 
 | Type1 font      | LaTeX package | Ubuntu container package |
 |-----------------+---------------+--------------------------|
@@ -133,9 +135,10 @@ for other operating systems as well.
 
 ** TODO DocBook export.
 
-
 ** STARTED HTML export.
+
 *** STARTED Exporting LaTeX fragments as images.
+
 LaTeX fragments can be exported as images for inclusion into HTML
 documents. For example, complicated mathematical expressions can be
 dealt with this way. This is done by creating a LaTeX file that
@@ -144,9 +147,9 @@ file and then processing it through dvipng. So, in addition to LaTeX,
 you will need dvipng: on Ubuntu, this is available in the "dvipng"
 package.
 
-The LaTeX file contains a somewhat different list of LaTeX packages.
-Note that this is the default list, determined by the value of the
-variable ``org-format-latex-header''.
+The LaTeX file contains a somewhat different list of LaTeX packages.  Note
+that this is the default list, determined by the value of the variable
+``org-format-latex-header''.
 
 | LaTeX package | Ubuntu container package | Options  |
 |---------------+--------------------------+----------|
@@ -156,6 +159,6 @@ variable ``org-format-latex-header''.
 | latexsym      | texlive-latex-base       |          |
 | eucal         | texlive-base             | mathscr  |
 
-** TODO org-plot.
+** TODO org-plot
 
-** TODO org-babel.
+** TODO org-babel

+ 7 - 4
org-devel.org

@@ -16,12 +16,12 @@
 
 [[file:index.org][{Back to Worg's index}]]
 
-
 Some org-mode related project currently being developed in worg.
 
-
 * Org Collector
 
+#+index: Collector
+
 Located in the =contrib/lisp/= directory of org-mode.
 
 A utility for collecting properties from the headers in an org file,
@@ -78,6 +78,9 @@ it might be better to put an exercise example here if someone has one.
 
 #<<fireforg>>
 * Fireforg, a Firefox extension for org interaction (EXPERIMENTAL)
+
+#+index: Fireforg
+
 Fireforg is a Firefox extension, that interacts with Emacs Org-mode.
 
 For the displayed URL it shows the associated tags in the status bar
@@ -591,8 +594,8 @@ The following notes should be taken into consideration before using Fireforg:
 #+END_QUOTE
 * Org mode issue tracking library
 
-A collection of helper functions to maintain the [[file:org-issues.org][Issue file]] from
-within Wanderlust and (partly) Gnus.
+A collection of helper functions to maintain the [[file:org-issues.org][Issue file]] from within
+Wanderlust and (partly) Gnus.
 
 You can download a current version of this file [[file:code/elisp/org-issue.el][here]].
 

File diff suppressed because it is too large
+ 543 - 333
org-faq.org


+ 130 - 41
org-glossary.org

@@ -1,10 +1,10 @@
+#+TITLE:      Org Glossary: An Explanation of Basic Org-Mode Concepts
+#+AUTHOR:     Worg people
+#+EMAIL:      mdl AT imapmail DOT org
 #+OPTIONS:    H:3 num:nil toc:1 \n:nil @:t ::t |:t ^:nil -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
 #+STARTUP:    align fold nodlcheck 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 Glossary: An Explanation of Basic Org-Mode Concepts
-#+AUTHOR:     Worg people
-#+EMAIL:      mdl AT imapmail DOT org
 #+LANGUAGE:   en
 #+PRIORITIES: A C B
 #+CATEGORY:   worg
@@ -14,6 +14,9 @@
 # Please feel free to add items or to complete any of the unfinished items.
 
 * The Glossary
+
+#+index: Glossary
+
 The org-manual does a great job of explaining the myriad features of
 org-mode. But for new users, the sheer number of options and features
 can be overwhelming.
@@ -35,9 +38,12 @@ description of possible uses. And feel free to add your own
 definitions by [[file:worg-about.org][editing Worg]].
 
 * Agenda
-:PROPERTIES:
-:CUSTOM_ID: agenda
-:END: 
+  :PROPERTIES:
+  :CUSTOM_ID: agenda
+  :END: 
+
+#+index: Agenda
+
 ** Definition
 
 The agenda allows you to create filtered views of the items in your
@@ -117,9 +123,12 @@ There are many more possibilities of configuring the agenda with
 [[http://orgmode.org/worg/org-tutorials/org-custom-agenda-commands.php][custom agenda commands]].
     
 * Agenda files
-:PROPERTIES:
-:CUSTOM_ID: agenda-files
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: agenda-files
+  :END:
+
+#+index: Agenda!Files
+
 ** Definition
 
 These are the files that are used to generate your [[#agenda][agenda]] views. When
@@ -181,9 +190,12 @@ An example:
     and/or files.
 
 * Archiving
-:PROPERTIES:
-:CUSTOM_ID: archiving
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: archiving
+  :END:
+
+#+index: Archiving
+
 ** Definition
 
 Archiving is a way of hiding and/or getting rid of old or unwanted
@@ -247,9 +259,12 @@ Here are a few ideas:
     archiving completed projects.
 
 * Category
-:PROPERTIES:
-:CUSTOM_ID: category
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: category
+  :END:
+
+#+index: Category
+
 ** Definition
 A category is the group an item belongs to.
 
@@ -305,7 +320,10 @@ for this.
 Here's one way to distinguish between categories and tags: an entry
 can belong to only one category but it can have multiple tags.
 
-* DEADLINE 
+* DEADLINE
+
+#+index: DEADLINE
+
 ** Definition
 
 A deadline is a special timestamp for indicating items that should be
@@ -356,9 +374,11 @@ You can add both a deadline and a scheduling timestamp to the same
 entry.
 
 * Docstring
-:PROPERTIES:
-:CUSTOM_ID: docstring
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: docstring
+  :END:
+
+#+index: Docstring
 
 ** Definition
 A [[http://en.wikipedia.org/wiki/Docstring][docstring]] is the documentation written as part of a emacs lisp
@@ -410,9 +430,12 @@ docstrings by browsing the customize interface (=M-x customize-group
 [RET] org=) or by typing =C-h v= or =M-x describe-variable=).
 
 * Drawers
-:PROPERTIES:
-:CUSTOM_ID: drawers
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: drawers
+  :END:
+
+#+index: Drawers
+
 ** Definition
 
 A drawer is a container that can hide information you don't want to
@@ -462,9 +485,12 @@ information you put in drawers will not be exported to HTML, LaTeX,
 etc.
 
 * Entry
-:PROPERTIES:
-:CUSTOM_ID: entry
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: entry
+  :END:
+
+#+index: Entry
+
 ** Definition
 
 An entry is the basic unit of data in org-mode. It consists of a
@@ -510,9 +536,12 @@ Here is a sample entry with a lot of data:
 #+end_src
 
 * Headline
-:PROPERTIES:
-:CUSTOM_ID: headline
-:END: 
+  :PROPERTIES:
+  :CUSTOM_ID: headline
+  :END: 
+
+#+index: Headline
+
 ** Definition
 A headline is the name for an outline heading in an org file.
 
@@ -576,6 +605,9 @@ outline structure into a powerful "database" of information, in which
 units of data can be nested within one another.
 
 * Inheritance
+
+#+index: Inheritance
+
 ** Definition
 
 Inheritance is a term used to describe the way in which [[#entry][entries]] in a
@@ -632,9 +664,12 @@ Finally, inheritance plays an important role in org-mode's column
 view.
 
 * Property
-:PROPERTIES:
-:CUSTOM_ID: property
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: property
+  :END:
+
+#+index: Property
+
 ** Definition
 
 A property is an arbitrary piece of "metadata" you can attach to an
@@ -696,9 +731,12 @@ are they for? Here are some of their uses:
       referenced easily via hyperlinks.
 
 * Tag
-:PROPERTIES:
-:CUSTOM_ID: tag
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: tag
+  :END:
+
+#+index: Tag
+
 ** Definition
 
 A tag is a label (or piece of "metadata") that is attached to a
@@ -818,9 +856,13 @@ considerations to keep in mind:
      -> FOLLOWUP -> etc.
 
 * Tree (subtree)
-:PROPERTIES:
-:CUSTOM_ID: tree
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: tree
+  :END:
+
+#+index: Tree
+#+index: Subtree
+
 ** Definition
 
 A tree is created by the structure of an outline. It consists of a
@@ -835,9 +877,12 @@ multiple nested entries. And, of course, subtrees are nested within
 larger trees.
 
 * Todo Keywords
-:PROPERTIES:
-:CUSTOM_ID: todo-keyword
-:END:
+  :PROPERTIES:
+  :CUSTOM_ID: todo-keyword
+  :END:
+
+#+index: Todo Keywords
+
 ** Definition
 
 A TODO keyword is a small keyword at the beginning of a headline that
@@ -895,17 +940,61 @@ record of when each event in the sequence happened.
 
 * TODO Awaiting definitions
 ** Agenda filtering
+
+#+index: Agenda!Filtering
+
 ** CLOCK 
+
+#+index: Clock
+
 ** Column view
+
+#+index: Column view
+
 ** Cycling
+
+#+index: Cycling
+
 ** Effort estimate
+
+#+index: Effort estimate
+
 ** Filetag
+
+#+index: Filetag
+
 ** Project
+
+#+index: Project
+
 ** Note
+
+#+index: Note
+
 ** List 
+
+#+index: List 
+
 ** Level
+
+#+index: Level
+
 ** Logging
+
+#+index: Logging
+
 ** SCHEDULED 
+
+#+index: SCHEDULED 
+
 ** Restriction lock
-** Table 
+
+#+index: Restriction lock
+
+** Table
+
+#+index: Table
+
 ** Timestamp
+
+#+index: Timestamp

+ 21 - 18
org-gtd-etc.org

@@ -16,32 +16,33 @@
 
 * Org and GTD
 
+#+index: GTD
+
 Org-mode is flexible enough to implement many different ways of
 organizing your projects.  A frequently discusses scheme is [[http://www.davidco.com/][David
 Allen's]] strategy for [[http://en.wikipedia.org/wiki/GTD][Getting Things Done]].  But it is clearly not the
 only way to us Org-mode for planning.  Here are a couple of links
 related to this topic.
 
-    - [[http://johnwiegley.com][John Wiegley]] has written an excellent document describing his
-      way of using Org-mode as a [[http://www.newartisans.com/2007/08/using-org-mode-as-a-day-planner.html][day planner]]. See also some later
-      messages for enhancements of his setup:
-      [[http://article.gmane.org/gmane.emacs.orgmode/2963][emacs-orgmode-2962]], [[http://article.gmane.org/gmane.emacs.orgmode/3629][emacs-orgmode-3629]]
+    - [[http://johnwiegley.com][John Wiegley]] has written an excellent document describing his way of
+      using Org-mode as a [[http://www.newartisans.com/2007/08/using-org-mode-as-a-day-planner.html][day planner]]. See also some later messages for
+      enhancements of his setup: [[http://article.gmane.org/gmane.emacs.orgmode/2963][emacs-orgmode-2962]], [[http://article.gmane.org/gmane.emacs.orgmode/3629][emacs-orgmode-3629]]
 
-    - [[http://members.optusnet.com.au/charles57/Creative/][Charles Cave]] has written an [[http://members.optusnet.com.au/~charles57/GTD/orgmode.html][article/tutorial]] about the basic
-      elements of GTD and how he implements them in Org-mode.  There
-      is also a [[http://www.legito.net/worg/org-tutorials/orgtutorial_dto-fr.php][french translation]] of this document.
+    - [[http://members.optusnet.com.au/charles57/Creative/][Charles Cave]] has written an [[http://members.optusnet.com.au/~charles57/GTD/orgmode.html][article/tutorial]] about the basic elements
+      of GTD and how he implements them in Org-mode.  There is also a
+      [[http://www.legito.net/worg/org-tutorials/orgtutorial_dto-fr.php][french translation]] of this document.
 
-      + More recently, Charles Cave has written another tutorial on
-        [[http://members.optusnet.com.au/~charles57/GTD/gtd_workflow.html][his GTD workflow in org-mode]], which includes a nice section on
-        effort estimates and custom agenda commands for GTD.
+      + More recently, Charles Cave has written another tutorial on [[http://members.optusnet.com.au/~charles57/GTD/gtd_workflow.html][his GTD
+        workflow in org-mode]], which includes a nice section on effort
+        estimates and custom agenda commands for GTD.
 
-    - There have been several threads on emacs-orgmode@gnu.org related
-      to GTD, the most important ones are:
+    - There have been several threads on emacs-orgmode@gnu.org related to
+      GTD, the most important ones are:
 
-      + [[http://thread.gmane.org/gmane.emacs.orgmode/683][Another GTD question]], which contains a discussion about GTD
-        and org-mode.
-      + In the same thread, there is a [[http://article.gmane.org/gmane.emacs.orgmode/715][post by Carsten]] summarizing
-        several options for implementing GTD in org-mode.
+      + [[http://thread.gmane.org/gmane.emacs.orgmode/683][Another GTD question]], which contains a discussion about GTD and
+        org-mode.
+      + In the same thread, there is a [[http://article.gmane.org/gmane.emacs.orgmode/715][post by Carsten]] summarizing several
+        options for implementing GTD in org-mode.
       + [[http://thread.gmane.org/gmane.emacs.orgmode/523][GTD, Projects and Next Actions in org-mode]] is a thread where
         several people describe their personal setup.
       + The [[http://thread.gmane.org/gmane.emacs.orgmode/4915][SOMEDAY/MAYBE vs. low priorities]] thread contains a
@@ -63,8 +64,10 @@ related to this topic.
 
 * Org and Pomodoro
 
-[[http://www.pomodorotechnique.com][Pomodoro]] is a time management technique.  In [[http://article.gmane.org/gmane.emacs.orgmode/29347][this thread]], Frédéric
-Couchet describes how he uses Org for Pomodoro:
+#+index: Pomodoro
+
+[[http://www.pomodorotechnique.com][Pomodoro]] is a time management technique.  In [[http://article.gmane.org/gmane.emacs.orgmode/29347][this thread]], Frédéric Couchet
+describes how he uses Org for Pomodoro:
 
 : I always start a clock when I work on a task. And for the Pomodoro
 : technique I use also the org-timer module with some configuration.

+ 1 - 1
org-hacks.org

@@ -1865,7 +1865,7 @@ remember templates, so that you are out of keys to assign those to.
 
 ** Org-mode and saveplace.el
 
-Fix a problem with saveplace.el putting you back in a folded position:
+Fix a problem with =saveplace.el= putting you back in a folded position:
 
 #+begin_src emacs-lisp
 (add-hook 'org-mode-hook

+ 3 - 3
org-translators.org

@@ -1,10 +1,10 @@
+#+TITLE:      Org-mode Import/Export Tools
+#+AUTHOR:     Worg people
+#+EMAIL:      mdl AT imapmail DOT org
 #+OPTIONS:    H:3 num:nil toc:nil \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-mode Import/Export Tools
-#+AUTHOR:     Worg people
-#+EMAIL:      mdl AT imapmail DOT org
 #+LANGUAGE:   en
 #+PRIORITIES: A C B
 #+CATEGORY:   worg

+ 4 - 1
org-tutorials/index.org

@@ -14,6 +14,8 @@
 
 [[file:../index.org][{Back to Worg's index}]]
 
+#+index: Tutorials
+
 * General Introductions to Org-mode
   :PROPERTIES:
   :ID:       5B439D78-F862-4380-959C-BEB542DFE352
@@ -64,6 +66,8 @@
   :ID:       50A0DEB1-4B63-4CC4-840E-313615C4BAE3
   :END:
 
+#+index: Setup
+
   In the following documents, the authors describe the details of
   their setup, along with the workflows they use to get organized with
   Org-mode.  While as a beginner you probably should start with only a
@@ -191,7 +195,6 @@
    meetings, for example of a commission or any other group, and for
    keeping track of the groups tasks.  [[file:org-meeting-tasks.org][Link to the tutorial]].
    
-
 * Personal Setup
 
   See also [[id:50A0DEB1-4B63-4CC4-840E-313615C4BAE3][Powerusers describe their setup]]