Rockbox

This is the bug/patch tracker for Rockbox. Click here for more information.

Quick links: Bugs · Patches · Rockbox frontpage

Tasklist

FS#9086 - Miscellaneous updates to the manual

Attached to Project: Rockbox
Opened by Eddy (bascule) - Wednesday, 11 June 2008, 14:20 GMT+2
Last edited by Eddy (bascule) - Saturday, 28 June 2008, 15:43 GMT+2
Task Type Patches
Category Manual
Status Closed
Assigned To Eddy (bascule)
Player Type All players
Severity Low
Priority Normal
Reported Version Daily build (which?)
Due in Version Undecided
Due Date 2008-07-31
Percent Complete 100%
Private No

Details

This is a placeholder task for my work on updating bits and pieces of the manual(s).

I'm noting where deficiencies lie and then I'll attach updated text files (or proper LaTex diffs if I can get it to work) as and when they're done :-)

Flashing/BootBox:
http://forums.rockbox.org/index.php?topic=15422.msg119593#msg119593
New WPS syntax: (I'm hoping someone else will beat me to it!)
Calling selection-specific context menus from the Main Menu (probably best in the missing $3.3 Menu Overview
$4.4 - Working with Playlists: (Again, I'm hoping someone else will beat me to it!)

Done:
$4.3.3 - Playlist indicies option:
http://forums.rockbox.org/index.php?topic=8715.0
Putting music on the player:
http://forums.rockbox.org/index.php?topic=14000.msg104870#msg104870
Change Pre-requisites section around and more explicitly describe putting the player into UMS mode
$3.1.1 Player controls - change second Scroll Forward to Scroll Back
$4.1.3 Virtual Keyboard - Add details of creating/using your own:
http://www.rockbox.org/twiki/bin/view/Main/WebHome?topic=LoadableKeyboardLayouts
$4.2 - Insert Link to Custom Database Wiki page
$5.10 - Update links to Playlist Catalog information
$7.3 - Verify that Show Path option also modifies Database titles
Use of fixed.cfg
'Bookmark Actions' context menu
20080623
$10.4.6 - Configuring disktidy:
http://forums.rockbox.org/index.php?topic=17199.msg127123#msg127123
$7.1 - More detail on Crossfade options:
http://forums.rockbox.org/index.php?topic=6726.0
iconsets
coloured filetypes
This task depends upon

Closed by  Eddy (bascule)
Saturday, 28 June 2008, 15:43 GMT+2
Reason for closing:  Accepted
Additional comments about closing:  Mostly committed, thanks Marc Guay and pixelma. Remaining updates to the manual will be posted as more specific tasks soon.
Comment by Marc Guay (Marc_Guay) - Wednesday, 11 June 2008, 17:00 GMT+2
Hey Eddy, I'm not sure how deep you're going to get into this but it might be worth refreshing the ManualTodo wiki page and searching through the tracker for all of the bugs in the Manual category.
Comment by Eddy (bascule) - Wednesday, 11 June 2008, 17:19 GMT+2
Marc, I was just planning to update annoying things that I know are missing and/or add detail to options that I have seen raised in the forums, but have never made it into the manual.

However, thanks for the reminder and I'll take a look at both those items as part of my 'preparation' ;)

I know it's going to be a long job but, like your excellent work on the Wiki, worth it in the long run...
Comment by Eddy (bascule) - Tuesday, 17 June 2008, 00:32 GMT+2
OK, here's the first one... I hope my new-found LaTex syntax knowledge is OK. Seemed to work for me in the PDF version (also attached).

There are changes to six files bundled up in this, but as they are all for the manual I thought it may not matter too much. Please let me know if they need to be split out.

/getting_started/installation.tex
$2.2 - clarity on UMS connection etc.

/rockbox_interface/main.tex
$3.1.1 - bugfix in button descriptions
NEW $3.1.4 Putting music on your player - brief overview of Drag 'n' Drop ability and recommended folder structure

/rockbox_interface/browsing_and_playing.tex
$4.1.3 - Virtual Keyboard - Link to Wiki (LoadableKeyboardLayouts}.

/rockbox_interface/tagcache.tex
NEW $4.2.5 Creating your own database navigation criteria - Link to Wiki (DataBase)

/working_with_playlists/main.tex
$4.4.2 Creating Playlists - clarify Playlist Catalog location is default, but not unchangeable
$4.4.6 Loading playlists - clarify Playlist Catalog location is default, but not unchangeable

/advanced_topics/main.tex
NEW $11.3 Changing the PLAYLIST CATALOG location
$11.3.2 Specs for cfg files - Description of the 'fixed.cfg' config file
Comment by Eddy (bascule) - Wednesday, 18 June 2008, 22:35 GMT+2
Some more updates completed. I split out the diffs this time, makes it easier to reject the dodgy ones ;)

Additions:

/rockbox_interface/wps.tex
$4.3.3 ...the Playlist Viewer Menu entries described

/configure_rockbox/file_view.tex
$7.3 Added effect of Show Path setting on Databse browser

/configure_rockbox/bookmarking.tex
$7.7 Explained Bookmark Actions context menu entries

I think these are ready to be committed, as the other things on my list will take more work, so may not be done for a little while.
   advanced_topics-main.diff (1.6 KiB) 
 manual/advanced_topics/main.tex |   12 ++++++++++++
 1 file changed, 12 insertions(+)

   configure_rockbox-bookmarking.diff (0.9 KiB) 
 manual/configure_rockbox/bookmarking.tex |    9 +++++++++
 1 file changed, 9 insertions(+)

   configure_rockbox-file_view.diff (0.7 KiB) 
 manual/configure_rockbox/file_view.tex |    3 +++
 1 file changed, 3 insertions(+)

   rockbox_interface-browsing_and_playing.diff (0.8 KiB) 
 manual/rockbox_interface/browsing_and_playing.tex |    2 ++
 1 file changed, 2 insertions(+)

   rockbox_interface-tagcache.diff (0.7 KiB) 
 manual/rockbox_interface/tagcache.tex |    4 ++++
 1 file changed, 4 insertions(+)

   rockbox_interface-wps.diff (1 KiB) 
 manual/rockbox_interface/wps.tex |   10 ++++++++++
 1 file changed, 10 insertions(+)

   working_with_playlists-main.diff (1 KiB) 
 manual/working_with_playlists/main.tex |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

   getting_started-installation.diff (1.9 KiB) 
 manual/getting_started/installation.tex |   17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

   rockbox_interface-main.diff (1.3 KiB) 
 manual/rockbox_interface/main.tex |    8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(application/pdf)    rockbox--r17725M-080618.pdf (929.8 KiB)
Comment by Eddy (bascule) - Wednesday, 18 June 2008, 22:40 GMT+2
...and all as one file, if you so wish
   all_man_updates.diff (9.9 KiB) 
 manual/working_with_playlists/main.tex            |    4 ++--
 manual/advanced_topics/main.tex                   |   12 ++++++++++++
 manual/getting_started/installation.tex           |   17 +++++++++--------
 manual/rockbox_interface/main.tex                 |    8 +++++++-
 manual/rockbox_interface/wps.tex                  |   10 ++++++++++
 manual/rockbox_interface/browsing_and_playing.tex |    2 ++
 manual/rockbox_interface/tagcache.tex             |    4 ++++
 manual/configure_rockbox/bookmarking.tex          |    9 +++++++++
 manual/configure_rockbox/file_view.tex            |    3 +++
 9 files changed, 58 insertions(+), 11 deletions(-)

Comment by Dominik Riebeling (bluebrother) - Thursday, 19 June 2008, 00:19 GMT+2
nice work. I just had a quick look at the diffs and noticed that there are several rather long lines -- could you please try to limit lines to 80 characters when possible (sometimes it makes sense to not break the lines, but ... ;-) I don't see a need for you reworking the diffs you already posted but it would be nice for new changes.
Comment by Eddy (bascule) - Tuesday, 24 June 2008, 00:08 GMT+2
Here's another batch:

Additions:

/configure_rockbox/playback_options.tex
Crossfade descriptions tweaked and descriptive graphic included

/advanced_topics/main.tex
Custom Filetype colours explained

/plugins/disktidy.tex
Custom configuration link to Wiki

/configure_rockbox/theme_settings.tex
Custom Icons link to Wiki pages

As I don't have commit access, I'd be grateful if someone could look them over and commit the suitable ones for me (and I have kept the line lengths trimmed this time).

The zip includes all (separate) diffs, plus a combined diff plus the image file.
   manual_updates_r17773.zip (28.8 KiB)
Comment by Marc Guay (Marc_Guay) - Tuesday, 24 June 2008, 07:17 GMT+2
I added 2 parts of your changes to /advanced_topics/main.tex, but left out the part about the Playlist Catalog location because it seemed too specific for that section. Perhaps it belongs in the Working With Playlists chapter?
Comment by Eddy (bascule) - Tuesday, 24 June 2008, 09:37 GMT+2
So what about the rest? I'm happy to make changes where necessary, but I don't really want this task to be in an indeterminate state when it comes to what has been committed and what has not.

I can split them out into lots of different tasks if that is the preferred method...
Comment by Steve Bavin (pondlife) - Tuesday, 24 June 2008, 10:17 GMT+2
I'd think that multiple tasks is the way to go, for trackability (if that's a word).
Comment by Eddy (bascule) - Tuesday, 24 June 2008, 11:25 GMT+2
Pixelma has kindly offered to look at the remaining patches. I'll split the rest out into separate tasks once she has committed those ones that make the grade...
Comment by Marc Guay (Marc_Guay) - Tuesday, 24 June 2008, 17:48 GMT+2
Hey Eddy, could you clarify this part of the "Putting Music on Your Player" addition: The default directory structure that is assumed by some parts of Rockbox (album art searching, WPS missing-tag fallback) is: /ArtistName/AlbumName/*.ext. I can't think of an example where this is true.
Comment by Eddy (bascule) - Wednesday, 25 June 2008, 10:42 GMT+2
Specifically, the original Rockbox default.wps and the new default Cabbie2.wps use conditionals to replace the album and artist tags with filepath information if the tag is missing. The assumption they use to do this is /ArtistName/AlbumName/filename.mp3
Also alluded to here: http://www.rockbox.org/twiki/bin/view/Main/CustomWPS#File_Info

Similarly, but not so specific, the AlbumArt search path for cover art (http://www.rockbox.org/twiki/bin/view/Main/AlbumArt#Where_To_Put_The_Images) includes the parent directory of a track and looks for albumtitle.bmp

My patch may not have made it clear enough that it is not a mandatory file structure, but by using it, people can save themselves a lot of hassle. I've seen a good number of people complaining that Rockbox is hard work, but it is because they have put *every* music file they have directly in the root directory!

If a user has un-tagged music within a good file structure, they may not even notice the lack of tagging, as the wps will smoothly default the tags with good filepath information.
Comment by Marianne Arnold (pixelma) - Saturday, 28 June 2008, 15:02 GMT+2
I committed quite a bit of the still missing stuff yesterday. Parts I skipped for the moment were (basically lacking knowledge about Rockbox my own here...)

- the disktidy plugin change (although I even made some own changes) but I wasn't sure because there were some changes to the disktidy plugin recently which might be worth mentioning too. That requires some investigation though

- the working with playlist part because I thought the my impression as a non-native speaker about the "specified playlist directory" was that it could be read as "you can specify any directory as playlist directory". Is this true, are there some things to be aware about if you do? There were a few mentions of "harddisk" there that I would change to just "disk" so it's more generic.

- the changes in the installation.tex because my impression was that some information gets lost (even though the old one can't be read that easily)

- finally all the things I just didn't see... (?). Actually I'm a bit lost what got already got committed and what not, maybe you could make a new diff against recent SVN?
Comment by Eddy (bascule) - Saturday, 28 June 2008, 15:40 GMT+2
Thanks very much for doing that. Now I'll go through all the changes I made and any that still haven't been committed, I'll re-post as new, specific Flyspray tasks. I can see now that the all-in-one task is not the best way to go :-)

FYI, the reason I changed the playlist text is that, yes, you can configure any directory to be the Playlist Catalog.

Loading...