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: Modern Conventions for Emacs Lisp files? Date: Mon, 08 Apr 2013 22:37:30 +0200 Message-ID: <87hajgu5bp.fsf@gmail.com> References: <87hajhswdh.fsf@gmail.com> <87y5csu7ml.fsf@gmail.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1365453469 26929 80.91.229.3 (8 Apr 2013 20:37:49 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 8 Apr 2013 20:37:49 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Apr 08 22:37:53 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 1UPIp6-0005v2-Oy for ged-emacs-devel@m.gmane.org; Mon, 08 Apr 2013 22:37:52 +0200 Original-Received: from localhost ([::1]:46917 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UPIp6-0002td-Cr for ged-emacs-devel@m.gmane.org; Mon, 08 Apr 2013 16:37:52 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:34416) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UPIox-0002gF-E9 for emacs-devel@gnu.org; Mon, 08 Apr 2013 16:37:48 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1UPIos-0001eV-Qg for emacs-devel@gnu.org; Mon, 08 Apr 2013 16:37:43 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:51358) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1UPIos-0001eJ-K4 for emacs-devel@gnu.org; Mon, 08 Apr 2013 16:37:38 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1UPIor-0005cS-OY for emacs-devel@gnu.org; Mon, 08 Apr 2013 22:37:37 +0200 Original-Received: from g231225015.adsl.alicedsl.de ([92.231.225.15]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 08 Apr 2013 22:37:37 +0200 Original-Received: from tjolitz by g231225015.adsl.alicedsl.de with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Mon, 08 Apr 2013 22:37:37 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 42 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: g231225015.adsl.alicedsl.de User-Agent: Gnus/5.130002 (Ma Gnus v0.2) Emacs/24.3 (gnu/linux) Cancel-Lock: sha1:ckjeOrHbE20kmytH1VwhWTWDd3Q= 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:158782 Archived-At: Stefan Monnier writes: >>>> 1. File structuring with outcommented Org-mode headlines (;; * Headline) >>> There is already a standard for that: >>> ;;; Headline >>> ;;;; SubHeadline >>> ;;;;; SubSubHeadline >>> outline-minor-mode understands it. >> ok, lets put it like this: I wanted to let fellow Emacs/Org-mode users >> know that they can have the same thing in Org-mode style now. > > I was responding to: > >> Would it make sense to define 'modern conventions for Emacs Lisp files' >> based on all this new functionality and the popularity of Org-mode? > > Your message wasn't quite clear on what those "modern" conventions would > look like. I'd be happy to refine/extend/tweak the existing > conventions, but switching to different ones would be a lot > more problematic. The modern conventions would just be that headlines are outcommented Org-mode headlines with whatever comment syntax the major-mode at hand uses. Thus the info about 'this is a headline' and 'this headline is level X' is entirely in the Org-mode headers, the comment-characters are only for that - outcommenting these headers. Thats the way outshine.el and outorg.el work, so they should in theory work with all kinds of major-modes where 'comment-region' and 'uncomment-region' are defined, even those not yet written. That are of course different conventions, and I did not want to push any big problematic moves or so. But with all the momentum and popularity Org-mode enjoys, maybe such an 'Org-mode' style structuring of source code files could become an accepted second choice (and if only in libraries that are not part of Emacs). -- cheers, Thorsten