From: Alan Mackenzie <acm@muc.de>
To: Thorsten Jolitz <tjolitz@gmail.com>
Cc: Bastien <bzg@gnu.org>,
"François Pinard" <pinard@iro.umontreal.ca>,
"Jonas Bernoulli" <jonas@bernoul.li>,
emacs-devel@gnu.org
Subject: Re: Modern Conventions for Emacs Lisp files?
Date: Mon, 8 Apr 2013 09:32:39 +0000 [thread overview]
Message-ID: <20130408093239.GA3810@acm.acm> (raw)
In-Reply-To: <87hajhswdh.fsf@gmail.com>
Morning, Thorsten!
On Mon, Apr 08, 2013 at 02:23:54AM +0200, Thorsten Jolitz wrote:
> Hi List,
> there are new ways (libraries) to make Emacs Lisp buffers similar to
> Org-mode buffers in looks and (outline) functionality.
> I made a screencast showing these new libraries for 'Org-mode outside
> Org-mode' (outshine, outorg, poporg, navi-mode) in action:
> ,----------------------------
> | http://youtu.be/nqE6YxlY0rw
> `----------------------------
I must admit, I spent more time listening to the music than paying
attention to the screen. ;-)
> (Watch in HD)
> Would it make sense to define 'modern conventions for Emacs Lisp files'
> based on all this new functionality and the popularity of Org-mode?
Maybe for new elisp files, and those old ones which somebody is prepared
to convert. But not as a standard applicable to all elisp files.
> Something like this:
> 1. File structuring with outcommented Org-mode headlines (;; * Headline)
> 2. Meta information not as free text anymore but as Org-mode properties,
> maybe like this:
> ,---------------------------------------------------------
> | * navi-mode.el --- major-mode for easy buffer-navigation
> | :PROPERTIES:
> | :copyright: Thorsten Jolitz
> | :copyright-years: 2013
> | :version: 0.9
> | :licence: GPL 2 or later (free software)
> | :licence-url: http://www.gnu.org/licenses/
> | :part-of-emacs: no
> | :author: Thorsten Jolitz
> | :author_email: tjolitz AT gmail DOT com
> | :inspiration: occur-mode org-mode
> | :keywords: emacs outline lisp
> | :END:
> `---------------------------------------------------------
> 3. A file template somehow similar to this:
> ,---------------------------------------------------------
> | * navi-mode.el --- major-mode for easy buffer-navigation
> | ** Commentary
> | *** About navi-mode
> | *** Usage
> | *** Installation
> | *** Emacs Version
> | ** ChangeLog
> | * Requires
> | * Mode Definitions
> | * Variables
> | ** Consts
> | ** Vars
> | ** Hooks
> | ** Fonts
> | ** Customs
> | *** Custom Groups
> | *** Custom Vars
> | * Defuns
> | ** Functions
> | ** Commands
> | * Menus and Keys
> | ** Menus
> | ** Keys
> | * Run Hooks and Provide
> `---------------------------------------------------------
I would be against this bit. I think that semantically close defined
entities should be close together. For example, cc-engine.el is divided
up into pages by ^Ls, and all the def{const,var,macro,subst,fun}s to do
with "A system for finding noteworthy parens before the point" are
together in that page. It is convenient to `narrow-to-page' to enclose
all these definitions together. This facility would be lost if all
definitions in the file (over 200 of them) were ordered as suggested
above.
> --
> cheers,
> Thorsten
--
Alan Mackenzie (Nuremberg, Germany).
next prev parent reply other threads:[~2013-04-08 9:32 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-08 0:23 Modern Conventions for Emacs Lisp files? Thorsten Jolitz
2013-04-08 9:32 ` Alan Mackenzie [this message]
2013-04-08 20:05 ` Thorsten Jolitz
2013-04-08 13:22 ` Stefan Monnier
2013-04-08 13:54 ` Andreas Röhler
2013-04-08 19:51 ` Thorsten Jolitz
2013-04-09 6:05 ` Andreas Röhler
2013-04-08 19:47 ` Thorsten Jolitz
2013-04-08 20:07 ` Stefan Monnier
2013-04-08 20:37 ` Thorsten Jolitz
2013-04-08 21:26 ` Stefan Monnier
2013-04-08 22:21 ` Thorsten Jolitz
2013-04-09 7:29 ` Bastien
2013-04-09 12:27 ` Stefan Monnier
2013-04-09 13:11 ` Bastien
2013-04-09 13:36 ` Andreas Röhler
2013-04-09 13:41 ` Bastien
2013-04-13 23:41 ` Thorsten Jolitz
2013-04-14 0:24 ` Stefan Monnier
2013-04-14 3:06 ` Stefan Monnier
2013-04-14 8:16 ` Thorsten Jolitz
2013-04-15 8:37 ` Thorsten Jolitz
2013-04-15 9:04 ` Eli Zaretskii
2013-04-15 11:16 ` Thorsten Jolitz
2013-04-15 13:13 ` Stefan Monnier
2013-04-15 9:09 ` Bastien
2013-04-08 20:55 ` Naming internal functions (was: Modern Conventions for Emacs Lisp files?) Christopher Schmidt
2013-04-08 21:28 ` Naming internal functions Stefan Monnier
2013-04-15 13:46 ` Christopher Schmidt
2013-04-15 14:07 ` Eli Zaretskii
2013-04-15 14:14 ` Christopher Schmidt
2013-04-15 14:25 ` Eli Zaretskii
2013-04-15 17:08 ` Christopher Schmidt
2013-04-15 14:16 ` xfq
2013-04-08 22:41 ` Modern Conventions for Emacs Lisp files? Pascal J. Bourguignon
2013-04-08 23:42 ` Thorsten Jolitz
2013-04-09 2:11 ` Stefan Monnier
2013-04-09 8:04 ` Thorsten Jolitz
2013-04-09 12:23 ` Stefan Monnier
2013-04-10 19:06 ` Pascal J. Bourguignon
2013-04-10 20:04 ` Thorsten Jolitz
2013-04-09 9:18 ` Leo Liu
-- strict thread matches above, loose matches on Subject: below --
2013-04-09 14:00 Barry OReilly
2013-04-09 14:39 ` Nicolas Richard
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.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20130408093239.GA3810@acm.acm \
--to=acm@muc.de \
--cc=bzg@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=jonas@bernoul.li \
--cc=pinard@iro.umontreal.ca \
--cc=tjolitz@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 public inbox
https://git.savannah.gnu.org/cgit/emacs.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).