GNOME Bugzilla – Bug 721181
User help should explain how to match flower tiles
Last modified: 2014-02-26 12:09:23 UTC
From Bug #721106 "The flower tiles consist of 8 tiles in 2 groups (4 in each) - the flower-group and the season-group. These 8 tiles are special, because there is only one of each - all other tiles have 4 occurrences. - The flower-group: blue winter motive in postmodern, yellow symbols in smooth - The season-group: yellow spring motive in postmodern, black symbols in smooth" In the postmodern tile set -- the default -- the four flower tiles in each group are represented by the same image, so there's no confusion. But in other tile sets, these tiles may be unique. If the user is looking for a matching tile, he will never find one. The user help should devote a bit of space to this.
Created attachment 269422 [details] [review] User help should explain how to match flower tiles The help page omits information about flower tiles, a new page for flower tiles and their matching is created. Please enter the commit message for your changes. Lines starting
Created attachment 269424 [details] [review] User help should explain how to match flower tiles The help pages omits information about flower tiles, a new page for flower tiles and their matching is created.
Review of attachment 269424 [details] [review]: As far as I can see, the actual .page-file is missing. You need to add that file to your commit and then create a patch.
Created attachment 269433 [details] [review] User help should explain how to match flower tiles The help pages omits information about flower tiles, a new page for flower tiles and their matching is created.
Review of attachment 269433 [details] [review]: ::: help/C/flowertiles.page @@ +5,3 @@ + <info> + <link type="guide" xref="index#play"/> + <revision pkgversion="3.5.4" version="0.2" date="2014-02-16" status="final"/> Did you write and test your instructions against version 3.5.4? If not, you might want to bump this. @@ +17,3 @@ + <title>Flower Tiles</title> + + <p>Flower Tiles consist of 8 tiles divided equally in 2 groups,the flower-group and the season-group.The flower-group consists of blue The entire section seems to miss whitespaces after punctuation marks. Why do "flower-group" and "season-group" have dashes? @@ +18,3 @@ + + <p>Flower Tiles consist of 8 tiles divided equally in 2 groups,the flower-group and the season-group.The flower-group consists of blue + winter motive in postmodern theme and yellow symbols in smooth theme and the season-group consists of yellow spring motive in postmodern "consists of blue winter motive"? To me motives are countable so the grammar might be wrong (or I misunderstand)? I'd also split this into two sentences, having three times "and" is a bit confusing for understanding what is what. @@ +19,3 @@ + <p>Flower Tiles consist of 8 tiles divided equally in 2 groups,the flower-group and the season-group.The flower-group consists of blue + winter motive in postmodern theme and yellow symbols in smooth theme and the season-group consists of yellow spring motive in postmodern + theme and black symbols in smooth theme.The four flower tiles in postmodern theme are represented by the same image,which can be matched if two images matches.But in smooth theme,these tiles may be unique,tiles with same color of the symbol needs to be matched together. Likely missing a linebreak here? "if two images matches" looks like wrong grammar for the verb? "tiles with same color" looks like it's missing an article; "tiles with same color of the symbol needs" is wrong grammar for the verb?
Review of attachment 269433 [details] [review]: You also need to add the images to the Makefile.am, same as you did with the page, but next to the other images.
Created attachment 269818 [details] [review] A new page for flower tiles and their matching is added to the help pages.
Review of attachment 269818 [details] [review]: Please pay closer attention to indenting, reflowing and whitespace. ::: help/C/flowertiles.page @@ +1,3 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="flowertiles"> <page> attributes are usually indented by 6 spaces so that they line up. This is the only exception to indenting by two spaces. @@ +8,3 @@ + <name>Rashi Aswani</name> + <email>aswanirashi19@gmail.com</email> + </credit> Check indentation here, <credit> should be indented same as <link>. <name> and <email> should be indented by two spaces deeper than <credit> (so by 6 spaces in total). @@ +11,3 @@ + <license> + <p>Creative Commons Share Alike 3.0</p> + </license> Indentation, but more importantly, please use XIncludes for the license. You can find information on how to do this at https://wiki.gnome.org/DocumentationProject/Licensing @@ +20,3 @@ + theme and black symbols in smooth theme. The identical flower tiles are matched in postmodern theme and the flower tiles with the same + symbol color are matched in smooth theme. + </p> Close tags on the same line as the content. Please reflow the whole paragraph to 79 characters wide (if you use an 80 character wide terminal, the 'gqap' command in vim will reflow the paragraph for you to the correct width, although you need to make sure that indentation is set correctly). There are actually only four flower tiles, you can read https://en.wikipedia.org/wiki/Mahjongg#Honors_and_bonus_tiles for more information about them. It sounds like the page is more about the "bonus tiles" (flower + seasons) rather than just the "flower tiles", so I think it would make sense to rename it to talk about the bonus tiles. @@ +22,3 @@ + </p> + <p>Some of the matching flower tiles in smooth theme are shown below:</p> + <table> You should consider using figures for these instead of a table: http://projectmallard.org/1.0/mal_block_figure @@ +24,3 @@ + <table> + <tr> + <td><p><em>Black Symbols</em></p></td> I would prefer to refer to these as "Season tiles". @@ +30,3 @@ + <media type="image" src="figures/black-symbol1.png" width="100" height="100"> + <p>Black Symbol</p> + </media> It looks like these are stretched, which makes them look pixely. It's possible to extract the tiles from data/smooth.png (with a bit of cropping in gimp) and from data/postmodern.png (with a bit of selective exporting in inkscape).
Please have a look at https://wiki.gnome.org/Git/CommitMessages about writing commit messages. Now that you have color.ui enabled for git, when you write the commit message, you should have the subject/title highlighted in orange for the first 50 characters, so it will be easier to keep them short.
Created attachment 270297 [details] [review] A new help page for bonus tiles is added There are eight bonus tiles: four flowers and four seasons. The postmodern theme has blue winter motives in flower group and yellow spring motives in season group. The smooth theme has yellow symbols in flower group and black symbols in season group. The identical bonus tiles are matched in postmodern theme and the bonus tiles with the same symbol color are matched in smooth theme.
Review of attachment 270297 [details] [review]: Almost there now :) ::: help/C/flowertiles.page @@ +1,3 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="topic" + id="flowertiles"> You should update the id and the filename to reflect that the page is about bonus tiles. Make sure to update the Makefile as well. @@ +18,3 @@ + postmodern theme and black symbols in smooth theme. The identical bonus + tiles are matched in postmodern theme and the bonus tiles with the same + symbol color are matched in smooth theme.</p> "in *the* <themename> theme" @@ +27,3 @@ + <media type="image" mime="image/png" src="figures/black-symbol2.png" + width="100" height="100"/> + </figure> I think it may make sense to show all four of these in one png, and chop them out of the file that they are taken from for the game so that you don't need to lay them out yourself. The images are not square, and upscaling them makes them look pixely, so it's better to not specify the width and height.
Thanks for the review :) Glad that I am almost there :D Can you please explain me how to show the images of the matching tiles? Should I add one snapshot of the whole game, consisting of all the 4 tiles and then show the matching tiles below it?
(In reply to comment #12) > Can you please explain me how to show the images of the matching tiles? > Should I add one snapshot of the whole game, consisting of all the 4 tiles and > then show the matching tiles below it? If you open the file in data/smooth.png with Shotwell, GIMP or any other image editing application, you will be able to "crop" it to show only the correct tile set. The yellow and black bonus tile sets are both on the right hand side of the image. Ping me in IRC if you need help cropping them out :)
Created attachment 270335 [details] [review] A new help page for bonus tiles is added There are eight bonus tiles: four flowers and four seasons. The postmodern theme has blue winter motives in flower group and yellow spring motives in season group. The smooth theme has yellow symbols in flower group and black symbols in season group. The identical bonus tiles are matched in postmodern theme and the bonus tiles with the same symbol color are matched in smooth theme.
Comment on attachment 270335 [details] [review] A new help page for bonus tiles is added Pushed to master in commit 6eb28d5c631b12aec5bd6b4e0e500afe4ba07969 with some minor stylistic changes.