After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 649146 - GNOME chess: Convert documentation to Mallard format
GNOME chess: Convert documentation to Mallard format
Status: RESOLVED OBSOLETE
Product: gnome-chess
Classification: Applications
Component: Documentation
git master
Other All
: Normal enhancement
: ---
Assigned To: Maintainers of Gnome user documentation
gnome-chess-maint
Depends on:
Blocks:
 
 
Reported: 2011-05-02 06:27 UTC by Robert Ancell
Modified: 2018-05-22 12:20 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Added-content-to-the-change-promotion-type.page (1.54 KB, patch)
2012-01-16 00:58 UTC, Brian Grohe
committed Details | Review
Added-content-to-the-shortcuts.page of-glchess (2.00 KB, patch)
2012-01-16 01:02 UTC, Brian Grohe
committed Details | Review
Adds-content-to-file-change-board-orientation.page (1.50 KB, patch)
2012-01-16 01:03 UTC, Brian Grohe
committed Details | Review
Adds-content-to-save-resume.page-in-docs-for-glchess (1.56 KB, patch)
2012-01-16 01:04 UTC, Brian Grohe
committed Details | Review
Adds-content-to-the-intro.page-in-the-docs-of-glchess (1.41 KB, patch)
2012-01-16 01:04 UTC, Brian Grohe
committed Details | Review

Description Robert Ancell 2011-05-02 06:27:27 UTC
Convert documentation to Mallard format
Comment 1 Tiffany Antopolski 2011-12-11 00:36:32 UTC
Stub pages have been pushed to master.
Comment 2 Tiffany Antopolski 2011-12-17 16:33:03 UTC
Posted as a gci task Dec. 16, 2011.
Comment 3 Brian Grohe 2012-01-16 00:58:28 UTC
Created attachment 205323 [details] [review]
Added-content-to-the-change-promotion-type.page
Comment 4 Brian Grohe 2012-01-16 01:02:55 UTC
Created attachment 205324 [details] [review]
Added-content-to-the-shortcuts.page of-glchess
Comment 5 Brian Grohe 2012-01-16 01:03:37 UTC
Created attachment 205325 [details] [review]
Adds-content-to-file-change-board-orientation.page
Comment 6 Brian Grohe 2012-01-16 01:04:10 UTC
Created attachment 205326 [details] [review]
Adds-content-to-save-resume.page-in-docs-for-glchess
Comment 7 Brian Grohe 2012-01-16 01:04:47 UTC
Created attachment 205327 [details] [review]
Adds-content-to-the-intro.page-in-the-docs-of-glchess
Comment 8 Tiffany Antopolski 2012-01-16 05:27:39 UTC
Review of attachment 205323 [details] [review]:

instead of <list type="numbered">  you should use <steps>.  I made the adjustment and committed to the master branch.
Comment 9 Tiffany Antopolski 2012-01-16 05:28:07 UTC
Review of attachment 205324 [details] [review]:

Perfect.  Committed as is.
Comment 10 Tiffany Antopolski 2012-01-16 05:31:29 UTC
Review of attachment 205325 [details] [review]:

Again, when listing a sequence of steps, the <steps> element should be used.
When referring to a string the user sees in the interface, best to use the <gui> element.
If you want to refer to a sequence of clicks a user should make to get somewhere, you can use the <guiseq> element.
Example:

Click <guiseq><gui>Settings</gui><gui>Preferences></gui></guiseq>.

I made this adjustment and committed the work to the master branch.
Comment 11 Tiffany Antopolski 2012-01-16 05:32:49 UTC
Review of attachment 205326 [details] [review]:

Made the changes mentioned in the previous patches and committed to the master branch.
Comment 12 Tiffany Antopolski 2012-01-16 05:33:39 UTC
Review of attachment 205327 [details] [review]:

I reworded this slightly, and capitalised GlChess and GNOME.  Committed to master.
Comment 13 Tiffany Antopolski 2012-01-16 05:41:07 UTC
Hi Brian, 

  I squashed the five patches into one, and committed your work to the master branch.  You can view the commit here:

http://git.gnome.org/browse/gnome-games/commit/?id=495731d4a115920fcda1630d57e025f43d7df475

The commit showing my changes is here:

http://git.gnome.org/browse/gnome-games/commit/?id=f71ecad87dbcf7c8fd8f2df8c754ae003a09542a

I know it says [glines help] on my commit, but it should say [glchess help].  I can't fix the commit message now that it has been pushed :-(

Anyways, thanks for your work!  It really is good.  Looking forward to your iagno docs :-)  And perhaps you will be interested in the Swell Foop task?  You could get that one done with alot of copy/paste from glines or mahjongg... and then just do intro, shortcuts, and one other page of your choice (if you are interested of course).

:-)

Cheers.
Comment 14 oliver.steven 2012-07-13 12:37:12 UTC
Should the status of this be changed to Closed? It looks like, based on Comment #13 this has been fixed and pushed.
Comment 15 Tiffany Antopolski 2012-07-13 14:36:22 UTC
Due to continued updates to glchess, I had decided to leave this bug open.  I will have a look and if necessary do some further updates to the docs prior to the 3.6 release.
Comment 16 Jeremy Bicha 2013-04-18 00:21:44 UTC
(In reply to comment #14)
> Should the status of this be changed to Closed? It looks like, based on Comment
> #13 this has been fixed and pushed.

No, the Mallard-based help has some empty topic pages and the Docbook-based help is still used by default.
Comment 17 GNOME Infrastructure Team 2018-05-22 12:20:59 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gnome-chess/issues/8.