From: Drew Adams <drew.adams@oracle.com>
To: Xue Fuqiao <xfq.free@gmail.com>,
Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Thorsten Jolitz <tjolitz@gmail.com>, emacs-devel <emacs-devel@gnu.org>
Subject: RE: Modern conventions for structuring Emacs Lisp libraries
Date: Sat, 5 Oct 2013 21:47:56 -0700 (PDT) [thread overview]
Message-ID: <705f3517-b092-4418-b71a-fb7272cf0826@default> (raw)
In-Reply-To: <CAAF+z6EcQP0rOZEkB=LVQT+hXX++X=stB-C6CtFULuG34dM01g@mail.gmail.com>
> > You skipped the part I was looking for: the "Commentary:"
> > section. I do want this part to be refined. More specifically, I'd
> > like someone to come up with a description of a markup format to use
> > there (99% compatible with what we already have), together with code
> > that can turn such a Commentary section into nicely rendered text in an
> > Emacs buffer.
>
> Agreed. It can also be rendered as HTML in the packages description on
> elpa.gnu.org (and other package archives, maybe), along with the README.
FWIW, I use something simple: `finder-commentary' plus `linkd-mode' (from
`linkd.el'). Finder renders the Commentary in a simple way (strips comment
chars, hyperlinks file names, etc.). Linkd provides hyperlinked text.
I also usually provide a linkd-linked index to the Commentary sections (if
large) and other file sections.
Linkd is here: http://www.emacswiki.org/emacs/download/linkd.el.
next prev parent reply other threads:[~2013-10-06 4:47 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-05 13:31 Modern conventions for structuring Emacs Lisp libraries Thorsten Jolitz
2013-10-05 16:52 ` Richard Stallman
2013-10-06 16:40 ` Thorsten Jolitz
2013-10-06 18:04 ` Stefan Monnier
2013-10-07 0:36 ` Xue Fuqiao
2013-10-05 16:52 ` Richard Stallman
2013-10-05 19:18 ` Daniel Colascione
2013-10-06 8:20 ` legalese haters club Stephen J. Turnbull
2013-10-06 19:21 ` Modern conventions for structuring Emacs Lisp libraries Richard Stallman
2013-10-06 16:51 ` Thorsten Jolitz
2013-10-06 18:07 ` Stefan Monnier
2013-10-06 0:42 ` Stefan Monnier
2013-10-06 3:20 ` Xue Fuqiao
2013-10-06 4:47 ` Drew Adams [this message]
2013-10-06 17:42 ` Thorsten Jolitz
2013-10-06 18:13 ` Stefan Monnier
2013-10-06 19:31 ` Josh
2013-10-06 19:58 ` Pascal J. Bourguignon
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=705f3517-b092-4418-b71a-fb7272cf0826@default \
--to=drew.adams@oracle.com \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
--cc=tjolitz@gmail.com \
--cc=xfq.free@gmail.com \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.