Call for documentation of contributed packages

Call for documentation of contributed packages

[Carsten Dominik]

[-- Attachment #1.1: Type: text/plain, Size: 1390 bytes --]

Hi,

I have started a new directory in Worg which will contain
documentation for the contributed packages that are living
in Org's contrib/ directory.  These packages are currently
not documented in the Org-mode manual, and the documentation
in the Lisp files themselves is relative hard to access for
people looking for interesting ideas and solutions that might
be found among these packages.

It seems to me that the best way to improve this would be to
put documentation for these packages on the web.

Worg now contains a directory org-contrib with an index page
listing the available pages, with a brief description of what
the package is about.  Right now, there is only one item,
the documentation Tom Breton wrote for org-choose.el.

So this is a call for authors of contributed packages to
document their package here.

To start up this process,  I am looking for a volunteer, with
the following task:

Go through the file commentaries of stuff in Org's contrib
directory and extract information from the file commentaries to
create a page for each of these packages.  Making a start in
this way would be great, and package authors and users could
then improve on this with time.  Anyone???

Once this is done, I will replace the "Extensions" section in
the manual with a link to the Worg pages, which will then be
a much better way to browse and find packages.

Thanks

- Carsten

[-- Attachment #1.2: Type: text/html, Size: 1960 bytes --]

[-- Attachment #2: Type: text/plain, Size: 204 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Call for documentation of contributed packages

[Philip Rooke]

On Tue, Feb 10, 2009 at 08:55:09AM +0100, Carsten Dominik wrote:
>
> To start up this process,  I am looking for a volunteer, with
> the following task:
>
> Go through the file commentaries of stuff in Org's contrib
> directory and extract information from the file commentaries to
> create a page for each of these packages.  Making a start in
> this way would be great, and package authors and users could
> then improve on this with time.  Anyone???

Hi Carsten,

(Apologies for not finishing this before when you asked me...) I am
back around for a bit and can volunteer if you would like.

Regards,

Phil

-- 

Blessed are they who can laugh at themselves for they shall never
cease to be amused.
    - Unknown

Re: Call for documentation of contributed packages

[Carsten Dominik]

If you are the author of one of the contributed packages,
and if you are planning to follow my call and write
a documentation file fo Worg,  please write a quick note to

      Philip Rooke <phil@yax.org.uk>

so that he will not waste time extracting docs from your
package.

Thanks!

- Carsten


On Feb 10, 2009, at 8:55 AM, Carsten Dominik wrote:

> Hi,
>
> I have started a new directory in Worg which will contain
> documentation for the contributed packages that are living
> in Org's contrib/ directory.  These packages are currently
> not documented in the Org-mode manual, and the documentation
> in the Lisp files themselves is relative hard to access for
> people looking for interesting ideas and solutions that might
> be found among these packages.
>
> It seems to me that the best way to improve this would be to
> put documentation for these packages on the web.
>
> Worg now contains a directory org-contrib with an index page
> listing the available pages, with a brief description of what
> the package is about.  Right now, there is only one item,
> the documentation Tom Breton wrote for org-choose.el.
>
> So this is a call for authors of contributed packages to
> document their package here.
>
> To start up this process,  I am looking for a volunteer, with
> the following task:
>
> Go through the file commentaries of stuff in Org's contrib
> directory and extract information from the file commentaries to
> create a page for each of these packages.  Making a start in
> this way would be great, and package authors and users could
> then improve on this with time.  Anyone???
>
> Once this is done, I will replace the "Extensions" section in
> the manual with a link to the Worg pages, which will then be
> a much better way to browse and find packages.
>
> Thanks
>
> - Carsten
> _______________________________________________
> Emacs-orgmode mailing list
> Remember: use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Call for documentation of contributed packages

[Manish]

On Tue, Feb 10, 2009 at 1:25 PM, Carsten Dominik wrote:
[...]
> To start up this process, I am looking for a volunteer, with
> the following task:

> Go through thefile commentaries of stuff in Org's contrib directory
> and extract information from the file commentaries to create a page
> for each of these packages. Making a start in this way would be great,
> and package authors and users could then improve on this
> withtime. Anyone???

I have created and uploaded first draft of a document on
org-annotation-helper.el to Worg.

-- 
Manish