From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16671 invoked from network); 5 Jun 1998 10:15:37 -0000 Received: from math.gatech.edu (list@130.207.146.50) by ns1.primenet.com.au with SMTP; 5 Jun 1998 10:15:37 -0000 Received: (from list@localhost) by math.gatech.edu (8.8.5/8.8.5) id GAA18627; Fri, 5 Jun 1998 06:10:53 -0400 (EDT) Resent-Date: Fri, 5 Jun 1998 06:10:53 -0400 (EDT) From: Zefram Message-Id: <199806051011.LAA22487@taos.demon.co.uk> Subject: Re: Use of tt() formatting in yodl doc sources To: schaefer@brasslantern.com (Bart Schaefer) Date: Fri, 5 Jun 1998 11:11:22 +0100 (BST) Cc: pws@ifh.de, zsh-workers@math.gatech.edu In-Reply-To: <980605014430.ZM17329@candle.brasslantern.com> from "Bart Schaefer" at Jun 5, 98 01:44:30 am X-Mailer: ELM [version 2.4 PL25] MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Resent-Message-ID: <"dYH1C1.0.-Y4.jGyTr"@math> Resent-From: zsh-workers@math.gatech.edu X-Mailing-List: archive/latest/4053 X-Loop: zsh-workers@math.gatech.edu Precedence: list Resent-Sender: zsh-workers-request@math.gatech.edu Bart Schaefer wrote: >On the other hand, it does seem silly to -both- quote things -and- set >them in a special typeface. Why do the .yo files do stuff like `tt(&)' >in the first place? The quote marks indicate that the enclosed text is not a part of the text of the documentation (i.e., that it is being quoted). The special typefaces (tt(), var()) indicate the precise nature of the text. Completely distinct purposes. Observe the places where tt() is used without quotes -- there is text of the form Type `tt(xyzzy)' to let zsh know you have played tt(advent). Saying `plugh' aloud doesn't have much effect, however. In this case, "zsh" is normal text (a name), "advent" is a command name ocurring in the main text, "plugh" is a normal word that is being quoted (it's the user that says `plugh', not the documentation), and "xyzzy" is some text to be typed literally that is being quoted. We probably don't follow these conventions everywhere, but in the conversion to yodl I fixed a lot of bad markup, and I've been watching the documentation ever since, so it's pretty consistent. This stuff should probably go into the zsh-development-guide. > (The remaining sillyness is with >stuff like tt(`) and tt(') which become ``' and `'', but at the moment >they often become ```'' and ``''' which is totally weird.) Weird it is. ``' isn't too bad, however, even without the special typefaces. -zefram