Documentation fixes.
[org-mode.git] / ORGWEBPAGE / todo.org
blob8b9b5a38048788627f4321f7a31d75b416dcce95
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 *** IDEA Make News HTML links work, using Google.
74     I can use Google groups with a message id to find a USENET message,
75     even if the original link points to gnus.
77 *** TODO Remove irretrievable links from /published/ HTML output
78     This is on David's table, and he will hopefully integrate a
79     mechanism for this into org-publish.el.  The discussion about this
80     was started by [[http://thread.gmane.org/gmane.emacs.orgmode/281][Austin Frank]]
82 *** TODO Document the character protection in links
83     I don't think this is really covered anywhere.
84     Maybe we also should protect characters in the visible part, to
85     make sure thing will never be on two lines...?
87 *** WISH Radio targets across files
88     I guess each org file could write a .orgtargets.filename file, if
89     it has any radio targets.
91 ** Tables
93 *** WISH Row formulas
94     @4=.....
96 *** WISH Make a variable that current line should be recomputed always
97     in each table, skipping headers of course.
99 *** BUG When computing in a narrowed column, aligning may go wrong.
100     Computing changes fields and does not yet see correctly if the column
101     width has changed, in the case of a narrowed column.
103 ** Compatibility issues
104 *** Emacs 21 compatibility
105     This is being phased out.  Almost everything works under Emacs 21,
106     but in the future I will make little effort to support it.
108 *** XEmacs compatibility
110 ** Exporting
111 *** IDEA Convert links to footnotes for ASCII export.
112     But the question is:  where should these footnotes be placed?
114 ** Publishing
116 We need to simplify the publishing options.  Here are some of the
117 options for publishing projects
119 *** Publishing options
121 :`:base-directory'       Directory containing publishing source files
123 :`:publishing-directory' Directory (possibly remote) where output files
124 :                        will be published.
126 :`:preparation-function' Function called before starting publishing
127 :                        process, for example to run `make' for updating
128 :                        files to be published.
130 :`:base-extension'  Extension (without the dot!) of source files.  This
131 :                   actually is a regular expression.
133 :`:exclude'         Regular expression to match file names that should
134 :                   not be published, even though they have been selected
135 :                   on the basis of their extension.
137 :`:include'         List of files to be included regardless of
138 :                   `:base-extension' and `:exclude'.
140 :`:publishing-function' Function executing the publication of a file.
141 :                       This may also be a list of functions, which will
142 :                       all be called in turn.
144 :`:link-validation-function'   Function to validate links
146 :`:auto-index'      When non-nil, publish an index during
147 :                   org-publish-current-project or org-publish-all.
149 :`:index-filename'  Filename for output of index. Defaults to `index.org'
150 :                   (which becomes `index.html').
152 :`:index-title'     Title of index page. Defaults to name of file.
154 :`:index-function'  Plug-in function to use for generation of index.
155 :                   Defaults to `org-publish-org-index', which generates
156 :                   a plain list of links to all files in the project.
158 *** TODO Document the :recursive option
159 *** QUESTION Does anyone use the index related options
160 *** QUESTION Remove :base-extension and only use :include
161 *** WISH Simple interaction between :include :exclude :recursive
162 *** QUESTION Use an export-directory option per file?
164 For now we use publishing-directory but this is not consistent with the
165 convention of using "publishing" when there is a /project/ to publish.
167 ** Miscellaneous Stuff
168 *** BUG Comments cannot be filled
169 *** QUESTION Inlining of images in Org-mode files
170 *** TODO Fixup outline-magic.el, so that it can be used.
171     
172 *** TODO Use the new argument of bibtex-url
173     Roland Winkler was kind enough to implement a new argument to the
174     `bibtex-url' command that allows me to retrieve the corresponding
175     URL, whether it is taken from a URL field or constructed in some
176     clever way.  Currently I am not using this, because too many
177     people use an old Emacs version which does not have this.
178     however, eventually I will implement this.
180 *** QUESTION Do we need a 43 folders implementation?
181     That could easily be done in an org-mode file.  But then, maybe
182     this should really be a paper thing. 
184 *** Priorities
185     Here is some information about priorities, which is not yet
186     documented.  Actually, I am not sur if the list here is correct
187 **** QUOTE Priorities
188     TODO entries: 1 or 1,2,...
189     DEADLINE is 10-ddays, i.e. it is 10 on the due day
190                           i.e. it goes above top todo stuff 7 days
191                                before due
192     SCHEDULED is 5-ddays, i.e. it is 5 on the due date
193                           i.e. it goes above top todo on the due day
194     TIMESTAMP is 0        i.e. always at bottom
195                           but as a deadline it is 100
196                           but if scheduled it is 99
197     TIMERANGE is 0        i.e. always at bottom
198     DIARY is 0            i.e. always at bottom
200     Priority * 1000
202 *** INCONSISTENCY: items don't grow/shrink due to promotion.
203     In plain lists, multiple demote/promote commands executed directly
204     after each other don't change the scope of the command - the
205     initially selected text continues to be selected.  This is
206     inconsistent with the behavior of outline sections, were the subtree
207     for promotion/demotion is newly defined after each command.  Which
208     convention is better?  Should this be consistent between trees and
209     plain lists?
211 *** INCONSISTENCY: M-TAB does not work on plain lists.  Why???
213 *** QUESTION grep on directory does not yet work.
214     I am actually not sure, I might have addressed this already, but
215     my memory is failing me.  Needs some checking.
217 *** DECLINED Inlining of external files
219 * Archive
220 ** Archived Tasks
221 *** DONE Definition lists, like in Muse
222     :PROPERTIES:
223     :ARCHIVE_TIME: 2008-05-29 Thu 17:01
224     :ARCHIVE_FILE: ~/lib/emacs/work/org-mode/ORGWEBPAGE/todo.org
225     :ARCHIVE_OLPATH: Tasks/Structure
226     :ARCHIVE_CATEGORY: todo
227     :ARCHIVE_TODO: DONE
228     :END:
229 *** DONE Sort TODO entries according to type?
230     :PROPERTIES:
231     :ARCHIVE_TIME: 2008-09-19 Fri 13:16
232     :ARCHIVE_FILE: ~/lib/emacs/work/org-mode/ORGWEBPAGE/todo.org
233     :ARCHIVE_OLPATH: Tasks/Agenda issues
234     :ARCHIVE_CATEGORY: todo
235     :ARCHIVE_TODO: DONE
236     :END:
237     This would apply for the list collection, not in the day entries.
238     However, I could also have a TODO keyword criterion that could be
239     used in the day entries, as one of the minor criteria.
241     Right now we can already sort an outline tree according to
242     children, this is nice already.  However, sorting in the agenda
243     would be nice too.  The problem is, that i the agenda we may have
244     todo lists from a number of different buffers, so the sorting
245     relation may not be clear.....
247 * COMMENT HTML style specifications
249 # Local Variables: 
250 # org-export-html-style: "<link rel=stylesheet href=\"freeshell2.css\" type=\"text/css\"> <style type=\"text/css\"> .tag { color: red; font-weight:bold}</style>" 
251 # End: