release
dev builds
extras
themes manual
wiki
device status forums
mailing lists
IRC bugs
patches
dev guide



Search | Go
Wiki > Main > DocBoxObsolete (r45)

Rockbox documentation work area

This page is for work in progress on the Rockbox documentation.

Todo: Ondio docs

The Ondio docs are as yet unfinished. This is what needs doing.

Please feel free to help out. These tasks are independent and can be done by multiple people and submitted seperately. Let us know here if you've taken on one of these tasks (put your WikiName? in brackets after the text so we don't duplicate effort).

Patches to the documentation should be submitted in OpenOffice format starting from the current RockboxManual via Sourceforge. It's probably best to start a new version of the file (Version from the OO File menu) before you start. Please follow the style guidelines as given below.

  • Chapters 2-3 need updating to include Ondio keys and any other Ondio specifics.

  • Chapter 5 needs Ondio keymaps added to all the Ondio compatible plugins, and reference to key mappings in the text removing.

  • Whole document: No actual key information should be contained within the body of the text. It should, in general be in tables. ideally one for each platform. (ChristiScarborough)

  • The entire text needs checking for references to to Recorders. Where appropriate, these should be updated to indicate that they also apply to the Ondio.

  • Chapter 2 - document how to use flash cards with the Ondio.

Other stuff that needs to happen before the next release.

  • Add section on restoring original firmware

  • Document flashing the player

  • Document recording beeps

  • Document changes to stereo separation settings

  • Document recording by signal level option

  • Changes to sleep timer

  • New plugin: logo

  • New plugin: rockboy

  • New plugin: iriverify

  • Player graphics library - new plugins

OpenOffice settings

OpenOffice has an object oriented styles model. On one hand, this is cool. On the other hand, it you don't use it properly, it sucks.

Try to avoid doing any manual formatting in Rockbox. There are three main circumstances where manual formatting is appropriate.

  • A genuine one off case - there's some specific formatting that simply doesn't have a general case.

  • Putting the odd word in bold. There's no point creating a custom style for that. But see "Minor titles" below.

  • Sometimes there is a single line on its own before a table. In this case manually format the paragraph not the style with "Keep with next paragraph"

NEVER do spacing with carriage returns (the title pages are an exception to this). Use space before, space after in styles / graphics / whatever. Trust me - it's much easier than having to rejig the spacing by hand every time you add something to the document.

Otherwise, the only formatting done should be by selecting the text to format and picking an appropriate style from the Style list. There are a couple of custom styles in the manual:

  • Minor title - use this for anything that's a title but doesn't want to go in the contents. Why? It binds itself to the following paragraph, so you won't get your titles appearing on their own at the end of a page.

  • Non-indexed heading - Same as Heading 2, but doesn't appear in the TOC. Used in Chapter 1 to make the intro more 'friendly'.

  • Table left - Most of our tables have row headings as well as column headings - Use this para style for the left hand column of a table where appropriate

Standard styles we use

  • Heading 1,2,3 - Section heirarchy - H1 is a section, H2 subsection, H3 subsubsection

  • Table Heading - Table column headings

  • Table Body - "Ordinary" table cells

  • Hyperlink, Footer - guess

  • Caption - used to format graphics captions.

  • Default - ordinary text

Changes from the OpenOffice defaults ("Rockbox house style")

  • The manual is aimed at end users. Technical information of interest to hackers is therefore left or the wiki for now. If someone wants to write more technical documentation, that's great. The manual, however, should remain focused on a more general audience.

  • Hyperlinks aren't underlined (Acrobat puts a square around them later anyway)

  • Default Style is changed to URWGothicL, 12pt. The OO default is ugly, because I say so. "Do not split paragraphs" is also turned on in the Default style. It's confusing to have paragraphs cross pages in a manual, let's not. 0.3cm space after paragraph.

  • We use a postscript font because this allows extendedPDF to create a searchable PDF file. (There's a Ghostscript bug that mates this not work with TT fonts.) It is also nicer than the default font.

  • Caption style is a 0.5cm gap before and after. This relates to the way we show images. Images are anchored as characters and tied to captions by putting them on the same logical line: ie image {hard line break (Shift + Enter)} caption. This "paragraph" is formatted in the "Caption" style, which is centred italic 10pt. It seems to be the only way to get the page end behaviour we'd expect out of images, otherwise the caption and image someitmes swap places at the end of a page leaving the caption on one page and the image at the top of the next. Yuck.

  • The background colour of table headings is "blue 8" - remember to strip formatting from tables imported from the wiki, unless you want to visually assault the reader.

  • Tables must be formatted by hand every time. There's no way to set defaults for tables (which sucks) 0.5cm gap before and after, do not split.

  • Ditto for images. Not sure if you still need to set borders on images with the new formatting method, but if you do it's 0.5 top and bottom

  • Also 0.5 top and bottom for any frames we might use. (Frames are generic "holders")

  • Remember - don't change the formatting, change the style. Then OO manages consistency for you, which is nice of it.

  • When removing erroneous styles, the "Default" item on the Format menu is your friend. This resets the selected area to the formatting selected by the Style. Styles are overridden by local formatting. Most of the time we don't want this.

  • For the same reason (consistency) any styles we use should be set to "auto-update".

  • We use the extendedPDF macro (freely available on the Net) to generate PDF output using Ghostscript - why? Because we get nifty bookmarks and hyperlinks, which OO's stardard PDF export doesn't support.

  • Menu options, configuration option names and filennames and paths (with trailing /) are given in bold Submenus use -> eg Backlight on when plugged, /.rockbox/, /.rockbox/lang/english.lang, Main Menu -> Playlist -> Show Playlist

  • Configuration options are quoted for text. Times, numbers etc. do not have surrounding quotes. eg "Always on", 1:00, 4

  • We do not do formatting using carriage returns. Objects such as tables, frames that need formatting should have a 0.5cm space in their before and after "Text Flow" spacing fields. Carriage returns only appear at the end of a paragraph.

  • Lists in general use the unnumbered list style with a grey button - see the manual. Don't use line breaks in lists unless there's a good reason (Extra paragraphs under a buller point are normally formatted as unbulleted items in the list. This makes the spacing uniform.) Avoid numbered lists if you can, as they can't be treated in this way and end up having to be formatted using line breaks.

  • If in doubt, find something similar in the manual. The Jukebox comparison table and the explanatory numbered list for the Split Editor are one off exceptions, and should not therefore be taken as examples of general good style. If still in doubt, ask.

Draft Manual

The current documentation master copy is available from RockboxManual.

Not currently active

The files below are copies of of the current draft of the Rockbox 2.3 manual.


CategoryFrontpage: Documentation work area

ChristiScarborough - 24 Jan 2005

  • buttons.zip: GIMP 2 source images for the button illustrations

lesbian lesbian lesbian sex lesbian lesbian porn lesbian teen lesbian lesbian gay lesbian lesbian lesbian video lesbian lesbian site myspace.com lesbian black lesbian lesbian free lesbian porn lesbian lesbian hentai lesbian lesbian picture lesbian lesbian fucking lesbian mature lesbian lesbian asian lesbian lesbian lesbian sex picture lesbian hot lesbian lesbian lesbian kissing lesbian free lesbian video lesbian lesbian movie lesbian lesbian orgy lesbian lesbian kiss lesbian lesbian personals lesbian free lesbian sex video lesbian lesbian dating lesbian free lesbian movie lesbian her first lesbian sex lesbian lesbian pic lesbian lesbian girl lesbian anal lesbian lesbian lesbian strap on lesbian anime lesbian lesbian young lesbian lesbian lesbian pussy lesbian lesbian sex video lesbian naked lesbian lesbian ebony lesbian lesbian amateur lesbian lesbian nude lesbian lesbian lesbian story lesbian free lesbian sex pic lesbian blonde lesbian lesbian first time lesbian lesbian free lesbian lesbian lesbian bondage lesbian latin lesbian lesbian lesbian hardcore lesbian lesbian lover lesbian lesbian cheerleader lesbian gay lesbian and bisexual lesbian lesbian sex story lesbian lesbian orgasm lesbian free lesbian sex lesbian sexy lesbian lesbian big tit lesbian lesbian lesbian licking lesbian lesbian love lesbian lesbian ass lesbian lesbian photo lesbian lesbian sistas lesbian lesbian dildo lesbian lesbian having sex lesbian interracial lesbian lesbian free lesbian picture lesbian busty lesbian lesbian lesbian chat lesbian first lesbian sex lesbian lesbian gallery lesbian milf lesbian lesbian lesbian foot lesbian lesbian cartoon lesbian fat lesbian lesbian lesbian store lesbian free lesbian pic lesbian lesbian shower lesbian horny lesbian lesbian lesbian sex movie lesbian lesbian xxx lesbian lesbian fisting lesbian lesbian threesome lesbian lesbian action lesbian lesbian erotica lesbian lesbian group lesbian college lesbian lesbian lesbian sexc lesbian free lesbian porn video lesbian lesbian gang bang lesbian lesbian licking pussy lesbian lesbian chat rooms lesbian lesbian porn star lesbian lesbian fuck lesbian lesbian sister lesbian japanese lesbian lesbian ass licking lesbian lesbian lesbian party lesbian lesbian tit lesbian old lesbian lesbian lesbian teacher lesbian lesbian school girl lesbian lesbian clip teen sex young teen sex free teen sex young teen sex teen sex pic young teen sex young teen sex young teen sex teen sex movie young teen sex free teen sex video young teen sex hot teen sex young teen sex free teen sex pic young teen sex pre teen sex young teen sex teen sex story young teen sex teen lesbian sex young teen sex teen anal sex young teen sex black teen sex young teen sex teen having sex young teen sex teen sex gallery young teen sex teen sex com young teen sex teen group sex young teen sex amateur teen sex young teen sex teen sex clip young teen sex teen sex party young teen sex teen titans sex young teen sex teen oral sex young teen sex free teen sex gallery young teen sex russian teen sex young teen sex teen sex xxx young teen sex rough teen sex young teen sex groups.msn.com sex site teen young teen sex page private sex teen young teen sex group info remember sex teen young teen sex interracial teen sex young teen sex pre teen have sex young teen sex japanese teen sex young teen sex free teen sex clip young teen sex teen sex for cash young teen sex info remember sex story teen young teen sex indian teen sex young teen sex teen couple sex young teen sex sex teen free pic young teen sex cute teen sex young teen sex live teen sex young teen sex teen sex tgp young teen sex free teen sex story young teen sex sex teen pic young teen sex sex education for teen young teen sex teen sex thumb young teen sex drunk teen sex young teen sex web cam teen sex young teen sex teen sex mpeg young teen sex school teen sex young teen sex real teen sex young teen sex teen hard sex young teen sex japan teen sex young teen sex teen titan sex young teen sex little teen sex young teen sex teen r sex young teen sex latina teen sex young teen sex teen sex pussy young teen sex ebony teen sex young teen sex teen sex vids young teen sex teen sex video clip young teen sex teen sex statistics young teen sex petite teen sex young teen sex teen sex blog young teen sex teen ass sex young teen sex free teen sex vids young teen sex teen sex .com young teen sex teen sex advice young teen sex naked teen sex young teen sex pre teen sex pic young teen sex free teen lesbian sex young teen sex info party remember sex teen young teen sex fat teen sex young teen sex college teen sex young teen sex young teen having sex young teen sex young teen sex pic black jack poker psp series world internet black jack poker psp series world online black jack poker psp series world jack black poker psp series world free black jack poker psp series world black jack online poker psp series world play black jack poker psp series world casino poker poker psp series world online casino poker poker psp series world bingo casino gambling online poker poker psp series world casino poker chips poker psp series world internet casino poker poker psp series world poker casino game poker psp series world free poker poker psp series world free online poker poker psp series world free poker game poker psp series world free strip poker poker psp series world free video poker poker psp series world full poker tilt poker psp series world full tilt poker poker psp series world internet poker poker psp series world internet poker game poker psp series world internet casino poker poker psp series world internet poker software poker psp series world internet poker site poker psp series world free internet poker poker psp series world best internet poker poker psp series world play internet poker online poker psp series world internet poker tournament poker psp series world internet poker software developer poker psp series world online casino poker psp series world online casino gambling poker psp series world best online casino poker psp series world free online casino poker psp series world best online casino gambling poker psp series world online casino review poker psp series world online casino game poker psp series world best online casino directory poker psp series world free online casino game poker psp series world 10 best online casino poker psp series world online casino bonus poker psp series world top online casino poker psp series world online casino poker psp series world online casino gambling poker psp series world best online casino poker psp series world free online casino poker psp series world best online casino gambling poker psp series world online casino review poker psp series world online casino game poker psp series world best online casino directory poker psp series world free online casino game poker psp series world 10 best online casino poker psp series world casino casino.com gambling.always online poker psp series world online casino bonus poker psp series world top online casino poker psp series world pacific poker poker psp series world 888 pacific poker poker psp series world pacific poker download poker psp series world pacific poker .com poker psp series world paradise poker poker psp series world paradise poker scam poker psp series world paradise poker bonus code poker psp series world paradise poker net poker psp series world party poker poker psp series world party poker bonus poker psp series world party poker bonus code poker psp series world party poker cheat poker psp series world free party poker poker psp series world poker party supply poker psp series world party poker stats poker psp series world party poker com poker psp series world party poker companion poker psp series world party poker cheat software poker psp series world poker theme party poker psp series world party poker player stats poker psp series world multiplayer sex poker party poker psp series world link online.musicbox1.com party poker poker psp series world poker party model poker psp series world party poker .com poker psp series world play poker poker psp series world play online poker poker psp series world play free poker poker psp series world play free poker online poker psp series world learn how to play poker poker psp series world play video poker poker psp series world play poker for fun poker psp series world play money poker poker psp series world play poker game poker psp series world play poker on line poker psp series world free texas holdem poker play poker psp series world chip poker poker psp series world chip poker set poker psp series world chip clay poker poker psp series world chip custom poker poker psp series world chip poker trick poker psp series world casino chip poker poker psp series world chip personalized poker poker psp series world case chip poker poker psp series world chip fantasy poker poker psp series world chip poker wholesale poker psp series world chip free poker poker psp series world buy chip poker poker psp series world poker game poker psp series world online poker game poker psp series world free poker game poker psp series world free online poker game poker psp series world poker card game poker psp series world video poker game poker psp series world strip poker game poker psp series world free video poker game poker psp series world poker game download poker psp series world poker game rule poker psp series world online video poker game poker psp series world free strip poker game poker psp series world crazy game of poker poker psp series world free online video poker game poker psp series world texas holdem poker game poker psp series world poker hands poker psp series world winning poker hands poker psp series world rank poker hands poker psp series world best poker hands poker psp series world ranking of poker hands poker psp series world texas holdem poker hands poker psp series world poker hands rule poker psp series world poker room poker psp series world online poker rooms poker psp series world online poker room review poker psp series world poker room review poker psp series world free poker rooms poker psp series world poker room software poker psp series world las vegas poker rooms poker psp series world best online poker room poker psp series world poker room .com poker psp series world poker rule poker psp series world holdem poker rule texas poker psp series world game poker rule poker psp series world poker rule tournament poker psp series world em hold poker rule texas poker psp series world play poker rule poker psp series world poker rule stud poker psp series world dealer poker rule poker psp series world omaha poker rule poker psp series world poker software poker psp series world party poker cheat software poker psp series world free poker software poker psp series world online poker software poker psp series world internet poker software poker psp series world poker room software poker psp series world poker software developer poker psp series world internet poker software developer poker psp series world poker software development poker psp series world poker star poker psp series world poker star net poker psp series world poker star .net poker psp series world poker star .com poker psp series world poker star cheat poker psp series world poker star download poker psp series world poker super star poker psp series world poker table poker psp series world poker table supply poker psp series world poker table top poker psp series world how to build a poker table poker psp series world poker table plan poker psp series world poker table for sale poker psp series world folding poker table poker psp series world custom poker table poker psp series world poker table felt poker psp series world cheap poker table poker psp series world texas holdem poker table poker psp series world poker tournament poker psp series world online poker tournament poker psp series world free poker tournament poker psp series world free online poker tournament poker psp series world las vegas poker tournament poker psp series world poker tournament rule poker psp series world atlantic city poker tournament poker psp series world freeroll poker tournament poker psp series world world poker tournament poker psp series world poker superstars invitational tournament poker psp series world strip poker poker psp series world free strip poker poker psp series world video strip poker poker psp series world online strip poker poker psp series world strip poker game poker psp series world free online strip poker poker psp series world free strip poker game poker psp series world community poker strip type poker psp series world live strip poker poker psp series world strip poker story poker psp series world holdem poker texas poker psp series world free holdem poker texas poker psp series world holdem online poker texas poker psp series world holdem poker rule texas poker psp series world game holdem poker texas poker psp series world free game holdem poker texas poker psp series world free holdem online poker texas poker psp series world download free holdem poker texas poker psp series world free holdem play poker texas poker psp series world holdem poker table texas poker psp series world holdem poker strategy texas poker psp series world video poker poker psp series world online video poker poker psp series world free video poker poker psp series world video strip poker poker psp series world poker video poker psp series world video poker game poker psp series world free video poker game poker psp series world free online video poker poker psp series world online video poker game poker psp series world poker series world poker psp series world 2005 poker series world poker psp series world 2005 poker result series world poker psp series world game poker series video world poker psp series world game poker series world poker psp series world 2006 poker series world poker psp series world poker ps2 series world poker psp series world 2005 poker series winner world poker psp series world event main poker series world poker psp series world cheat poker series world poker psp series world poker psp series world
Edit | Attach | Print version | History: r48 | r46 < r45 < r44 < r43 | Backlinks | View wiki text | More topic actions...
r45 - 29 Jan 2006 - 14:22:47 - AliRose?
Copyright by the contributing authors.