bug#62160: Guix reference manual link from guix.gnu.org?

[Simon Josefsson via Bug reports for GNU Guix]

Hi

I often go to guix.gnu.org to read the (excellent!) Guix manual.  This
leads to this click pattern: guix.gnu.org -> Help -> GNU Guix Manual
1.4.0 which leads me to a page (written in english) to chose language
of the manual -- https://guix.gnu.org/en/manual/ -- and when I chose
English I get a page to chose format of manual --
https://guix.gnu.org/en/manual/en/ -- and that choice takes a split
second cognitive load.

How about these changes to improve user experience?

1) The link guix.gnu.org -> Help -> GNU Guix Manual 1.4.0 goes directly
to the split-node https://guix.gnu.org/en/manual/en/html_node/

  1b) The link could respect the language-choice for the web-site,
i.e., so if I'm browsing https://guix.gnu.org/de/ it should directly
link me to https://guix.gnu.org/de/manual/de/html_node/ instead.

2) Add links to the PDF variant and full-HTML variants in the top-right
menu where different languages are shown.

What do you think?  Then you quickly get into the manual, and there is
still a simple way to chose other languages, and to get PDF/full-HTML
variants.  I don't see any significant disadvantage with this change.

/Simon



signature.asc
Description: This is a digitally signed message part

bug#62160: Guix reference manual link from guix.gnu.org?

[Simon Tournier]

Hi Simon,

On Mon, 13 Mar 2023 at 13:11, Simon Josefsson via Bug reports for GNU Guix 
 wrote:

> I often go to guix.gnu.org to read the (excellent!) Guix manual.  This
> leads to this click pattern: guix.gnu.org -> Help -> GNU Guix Manual
> 1.4.0 which leads me to a page (written in english) to chose language
> of the manual -- https://guix.gnu.org/en/manual/ -- and when I chose
> English I get a page to chose format of manual --
> https://guix.gnu.org/en/manual/en/ -- and that choice takes a split
> second cognitive load.

Well, personally I never read en/manual/ but always en/manual/devel/. :-)

And I have a short-cut (or bookmark) for opening
.


> How about these changes to improve user experience?
>
> 1) The link guix.gnu.org -> Help -> GNU Guix Manual 1.4.0 goes directly
> to the split-node https://guix.gnu.org/en/manual/en/html_node/

Well, I do not have an opinion since I barely read released manual but
only the more accurate devel manual.

However, my preference is about ’entirely on one page’ an not ’with a
separate page per node’ because ’entirely on one page’ eases Control-f
for searching. :-)


>   1b) The link could respect the language-choice for the web-site,
> i.e., so if I'm browsing https://guix.gnu.org/de/ it should directly
> link me to https://guix.gnu.org/de/manual/de/html_node/ instead.

With this change, where can I choose the language for the manual?

The workflow would be,

From https://guix.gnu.org/
Click top right to language and select one, say French
Then click Aide -> Manuel and it would open the manual in French.

so I would have to come back the front page to switch from one language
to the other.  Right?

Well, in addition, I would like to have a page proposition the manual
for all the languages, as we have now.  For example, these two webpages:

https://guix.gnu.org/en/manual/devel/
https://guix.gnu.org/fr/manual/devel/

serve the same choice and I would like to keep it somewhere.

> 2) Add links to the PDF variant and full-HTML variants in the top-right
> menu where different languages are shown.

Do you mean add an item to the list,

--8<---cut here---start->8---
  ,(menu-dropdown
#:label (C_ "website menu" "Help")
[...]
 (menu-item #:label "All"
[...]
 (menu-item #:label (C_ "website menu"
(string-append "GNU Guix Manual "
[...]
 (menu-item #:label "GNU Guix Manual (latest)"
[...]
 (menu-item #:label "Guix Reference Card"
[...]
 (menu-item #:label "Videos"
[...]
 (menu-item #:label "Cookbook"
[...]
 (menu-item #:label "GNU Manuals"
[...]
 (menu-item #:label "Wiki"
[...]
 (menu-item #:label "IRC Chat"
[...]
 (menu-item #:label "Mailing Lists"
--8<---cut here---end--->8---



?


Cheers,
simon

bug#62160: Guix reference manual link from guix.gnu.org?

[bokr]

On +2023-03-14 12:29:11 +0100, Simon Tournier wrote:
> Hi Simon,
> 
> On Mon, 13 Mar 2023 at 13:11, Simon Josefsson via Bug reports for GNU Guix 
>  wrote:
> 
> > I often go to guix.gnu.org to read the (excellent!) Guix manual.  This
> > leads to this click pattern: guix.gnu.org -> Help -> GNU Guix Manual
> > 1.4.0 which leads me to a page (written in english) to chose language
> > of the manual -- https://guix.gnu.org/en/manual/ -- and when I chose
> > English I get a page to chose format of manual --
> > https://guix.gnu.org/en/manual/en/ -- and that choice takes a split
> > second cognitive load.
> 
> Well, personally I never read en/manual/ but always en/manual/devel/. :-)
> 
> And I have a short-cut (or bookmark) for opening
> .
>
[...]

> Well, I do not have an opinion since I barely read released manual but
> only the more accurate devel manual.
> 
> However, my preference is about ’entirely on one page’ an not ’with a
> separate page per node’ because ’entirely on one page’ eases Control-f
> for searching. :-)
> 

I like that too :)

To work off-line, I like to do save-as to some-name.html
with which firefox creates a directory "some-name_files"
for images and css style stuff etc.

BUT: A nit: 

In firefox-esr, if you do "save-as ...", it will prompt with a file name
seemingly pretty directly copying the URL characters, in this case
"GNU Guix Reference Manual.html" -- which has spaces in it.

So my nuisance work flow is:
   - copy url from browser line into clipboard,
   - switch to a terminal,
   - touch $(sanitize-clipboard-url), ;; hack also puts clean name-string back 
in clipboard
   - switch to browser
   - delete undesired file name string from prompt by pasting in the clean name 
string
   - click save-as

I would really like Mozilla to solve this with configurable sanitization options
for the file name. Especially if I am looking at a page with an URL that has
weird non-ascii/utf-8 characters besides spaces.

But until Mozilla offers that, could GNU web pages have some kind of alias link 
on them
with a sanitized name to do save-link-as (not plain save-as) with,
so as to get a clean name?

[...]
> 
> Well, in addition, I would like to have a page proposition the manual
> for all the languages, as we have now.  For example, these two webpages:
> 
> https://guix.gnu.org/en/manual/devel/
> https://guix.gnu.org/fr/manual/devel/
>
+1 :)
--
Regards,
Bengt Richter

bug#62160: Guix reference manual link from guix.gnu.org?

[Bengt Richter]

Hi,

On +2023-03-14 18:35:36 +0100, b...@bokr.com wrote:
[...]
> BUT: A nit: 
> 
> In firefox-esr, if you do "save-as ...", it will prompt with a file name
> seemingly pretty directly copying the URL characters, in this case
> "GNU Guix Reference Manual.html" -- which has spaces in it.
>
Sorry, I think it just copies whatever XXX is in the html header as
   XXX
but some sites have weird strings in their titles, so the problem
remains..

> So my nuisance work flow is:
>- copy url from browser line into clipboard,
>- switch to a terminal,
>- touch $(sanitize-clipboard-url), ;; hack also puts clean name-string 
> back in clipboard
>- switch to browser
>- delete undesired file name string from prompt by pasting in the clean 
> name string
>- click save-as
> 
> I would really like Mozilla to solve this with configurable sanitization 
> options
> for the file name. Especially if I am looking at a page with an URL that has
> weird non-ascii/utf-8 characters besides spaces.
> 
> But until Mozilla offers that, could GNU web pages have some kind of alias 
> link on them
> with a sanitized name to do save-link-as (not plain save-as) with,
> so as to get a clean name?

I would still like this option, but I'm not sure how to implement
such an alias link in a static page.
IWG no problem if the header is dynamically generated ??

--
Regards,
Bengt Richter