From: cheer_xiao <xiaqqaix@gmail.com>
To: Bart Schaefer <schaefer@brasslantern.com>
Cc: zsh-workers@zsh.org
Subject: Re: Bug in user guide
Date: Fri, 11 Feb 2011 13:15:03 +0800 [thread overview]
Message-ID: <AANLkTikVR6G_HmiVMBekp_mBXt9ebmZ4sgnDujzq_uLT@mail.gmail.com> (raw)
In-Reply-To: <110210070431.ZM30121@torch.brasslantern.com>
On Thu, Feb 10, 2011 at 11:04 PM, Bart Schaefer
<schaefer@brasslantern.com> wrote:
> [snip]
> Just to be sure ... you're talking about
> http://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. 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.
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!)
next prev parent reply other threads:[~2011-02-11 5:15 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-02-04 4:17 cheer_xiao
2011-02-09 9:34 ` cheer_xiao
2011-02-09 12:03 ` Frank Terbeck
2011-02-10 1:42 ` cheer_xiao
2011-02-10 15:04 ` Bart Schaefer
2011-02-11 5:15 ` cheer_xiao [this message]
2011-02-15 11:22 ` cheer_xiao
2011-02-15 11:37 ` Peter Stephenson
2011-02-16 13:33 ` cheer_xiao
2011-02-16 13:39 ` Peter Stephenson
2011-02-16 13:46 ` Mikael Magnusson
2011-02-16 13:48 ` cheer_xiao
2011-02-16 13:51 ` Mikael Magnusson
2011-02-16 13:56 ` cheer_xiao
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=AANLkTikVR6G_HmiVMBekp_mBXt9ebmZ4sgnDujzq_uLT@mail.gmail.com \
--to=xiaqqaix@gmail.com \
--cc=schaefer@brasslantern.com \
--cc=zsh-workers@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).