GNU bug report logs - #31652
Use of ‘keymap’ vs. ‘layout’ in manual

Previous Next

Full log

Message #11 received at 31652 <at> debbugs.gnu.org (full text, mbox):

From: Ricardo Wurmus <rekado <at> elephly.net>
To: Alex Kost <alezost <at> gmail.com>
Cc: 31652 <at> debbugs.gnu.org, Tobias Geerinckx-Rice <me <at> tobias.gr>
Subject: Re: bug#31652: Use of ‘keymap’ vs.
 ‘layout’ in manual
Date: Wed, 30 May 2018 13:27:27 +0200

Alex Kost <alezost <at> gmail.com> writes:

> Tobias Geerinckx-Rice (2018-05-30 05:49 +0200) wrote:
>
>> Guix,
>>
>> Grepping the manual for ‘keyboard layout’ will get you to section
>> 6.1.4.1 (setting the layout temporarily during installation using
>> loadkeys), but not 6.2.7.1 where you might learn about using
>> console-keymap-service to make the change permanent.
>>
>> This bug is a reminder to myself to replace at least one occurrence of
>> ‘keymap’ with the common term.
>
> Do you mean ‘layout’ is the common term?  "man loadkeys" mentions
> "layout" only once, and "keymap" a lot.
>
> I think we can just put a reference to that section.  Maybe like this:
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index 09749b15e..02425e791 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -8418,7 +8418,9 @@ loadkeys dvorak
>  
>  See the files under @file{/run/current-system/profile/share/keymaps} for
>  a list of available keyboard layouts.  Run @command{man loadkeys} for
> -more information.
> +more information.  After installing GuixSD, you can set your default
> +keyboard layout with @code{console-keymap-service} (@pxref{Base
> +Services}).
>  
>  @subsubsection Networking

This is fine.  We should also consider adding more @cindex entries to
cover all terms that people might search for.  The index should guide
people to the relevant places in the manual.

-- 
Ricardo

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.