From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Thorsten Jolitz Newsgroups: gmane.emacs.devel Subject: Modern Conventions for Emacs Lisp files? Date: Mon, 08 Apr 2013 02:23:54 +0200 Message-ID: <87hajhswdh.fsf@gmail.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1365445643 3821 80.91.229.3 (8 Apr 2013 18:27:23 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 8 Apr 2013 18:27:23 +0000 (UTC) Cc: Bastien , =?utf-8?Q?Fran=C3=A7ois?= Pinard , Jonas Bernoulli To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Apr 08 20:27:27 2013 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1UPGmf-0004Y8-Ki for ged-emacs-devel@m.gmane.org; Mon, 08 Apr 2013 20:27:13 +0200 Original-Received: from localhost ([::1]:38830 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UP66l-0000C0-GE for ged-emacs-devel@m.gmane.org; Mon, 08 Apr 2013 03:03:15 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:35154) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UP66f-000086-K1 for emacs-devel@gnu.org; Mon, 08 Apr 2013 03:03:11 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UP66Z-0007EF-De for emacs-devel@gnu.org; Mon, 08 Apr 2013 03:03:09 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:47638) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UP66Z-0007De-7m for emacs-devel@gnu.org; Mon, 08 Apr 2013 03:03:03 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1UP63B-0008EN-D8 for emacs-devel@gnu.org; Mon, 08 Apr 2013 08:59:33 +0200 Original-Received: from g231111159.adsl.alicedsl.de ([92.231.111.159]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 08 Apr 2013 08:59:33 +0200 Original-Received: from tjolitz by g231111159.adsl.alicedsl.de with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 08 Apr 2013 08:59:33 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 72 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: g231111159.adsl.alicedsl.de User-Agent: Gnus/5.130002 (Ma Gnus v0.2) Emacs/24.3 (gnu/linux) Cancel-Lock: sha1:xQjumLrDgw4kVjQyqYRuW9VkKBw= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:158768 Archived-At: 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 `---------------------------- (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? 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 `--------------------------------------------------------- -- cheers, Thorsten