From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Luc Teirlinck Newsgroups: gmane.emacs.devel,gmane.mail.mh-e.devel Subject: Re: MH-E manual update Date: Sat, 11 Mar 2006 17:24:57 -0600 (CST) Message-ID: <200603112324.k2BNOvW23186@raven.dms.auburn.edu> References: <27306.1134088031@olgas.newt.com> <871wxfnisy.fsf@olgas.newt.com> <9353.1142107690@olgas.newt.com> <200603112135.k2BLZJE22058@raven.dms.auburn.edu> <11886.1142116037@olgas.newt.com> NNTP-Posting-Host: main.gmane.org X-Trace: sea.gmane.org 1142119843 9462 80.91.229.2 (11 Mar 2006 23:30:43 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 11 Mar 2006 23:30:43 +0000 (UTC) Cc: eliz@gnu.org, mh-e-devel@lists.sourceforge.net, emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sun Mar 12 00:30:37 2006 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1FIDXZ-0000PT-Oj for ged-emacs-devel@m.gmane.org; Sun, 12 Mar 2006 00:30:30 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1FIDXY-0000Kx-Qu for ged-emacs-devel@m.gmane.org; Sat, 11 Mar 2006 18:30:28 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1FIDXL-0000HA-UH for emacs-devel@gnu.org; Sat, 11 Mar 2006 18:30:15 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1FIDXK-0000Eh-4l for emacs-devel@gnu.org; Sat, 11 Mar 2006 18:30:15 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1FIDXJ-0000E8-TK for emacs-devel@gnu.org; Sat, 11 Mar 2006 18:30:13 -0500 Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu) by monty-python.gnu.org with esmtp (Exim 4.52) id 1FIDaq-0001fq-E6; Sat, 11 Mar 2006 18:33:52 -0500 Original-Received: from raven.dms.auburn.edu (raven.dms.auburn.edu [131.204.53.29]) by manatee.dms.auburn.edu (8.13.3+Sun/8.13.3) with ESMTP id k2BNU7jX007048; Sat, 11 Mar 2006 17:30:07 -0600 (CST) Original-Received: (from teirllm@localhost) by raven.dms.auburn.edu (8.11.7p1+Sun/8.11.7) id k2BNOvW23186; Sat, 11 Mar 2006 17:24:57 -0600 (CST) X-Authentication-Warning: raven.dms.auburn.edu: teirllm set sender to teirllm@dms.auburn.edu using -f Original-To: wohler@newt.com In-reply-to: <11886.1142116037@olgas.newt.com> (message from Bill Wohler on Sat, 11 Mar 2006 14:27:17 -0800) X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-2.0.1 (manatee.dms.auburn.edu [131.204.53.104]); Sat, 11 Mar 2006 17:30:07 -0600 (CST) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:51497 gmane.mail.mh-e.devel:11945 Archived-At: Bill Wohler wrote: 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}. If you are going to include the entire defcustom, you would obviously use @example. But if you then refer to Alphabetical outside of the @example, things get subtle. I believe that if you refer to the string "Alphabetical", which the programmer has to write in his defcustom, you use @code. However, if you refer to the text that actually appears in the Custom buffer, you use @samp. That is why you have @samp in the following quote from lispref/customize.texi: @example (choice (integer :tag "Number of spaces") (string :tag "Literal text")) @end example @noindent so that the menu offers @samp{Number of spaces} and @samp{Literal text}. It talks about the text in the menu, as opposed to the strings in the code. Sincerely, Luc.