Manual Todo

---

Introduction

This page is used to organize work being done on the documentation. See also ManualFixmes which contains a list of places in the manual 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. If you decide to tackle a particular issue, please add your name to the "Worked on by who?" column so that work isn't repeated, and remove the entry when you've completed it.

---

To-Do

General Issues

Issue	What needs to be done	Worked on by who?

Chapter Specific

Chapter		What needs to be done	Worked on by who?
General Settings	System	Keyclick setting is missing.	see FS#10491

Plugins

The following plugins have issues to be addressed, and we also need to decide if the docs for plugins should exist solely in the manual or not - as it stands, they are duplicated by the wiki, making maintenance more difficult.

Plugin	Status	Worked on by who?
Doom	initial attempt started, still needs to look after everything thats not documented yet.	RobertMenes (I have some work done in my local trunk)
Jackpot	please verify
Jewels	Needs Checking
Text Viewer	needs descriptions of new options minor corrections etc
Text Editor	Description is very sparse and lacks keymaps of the two menus

---

Wiki Stuff

We need to decide which of the following pages contain information which is better suited to the manual or the wiki as it's redundant and more difficult to maintain having them in both places. I've started sorting them but feel free to move them around as you see fit.

Leave in the Wiki

• PluginIndex - Where to find information on all plugins
• SimpleGuideToWPSMaking - A simple guide to making your own WPS
• ThemeGuidelines - Guidelines for submitting themes
• SubmitWPS - Instructions on how to submit your WPS for inclusion with the regular build
• CreateFonts - How to create fonts for use with Rockbox
• FontFormat - The Rockbox font format
• UnicodeGuide - The Unicode info page
• UnicodeFonts - The status of Unicode support with various fonts
• LangFiles - Details on the .lang file type
• CustomIcons - How to create custom icons for Rockbox
• VoiceHowto - How to make your player speak
• VoiceBuilding - How to make your own voices
• GaplessPlayback - About Gapless playback
• GaplessHowTo - How to create gapless sound files
• VolumeTriggeredRecording
• RoLo - Information on the Rockbox Loader
• SoundCodecs - Details on the codecs supported by Rockbox
• ShuffleExplained - Basic description of how shuffle works in Rockbox

Move to the Manual

• ViewerPlugin - Information on viewer plugins
• PluginMpegplayer - Information on the MPEG video player plugin (particularly the missing parts of the menu options)
• PluginJpeg - Information on the JPEG plugin
• PluginRockboy - Information on the Rockboy (Gameboy emulator) plugin
• CustomWPS - How to design your own custom While Playing Screen
• AlbumArt - Information on using Album Art - FS#9928
• DataBase - Details on the Rockbox Database
• CustomConfigFile - Details of the Rockbox configuration file type
• LastFMLog - Info on last.fm logging capabilities
• ScreenDump - How to take a bitmap image of your screen
• LoadableKeyboardLayouts - Information on custom keyboard layouts
• CustomFiletypeColours - Make your File Browser look like Linux! - In the manual as of r20348
• Missing parts of TriggerManual

---

Ideas For The Future

Idea	Who?

---

Ideas for New Manual Structure

See ManualStructureTalk.

---