GNOME Bugzilla – Bug 700442
evince help not updated for 3.8 interface changes
Last modified: 2014-03-22 21:25:18 UTC
The evince documentation available through yelp is not yet updated to correlate with recent UI changes. That means the no-longer existing menu bar items etc. are referred.
Created attachment 244498 [details] [review] created patch for toolbar page as per present UI please review if the modifications made are correct or needs work so that I can move further accordingly.
Hi Shobha, the toolbar page looks just fine. There's still a couple of 'Go' menu items mentioned in movearound.page, but other than that it's okay too. You can definitely move forward. Thanks.
Created attachment 244527 [details] [review] created patch for few page as per present UI
Created attachment 244548 [details] [review] patch for modified evince according to version 3.8 UI for bug 700442
Hi, Please see the changes if they are as expected or needs work. Thanks.
Comment on attachment 244548 [details] [review] patch for modified evince according to version 3.8 UI for bug 700442 >+ <item><p>Press <gui>Magnifying glass</gui> button or press The missing article makes it sound weird to me, but I'll let native speakers comment on this. >+ To swap black for white, white for black, and so on, click <guiseq><gui>Geaar button</gui><gui>Inverted Colors</gui></guiseq>. Typo >+ <item><p>Type a page number in the 'Select Page' tool on the <link Hmm, no markup instead of ''? >- <media type="image" src="figures/zoom.png"/> >+The <gui>Fit Page</gui> option will make a document page fit the whole <em>height</em> of the window. </p> This issue was not introduced by your patch, but still I'd remove the whitespace at the end. >+<p>If you want to see the previously visited pages press previous history or next history buttons on the toolbar.</p> I wonder if those buttons should get markup here. >+ <item><p>or uncheck fullscreen by pressing the <guiseq><gui>Wrench button</gui><gui>Fullscreen</gui></guiseq>.</p></item> There might be a better way to express "uncheck fullscreen" (that's the technical action, but not the *aim* that you have - you wouldn't ask somebody to "uncheck fullscreen" in general language). >+The toolbar contains the basic set of tools: </p> Whitespace at the end of a sentence. >-<item><p><gui>Previous</gui> and <gui>Next</gui> for <link >+<item><p><gui>Previous</gui> and <gui>next</gui> button for <link Next should remain capitalized I guess, plus as these are buttons you should use the specific markup for it. >+<item><p>The 'Select Page' <link xref="movingaround#between-pages">tool.</link></p> <gui> markup for select page maybe? Not sure. >+<item><p><gui>Go to previous history item</gui> and <gui>Go to next history item</gui> >+ button for <link xref="movingaround#between-pages">moving</link> previous history >+ items.</p></item> That's not a task-oriented sentence targetting the user. It's like "<gui>Food</gui> for <link>hunger</link>" - what does that tell me as a user? :) Plus buttons (plural) should have the specific markup for it? >+<p>On the right hand side, there are three buttons as follows:</p> >+ <list><item><p><gui>Magnifying glass button</gui> to <link xref ="finding">find >+ </link> word or phrase in the document.</p></item> Missing article: find a word or phrase >+ <item> >+ <p><gui>Wrench button</gui> with menuitems for actions like >+ <link xref="movingaround#navigating">navigation</link>, >+ <link xref="presentations#start-presentation">presentation</link>, rotation, >+ <link xref="movingaround#zoom">zoom in or out</link>, >+ <link xref="invert-colors">invert colors</link> and >+ <link xref="reload">reload</link>. Gerunds might work better here than infinitives, but better to get feedback by native speakers. >+ <p><gui>Gear button</gui> with dropdown menuitems for >+ <link xref="opening">opening</link>, Oh yes, and here you use gerunds instead of infinitives. >+ <link xref="bookmarks">bookmarks</link>, select all, copying, closing Oh well, here you don't. But then you do again. More consistency welcome. :) >+ and knowing the properties of a document.</p> </item> Unneeded whitespace between </p> </item>
Created attachment 244634 [details] [review] modified patch for evince 3.8 UI bug 700442 this time, I have also modified bookmarks page as per evince3.8
Comment on attachment 244634 [details] [review] modified patch for evince 3.8 UI bug 700442 >From f2d20d1dce7d6214c36ac657a81b4cac65293b18 Mon Sep 17 00:00:00 2001 >diff --git a/help/C/bookmarks.page b/help/C/bookmarks.page >index e4102e0..62e81ae 100644 >--- a/help/C/bookmarks.page >+++ b/help/C/bookmarks.page >@@ -4,22 +4,75 @@ > > <info> > <link type="guide" xref="index#annotations"/> >- <desc>You can use annotations like bookmarks.</desc> >+ <desc>How to bookmark your pages.</desc> After this change, title and desc do not include the word annotations anymore. Is this intended? >+ <title>Bookmarks</title> >+ <p>You can bookmark your pages and access them easily any time you wish.</p> "your pages" -> maybe "your favorite pages"? It wouldn't be entirely clear what "my pages" are when reading this. >+ <p>In a document, if you wish to add a <link xref="movingaround#between-pages">page</link> >+ to the bookmarks. Use any of the following ways:</p> This should be one sentence. Maybe you want to "bookmark a page" instead of "adding a page to the bookmarks". >+ <note><p>You can also use <link xref = "annotations">annotations</link> like bookmarks.</p></note> <link xref=" would be better to read. >- <item><p>Click <guiseq><gui>Edit</gui><gui>Find</gui></guiseq> or press >+ <item><p>Press the <gui>Magnifying glass</gui> button or press > <keyseq><key>Ctrl</key><key>F</key></keyseq> or <key>/</key> to display a > search box. </p></item> Not your fault, but the whitespace in "box. </p>" could be removed. >+ <item><p>Press the <gui>Previous</gui> or <gui>Next</gui> buttons on >+the <link xref="toolbar">toolbar</link>.</p></item><item><p>Press the <keyseq><key>Ctrl</key><key>Page Up</key></keyseq> or I'd love to see a linebreak between </item><item> >+ <item><p>To exit from the fullscreen mode:</p> I think the "from" is not needed. >+ <item><p>or disable <gui>Fullscreen</gui> by pressing the <guiseq><gui>Wrench button</gui><gui>Fullscreen</gui></guiseq>.</p></item> It feels a bit weird to me to put the first <gui>Fullscreen</gui> into markup, but maybe I don't get it. :) >diff --git a/help/C/printing.page b/help/C/printing.page >index 8145e9a..52e917f 100644 >--- a/help/C/printing.page >+++ b/help/C/printing.page >- <item><p>Click <guiseq><gui>File</gui><gui>Print</gui></guiseq></p></item> >+ <item><p>Press <guiseq><gui>Gear button</gui><gui>Print</gui></guiseq></p></item> > <item><p>Choose your printer from the list </p></item> > <item><p>Click <gui>Print</gui>.</p></item> These steps miss proper and consistent punctuation (full stops at the end; not your fault). Would be great if this could fixed (plus removing the unneeded whitespace at the end). >+The toolbar contains the basic set of tools:</p> I wonder if it should be "a basic set of tools" instead. >+<media type="image" src="figures/evince-toolbar.png" width="475"/> > <list> >-<item><p><gui>Previous</gui> and <gui>Next</gui> for <link >+<item><p><gui type="button">Previous</gui> and <gui type="button">Next</gui> button for <link > xref="movingaround#between-pages">moving</link> from page to page.</p></item> >+<item><p>The <link xref="movingaround#between-pages">Select page</link> tool.</p> >+</item> >+<item><p>Tool to access <link xref="movingaround#between-pages">history</link> items. >+</p></item> > <item><p>A tool to adjust the <link xref="movingaround#zoom">zoom</link> level.</p></item> >-<item><p>The 'page select' <link >-xref="movingaround#between-pages">tool.</link></p></item> "Tool to access" feels weird here as the start of a sentence - the one after has an article "A tool to adjust" and the very first one are "buttons" instead of "tools". >+ <list><item><p><gui>Magnifying glass button</gui> to <link xref ="finding">find >+ </link>a word or a phrase in the document.</p></item> Missing whitespace: "</link>a" >+ <item> >+ <p><gui>Wrench button</gui> with dropdown menuitems for I think this should be "menu items"? >+ <p><gui>Gear button</gui> with dropdown menuitems for Same here? >+ <link xref="print-booklet">printing</link>, going to >+ <link xref="movingaround#between-pages">first page</link> or >+ <link xref="movingaround#between-pages">last page</link>, adding going to *the* first page...? >+ <link xref="bookmarks">bookmarks</link>, select all, copying, closing >+ and knowing the properties of a document.</p></item> Should probably be "selecting all" as all the other actions are also in gerund form ("-ing" ending).
Shobha: Do you plan to rework the patch, or should somebody else give it a try? Just wondering to avoid "cookie licking". :)
Andre, yes, let anyone else to give it a try. Thanks
Working on a patch for this
Created attachment 272426 [details] [review] Picked off from where Shobha started
Review of attachment 272426 [details] [review]: Use <revision> tags: https://wiki.gnome.org/DocumentationProject/StatusTracking#Recording_Status_Information Also, review all instances of "gear button" and "wrench button" ::: help/C/convertPostScript.page @@ +38,3 @@ <item> <p> + Click the <guiseq><gui>Gear button</gui><gui>Print</gui></guiseq> Lets start changing the style a bit to fit better with the rest of docs: start the paragraph on the same line as you open the tag: <p>Click… "Gear button" is a horrible name to call it (I know I'm guilty of calling it that in the past), call it "<gui>File options</gui> menu in the top right corner" which means that you wouldn't be able to use a <guiseq> ::: help/C/convertSVG.page @@ +36,3 @@ <p> + Click the <guiseq><gui>Gear button</gui><gui>Print</gui></guiseq> and go + to the <gui>General</gui> tab. Same as the first page. Check your reflowing (lines should normally be 79 characters long or shorter, but they are sometimes longer when long sequences or URLs are involved). ::: help/C/convertpdf.page @@ +38,3 @@ <p> + Click the <guiseq><gui>Gear button</gui><gui>Print</gui></guiseq> and go + to the <gui>General</gui> tab. As before. ::: help/C/finding.page @@ +35,3 @@ </item> <item> + <p>The <gui>∧</gui> and <gui>∨</gui> buttons let you Reflow. ::: help/C/forms-saving.page @@ +36,3 @@ <item> <p> + <guiseq><gui>Gear button</gui><gui>Save a copy</gui></guiseq> As before. @@ +54,3 @@ <p> + Click <guiseq><gui>Gear button</gui><gui>Print</gui></guiseq> and go to + the <gui>General</gui> tab. Same again. ::: help/C/invert-colors.page @@ +30,3 @@ <p> + To swap black for white, white for black, and so on, click + the <guiseq><gui>Wrench button</gui><gui>Inverted Colors</gui></guiseq>. "<gui>View options</gui> button at the top-right of the window." ::: help/C/movingaround.page @@ +83,3 @@ <list> + <item><p>Click the <gui>∧</gui> or <gui>∨</gui> buttons on the + <link xref="toolbar">toolbar</link>.</p></item> < and >, not ^ and v (find the unicode opposite of ^ for the other page) @@ +89,3 @@ <list> + <item><p>Type a page number in <gui style="input">Select Page</gui> on the + <link xref="toolbar">toolbar</link> and press <key>Enter</key>. </p></item> As you're touching these lines, please use the current indentation style: <list> <item> <p>…</p> </item> </list> @@ +92,3 @@ + <item><p>If you want to see the recently visited pages press + <gui type="button"><</gui> or <gui type="button">></gui> on the toolbar. + </p></item> Hmm, this seems to show the previous and next pages, not recently visited unless the context implies otherwise. @@ +98,3 @@ + <guiseq><gui>Gear button</gui><gui>First Page</gui></guiseq>. You can + also press <keyseq><key>Ctrl</key><key>Home</key></keyseq> on your + keyboard.</p></item> As before. @@ +102,3 @@ + <guiseq><gui>Gear button</gui><gui>Last Page</gui></guiseq> or press + <keyseq><key>Ctrl</key><key>End</key></keyseq> on your + keyboard.</p></item> As before. @@ +114,3 @@ You can only move around one page at a time, by default. If you want to move + between pages just by scrolling or dragging, click the + <guiseq><gui>Gear button</gui><gui>Continuous</gui></guiseq>. As before. @@ +125,3 @@ + <p>To make the side pane visible click the + <guiseq><gui>Wrench button</gui><gui>Side Pane</gui></guiseq> on the toolbar, As before. Check reflowing.
I'll finish it today
Created attachment 272640 [details] [review] Modified patch
Created attachment 272654 [details] [review] slight modified patch
Comment on attachment 272654 [details] [review] slight modified patch Pushed to master in commit 96e6ae88341b8681fcf6416f855cb2ee7bbc0ad5 Pushed to gnome-3-12 in commit 20c82d7bf5d9bef03de1ee91cbc5ae009c004c07 Anna: you may want to read https://wiki.gnome.org/DocumentationProject/Guide/Translations for how to use the ITS namespace