After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 705585 - The documentation don't mention the "New tab" button
The documentation don't mention the "New tab" button
Status: RESOLVED FIXED
Product: epiphany
Classification: Core
Component: Documentation
3.9.x
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
Epiphany Maintainers
Depends on:
Blocks:
 
 
Reported: 2013-08-06 18:00 UTC by Adam Matoušek
Modified: 2014-12-02 21:46 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Adam Matoušek 2013-08-06 18:00:21 UTC
In the Epiphany's documentation (file browse-web.page, line 46), the advised way to open new tab is using the "gear menu". I believe this should be rewritten to take the "New tab" button into account.
Comment 1 Kat 2013-08-14 09:08:11 UTC
I couldn't use the button in the user help instructions because it has no menu and no tooltips, so it cannot be described. (The same problem exists for the "gear" menu.) I will try to add tooltips for 3.12 and, if the patch is accepted, then I can update the help.
Comment 2 Kat 2013-08-14 09:14:35 UTC
Ahem, that should say "no label and no tooltip".
Comment 3 Reinout van Schouwen 2013-08-15 14:15:29 UTC
(In reply to comment #1)
> I couldn't use the button in the user help instructions because it has no menu
> and no tooltips, so it cannot be described. (The same problem exists for the
> "gear" menu.) I will try to add tooltips for 3.12 and, if the patch is
> accepted, then I can update the help.

This sounds like a more general problem that needs to be discussed with the design team!
Comment 4 Kat 2013-08-15 14:49:02 UTC
(In reply to comment #3)
> (In reply to comment #1)
> > I couldn't use the button in the user help instructions because it has no menu
> > and no tooltips, so it cannot be described. (The same problem exists for the
> > "gear" menu.) I will try to add tooltips for 3.12 and, if the patch is
> > accepted, then I can update the help.
> 
> This sounds like a more general problem that needs to be discussed with the
> design team!

I have briefly spoken to the design team about this (in general) on IRC and the response indicated that the team had no interest in including tooltips in the designs. To be honest, this is also something that developers should pick up when implementing the designs.

Unfortunately, there is no design mailing list, so I cannot give you a link to the discussion and the view may not be shared by the whole team as not all of it may have been on IRC or awake at the time.

For now, when I come across a problem, I provide a patch. It is a bit difficult to generalise for the gear/menu button because it means different things in different applications.
Comment 5 Claudio Saavedra 2013-08-15 15:19:23 UTC
(In reply to comment #1)
> I couldn't use the button in the user help instructions because it has no menu
> and no tooltips, so it cannot be described.

Why it cannot be described? Can't a screenshot of the button be used to refer to it, for instance?
Comment 6 Kat 2013-08-15 16:04:07 UTC
(In reply to comment #5)
> (In reply to comment #1)
> > I couldn't use the button in the user help instructions because it has no menu
> > and no tooltips, so it cannot be described.
> 
> Why it cannot be described? Can't a screenshot of the button be used to refer
> to it, for instance?

That fails the instant a user has a different theme or is blind. The best we can do right now is "that button in the top right of the screen which might be a gear, but could be something completely different depending on your theme", which is not particularly helpful and cannot be used inside a GUI sequence (menu->menuitem).

<guiseq> are tags that we use to describe the UI in Mallard. They are most often used to describe interactions with menus and contain a number of GUI elements inside them (most commonly text from labels).

As a quick fix, the next best thing that I have come up with is to add tooltips to the buttons (these help with accessibility all round), and to use the tooltip to help describe the button.

I would like to see something added to yelp that would allow us to request icons from the theme, but someone would need to implement this.
Comment 7 Claudio Saavedra 2013-08-15 16:59:18 UTC
There are shortcuts for both actions. F10 for the gear menu and Ctrl+T for new tab. That could help. As for the theme issues, the same are present for all existing screenshots.
Comment 8 Kat 2013-08-15 17:16:34 UTC
(In reply to comment #7)
> There are shortcuts for both actions. F10 for the gear menu and Ctrl+T for new
> tab. That could help.

Yes, I will add these to the keyboard-shortcuts.page when we write one and the tab page when I split it off from the browsing (as per our conversation at GUADEC). If you can think of any others, please let us know!

> As for the theme issues, the same are present for all
> existing screenshots.

Which is why we don't use the screenshots to describe actions or steps :) If I remember correctly, there is currently one, traditional, screenshot of the main window in the introduction and one showing that the private browsing looks different from normal browsing (which needs to be improved, as you mentioned). Both pages are as useful without the screenshots, but users apparently appreciate some visual feedback occasionally and I can see how knowing what to expect when starting up an application is nice.
Comment 9 Claudio Saavedra 2013-08-16 08:19:14 UTC
(In reply to comment #8)

> Yes, I will add these to the keyboard-shortcuts.page when we write one and the
> tab page when I split it off from the browsing (as per our conversation at
> GUADEC). If you can think of any others, please let us know!

All the keybindings are specified in the ephy-window.c sources: https://git.gnome.org/browse/epiphany/tree/src/ephy-window.c#n102
Comment 10 Kat 2014-12-02 21:46:35 UTC
New page about tabs added in commit 4f9a7ef36c77cdfef7dc45b2e6359c70518d9b79 which mentions the "new tab" button.

(Keyboard shortcuts were added in commits 7c38eeaeed2c87d94689ef35a38ff1fa874b66fc and a0953d9cacb99f0f6d409ec5f20ef08e59914a94)