Commit graph

228 commits

Author SHA1 Message Date
Nils Wallménius
2fe7752e3f Update the 'Supported audio formats' table, we now recognize ogg/vorbis files with the extension '.oga' and ape is now usable on the pp based targets
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19289 a1c6a512-1295-4272-9138-f99709370657
2008-12-01 13:50:44 +00:00
Robert Menes
2527ebff3d Minor fix of the word "color" in the color settings; it is now spelled
in British English "colour".


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19163 a1c6a512-1295-4272-9138-f99709370657
2008-11-20 23:06:55 +00:00
Dave Chapman
e5b238b496 Gammar correction
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18907 a1c6a512-1295-4272-9138-f99709370657
2008-10-29 00:18:09 +00:00
Nils Wallménius
8fbbbb77bf Update note for the APE codec mentioning that c2000 files now can be played back realtime on coldfire targets
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18905 a1c6a512-1295-4272-9138-f99709370657
2008-10-28 22:19:02 +00:00
Dominik Riebeling
71c1e2a838 Document %mv wps tag (FS#9482 by Alexander Levin).
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18779 a1c6a512-1295-4272-9138-f99709370657
2008-10-12 10:48:06 +00:00
Nils Wallménius
d89f400c21 Use the generated feature to control inclusion of sections about different battery types, add 'battery type' to config file options
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18255 a1c6a512-1295-4272-9138-f99709370657
2008-08-12 15:39:47 +00:00
Nils Wallménius
b3d62053df Update the config file options table, a bunch of options are still missing (we have way too many\!) and i put in a couple of fixme's, closes FS#9185
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18254 a1c6a512-1295-4272-9138-f99709370657
2008-08-12 15:15:49 +00:00
Nils Wallménius
a721083223 FS#9266 Add a table with supported audio formats to the manual
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18250 a1c6a512-1295-4272-9138-f99709370657
2008-08-11 22:47:17 +00:00
Martin Arver
e78cb65a50 Move the menu structure to the appendix. The menu structure description itself, is still missing though
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18059 a1c6a512-1295-4272-9138-f99709370657
2008-07-15 18:33:43 +00:00
Marc Guay
a5afecb02b Add the volume, bass, and treble ranges for the e200.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18022 a1c6a512-1295-4272-9138-f99709370657
2008-07-12 23:22:32 +00:00
Marc Guay
8df0a92526 One last request->suggest
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18020 a1c6a512-1295-4272-9138-f99709370657
2008-07-12 23:05:38 +00:00
Marc Guay
6e4aab0fe9 Update the Feature Request section of the manual's appendix to reflect the new policy.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18018 a1c6a512-1295-4272-9138-f99709370657
2008-07-12 22:46:53 +00:00
Dominik Riebeling
1e9ea256cc Document line selector color config file settings (FS#8880 by Justin Hannigan).
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@17124 a1c6a512-1295-4272-9138-f99709370657
2008-04-15 18:53:06 +00:00
Dave Chapman
bf8e9994c0 Fix typo in the description of the %Sp tag
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@17064 a1c6a512-1295-4272-9138-f99709370657
2008-04-10 21:42:50 +00:00
Dominik Riebeling
8f44dd2b72 Make the image tags examples nicer.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@16869 a1c6a512-1295-4272-9138-f99709370657
2008-03-28 21:49:41 +00:00
Dominik Riebeling
a3674c6bc0 Fix wps image tags description.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@16839 a1c6a512-1295-4272-9138-f99709370657
2008-03-27 07:35:53 +00:00
Dominik Riebeling
2ce440d740 Document image strips wps tags (FS#8793 by Alexander Levin)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@16826 a1c6a512-1295-4272-9138-f99709370657
2008-03-26 19:35:39 +00:00
Nils Wallménius
12eb058bb0 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
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@16765 a1c6a512-1295-4272-9138-f99709370657
2008-03-23 22:07:09 +00:00
Thom Johansen
c479b9975d 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.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@16302 a1c6a512-1295-4272-9138-f99709370657
2008-02-13 13:32:44 +00:00
Nicolas Pennequin
ddf33db8c4 Update the manual for r12321: the progressbar's y position is customisable.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@15063 a1c6a512-1295-4272-9138-f99709370657
2007-10-10 05:51:52 +00:00
Marianne Arnold
6f3566405e Just noticed that the file format table still did not mention '.gigabeat' in the Gigabeat manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@14938 a1c6a512-1295-4272-9138-f99709370657
2007-10-01 08:46:03 +00:00
Marianne Arnold
a5fcfd1e7f Manuals - be more accurate with the firmware file extension (Sansas and H10s).
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@14930 a1c6a512-1295-4272-9138-f99709370657
2007-09-30 21:48:20 +00:00
Nicolas Pennequin
29407cbe80 Implement feature request FS#7476: Add a "song progress percentage" WPS tag (%px) that can be used in a conditional to create custom progress meters.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13987 a1c6a512-1295-4272-9138-f99709370657
2007-07-25 14:14:47 +00:00
Dave Chapman
188b6013b0 Update the description of the %fc audio codec enumeration
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13563 a1c6a512-1295-4272-9138-f99709370657
2007-06-05 18:49:00 +00:00
Marianne Arnold
a352c62ad0 Dealing with the description of flash based vs. hard disk based players in the manual. (1) If possible make the phrasing more general. (2) Introducing a 'disk' macro in the platform files for further use. Any workarounds for this problem should be replaced one by one.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13419 a1c6a512-1295-4272-9138-f99709370657
2007-05-19 19:03:39 +00:00
Nicolas Pennequin
c97f0c60fd Remove the crossfeed WPS tag from the manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13141 a1c6a512-1295-4272-9138-f99709370657
2007-04-13 12:05:21 +00:00
Dominik Riebeling
f177af4271 Document the RTC wps tags. FS#6986 by Philippe Latulippe.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13098 a1c6a512-1295-4272-9138-f99709370657
2007-04-10 17:38:40 +00:00
Dominik Riebeling
eef96946e1 WPS tags: The player doesn't have peak meters. Fix a glitch in \nopt which introduced a stray protected space.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13061 a1c6a512-1295-4272-9138-f99709370657
2007-04-07 22:48:11 +00:00
Nicolas Pennequin
15e2aecd8f Oops, forgot to add the picture.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13018 a1c6a512-1295-4272-9138-f99709370657
2007-04-04 14:00:44 +00:00
Nicolas Pennequin
e7f72802fa * Add a few things about cuesheet support (setting description, file format and config file option).
* Enable the pause on headphone unplug setting description for the gigabeat.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13017 a1c6a512-1295-4272-9138-f99709370657
2007-04-04 13:01:55 +00:00
Martin Arver
068482719d Update the description of the different builds that rockbox offers, to reflect the recent changes in the side menu.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12148 a1c6a512-1295-4272-9138-f99709370657
2007-01-29 18:47:53 +00:00
Martin Arver
f5fbde03ab Remove disk poweroff
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12105 a1c6a512-1295-4272-9138-f99709370657
2007-01-24 19:28:35 +00:00
Tom Ross
561620331b Add some missing things to the X5 manual. Also updated the VU Meter screens.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12078 a1c6a512-1295-4272-9138-f99709370657
2007-01-20 00:43:50 +00:00
Dominik Riebeling
a25fa2c6a6 More sansa button and screenshot additions by Tom Ross (FS#6535)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12005 a1c6a512-1295-4272-9138-f99709370657
2007-01-14 09:55:19 +00:00
Linus Nielsen Feltzing
e2022a26d0 Removed executable flag
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11967 a1c6a512-1295-4272-9138-f99709370657
2007-01-09 23:29:07 +00:00
Martin Arver
e9163b4fb4 Add the GPL to the manual. Some changes to the license section and also to the GFDL to better fit in our manual (in style, not content)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11688 a1c6a512-1295-4272-9138-f99709370657
2006-12-07 20:47:39 +00:00
Nils Wallménius
5db84acfb4 Changed \nopt to \opt to make ondiosp manual build again
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11620 a1c6a512-1295-4272-9138-f99709370657
2006-11-28 17:01:46 +00:00
Nils Wallménius
6675b64f46 Updated wps tags in manual: 1) volume and battery level now use the unlimited enumerations. 2) codec list has changed (also added sid and adx) 3) Broke long lines, use correct opts, etc.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11574 a1c6a512-1295-4272-9138-f99709370657
2006-11-22 17:07:17 +00:00
Nils Wallménius
da55588fc7 Add a description of the bacdrop functionality and include description of relevant options for greyscale targets too
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11522 a1c6a512-1295-4272-9138-f99709370657
2006-11-13 15:14:28 +00:00
Martin Arver
f8e2f3e08d Fix for more consistent and proper British English. (-ize/-ise etc)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11246 a1c6a512-1295-4272-9138-f99709370657
2006-10-17 12:18:51 +00:00
Dominik Riebeling
28546a6530 Oops.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10989 a1c6a512-1295-4272-9138-f99709370657
2006-09-18 06:53:33 +00:00
Dominik Riebeling
9723cb7fb1 Rework the config file options table: allow the fields to break automatically, reformat the source for better readability and adjust table width. Finally include the table in the HTML output.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10982 a1c6a512-1295-4272-9138-f99709370657
2006-09-17 20:47:10 +00:00
Martin Arver
fc2f31d2ea Remove the lcd screen size reference table, as it makes no sense in a target specific manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10785 a1c6a512-1295-4272-9138-f99709370657
2006-08-28 16:58:26 +00:00
Dominik Riebeling
ad19af7a75 kill additional spaces (opt again)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10778 a1c6a512-1295-4272-9138-f99709370657
2006-08-28 06:10:50 +00:00
Martin Arver
7bdd03a118 Part one of a cleanup of the ondio manuals as reported by Marianne Arnold. * Some code clean-up/policy in general. * Get rid of remains from the 2.4 manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10770 a1c6a512-1295-4272-9138-f99709370657
2006-08-27 15:00:50 +00:00
Dominik Riebeling
28388b131a Repeat the table heading on all pages. Minor units tweaks.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10742 a1c6a512-1295-4272-9138-f99709370657
2006-08-25 09:32:10 +00:00
Nils Wallménius
7d6add543c changed the NODO to include relevant entries in the right manuals.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10656 a1c6a512-1295-4272-9138-f99709370657
2006-08-19 12:23:47 +00:00
Nils Wallménius
bfe81e858c Update config file reference table. added missing settings, removed deprecated settings, corrected errors.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10655 a1c6a512-1295-4272-9138-f99709370657
2006-08-19 11:50:59 +00:00
Dominik Riebeling
536c6b47ad "Getting started" rework: add informations about support channels. Move out installation instructions to its own chapter (and file). Move the "Differences between binaries" to installation section. Update iriver installation and add description of bootloader usb mode.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10566 a1c6a512-1295-4272-9138-f99709370657
2006-08-14 07:13:01 +00:00
Dominik Riebeling
da1e28c17f Make the wps tagmaps floats (for better displaying in the html manual). Add the new added wps tags.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10441 a1c6a512-1295-4272-9138-f99709370657
2006-08-03 18:32:41 +00:00
Dominik Riebeling
251e519985 Move file formats table to its own file and add table environment (for html manual)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10412 a1c6a512-1295-4272-9138-f99709370657
2006-08-02 17:21:38 +00:00
Martin Arver
26c6e7bff9 rename the rockref macro to reference
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10392 a1c6a512-1295-4272-9138-f99709370657
2006-08-01 11:57:38 +00:00
Martin Arver
7a47313a21 Introduce new reference command; \rockref. Use this to get references right in both the pdf and the html manuals
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10375 a1c6a512-1295-4272-9138-f99709370657
2006-07-31 12:21:57 +00:00
Dominik Riebeling
53ca97cbcc Remove "config file options" from the HTML manual for now as it breaks building. Needs to be fixed later.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10266 a1c6a512-1295-4272-9138-f99709370657
2006-07-20 18:12:17 +00:00
Dominik Riebeling
7ab1d9bbac use the correct values for volume in config file description.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10242 a1c6a512-1295-4272-9138-f99709370657
2006-07-18 20:53:19 +00:00
Martin Arver
31c7a453e1 Use fname macro on the file extensions
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10174 a1c6a512-1295-4272-9138-f99709370657
2006-07-02 08:59:00 +00:00
Dominik Riebeling
e092410dbd update the File Formats table a bit and opt some target specific entries.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10169 a1c6a512-1295-4272-9138-f99709370657
2006-07-01 11:52:57 +00:00
Dominik Riebeling
b074b221ec Include the credits file. This adds a build dependency to iconv for now, but we should consider converting the manual to utf8 completely. Also sorted the screen sizes table.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10058 a1c6a512-1295-4272-9138-f99709370657
2006-06-05 10:08:54 +00:00
Michael DiFebbo
5f11009d1c Add icon per bug fix 5460, comment 1, #7. (Prior commit message should also have referred to 5460, not 5480.)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10046 a1c6a512-1295-4272-9138-f99709370657
2006-06-04 12:49:49 +00:00
Michael DiFebbo
249fa059b1 Various corrections to the manual as noted in bug report 5460, comment #1.) Patches by Jonas.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10044 a1c6a512-1295-4272-9138-f99709370657
2006-06-04 12:46:13 +00:00
Martin Arver
bd0db08e37 Oops. Shouldn't have commited this.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9897 a1c6a512-1295-4272-9138-f99709370657
2006-05-09 22:09:51 +00:00
Martin Arver
2c9a8ed457 Fixes and corrections. Adds keymaps for ipods for the wps key table, virtual keyboard, sudoku (x5 as well). (Patches #5320, #5308, #5324. All from Mark Bright)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9896 a1c6a512-1295-4272-9138-f99709370657
2006-05-09 21:49:32 +00:00
Martin Arver
f21f914872 New macro: \config. Use this for tags, config file settings or in other places where a courier font is wanted. Adopted the wps-tag section to use this macro
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9891 a1c6a512-1295-4272-9138-f99709370657
2006-05-08 21:32:44 +00:00
Dominik Riebeling
f033902f39 Add missing file types to tag description and make the long example line break
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9890 a1c6a512-1295-4272-9138-f99709370657
2006-05-08 19:38:20 +00:00
Martin Arver
7ab7c5673e Fix the icons to not be target specific (by making them b/w)
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9818 a1c6a512-1295-4272-9138-f99709370657
2006-04-27 13:34:26 +00:00
Dominik Riebeling
9eaa568f7f Add recently added pitch tag.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9593 a1c6a512-1295-4272-9138-f99709370657
2006-04-10 17:35:49 +00:00
Dominik Riebeling
36a3133f32 Cleanup WPS tags appendix a bit and add macro for wps tag tables.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9587 a1c6a512-1295-4272-9138-f99709370657
2006-04-09 21:22:42 +00:00
Dominik Riebeling
8258c5fb90 Fixed tracker url.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9576 a1c6a512-1295-4272-9138-f99709370657
2006-04-09 12:25:45 +00:00
Dominik Riebeling
3fbbce3245 add ipod mini 2g LCD size (from FS#4981). Code policing by me. Use tabularx for LCD table
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9405 a1c6a512-1295-4272-9138-f99709370657
2006-04-01 17:17:15 +00:00
Dominik Riebeling
18f319caf5 make use of the \note macro on plugins and appendix
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9404 a1c6a512-1295-4272-9138-f99709370657
2006-04-01 17:00:04 +00:00
Martin Arver
ec60a05d1d Patch #4944 from Dominik Riebeling. Introduce the tabularx package for better looking tables, and replaces the use of tabular with tabularx in the appendix section.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9348 a1c6a512-1295-4272-9138-f99709370657
2006-03-29 18:40:42 +00:00
Martin Arver
6784e0333f Follow in Linus' footsteps and rename the bx-tags section to Power related
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9305 a1c6a512-1295-4272-9138-f99709370657
2006-03-28 11:04:38 +00:00
Martin Arver
df6e42445b Adds sleeptimer tag description for the wps reference section
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9304 a1c6a512-1295-4272-9138-f99709370657
2006-03-28 10:37:03 +00:00
Martin Arver
55e67fc1dc Move config file options to the appendix. These options should be grouped in sections with regards to the type of option (recording, sound etc) they represent
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9208 a1c6a512-1295-4272-9138-f99709370657
2006-03-23 15:23:53 +00:00
Martin Arver
94c1289da7 Move WPS tag definitions to the appendix
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9206 a1c6a512-1295-4272-9138-f99709370657
2006-03-23 14:11:52 +00:00
Martin Arver
7ec830d65b Fixes to chapter Configure Rockbox. Fixes some references. Makes some section target specific.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9048 a1c6a512-1295-4272-9138-f99709370657
2006-03-15 18:16:10 +00:00
Martin Arver
784e0e13c9 Adds the appendix to the manual. Adds the FDL as a .tex document. Include some icon images from the 2.4 docs.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9026 a1c6a512-1295-4272-9138-f99709370657
2006-03-13 13:29:27 +00:00
Christi Scarborough
d68d7c0ecf Rockbox manual in LaTeX initial commit. New option 'manual' added to configure. Some platforms (eg recorderv2, fmrecorder) produce the same manual target, so either can be selected from the configure script.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@8596 a1c6a512-1295-4272-9138-f99709370657
2006-02-06 07:25:25 +00:00