Zsh Mailing List Archive
Messages sorted by:
Reverse Date,
Date,
Thread,
Author
Re: Bug in user guide
- X-seq: zsh-workers 28728
- From: Bart Schaefer <schaefer@xxxxxxxxxxxxxxxx>
- To: zsh-workers@xxxxxxx
- Subject: Re: Bug in user guide
- Date: Thu, 10 Feb 2011 07:04:31 -0800
- In-reply-to: <AANLkTinUgfiZkE0GkHt6L=ccbpXxBhFhZphOua=z3Si9@mail.gmail.com>
- List-help: <mailto:zsh-workers-help@zsh.org>
- List-id: Zsh Workers List <zsh-workers.zsh.org>
- List-post: <mailto:zsh-workers@zsh.org>
- Mailing-list: contact zsh-workers-help@xxxxxxx; run by ezmlm
- References: <AANLkTi=Nm7OZD3ku_6VF5V6zpUmqCvMc2if0Yu09P9nS@mail.gmail.com> <AANLkTimBbAwf-Cfa_Ki9NX-0_-gsO=51rX601xF8VqQ1@mail.gmail.com> <87ei7h2z52.fsf@ft.bewatermyfriend.org> <AANLkTinUgfiZkE0GkHt6L=ccbpXxBhFhZphOua=z3Si9@mail.gmail.com>
On Feb 10, 9:42am, cheer_xiao wrote:
} Subject: Re: Bug in user guide
}
} Some more thoughts about the user guide. The guide is, overall, well
} written. But I found two features missing in the user guide:
} 1) Mark the terms appearing for the first time in *bold*,
} 2) A comprehensive index.
} Does that sound fine to you all? If so, I'll take some time to improve
} the guide and post my improve version to the mailing list.
Just to be sure ... you're talking about
http://zsh.sourceforge.net/Guide/zshguide.html
??
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. As for
(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.
Based on SourceForge's progress so far we might have our CVS back by
sometime on Friday.
Messages sorted by:
Reverse Date,
Date,
Thread,
Author