GNOME Bugzilla – Bug 496647
User manual is outdated
Last modified: 2009-03-03 20:14:41 UTC
Good morning, I'm involved in the Italian translation of the user Manual, v2.0 1) In C:/totem.xml:106 it is reported that the u.m. is related to version 1.6.0 of Totem. Is it correct? This because I'm using (from a while) v2.18.1 2) In C:/totem.xml:393 it is reported "grop-down" instead of "drop-down" 3) In C:/totem.xml:509 there is a blank space between </menuchoice> and "."
Issues 2 and 3 fixed, but 1 is part of a much bigger problem; that the Totem manual is completely out-of-date. 2007-11-25 Philip Withnall <pwithnall@svn.gnome.org> * C/totem.xml: * en_GB/en_GB.po: Modified patch from Eero Salokannel <epatic@pp.inet.fi> to fix documentation for "Take Screenshot..." dialog. (Closes: #486466) Wording changes to paragraphs about bug reporting. (Closes: #497183) Corrections to the documented menu path for Totem. (Closes: #497182) Fixed a typo and a whitespace issue. (Helps: #496647)
philip, "completely out-of-date" means "total rewrite", or "update some major parts"? how much time would it require to do this? i wonder if this could become a GHOP task...
(In reply to comment #2) > philip, "completely out-of-date" means "total rewrite", or "update some major > parts"? how much time would it require to do this? i wonder if this could > become a GHOP task... I think you could get away with updating some major parts, since the manual's written for version 1.6 of Totem, but what's documented hasn't changed drastically since then --- a lot more has just been added. It would be a good few hours' work to do it, but I think it might be suitable for a GHOP task. Bastien?
Sure. Very good idea.
cool! if one of you volunteers for mentoring, please go ahead and file it ("we! need! tasks!"), see http://code.google.com/p/google-highly-open-participation-gnome/wiki/HowToWriteAGoodTask to make it easy for students to run the latest (well, 2.21.2) svn version, we also provide a gnome vmware live cd at http://www.rpath.org/rbuilder/project/gnome/release?id=5914 . perhaps worth to mention in the description.
I made a few cleanups and improvements to the docs in my patch in bug #500783, but I think there's still plenty to go at for a GHOP task here: * The new features such as the codec buddy, subtitle work and any extra playlist functionality need to be documented. * Documentation needs to be written for all the plugins explaining what they do and how to use them. Documentation already exists for the "Always on Top" plugin in the main documentation, and might need to be moved. * The documentation figures sorely need updating, and perhaps new ones need to be added to explain things like the preferences or plugins dialogs. * The documentation's XML needs some formatting love. It's god awful to try and read! I think we could award bonus points for updating some of the documentation translations, or adding new translated figures. Bastien, anything to add? I'm not sure I could mentor this by myself, as patch #100556 was my first real foray into the world of documentation, but we could jointly mentor it, or something...
Maybe we should wait for the freeze before getting somebody to update the docs?
i have to admit: that sounds reasonible. UI *Freeze* is too late for this contest, but what about UI change announcement period starting next monday? after that, file your task... :)
Created attachment 128503 [details] [review] Update Totem's documentation. This updates all the outdated bits I could find in the documentation and adds new documentation for a few things, such as screenshot galleries and some subtitle stuff. The patch sets the document status to "update"[1]. It also removes some redundant/pointless bits from the documentation, and merges some parts. Still to do is documentation for the plugins, and a proper check to make sure we haven't missed out documentation for any features. [1]: http://live.gnome.org/DocumentationProject/StatusTracking
*** Bug 569078 has been marked as a duplicate of this bug. ***
2009-02-16 Philip Withnall <philip@tecnocode.co.uk> * C/totem.xml: Updated the documentation to match changes in Totem since the stone age. Added a bit of documentation for new features. (Helps: #496647)
2009-03-03 Philip Withnall <philip@tecnocode.co.uk> * C/totem.xml: Added documentation for the plugins and tidied up a few other things.