rockbox/manual/plugins
Alex Parker 12791d3714 Update Battery Benchmark plugin in the manual to correct some out-of-date
information, and rewrite some sections to improve the English.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@20352 a1c6a512-1295-4272-9138-f99709370657
2009-03-18 22:37:24 +00:00
..
images Add PictureFlow plugin to the manual 2009-02-16 20:10:01 +00:00
alpinecdc.tex FS #8340 by David Bishop. Remove contractions from the manual, as this seems to be common practice in this format and makes it easier to read for non-native english speakers. New manual work should try to adhere to this. 2008-02-13 13:32:44 +00:00
batterybenchmark.tex Update Battery Benchmark plugin in the manual to correct some out-of-date 2009-03-18 22:37:24 +00:00
blackjack.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
bounce.tex Make more use of the 'features' system in the manuals (committed in r16304), less stuff to keep in sync manually but keep in mind that changes in config-*.h can now affect the manual 2008-03-23 22:07:09 +00:00
brickmania.tex General language cleanup and small restrucuring of the source code of misc. parts of the manual. 2008-07-14 22:47:40 +00:00
bubbles.tex Since r19253 bubbles uses a standard menu instead of a custom start screen where certain key presses were used to adjust start level etc. The button table in the manual doesn't need to mention them either. 2008-11-30 13:48:31 +00:00
calculator.tex Split HAVE_SCROLLWHEEL into HAVE_SCROLLWHEEL and HAVE_WHEEL_ACCELERATION, where the latter now activates the wheel acceleration code. 2009-03-02 19:25:50 +00:00
calendar.tex Fix wrong button for exiting calendar 2008-12-26 10:14:29 +00:00
chess_clock.tex Some more small updates in the manual's plugins section: fill out missing info in some button tables, fix typos and descriptions, additionally fix wrong info in my previous mpegplayer.tex commit, add missing screenshot (c200 chess_clock) and wrap the example line in the shortcuts.tex into 'example' because the line didn't break correctly and looked weird in the pdf. 2008-06-21 10:39:23 +00:00
chessbox.tex Its not It's. 2008-07-09 02:26:49 +00:00
chip8emulator.tex Manual - plugin button tables: fill out missing info for the c200 pad (chip8emulator, doom, snake, snake2, wormlet), also update the table in clock.tex (was outdated for all and missing the mode and skin 'shortcuts'), add a small note about how to quit credits, change the list of the four direction buttons in some tex files (minesweeper, flipit, sudoku) so that the line can break and won't overlap, correct the position of } in rockblox.tex to not let the 'pause' line appear when it doesn't exist on a target. Break overly long lines. 2008-09-16 23:24:31 +00:00
chopper.tex Manual - plugin button tables: fill out missing info for the c200 pad (chip8emulator, doom, snake, snake2, wormlet), also update the table in clock.tex (was outdated for all and missing the mode and skin 'shortcuts'), add a small note about how to quit credits, change the list of the four direction buttons in some tex files (minesweeper, flipit, sudoku) so that the line can break and won't overlap, correct the position of } in rockblox.tex to not let the 'pause' line appear when it doesn't exist on a target. Break overly long lines. 2008-09-16 23:24:31 +00:00
clock.tex Manual - plugin button tables: fill out missing info for the c200 pad (chip8emulator, doom, snake, snake2, wormlet), also update the table in clock.tex (was outdated for all and missing the mode and skin 'shortcuts'), add a small note about how to quit credits, change the list of the four direction buttons in some tex files (minesweeper, flipit, sudoku) so that the line can break and won't overlap, correct the position of } in rockblox.tex to not let the 'pause' line appear when it doesn't exist on a target. Break overly long lines. 2008-09-16 23:24:31 +00:00
credits.tex Manual - plugin button tables: fill out missing info for the c200 pad (chip8emulator, doom, snake, snake2, wormlet), also update the table in clock.tex (was outdated for all and missing the mode and skin 'shortcuts'), add a small note about how to quit credits, change the list of the four direction buttons in some tex files (minesweeper, flipit, sudoku) so that the line can break and won't overlap, correct the position of } in rockblox.tex to not let the 'pause' line appear when it doesn't exist on a target. Break overly long lines. 2008-09-16 23:24:31 +00:00
cube.tex Manual, cube button table: be a bit more accurate to avoid misunderstandings. 2008-09-23 22:14:38 +00:00
demystify.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
dice.tex Some more small updates in the manual's plugins section: fill out missing info in some button tables, fix typos and descriptions, additionally fix wrong info in my previous mpegplayer.tex commit, add missing screenshot (c200 chess_clock) and wrap the example line in the shortcuts.tex into 'example' because the line didn't break correctly and looked weird in the pdf. 2008-06-21 10:39:23 +00:00
disktidy.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
doom.tex Fix the InGame menu keymaps. Closes FS#9672. 2009-01-02 22:17:34 +00:00
euro_converter.tex
fire.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
firmware_flash.tex
flipit.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
goban.tex Goban plugin: FS#9897 by Joshua Simmons 2009-02-12 13:47:34 +00:00
invadrox.tex Accept FS#9905 by Alex Parker adding Invadrox to the manual 2009-02-14 07:54:05 +00:00
jackpot.tex
jewels.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
jpegviewer.tex Change Grayscale to Greyscale in the JPEG viewer and add explanation of the Display Option menu to the manual. 2009-02-19 00:38:41 +00:00
keybox.tex Manual page for the keybox plugin 2008-07-07 14:40:41 +00:00
lamp.tex Description off the lamp plugin: add missing keypads to the button table, fix the spelling for the X5/M5 pad (which prevented the button from showing up) and change the wording for a 'long press of play' to comply with the rest of the manuals. 2008-05-09 22:12:59 +00:00
logo.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
main.tex FS#9901 by Joshua Simmons for the Goban plugin: Goban overlay for the Archos targets. 2009-02-20 23:14:09 +00:00
mandelbrot.tex Rename h100 manual name "h1xx" to "h100" to be in line with other players. 2008-12-07 23:00:15 +00:00
mazezam.tex FS#8861 - More Rockbox friendly MazezaM (by Malcolm Tyrrell) 2008-04-10 23:28:19 +00:00
md5sum.tex Set some wrong or missing svn properties (keywords, eol-style) and remove the executable flag from md5sum.tex. 2008-07-01 10:37:45 +00:00
metronome.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
midiplay.tex Three times the charme... the new wording makes the parentheses unnecessary. 2008-06-13 20:03:00 +00:00
minesweeper.tex Manual - plugin button tables: fill out missing info for the c200 pad (chip8emulator, doom, snake, snake2, wormlet), also update the table in clock.tex (was outdated for all and missing the mode and skin 'shortcuts'), add a small note about how to quit credits, change the list of the four direction buttons in some tex files (minesweeper, flipit, sudoku) so that the line can break and won't overlap, correct the position of } in rockblox.tex to not let the 'pause' line appear when it doesn't exist on a target. Break overly long lines. 2008-09-16 23:24:31 +00:00
mosaic.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
movieplayer.tex
mpegplayer.tex Some more small updates in the manual's plugins section: fill out missing info in some button tables, fix typos and descriptions, additionally fix wrong info in my previous mpegplayer.tex commit, add missing screenshot (c200 chess_clock) and wrap the example line in the shortcuts.tex into 'example' because the line didn't break correctly and looked weird in the pdf. 2008-06-21 10:39:23 +00:00
nim.tex
oscilloscope.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
pacbox.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
pegbox.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
pictureflow.tex Split HAVE_SCROLLWHEEL into HAVE_SCROLLWHEEL and HAVE_WHEEL_ACCELERATION, where the latter now activates the wheel acceleration code. 2009-03-02 19:25:50 +00:00
plasma.tex Make more use of the 'features' system in the manuals (committed in r16304), less stuff to keep in sync manually but keep in mind that changes in config-*.h can now affect the manual 2008-03-23 22:07:09 +00:00
pong.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
ppmviewer.tex only build ppmviewer on colour targets (as it doesn't do greylib yet), and actually document it 2008-06-30 19:27:06 +00:00
random_folder_advance_config.tex Document FS#7074 - Random folder advance custom directories. 2008-06-27 01:54:39 +00:00
robotfindskitten.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
rockblox.tex Split HAVE_SCROLLWHEEL into HAVE_SCROLLWHEEL and HAVE_WHEEL_ACCELERATION, where the latter now activates the wheel acceleration code. 2009-03-02 19:25:50 +00:00
rockblox1d.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
rockbox_flash.tex
rockboy.tex Fix for two plugin descriptions in the manual; on the Rockboy options, the screen rotation option should rotate it "90 degrees", not "90 percent". Fix the Rockblox description to use better English and be a little more descriptive. 2009-02-16 23:28:27 +00:00
search.tex
shortcuts.tex Mention the .link files as a supported file type (FS#9927) 2009-02-28 22:04:58 +00:00
sliding.tex Rename h100 manual name "h1xx" to "h100" to be in line with other players. 2008-12-07 23:00:15 +00:00
snake.tex Manual - plugin button tables: fill out missing info for the c200 pad (chip8emulator, doom, snake, snake2, wormlet), also update the table in clock.tex (was outdated for all and missing the mode and skin 'shortcuts'), add a small note about how to quit credits, change the list of the four direction buttons in some tex files (minesweeper, flipit, sudoku) so that the line can break and won't overlap, correct the position of } in rockblox.tex to not let the 'pause' line appear when it doesn't exist on a target. Break overly long lines. 2008-09-16 23:24:31 +00:00
snake2.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
snow.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
sokoban.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00
solitaire.tex Fix a typo by slightly changing the affected sentence and remove a hard line break. 2008-10-25 16:40:49 +00:00
sort.tex Fix a few dead references in the manual and add an 's' where one was missing. 2008-07-06 21:32:59 +00:00
spacerocks.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
split_editor.tex FS #8340 by David Bishop. Remove contractions from the manual, as this seems to be common practice in this format and makes it easier to read for non-native english speakers. New manual work should try to adhere to this. 2008-02-13 13:32:44 +00:00
star.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
starfield.tex Make more use of the 'features' system in the manuals (committed in r16304), less stuff to keep in sync manually but keep in mind that changes in config-*.h can now affect the manual 2008-03-23 22:07:09 +00:00
stats.tex press the targets "stop" button to exit stats after counting if finished 2008-06-29 09:12:24 +00:00
stopwatch.tex Fill out and correct a few plugin button tables. This includes: adding missing info for some keypads (mainly c200 and H10), fixing typos or wrong (outdated) details, adding missing facts, some whitespace changes and breaking overly long lines to make the code better readable. 2008-06-19 01:08:37 +00:00
sudoku.tex Make Select change the scroll direction in Sudoku on Ipods (FS#8428 by Henri Valta). 2008-11-27 20:26:50 +00:00
text_editor.tex Add filetype colours to the manual. Also add a macro to give the 2009-03-18 14:24:28 +00:00
text_viewer.tex Overhaul of the text viewer chapter in the manual - the old one still described the not-existent-anymore button combos to change specific view modes etc. and which was replaced by a menu for quite a while already. Hence update the button table and describe the menu. Also mention the setting save (there was outdated info) and bookmarking (not mentioned yet). Wording could probably improved but at least the information is up-to-date... 2008-09-23 17:32:20 +00:00
vbrfix.tex
vumeter.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
wavplay.tex Don't promise features for a certain release in the manual 2008-07-01 21:54:32 +00:00
wormlet.tex Manual - plugin button tables: fill out missing info for the c200 pad (chip8emulator, doom, snake, snake2, wormlet), also update the table in clock.tex (was outdated for all and missing the mode and skin 'shortcuts'), add a small note about how to quit credits, change the list of the four direction buttons in some tex files (minesweeper, flipit, sudoku) so that the line can break and won't overlap, correct the position of } in rockblox.tex to not let the 'pause' line appear when it doesn't exist on a target. Break overly long lines. 2008-09-16 23:24:31 +00:00
xobox.tex - add button descriptions to the m:robe 100 manual for the majority of plugins 2008-03-18 09:24:35 +00:00
zxbox.tex Mostly cosmetic changes to some plugin descriptions in the manual: 1) In main.tex - don't mention chip8 games in the Player manual and give the correct path to the viewers directory. 2) Correct wrongly placed 'end' in zxbox.tex and remove link to the wiki as this chapter is based off of that page and there is no additional information on it. 3) Let long lists of button names break so they don't overlap with the next column in the pdf - blackjack, bubbles, demystify, flipit, logo, oscilloscope, pegbox, rockblox1d, rockblox, rockboy, sliding puzzle, snake2, solitaire, sudoku. 4) While at it, break long (code) lines in bubbles.tex. 5) Additionally exclude lines which showed only 'n/a' in the button tables for a specific target - pegbox, sokoban. 6) Use 'fname' to mark a path in disktidy.tex, also simplify the button table. 7) Use 'ButtonHold' in doom.tex. 2008-09-23 17:25:32 +00:00