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 726073 - Update toolbar.page as no option to hide or show exists for the toolbar
Update toolbar.page as no option to hide or show exists for the toolbar
Status: RESOLVED FIXED
Product: gnome-mahjongg
Classification: Applications
Component: documentation
git master
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
gnome-mahjongg-maint
Depends on:
Blocks:
 
 
Reported: 2014-03-10 23:31 UTC by Rashi Aswani
Modified: 2014-03-17 12:11 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Updated toolbar.page as no option to hide or show exists for the toolbar (1.74 KB, patch)
2014-03-10 23:43 UTC, Rashi Aswani
needs-work Details | Review
Deleted toolbar.page as no toolbar exists (2.05 KB, patch)
2014-03-17 00:23 UTC, Rashi Aswani
none Details | Review

Description Rashi Aswani 2014-03-10 23:31:40 UTC
Update the toolbar.page as no option to hide/show exists for the toolbar.
Comment 1 Rashi Aswani 2014-03-10 23:43:15 UTC
Created attachment 271494 [details] [review]
Updated toolbar.page as no option to hide or show exists for the toolbar
Comment 2 Sindhu S 2014-03-11 06:19:17 UTC
Review of attachment 271494 [details] [review]:

::: help/C/toolbar.page
@@ +27,3 @@
   </info>
 
+  <title>Toolbar</title>

This page itself needs a re-write because AFAIK, most GNOME apps have now moved over to the new header bar widget, so please find out if it's still called "Toolbar" or something else.

@@ +31,1 @@
   <p>The toolbar, located under the menu bar, lets you perform common actions

There is also no menu bar now is there? there is definitely an "App Menu" for which you have to access the "Top Bar" (this terminology is GNOME Shell specific).

@@ +31,2 @@
   <p>The toolbar, located under the menu bar, lets you perform common actions
   with your mouse. To use a toolbar item, just click on it. The buttons, from

Am not very sure about "just click on it". Am aware you didn't write this but it can use a re-write.

GNOME shell and it's associated apps are now being installed on a wide variety of devices and not all of them have a mouse pointer to be able to "click on it". This means that:

1. Keep our help instructions platform agnostic.
2. Keep in mind there is no "click" in a touchscreen environment. The terminology there would be "tap".

I have shortlisted the things to keep in mind before submitting a user documentation patch. Perhaps a run through it comparing your work would be helpful in the future? :)
http://sindhus.bitbucket.org/pages/suggested-workflow-for-writing-user-help.html
Comment 3 Michael Catanzaro 2014-03-11 13:52:11 UTC
(In reply to comment #2)
> This page itself needs a re-write because AFAIK, most GNOME apps have now moved
> over to the new header bar widget, so please find out if it's still called
> "Toolbar" or something else.

Right, the toolbar and menu bar have both been removed for 3.12 in favor of the header bar.

> @@ +31,2 @@
>    <p>The toolbar, located under the menu bar, lets you perform common actions
>    with your mouse. To use a toolbar item, just click on it. The buttons, from
> 
> Am not very sure about "just click on it". Am aware you didn't write this but
> it can use a re-write.

I don't think we need to explain how to press a button to the user.  There's no way he could have made it as far as the user help without this skill. :)
Comment 4 Sindhu S 2014-03-11 16:02:47 UTC
(In reply to comment #3)
> I don't think we need to explain how to press a button to the user.  There's no
> way he could have made it as far as the user help without this skill. :)

hehe yes! I meant to say, the sentence and phrasing wasn't "looking" OK according to the way we usually write user docs for GNOME and also to keep user instructions platform agnostic.
Comment 5 Rashi Aswani 2014-03-15 12:19:45 UTC
Hi Michael,Sindhu
Should I delete the toolbar.page itself as the buttons are self explanatory?
Comment 6 Michael Catanzaro 2014-03-16 14:36:07 UTC
That seems reasonable to me.
Comment 7 Rashi Aswani 2014-03-17 00:23:17 UTC
Created attachment 272101 [details] [review]
Deleted toolbar.page as no toolbar exists