summaryrefslogtreecommitdiff
path: root/manual/preamble.tex
AgeCommit message (Collapse)Author
2020-12-12manual: Replace all rockbox.org urls with https.Solomon Peachy
In the process, utilize the \download{} and \wikilink{} commands instead of direct URLs. Change-Id: Iad38c15c7b9cec95b6c011fd0dbdbb3326985bbc
2020-11-21manual: hopefully fix html generationSolomon Peachy
(by using the 'scrhack' package) Change-Id: I229b59878016d18ac7714139debc1ad2b0621fed
2020-11-22fix a few manual warningsMoshe Piekarski
Change-Id: I4b9bf1e418367b2a420f56ce36f30cb0926e816f
2020-06-28Partially revert the last commit.Franklin Wei
The \if->\If replacement is a bit premature for texlive-2019, apparently. Change-Id: Iab198c2f5e2f00ecdf7e2431e2b77c423e6afc07
2020-06-28fix a few manual warningsMoshe Piekarski
Change-Id: I6abcceeb84d70e32be203049950c6fe4711e8df8
2011-06-19Manual: Add version information to page footer.Dominik Riebeling
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30014 a1c6a512-1295-4272-9138-f99709370657
2011-04-21Use Latin Modern font family for the manual.Dominik Riebeling
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-11Allow URLs to break at hyphens and allow more space at breaking characters.Dominik Riebeling
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-02-27Manual: switch to inputenx and load additional characters.Dominik Riebeling
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
2010-07-18Fix broken (html) manual: set seriesimg globally in preamble.tex to \specimg ↵Marianne Arnold
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-17Manual: add another possible parameter to screenshot names: 'seriesimg' to ↵Marianne Arnold
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-02Make the first column in the tag tables narrowerAlexander Levin
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27246 a1c6a512-1295-4272-9138-f99709370657
2010-06-28Simplify the 'blind' macro and imrove spacing where it's usedAlexander Levin
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27166 a1c6a512-1295-4272-9138-f99709370657
2010-06-20Adjust the tagmap table environment so that the second column doesn't end up ↵Alex Parker
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-05Change font encoding to T1.Dominik Riebeling
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-05-20Get rid of unnecessary 'table' environment and the never used parameters for ↵Alexander Levin
button maps (FS#11088) git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26201 a1c6a512-1295-4272-9138-f99709370657
2010-05-20Another go at FS#11295 -- Use nice 'times' glyphs for describing dimensions. ↵Alexander Levin
This time properly implemented. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26198 a1c6a512-1295-4272-9138-f99709370657
2010-05-08Add some vertical space before and after notesAlexander Levin
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25897 a1c6a512-1295-4272-9138-f99709370657
2010-03-27Fix the description of the %V WPS tag (last part of FS#11117)Alexander Levin
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@25349 a1c6a512-1295-4272-9138-f99709370657
2010-03-07Remove the caption and label parameters from the tagmap macro. They are ↵Alexander Levin
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
2009-08-29Manual: Fix the vertical spacing in the first and the last rows in tablesAlexander Levin
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22553 a1c6a512-1295-4272-9138-f99709370657
2009-08-29Make table headers look like the original booktabsAlexander Levin
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22550 a1c6a512-1295-4272-9138-f99709370657
2009-08-29Revert r22516 and r22522 - the former breaks html on linux and evrything on ↵Alex Parker
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-28Fix building the html manual broken by the new top, mid, and bottom rules ↵Alex Parker
introduced in r22516 git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22522 a1c6a512-1295-4272-9138-f99709370657
2009-08-26Manual: do filling the table headers with colors in a more official way, so ↵Alexander Levin
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-24Fully fill the table headers with colorAlexander Levin
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22509 a1c6a512-1295-4272-9138-f99709370657
2009-08-24Change the manual tabe colours so that we have a darker blue for the header, ↵Alex Parker
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-24Add the ability to set the header row colour to button tables and wps tag ↵Alex Parker
tables. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22507 a1c6a512-1295-4272-9138-f99709370657
2009-08-24Correct order of odd and even row colours in the rowcolors command, and set ↵Alex Parker
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-24Remove enumerate package as it isn't needed, and breaks texlive.Alex Parker
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22504 a1c6a512-1295-4272-9138-f99709370657
2009-08-24Introduce a new environment 'rbtabular' to make all the tables look the ↵Alexander Levin
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-24Introduce names for header and row color in the tables so that they are the ↵Alexander Levin
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-24Add coloured rows to the other tables in the manual (button maps already done).Alex Parker
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22494 a1c6a512-1295-4272-9138-f99709370657
2009-08-23Add alternate line colouring to button map tables to better distinguish Alex Parker
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-06-29Fix html manuals for targets with remote keymaps. For some reason using an ↵Alex Parker
\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-28Change manual remote keymap define to HAVE_REMOTE_KEYMAP to be more ↵Alex Parker
consistent with other edefs. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21540 a1c6a512-1295-4272-9138-f99709370657
2009-06-20Fix a typoAlexander Levin
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21425 a1c6a512-1295-4272-9138-f99709370657
2009-06-20Much cleaner version of r21411 - add three column button tables capability ↵Alex Parker
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-20The define is remote_keymap - good place for a typo that.Alex Parker
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21412 a1c6a512-1295-4272-9138-f99709370657
2009-06-20Prepare the manual to have two or three column button map tables so that ↵Alex Parker
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
2008-12-02Recent LaTeX comes with utf8 support called "utf8", while "utf8x" is the ↵Dominik Riebeling
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-01Fix FS#9550 and FS#5721: don't use Palatino anymore and use the soul package ↵Dominik Riebeling
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-11-24Removed the DRAFT VERSION text.Björn Stenberg
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19205 a1c6a512-1295-4272-9138-f99709370657
2008-09-23Add a new environment for setting the changelog using a different bullet ↵Dominik Riebeling
icon and smaller vertical space between items. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18596 a1c6a512-1295-4272-9138-f99709370657
2008-03-12give the Key column in the button tables a fixed with to prevent it getting ↵Dominik Riebeling
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-02-13Commit FS#8567, the manual now uses the same 'features' system as the ↵Nils Wallménius
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
2007-12-14Manual: apply FS#8309 by David Bishop (replace all occurences of ↵Marianne Arnold
'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-09-24Remove the full url path from links to the wiki and display the wiki name ↵Dominik Riebeling
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-04-07WPS tags: The player doesn't have peak meters. Fix a glitch in \nopt which ↵Dominik Riebeling
introduced a stray protected space. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@13061 a1c6a512-1295-4272-9138-f99709370657
2007-02-01Make the manual use utf8 as base input encoding. This *requires* the UCS ↵Dominik Riebeling
package which is not part of standard LaTeX distributions. Fixes manual building which got broken by some extended character in the credits file. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12168 a1c6a512-1295-4272-9138-f99709370657