GNOME Bugzilla – Bug 314001
Documentation needs updating
Last modified: 2009-06-11 19:08:57 UTC
Rhythmbox's manual (Available as Help->Contents) needs updating; some issues include: * Introduction talks about ID3 organised music, probably should say "tagged music" or something. ID3 is a technical term, and isn't even accurate for some media types (ogg files) * Introduction 1.3 is empty. * Several places: the "Side Bar" is now called the "Source List" * "Using Music Player" 3.2, says to use "Organize → Add to Library..." which doesn't exist * "Using Music Player" 3.2.2, says the delete key is a shortcut for removing a track from the library. It isn't. * "Using Music Player" 3.4.2 and 3.4.2 should mention that they only apply to normal playlists, not automatic ones. * "Using Music Player" 3.4.5 - this doesn't work for me. Has the feature been removed, or is currently broken? * "Using Music Player" 3.6 - the panel applet now has "show window" and "quit" menu items. (CVS also has notification bubbles) * Keyboard Shortcuts - "New Group" should be "New Playlist", "Restart" should be "Repeat", "Cntl-W Exit Music Player" should be "Cntl-Q Quit", "F2 Rename group" should be removed. "Show"Hide Browser is not Cntl-B not F7, "Small Display Mode" is Cntl-D not F8, "Side Bar" is called "Source List and is Cntl-L not F9
For Information I started to update the help file following the previous comments, and done various work to add sections on podcast, playlists.
Created attachment 58827 [details] a tarball of the doc This is an initial documentation, I didn't updated all sections. I've an html export at http://www.kinoa.info/GNOME/Rhythmbox/help/rhythmbox.html
Looks good, some minor issues: 1. It isn't obvious which is supposed to be the DAAP source in the figure at: http://www.kinoa.info/GNOME/Rhythmbox/help/rhythmbox.html#rb-window-intro Is it the "Heat" source? Perhaps the screenshot could be tweaked to label it as "Users DAAP share". Or if it isn't a DAAP share, maybe one could be added. 2. The status bar section is out of date: http://www.kinoa.info/GNOME/Rhythmbox/help/rhythmbox.html#Playing The shuffle and repeat options are now in the toolbar, and should be replaced with screenshots of the toolbar.
Created attachment 59151 [details] updated docs I'll update the doc a bit The Heat source is an Audio CD, there is a bug in gnome-icon-theme ATM and the Audio CD icon disppeared. I will provide a DAAP screenshot in few days. 2. Updated.
There is a request to incorporate LIRC documentation at bug #324101.
This looks good enough to commit to CVS and is a vast improvement on what's there currently, so is possible to add, James? Things can always be tweaked later, also this bug blocks the porting to gnome-doc-utils (bug #326113).
I've committed it to cvs, so that our documention isn't quite so out of date. Feel free to attach any updates.
Hello James, I have an updated version of the documentation, I will provide it to you tomorrow as soon I'll be back at home.
Memo: there are a couple of cosmetic change we could apply to match other GNOME manuals. * Rename "&app; Window" title for section as "Getting Started" * Add in this Getting Started a "To Start &app" section (see other manuals) * use "To <DO SOMETING>" as title for section explaing a procedure (typically <sect2> stuff) and and add a list of actions to performs (see other manuals)
Hello Luca :) For "Getting Started", I started to write a small section, with the appropriate way to start Rb from menu and terminal. It's on my disk. I totally agree the Rb doc is not properly structured, but I didn't really knwo how to start, that's why I've written it by source. I would accept some elp or guideline to improve it. :)
Of relevance is the woefully out of date screenshot on the webpage (bug #332029), I suggest using one of the screenshots that are now in CVS in it's place.
*** Bug 333347 has been marked as a duplicate of this bug. ***
Under "Library Source", the documentation also says "At this time Rhythmbox Music Player is not able to modify the tags of your music files, but you can use another software like Easytag." Rhythmbox is now able to modify tags, I believe.
(In reply to comment #13) > > Rhythmbox is now able to modify tags, I believe. > There could be still issues with Ogg/Vorbis. I don't know if the needed stuff are yet in GStreamer sources.
The section with id cd-import in rhythmbox.xml refers to the 'Import Audio CD...' menu option and launching Sound-Juicer. This menu option appears to have been removed with the introduction of the audiocd plugin.
I'm closing this bug as it is very difficult to know what has been done, as time goes by. I just committed a patch in bug #531310 which fixes several issues. Feel free to reopen new bugs with more precise information if you still find outdated information.