From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Bill Wohler Newsgroups: gmane.mail.mh-e.devel,gmane.emacs.devel Subject: Re: MH-E manual update Date: Sat, 11 Mar 2006 14:27:17 -0800 Organization: Newt Software Message-ID: <11886.1142116037@olgas.newt.com> References: <27306.1134088031@olgas.newt.com> <871wxfnisy.fsf@olgas.newt.com> <9353.1142107690@olgas.newt.com> <200603112135.k2BLZJE22058@raven.dms.auburn.edu> NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1142116094 31334 80.91.229.2 (11 Mar 2006 22:28:14 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 11 Mar 2006 22:28:14 +0000 (UTC) Cc: eliz@gnu.org, mh-e-devel@lists.sourceforge.net, emacs-devel@gnu.org Original-X-From: mh-e-devel-admin@lists.sourceforge.net Sat Mar 11 23:28:12 2006 Return-path: Envelope-to: gmmd-mh-e-devel@m.gmane.org Original-Received: from lists-outbound.sourceforge.net ([66.35.250.225]) by ciao.gmane.org with esmtp (Exim 4.43) id 1FICZB-0006pE-Eg for gmmd-mh-e-devel@m.gmane.org; Sat, 11 Mar 2006 23:28:06 +0100 Original-Received: from sc8-sf-list1-b.sourceforge.net (sc8-sf-list1-b.sourceforge.net [10.3.1.7]) by sc8-sf-spam2.sourceforge.net (Postfix) with ESMTP id 0F32012C25; Sat, 11 Mar 2006 14:28:02 -0800 (PST) Original-Received: from sc8-sf-mx1-b.sourceforge.net ([10.3.1.91] helo=mail.sourceforge.net) by sc8-sf-list1.sourceforge.net with esmtp (Exim 4.30) id 1FICYY-0005az-HM for mh-e-devel@lists.sourceforge.net; Sat, 11 Mar 2006 14:27:26 -0800 Original-Received: from pop-gadwall.atl.sa.earthlink.net ([207.69.195.61]) by mail.sourceforge.net with esmtp (Exim 4.44) id 1FICYX-00029i-7a for mh-e-devel@lists.sourceforge.net; Sat, 11 Mar 2006 14:27:26 -0800 Original-Received: from h-68-165-5-58.snvacaid.dynamic.covad.net ([68.165.5.58] helo=olgas.newt.com) by pop-gadwall.atl.sa.earthlink.net with esmtp (Exim 3.36 #10) id 1FICYQ-0005b7-00; Sat, 11 Mar 2006 17:27:18 -0500 Original-Received: by olgas.newt.com (Postfix, from userid 1000) id D99B81707E; Sat, 11 Mar 2006 14:27:17 -0800 (PST) Original-Received: from olgas.newt.com (localhost [127.0.0.1]) by olgas.newt.com (Postfix) with ESMTP id D4B6016FA8; Sat, 11 Mar 2006 14:27:17 -0800 (PST) Original-To: Luc Teirlinck In-reply-to: <200603112135.k2BLZJE22058@raven.dms.auburn.edu> Comments: In-reply-to Luc Teirlinck message dated "Sat, 11 Mar 2006 15:35:19 -0600." X-Mailer: MH-E 7.93+cvs; nmh 1.1; GNU Emacs 22.0.50.14 X-Image-URL: http://www.newt.com/wohler/images/bill-diving.png Mail-Followup-To: emacs-devel@gnu.org, mh-e-devel@lists.sourceforge.net X-Spam-Score: 1.0 (+) X-Spam-Report: Spam Filtering performed by sourceforge.net. See http://spamassassin.org/tag/ for more details. Report problems to http://sf.net/tracker/?func=add&group_id=1&atid=200001 1.0 FORGED_RCVD_HELO Received: contains a forged HELO Original-Sender: mh-e-devel-admin@lists.sourceforge.net Errors-To: mh-e-devel-admin@lists.sourceforge.net X-BeenThere: mh-e-devel@lists.sourceforge.net X-Mailman-Version: 2.0.9-sf.net Precedence: bulk List-Unsubscribe: , List-Id: Forum for the MH-E developers List-Post: List-Help: List-Subscribe: , List-Archive: X-Original-Date: Sat, 11 Mar 2006 14:27:17 -0800 Xref: news.gmane.org gmane.mail.mh-e.devel:11940 gmane.emacs.devel:51489 Archived-At: Luc Teirlinck wrote: > Bill Wohler wrote: > > > @samp{"\\(<<\\([^\n]+\\)?\\)"}. If this regular expression is not <<<<<<< > > correct, the body fragment will not be highlighted with the face > > @code{mh-folder-body}. > > > > I think this usage is not a very good idea: @samp{foo} is typeset as > > `foo', so you will have here quotes inside quotes. I suggest to lose > > the inner quotes, since they are redundant IMO. > > They aren't redundant since the user actually has to enter the quotes in > his value. I agree that having quotes inside quotes doesn't look good, > but it's probably a necessary evil to be technically correct. > > Without the double quotes, the doubling up of backslashes is > incorrect, since that only is correct inside Lisp strings. I looked > at the Elisp manual and the convention seems consistently to be that > if you write a regexp in non-Lisp syntax, you use @samp, but if you > write a regexp in Lisp syntax, you use @code and definitely use the > double quotes. ...with three exceptions in strings.texi and text.texi. A quick grep in the Elisp manual didn't reveal any @samp{.*} (without quotes) that looked like they might be a variable's value. > That will still produce `"...."' in Info, but _not_ in > the printed manual. That would be preferable. In (texinfo) code: Thus, you should use `@code' for an expression in a program, for the name of a variable or function used in a program, or for a keyword in a programming language. If we are in agreement, this paragraph should be amended to say "for the name *or value* of a variable or function" since it would be inconsistent and complicate usage to use @code for string values and @samp for other values. If the customize rendering of a variable has user-friendly variants of the variable's values, then those user-friendly variants should perhaps be rendered in @code for good looks and consistency as well. For example: (defcustom mh-alias-insertion-location 'sorted "Specifies where new aliases are entered in alias files. This option is set to \"Alphabetical\" by default. If you organize your alias file in other ways, then adding aliases to the \"Top\" or \"Bottom\" of your alias file might be more appropriate." :type '(choice (const :tag "Alphabetical" sorted) (const :tag "Top" top) (const :tag "Bottom" bottom)) :group 'mh-alias) We'd use @code{'sorted} and @code{Alphabetical}. I just changed a handful of @samps to @codes in the manual for these user-friendly values, and I have to say it looks MUCH better in the HTML and PDF outputs (no change in info, of course). So, I'd be very happy to have the convention that any variable's value gets @code. If we are in agreement, can someone who has the Texinfo manual checked out make the clarification in the @code section? Thanks again for your valuable input, Luc. -- Bill Wohler http://www.newt.com/wohler/ GnuPG ID:610BD9AD Maintainer of comp.mail.mh FAQ and MH-E. Vote Libertarian! If you're passed on the right, you're in the wrong lane. ------------------------------------------------------- This SF.Net email is sponsored by xPML, a groundbreaking scripting language that extends applications into web and mobile media. Attend the live webcast and join the prime developer group breaking into this new coding territory! http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642