[Orgmode] Org mode issue file

[David Maus]

Hello all,

The Org mode issue file located at

http://orgmode.org/worg/org-issues.php

was just updated with a explanations about the nomenclature of
keywords and tags, how the recorded issues flow inside the file, and
some remarks on operating on this file collaboratively.

Most notably the issue file is supposed to supersede the old todo
file[1], thus it includes a section with the open development task of
the old todo file.

I've attached a copy of the introduction to the issue and a
preliminary version of a library to operate on the issue file from
withing Gnus and Wanderlust.  Please see the commentary section of
org-issue.el for the functions it provides.

Regards and happy hacking,

  -- David

[1] http://orgmode.org/todo.html
--
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... address@hidden
Email..... address@hidden

org-issue.el
Description: Binary data

                      Open issues with Org mode
                      =========================

Date: 2010-06-13 18:21:25 CEST


Table of Contents
=================
Introduction 
    Nomenclature 
    Document structure and maintenance 
    Using this file 


Introduction 
~~~~~~~~~~~~~

This is a simple mailing list based tracker for issues and other
things about Org mode.  It is a replacement of the abandoned todo file
and incorporates it's structure and parts of the nomenclature.  The
purpose of this document is to keep track of issues, i.e. anything
that requires some kind of actions, and other things like
announcements, hacks, feature ideas and the like.

Nomenclature 
=============

On this page, TODO keywords are used in the following way:

     *Keyword*         Intention                                                
                                                                                
      
    
-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------
     *NEW*             A new issue that is not yet classifed.                   
                                                                                
      
     *TODO*            A task to be done.  This includes but is not limited to 
answers to user requests, development or documentation tasks.                   
       
     *ASSIGNED*        Someone started to take care of this task.  A property 
*ASSIGNEE* should provide a hint on who it is.                                  
        
     *IDEA*            A new idea, I have not yet decided what if anything I 
will do about it.                                                               
         
     *WISH*            A wish, probably voiced by someone on  address@hidden  
This is less than a new idea, more a change in existing behavior.               
     *DECLINED*        A feature or idea that was declined. Still in the list 
so that people can see it, complain, or still try to convince Carsten to 
implement it.  
     *INCONSISTENCY*   Some behavior in Org-mode that is not as clean and 
consistent as it should be.                                                     
            
     *BUG*             This needs to be fixed, as soon as possible.             
                                                                                
      
     *DONE*            Well, done is done.                                      
                                                                                
      

In addition, tags are used to provide more detailed context
information.  Currently these tags are used in this file:

     *Tag*     Context                                                
    ---------+-------------------------------------------------------
     *Babel*   Issue concerning the library of [Babel]                  
     *Mobil*   Issue concerning [MobileOrg]                             
     *Patch*   A patch is available via Org mode's [Patchwork tracker]  


     [Babel]: http://orgmode.org/worg/org-contrib/babel/index.php
     [MobileOrg]: http://mobileorg.ncogni.to/
     [Patchwork tracker]: 
http://patchwork.newartisans.com/project/org-mode/list/

Document structure and maintenance 
===================================

New issues hitting the Org mode [mailing list] are recorded on a
(almost) daily basis using a yet to be published library that allows
operating on the issue file from within Wanderlust and (partly) Gnus.

They are first filed to the heading *New Issues*.

In a second step issues beneath this heading are reviewed.  If an
issue triggers a development task it is properly classified (keywords,
tag) and refiled to heading *Development Task*.  If it is already
closed according to the mailing list, it is immediately closed and
moved to *Closed issues*.  If it cannot yet be classified or closed,
it stays where it is.


[mailing list]: http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Using this file 
================

This file is hosted and published on [Worg].  So you can either read the
file via your browser or check out Worg's git repository.

Everyone is encouraged to use this file to facilitate collaboration in
solving issue and extending Org mode.  Thus, you can operate on the
entries as you wish, as long as the ID property is kept intact.

Operating on this file includes, but is not limited to, classifying
new issues, doing research on an outstanding task, or grouping related
issues into a development task.  If you start to take care of an open
issue or task, please put a token in a headline property called
"ASSIGNEE", so others can see that you started to take care of this
issue.

[Worg]: http://orgmode.org/worg/

pgplGQDPjebmX.pgp
Description: PGP signature