GNOME Bugzilla – Bug 730503
Document keyboard shortcuts
Last modified: 2014-09-17 19:56:48 UTC
Add a page listing the keyboard shortcuts, which can be found at https://git.gnome.org/browse/epiphany/tree/src/ephy-window.c#n102 [Please leave this bug for the GNOME.Asia training session on 2014-05-23]
I will work on this bug.
Siyu Yang: In case you need any help with this (or if something is unclear), please tell us so we can help.
Created attachment 277404 [details] [review] This is the patch to add a page listing keyboard shortcuts.
André Klapper: Thank you! Finally I have finished it. It's a good and memorable experience, and I am willing to continue contributing!
Review of attachment 277404 [details] [review]: Hi, thank you for your patch! There are a few very minor corrections that I would like you to make before we accept it. Can you add this file to the list of files in help/Makefile.am? The list is alphabetical, you need to start it with a tab (not spaces) and end it with a ' \' as long as there is another file after it. To amend your previous patch, run 'git commit -a --amend' when you have finished making all the changes. Then create the new patch exactly the same way as you created this one. Thanks for writing a great commit message! ::: help/C/keyboard-shortcut.page @@ +6,3 @@ + <info> + <link type="guide" xref="index#start" group="#first"/> + <revision pkgversion="3.9" date="2013-06-30" status="incomplete"/> The package version should be 3.13 as you looked at the code on the master branch in git. The date should be when you made the changes and the status should be "review" as the patch is ready for review. @@ +26,3 @@ + <title>Keyboard shortcuts</title> + + <p>Multiple keyboard shortcuts can be used to complete tasks when browsing the web. They are listed below:</p> Can you reflow the text to be 79 characters wide? I'm not sure which text editor you used, but some have tools to make this easier (for example, in an 80 character wide terminal, you can use the command 'gqap1' in vim to do this easily). @@ +42,3 @@ + <tr> + <td> + <p>New Window</p> We generally don't use American title capitalisation, so we'd normally have "New window". If you're copying this from the UI, you need to put it in <gui> tags which are used to mark text as being taken directly from the UI. So for example, <p>New window</p> or <p><gui>New Window</gui></p> You can use either, but make sure that there's consistency throughout the help for this application. In this case, that just means that you do it consistently throughout this page. @@ +90,3 @@ + <tr> + <td> + <p>Close</p> Does this close the tab or the whole window? Might make sense to be more explicit. @@ +221,3 @@ + </td> + <td> + <p><keyseq><key>Ctrl</key><key>Plus</key></keyseq></p> <p><keyseq><key>Ctrl</key><key>+</key></keyseq></p> We use what is normally written on the keys. @@ +229,3 @@ + </td> + <td> + <p><keyseq><key>Ctrl</key><key>Minus</key></keyseq></p> As above. @@ +269,3 @@ + </td> + <td> + <p><keyseq><key>Ctrl</key><key>Page_Up</key></keyseq></p> USe PgUp for page up. @@ +277,3 @@ + </td> + <td> + <p><keyseq><key>Ctrl</key><key>Page_Down</key></keyseq></p> Use PgDn for page down.
Created attachment 277472 [details] [review] (After correction)This is the patch to add a page listing keyboard shortcuts.
Review of attachment 277472 [details] [review]: Pushed to master in commit 7c38eeaeed2c87d94689ef35a38ff1fa874b66fc after removing a trailing whitespace, thank you for your patch. There are a few things that can still be improved, please see my comments below. If you would like to fix these, please create a new patch with the improvements. ::: help/C/keyboard-shortcut.page @@ +21,3 @@ + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + + <desc>Browsing the web by using keyboard shortcuts.</desc> "Brose the web" is better because we try to use an active tone. @@ +51,3 @@ + <tr> + <td> + <p>New incognito window</p> "incognito" could be linked to the private browsing page. @@ +206,3 @@ + </td> + <td> + <p><keyseq><key>Escape</key></keyseq></p> The key usually says "Esc" on US layouts. @@ +376,3 @@ + </td> + <td> + <p><keyseq><key>Alt</key><key>Left</key></keyseq></p> An arrow could be used here instead of "left". @@ +384,3 @@ + </td> + <td> + <p><keyseq><key>Alt</key><key>Right</key></keyseq></p> An arrow could be used here instead of "right".
Improvements pushed to master in commit a0953d9cacb99f0f6d409ec5f20ef08e59914a94 Thank you for your help, Siyu Yang :)