Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
35746 commits 17 branches 142 tags 291 MiB
Commit graph

106 commits

Author SHA1 Message Date
Dominik Riebeling
356133d321 manual: Add workaround for older KOMAscript versions. 
KOMAscript 3.28 changes \ifpdfoutput to \Ifpdfoutput. Add a check and
redefine the new command as the old one if it's missing since only the
name was changed. Not all Linux distros have a recent enough version
yet.

Change-Id: Ie709a1c85f10e1ddebb703ae50d3539f1aeee8bb
 2021-08-20 21:17:50 +02: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
Solomon Peachy
2eb191a3f4 manual: hopefully fix html generation 
(by using the 'scrhack' package)

Change-Id: I229b59878016d18ac7714139debc1ad2b0621fed
 2020-11-21 23:55:45 -05:00
Moshe Piekarski
332433eb3d fix a few manual warnings 
Change-Id: I4b9bf1e418367b2a420f56ce36f30cb0926e816f
 2020-11-22 03:48:28 +00:00
Franklin Wei
ca673d7e9f Partially revert the last commit. 
The \if->\If replacement is a bit premature for texlive-2019, apparently.

Change-Id: Iab198c2f5e2f00ecdf7e2431e2b77c423e6afc07
 2020-06-28 00:08:42 -04:00
Moshe Piekarski
140bf66b90 fix a few manual warnings 
Change-Id: I6abcceeb84d70e32be203049950c6fe4711e8df8
 2020-06-28 03:41:54 +00:00
Dominik Riebeling
edaeb1954e Manual: Add version information to page footer. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30014 a1c6a512-1295-4272-9138-f99709370657
 2011-06-19 09:41:09 +00:00
Dominik Riebeling
8f8f9a5bde Use Latin Modern font family for the manual. 
The Latin Modern family uses T1 coding instead of the OT1 coding used by
Computer Modern. Due to this it isn't necessary to emulate characters like
umlauts which makes them searchable.

As a side effect this also addresses FS#12057.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29756 a1c6a512-1295-4272-9138-f99709370657
 2011-04-21 21:52:27 +00:00
Dominik Riebeling
0ab97b7015 Allow URLs to break at hyphens and allow more space at breaking characters. 
Makes URLs much nicer and avoids them running out of the right margin.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29705 a1c6a512-1295-4272-9138-f99709370657
 2011-04-11 22:09:44 +00:00
Dominik Riebeling
892fd0abf3 Manual: switch to inputenx and load additional characters. 
Since we're now loading a file from inputenx directly change to inputenx in
general to avoid issues between those two packages. Fixes manual builds that
broke because of U+0101 and U+0146 glyphs which aren't defined in the utf8
inputenc package.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29428 a1c6a512-1295-4272-9138-f99709370657
 2011-02-27 16:31:59 +00:00
Marianne Arnold
c2273cf5e2 Fix broken (html) manual: set seriesimg globally in preamble.tex to \specimg if it isn't defined in a target's platform file, otherwise tex tries to check for it and doesn't know which string to take. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27481 a1c6a512-1295-4272-9138-f99709370657
 2010-07-18 14:34:54 +00:00
Marianne Arnold
e39d9af882 Manual: add another possible parameter to screenshot names: 'seriesimg' to be able to use screenshots for manuals of the same series (e.g. all Clips) which need to be different to other targets with the same resolution, keeping the possibility to differentiate between targets (e.g. the Clip+ and the rest). 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27470 a1c6a512-1295-4272-9138-f99709370657
 2010-07-17 16:49:31 +00:00
Alexander Levin
67f25a45a5 Make the first column in the tag tables narrower 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27246 a1c6a512-1295-4272-9138-f99709370657
 2010-07-02 18:54:09 +00:00
Alexander Levin
942e427ef0 Simplify the 'blind' macro and imrove spacing where it's used 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27166 a1c6a512-1295-4272-9138-f99709370657
 2010-06-28 22:39:45 +00:00
Alex Parker
318e99a61e Adjust the tagmap table environment so that the second column doesn't end up tiny. It can be adjusted further if necessary. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26988 a1c6a512-1295-4272-9138-f99709370657
 2010-06-20 12:58:24 +00:00
Dominik Riebeling
48832cd20a Change font encoding to T1. 
Some characters used by the manual can't be represented by the default font
encoding OT1 used by LaTeX. Switching the font encoding to T1 fixes this, and
makes the manuals build again.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26578 a1c6a512-1295-4272-9138-f99709370657
 2010-06-05 13:55:36 +00:00
Alexander Levin
97365803d3 Get rid of unnecessary 'table' environment and the never used parameters for button maps (FS#11088) 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26201 a1c6a512-1295-4272-9138-f99709370657
 2010-05-20 17:38:38 +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
04afc139ef Add some vertical space before and after notes 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25897 a1c6a512-1295-4272-9138-f99709370657
 2010-05-08 11:56:28 +00:00
Alexander Levin
f2589546b3 Fix the description of the %V WPS tag (last part of FS#11117) 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25349 a1c6a512-1295-4272-9138-f99709370657
 2010-03-27 13:14:14 +00:00
Alexander Levin
4c105b6806 Remove the caption and label parameters from the tagmap macro. They are never used. Also don't embed tagmaps into a table environment since we want the tables exactly where they are in the source, i.e. we don't want them to float. This speeds up typesetting and makes vertical spaces nicer. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25065 a1c6a512-1295-4272-9138-f99709370657
 2010-03-07 22:12:16 +00:00
Alexander Levin
b783c06362 Manual: Fix the vertical spacing in the first and the last rows in tables 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22553 a1c6a512-1295-4272-9138-f99709370657
 2009-08-29 22:29:22 +00:00
Alexander Levin
876cce1fbe Make table headers look like the original booktabs 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22550 a1c6a512-1295-4272-9138-f99709370657
 2009-08-29 21:38:49 +00:00
Alex Parker
7550c9db3b Revert r22516 and r22522 - the former breaks html on linux and evrything on cygwin, the latter fixes html but breaks pdf on linux. Revert and find a different way to do this. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22541 a1c6a512-1295-4272-9138-f99709370657
 2009-08-29 18:28:50 +00:00
Alex Parker
bd946c255d Fix building the html manual broken by the new top, mid, and bottom rules introduced in r22516 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22522 a1c6a512-1295-4272-9138-f99709370657
 2009-08-28 20:42:43 +00:00
Alexander Levin
9f64794c70 Manual: do filling the table headers with colors in a more official way, so that the spaces defined in booktabs are retained 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22516 a1c6a512-1295-4272-9138-f99709370657
 2009-08-26 20:58:49 +00:00
Alexander Levin
37eb6c5044 Fully fill the table headers with color 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22509 a1c6a512-1295-4272-9138-f99709370657
 2009-08-24 22:54:09 +00:00
Alex Parker
73bac43d63 Change the manual tabe colours so that we have a darker blue for the header, then white and light blue alternating for the rows. As decided upon after a lengthy IRC discussion :) 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22508 a1c6a512-1295-4272-9138-f99709370657
 2009-08-24 22:50:45 +00:00
Alex Parker
daede5e8bb Add the ability to set the header row colour to button tables and wps tag tables. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22507 a1c6a512-1295-4272-9138-f99709370657
 2009-08-24 22:12:45 +00:00
Alex Parker
17e6288e38 Correct order of odd and even row colours in the rowcolors command, and set colours to alternate white asnd 15% blue with a white header for now. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22506 a1c6a512-1295-4272-9138-f99709370657
 2009-08-24 22:03:30 +00:00
Alex Parker
6ed9cfd522 Remove enumerate package as it isn't needed, and breaks texlive. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22504 a1c6a512-1295-4272-9138-f99709370657
 2009-08-24 21:23:48 +00:00
Alexander Levin
fb87e89473 Introduce a new environment 'rbtabular' to make all the tables look the same. See comments in preable.tex. Next step will be to define btnmap and tagmap via this environment. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22503 a1c6a512-1295-4272-9138-f99709370657
 2009-08-24 21:22:18 +00:00
Alexander Levin
4acf5d35fe Introduce names for header and row color in the tables so that they are the same throughout the manual and can be changed easily 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22501 a1c6a512-1295-4272-9138-f99709370657
 2009-08-24 18:08:00 +00:00
Alex Parker
268a4ae621 Add coloured rows to the other tables in the manual (button maps already done). 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22494 a1c6a512-1295-4272-9138-f99709370657
 2009-08-24 11:16:06 +00:00
Alex Parker
7dfec97c5d Add alternate line colouring to button map tables to better distinguish 
rows.  Also increase the width of three column button tables slightly.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22483 a1c6a512-1295-4272-9138-f99709370657
 2009-08-23 22:23:33 +00:00
Alex Parker
c5d3857715 Fix html manuals for targets with remote keymaps. For some reason using an \opt in preamble.tex with an underscore in the name breaks html manuals (but not pdf). 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21566 a1c6a512-1295-4272-9138-f99709370657
 2009-06-29 18:33:44 +00:00
Alex Parker
8e4098bd66 Change manual remote keymap define to HAVE_REMOTE_KEYMAP to be more consistent with other edefs. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21540 a1c6a512-1295-4272-9138-f99709370657
 2009-06-28 13:02:38 +00:00
Alexander Levin
05e3aad620 Fix a typo 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21425 a1c6a512-1295-4272-9138-f99709370657
 2009-06-20 22:15:49 +00:00
Alex Parker
931ff0b12c Much cleaner version of r21411 - add three column button tables capability to the manual. To use, add remote_keymap to the platform file, then button tables can be used in the form Main Button & Remote Button & Description. If remote_keymap is defined in the platform file but additional buttons are not added to the button tables, then the decription will appear in the remote key column, but the manual should still build. Thanks to bluebrother for pointing out! 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21423 a1c6a512-1295-4272-9138-f99709370657
 2009-06-20 22:00:47 +00:00
Alex Parker
01bcd2c612 The define is remote_keymap - good place for a typo that. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21412 a1c6a512-1295-4272-9138-f99709370657
 2009-06-20 19:20:13 +00:00
Alex Parker
60c0474050 Prepare the manual to have two or three column button map tables so that remote keymaps can be added. 
btnmap is set to be either two or three columns wide depending on whether remote_kaymap is defined in the platform file for the target in question.  If it is, then every button table needs to have three columns of the form Main Unit Key  &  Remote Key  &  Description \\   or the manual will fail to build.  For some reason, it doesn't seem possible to put the \end{btnmap} in a macro, so leave it as it is in the keymaps.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21411 a1c6a512-1295-4272-9138-f99709370657
 2009-06-20 19:17:06 +00:00
Dominik Riebeling
3e166f6101 Recent LaTeX comes with utf8 support called "utf8", while "utf8x" is the older one that has to be installed separately so don't use that anymore. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19307 a1c6a512-1295-4272-9138-f99709370657
 2008-12-02 23:12:39 +00:00
Dominik Riebeling
cee8f0178e Fix FS#9550 and FS#5721: don't use Palatino anymore and use the soul package for html output. 
The Palatino font was responsible for words broken up in the PDF, resulting in small caps parts being not searchable. Using the soul package creates much better HTML output, not putting every small caps character into its own span element anymore.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19294 a1c6a512-1295-4272-9138-f99709370657
 2008-12-01 21:21:42 +00:00
Björn Stenberg
3dcfe9ef71 Removed the DRAFT VERSION text. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19205 a1c6a512-1295-4272-9138-f99709370657
 2008-11-24 20:35:10 +00:00
Dominik Riebeling
a2c6b67005 Add a new environment for setting the changelog using a different bullet icon and smaller vertical space between items. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18596 a1c6a512-1295-4272-9138-f99709370657
 2008-09-23 20:27:39 +00:00
Dominik Riebeling
78017a0b38 give the Key column in the button tables a fixed with to prevent it getting too wide (happened with some long alternative buttons lists). 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@16644 a1c6a512-1295-4272-9138-f99709370657
 2008-03-12 18:12:19 +00:00
Nils Wallménius
22a5c60af3 Commit FS#8567, the manual now uses the same 'features' system as the lang/voice creation does. Building the manual now requires gcc to parse the features list and 'make manual' must now be used instead of just 'make'. Rerun configure in your manual build dirs. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@16304 a1c6a512-1295-4272-9138-f99709370657
 2008-02-13 16:40:57 +00:00
Marianne Arnold
b2f7c61f84 Manual: apply FS#8309 by David Bishop (replace all occurences of 'folder/folders' with 'directory/directories') for consistency. Additionally tried to get rid of some unnecessary ones here and there but phrasing can definitely be improved further. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@15923 a1c6a512-1295-4272-9138-f99709370657
 2007-12-14 02:03:58 +00:00
Dominik Riebeling
7255bdbb6a Remove the full url path from links to the wiki and display the wiki name only instead. Add a note on how to manually access wiki pages. The links itself are still pointing to the wiki. 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@14847 a1c6a512-1295-4272-9138-f99709370657
 2007-09-24 22:39:24 +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