bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual

bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual

[Tobias Geerinckx-Rice]

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.

Kind regards,

T G-R

bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual

[Alex Kost]

[-- Attachment #1: Type: text/plain, Size: 636 bytes --]

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:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: doc-keymap.diff --]
[-- Type: text/x-patch, Size: 500 bytes --]

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
 

[-- Attachment #3: Type: text/plain, Size: 10 bytes --]


-- 
Alex

bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual

[Ricardo Wurmus]

Alex Kost <alezost@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

bug#31652: Use of ‘keymap’ vs. ‘layout’ in manual

[Sarah Morgensen]

Hello all,

I found this old bug...

Ricardo Wurmus <rekado@elephly.net> writes:

> Alex Kost <alezost@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.

However, it seems the manual now primarily uses "keyboard layout" with
an entry in the index for "keymap".  This seems to resolve the original
issue, so I'm closing this bug.  Please reopen if this was in error.

Note also that when there is alternate terminology, you can use

  @cindex keymap @seeentry{keyboard layout}

to put a single entry in the index which says

  keymap: see keyboard layout

See (texinfo)Advanced Indexing for more info :)

--
Sarah