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: Re: Comment conventions, adding an explicit Header. Date: Thu, 30 Oct 2014 13:33:07 +0100 Message-ID: <87sii5n3ek.fsf@gmail.com> References: <87d299eu1d.fsf@newcastle.ac.uk> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1414780662 11040 80.91.229.3 (31 Oct 2014 18:37:42 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 31 Oct 2014 18:37:42 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Oct 31 19:37:37 2014 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 1XkH4m-0002Ab-JN for ged-emacs-devel@m.gmane.org; Fri, 31 Oct 2014 19:37:32 +0100 Original-Received: from localhost ([::1]:40932 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XkH4m-0006yw-0Z for ged-emacs-devel@m.gmane.org; Fri, 31 Oct 2014 14:37:32 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:35067) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XkES9-0001ad-Em for emacs-devel@gnu.org; Fri, 31 Oct 2014 11:50:34 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Xjous-0007jV-FK for emacs-devel@gnu.org; Thu, 30 Oct 2014 08:33:31 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:40864) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Xjous-0007jR-8t for emacs-devel@gnu.org; Thu, 30 Oct 2014 08:33:26 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1Xjouq-0007rg-9X for emacs-devel@gnu.org; Thu, 30 Oct 2014 13:33:24 +0100 Original-Received: from g231225114.adsl.alicedsl.de ([92.231.225.114]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Thu, 30 Oct 2014 13:33:24 +0100 Original-Received: from tjolitz by g231225114.adsl.alicedsl.de with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Thu, 30 Oct 2014 13:33:24 +0100 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 87 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: g231225114.adsl.alicedsl.de User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.4 (gnu/linux) Cancel-Lock: sha1:za+RWioFcAaVgvo6gvhRJXKiZbI= 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:176128 Archived-At: phillip.lord@newcastle.ac.uk (Phillip Lord) writes: Hallo, > Currently, emacs uses comments of the form ";;; Commentary;" to > effectively indicate section headers in the buffer. I once did a pretty exhaustive analysis of the 'pathologies' of current emacs lisp conventions for file structuring: ,---- | https://lists.gnu.org/archive/html/emacs-devel/2013-10/msg00112.html `---- and while maintainers did acknowledge the weaknesses I described, the probability of introducing 'modern conventions' seems to tend towards zero. But for myself (always using outshine and navi-mode) I developed a default file structure and a new way to store library meta-data, see e.g. navi-mode.el: ,---- | 20 matches for "^;;;;? " in buffer: navi-mode.el | 1:;;; navi-mode.el --- major-mode for easy buffer-navigation | 7:;;;; MetaData | 23:;;;; Commentary | 270:;;;; ChangeLog | 278:;;; Requires | 283:;;; Mode Definitions | 314:;;; Variables | 315:;;;; Consts | 316:;;;; Vars | 335:;;;; Hooks | 340:;;;; Fonts | 341:;;;; Customs | 960:;;; Defuns | 961:;;;; Functions | 1471:;;;; Commands | 2156:;;; Menus and Keys | 2157:;;;; Menus | 2368:;;;; Keys | 2516:;;; Run Hooks and Provide | 2523:;;; navi-mode.el ends here `---- with several subtrees under these headlines, e.g. ,---- | 1:;;; navi-mode.el --- major-mode for easy buffer-navigation | 7:;;;; MetaData | 23:;;;; Commentary | 25:;;;;; About navi-mode | 65:;;;;; Usage | 245:;;;;; Installation | 264:;;;;; Emacs Version | 270:;;;; ChangeLog | 278:;;; Requires [...] `---- and this MetaData section, easily editable in Org-mode via outorg: ,---- | ;;;; MetaData | ;; :PROPERTIES: | ;; :copyright: Thorsten Jolitz | ;; :copyright-years: 2013+ | ;; :version: 2.0 | ;; :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 | ;; :git-repo: https://github.com/tj64/navi.git | ;; :git-clone: git://github.com/tj64/navi.git | ;; :inspiration: occur-mode org-mode | ;; :keywords: emacs navigation remote-buffer-control | ;; :END: `---- [Note that I had to use oldschool instead of outshine headers and to include the pathological last line ";;; navi-mode.el ends here", which is not a headline at all, to please MELPA] -- cheers, Thorsten