From: Bart Schaefer <schaefer@brasslantern.com>
To: zsh-workers@zsh.org
Subject: Re: Bug in user guide
Date: Thu, 10 Feb 2011 07:04:31 -0800 [thread overview]
Message-ID: <110210070431.ZM30121@torch.brasslantern.com> (raw)
In-Reply-To: <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.
next prev parent reply other threads:[~2011-02-10 15:04 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 [this message]
2011-02-11 5:15 ` cheer_xiao
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=110210070431.ZM30121@torch.brasslantern.com \
--to=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).