len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2025-10-13 10:07:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix a few manual warnings

Browse source 
Change-Id: I4b9bf1e418367b2a420f56ce36f30cb0926e816f
This commit is contained in:
Moshe Piekarski 2020-06-28 00:08:52 -04:00 • committed by Solomon Peachy
parent 4641d86c46
commit 332433eb3d
6 changed files with 19 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

2
manual/appendix/config_file_options.tex
View file

@ -4,7 +4,7 @@
% define a local version of endhead, as using the output distinction adds % define a local version of endhead, as using the output distinction adds
% an unwanted newline. endhead breaks with htlatex so we need to remove it % an unwanted newline. endhead breaks with htlatex so we need to remove it
% for the html output. % for the html output.
\ifpdfoutput{\newcommand{\localendhead}{\endhead}}% \Ifpdfoutput{\newcommand{\localendhead}{\endhead}}%
{\newcommand{\localendhead}{}} {\newcommand{\localendhead}{}}
\rowcolors{2}{tbloddrowbgcolor}{tblevenrowbgcolor} \rowcolors{2}{tbloddrowbgcolor}{tblevenrowbgcolor}
\begin{longtable}{>{\raggedright}p{.3\textwidth}>{\raggedright}p{.4\textwidth}p{.2\textwidth}} \begin{longtable}{>{\raggedright}p{.3\textwidth}>{\raggedright}p{.4\textwidth}p{.2\textwidth}}

2
manual/frontpage/frontpage.tex
View file

@ -1,7 +1,7 @@
\thispagestyle{empty} \thispagestyle{empty}
\vspace*{0.3cm} \vspace*{0.3cm}
\begin{center} \begin{center}
\ifpdfoutput{\includegraphics[width=10cm]{frontpage/rockboxlogo.pdf}} \Ifpdfoutput{\includegraphics[width=10cm]{frontpage/rockboxlogo.pdf}}
{\includegraphics{frontpage/rockbox-web.png}}\\ {\includegraphics{frontpage/rockbox-web.png}}\\
\vspace{2cm} \vspace{2cm}
\huge{\textsf{\textbf{The Rockbox Manual\\for\\\playername}}}\vspace{1cm}\\ \huge{\textsf{\textbf{The Rockbox Manual\\for\\\playername}}}\vspace{1cm}\\

6
manual/getting_started/main.tex
View file

@ -65,7 +65,7 @@ unsupported''. Manufacturer and model names are proper nouns, and
thus are written beginning with a capital letter. thus are written beginning with a capital letter.
% write a bit more about names etc. here. % write a bit more about names etc. here.
\ifpdfoutput{ \Ifpdfoutput{
This manual has some parts that are marked with icons on the margin to help This manual has some parts that are marked with icons on the margin to help
you finding important parts or parts you could skip. The following icons you finding important parts or parts you could skip. The following icons
are used: are used:
@ -91,14 +91,14 @@ are used:
icon shown in the margin on the right. icon shown in the margin on the right.
\\ \\
} }
}{}% end ifpdfoutput }{}% end Ifpdfoutput
Links to the wiki are abbreviated by the name of the wiki page. Those names Links to the wiki are abbreviated by the name of the wiki page. Those names
are still linked so you can simply follow them like any other link in this are still linked so you can simply follow them like any other link in this
manual. If you want to access a wiki page manually go to manual. If you want to access a wiki page manually go to
\wikiicon{} \href{\wikibaseurl}{\wikibaseurl} \wikiicon{} \href{\wikibaseurl}{\wikibaseurl}
and type the page name in the ``Go'' box at the top of the page. and type the page name in the ``Go'' box at the top of the page.
\ifpdfoutput{Links to wiki pages are also indicated by the symbol \wikiicon{} \Ifpdfoutput{Links to wiki pages are also indicated by the symbol \wikiicon{}
in front of the page name.}{} in front of the page name.}{}
\input{getting_started/installation.tex} \input{getting_started/installation.tex}

4
manual/intro/main.tex
View file

@ -18,11 +18,11 @@
% Contributors are listed in the file docs/CREDITS-MANUAL % Contributors are listed in the file docs/CREDITS-MANUAL
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifpdfoutput{ \Ifpdfoutput{
\newcommand{\latexbuild}{pdf\LaTeX}} \newcommand{\latexbuild}{pdf\LaTeX}}
{\newcommand{\latexbuild}{\TeX4ht}} {\newcommand{\latexbuild}{\TeX4ht}}
\ifpdfoutput{\chapter*{\centering{Rockbox\\}}}% \Ifpdfoutput{\chapter*{\centering{Rockbox\\}}}%
{\begin{center}{\Large{Rockbox}}\end{center}} {\begin{center}{\Large{Rockbox}}\end{center}}
\vspace{1cm} \vspace{1cm}

22
manual/preamble.tex
View file

@ -76,7 +76,7 @@
\usepackage{makeidx} \usepackage{makeidx}
\usepackage{fancyvrb} \usepackage{fancyvrb}
\usepackage{color} \usepackage{color}
\ifpdfoutput{\usepackage{booktabs}}% \Ifpdfoutput{\usepackage{booktabs}}%
{\newcommand{% {\newcommand{%
\toprule}{}\newcommand{\midrule}{\hline}\newcommand{\bottomrule}{}% \toprule}{}\newcommand{\midrule}{\hline}\newcommand{\bottomrule}{}%
} }
@ -90,7 +90,7 @@
% pdf output: try pdf first, then png and jpg as file format % pdf output: try pdf first, then png and jpg as file format
% html output: try png first, then jpg. Ignore pdf files % html output: try png first, then jpg. Ignore pdf files
% this only applies if no file extension is given! % this only applies if no file extension is given!
\ifpdfoutput{\DeclareGraphicsExtensions{.pdf,.png,.jpg}}% \Ifpdfoutput{\DeclareGraphicsExtensions{.pdf,.png,.jpg}}%
{\DeclareGraphicsExtensions{.png,.jpg}} {\DeclareGraphicsExtensions{.png,.jpg}}
% fancy header style adjustments % fancy header style adjustments
@ -107,7 +107,7 @@
\setlength{\headheight}{18.5pt} \setlength{\headheight}{18.5pt}
\newcounter{example}[chapter] \newcounter{example}[chapter]
\ifpdfoutput{% \Ifpdfoutput{%
\renewcommand{\toprule}{\specialrule{\heavyrulewidth}{\abovetopsep}{0pt}} \renewcommand{\toprule}{\specialrule{\heavyrulewidth}{\abovetopsep}{0pt}}
\renewcommand{\midrule}{\specialrule{\lightrulewidth}{0pt}{\belowrulesep}} \renewcommand{\midrule}{\specialrule{\lightrulewidth}{0pt}{\belowrulesep}}
}{} }{}
@ -198,7 +198,7 @@
% command to display a note. % command to display a note.
% Usage: \note{text of your note} % Usage: \note{text of your note}
% Note: do NOT use \textbf or similar to emphasize text, use \emph! % Note: do NOT use \textbf or similar to emphasize text, use \emph!
\ifpdfoutput{ \Ifpdfoutput{
\newcommand{\note}[1]{ \newcommand{\note}[1]{
\ifinner\else\vspace{1ex}\par\noindent\fi \ifinner\else\vspace{1ex}\par\noindent\fi
\textbf{Note:}\ % \textbf{Note:}\ %
@ -209,7 +209,7 @@
% command to display a warning. % command to display a warning.
% Usage: \warn{text of your warning} % Usage: \warn{text of your warning}
% Note: do NOT use \textbf or similar to emphasize text! % Note: do NOT use \textbf or similar to emphasize text!
\ifpdfoutput{ \Ifpdfoutput{
\newcommand{\warn}[1]{ \newcommand{\warn}[1]{
\ifinner\else\par\noindent\fi \ifinner\else\par\noindent\fi
\textbf{Warning:\ }% \textbf{Warning:\ }%
@ -219,7 +219,7 @@
% command to mark a text block as intended especially for blind people % command to mark a text block as intended especially for blind people
% Usage: \blind{text} % Usage: \blind{text}
\ifpdfoutput{ \Ifpdfoutput{
\newcommand{\blind}[1]{\mbox{}\marginpar{\raisebox{-1ex}{\Huge{\ForwardToEnd}}}#1} \newcommand{\blind}[1]{\mbox{}\marginpar{\raisebox{-1ex}{\Huge{\ForwardToEnd}}}#1}
} }
{\newcommand{\blind}[1]{\ifinner\else\par\noindent\fi#1}} {\newcommand{\blind}[1]{\ifinner\else\par\noindent\fi#1}}
@ -299,7 +299,7 @@
% When creating HTML, use the soul package. % When creating HTML, use the soul package.
% This produces much nicer HTML code (textsc results in each character being % This produces much nicer HTML code (textsc results in each character being
% put in a separate <span>). % put in a separate <span>).
\ifpdfoutput{\newcommand{\caps}[1]{\textsc{#1}}}{\usepackage{soul}} \Ifpdfoutput{\newcommand{\caps}[1]{\textsc{#1}}}{\usepackage{soul}}
\newcommand{\setting}[1]{\caps{#1}} \newcommand{\setting}[1]{\caps{#1}}
\newcommand{\config}[1]{\texttt{#1}} \newcommand{\config}[1]{\texttt{#1}}
@ -314,7 +314,7 @@
% Usage: \wikilink{WebHome} % Usage: \wikilink{WebHome}
% with "WebHome" being the wiki page name % with "WebHome" being the wiki page name
\newcommand{\wikibaseurl}{http://www.rockbox.org/wiki/} \newcommand{\wikibaseurl}{http://www.rockbox.org/wiki/}
\ifpdfoutput{\newcommand{\wikiicon}{\Pointinghand}} \Ifpdfoutput{\newcommand{\wikiicon}{\Pointinghand}}
{\newcommand{\wikiicon}{}} {\newcommand{\wikiicon}{}}
\newcommand{\wikilink}[1]{\wikiicon{}\href{\wikibaseurl#1}{#1}} \newcommand{\wikilink}[1]{\wikiicon{}\href{\wikibaseurl#1}{#1}}
%\newcommand{\wikilink}[1]{\url{http://www.rockbox.org/wiki/#1}} %\newcommand{\wikilink}[1]{\url{http://www.rockbox.org/wiki/#1}}
@ -355,15 +355,15 @@
% Use the reference to handle get a flexible reference command % Use the reference to handle get a flexible reference command
% usage \reference{ref_section} % usage \reference{ref_section}
\ifpdfoutput{% \Ifpdfoutput{%
\newcommand{\reference}[1]{% \newcommand{\reference}[1]{%
section~\ref{#1} (page~\pageref{#1})% section~\ref{#1} (page~\pageref{#1})%
}} }}
{\newcommand{\reference}[1]{section~\ref{#1}}} {\newcommand{\reference}[1]{section~\ref{#1}}}
% special HTML output adjustments % special HTML output adjustments
\ifpdfoutput{}{\setlength{\parindent}{0mm}} \Ifpdfoutput{}{\setlength{\parindent}{0mm}}
\ifpdfoutput{}{\renewcommand{\Forward}[1]{$\triangleright${}#1}} \Ifpdfoutput{}{\renewcommand{\Forward}[1]{$\triangleright${}#1}}
\newcommand{\btnfnt}[1]{\textbf{#1}} \newcommand{\btnfnt}[1]{\textbf{#1}}
%\hfuzz=2pt %\hfuzz=2pt

2
manual/rockbox_interface/main.tex
View file

@ -5,7 +5,7 @@
% include the front image. Using \specimg makes this fairly easy, % include the front image. Using \specimg makes this fairly easy,
% but requires to use the exact value of \specimg in the filename! % but requires to use the exact value of \specimg in the filename!
% The extension is selected in the preamble, so no further \ifpdfoutput % The extension is selected in the preamble, so no further \Ifpdfoutput
% is necessary. % is necessary.
% %
% The check looks for a png file -- we use png for the HTML manual, so that % The check looks for a png file -- we use png for the HTML manual, so that