From owner-freebsd-doc@FreeBSD.ORG  Mon Jul 22 03:37:12 2013
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: doc@FreeBSD.org
Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115])
 by hub.freebsd.org (Postfix) with ESMTP id 877D75C7
 for <doc@FreeBSD.org>; Mon, 22 Jul 2013 03:37:12 +0000 (UTC)
 (envelope-from wblock@wonkity.com)
Received: from wonkity.com (wonkity.com [67.158.26.137])
 (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by mx1.freebsd.org (Postfix) with ESMTPS id 4ABB9201E
 for <doc@FreeBSD.org>; Mon, 22 Jul 2013 03:37:12 +0000 (UTC)
Received: from wonkity.com (localhost [127.0.0.1])
 by wonkity.com (8.14.7/8.14.7) with ESMTP id r6M3b54V042682
 for <doc@FreeBSD.org>; Sun, 21 Jul 2013 21:37:05 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Received: from localhost (wblock@localhost)
 by wonkity.com (8.14.7/8.14.7/Submit) with ESMTP id r6M3b5bw042679
 for <doc@FreeBSD.org>; Sun, 21 Jul 2013 21:37:05 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Date: Sun, 21 Jul 2013 21:37:05 -0600 (MDT)
From: Warren Block <wblock@wonkity.com>
To: doc@FreeBSD.org
Subject: FDP Primer: emacs and vim
Message-ID: <alpine.BSF.2.00.1307212109460.42268@wonkity.com>
User-Agent: Alpine 2.00 (BSF 1167 2008-08-23)
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; format=flowed; charset=US-ASCII
X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3
 (wonkity.com [127.0.0.1]); Sun, 21 Jul 2013 21:37:05 -0600 (MDT)
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.14
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 22 Jul 2013 03:37:12 -0000

Multiple people have said the emacs configuration shown in the FDP 
Primer is outdated.  Of particular interest is the section at the end of 
the emacs chapter:

http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/psgml-mode.html


There is also a vim configuration shown in the Writing Style chapter on 
indentation, currently 12.3.3:

http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-guide.html

That also looks outdated (sgml rather than xml).


The proposal is two parts:

First, remove the "Using sgml-mode with Emacs" chapter altogether. 
Teaching users to use an editor is out of scope of the FDP Primer. 
(And reputed to be outdated, but so far emacs users have not volunteered 
to update it.)  This may have been a big deal back when it was added, 
but there are multiple XML-capable editors now, and their documentation 
will be more helpful to the user than a rarely-updated section in the 
FDP Primer.

Second, move the small configuration file entries for both editors into 
a new "Editor Configuration" appendix.  This will be easier for users to 
find and easier to keep updated.


So: emacs users, please provide a modern configuration for emacs.
     vim users, provide an updated configuration for vim.


Thanks!