From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Alex Schroeder Newsgroups: gmane.emacs.xemacs.design,gmane.emacs.devel Subject: Re: INFO on add-ons Date: Wed, 04 Sep 2002 00:56:42 +0200 Sender: xemacs-design-admin@xemacs.org Message-ID: <873csqr8b9.fsf@emacswiki.org> References: <3D728E82.8000808@cox.net> <87vg5pe4pr.fsf@emacswiki.org> <3D73F919.5010706@cox.net> NNTP-Posting-Host: localhost.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: main.gmane.org 1031093669 27588 127.0.0.1 (3 Sep 2002 22:54:29 GMT) X-Complaints-To: usenet@main.gmane.org NNTP-Posting-Date: Tue, 3 Sep 2002 22:54:29 +0000 (UTC) Cc: xemacs-design@xemacs.org Return-path: Original-Received: from gwyn.tux.org ([207.96.1.200]) by main.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 17mMZ2-0007AV-00 for ; Wed, 04 Sep 2002 00:54:28 +0200 Original-Received: from gwyn.tux.org (localhost.localdomain [127.0.0.1]) by gwyn.tux.org (8.9.3/8.9.1) with ESMTP id SAA14589; Tue, 3 Sep 2002 18:56:03 -0400 Original-Received: (from turnbull@localhost) by gwyn.tux.org (8.9.3/8.9.1) id SAA14555 for xemacs-design-mailman@xemacs.org; Tue, 3 Sep 2002 18:55:47 -0400 Original-Received: (from mail@localhost) by gwyn.tux.org (8.9.3/8.9.1) id SAA14551 for turnbull@tux.org; Tue, 3 Sep 2002 18:55:47 -0400 Original-Received: from yxa.extundo.com (178.230.13.217.in-addr.dgcsystems.net [217.13.230.178]) by gwyn.tux.org (8.9.3/8.9.1) with ESMTP id SAA14547 for ; Tue, 3 Sep 2002 18:55:46 -0400 Original-Received: from relay01.cablecom.net (relay01.cablecom.net [62.2.33.101]) by yxa.extundo.com (8.12.6/8.12.6) with ESMTP id g83Mtjn3015108 (version=TLSv1/SSLv3 cipher=EDH-RSA-DES-CBC3-SHA bits=168 verify=NO) for ; Wed, 4 Sep 2002 00:55:45 +0200 Original-Received: from smtp.swissonline.ch (mail-4.swissonline.ch [62.2.32.85]) by relay01.cablecom.net (8.12.5/8.12.5/SOL/AWF/MXRELAY/20020820) with ESMTP id g83Msa20096283; Wed, 4 Sep 2002 00:54:39 +0200 (CEST) (envelope-from alex@emacswiki.org) Original-Received: from confusibombus (dclient217-162-239-43.hispeed.ch [217.162.239.43]) by smtp.swissonline.ch (8.11.6/8.11.6/SMTPSOL/AWF/2002040101) with ESMTP id g83MsXH28366; Wed, 4 Sep 2002 00:54:33 +0200 (MEST) Original-Received: from alex by confusibombus with local (Exim 3.35 #1 (Debian)) id 17mMbD-00008U-00; Wed, 04 Sep 2002 00:56:43 +0200 Original-To: emacs-devel@gnu.org X-Face: ^BC$`[IcggstLPyen&dqF+b2'zyK#r.mU*'Nms}@&4zw%SJ#5!/7SMVjBS7'lb;QK)|IPU5U'o1'522W4TyzB3Ab*IBo^iw]l4|kUbdZuUDO6=Um-.4IzhNiV'B"@K#jy_(wW|Zbk[34flKY^|PrQ?$u2\fKg^]AY>wOX#H32i In-Reply-To: <3D73F919.5010706@cox.net> ("David A. Cobb"'s message of "Mon, 02 Sep 2002 19:49:45 -0400") Original-Lines: 31 User-Agent: Gnus/5.090008 (Oort Gnus v0.08) Emacs/21.2.90 (i686-pc-linux-gnu) X-XEmacs-List: design Errors-To: xemacs-design-admin@xemacs.org X-BeenThere: xemacs-design@xemacs.org X-Mailman-Version: 2.0.1 Precedence: bulk List-Help: List-Post: List-Subscribe: , List-Id: Discussion of design and features for XEmacs. List-Unsubscribe: , Xref: main.gmane.org gmane.emacs.xemacs.design:1360 gmane.emacs.devel:7408 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:7408 "David A. Cobb" writes: > Alex Schroeder wrote: > >>Not me. > > Y? please. Most of the code I write fits into an elisp file. Instead of writing texinfo, and worrying about correct installation, and copyright info, and layouting, and cross references, I would rather just put the stuff in the Commentary section, and provide as much help as possible in the defgroup, defcustom, and defun statements. These docstrings are what programmers and users use in their daily life. The manuals are not used very often. They are nice to have for newbies, and for user-level features that are distributed over a big number of functions (such as how keymaps work, how extents work, how to write a regexp, how to navigate in a buffer, etc.). When I write sql.el, for example, I could copy and paste some stuff into a texinfo file. But keeping the stuff in sync would be even worse than keeping the Commentary in sync with the rest. The same is true for color-theme.el, ansi-color.el, master.el, etc. Actually, to be honest, I find the Emacs Wiki at emacswiki.org to be a wonderful compromise. I can put basic user-level docs there, and other people can contribute but just editing the pages and typing. No fuss about texinfo, copyrights, LaTeX, info, xref, etc. It just works. For me. :) Alex.