summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorAlexander Levin <al.le@rockbox.org>2009-08-24 21:22:18 +0000
committerAlexander Levin <al.le@rockbox.org>2009-08-24 21:22:18 +0000
commitfb87e8947340e183e0c9c55345f0f2917d03ef1c (patch)
treeee59e1119e6eb0b7fb2e7450ea7e567d1c40b138 /manual
parent873d266199f02cf619ff0c56f645cb674ed996cf (diff)
downloadrockbox-fb87e8947340e183e0c9c55345f0f2917d03ef1c.tar.gz
rockbox-fb87e8947340e183e0c9c55345f0f2917d03ef1c.tar.bz2
rockbox-fb87e8947340e183e0c9c55345f0f2917d03ef1c.zip
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
Diffstat (limited to 'manual')
-rw-r--r--manual/appendix/config_file_options.tex2
-rw-r--r--manual/appendix/file_formats.tex22
-rw-r--r--manual/configure_rockbox/file_view.tex12
-rw-r--r--manual/configure_rockbox/recording_settings.tex10
-rw-r--r--manual/configure_rockbox/sound_settings.tex20
-rw-r--r--manual/getting_started/archos_choice.tex12
-rw-r--r--manual/plugins/brickmania.tex11
-rw-r--r--manual/plugins/goban.tex10
-rw-r--r--manual/plugins/pacbox.tex10
-rw-r--r--manual/plugins/wormlet.tex8
-rw-r--r--manual/preamble.tex44
-rw-r--r--manual/rockbox_interface/tagcache.tex12
12 files changed, 84 insertions, 89 deletions
diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex
index d7ee75c1e8..d0fa073635 100644
--- a/manual/appendix/config_file_options.tex
+++ b/manual/appendix/config_file_options.tex
@@ -6,7 +6,7 @@
% for the html output.
\ifpdfoutput{\newcommand{\localendhead}{\endhead}}%
{\newcommand{\localendhead}{}}
- \rowcolors{1}{}{tblrowbgcolor}
+ \rowcolors{1}{tblevenrowbgcolor}{tbloddrowbgcolor}
\begin{longtable}{@{}>{\raggedright}p{.35\textwidth}@{}>{\raggedright}p{.4\textwidth}@{}p{.25\textwidth}@{}}
\toprule
\rowcolor{white} \textbf{Setting} & \textbf{Allowed Values} & \textbf{Unit}\\
diff --git a/manual/appendix/file_formats.tex b/manual/appendix/file_formats.tex
index e0f5161883..cbf1ab2c07 100644
--- a/manual/appendix/file_formats.tex
+++ b/manual/appendix/file_formats.tex
@@ -2,11 +2,9 @@
\chapter{File formats}
\section{\label{ref:Supportedfileformats}Supported file formats}
\begin{table}
-\begin{center}
-\rowcolors{1}{}{tblrowbgcolor}
-\begin{tabularx}{\textwidth}{clp{7em}X}\toprule
-\textbf{Icon} & \textbf{File Type} & \textbf{Extension}
- & \textbf{Action when selected} \\\midrule%
+\begin{rbtabular}{\textwidth}{clp{7em}X}%
+{\textbf{Icon} & \textbf{File Type} & \textbf{Extension}
+ & \textbf{Action when selected}}{}{}
\includegraphics[width=0.37cm]{appendix/images/icon-directory.png}
& Directory & \emph{none} & Enter the directory \\
\includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png}
@@ -74,18 +72,14 @@
& Game of Life & \fname{.cells} & Show the configuration with the
``Rocklife'' plugin\\}
-\bottomrule
-\end{tabularx}
-\end{center}
+\end{rbtabular}
\end{table}
\opt{swcodec}{
\section{\label{ref:Supportedaudioformats}Supported audio formats}
\begin{table}
- \begin{center}
- \rowcolors{1}{}{tblrowbgcolor}
- \begin{tabularx}{\textwidth}{lp{6em}X}\toprule
- \textbf{Format} & \textbf{Extension} & \textbf{Notes} \\\midrule
+ \begin{rbtabular}{\textwidth}{lp{6em}X}%
+ {\textbf{Format} & \textbf{Extension} & \textbf{Notes}}{}{}
\multicolumn{2}{c}{\textbf{Lossy codecs}}\\
\midrule
MPEG audio & \fname{.mp1, .mpa, .mp2, .mp3} & \\
@@ -127,8 +121,6 @@
NES Sound Format & \fname{.nsf, .nsfe} & \\
SPC700 & \fname{.spc} & \\
Atari SAP & \fname{.sap} & \\
- \bottomrule
- \end{tabularx}
- \end{center}
+ \end{rbtabular}
\end{table}
}
diff --git a/manual/configure_rockbox/file_view.tex b/manual/configure_rockbox/file_view.tex
index 3bf7c07faf..21dbe4042f 100644
--- a/manual/configure_rockbox/file_view.tex
+++ b/manual/configure_rockbox/file_view.tex
@@ -29,12 +29,8 @@ displays files.
\newline\setting{As digits} disables this algorithm, and causes every digit to
be compared separately. The following table demonstrates the two sortings.
\begin{table}
- \begin{center}
- \rowcolors{1}{}{tblrowbgcolor}
- \begin{tabularx}{.8\textwidth}{XX}
- \toprule
- \textbf{As whole numbers} & \textbf{As digits}\\
- \midrule
+ \begin{rbtabular}{.8\textwidth}{XX}%
+ {\textbf{As whole numbers} & \textbf{As digits}}{}{}
03 Jackson.mp3 & 03 Jackson.mp3\\
1 Ring Of Fire.mp3 & 1 Ring Of Fire.mp3\\
2 I Walk The Line.mp3 & 10 A Thing Called Love.mp3\\
@@ -42,9 +38,7 @@ displays files.
Episode 1.ogg & Episode 1.ogg\\
Episode 57.ogg & Episode 233.ogg\\
Episode 233.ogg & Episode 57.ogg\\
- \bottomrule
- \end{tabularx}
- \end{center}
+ \end{rbtabular}
\end{table}
diff --git a/manual/configure_rockbox/recording_settings.tex b/manual/configure_rockbox/recording_settings.tex
index f7b17d524f..27db3e86ce 100644
--- a/manual/configure_rockbox/recording_settings.tex
+++ b/manual/configure_rockbox/recording_settings.tex
@@ -19,15 +19,13 @@
and the average bitrate changes as follows.
\begin{table}[h!]
- \begin{center}
- \begin{tabularx}{0.75\textwidth}{lX}\toprule
- \emph{Frequency} & \emph{Bitrate} (Kbit/s) -- quality 0$\rightarrow$7 \\\midrule
+ \begin{rbtabular}{0.75\textwidth}{lX}%
+ {\emph{Frequency} & \emph{Bitrate} (Kbit/s) -- quality 0$\rightarrow$7}{}{}
44100Hz stereo & 75, 80, 90, 100, 120, 140, 160, 170 \\
22050Hz stereo & 39, 41, 45, 50, 60, 80, 110, 130 \\
44100Hz mono & 65, 68, 73, 80, 90, 105, 125, 140 \\
- 22050Hz mono & 35, 38, 40, 45, 50, 60, 75, 90 \\\bottomrule
- \end{tabularx}
- \end{center}
+ 22050Hz mono & 35, 38, 40, 45, 50, 60, 75, 90 \\
+ \end{rbtabular}
\end{table}
}
diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex
index c3ce1f4dcb..e8e4f8aeee 100644
--- a/manual/configure_rockbox/sound_settings.tex
+++ b/manual/configure_rockbox/sound_settings.tex
@@ -80,10 +80,8 @@ change to customise your listening experience.
Available options are:
%
\begin{table}
- \begin{center}
- \rowcolors{1}{}{tblrowbgcolor}
- \begin{tabularx}{\textwidth}{lX}\toprule
- \textbf{Setting} & \textbf{Description} \\\midrule
+ \begin{rbtabular}{\textwidth}{lX}%
+ {\textbf{Setting} & \textbf{Description}}{}{}
Stereo
& Leave the audio signal unmodified. \\
%
@@ -107,9 +105,7 @@ change to customise your listening experience.
to make the singer sound centrally placed, this often (but not
always) has the effect of removing the voice track from a song. This
setting also very often has other undesirable effects on the sound. \\
- \bottomrule
- \end{tabularx}
- \end{center}
+ \end{rbtabular}
\end{table}
\section{Stereo Width}
@@ -198,16 +194,12 @@ change to customise your listening experience.
Rockbox uses are:
%
\begin{table}[h!]
- \begin{center}
- \rowcolors{1}{}{tblrowbgcolor}
- \begin{tabular}{@{}lc@{}}\toprule
- Setting & Value \\\midrule
+ \begin{rbtabular}{0.5\textwidth}{Xc}{Setting & Value}{}{}
MDB Strength & 50dB \\
MDB Harmonics & 48\% \\
MDB Centre Frequency & 60Hz \\
- MDB Shape & 90Hz \\\bottomrule
- \end{tabular}
- \end{center}
+ MDB Shape & 90Hz \\
+ \end{rbtabular}
\end{table}
\end{description}
diff --git a/manual/getting_started/archos_choice.tex b/manual/getting_started/archos_choice.tex
index d05532bf45..96b773d776 100644
--- a/manual/getting_started/archos_choice.tex
+++ b/manual/getting_started/archos_choice.tex
@@ -8,10 +8,9 @@ identify which version of the software you need.
The model name is printed on the case. The hard drive size is listed on the
serial number sticker on the back of the unit.
-\begin{center}
- \begin{tabularx}{\textwidth}{llXl}\toprule
- \label{ref:Jukeboxtypetable}
- \textbf{Picture} & \textbf{Disk size} & \textbf{Model Name} & \textbf{Version Name} \\\midrule
+\begin{rbtabular}{\textwidth}{llXl}%
+ {\textbf{Picture} & \textbf{Disk size} & \textbf{Model Name} & \textbf{Version Name}}%
+ {}{ref:Jukeboxtypetable}
\begin{minipage}{2.2cm}
\includegraphics[width=2cm]{getting_started/images/archos-studio-small.png}
\end{minipage}
@@ -48,8 +47,7 @@ serial number sticker on the back of the unit.
\begin{minipage}{2.2cm}
\includegraphics[width=2cm]{getting_started/images/archos-ondiofm-small.png}
\end{minipage}
- & 128MB (flash) & Ondio 128 FM & ondiofm \\\bottomrule
- \end{tabularx}
-\end{center}
+ & 128MB (flash) & Ondio 128 FM & ondiofm \\
+\end{rbtabular}
\note{Rockbox does not run on the Archos Jukebox Multimedia or any
Archos products other than those mentioned here.}
diff --git a/manual/plugins/brickmania.tex b/manual/plugins/brickmania.tex
index 536c4a1007..ecfd38183b 100644
--- a/manual/plugins/brickmania.tex
+++ b/manual/plugins/brickmania.tex
@@ -8,19 +8,16 @@ effect, you must catch it with the paddle. Look out for the bad ones.\\
\subsubsection{Special items}
\begin{table}
- \begin{center}
- \rowcolors{1}{}{tblrowbgcolor}
- \begin{tabularx}{.75\textwidth}{clX}\toprule
- \textbf{Displayed} & \textbf{Name} & \textbf{Description}\\\midrule
+ \begin{rbtabular}{.75\textwidth}{clX}%
+ {\textbf{Displayed} & \textbf{Name} & \textbf{Description}}{}{}
N & Normal & Returns paddle to normal.\\
D & Die & Ball dies; lose a life.\\
L & Life & Gain a life.\\
F & Fire & Allows you to shoot bricks with paddle.\\
G & Glue & Ball sticks to paddle each time it hits.\\
B & Ball & Immediately fires another ball.\\
- FL & Flip & Flip left / right movement.\\\bottomrule
- \end{tabularx}
- \end{center}
+ FL & Flip & Flip left / right movement.\\
+ \end{rbtabular}
\end{table}
\begin{table}
diff --git a/manual/plugins/goban.tex b/manual/plugins/goban.tex
index fe343b02c3..815eec559f 100644
--- a/manual/plugins/goban.tex
+++ b/manual/plugins/goban.tex
@@ -34,10 +34,8 @@ The information panel which displays the current move number may also contain
these markers: \\
\begin{table}
- \begin{center}
- \rowcolors{1}{}{tblrowbgcolor}
- \begin{tabularx}{\textwidth}{lX}\toprule
- \textbf{Mark} & \textbf{Meaning} \\ \midrule
+ \begin{rbtabular}{\textwidth}{lX}%
+ {\textbf{Mark} & \textbf{Meaning}}{}{}
\emph{+ } & There are nodes after the current node in the SGF tree. \\
\emph{* } & There are sibling variations which can be navigated to using the %
\emph{Next Variation} menu option of the \emph{Context Menu}%
@@ -53,9 +51,7 @@ these markers: \\
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec} button}. \\
\emph{C } & There is a comment at the current node. It can be viewed/edited using
the \emph{Add/Edit Comment} menu option of the \emph{Context Menu}. \\
- \bottomrule
- \end{tabularx}
- \end{center}
+ \end{rbtabular}
\end{table}
\subsubsection{Controls}
diff --git a/manual/plugins/pacbox.tex b/manual/plugins/pacbox.tex
index 96979b801d..8c40ef9d14 100644
--- a/manual/plugins/pacbox.tex
+++ b/manual/plugins/pacbox.tex
@@ -10,18 +10,14 @@ Pacbox is an emulator of the Pacman arcade machine hardware. It is a port of
To use the emulator to play Pacman, you need a copy of ROMs for
``Midway Pacman''.
\begin{table}
-\begin{center}
- \rowcolors{1}{}{tblrowbgcolor}
- \begin{tabular}{ll}\toprule
- \textbf{Filename} & \textbf{MD5 checksum}\\\midrule
+ \begin{rbtabular}{0.8\textwidth}{lX}{\textbf{Filename} & \textbf{MD5 checksum}}{}{}
pacman.5e & 2791455babaf26e0b396c78d2b45f8f6\\
pacman.5f & 9240f35d1d2beee0ff17195653b5e405\\
pacman.6e & 290aa5eae9e2f63587b5dd5a7da932da\\
pacman.6f & 19a886fcd8b5e88b0ed1b97f9d8659c0\\
pacman.6h & d7cce8bffd9563b133ec17ebbb6373d4\\
- pacman.6j & 33c0e197be4c787142af6c3be0d8f6b0\\\bottomrule
- \end{tabular}
-\end{center}
+ pacman.6j & 33c0e197be4c787142af6c3be0d8f6b0\\
+ \end{rbtabular}
\end{table}
These need to be stored in the \fname{/.rockbox/pacman/} directory on your
diff --git a/manual/plugins/wormlet.tex b/manual/plugins/wormlet.tex
index f8596090fa..53b3f1ffbb 100644
--- a/manual/plugins/wormlet.tex
+++ b/manual/plugins/wormlet.tex
@@ -39,9 +39,9 @@ Game controls:}
\opt{RECORDER_PAD}{
\renewcommand{\arraystretch}{1.8}
-\begin{tabularx}{\textwidth}{c X p{3cm} p{3cm} p{3cm}}\toprule
-\textbf{Players} & \textbf{Modes} & \textbf{Player 1} & \textbf{Player 2}
- & \textbf{Player 3}\\\midrule
+\begin{rbtabular}{\textwidth}{c X p{3cm} p{3cm} p{3cm}}%
+{\textbf{Players} & \textbf{Modes} & \textbf{Player 1} & \textbf{Player 2}
+ & \textbf{Player 3}}{}{}
%
0 & Out of control & \multicolumn{3}{p{9cm}}{With no player taking part in the
game all worms are out of control and steered by artificial stupidity.}\\
@@ -65,7 +65,7 @@ Game controls:}
& on remote control VOL DOWN: turn left VOL UP: turn
right & on \dap\ \ButtonFTwo: turn left \ButtonFThree:
turn right \\
-\end{tabularx}
+\end{rbtabular}
\renewcommand{\arraystretch}{1.0}
}
diff --git a/manual/preamble.tex b/manual/preamble.tex
index 8bbce066bd..4e2ec7ec79 100644
--- a/manual/preamble.tex
+++ b/manual/preamble.tex
@@ -62,7 +62,8 @@
% Colors used to typeset table headers and alternating table rows
\colorlet{tblhdrbgcolor}{gray!60} % Background color for headers
-\colorlet{tblrowbgcolor}{gray!30} % Background color for rows
+\colorlet{tbloddrowbgcolor}{white} % Background color for odd rows (headers not included)
+\colorlet{tblevenrowbgcolor}{gray!30} % Background color for even rows (headers not included)
\usepackage{fancyhdr}
\usepackage{graphicx}
@@ -201,6 +202,43 @@
\setcounter{totalnumber}{5} % default: 3
+% Environment for typesetting tables in a consistent way. The header has
+% a darker background; rows are white and light gray (alternating). Top,
+% middle and bottom rules are automatically set.
+%
+% Params:
+% #1 -- table width
+% #2 -- column specification (as used in the package tabularx)
+% #3 -- contents of the header row. The number of items must
+% match the number of specs in #2
+% #4 -- caption (optional). If used then this must be inside a floating
+% environment, e.g. table
+% #5 -- label (optional)
+%
+% Example:
+% \begin{rbtabular}{0.9\textwidth}{lX}{Col1 & Col2}{}{}
+% A1 & A2\\
+% B1 & B2\\
+% C1 & C2\\
+% \end{rbtabular}
+%
+\newenvironment{rbtabular}[5]{%
+ \rowcolors{2}{tblevenrowbgcolor}{tbloddrowbgcolor}
+ \expandafter\let\expandafter\SavedEndTab\csname endtabular*\endcsname
+ \expandafter\renewcommand\expandafter*\csname endtabular*\endcsname{%
+ \bottomrule
+ \SavedEndTab%
+ \if\given{#4}\caption{#4}\fi%
+ \if\given{#5}\label{#5}\fi%
+ \endcenter%
+ }
+ \center
+ \tabularx{#1}{#2}\toprule\rowcolor{tblhdrbgcolor}
+ #3\\\midrule
+}{%
+ \endtabularx
+}
+
@@ -214,7 +252,7 @@
% Note: you still need to enclose this with \begin{table} / \end{table}
% Cheers for the usenet helping me building this up :)
\newenvironment{tagmap}[2]{%
-\rowcolors{1}{}{tblrowbgcolor}
+\rowcolors{1}{tblevenrowbgcolor}{tbloddrowbgcolor}
\expandafter\let\expandafter\SavedEndTab\csname endtabular*\endcsname
\expandafter\renewcommand\expandafter*\csname endtabular*\endcsname{%
\bottomrule
@@ -324,7 +362,7 @@
% Main Unit Key & Remote Key & Description \\
\newenvironment{btnmap}[2]{%
- \rowcolors{1}{}{tblrowbgcolor}
+ \rowcolors{1}{tblevenrowbgcolor}{tbloddrowbgcolor}
\expandafter\let\expandafter\SavedEndTab\csname endtabular*\endcsname
\expandafter\renewcommand\expandafter*\csname endtabular*\endcsname{%
\bottomrule
diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex
index 09a7199499..2856c22b3c 100644
--- a/manual/rockbox_interface/tagcache.tex
+++ b/manual/rockbox_interface/tagcache.tex
@@ -113,12 +113,8 @@ to use it just do not do the initial build of the database and do not load it
to RAM.}%
\begin{table}
-\begin{center}
-\rowcolors{1}{}{tblrowbgcolor}
- \begin{tabularx}{.75\textwidth}{XXX}%
- \toprule%
- \textbf{Tag} & \textbf{Type} & \textbf{Origin} \\
- \midrule
+ \begin{rbtabular}{.75\textwidth}{XXX}%
+ {\textbf{Tag} & \textbf{Type} & \textbf{Origin}}{}{}
filename & string & system \\
album & string & id tag \\
albumartist & string & id tag \\
@@ -143,7 +139,5 @@ to RAM.}%
length & numeric & system \\
Lm (track len - min) & numeric & system \\
Ls (track len - sec) & numeric & system \\
- \bottomrule
- \end{tabularx}
-\end{center}
+ \end{rbtabular}
\end{table}