From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 18883 invoked from network); 31 Mar 2000 10:37:06 -0000 Received: from sunsite.auc.dk (130.225.51.30) by ns1.primenet.com.au with SMTP; 31 Mar 2000 10:37:06 -0000 Received: (qmail 16157 invoked by alias); 31 Mar 2000 10:36:48 -0000 Mailing-List: contact zsh-workers-help@sunsite.auc.dk; run by ezmlm Precedence: bulk X-No-Archive: yes X-Seq: 10356 Received: (qmail 16145 invoked from network); 31 Mar 2000 10:36:47 -0000 Message-ID: <38E47FB6.A2EDF8E1@u.genie.co.uk> Date: Fri, 31 Mar 2000 11:36:38 +0100 From: Oliver Kiddle X-Mailer: Mozilla 4.72 [en] (Win95; I) X-Accept-Language: en MIME-Version: 1.0 To: zsh-workers@sunsite.auc.dk Subject: documentation (was Re: New user questions) References: <200003310828.KAA08549@beta.informatik.hu-berlin.de> Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Sven Wischnowsky wrote: > Andrej Borsenkow wrote: > > This is in modules section (Zle module). But, yes, I never liked this. > > Users are not supposed to know, if command is implemented in core or > > module. > But without the module they won't get the builtin (parameter, > condition code, whatever...), so they may be in for a surprise. I agree with Andrej here - I generally do know when a command is implemented in a module yet I still find myself looking among all the other builtins before my slow brain kicks in and I remember that I should be looking at the back. I think we should move the basic descriptions for fundamental builtins like bindkey to where the builtins are all described and add a reference to it from the zsh modules section. It would also make them easier to find in printed manuals because it is easy to flick through the manual until getting a glimpse of something that looks like the builtins and then using the alphabetical order to find the right one. Also on the subject of the arrangement of the documentation. I think it would be better if chapter 23 (Completion System) was moved to come before chapter 22 (Zsh Modules) so that we have the chapter on Completion Widgets and Completion System together. I also think it might be a good idea to turn the chapter on completion using compctl into just a subsection of Zsh Modules. I think of the compctl module as just there for backward compatibility for those people who haven't moved to the new system. It would also bring new user's attention to the new system first. Oliver