Commit graph

128 commits

Author SHA1 Message Date
Solomon Peachy
f8bbe3352c rocker: First crack at manual for the AGPTek Rocker
It needs screenshots and slightly better installation instructions

Includes bits shared with other HibyOS platforms

Change-Id: I1c1974143b5badf1aca5c3281556ce553ab1b8a5
2021-07-24 11:16:57 -04:00
Aidan MacDonald
fde6eaa8e1 Add Fiio M3K and Shanling Q1 manuals
Includes installation instructions and a description of Rockbox's
limitations versus the original firmware. Some things are still
missing, notably screenshots for the Q1. The M3K image also needs
to be updated to include the 'select' button.

Change-Id: Ib533206df01925203edeccdd75e1bf22f407e794
2021-07-24 14:07:09 +00:00
Solomon Peachy
72e9b61061 manual: Replace all rockbox.org urls with https.
In the process, utilize the \download{} and \wikilink{} commands instead
of direct URLs.

Change-Id: Iad38c15c7b9cec95b6c011fd0dbdbb3326985bbc
2020-12-12 23:17:04 -05:00
Moshe Piekarski
0aa702836b Manual: remove most HWCODEC artifacts
This causes 3 changes in layout. 2 I can't track down and 1 is better this way.

Change-Id: If4ad5e1d7431b4c2cbaaf9767d78139ef4e2dc44
2020-11-18 14:35:09 +00:00
Johannes Rauh
963e979e6c Manual: add Multiboot for Sansa E200
Change-Id: I89d0881face9952184f49f28740896ead3c2dfb5
2020-09-01 03:16:48 +00:00
William Wilgus
3550283442 Add open_plugin to core
open_plugin allows arbitrary plugins to be called
in hotkey and start screen

replaces PictureFlow Integration
shortcuts menu plays plugins now too

rather than store paths and parameters in the settings
that reside in memory instead entries in a file are searched by hash.
after all, the plugin has to be loaded from disk anyways

----------------------------------------------------------------------------
shortcut_viewer.rock--  can now call plugins rather than taking you to them
in the browser
-----------------------------------------------------------------------------
Added a new option to menus:
 F_CB_ON_SELECT_ONLY
 instead of option callback every time a item is accessed
 F_CB_ON_SELECT_ONLY fires callback only when item is selected
-----------------------------------------------------------------------------
Added manual entries
-----------------------------------------------------------------------------

Change-Id: I078b57b1d2b4dd633c89212c1082fcbc1b516e6a
2020-08-17 10:15:14 -04:00
Solomon Peachy
0c4f89370d [2/4] get rid of HAVE_LCD_CHARCELLS
HAVE_LCD_BITMAP is now redundant.

lcd_bitmap is always-on in features.txt so manual and lang strings
don't have to change

Change-Id: I08eeb20de48099ffc2dc23782711af368c2ec794
2020-07-24 21:20:13 +00:00
Solomon Peachy
092c340a20 [1/4] Remove SH support and all archos targets
This removes all code specific to SH targets

Change-Id: I7980523785d2596e65c06430f4638eec74a06061
2020-07-24 21:20:13 +00:00
William Wilgus
b935475c58 Manual fix multiboot section
Change-Id: I7189b71e1bae2f2b772b5ecf96add563a1eb19a4
2020-05-23 22:52:08 +02:00
William Wilgus
42263152d4 Multiboot update manual entry
Change-Id: I99abe45adaade350222fa1f0aaf864a06d6dfcdf
2019-07-27 21:46:54 +02:00
Sebastian Leonhardt
5dfcadc45b manual: nitpicking on '-' character and other minor details
Change-Id: Id204276387d55ba2276530ed1cb6ee827e28062a
2018-08-05 12:57:05 +02:00
William Wilgus
dc87e9e9f3 Selective Backlight/Advanced Softlock - Selective actions based on context
Selective backlight allows the user to choose actions that will not
enable the backlight when pressed.

Advanced softlock allows user to choose actions that  will not be
blocked by screenlock on devices without a hold button.

Both only occur in FM and WPS Contexts.

Update:
Back from the dead
-Cleaned up code, removed unnecessary calls, re-arranged last filter action
  timeout conditional to work in case last_filtered_action_tick was never set
-Added entries to the manual
-Fixed back button on some menus not activating backlight
-Made menus more intuitive, no actions selected now changes menu item to off.
-Added talk fuctionality.
-Added option to disable selective backlight while on external power.
-Rewrote backlight and softlock handling code to fix issue with scrollwheels
-Menu changed to have toggle(yes/no) and settings
-Optimized selective actions lookup
-Added option to disable notification of 'buttons locked' while softlocked
-Removed uneeded code, consolidated action lookup to single function
-Fixed incorrect name on selective softlock menu
-Added option to disable touch on touchscreen devices
-Fixed backlight on original screenlock without selective screenlock active
-Added text selection in mask_select for when show_icons is off
-Fixed voice in mask_select to speak if voice is defined instead of spelling
-Added more lang defines (play skip seek)
-Added option to disable unknown keys turning on backlight
-Fixed Conditional argument In wrong place causing players without
	backlight to fail to build
-Fixed Disable Unknown blocking detection of context change
-Fixed canceling menu didn't update new settings
-Added Autolock on backlight off
-Removed backlight_on_force from backlight.c, Now sets ignore next to false
	and uses backlight_on
-Cleaned up autolock code added strings to lang file
-Fixed issue where rapid presses would bypass softlock
-Removed old softlock code, Cleaned selective actions code
-Changed menu to match existing RB menus
-Fixed Backlight_on_Hold blocked by backlight_ignore_next
-Fixed ignore_next for ipod
-Fixed bug allowing context with softlock to bypass selective backlight
-Changed mask_select to no longer prompt for changes to be saved
-Changed menu names
-Added ignore timeout to allow ipod scroll wheel to work properly and other
 players to still work properly, removed some previous code including
 ignore_event
-Increased ignore timeout to prevent sd card accesses from interrupting action
 code and turning on backlight
-Changed Unknown action to unmapped action in menu, changed handling code
-Removed unneeded logic and variables for handling unfiltered actions
-Reverted unmapped action code to previous functionality
-Added manual entries (thanks JohnB)
-Removed elusive unhandled unicode character from manual, changed formatting slightly

Actions:
Volume,Play,Seek,Skip

Extras:
Disable unmapped actions
Disable selective backlight on external power
Disable touch during softlock on touchscreen devices
Disable softlock notifications (power button still notifies)
Autolock on backlight off

Method:
Adds a function to ignore backlight on next call
 If selected action occurs backlight is forced on,
 Filter_first_keypress stays intact.

Selective softlock allows selected actions through, bypasses the normal
 softlock routine.

ToDo:
DONE

previous commit (#1) has attribution for folder_select.c which mask_select
is based from.

Change-Id: I08132ddcfd64c81751ef23b720f3ec6d68695fe4
2017-01-17 23:06:17 +01:00
Sebastian Leonhardt
6548dc2943 Manual: Add missing plugins
The text is usually only a short description taken from the wiki and
don't contain screenshots or keymaps, but should be better than nothing. :)

Added manual entries:
- Boomshine
- Dict
- FFT
- main_menu_config
- Matrix
- Maze (including keymap)
- PDbox
- Superdom
Additional changes/fixes:
- fix "Clix" alphabetical order
- add Frotz & ZXBox to games preamble

Change-Id: I169870420cbac8123695747ccfcbaaf3478c11cc
2016-04-15 01:15:30 +02:00
Szymon Dziok
e7f113e1bb Manual for the Samsung YH820.
Change-Id: I1c760b4846963f39b9df60413ffbb9f95dc0e0fb
2014-10-22 09:59:26 +02:00
Szymon Dziok
a8b5589523 Manual for the Samsung YH920/YH925.
Change-Id: I2db0023cae585e9c9517da9ed2e9de6195081ce2
2014-10-22 09:59:26 +02:00
Szymon Dziok
f313253e00 Manual: add M:Robe 100 to "Using ROLO" subsection.
Change-Id: Idab44f91ff5beb59cc7c7d858066e3db35fe2413
2014-10-02 16:08:23 +02:00
Alex Mayer
6c4395be94 Corrected typo '%Play' with 'Play' on line 407
Change-Id: I19b290c6dd305537746a2f3abeee947cec53aba9
Reviewed-on: http://gerrit.rockbox.org/324
Reviewed-by: Alex Parker <rockbox@aeparker.com>
2012-10-05 17:23:48 +02:00
Jean-Louis Biasini
6637e24aed Update Fuze+ manual (main files) FS#12492
- this patch add all general sections of the manual for the fuze+
     - also correct some typos

Change-Id: Idd28675f48c0d01079d8fa01d68d3238ad2a54ce
Reviewed-on: http://gerrit.rockbox.org/116
Reviewed-by: Dominik Riebeling <Dominik.Riebeling@gmail.com>
2012-05-01 20:19:25 +02:00
Alexander Levin
fa452c1025 Manual: Describe more generally how to customise the main menu.
Change-Id: I1eda6d8b7785d1e2888860c8e461eb54b4f9abb7
Reviewed-on: http://gerrit.rockbox.org/164
Reviewed-by: Alex Parker <rockbox@aeparker.com>
Tested-by: Alex Parker <rockbox@aeparker.com>
2012-03-02 21:19:39 +01:00
Thomas Martitz
e958aeeb76 root menu ordering: Remove underscores from the config setting.
The very vast majority doesn't have an underscore. There are a few
exceptions but there shouldn't be introduced even more.

Change-Id: I18d9bf86b5588f8a22a7a96d2dbea61fde4aba61
2012-02-29 00:05:40 +01:00
Jonathan Gordon
9f48f5f207 root menu: Use - to reset the root menu order from a config
use root_menu_order: - to reset the order

Change-Id: I10c38926d79b10c88e5f1e0acdd85ca1a1489edf
2012-02-27 09:34:37 +11:00
Jonathan Gordon
13412f67ca main menu: Add the ability to hide and reorder the main menu items.
To change the shown menu items add the line "root_menu_order:<items>" into your config.cfg
<items> can be any of:
bookmarks, files, database, wps, settings, recording, radio, playlists, plugins, system_menu, shortcuts

Manual entry by Alexander Levin

Change-Id: Ie7f4bfb0f795184de094d05fc341a6cedd1c0cde
Reviewed-on: http://gerrit.rockbox.org/104
Reviewed-by: Jonathan Gordon <rockbox@jdgordon.info>
2012-02-25 12:40:44 +01:00
Andree Buschmann
2a72e0af30 Add a recommendation about 'peak meter' usage to the manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31354 a1c6a512-1295-4272-9138-f99709370657
2011-12-18 12:41:52 +00:00
Fred Bauer
ea7a89606c FS#12293 Global default glyph setting in System > Limits > Glyphs To Cache. Defaults to 250. This saves a lot of RAM while still allowing non-English users to have adequate glyph coverage.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31031 a1c6a512-1295-4272-9138-f99709370657
2011-11-19 23:34:26 +00:00
Alex Parker
77a78ee8f4 Manual: add %Vg and %Vs tags. Closes FS#12230.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30332 a1c6a512-1295-4272-9138-f99709370657
2011-08-19 11:43:51 +00:00
Alex Parker
964a5e6dfb Manual: A few more spelling corrections.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30273 a1c6a512-1295-4272-9138-f99709370657
2011-08-09 14:39:32 +00:00
Marianne Arnold
b43b4936a1 Pick up the target rename completion in the manual started in r27823 ... this time taking care of the Iriver targets. This fixes a few issues with wrongly in- or excluded parts (e.g. pacbox missing from the H100 manual, invadrox wrongly included in the small H10 manual as the plugin's main.tex already used the new names without making sure they are there). If possible replace 'target name' \opts with sensible feature \opts. Fix small mistakes and break too long lines discovered along the way.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29075 a1c6a512-1295-4272-9138-f99709370657
2011-01-17 18:30:18 +00:00
Alexander Levin
55dc25fe72 Describe the default value of the new optional tag parameter
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27899 a1c6a512-1295-4272-9138-f99709370657
2010-08-26 20:56:07 +00:00
Jonathan Gordon
faaf431d32 Accept FS#11567 by Fred Bauer - better memory management for the skin fonts
%Fl now takes an optional 3rd param which is the number of glyphs to cache (default to 256). the smaller the number, the less ram will be used (i.e using 15 for a font which only shown numbers is a good idea)

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27882 a1c6a512-1295-4272-9138-f99709370657
2010-08-25 14:11:38 +00:00
Marianne Arnold
c4bdf20197 Manual: some cosmetic changes in phrasing as well as code... fix typos and RAS syndrome, correct use of dap{} and {daps}.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27809 a1c6a512-1295-4272-9138-f99709370657
2010-08-14 10:30:42 +00:00
Alex Parker
abd05669ba Manual: Fix typo
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27670 a1c6a512-1295-4272-9138-f99709370657
2010-08-02 21:38:37 +00:00
Marianne Arnold
8c54767453 Close the \ActionStdCancel correctly so that the following space won't be eaten.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27285 a1c6a512-1295-4272-9138-f99709370657
2010-07-04 22:33:37 +00:00
Marianne Arnold
79a863b322 Replace COWON_D2_PAD with 'touchscreen' in manual button tables and text where appropriate - places where a touch area is meant and hence valid for all touchscreen devices. Makes the Onda VX777 manual build correctly.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27282 a1c6a512-1295-4272-9138-f99709370657
2010-07-04 13:52:22 +00:00
Alexander Levin
e39f4098f2 Do not use fancy apostrophes in the verbatim code
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27092 a1c6a512-1295-4272-9138-f99709370657
2010-06-23 18:21:35 +00:00
Alex Parker
994d955d9c Fix typos/c&p errors.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26993 a1c6a512-1295-4272-9138-f99709370657
2010-06-20 16:23:47 +00:00
Alex Parker
64d4ddf216 Convert the manual to the new theme syntax. As a result, adds the viewport colour tags which closes FS#11372. Correct multifont tag from %F to %Fl
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26989 a1c6a512-1295-4272-9138-f99709370657
2010-06-20 12:58:41 +00:00
Alex Parker
1b0c77fd28 Add multifont to the manual. Closes FS#11294.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26987 a1c6a512-1295-4272-9138-f99709370657
2010-06-20 12:58:09 +00:00
Szymon Dziok
f7253e322f manual: add a forgotten note about reseting settings for the vibe 500.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26267 a1c6a512-1295-4272-9138-f99709370657
2010-05-24 19:24:38 +00:00
Alexander Levin
5a379bce60 Another strike against ugly apostrophes in the manual
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26199 a1c6a512-1295-4272-9138-f99709370657
2010-05-20 16:35:45 +00:00
Alexander Levin
87b2ad14c7 Another go at FS#11295 -- Use nice 'times' glyphs for describing dimensions. This time properly implemented.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26198 a1c6a512-1295-4272-9138-f99709370657
2010-05-20 16:20:58 +00:00
Alexander Levin
9fbd7fd9c9 Revert r26171. Special macro for the image base name is needed. Will be committed soon.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26173 a1c6a512-1295-4272-9138-f99709370657
2010-05-19 17:10:14 +00:00
Alexander Levin
3fa48eef45 Show another way to learn about convbdf
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26172 a1c6a512-1295-4272-9138-f99709370657
2010-05-19 16:34:20 +00:00
Alexander Levin
4bc0cf6fac Use nice 'times' glyphs for describing dimensions (FS#11295)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26171 a1c6a512-1295-4272-9138-f99709370657
2010-05-19 16:06:42 +00:00
Alexander Levin
d9306418ac Rockbox can handle fonts larger than 16 pixels too.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26152 a1c6a512-1295-4272-9138-f99709370657
2010-05-18 20:45:32 +00:00
Alexander Levin
64bb9a0bf5 Fix a couple of typos in the manual
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26151 a1c6a512-1295-4272-9138-f99709370657
2010-05-18 20:23:22 +00:00
Jonathan Gordon
32382938c5 .sbs is base skin, not custom statusbar
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26079 a1c6a512-1295-4272-9138-f99709370657
2010-05-16 11:20:42 +00:00
Alex Parker
6d549df28d FS#11243 - The %VI (capital i) WPS tag is not described in the manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25987 a1c6a512-1295-4272-9138-f99709370657
2010-05-13 08:13:37 +00:00
Alex Parker
40782d5c5e Update the discussion of themeing in the manual, and put a note in the wps tags appendix that the actual discussion is elsewhere.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25986 a1c6a512-1295-4272-9138-f99709370657
2010-05-13 08:13:31 +00:00
Alexander Levin
e0bb221859 Use a nice apostroph
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25975 a1c6a512-1295-4272-9138-f99709370657
2010-05-12 22:07:49 +00:00
Szymon Dziok
a09152b128 Packard Bell Vibe 500: Add a part of the manual (no plugin keymaps yet).
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25652 a1c6a512-1295-4272-9138-f99709370657
2010-04-15 18:35:41 +00:00