Commit graph

1935 commits

Author SHA1 Message Date
Dominik Riebeling
f8eb8c8679 Filter LaTeX output for errors.
Pipe the output of LaTeX through a Perl script and filter out information that
is irrelevant in deciding if building the manual actually worked. Format errors
in a similar way to gcc output to allow existing scripts catching it.

Enabling verbose output during the make run will not remove parts of the output
but only do some reflowing. The full log is always available in the manual
subfolder.

Change-Id: I15d35b4d3c73fafe2a4357168ca8ada51355f221
Reviewed-on: http://gerrit.rockbox.org/247
Reviewed-by: Dominik Riebeling <Dominik.Riebeling@gmail.com>
Tested-by: Dominik Riebeling <Dominik.Riebeling@gmail.com>
2012-06-19 21:32:10 +02:00
Michael Giacomelli
784fb6a1dd Fix keymap entry for the Clip series in the stopwatch plugin
Change-Id: If3ee1cb06957e52cf826dc66b6d276b4371ea798
2012-06-13 22:45:47 -04:00
Marianne Arnold
5f2618c363 Manual: Include the iaudio remote graphic in its manual again.
Commit bb24ac8c27 replaced the
\opt{iaudiom3,iriverh100} with \opt{remote} which isn't true in the
Iaudio M3 case as this feature is dependent on HAVE_REMOTE_LCD and
the M3 uses this screen as main lcd so doesn't define it. Use the manual
HAVEREMOTEKEYMAP for now as I didn't find a suitable other define yet.

Change-Id: I58b2abd2f7cae1a821cea297a2b4c002a3420493
2012-05-20 18:08:30 +02:00
Marianne Arnold
cf90958e94 Manual: Pull general album art info out of the theme tags section.
Make this info available for all bitmap targets, also ones that only need it
in the pictureflow description. Shuffle some lines around so that it doesn't
need too many opts. Fixes FS#11350.

Change-Id: I5268483c7a1d765c8a994614442309b05de1d832
2012-05-20 17:58:06 +02:00
Marianne Arnold
6c0a1cb223 Manual: Include the Iaudio remote graphic in the M5 and X5 manuals.
Create symlinks to the iaudiom3 graphics to not duplicate the picture itself
and to not lose the precise 'addressing' of the picture. Change the manual's
makefile to follow symlinks for this to work (thanks to Dominik and Jens for
the help there).

Change-Id: I5882880cb22cbf5561cb0872d7889b7c8c42b62e
2012-05-20 17:58:06 +02:00
Marianne Arnold
a5c5da4525 Fix broken touchscreen manuals.
Escape the underscores in the option name as otherwise they'll be interpreted
wrongly by latex.

Change-Id: I10c1168a90d94e685d326073dcf8370dd972db91
2012-05-19 12:55:23 +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
Nick Peskett
10d8717e94 Split sleep timer activation and default duration setting.
Where before there was a single sleep timer menu option which handled
initiating/ cancelling a sleep timer as well as setting the default duration,
now there is one menu option to either start or cancel a sleep timer and
another to set the default duration that will be used for future sleep timers.

Change-Id: Ibea3711ec6406845ff5d0c0568fe5d1739eb8deb
Reviewed-on: http://gerrit.rockbox.org/201
Reviewed-by: Nick Peskett <rockbox@peskett.co.uk>
2012-03-29 09:01:33 +02:00
Jonathan Gordon
6f62226294 quickscreen: optionally display the shortcuts menu instead of the QS
Adds an option under settings > general settings > system to allow
the user to have the shortcuts menu displayed instead of the
quick screen. (option is "shortcuts instead of quickscreen" in the .cfg)

Change-Id: Id679b461c40ac617629422736d1509384364084d
Reviewed-on: http://gerrit.rockbox.org/199
Reviewed-by: Marek Salaba <marek.salaba@gmail.com>
Reviewed-by: Jonathan Gordon <rockbox@jdgordon.info>
2012-03-28 10:56:12 +02:00
Jonathan Gordon
b2202a3d7c skin_engine: Allow negative numbers for the start offset in %ss
i.e %ss(-1, -, %ia) will get the last letter in the %ia tag

Change-Id: I6b2764d30c072b549e7424fc6e847ec48850b46a
2012-03-27 23:42:00 +11:00
Nick Peskett
be10817e1c Option to constrain get_next_dir() to directories below global_settings.start_directory.
When enabled, if the user has set "Start File Browser Here" (config.cfg:
start directory) to anything other than root and "Auto-Change Directory"
is set to "Yes" or "Random", the directory returned when an auto change
is required will be constrained to the value of "start directory" or below.

Change-Id: Iaab773868c4cab5a54f6ae67bdb22e84642a9e4b
Reviewed-on: http://gerrit.rockbox.org/182
Reviewed-by: Nick Peskett <rockbox@peskett.co.uk>
Tested-by: Nick Peskett <rockbox@peskett.co.uk>
2012-03-19 11:49:55 +01:00
Jonathan Gordon
014a08cabb skin_engine: New tag to draw a rectangle (optionally with a gradient)
%dr(x, y, width, height, [colour1[, colour2]]):
x,y - viewport relative pixel coordinates to start the rectangle.
width, height - obvious. can be '-' to fill the viewport
if both colours are left out the viewports foreground colour will be used
if one colour is specified it will fill the rectangle that colour.
if both colours are specified it will gradient fill the rectangle.

Change-Id: Iad451e99ded663bc7c5d182443659db7d909b388
2012-03-15 22:52:53 +11:00
Jean-Louis Biasini
dcc78cb867 Fuze+/calendar's plugin update keymaps and manual
- fuze+ keymaps for calculator updated
- manual updated accordingly
- also correct a little problem with a line only used by mpio hd300
manual but that appears on all other target's manual.

Change-Id: I9c4d3c21dc6174079edbde8035bad318e09ec74a
Reviewed-on: http://gerrit.rockbox.org/125
Reviewed-by: Amaury Pouly <amaury.pouly@gmail.com>
2012-03-15 11:31:19 +01:00
Osborne Jacobs
67b4b2af7c Update manual for %cs and %T tags
Added missing %T actions and %cs states.

Change-Id: Id7ec897c84141ac3d604e23b41e1138bbadc5c77
Reviewed-on: http://gerrit.rockbox.org/180
Reviewed-by: Jonathan Gordon <rockbox@jdgordon.info>
2012-03-13 08:54:28 +01:00
Osborne Jacobs
595427c095 Add new actions to %Tp (Touchscreen areas)
Add the following actions to %Tp:
createbookmark   create a new bookmark from the wps
listbookmarks    list bookmarks from the wps
trackinfo        show track info from the wps

My main motivation was to allow bookmarking and jumping around audio books
from the wps on touch enabled targets.  You can do it now through the context
menu but it requires 4 screen presses instead of 1.

Change-Id: I1fa1bf0064dfd22b897eca7c56acc1ce8956f14c
Reviewed-on: http://gerrit.rockbox.org/171
Reviewed-by: Jonathan Gordon <rockbox@jdgordon.info>
2012-03-13 03:17:12 +01:00
Dominik Riebeling
47e30b8cdc Update manual for boot behaviour on clip+, clipv2 and fuzev2.
The bootloader doesn't boot into the Original Firmware anymore since a while.
Remove the claim that Rockbox will always boot the OF on USB, and add a note
about older builds not providing USB support.

Change-Id: I44f37eeb849b522a2024eb26cee064e848bc4d17
2012-03-12 22:48:40 +01:00
pixelma
4601a8b44a Manual: Fix misaligment in the 'Images' theme tags table.
Commit 1c1e1c0 replaced one \newline with a \\ which means starting a complete
new table row instead of keeping the linebreak within a cell, so put it back.

Change-Id: I6962ff8fe2d1f18bd3d85398a7373b3df0634c50
2012-03-05 09:04:58 +01:00
Jean-Louis Biasini
693af46f6d Plugin mosaique PLA integration (code + manual)
This commit change:
1) replace all keymaps with PLA ones.
2) add an alternative exit button (PLA_EXIT or PLA_CANCEL)
3) do the required change to the manual in order to match
code's changes.
4) add a missing key in the manual and show them in a table

Change-Id: Ie983c7673c9dec1a9daeb34f5edaaa3c8be7dd5e
Reviewed-on: http://gerrit.rockbox.org/129
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Tested-by: Thomas Martitz <kugel@rockbox.org>
2012-03-03 16:37:47 +01:00
Jean-Louis Biasini
a92696d40d Plugin Starfield PLA integration (code + manual)
This commit changes:
1) replace all keymaps with PLA ones.
2) do the required changes to the manual in order to match
code's changes.
3) add an alternative exit button (PLA_EXIT or PLA_CANCEL)

Change-Id: I0cea909dd2ff44b8c5a2daba11c192965c4a02c7
Reviewed-on: http://gerrit.rockbox.org/131
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Tested-by: Thomas Martitz <kugel@rockbox.org>
2012-03-03 12:10:53 +01:00
Jean-Louis Biasini
10c566ed94 Plugin logo PLA integration (code + manual)
This commit changes:
1) replace all keymaps with PLA ones.
2) do the required change to the manual in order to match
code's changes.
3) add an alternative exit button (PLA_EXIT or PLA_CANCEL)
4) add the possibility to change values repeatily by holding key
pressed.

Change-Id: Ie68fd4e94830bba8a592941ee4e8b10aeacda923
Reviewed-on: http://gerrit.rockbox.org/127
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Tested-by: Thomas Martitz <kugel@rockbox.org>
2012-03-03 12:05:58 +01:00
Jean-Louis Biasini
f1e1ab8d41 Plugin snow PLA integration (code + manual)
this commit changes:
1) replace all keymaps with PLA ones.
2) do the required change to the manual in order to match
code's changes.
3) add an alternative exit button (PLA_EXIT or PLA_CANCEL)

Change-Id: I8a064b98c118e369f8464de5e43c7641d8a08e9e
Reviewed-on: http://gerrit.rockbox.org/130
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Tested-by: Thomas Martitz <kugel@rockbox.org>
2012-03-03 10:48:22 +01: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
Alexander Levin
5db58fcd0a Manual: Fix the WPS tags table
Change-Id: Idee12d56940a7a547a965bd78c5344448f29e566
Reviewed-on: http://gerrit.rockbox.org/163
Reviewed-by: Alex Parker <rockbox@aeparker.com>
2012-03-02 20:02:40 +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
1c1e1c070c skin_engine: ease the restrictions on %x/%xl
%x and %xl only require the id and filename now.
If you leave off the x,y it will default to 0,0.
If you want to use the default x,y you can still put in the
num_subimages param on the end (e.g %xl(a, file, 3) )

Change-Id: I8eff793dfdd037e302ace8deec9dc16dcea264a7
2012-02-29 00:14:06 +11:00
Jonathan Gordon
2c71aa9feb lcd/skin_engine: Add the ability to draw onto the backdrop layer
The framebuffer the lcd driver uses can now be changed on the fly
which means that regular lcd_* drawing functions can draw onto the
"backdrop" buffer. The skin engine can use this to create layered
effects.

Add the tag %VB to a viewport to draw that viewport onto the
backdrop layer. If you want to draw an image onto the backdrop
framebuffer use %x(backdrop filename) instead of %X() inside
a viewport with %VB.

Change-Id: I741498e2af6d4f2d78932cabe8942317893e7cfc
2012-02-28 23:03:04 +11: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
31a05953e1 FS#12586 - Modify %ss to be able to use numbers for conditionals
i.e %?ss(1,1,%cM)<|one|two|three|...|> or %xd(numbers, %ss(1,1%cM)

Change-Id: I74ecb3f253f3be1fd270f75c0ef79addd364a7de
2012-02-26 00:50:14 +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
Michael Giacomelli
f6e5ec4e32 Update the manual to include Home as a way of quitting the quicksreen on the Clip players. Leave Select in place since we'll add that next.
Change-Id: I2a5632cbad8b88a9f7ec92c790ba6c0e272115f7
2012-02-24 16:56:06 -05:00
Jean-Louis Biasini
7c215b1be8 bounce's plugin PLA integration (main code + manual)
1) this patch replace all keymaps with PLA ones.

2) the patch also do the required change to the manual in order to match
code's changes.

3) it also add an alternative exit button (PLA_EXIT or PLA_CANCEL)

4) Also cut out the remote control related mapping as PLA handle remote controls
his own way so that we don't need them anymore

5) change scrollwheel mapping in order to have it controlling the value of selected field unstead of field selection

Change-Id: I023122d45a8337fad1e8ed8be12d4c928bdd1292
Reviewed-on: http://gerrit.rockbox.org/106
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Tested-by: Thomas Martitz <kugel@rockbox.org>
2012-02-24 13:11:51 +01:00
Jean-Louis Biasini
4da1561a69 Fuze+'s manual: all non-PLA plugins games keymaps
- plugins games keymaps added to the manual
- merge some lines (see chessbox)

Change-Id: Iad97e6d07ae0419f54c26697f157ede3d07bd349
Reviewed-on: http://gerrit.rockbox.org/119
Reviewed-by: Dominik Riebeling <Dominik.Riebeling@gmail.com>
2012-02-23 22:50:47 +01:00
Jean-Louis Biasini
5f2fb4ab90 Fuze+'s manual: change ugly \ButtonPlayPause
Following a discution on irc we agreed on that:

- \ButtonPlayPause becomes \ButtonPlay for consistency
- It appeas in the manual as Play unstead of Play/Pause
- updated manual images accordingly

The patch was tested: manual still compile and display keymaps correctly

Change-Id: I04bd3c2bfee1c6c40ab66df9bf33f09f4ed47661
Reviewed-on: http://gerrit.rockbox.org/118
Reviewed-by: Dominik Riebeling <Dominik.Riebeling@gmail.com>
2012-02-22 23:32:23 +01:00
Jean-Louis Biasini
d8fd988cf2 stats's plugin PLA integration (main code + manual)
1) this patch replace all keymaps with PLA ones. It also clean some optionnal
 compiling that are not needed anymore througt PLA

2) the patch also made required change to the manual in order to match code's
 change.

3) it also add an alternative exit button (PLA_EXIT or  PLA_CANCEL)

TO TEST:
I'm not sure if remote control works anymore and cannot test it. I'm not
sure about the way PLA handle those so if that doesn't work let me know ;)

Change-Id: I3fb81e75ef6e4d49e19be24f09c0413599ed0c9c
Reviewed-on: http://gerrit.rockbox.org/90
Tested-by: Thomas Martitz <kugel@rockbox.org>
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
2012-02-22 09:15:50 +01:00
Jean-Louis Biasini
d5bd4ec682 Fuze+: fractals's plugin keymaps reworks
1) Multitouch does not work on Fuze+. Unstead we can take advantage of
bottomleft and bottomright button.

2) Manual completed accordingly

Change-Id: I9535865773a2d1e21b1a71af63e4d377abcbc752
Reviewed-on: http://gerrit.rockbox.org/115
Reviewed-by: Amaury Pouly <amaury.pouly@gmail.com>
2012-02-21 18:08:08 +01:00
Jean-Louis Biasini
e5b1b0f998 rockblox1d's plugin PLA integration (main code + manual)
1) this patch replace all keymaps with PLA ones. It also clean some optionnal
compiling that are not needed anymore througt PLA.

2) the patch also made required change to the manual in order to match code's
change.

3) it also add an alternative exit button (PLA_EXIT or PLA_CANCEL).

Change-Id: If6e78711eaab1dd2c907b418ba72c8789ceaa72b
Reviewed-on: http://gerrit.rockbox.org/105
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Tested-by: Thomas Martitz <kugel@rockbox.org>
2012-02-18 23:57:22 +01:00
Nils Wallménius
e61f42ae41 Add description of the speaker keyckick setting
also use the same setting names in the manual as the UI when we have a piezo.

Change-Id: I7a629addc9d63cfe14b403eac66f5410f908a948
2012-02-12 00:32:47 +01:00
Rafaël Carré
6162d813e7 Sansa AMS: don't duplicate incorrectly install steps.
Change-Id: Ib9678ca108cc1264d5dc355fabc5ba877da59497
2012-02-11 14:13:26 -05:00
Jean-Louis Biasini
c978665025 Fuze+ PLA_EXIT slight mapping cleanup
1) On all non PLA plugin, power button is used for exit. For consistency,
we set PLA_EXIT to power button.
2) Manual updated accordingly

Change-Id: Ia4b8fce13bad2f8dc0710cdb29ccf6c74b3fd9c4
Reviewed-on: http://gerrit.rockbox.org/91
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Reviewed-by: Amaury Pouly <amaury.pouly@gmail.com>
2012-02-09 16:43:53 +01:00
Jean-Louis Biasini
a869d4a9ac LAMP plugin PLA integration (main code + manual)
1) this patch replace all keymaps with PLA ones. It also clean some optionnal
 compiling that are not needed anymore througt PLA
2) the patch also made required change to the manual in order to match code's
 change.

Change-Id: I54ec953f79a419a6bb2f78877ca8b82f572fb510
Reviewed-on: http://gerrit.rockbox.org/86
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Tested-by: Thomas Martitz <kugel@rockbox.org>
2012-02-08 18:32:53 +01:00
Frank Gevaerts
513c5ad3d0 SVG Image for Philips GoGear SA9200 (FS#12407)
Change-Id: Ia663350e1609ae1843b474fc50dbc189188b0e81
2012-02-07 19:22:15 +01:00
Jonathan Gordon
40ecdf6811 skin engine: New logical 'and' and 'or' tags to evaluate multiple tags in a single conditional.
Use these tags to stop having multiple conditionals.. e.g:
OLD: %?C<%?Ia<something>>
NEW: %?and(%C, %Ia)<something>

Change-Id: Ia3bbe4611cf808e87dcd1b1147181461fa08294a
2012-02-07 21:41:18 +11:00
Marko Pahlke
32326e3bd3 SVG Image for Samsung YP-R0 (FS#12577)
Change-Id: I1433cdff2c7f007d437300b103059f18099faf7d
2012-02-06 18:42:33 +01:00
Frank Gevaerts
a969c4df88 rocklife is much more a demo than a game.
Change-Id: Ibf80637cd9c6001a636a9f92c72223ec56dad780
Reviewed-on: http://gerrit.rockbox.org/82
Reviewed-by: Thomas Martitz <kugel@rockbox.org>
Reviewed-by: Boris Gjenero <boris.gjenero@gmail.com>
Tested-by: Boris Gjenero <boris.gjenero@gmail.com>
2012-02-06 09:29:39 +01:00
Marcin Bukat
ae7d40f89a HD300: manual graphics
Change-Id: Icf224fb225ab3a1869196c0479677c19a3145807
2012-02-02 14:55:51 +01:00
Marcin Bukat
4bbc9f68ea MPIOs: manual work
Change-Id: Ief46eabf3611d6d21594f52f73292f2be5831b87
2012-02-02 14:55:51 +01:00
Michael Giacomelli
cd99b0dbf9 Fix install directions for the Clip Zip.
Change-Id: I66214cd44afda7cba18f94f52d7979bcd9e8edd1
2012-01-14 16:48:58 -05:00
Dominik Riebeling
bb24ac8c27 Manual: don't break on missing player image.
As done with the screenshots display an error notice when the main image is
missing. Same is done for the remote image for targets that do have a remote.

\IfFileExists requires to use the full filename, not the stem as
\includegraphics accepts happily, so 36489d9 actually broke the main image for
all players.
2012-01-14 20:57:19 +01:00
Rafaël Carré
36489d9aa0 manual: don't error out if front image is missing 2012-01-14 14:13:37 -05:00
Michael Giacomelli
92ef9b260a Clarify that you must reboot into the Sandisk firmware when uninstalling the bootloader.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31630 a1c6a512-1295-4272-9138-f99709370657
2012-01-08 07:05:58 +00:00