summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-07-31 12:21:57 +0000
committerMartin Arver <martin.arver@gmail.com>2006-07-31 12:21:57 +0000
commit7a47313a21c23b7e3e3ce69c6e799beb6bbf3548 (patch)
treeb7750e1518f77a6884e1c1883f8c654971c8e609 /manual
parent69a09fb9059c3df12d5803f569317257318e697f (diff)
downloadrockbox-7a47313a21c23b7e3e3ce69c6e799beb6bbf3548.tar.gz
rockbox-7a47313a21c23b7e3e3ce69c6e799beb6bbf3548.zip
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
Diffstat (limited to 'manual')
-rw-r--r--manual/appendix/appendix.tex2
-rwxr-xr-xmanual/configure_rockbox/display_options.tex10
-rwxr-xr-xmanual/configure_rockbox/file_view.tex12
-rwxr-xr-xmanual/configure_rockbox/language.tex2
-rw-r--r--manual/getting_started/main.tex2
-rw-r--r--manual/main_menu/fmradio.tex2
-rw-r--r--manual/main_menu/main.tex31
-rw-r--r--manual/main_menu/recording.tex2
-rw-r--r--manual/plugins/firmware_flash.tex2
-rw-r--r--manual/plugins/main.tex4
-rw-r--r--manual/plugins/rockbox_flash.tex2
-rw-r--r--manual/plugins/sort.tex2
-rw-r--r--manual/plugins/text_editor.tex2
-rw-r--r--manual/plugins/text_viewer.tex2
-rw-r--r--manual/preamble.tex10
-rw-r--r--manual/rockbox_interface/main.tex10
-rw-r--r--manual/rockbox_interface/wps.tex16
17 files changed, 61 insertions, 52 deletions
diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex
index 5144590796..d295a42621 100644
--- a/manual/appendix/appendix.tex
+++ b/manual/appendix/appendix.tex
@@ -112,7 +112,7 @@ For open feature requests refer to
Duplicates are really boring!
\item Check that the feature hasn't already been implemented.
Download the latest daily build and/or search the mail list archive.
-\item Check that the feature is possible to implement (see page \pageref{ref:NODO}).
+\item Check that the feature is possible to implement (see \rockref{ref:NODO}).
\end{enumerate}
\subsection{\label{ref:NODO}Features we will not implement}
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex
index 7bd969716b..7091be3558 100755
--- a/manual/configure_rockbox/display_options.tex
+++ b/manual/configure_rockbox/display_options.tex
@@ -5,16 +5,16 @@
\nopt{player}{
\item[Browse fonts:]
Browse the fonts that reside in your \fname{/.rockbox/fonts} directory.
- Selecting one will activate it. See page \pageref{ref:Loadingfonts}
+ Selecting one will activate it. See \rockref{ref:Loadingfonts}
for further details about fonts.
} % \nopt{player}
\item[Browse WPS files:]
Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and
displays all \fname{.wps} files. Selecting one will activate it, stop will
- exit back to the menu. For further information about the WPS see page
- \pageref{ref:WPS}. For information about editing a .wps file see
- page \pageref{ref:ConfiguringtheWPS}.
+ exit back to the menu. For further information about the WPS see
+ \rockref{ref:WPS}. For information about editing a .wps file see
+ \rockref{ref:ConfiguringtheWPS}.
\opt{h1xx,h300,x5}{
\item[Browse RWPS files:]
@@ -226,7 +226,7 @@
\opt{HAVE_LCD_BITMAP}{
\item[Peak Meter:]
The peak meter can be configured with a number of parameters.
- (For a description of the peak meter see page \pageref{sec:peakmeter}.)
+ (For a description of the peak meter see \rockref{sec:peakmeter}.)
\begin{description}
\item[Peak Release:]
This determines how fast the bar shrinks when the music becomes
diff --git a/manual/configure_rockbox/file_view.tex b/manual/configure_rockbox/file_view.tex
index 3318bc1dfc..e2643f1bdf 100755
--- a/manual/configure_rockbox/file_view.tex
+++ b/manual/configure_rockbox/file_view.tex
@@ -30,7 +30,7 @@
information, thus disabling the file browser. You can browse the
database by various tags and search them. Only information present
in music file tags are shown. For a detailed description of Tag Cache
- refer to page \pageref{ref:tagcache}.
+ refer to \rockref{ref:tagcache}.
\item[Playlists:] The File Browser displays only directories and playlists,
for simplified navigation.
\item[Music:] The File Browser displays only folders, \fname{.m3u} files
@@ -38,7 +38,7 @@
Files and directories starting with \fname{.} or with the ``hidden''
flag set are hidden.
\item[Supported:] The File Browser displays all directories and files
- supported by Rockbox (see page \pageref{ref:Supportedfileformats}).
+ supported by Rockbox (see \rockref{ref:Supportedfileformats}).
Files and directories starting with \fname{.} or with the ``hidden''
flag set are hidden.
\end{description}
@@ -53,12 +53,12 @@
\item[Show Icons:]
Rockbox has the ability to display an icon to the left of the file
- in the File Browser. For details of these icons, please see page
- \pageref{ref:Supportedfileformats}.
+ in the File Browser. For details of these icons, please see
+ \rockref{ref:Supportedfileformats}.
\item[Tag Cache:]
- This option allows you to configure the Tag Cache.
- See page \pageref{ref:tagcache} for more information about using
+ This option allows you to configure the Tag Cache.
+ See \rockref{ref:tagcache} for more information about using
the Tag Cache.
\end{description}
diff --git a/manual/configure_rockbox/language.tex b/manual/configure_rockbox/language.tex
index 23d663a64b..145cdf6aca 100755
--- a/manual/configure_rockbox/language.tex
+++ b/manual/configure_rockbox/language.tex
@@ -1,2 +1,2 @@
\section{\label{ref:Language}Language}
- This setting controls the language of the Rockbox user interface. Selecting a language will activate it. The language files must be in the \textbf{/.rockbox/lang/} directory. See page \pageref{ref:Loadinglanguages} for further details about languages.
+ This setting controls the language of the Rockbox user interface. Selecting a language will activate it. The language files must be in the \textbf{/.rockbox/lang/} directory. See \rockref{ref:Loadinglanguages} for further details about languages.
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index f20dfc1d85..87d508e554 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -125,7 +125,7 @@ from \wikilink{VoiceFiles}. For the
English language, the file is called \fname{english.voice}. When it has been
downloaded, unpack this file and copy it into the \fname{lang} folder which is
inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on
-by default. See page \pageref{ref:Voiceconfiguration} for details on voice
+by default. See \rockref{ref:Voiceconfiguration} for details on voice
settings.
\section{Running Rockbox}
diff --git a/manual/main_menu/fmradio.tex b/manual/main_menu/fmradio.tex
index 700d5cff9c..c67c388717 100644
--- a/manual/main_menu/fmradio.tex
+++ b/manual/main_menu/fmradio.tex
@@ -110,7 +110,7 @@
station. Press \ButtonOff\ to stop recording. Press \ButtonPlay\
again to seamlessly start recording to a new file. The settings
for the recording can be changed in the \ButtonFOne\ menu before
- starting the recording. See page \pageref{ref:Recordingsettings}
+ starting the recording. See \rockref{ref:Recordingsettings}
for details of recording settings.
}
\end{description}
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index bc486c5c2d..218d38cfaa 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -18,7 +18,7 @@ the disk solely for the purpose of saving settings. Instead, Rockbox will
save settings when it spins up the disk the next time, for example when
refilling the MP3 buffer or navigating through the file browser. Changes to
settings may therefore not be saved unless the \dap\ is shut down safely
-(see page \pageref{ref:Safeshutdown}).
+(see \rockref{ref:Safeshutdown}).
\section{Navigating the Main Menu}
\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{
@@ -69,25 +69,25 @@ settings may therefore not be saved unless the \dap\ is shut down safely
{The list bookmarks screen}{}
If the \setting{Save a list of recently created bookmarks} option is enabled
then you can view a list of several recent bookmarks here and select one to
-jump straight to that track. See page \pageref{ref:Bookmarkconfigactual}
+jump straight to that track. See \rockref{ref:Bookmarkconfigactual}
for more details on configuring bookmarking in Rockbox.
\note{This option is off by default.}
\section{Sound Settings}
The \setting{Sound Settings} menu offers a selection of sound properties you may
change to customize your listening experience. The details of this menu are
-covered in detail starting on page \pageref{ref:configure_rockbox_sound}.
+covered in detail in \rockref{ref:configure_rockbox_sound}.
\section{General Settings}
The \setting{General Settings} menu allows you to customize the way Rockbox looks
-and the way it plays music. The details of this menu are covered in detail
-starting on page \pageref{ref:configure_rockbox_general}.
+and the way it plays music. The details of this menu are covered in detail in
+\rockref{ref:configure_rockbox_general}.
\section{Manage Settings}
The \setting{Manage Settings} option allows the saving and re-loading of user
configuration settings, browse the hard drive for alternate firmwares, and finally
to reset your \dap\ back to initial configuration. The details of this menu are
-covered in detail starting on page \pageref{ref:ManageSetting}.
+covered in detail in \rockref{ref:ManageSetting}.
\section{Browse Themes}
This option will display all the currently installed themes on the \dap,
@@ -113,9 +113,8 @@ others will be full-blown themes.
\note{Themes do not have to be purely visual. It is quite possible to create
a theme that switches between audio configurations for use in the car, with
-headphones and when connected to an external amplifier. See the section on
-``Making Your Own Settings File'' on page \pageref{ref:CreateYourOwnWPS}
-for more details.
+headphones and when connected to an external amplifier. See
+\rockref{ref:CreateYourOwnWPS} for more details.
}
\opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}}
@@ -126,7 +125,7 @@ for more details.
This menu allows you to work with playlists. Playlists can either be created
automatically by playing a file in a directory directly, which will cause all
of the files in that directory to be placed in the playlist, or they can be
-created by hand using the \setting{File Menu} (see page \pageref{ref:Filemenu})
+created by hand using the \setting{File Menu} (see \rockref{ref:Filemenu})
or using the \setting{Playlist Options} menu. Both automatic and manually
created playlists can be edited using this menu.
@@ -142,7 +141,7 @@ from where you currently are.
\item[Save Current Playlist:]
Saves the current dynamic playlist, excluding queued tracks, to the
specified file. If no path is provided then playlist is saved to current
-directory (see page \pageref{ref:Playlistsubmenu}).
+directory (see \rockref{ref:Playlistsubmenu}).
\item[Recursively Insert Directories: ]
If set to \setting{On}, then when a directory is inserted or queued into a
@@ -160,8 +159,8 @@ directory (see page \pageref{ref:Playlistsubmenu}).
With this option you can load and run various plugins that have been
written for Rockbox. There are a wide variety of these supplied with
Rockbox, including several games, some impressive demos and a number of
-utilities. A detailed description of the different plugins begins
-on page \pageref{ref:plugins}.
+utilities. A detailed description of the different plugins is to be found in
+\rockref{ref:plugins}.
\section{\label{ref:Info}Info}
This option shows RAM buffer size, battery voltage level and estimated time
@@ -192,7 +191,7 @@ battery status, hard disk size and the amount of free space on the disk.
This menu option saves the Rockbox configuration and turns off the hard
drive before shutting down the machine. For maximum safety this procedure
is recommended when turning off the \dap. (There is a very small risk
- of hard disk corruption otherwise.) See page \pageref{ref:Safeshutdown}
+ of hard disk corruption otherwise.) See \rockref{ref:Safeshutdown}
for more details.
}
@@ -207,6 +206,6 @@ battery status, hard disk size and the amount of free space on the disk.
\opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonMenu}
\opt{IAUDIO_X5_PAD}{\ButtonRec}
key, and it allows rapid access to the \setting{Shuffle} and \setting{Repeat} modes
- (Page \pageref{ref:PlaybackOptions})
- and the \setting{Show Files} option (Page \pageref{ref:ShowFiles}).
+ (\rockref{ref:PlaybackOptions})
+ and the \setting{Show Files} option (\rockref{ref:ShowFiles}).
}
diff --git a/manual/main_menu/recording.tex b/manual/main_menu/recording.tex
index 44ffe10b18..2d3ee52799 100644
--- a/manual/main_menu/recording.tex
+++ b/manual/main_menu/recording.tex
@@ -110,7 +110,7 @@
\item[Source:]
Choose the source of the recording. This can be
\opt{recorder,recorderv2fm,h1xx}{SPDIF (digital),} microphone or line in.
- \opt{CONFIG_TUNER}{For recording from the radio see page \pageref{ref:FMradio}.}
+ \opt{CONFIG_TUNER}{For recording from the radio see \rockref{ref:FMradio}.}
% Add h1xx here whenever it supports setting recording frequency.
\opt{recorder,recorderv2fm}
diff --git a/manual/plugins/firmware_flash.tex b/manual/plugins/firmware_flash.tex
index 9361cc3cce..dab7020ffd 100644
--- a/manual/plugins/firmware_flash.tex
+++ b/manual/plugins/firmware_flash.tex
@@ -6,7 +6,7 @@
Firmware\_flash
\par}
-Use when flashing Rockbox (see page \pageref{ref:FlashingRockboxReal}.
+Use when flashing Rockbox (see \rockref{ref:FlashingRockboxReal}.
In the ideal case, you'll need this tool only once. For safety reasons you may wish to delete \textbf{firmware\_flash.rock} from \textbf{/.rockbox/rocks} once flashing is complete.
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 422f2c48b3..b4dee2426b 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -14,9 +14,9 @@ text files, chip8 games), or from the \setting{Open with} option on the
\section{Games}
\opt{HAVE_LCD_BITMAP}
- {See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator}
+ {See also the Chip{}-8 emulator in \rockref{ref:Chip8emulator}
\opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodvideo}
- {and Rockboy on page \pageref{ref:Rockboy}}.}
+ {and Rockboy in \rockref{ref:Rockboy}}.}
\opt{HAVE_LCD_BITMAP}{\input{plugins/brickmania.tex}}
diff --git a/manual/plugins/rockbox_flash.tex b/manual/plugins/rockbox_flash.tex
index fd37daccd3..a627fdcdbc 100644
--- a/manual/plugins/rockbox_flash.tex
+++ b/manual/plugins/rockbox_flash.tex
@@ -7,6 +7,6 @@ Rockbox flash
\par}
For ``playing'' \fname{.UCL} files on flashed Jukeboxes. Reprograms the flash memory of
-the Jukebox unit (see page \pageref{ref:Rockboxinflash} for details).
+the Jukebox unit (see \rockref{ref:Rockboxinflash} for details).
diff --git a/manual/plugins/sort.tex b/manual/plugins/sort.tex
index 940f86ff40..f9e423adc0 100644
--- a/manual/plugins/sort.tex
+++ b/manual/plugins/sort.tex
@@ -1,5 +1,5 @@
\subsection{Sort}
This plugin takes a file and sorts it in forward alphabetical order. Case is
-ignored. This is useful for ordering playlists generated by the ``Create Playlist'' menu option (see page \pageref{ref:Playlistsubmenu}).
+ignored. This is useful for ordering playlists generated by the ``Create Playlist'' menu option (see \rockref{ref:Playlistsubmenu}).
diff --git a/manual/plugins/text_editor.tex b/manual/plugins/text_editor.tex
index 499ec79d97..08bd922074 100644
--- a/manual/plugins/text_editor.tex
+++ b/manual/plugins/text_editor.tex
@@ -1,7 +1,7 @@
\subsection{Text Editor}
This plugin allows you to view and edit simple text documents on your DAP.
You can view files by using \textbf{Open with} from the
-\textbf{File Menu} (see page \pageref{ref:Filemenu}).
+\textbf{File Menu} (see \rockref{ref:Filemenu}).
\subsubsection{Usage}
If you start the Text Editor from the plugin browser you will be greeted with
diff --git a/manual/plugins/text_viewer.tex b/manual/plugins/text_viewer.tex
index f35994dac3..9e8820800d 100644
--- a/manual/plugins/text_viewer.tex
+++ b/manual/plugins/text_viewer.tex
@@ -3,7 +3,7 @@ This is a Viewer for text files with word wrap. Just open a .txt file to
display it. The text vewer features controls to handle various styles of text
formatting, has top{}-of{}-file and bottom{}-of{}-file buttons. You can view
files without a \fname{.txt} extension by using \emph{Open with} from the
-\emph{File Menu} (see page \pageref{ref:Filemenu}).
+\emph{File Menu} (see \rockref{ref:Filemenu}).
\subsubsection{Mode settings}
diff --git a/manual/preamble.tex b/manual/preamble.tex
index 056cd5c84b..d79655a540 100644
--- a/manual/preamble.tex
+++ b/manual/preamble.tex
@@ -259,3 +259,13 @@
\renewcommand{\optnvalue}{0}\opt{#1}{\renewcommand{\optnvalue}{1}}%
\ifthenelse{\optnvalue > 0}{}{#2}
}
+
+
+
+% Use the rockref to handle get a flexible reference command
+% usage \rockref{ref_section}
+\ifpdfoutput{
+ \newcommand{\rockref}[1]{%
+ section \ref{#1} (page \pageref{#1})
+}}
+{\newcommand{\rockref}[1]{section \ref{#1}}}
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index 74ed075773..1683a7fdbf 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -143,8 +143,8 @@ etc.
You can select whether to browse using the \setting{File Browser} or the
\setting{Tag Cache Browser} by adjusting the \setting{Show Files} setting.
If you choose the \setting{File Browser}, the \setting{Show Files} setting also
-lets you select what types of files you wish to view. See page
-\pageref{ref:ShowFiles} for more information on the \setting{Show Files}
+lets you select what types of files you wish to view. See
+\rockref{ref:ShowFiles} for more information on the \setting{Show Files}
setting.
\note{The \setting{File Browser} allows you to manipulate your files in ways
@@ -179,7 +179,7 @@ that are not available within the \setting{Tag Cache Browser}. Read more about
\opt{ONDIO_PAD}{\ButtonRight}
\opt{RECORDER_PAD}{\ButtonRight/\ButtonPlay}
& Executes an action. Depending on the file type, that action may vary.
- (See page \pageref{ref:Filemenu}) \\
+ (See \rockref{ref:Filemenu}) \\
%
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,PLAYER_PAD,RECORDER_PAD}{\ButtonOn}
\opt{IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonPlay}
@@ -266,7 +266,7 @@ each option pertains both to files and directories):
The \setting{Open With} function can be used to override the default action and
select a viewer by hand. For example, this function can be used to view a text file
even if the file has a non-standard extension (i.e., the file has an extension
- of something other than ``.txt''). See page \textmd{\pageref{ref:Viewersplugins}}
+ of something other than \fname{.txt}). See \rockref{ref:Viewersplugins}
for more details on viewers.
\item [Create Directory:]
Makes a new folder in the current folder on the disk.
@@ -294,7 +294,7 @@ options:
\item [Queue:]
Queue is the same as Insert except queued tracks are deleted immediately from
the playlist after they've been played. Also, queued tracks are not saved to
- the playlist file (see page \pageref{ref:playlistoptions}).
+ the playlist file (see \rockref{ref:playlistoptions}).
\item [Queue next:]
Queue track(s) immediately after current playing track.
\item [Queue last:]
diff --git a/manual/rockbox_interface/wps.tex b/manual/rockbox_interface/wps.tex
index d93fa684b6..8df5384e0e 100644
--- a/manual/rockbox_interface/wps.tex
+++ b/manual/rockbox_interface/wps.tex
@@ -6,7 +6,7 @@ currently playing audio file.
\opt{HAVE_LCD_BITMAP}{%
The apperance of the WPS can be configured using wps configuration files.
The items shown depend on your configuration -- all item can be turned on
- or off independently. Refer to \pageref{ref:wps_tags} for details on how
+ or off independently. Refer to \rockref{ref:wps_tags} for details on how
to change the display of the WPS.
\begin{itemize}
\item Status bar: The Status bar shows Battery level, charger status,
@@ -42,7 +42,7 @@ currently playing audio file.
}
}
-See page \pageref{ref:ConfiguringtheWPS} for details of customising
+See \rockref{ref:ConfiguringtheWPS} for details of customising
your WPS (While Playing Screen).
@@ -127,8 +127,8 @@ your WPS (While Playing Screen).
\opt{HAVE_LCD_BITMAP}{
\subsection{\label{ref:peak_meter}Peak Meter}
The peak meter can be displayed on the While Playing Screen and consists of
- several indicators. For a picture of the peak meter, please see the While
- Recording Screen on page \pageref{ref:Whilerecordingscreen}.
+ several indicators. For a picture of the peak meter, please see the While
+ Recording Screen in \rockref{ref:Whilerecordingscreen}.
\begin{description}
\item [The bar:]
@@ -158,8 +158,8 @@ your WPS (While Playing Screen).
\subsubsection{Sound Settings}
This is a shortchut to the \setting{Sound Settings Menu}, where you can configure volume,
- bass, treble, and other settings affecting the sound of your music. See page
- \pageref{ref:configure_rockbox_sound} for more information.
+ bass, treble, and other settings affecting the sound of your music.
+ See \rockref{ref:configure_rockbox_sound} for more information.
\subsubsection{Playlist}
The \setting{Playlist} submenu allows you to view, save, search and reshuffle the current
@@ -246,7 +246,7 @@ your WPS (While Playing Screen).
(Playlists), any files that Rockbox supports (Supported) or all files on the
disk (All).
- See page \pageref{ref:PlaybackOptions} for more information about these
+ See \rockref{ref:PlaybackOptions} for more information about these
settings.
\begin{table}
@@ -268,7 +268,7 @@ your WPS (While Playing Screen).
assignments swap over with the display orientation where it is logical for
them to do so.
- See page \pageref{ref:Displayoptions} for more information about these
+ See \rockref{ref:Displayoptions} for more information about these
settings.
\begin{table}