Manual Todo
Introduction
This page is used to organize work being done on the manual. See also ManualFixmes which contains a list of places marked with the \fixme macro, and here's a quick-link to all of the open tasks in the tracker related to the manual: link.
To-Do
Issues
| Issue |
What needs to be done |
Status |
Done |
Worked on by who? |
|---|
| Target specific text |
Write the text more general, and \opt sections to their specific targets |
|
|
|
| Target spec. screenshots |
Add missing screenshots |
Most screenshots are in. screenshot macro to unify screenshots in cvs and already heavily used. |
95% |
|
| Correct labels/references |
A lot of the labels and references are wrong, these need to be fixed |
|
|
|
| Plugins missing |
Add plugins and screenshots (see PluginIndex) |
Most plugins are in |
|
NilsWallmenius |
| Unify the terms |
Write macros, for instance of the key-presses and use that when writing |
lot of macros in cvs and already heavily used, should cover the most cases |
90% |
|
| Unify the use of fonts |
Filenames should be used with the \fname macro. Use verbatim text where appropriate etc |
additional macros (\warn, \note) in cvs. Using of them has started |
50% |
|
| Add newer targets |
Create a platform file, correct / extend the text where appropriate |
most sections already extended |
80% |
|
Chapter Specific
| Chapter |
Status |
Done |
Worked on by who? |
|---|
| Browsing and playing |
Please correct what is wrong, and add what is missing |
95% |
MichaelDiFebbo |
| Browsing |
File Browser |
h100: quick screen missing in the main keymapping |
95% |
MichaelDiFebbo |
| Browsing |
Database |
Initial section in, need enhancements |
20% |
DominikRiebeling |
| The Main Menu |
Some tweaking still required |
90% |
MichaelDiFebbo |
| Main |
FM radio |
Ondio keymap still not complete |
50% |
|
| Main |
Recording |
Triggered recording is missing (see TriggerManual), Descriptions of encoders and maybe other things changed with the MRP (Monster Recording Patch) missing for swcodec. Screenshots are outdated. |
50% |
|
| General Settings |
Needs more target spec. changes. New menu items should be added |
90% |
MichaelDiFebbo |
| General |
Playback Options |
some button mappings are mising |
75% |
|
| General |
Display Options |
some references are missing, "screen scrolls out of view" needs to be explained better |
80% |
|
| General |
System Options |
Needs to be update with \setting macro |
98% |
MichaelDiFebbo |
| General |
Voice |
Needs to be updated with \setting macro |
80% |
|
| Plugins (see below for a detailed table) |
Some plugins still need to use the button macros, lots of x5 screenshots missing |
80% |
NilsWallmenius |
| Advanced Topics |
Needs more target specific changes |
70% |
|
| Appendix |
Still needs additions and changes |
70% |
|
Other
| What |
Status |
Done |
Targets |
Section |
Who? |
|---|
| hold button |
the hold button is on some devices a "soft hold" by pressing a button combo, on other targets it's a real switch. Rockboy uses the hold button and various games pause when hold is enabled. |
0% |
all |
plugins (mainly) |
|
| installation on iriver |
bootloader links on ManualRockboxInstall are all dead - remove from the manual |
30% |
iriver |
getting started |
|
| iriver remote |
mentioned in configuration -- should we write a more detailed section? |
20% |
iriver |
appendix? |
|
| Basic notes for migrating |
write some basic notes for migrating from OF, outlining the main differences etc. Should be one of the first chapters (maybe in "Getting started"?) |
0% |
all targets |
getting started |
|
| "Random folder advance" |
not documented in the manual, needs special attention because of the involved plugin |
0% |
all |
? |
| Table for supported audio file formats |
Currently the "File Formats table mentions that "various" formats are supported, maybe make a seperate table? |
0% |
All |
Appendix A |
|
| all-devices table |
archos table left from old "getting started" section |
10% |
all |
appendix |
DominikRiebeling |
| Links to specific WPS page missing |
Why not just have them all point to WPSGallery? |
|
e200/GigabeatFX |
Theme Settings |
|
Plugins
Please expand this table so we can get an overview over the status of each plugin.
| Plugin |
Status |
done |
Worked on by who? |
|---|
| Battery Benchmark |
Looks OK checking required |
90% |
|
| Brickmania |
done (feel free to enhance the text, its kind of short but sufficient) |
100% |
|
| Bounce |
done |
100% |
|
| Bubbles |
Hmmm. key Table is there, but appears on next page (in H140 version) |
70% |
|
| Calculator |
Please verify |
90% |
|
| Calendar |
done |
100% |
|
| Chessbox |
description is pretty short |
80% |
|
| Chess Clock |
done |
100% |
|
| Chip 8 |
done |
100% |
|
| Clock |
All non-archos screenshots need updating |
70% |
|
| Credits |
done |
100% |
|
| Cube |
done |
100% |
|
| Demystify |
done |
100% |
|
| Disktidy |
done |
100% |
|
| Doom |
initial attempt started, still needs to look after everything thats not documented yet. |
25% |
|
| Euro Converter |
Missing screenshot |
|
|
| Fire |
done |
100% |
|
| Flipit |
done |
100% |
|
| Jackpot |
please verify |
95% |
|
| Jewels |
Needs Checking |
75% |
|
| Jpeg viewer |
Lacks explanation of some menu options |
50% |
|
| Logo |
done |
100% |
|
| Mandelbrot |
done |
100% |
|
| Metronome |
Needs x5 keys |
|
|
| Minesweeper |
done |
100% |
|
| Mosaic |
done |
100% |
|
| Movie Player |
|
100% |
|
| Mpegplayer |
Not added to manual yet |
0% |
|
| Nim |
someone please verify |
95% |
|
| Oscilloscope |
done for 3.0 Missing x5 screenshot |
100% |
|
| Pacbox |
done for 3.0 needs x5 screenshot |
100% |
|
| Plasma |
done |
100% |
|
| Pong |
done |
100% |
|
| Rockblox |
screenshots updated |
95% |
|
| Rockboy |
done for working targets (iriver and recorder) but could be improved |
90% |
|
| Rockbox_flash |
missing screenshot |
|
|
| Rockpaint |
missing |
0% |
|
| Sliding Puzzle |
|
|
|
| Snake |
Needs Key Presses table. (No docs for this plugin in Wiki) |
|
|
| Snake 2 |
done |
100% |
|
| Sokoban |
done |
100% |
|
| Solitaire |
done |
100% |
|
| Spacerocks |
done |
100% |
|
| Split edit |
Needs new buttontable and screenshots |
50% |
|
| Star |
done |
100% |
|
| Starfield |
done |
100% |
|
| Stats |
finished (only 3.0 targets) |
100% |
|
| Stopwatch |
Missing screenshot |
|
|
| Sudoku |
done for 3.0 |
100% |
|
| Text editor |
initial work in cvs -- should we add a screenshot? Button Mappings ok, maybe we can this already declare as complete |
60% |
|
| Text Viewer |
needs descriptions of new options minor corrections etc |
50% |
|
| Vbrfix |
done |
100% |
|
| VU meter |
needs updated screenshots |
90% |
|
| Wavplay |
nothing yet (applies to MASCODEC only) |
0% |
|
| Wormlet |
done |
100% |
|
| Xobox |
done |
100% |
|
| ZXBox |
missing |
0% |
|
Future Tasks
| Issue |
What needs to be done |
Status |
Worked on by who? |
|---|
| FAQ |
Try to include some FAQs (maybe as appendix) in the manual |
|
|
| About the manual |
Write some explanations about the manual, esp. naming conventions (why is Iriver not written as iRiver in the manual? etc.) |
10% |
|
| Index |
generate an index from the manual (\index) |
|
|
| Themes Overviews |
Write a section that gives an overview with screenshots over the themes of a standard install. Mention common places for themes here |
|
|
| use capabilities in \opt |
Change the player specific \opt valuesto use capabilities (e.g. HAVE_RECORDING etc.) |
|
|
| external ressources |
build up a section with external ressources (plugbox, wps sites, etc) |
|
|
| "Working with Playlists" chapter |
Consolidate all discussion of how to use playlists into a single, cohesive chapter. |
20% |
MichaelDiFebbo |
Ideas for New Manual Structure
See ManualStructureTalk.
|
