Rockbox

Tasklist

FS#10979 - Manual: Have all keymap actions defined in one place for each platform

Attached to Project: Rockbox
Opened by Tomer Shalev (tomers) - Sunday, 07 February 2010, 21:47 GMT
Last edited by Tomer Shalev (tomers) - Tuesday, 09 February 2010, 07:18 GMT
Task Type Patches
Category Manual
Status New
Assigned To Tomer Shalev (tomers)
Operating System All players
Severity Low
Priority Normal
Reported Version Daily build (which?)
Due in Version Undecided
Due Date Undecided
Percent Complete 0%
Votes 0
Private No

Details

This patch tries to avoid the \opt / \nopt hell in manual's tex files, by concentrating all different action definitions together in the platforms keymap file.

Current patch contains changes only to the jpegviewer plugin, in order to demonstrate functionality. Please provide feedback before I spend a lot of time converting all other locations in the manual to this proposed form.

I think this way of organizing keymap assignments is better because it is neater, and each platform has its button assignment all in one place. Adding new platform is much easier this way.

The patch also use one keymap file to all ipod brands, because they are similar to each other (the ipod4g adds some keymappings, but it doesn't matter if they are defined in other ipod brands).
This task depends upon

Comment by Alexander Levin (fml2) - Monday, 08 February 2010, 23:12 GMT
Here is my feedback after briefly looking at the task:

1. The task header is bad

2. The task category is chosen wrong

3. I think that if we were to provide keymap files for plugins then it should be different files than the files with the core keymaps. I.e. those files should be in the "plugin" subdirectory of the manual.

4. IMO we do not need these files. Just define all the macros in the beginning of the .tex file for that plugin and then use them in text. The LaTeX code will be neat and everything will be in one place.
Comment by Tomer Shalev (tomers) - Tuesday, 09 February 2010, 07:29 GMT
1. The task header is bad
2. The task category is chosen wrong
> I don't know how I overlooked that. I was probably too tired :-) Thanks for noticing.

3. I think that if we were to provide keymap files for plugins then it should be different files than the files with the core keymaps. I.e. those files should be in the "plugin" subdirectory of the manual.
4. IMO we do not need these files. Just define all the macros in the beginning of the .tex file for that plugin and then use them in text. The LaTeX code will be neat and everything will be in one place.
> Sounds reasonable, and it is probably better than having it all in one place. But it will still have \opt and \nopt mess in each file, and when adding a new platform (which is an extremely rare event) you will have to change many files instead of copying from one platform to the new one and modifying the keymaps.
I will post an updated patch in the near future according to your suggestion. Thanks.
Comment by Alexander Levin (fml2) - Tuesday, 09 February 2010, 10:14 GMT
One more question: do I understand correctly that you also replaced many ipod keymap files with just one? I think that this, if at all, should be done in a separate patch.
Comment by Dominik Riebeling (bluebrother) - Tuesday, 09 February 2010, 18:11 GMT
> One more question: do I understand correctly that you also replaced many ipod keymap files with just one?

As far as I can see from the patch this is the case. And I absolutely agree that (if merging does make sense at all, haven't checked yet) it should be done in a separate patch. IMO it's fine to make this patch rely on a different patch that does the merging.

Loading...