GNOME Bugzilla – Bug 682296
Pages supplied: Add the information from the mousetweaks docbook help to the user docs
Last modified: 2021-06-05 16:31:53 UTC
Created attachment 221895 [details] [review] Patch with enhancements to the Hover Click and Simulated Second Click docs Hi, As maintainers of mousetweaks, the program that implements the Hover Click and the Simulated Secondary Click, we were asked to port the docbook help available in the source tree of mousetweaks to the new documentation infrastructure: https://bugzilla.gnome.org/show_bug.cgi?id=681268 However, as there already is some documentation about the Hover Click and the Simulated Secondary Click in gnome-user-docs, we wondered whether we should not enhance this with the still relevant information of the outdated docbook help. Thus, I created a patch that adds these pieces of information by modifying the already available pages and adding several more pages. As the two already available pages were strongly modified and most of the new information is on new pages, I will not only attach the patch to this bug thread, but also also the single pages that were modified or newly created. Please, feel free to modify the submitted patch or pages any way you want. Hoping to have been helpful. Francesco PS: Please, take into account when reviewing the patch or the pages, that I only have little experience with mallard.
Created attachment 221897 [details] Hover click main page
Created attachment 221899 [details] Hover Click: start by gui page
Created attachment 221900 [details] Hover Click: start by cli page
Created attachment 221901 [details] Hover Click: usage page
Created attachment 221902 [details] Hover Click: bugs page
Created attachment 221903 [details] Simulated Secondary Click: main page
Created attachment 221904 [details] Simulated Secondary Click: start by gui page
Created attachment 221905 [details] Simulated Secondary Click: start by cli page
Created attachment 221906 [details] Simulated Secondary Click: usage page
Created attachment 221907 [details] Simulated Secondary Click: oddities page
Created attachment 221908 [details] Simulated Secondary Click: alternatives page
Created attachment 221909 [details] Simulated Secondary Click: bugs page
Hi Francesco, Definitely helpful! I notice that the new pages you created also have Shaun McCance listed as an author. Was this intentional? Also, just as an fyi, we only mark pages as status="final" if we freeze them. New submissions can be "draft" or "review" (if ready for review), and once reviewed, they are marked "candidate". I really appreciate this contribution!
First of all, thanks for reviewing this bug thread. > Definitely helpful! I notice that the new pages you created also have Shaun > McCance listed as an author. Was this intentional? Honestly, I did not know whether I had to also list him, as a look at the repository of mallard shows that he is a developer of mallard. Thinking that having a wrong name is better than missing somebody, I decided to leave his name on all the pages. > Also, just as an fyi, we only mark pages as status="final" if we freeze them. > New submissions can be "draft" or "review" (if ready for review), and once > reviewed, they are marked "candidate". Thanks for these explanations, I did not know. I misinterpreted the function of the status tag and am going to immediately replace them with pages having the correct status information. When I uploaded the pages, I would have considered them ready for review, but in the meantime, I have info about improving the cli pages. If I get around doing the improvements today, I will mark them as review, otherwise, I will leave them as draft. > I really appreciate this contribution! You are welcome.
Created attachment 222412 [details] [review] Hover click main page
Created attachment 222413 [details] [review] Hover Click: bugs page
Created attachment 222414 [details] Hover Click: start by cli page
Created attachment 222415 [details] [review] Hover Click: start by gui page
Created attachment 222416 [details] [review] Hover Click: usage page
Created attachment 222417 [details] [review] Simulated Secondary Click: main page
Created attachment 222418 [details] [review] Simulated Secondary Click: alternatives page
Created attachment 222419 [details] [review] Simulated Secondary Click: bugs page
Created attachment 222420 [details] Simulated Secondary Click: start by cli page
Created attachment 222421 [details] [review] Simulated Secondary Click: start by gui page
Created attachment 222422 [details] [review] Simulated Secondary Click: usage page
Created attachment 222423 [details] [review] Simulated Secondary Click: oddities page
I have removed Shaun McCance from the pages that do not contain pieces of pages where he was listed. Moreover, I marked all the pages as review except the cli pages which are marked as draft as I will improve them in a couple of weeks.
Created attachment 223707 [details] [review] Hover Click: start by cli page
Created attachment 223708 [details] [review] Simulated Secondary Click: start by cli page
I found time to update the cli pages sooner than expected: they now make the difference about starting the features by using the corresponding gsettings keys and starting the daemon directly. The pages should now all be ready for review. Please, let me know if there are still problems with the pages.
@André Klapper
Hmm?
@André Klapper Sorry for the misleading title of this bug thread that might have induced you to think that the attached files are patches. (I updated the title to avoid this happening again.) The pages attached below are not patches; they are simply pages that should be added or that should replace the pages with the same name that are already available.
GNOME is going to shut down bugzilla.gnome.org in favor of gitlab.gnome.org. As part of that, we are mass-closing older open tickets in bugzilla.gnome.org which have not seen updates for a longer time (resources are unfortunately quite limited so not every ticket can get handled). If you can still reproduce the situation described in this ticket in a recent and supported software version, then please follow https://wiki.gnome.org/GettingInTouch/BugReportingGuidelines and create a new enhancement request ticket at https://gitlab.gnome.org/GNOME/mousetweaks/-/issues/ Thank you for your understanding and your help.