Re: Annotate files in org syntax

[Carsten Dominik <carsten.dominik@gmail.com>]

On Jan 15, 2008, at 1:06 PM, Phil Jackson wrote:

> Carsten Dominik <carsten.dominik@gmail.com> writes:
>
>> Can you say more on how you typically use this?
>
> At the moment I use it solely with code. Rather than put TODOs in the
> code itself I like to keep an org style list. As an off the top of my
> head example an entry might look like this:
>
> * ~/blah.pl
> ** TODO [/] Refactor extract_something function          :SPAM_ENGINE:
>    - [ ] 100% unit test coverage
>    - [ ] Replace substr/index calls with regexps
>
> As all of these are in one file I can use sparse trees to drill down  
> to
> a project (for example).

Thanks.

>
>
> I'm going to hack on it and make it project/branch aware... just  
> haven't
> figured out how yet :)


Yes, I guess you might want to have sections corresponding to functions
in a source code file or so.  Maybe you can get some inspiration from  
the
code i Emacs that produced ChangeLog entires (e.g. `add-change-log- 
entry').
These commands create an etnry consisting of a file name and some kind  
of
local section like a function name, a section in a texinfo document etc.


Best wishes

- Carsten