GNOME Bugzilla – Bug 770141
Remove Quick Reference PDF
Last modified: 2018-07-10 08:38:32 UTC
Keep existing https://help.gnome.org/users/evolution/stable/mail-reading-keyboard-shortcuts.html in mind / synced / merged. Needs some thinking I guess :) Also see / decide on bug 759493.
https://git.gnome.org/browse/evince/tree/shell/help-overlay.ui looks like a nicer approach in https://help.gnome.org/users/gnome-help/stable/shell-keyboard-shortcuts.html. IMO. (Thanks Olav for the hint.)
Created attachment 356674 [details] [review] Patch proposal This is my second contribution. If this is the way to create a page like https://help.gnome.org/users/gnome-help/unstable/shell-keyboard-shortcuts.html I can convert the rest of the page into a table.
Comment on attachment 356674 [details] [review] Patch proposal Yes, this looks like the right way, thanks! :) I think we should turn "Using shortcut keys to read mail" into a generic "Useful keyboard shortcuts" page, make 'mail' only one sub-section, and incorporate what can be seen in the PDF under "Help > Quick Reference" (apart from 'how to create a new ..." because I think that's way to noisy). And then move the page, however looking at https://help.gnome.org/users/evolution/stable/index.html I am again not sure where to put a generic 'keyboard shortcuts' page. Maybe "Getting Started" or "Common Other Questions and Problems"?
Created attachment 356752 [details] [review] Keyboard Shortcuts Quick Reference Convert help/quickref/C/quickref.pdf into help/C/intro-keyboard-shortcuts.page. Need a extra patch to fix the location of the node. Please let me know how to change the node position on the summary.
Review of attachment 356674 [details] [review]: Replaced by new patch.
Review of attachment 356752 [details] [review]: (In reply to Raniere Silva from comment #4) > Please let me know how to change the node position on the summary. You mean on the index page? The line <link type="guide" xref="index#mail-basic" /> defines in which section of index.page it is linked - see the id's in index.page. Also, when renaming/adding/deleting files, to not break the build, the file CMakeLists.txt needs to be updated (it is one level higher). ::: help/C/intro-keyboard-shortcuts.page @@ +4,3 @@ + <info> + <desc>Keyboard shortcuts that can save you some time when reading mail.</desc> + If this is not only about mail anymore, the last part should probably be dropped? @@ +5,3 @@ + <desc>Keyboard shortcuts that can save you some time when reading mail.</desc> + + <link type="guide" xref="index#mail-basic" /> Should probably get listed on index.page in a more generic section than mail now. @@ +12,3 @@ + <name its:translate="no">Andre Klapper</name> + <email its:translate="no">ak-47@gmx.net</email> + </credit> Feel free to add yourself as author here and bump the date. @@ +25,3 @@ + +<p>This page provides an overview of keyboard shortcuts that can help you +use <app>Evolucion</app> more efficiently.</p> Small typo: Evolucion @@ +52,3 @@ + </p></td> + <td><p>Select Memos component.</p></td> + </tr> Looks like Tasks got lost here which are 4, and Memos are 5. @@ +126,3 @@ + <keyseq><key>Shift</key><key>Ctrl</key><key>M</key></keyseq> + </p></td> + <td><p>Create a new mail.</p></td> This might be a typo already in the original already: "mail" is always plural. So "message" might be better. @@ +249,3 @@ + <keyseq><key>Ctrl</key><key>T</key></keyseq> + </p></td> + <td><p>Got to today.</p></td> Typo: Got should be go. @@ +275,3 @@ + +<section id="view-email"> +<title>Notes</title> I'm not entirely happy about the "Notes" title here - isn't this section more about reading mail / going through unread messages?
Created attachment 358092 [details] [review] Keyboard Shortcuts Quick Reference
André, Thanks for the review. Sorry to take so long to make the changes.
ping Andre, I keep the review up to you here.
Ah, *I* am sorry Raniere, because this fell through the cracks here, sigh :-/ Thanks Milan for the ping. "git am" did not work as it's not git-formatted, and "patch -p0 -i 770141.diff" neither as there is no 'a' directory. I wonder how this diff was created. :P I made the style consistent across all tables (and removed the namespace prefix ui for expanded as it's not defined for tables), turned each table into a separate section (looked clearer to me when opening it in Yelp 3.26), fixed a typo (capitalized Ctrl+y), removed the section about opening a message in its own window as that is already covered in the table above, moved the "magic spacebar" stuff into a section right below the Mail shortcuts, and in general replaced "the Spacebar" by <key>Space</key> for consistency. Yay! Pushed as git commit 820b894d84 to git master / 3.27. And.... congratulations to your patch having been merged, Raniere! *drumroll*
Next step is to kill, remove, burn help/quickref/C/quickref.pdf here I guess...
Merge request is in https://gitlab.gnome.org/GNOME/evolution/merge_requests/3
The merge request wasn't complete, it had missing some places where the related code should be removed, but no bug deal, I removed it for you. Created commit 74469b0cbe in evo master (3.29.4+)
Ah. Thank you a lot!