emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Torsten Wagner <torsten.wagner@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Propose: add developer infos to the manual
Date: Thu, 04 Mar 2010 11:41:04 +0900	[thread overview]
Message-ID: <4B8F1DC0.4010702@gmail.com> (raw)

Dear All,

I'm really an org-mode beginner and even more I'm a bloody emacs-lisp 
beginner. Nevertheless, I try to understand here and there who things 
work out and tweak some things here and there. Nothing which might be 
worse to share yet .... but I'm on my way to learn about the internals 
of org-mode.

Normally I start to consult the manual and see if I could achive what I 
am looking for by the given function set of org-mode. If I concern a lot 
I try to dig down threw the source-code for different functions to see 
how they work.
I wonder whether it might be possible to add a footnote to every 
explained function with a link to the source-file.
By this way it would be much easier to find the desired code-lines. 
Maybe bug-fixing will be easier as well. I assume there are many 
org-mode users with solid lisp knowledge who might be able to help 
bug-fixing but who have no idea where to find the necessary code.

I know I can use C-h a in emacs to search for the desired function and 
jump to the lisp code. Just thought some redundancy in the manual might 
help to attract more people to contribute.

Since the manual and the lisp files are plain text, it might be easy to 
write a function which does this automatically?!

Furthermore, after I thought about this I started to wonder whether 
org-mode + babel could be used to literally program org-mode itself. 
This would result in a very nice developer manual and is a very nice 
example to literate programming.

Just some thoughts

Bye

Torsten

             reply	other threads:[~2010-03-04  2:41 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-03-04  2:41 Torsten Wagner [this message]
2010-03-04  6:26 ` Propose: add developer infos to the manual Carsten Dominik

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4B8F1DC0.4010702@gmail.com \
    --to=torsten.wagner@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).