Mention org-agenda-dim-blocked-tasks
authorBastien Guerry <bzg@altern.org>
Wed, 6 Mar 2013 08:42:02 +0000 (09:42 +0100)
committerBastien Guerry <bzg@altern.org>
Wed, 6 Mar 2013 08:42:02 +0000 (09:42 +0100)
Also add index entries and links to variables in worg/doc.org

agenda-optimization.org

index e75f49e..4e8dedb 100644 (file)
@@ -5,6 +5,7 @@
 #+LANGUAGE:   en
 #+CATEGORY:   worg
 #+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
+#+LINK:       doc http://orgmode.org/worg/doc.html#%s
 
 When your Org files grow, agenda generation may slow down.
 
@@ -35,8 +36,21 @@ When matching against TODO-type tasks, Org will skip the ones marked as
 DONE or archived.  If you have many DONE tasks and archived tasks in your
 file, better to store them in another file.
 
+* Inhibit the dimming of blocked tasks
+
+#+INDEX: Dim blocked tasks
+#+INDEX: org-agenda-dim-blocked-tasks
+
+By default [[doc::org-agenda-dim-blocked-tasks][org-agenda-dim-blocked-tasks]] is set to t, which will dim blocked
+tasks.  For the agenda to get the relevant information, it needs to check
+against the headline up, and this takes time.  If you don't need this
+feature globally or for a specific agenda, turning it off will speed up
+agenda generation.
+
 * Inhibit agenda files startup options (Org > 8.0)
 
+#+INDEX: org-startup-folded
+
 When you run an agenda command, Org visits agenda files that are not yet
 visited.  When finding a file for the first time, Org checks the startup
 options and apply them to the buffer: those options are either globally set
@@ -44,7 +58,7 @@ through the =org-startup-*= variables or on a per-file basis through the
 =#+STARTUP= keyword.
 
 Especially, Org will honor the startup visibility status, as set by
-=org-startup-folded= or =#+STARTUP: folded=.
+[[doc::org-startup-folded][org-startup-folded]] or =#+STARTUP: folded=.
 
 This may slow down the operation of visiting a file very much, and the
 process of selecting agenda entries consequently.
@@ -62,25 +76,30 @@ many nested headlines.
 
 * Disable tag inheritance in agendas (Org > 8.0)
 
+#+INDEX: Tag inheritance
+#+INDEX: org-use-tag-inheritance
+#+INDEX: org-agenda-use-tag-inheritance
+#+INDEX: org-agenda-show-inherited-tags
+
 Defining inherited tags for a headline in the agenda takes time, because
 Org needs will grab inherited tags from higher level headlines.
 
 Whether the agenda knows about inherited tags for each task depends on
-=org-use-tag-inheritance= and =org-agenda-use-tag-inheritance=:
+[[doc::org-use-tag-inheritance][org-use-tag-inheritance]] and [[doc::org-agenda-use-tag-inheritance][org-agenda-use-tag-inheritance]]:
 
-- =org-use-tag-inheritance= controls whether tags are inherited for
-  tags-type agenda commands: =tags=, =tags-todo= and =tags-tree=.  This
-  variable also controls whether tags are inherited when running the
-  command =M-x org-sparse-tree RET= in an Org buffer (hence the name of
-  this variable, without the =org-agenda-= prefix.)
+- [[doc::org-use-tag-inheritance][org-use-tag-inheritance]] controls whether tags are inherited for tags-type
+  agenda commands: =tags=, =tags-todo= and =tags-tree=.  This variable also
+  controls whether tags are inherited when running the command =M-x
+  org-sparse-tree RET= in an Org buffer (hence the name of this variable,
+  without the =org-agenda-= prefix.)
 
-- =org-agenda-use-tag-inheritance= controls whether tags are inherited for
+- [[doc::org-agenda-use-tag-inheritance][org-agenda-use-tag-inheritance]] controls whether tags are inherited for
   other agenda types too: =todo=, =search=, =timeline=, =agenda=.
 
   Generally, you want this variable to be nil, because the headlines on
   those agenda types don't depend on tags (and /a fortiori/ on inherited
   ones.)  Still, the default is to use tags in all agenda types, because
-  =org-agenda-show-inherited-tags= needs to do the right thing by default.
+  [[doc::org-agenda-show-inherited-tags][org-agenda-show-inherited-tags]] needs to do the right thing by default.
 
 What to do?  If you don't need inherited tags in
 todo/search/timeline/agenda, just use this setting: