GNOME Bugzilla – Bug 665833
gnobots2 / gnome-robots: Convert documentation to Mallard format
Last modified: 2014-03-19 16:23:55 UTC
Convert documentation to Mallard format
Hi, a new branch mallard-help has been pushed to git. The commit id of the mallard-help is 315dd03ad6a0215477fa8ae252426c0aced66c10 It would be great if someone reviewed the pages so it could be merged with master.
Sorry, the commit id is 046104596308723c9f9f690e35318f9509a6f977
Looks almost complete. It'd be nice to get this in for 3.12 if we can. A few comments, all minor: * The 32x32 application icon should be displayed to the left of the title on the index page. * On the basic instructions page, under enable sounds, there's a missing space between Select and Settings. * On the different moves in Robots page, you say you can move in nine possible ways, or wait for the robots, or teleport. But one of the nine possible ways of moving listed below is waiting. Might be less confusing to say eight directions. * On the game type page, you mention the use safe moves and use super safe moves preferences. It would be good to explain more fully how these work. These could arguably be split off to a separate page, since they're not really related to the game mode.
(In reply to comment #3) > Looks almost complete. It'd be nice to get this in for 3.12 if we can. > > * The 32x32 application icon should be displayed to the left of the title on > the index page. > * On the basic instructions page, under enable sounds, there's a missing space > between Select and Settings. > * On the different moves in Robots page, you say you can move in nine possible > ways, or wait for the robots, or teleport. But one of the nine possible ways of > moving listed below is waiting. Might be less confusing to say eight > directions. All three fixed in https://git.gnome.org/browse/gnome-robots/commit/?h=mallard-help&id=9ba4afc8147260d43adebf82fa4a1862eb9e8bdc > * On the game type page, you mention the use safe moves and use super safe > moves preferences. It would be good to explain more fully how these work. These > could arguably be split off to a separate page, since they're not really > related to the game mode. Can this please become a separate enhancement request? So regarding comment 3, I think we're done here, so you could merge Aruna's branch into git master for 3.12?
(In reply to comment #4) > All three fixed in > https://git.gnome.org/browse/gnome-robots/commit/?h=mallard-help&id=9ba4afc8147260d43adebf82fa4a1862eb9e8bdc Thanks! I made a couple of changes you might want to look over real quick. > Can this please become a separate enhancement request? OK: Bug #722998 > So regarding comment 3, I think we're done here, so you could merge Aruna's > branch into git master for 3.12? I sure can, but does anyone else need to approve this first, or are we good to go?
Thanks for fixing my mistakes, Andre!
(In reply to comment #5) > Thanks! I made a couple of changes you might want to look over real quick. https://git.gnome.org/browse/gnome-robots/commit/?h=mallard-help&id=edbb5942d3a324d9fcee4f40299d8209911a34f7 confuses me. The text should only be displayed as a fallback when the image is not loaded, IMO. Wondering what's different with your setup. Yelp 3.10 here. Thanks for fixing the build; was late yesterday and didn't test. :-/ > > So regarding comment 3, I think we're done here, so you could merge Aruna's > > branch into git master for 3.12? > > I sure can, but does anyone else need to approve this first, or are we good to > go? I'd let Kat have the last word here.
Created attachment 267238 [details] screenshot Hm, do other modules use fallback text for these logos? I don't think any of the other games do. Here's what I'm seeing. If I don't install the logo, it looks just like this except with a missing image placeholder instead of the logo: the text doesn't replace the image. My Yelp is recently built from git master.
Hi all, Michael is correct about the alt text for the logo: we don't use them because of the "Application logo Application" problem. The rest of the help looks good for merging.
Cool. Thanks everyone, especially Aruna of course! The following fixes have been pushed: 9d52b91 Update documentor credits 74dbb93 help: do not name the page "Robots logo Robots" 1b8f4b4 help: install Robots logo b2b364f Add icon next to title; fix typo; clarify possible moves 6e7a831 Bug 665833: Added Mallard help for GNOME-robots
Created attachment 267361 [details] [review] Update documentor credits
Created attachment 267362 [details] [review] help: do not name the page "Robots logo Robots" This is displaying incorrectly in Yelp's window title and in the dropdown menu.
Created attachment 267363 [details] [review] help: install Robots logo
Created attachment 267364 [details] [review] Add icon next to title; fix typo; clarify possible moves See first three items of https://bugzilla.gnome.org/show_bug.cgi?id=665833#c3
Created attachment 267365 [details] [review] Bug 665833: Added Mallard help for GNOME-robots Added: appearance.page, basics.page, controls-change, controls-default.page, game-types.page, index.page, moves.page, scores.page
Could I try the review (mentioned here: https://wiki.gnome.org/DocumentationProject/Tasks/ApplicationHelp#Beginner_projects)?
Created attachment 272329 [details] [review] help: New images for documentation New images of robots have been included for the themes not already documented (anthills, cows, eggs. mice, spills, stormclouds, toasters). "gnome-high-risk.png" and "gnome-low-risk.png" have been renamed to "gnomes-high-risk.png" and "gnomes-low-risk" to conform with theme name "gnomes" and names for the images of other themes. One image for starting a new game added.
Created attachment 272330 [details] [review] help: Updated Makefile.am for new doc. images
Created attachment 272331 [details] [review] help: Updated appearance page with new themes The themes not previously documented (anthills, cows, eggs, mice, spills, stormclouds, toasters) have been added to the list of themes available.
Created attachment 272332 [details] [review] help: Added starting new game from toolbar An instruction for starting a new game from the toolbar with accompanying image has been included.
Created attachment 272333 [details] [review] help: All high&low risk robots & high score info The section on high and low risk robots now covers robots of all themes. Anthills, cows, eggs, mice, spills, stormclouds were all previously missing. The information is now in table form, to improve concision and reduce repetition. Information on viewing high scores has been added.
Created attachment 272334 [details] [review] help: Reordered & formatted table of game types The game types are now listed in the order in which they appear in the preferences dialog; the previous order appeared to have no particular pattern. The table has been reformatted to correspond better with the formatting of other tables in GNOME Games.
Created attachment 272335 [details] [review] help: Changed key info for staying & reformatted The key for staying in place has been edited to "Begin" (i.e. without numlock activated) to match all other key descriptions e.g. "PgUp", with a note that some keyboards only show "5" on this key. Table reformatted.
Review of attachment 272332 [details] [review]: ::: help/C/basics.page @@ +7,3 @@ + <revision pkgversion="3.8" version="0.1" date="2013-04-03" status="draft"/> + <revision pkgversion="3.11.90" date="2014-03-18" status="review"/> Check indentation @@ +15,3 @@ <email>safincrazy@gmail.com</email> </credit> No blank line here please @@ +19,3 @@ + <name>Rachel Dunstan</name> + <email>dunstanrc@gmail.com</email> + </credit> Check indentation @@ +31,2 @@ <p>Select <guiseq><gui style="menu">Game</gui> + <gui style="menuitem">New</gui></guiseq>, click the <media type="image" Don't break the <media> tag half way through, just move the whole tag to the next line @@ +32,3 @@ + <gui style="menuitem">New</gui></guiseq>, click the <media type="image" + src="figures/new.png"/> button on the toolbar, or press <keyseq><key>Ctrl + </key><key>N</key></keyseq> to start a new Check indentation; keep the <keyseq> on one line as what you're doing here will add a space into one of the keys
Created attachment 272389 [details] [review] help: Fixed spacing of appearance patch Commit message of original patch: The themes not previously documented (anthills, cows, eggs, mice, spills, stormclouds, toasters) have been added to the list of themes available.
Created attachment 272390 [details] [review] help: Fixed spaces of basics patch & added alt-text Commit message of original patch: An instruction for starting a new game from the toolbar with accompanying image has been included.
Created attachment 272391 [details] [review] help: Fixed spacing of controls-default & added alt-text Commit message of original patch: The key for staying in place has been edited to "Begin" (i.e. without numlock activated) to match all other key descriptions e.g. "PgUp", with a note that some keyboards only show "5" on this key. Table reformatted
Created attachment 272392 [details] [review] help: Fixed spacing of game-types patch Commit message of original patch: The game types are now listed in the order in which they appear in the preferences dialog; the previous order appeared to have no particular pattern. The table has been reformatted to correspond better with the formatting of other tables in GNOME Games.
Created attachment 272393 [details] [review] help: Fixed spacing of scores & added alt-text Commit message of original patch: The section on high and low risk robots now covers robots of all themes. Anthills, cows, eggs, mice, spills, stormclouds were all previously missing. The information is now in table form, to improve concision and reduce repetition. Information on viewing high scores has been added.
Rachel: This bug report was closed as RESOLVED FIXED on 2014-01-27 as converting the documentation to Mallard was successfully finished (and that's what the ticket is about). Further cleanup patches might not receive attention and should better go to separate followup bug reports, as they are unrelated to the original topic of this ticket (converting to Mallard).