One docstring improvement and 2 docstring typos.
[rgr-org-mode.git] / ORGWEBPAGE / todo.org
blob8b158f59337387c53115e940f3bfc9f82cb71b10
1 #         -*- mode:org -*-
3 #+STARTUP:   align
4 #+TYP_TODO:  TODO IDEA WISH QUESTION INCONSISTENCY BUG | DONE DECLINED 
5 #+TAGS:      NEW(n)
6 #+OPTIONS:   H:2 num:t toc:t \n:nil @:t ::t |:t ^:t *:t TeX:t
7 #+ARCHIVE:   ::** Archived Tasks
8 #+EMAIL:     carsten.dominik@gmail.com
9 #+TITLE:     The Org-mode TODO list
11 * Introduction
13 This is a loose collection of ideas and TODO items for the future
14 development of Org-mode.  These ideas come from various sources,
15 mostly from emacs-orgmode@gnu.org, from direct emails to me, or from
16 my own day-dreaming.  I don't always mention the source of an idea,
17 out of laziness.  However, when I implement a good idea, I try to
18 mention the origin of this idea in the /Acknowledgments/ section of
19 the manual - let me know if I forgot to give /you/ credit for
20 something.
22 ** Nomenclature
23    On this page, I am using TODO keywords in the following way:
24    |-----------------+----------------------------------------------------|
25    | *Keyword*       | Intention                                          |
26    |-----------------+----------------------------------------------------|
27    | *TODO*          | A development  that is going to happen, once I have time or once I figure out how to do it. |
28    | *IDEA*          | A new idea, I have not yet decided what if anything I will do about it. |
29    | *WISH*          | A wish, probably voiced by someone on  emacs-orgmode@gnu.org.  This is less than a new idea, more a change in existing behavior. |
30    | *QUESTION*      | A question someone asked, that needs some thinking before it can be answered |
31    | *DECLINED*      | I have decided not to implement this feature, but I am keeping it in the list so that people can see it, complain, or still try to convince me. |
32    | *INCONSISTENCY* | Some behavior in Org-mode that is not as clean and consistent as I would like it to be. |
33    | *BUG*           | This needs to be fixed, as soon as possible.       |
34    | *DONE*          | Well, done is done.                                |
35    | /NEW/           | This is a tag, indicating recently added entries   |
36    |                 | <50>                                               |
37    |-----------------+----------------------------------------------------|
39    
40 * Tasks
42 ** Structure
43 *** TODO Get rid of all the \r instances, which were used only for XEmacs.
44 *** TODO proper visibility cycling for items
45     Make them not hide the text after the final list item.
46     This is not trivial, we cannot usenormal outline stuff,
47     needs a separate implementaiton.
48 *** WISH Inline TODO entries
49     A way to put a TODO entry without starting a new section.
51 ** Agenda issues
52 *** WISH Make more modes changeable from the agenda
53     These could be made available for toggling, just like
54     follow-mode. Examples:
55     - org-agenda-todo-list-sublevels
56     - org-tags-match-list-sublevels
57     - org-agenda-todo-ignore-scheduled
59 ** Links
60 *** WISH Variable of standard links for completion with C-c C-l
61     Or something like that, to make standard links fast.
62 *** IDEA Find all links to a specific file
63 *** IDEA Make info HTML links work for links to Info files
64     Info links of course only work inside Emacs.  However, many info
65     documents are on the web, so the HTML exporter could try to be
66     smart and convert an Info link into the corresponding link on the
67     web.  For example, we could use the GNU software site then
68     Name.HTML.  Here is the link to be used:
69     http://www.gnu.org/software/emacs/manual/html_node/ Another
70     question is, is this URL going to be stable so that it makes sense
71     to actually put this into org.el?
73 *** TODO Remove irretrievable links from /published/ HTML output
74     This is on David's table, and he will hopefully integrate a
75     mechanism for this into org-publish.el.  The discussion about this
76     was started by [[http://thread.gmane.org/gmane.emacs.orgmode/281][Austin Frank]]
78 *** TODO Document the character protection in links
79     I don't think this is really covered anywhere.
80     Maybe we also should protect characters in the visible part, to
81     make sure thing will never be on two lines...?
83 *** WISH Radio targets across files
84     I guess each org file could write a .orgtargets.filename file, if
85     it has any radio targets.
87 ** Tables
89 *** WISH Row formulas
90     @4=.....
92 *** WISH Make a variable that current line should be recomputed always
93     in each table, skipping headers of course.
95 *** BUG When computing in a narrowed column, aligning may go wrong.
96     Computing changes fields and does not yet see correctly if the column
97     width has changed, in the case of a narrowed column.
99 ** Compatibility issues
100 *** Emacs 21 compatibility
101     This is being phased out.  Almost everything works under Emacs 21,
102     but in the future I will make little effort to support it.
104 *** XEmacs compatibility
106 ** Exporting
107 *** IDEA Convert links to footnotes for ASCII export.
108     But the question is:  where should these footnotes be placed?
110 ** Publishing
112 We need to simplify the publishing options.  Here are some of the
113 options for publishing projects
115 *** Publishing options
117 :`:base-directory'       Directory containing publishing source files
119 :`:publishing-directory' Directory (possibly remote) where output files
120 :                        will be published.
122 :`:preparation-function' Function called before starting publishing
123 :                        process, for example to run `make' for updating
124 :                        files to be published.
126 :`:base-extension'  Extension (without the dot!) of source files.  This
127 :                   actually is a regular expression.
129 :`:exclude'         Regular expression to match file names that should
130 :                   not be published, even though they have been selected
131 :                   on the basis of their extension.
133 :`:include'         List of files to be included regardless of
134 :                   `:base-extension' and `:exclude'.
136 :`:publishing-function' Function executing the publication of a file.
137 :                       This may also be a list of functions, which will
138 :                       all be called in turn.
140 :`:link-validation-function'   Function to validate links
142 :`:auto-index'      When non-nil, publish an index during
143 :                   org-publish-current-project or org-publish-all.
145 :`:index-filename'  Filename for output of index. Defaults to `index.org'
146 :                   (which becomes `index.html').
148 :`:index-title'     Title of index page. Defaults to name of file.
150 :`:index-function'  Plug-in function to use for generation of index.
151 :                   Defaults to `org-publish-org-index', which generates
152 :                   a plain list of links to all files in the project.
154 *** TODO Document the :recursive option
155 *** QUESTION Does anyone use the index related options
156 *** QUESTION Remove :base-extension and only use :include
157 *** WISH Simple interaction between :include :exclude :recursive
158 *** QUESTION Use an export-directory option per file?
160 For now we use publishing-directory but this is not consistent with the
161 convention of using "publishing" when there is a /project/ to publish.
163 ** Miscellaneous Stuff
164 *** BUG Comments cannot be filled
165 *** WISH Inlining of images in Org-mode files
166 *** TODO Fixup outline-magic.el, so that it can be used.
167     
168 *** TODO Use the new argument of bibtex-url
169     Roland Winkler was kind enough to implement a new argument to the
170     `bibtex-url' command that allows me to retrieve the corresponding
171     URL, whether it is taken from a URL field or constructed in some
172     clever way.  Currently I am not using this, because too many
173     people use an old Emacs version which does not have this.
174     however, eventually I will implement this.
176 *** QUESTION Do we need a 43 folders implementation?
177     That could easily be done in an org-mode file.  But then, maybe
178     this should really be a paper thing. 
180 *** Priorities
181     Here is some information about priorities, which is not yet
182     documented.  Actually, I am not sur if the list here is correct
183 **** QUOTE Priorities
184     TODO entries: 1 or 1,2,...
185     DEADLINE is 10-ddays, i.e. it is 10 on the due day
186                           i.e. it goes above top todo stuff 7 days
187                                before due
188     SCHEDULED is 5-ddays, i.e. it is 5 on the due date
189                           i.e. it goes above top todo on the due day
190     TIMESTAMP is 0        i.e. always at bottom
191                           but as a deadline it is 100
192                           but if scheduled it is 99
193     TIMERANGE is 0        i.e. always at bottom
194     DIARY is 0            i.e. always at bottom
196     Priority * 1000
198 *** INCONSISTENCY: items don't grow/shrink due to promotion.
199     In plain lists, multiple demote/promote commands executed directly
200     after each other don't change the scope of the command - the
201     initially selected text continues to be selected.  This is
202     inconsistent with the behavior of outline sections, were the subtree
203     for promotion/demotion is newly defined after each command.  Which
204     convention is better?  Should this be consistent between trees and
205     plain lists?
207 *** QUESTION grep on directory does not yet work.
208     I am actually not sure, I might have addressed this already, but
209     my memory is failing me.  Needs some checking.
212 * Archive
213 ** Archived Tasks
214 * COMMENT HTML style specifications
216 # Local Variables: 
217 # org-export-html-style: "<link rel=stylesheet href=\"freeshell2.css\" type=\"text/css\"> <style type=\"text/css\"> .tag { color: red; font-weight:bold}</style>" 
218 # End: