From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16161 invoked by alias); 11 Feb 2011 05:15:31 -0000 Mailing-List: contact zsh-workers-help@zsh.org; run by ezmlm Precedence: bulk X-No-Archive: yes List-Id: Zsh Workers List List-Post: List-Help: X-Seq: 28737 Received: (qmail 2758 invoked from network); 11 Feb 2011 05:15:28 -0000 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on f.primenet.com.au X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW autolearn=ham version=3.3.1 Received-SPF: pass (ns1.primenet.com.au: SPF record at _spf.google.com designates 209.85.210.171 as permitted sender) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc:content-type:content-transfer-encoding; bh=2bLf9w/XMnjGuiwfdg1TliHnsn1dwc6Bkt9dWdlWWJM=; b=Gs6fmiwIeUy/0Nug8SAUzJL3Ezy+sOrfwz4tAcvWWmVdemzfNARP/XIijUz7kYwS7x pkpKvjsnUTbed+wOkuFMfIsq5ynGxJL6IaAVinFUglEye43oauqYEu/SZu34iaOvaX1I SM6rdgH4EFtRistV9L1IpROq8SFTUfWv4DAs0= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-type:content-transfer-encoding; b=ZW4GjdADy2d2TJJ0UPnROjw/Vgl46CiCSW/GCb62wIqhiYWvjG/r3SuT7HajZSCLZ9 D46hihcjlpUh/s5O5zVSCiVWvOuORPToidAlgKmI2uURNj3Zfc+59UJ7BTXevyCf/rBR H6th6+Qp4m4hdwmUnJmUnF5lYfTfi6GO1rpa8= MIME-Version: 1.0 In-Reply-To: <110210070431.ZM30121@torch.brasslantern.com> References: <87ei7h2z52.fsf@ft.bewatermyfriend.org> <110210070431.ZM30121@torch.brasslantern.com> From: cheer_xiao Date: Fri, 11 Feb 2011 13:15:03 +0800 Message-ID: Subject: Re: Bug in user guide To: Bart Schaefer Cc: zsh-workers@zsh.org Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable On Thu, Feb 10, 2011 at 11:04 PM, Bart Schaefer wrote: > [snip] > Just to be sure ... you're talking about > =C2=A0 =C2=A0http://zsh.sourceforge.net/Guide/zshguide.html > ?? Yes. > We'd certainly welcome any help with the guide (or any other docs, for > that matter) so do jump in and send us suggested improvements. =C2=A0As f= or > (1) in particular ... although the guide can be read linearly it's > really more intended to to be navigated as hypertext, so adding more > cross-references to places where terms are explained would probably be > more useful than merely highlighting the "first" place they are used. > Which ought to be possible if you're constructing an index anyway. I think the user guide is intended for linear reading; it's quite hard for me to start somewhere in the middle. After all, that's what most "user guides" are; you should turn to the (more formal) documentation when you need reference. User guides are more like books, documentations dictionaries. Given its linear nature, I suppose that adding cross-references can be distracting and unnecessary (that's what the documentation needs), while highlighting the first appearance of terms is quite helpful. > Based on SourceForge's progress so far we might have our CVS back by > sometime on Friday. I'm looking forward to a heavily loaded "git pull"! (I'm not a native speaker so please correct my English if it sounds weird or impolite. Thanks!)