diff options
author | Martin Arver <martin.arver@gmail.com> | 2006-07-31 12:21:57 +0000 |
---|---|---|
committer | Martin Arver <martin.arver@gmail.com> | 2006-07-31 12:21:57 +0000 |
commit | 7a47313a21c23b7e3e3ce69c6e799beb6bbf3548 (patch) | |
tree | b7750e1518f77a6884e1c1883f8c654971c8e609 /manual | |
parent | 69a09fb9059c3df12d5803f569317257318e697f (diff) | |
download | rockbox-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.tex | 2 | ||||
-rwxr-xr-x | manual/configure_rockbox/display_options.tex | 10 | ||||
-rwxr-xr-x | manual/configure_rockbox/file_view.tex | 12 | ||||
-rwxr-xr-x | manual/configure_rockbox/language.tex | 2 | ||||
-rw-r--r-- | manual/getting_started/main.tex | 2 | ||||
-rw-r--r-- | manual/main_menu/fmradio.tex | 2 | ||||
-rw-r--r-- | manual/main_menu/main.tex | 31 | ||||
-rw-r--r-- | manual/main_menu/recording.tex | 2 | ||||
-rw-r--r-- | manual/plugins/firmware_flash.tex | 2 | ||||
-rw-r--r-- | manual/plugins/main.tex | 4 | ||||
-rw-r--r-- | manual/plugins/rockbox_flash.tex | 2 | ||||
-rw-r--r-- | manual/plugins/sort.tex | 2 | ||||
-rw-r--r-- | manual/plugins/text_editor.tex | 2 | ||||
-rw-r--r-- | manual/plugins/text_viewer.tex | 2 | ||||
-rw-r--r-- | manual/preamble.tex | 10 | ||||
-rw-r--r-- | manual/rockbox_interface/main.tex | 10 | ||||
-rw-r--r-- | manual/rockbox_interface/wps.tex | 16 |
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 | |||
112 | Duplicates are really boring! | 112 | Duplicates are really boring! |
113 | \item Check that the feature hasn't already been implemented. | 113 | \item Check that the feature hasn't already been implemented. |
114 | Download the latest daily build and/or search the mail list archive. | 114 | Download the latest daily build and/or search the mail list archive. |
115 | \item Check that the feature is possible to implement (see page \pageref{ref:NODO}). | 115 | \item Check that the feature is possible to implement (see \rockref{ref:NODO}). |
116 | \end{enumerate} | 116 | \end{enumerate} |
117 | 117 | ||
118 | \subsection{\label{ref:NODO}Features we will not implement} | 118 | \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 @@ | |||
5 | \nopt{player}{ | 5 | \nopt{player}{ |
6 | \item[Browse fonts:] | 6 | \item[Browse fonts:] |
7 | Browse the fonts that reside in your \fname{/.rockbox/fonts} directory. | 7 | Browse the fonts that reside in your \fname{/.rockbox/fonts} directory. |
8 | Selecting one will activate it. See page \pageref{ref:Loadingfonts} | 8 | Selecting one will activate it. See \rockref{ref:Loadingfonts} |
9 | for further details about fonts. | 9 | for further details about fonts. |
10 | } % \nopt{player} | 10 | } % \nopt{player} |
11 | 11 | ||
12 | \item[Browse WPS files:] | 12 | \item[Browse WPS files:] |
13 | Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and | 13 | Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and |
14 | displays all \fname{.wps} files. Selecting one will activate it, stop will | 14 | displays all \fname{.wps} files. Selecting one will activate it, stop will |
15 | exit back to the menu. For further information about the WPS see page | 15 | exit back to the menu. For further information about the WPS see |
16 | \pageref{ref:WPS}. For information about editing a .wps file see | 16 | \rockref{ref:WPS}. For information about editing a .wps file see |
17 | page \pageref{ref:ConfiguringtheWPS}. | 17 | \rockref{ref:ConfiguringtheWPS}. |
18 | 18 | ||
19 | \opt{h1xx,h300,x5}{ | 19 | \opt{h1xx,h300,x5}{ |
20 | \item[Browse RWPS files:] | 20 | \item[Browse RWPS files:] |
@@ -226,7 +226,7 @@ | |||
226 | \opt{HAVE_LCD_BITMAP}{ | 226 | \opt{HAVE_LCD_BITMAP}{ |
227 | \item[Peak Meter:] | 227 | \item[Peak Meter:] |
228 | The peak meter can be configured with a number of parameters. | 228 | The peak meter can be configured with a number of parameters. |
229 | (For a description of the peak meter see page \pageref{sec:peakmeter}.) | 229 | (For a description of the peak meter see \rockref{sec:peakmeter}.) |
230 | \begin{description} | 230 | \begin{description} |
231 | \item[Peak Release:] | 231 | \item[Peak Release:] |
232 | This determines how fast the bar shrinks when the music becomes | 232 | 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 @@ | |||
30 | information, thus disabling the file browser. You can browse the | 30 | information, thus disabling the file browser. You can browse the |
31 | database by various tags and search them. Only information present | 31 | database by various tags and search them. Only information present |
32 | in music file tags are shown. For a detailed description of Tag Cache | 32 | in music file tags are shown. For a detailed description of Tag Cache |
33 | refer to page \pageref{ref:tagcache}. | 33 | refer to \rockref{ref:tagcache}. |
34 | \item[Playlists:] The File Browser displays only directories and playlists, | 34 | \item[Playlists:] The File Browser displays only directories and playlists, |
35 | for simplified navigation. | 35 | for simplified navigation. |
36 | \item[Music:] The File Browser displays only folders, \fname{.m3u} files | 36 | \item[Music:] The File Browser displays only folders, \fname{.m3u} files |
@@ -38,7 +38,7 @@ | |||
38 | Files and directories starting with \fname{.} or with the ``hidden'' | 38 | Files and directories starting with \fname{.} or with the ``hidden'' |
39 | flag set are hidden. | 39 | flag set are hidden. |
40 | \item[Supported:] The File Browser displays all directories and files | 40 | \item[Supported:] The File Browser displays all directories and files |
41 | supported by Rockbox (see page \pageref{ref:Supportedfileformats}). | 41 | supported by Rockbox (see \rockref{ref:Supportedfileformats}). |
42 | Files and directories starting with \fname{.} or with the ``hidden'' | 42 | Files and directories starting with \fname{.} or with the ``hidden'' |
43 | flag set are hidden. | 43 | flag set are hidden. |
44 | \end{description} | 44 | \end{description} |
@@ -53,12 +53,12 @@ | |||
53 | 53 | ||
54 | \item[Show Icons:] | 54 | \item[Show Icons:] |
55 | Rockbox has the ability to display an icon to the left of the file | 55 | Rockbox has the ability to display an icon to the left of the file |
56 | in the File Browser. For details of these icons, please see page | 56 | in the File Browser. For details of these icons, please see |
57 | \pageref{ref:Supportedfileformats}. | 57 | \rockref{ref:Supportedfileformats}. |
58 | 58 | ||
59 | \item[Tag Cache:] | 59 | \item[Tag Cache:] |
60 | This option allows you to configure the Tag Cache. | 60 | This option allows you to configure the Tag Cache. |
61 | See page \pageref{ref:tagcache} for more information about using | 61 | See \rockref{ref:tagcache} for more information about using |
62 | the Tag Cache. | 62 | the Tag Cache. |
63 | 63 | ||
64 | \end{description} | 64 | \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 @@ | |||
1 | \section{\label{ref:Language}Language} | 1 | \section{\label{ref:Language}Language} |
2 | 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. | 2 | 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 | |||
125 | English language, the file is called \fname{english.voice}. When it has been | 125 | English language, the file is called \fname{english.voice}. When it has been |
126 | downloaded, unpack this file and copy it into the \fname{lang} folder which is | 126 | downloaded, unpack this file and copy it into the \fname{lang} folder which is |
127 | inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on | 127 | inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on |
128 | by default. See page \pageref{ref:Voiceconfiguration} for details on voice | 128 | by default. See \rockref{ref:Voiceconfiguration} for details on voice |
129 | settings. | 129 | settings. |
130 | 130 | ||
131 | \section{Running Rockbox} | 131 | \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 @@ | |||
110 | station. Press \ButtonOff\ to stop recording. Press \ButtonPlay\ | 110 | station. Press \ButtonOff\ to stop recording. Press \ButtonPlay\ |
111 | again to seamlessly start recording to a new file. The settings | 111 | again to seamlessly start recording to a new file. The settings |
112 | for the recording can be changed in the \ButtonFOne\ menu before | 112 | for the recording can be changed in the \ButtonFOne\ menu before |
113 | starting the recording. See page \pageref{ref:Recordingsettings} | 113 | starting the recording. See \rockref{ref:Recordingsettings} |
114 | for details of recording settings. | 114 | for details of recording settings. |
115 | } | 115 | } |
116 | \end{description} | 116 | \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 | |||
18 | save settings when it spins up the disk the next time, for example when | 18 | save settings when it spins up the disk the next time, for example when |
19 | refilling the MP3 buffer or navigating through the file browser. Changes to | 19 | refilling the MP3 buffer or navigating through the file browser. Changes to |
20 | settings may therefore not be saved unless the \dap\ is shut down safely | 20 | settings may therefore not be saved unless the \dap\ is shut down safely |
21 | (see page \pageref{ref:Safeshutdown}). | 21 | (see \rockref{ref:Safeshutdown}). |
22 | 22 | ||
23 | \section{Navigating the Main Menu} | 23 | \section{Navigating the Main Menu} |
24 | \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{ | 24 | \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 | |||
69 | {The list bookmarks screen}{} | 69 | {The list bookmarks screen}{} |
70 | If the \setting{Save a list of recently created bookmarks} option is enabled | 70 | If the \setting{Save a list of recently created bookmarks} option is enabled |
71 | then you can view a list of several recent bookmarks here and select one to | 71 | then you can view a list of several recent bookmarks here and select one to |
72 | jump straight to that track. See page \pageref{ref:Bookmarkconfigactual} | 72 | jump straight to that track. See \rockref{ref:Bookmarkconfigactual} |
73 | for more details on configuring bookmarking in Rockbox. | 73 | for more details on configuring bookmarking in Rockbox. |
74 | \note{This option is off by default.} | 74 | \note{This option is off by default.} |
75 | 75 | ||
76 | \section{Sound Settings} | 76 | \section{Sound Settings} |
77 | The \setting{Sound Settings} menu offers a selection of sound properties you may | 77 | The \setting{Sound Settings} menu offers a selection of sound properties you may |
78 | change to customize your listening experience. The details of this menu are | 78 | change to customize your listening experience. The details of this menu are |
79 | covered in detail starting on page \pageref{ref:configure_rockbox_sound}. | 79 | covered in detail in \rockref{ref:configure_rockbox_sound}. |
80 | 80 | ||
81 | \section{General Settings} | 81 | \section{General Settings} |
82 | The \setting{General Settings} menu allows you to customize the way Rockbox looks | 82 | The \setting{General Settings} menu allows you to customize the way Rockbox looks |
83 | and the way it plays music. The details of this menu are covered in detail | 83 | and the way it plays music. The details of this menu are covered in detail in |
84 | starting on page \pageref{ref:configure_rockbox_general}. | 84 | \rockref{ref:configure_rockbox_general}. |
85 | 85 | ||
86 | \section{Manage Settings} | 86 | \section{Manage Settings} |
87 | The \setting{Manage Settings} option allows the saving and re-loading of user | 87 | The \setting{Manage Settings} option allows the saving and re-loading of user |
88 | configuration settings, browse the hard drive for alternate firmwares, and finally | 88 | configuration settings, browse the hard drive for alternate firmwares, and finally |
89 | to reset your \dap\ back to initial configuration. The details of this menu are | 89 | to reset your \dap\ back to initial configuration. The details of this menu are |
90 | covered in detail starting on page \pageref{ref:ManageSetting}. | 90 | covered in detail in \rockref{ref:ManageSetting}. |
91 | 91 | ||
92 | \section{Browse Themes} | 92 | \section{Browse Themes} |
93 | This option will display all the currently installed themes on the \dap, | 93 | This option will display all the currently installed themes on the \dap, |
@@ -113,9 +113,8 @@ others will be full-blown themes. | |||
113 | 113 | ||
114 | \note{Themes do not have to be purely visual. It is quite possible to create | 114 | \note{Themes do not have to be purely visual. It is quite possible to create |
115 | a theme that switches between audio configurations for use in the car, with | 115 | a theme that switches between audio configurations for use in the car, with |
116 | headphones and when connected to an external amplifier. See the section on | 116 | headphones and when connected to an external amplifier. See |
117 | ``Making Your Own Settings File'' on page \pageref{ref:CreateYourOwnWPS} | 117 | \rockref{ref:CreateYourOwnWPS} for more details. |
118 | for more details. | ||
119 | } | 118 | } |
120 | 119 | ||
121 | \opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}} | 120 | \opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}} |
@@ -126,7 +125,7 @@ for more details. | |||
126 | This menu allows you to work with playlists. Playlists can either be created | 125 | This menu allows you to work with playlists. Playlists can either be created |
127 | automatically by playing a file in a directory directly, which will cause all | 126 | automatically by playing a file in a directory directly, which will cause all |
128 | of the files in that directory to be placed in the playlist, or they can be | 127 | of the files in that directory to be placed in the playlist, or they can be |
129 | created by hand using the \setting{File Menu} (see page \pageref{ref:Filemenu}) | 128 | created by hand using the \setting{File Menu} (see \rockref{ref:Filemenu}) |
130 | or using the \setting{Playlist Options} menu. Both automatic and manually | 129 | or using the \setting{Playlist Options} menu. Both automatic and manually |
131 | created playlists can be edited using this menu. | 130 | created playlists can be edited using this menu. |
132 | 131 | ||
@@ -142,7 +141,7 @@ from where you currently are. | |||
142 | \item[Save Current Playlist:] | 141 | \item[Save Current Playlist:] |
143 | Saves the current dynamic playlist, excluding queued tracks, to the | 142 | Saves the current dynamic playlist, excluding queued tracks, to the |
144 | specified file. If no path is provided then playlist is saved to current | 143 | specified file. If no path is provided then playlist is saved to current |
145 | directory (see page \pageref{ref:Playlistsubmenu}). | 144 | directory (see \rockref{ref:Playlistsubmenu}). |
146 | 145 | ||
147 | \item[Recursively Insert Directories: ] | 146 | \item[Recursively Insert Directories: ] |
148 | If set to \setting{On}, then when a directory is inserted or queued into a | 147 | 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}). | |||
160 | With this option you can load and run various plugins that have been | 159 | With this option you can load and run various plugins that have been |
161 | written for Rockbox. There are a wide variety of these supplied with | 160 | written for Rockbox. There are a wide variety of these supplied with |
162 | Rockbox, including several games, some impressive demos and a number of | 161 | Rockbox, including several games, some impressive demos and a number of |
163 | utilities. A detailed description of the different plugins begins | 162 | utilities. A detailed description of the different plugins is to be found in |
164 | on page \pageref{ref:plugins}. | 163 | \rockref{ref:plugins}. |
165 | 164 | ||
166 | \section{\label{ref:Info}Info} | 165 | \section{\label{ref:Info}Info} |
167 | This option shows RAM buffer size, battery voltage level and estimated time | 166 | 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. | |||
192 | This menu option saves the Rockbox configuration and turns off the hard | 191 | This menu option saves the Rockbox configuration and turns off the hard |
193 | drive before shutting down the machine. For maximum safety this procedure | 192 | drive before shutting down the machine. For maximum safety this procedure |
194 | is recommended when turning off the \dap. (There is a very small risk | 193 | is recommended when turning off the \dap. (There is a very small risk |
195 | of hard disk corruption otherwise.) See page \pageref{ref:Safeshutdown} | 194 | of hard disk corruption otherwise.) See \rockref{ref:Safeshutdown} |
196 | for more details. | 195 | for more details. |
197 | } | 196 | } |
198 | 197 | ||
@@ -207,6 +206,6 @@ battery status, hard disk size and the amount of free space on the disk. | |||
207 | \opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonMenu} | 206 | \opt{IPOD_4G_PAD,IPOD_VIDEO_PAD}{\ButtonMenu} |
208 | \opt{IAUDIO_X5_PAD}{\ButtonRec} | 207 | \opt{IAUDIO_X5_PAD}{\ButtonRec} |
209 | key, and it allows rapid access to the \setting{Shuffle} and \setting{Repeat} modes | 208 | key, and it allows rapid access to the \setting{Shuffle} and \setting{Repeat} modes |
210 | (Page \pageref{ref:PlaybackOptions}) | 209 | (\rockref{ref:PlaybackOptions}) |
211 | and the \setting{Show Files} option (Page \pageref{ref:ShowFiles}). | 210 | and the \setting{Show Files} option (\rockref{ref:ShowFiles}). |
212 | } | 211 | } |
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 @@ | |||
110 | \item[Source:] | 110 | \item[Source:] |
111 | Choose the source of the recording. This can be | 111 | Choose the source of the recording. This can be |
112 | \opt{recorder,recorderv2fm,h1xx}{SPDIF (digital),} microphone or line in. | 112 | \opt{recorder,recorderv2fm,h1xx}{SPDIF (digital),} microphone or line in. |
113 | \opt{CONFIG_TUNER}{For recording from the radio see page \pageref{ref:FMradio}.} | 113 | \opt{CONFIG_TUNER}{For recording from the radio see \rockref{ref:FMradio}.} |
114 | 114 | ||
115 | % Add h1xx here whenever it supports setting recording frequency. | 115 | % Add h1xx here whenever it supports setting recording frequency. |
116 | \opt{recorder,recorderv2fm} | 116 | \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 @@ | |||
6 | Firmware\_flash | 6 | Firmware\_flash |
7 | \par} | 7 | \par} |
8 | 8 | ||
9 | Use when flashing Rockbox (see page \pageref{ref:FlashingRockboxReal}. | 9 | Use when flashing Rockbox (see \rockref{ref:FlashingRockboxReal}. |
10 | 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. | 10 | 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. |
11 | 11 | ||
12 | 12 | ||
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 | |||
14 | 14 | ||
15 | \section{Games} | 15 | \section{Games} |
16 | \opt{HAVE_LCD_BITMAP} | 16 | \opt{HAVE_LCD_BITMAP} |
17 | {See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator} | 17 | {See also the Chip{}-8 emulator in \rockref{ref:Chip8emulator} |
18 | \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodvideo} | 18 | \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodvideo} |
19 | {and Rockboy on page \pageref{ref:Rockboy}}.} | 19 | {and Rockboy in \rockref{ref:Rockboy}}.} |
20 | 20 | ||
21 | \opt{HAVE_LCD_BITMAP}{\input{plugins/brickmania.tex}} | 21 | \opt{HAVE_LCD_BITMAP}{\input{plugins/brickmania.tex}} |
22 | 22 | ||
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 | |||
7 | \par} | 7 | \par} |
8 | 8 | ||
9 | For ``playing'' \fname{.UCL} files on flashed Jukeboxes. Reprograms the flash memory of | 9 | For ``playing'' \fname{.UCL} files on flashed Jukeboxes. Reprograms the flash memory of |
10 | the Jukebox unit (see page \pageref{ref:Rockboxinflash} for details). | 10 | the Jukebox unit (see \rockref{ref:Rockboxinflash} for details). |
11 | 11 | ||
12 | 12 | ||
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 @@ | |||
1 | \subsection{Sort} | 1 | \subsection{Sort} |
2 | This plugin takes a file and sorts it in forward alphabetical order. Case is | 2 | This plugin takes a file and sorts it in forward alphabetical order. Case is |
3 | ignored. This is useful for ordering playlists generated by the ``Create Playlist'' menu option (see page \pageref{ref:Playlistsubmenu}). | 3 | ignored. This is useful for ordering playlists generated by the ``Create Playlist'' menu option (see \rockref{ref:Playlistsubmenu}). |
4 | 4 | ||
5 | 5 | ||
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 @@ | |||
1 | \subsection{Text Editor} | 1 | \subsection{Text Editor} |
2 | This plugin allows you to view and edit simple text documents on your DAP. | 2 | This plugin allows you to view and edit simple text documents on your DAP. |
3 | You can view files by using \textbf{Open with} from the | 3 | You can view files by using \textbf{Open with} from the |
4 | \textbf{File Menu} (see page \pageref{ref:Filemenu}). | 4 | \textbf{File Menu} (see \rockref{ref:Filemenu}). |
5 | 5 | ||
6 | \subsubsection{Usage} | 6 | \subsubsection{Usage} |
7 | If you start the Text Editor from the plugin browser you will be greeted with | 7 | 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 | |||
3 | display it. The text vewer features controls to handle various styles of text | 3 | display it. The text vewer features controls to handle various styles of text |
4 | formatting, has top{}-of{}-file and bottom{}-of{}-file buttons. You can view | 4 | formatting, has top{}-of{}-file and bottom{}-of{}-file buttons. You can view |
5 | files without a \fname{.txt} extension by using \emph{Open with} from the | 5 | files without a \fname{.txt} extension by using \emph{Open with} from the |
6 | \emph{File Menu} (see page \pageref{ref:Filemenu}). | 6 | \emph{File Menu} (see \rockref{ref:Filemenu}). |
7 | 7 | ||
8 | \subsubsection{Mode settings} | 8 | \subsubsection{Mode settings} |
9 | 9 | ||
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 @@ | |||
259 | \renewcommand{\optnvalue}{0}\opt{#1}{\renewcommand{\optnvalue}{1}}% | 259 | \renewcommand{\optnvalue}{0}\opt{#1}{\renewcommand{\optnvalue}{1}}% |
260 | \ifthenelse{\optnvalue > 0}{}{#2} | 260 | \ifthenelse{\optnvalue > 0}{}{#2} |
261 | } | 261 | } |
262 | |||
263 | |||
264 | |||
265 | % Use the rockref to handle get a flexible reference command | ||
266 | % usage \rockref{ref_section} | ||
267 | \ifpdfoutput{ | ||
268 | \newcommand{\rockref}[1]{% | ||
269 | section \ref{#1} (page \pageref{#1}) | ||
270 | }} | ||
271 | {\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. | |||
143 | You can select whether to browse using the \setting{File Browser} or the | 143 | You can select whether to browse using the \setting{File Browser} or the |
144 | \setting{Tag Cache Browser} by adjusting the \setting{Show Files} setting. | 144 | \setting{Tag Cache Browser} by adjusting the \setting{Show Files} setting. |
145 | If you choose the \setting{File Browser}, the \setting{Show Files} setting also | 145 | If you choose the \setting{File Browser}, the \setting{Show Files} setting also |
146 | lets you select what types of files you wish to view. See page | 146 | lets you select what types of files you wish to view. See |
147 | \pageref{ref:ShowFiles} for more information on the \setting{Show Files} | 147 | \rockref{ref:ShowFiles} for more information on the \setting{Show Files} |
148 | setting. | 148 | setting. |
149 | 149 | ||
150 | \note{The \setting{File Browser} allows you to manipulate your files in ways | 150 | \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 | |||
179 | \opt{ONDIO_PAD}{\ButtonRight} | 179 | \opt{ONDIO_PAD}{\ButtonRight} |
180 | \opt{RECORDER_PAD}{\ButtonRight/\ButtonPlay} | 180 | \opt{RECORDER_PAD}{\ButtonRight/\ButtonPlay} |
181 | & Executes an action. Depending on the file type, that action may vary. | 181 | & Executes an action. Depending on the file type, that action may vary. |
182 | (See page \pageref{ref:Filemenu}) \\ | 182 | (See \rockref{ref:Filemenu}) \\ |
183 | % | 183 | % |
184 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,PLAYER_PAD,RECORDER_PAD}{\ButtonOn} | 184 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,PLAYER_PAD,RECORDER_PAD}{\ButtonOn} |
185 | \opt{IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonPlay} | 185 | \opt{IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonPlay} |
@@ -266,7 +266,7 @@ each option pertains both to files and directories): | |||
266 | The \setting{Open With} function can be used to override the default action and | 266 | The \setting{Open With} function can be used to override the default action and |
267 | select a viewer by hand. For example, this function can be used to view a text file | 267 | select a viewer by hand. For example, this function can be used to view a text file |
268 | even if the file has a non-standard extension (i.e., the file has an extension | 268 | even if the file has a non-standard extension (i.e., the file has an extension |
269 | of something other than ``.txt''). See page \textmd{\pageref{ref:Viewersplugins}} | 269 | of something other than \fname{.txt}). See \rockref{ref:Viewersplugins} |
270 | for more details on viewers. | 270 | for more details on viewers. |
271 | \item [Create Directory:] | 271 | \item [Create Directory:] |
272 | Makes a new folder in the current folder on the disk. | 272 | Makes a new folder in the current folder on the disk. |
@@ -294,7 +294,7 @@ options: | |||
294 | \item [Queue:] | 294 | \item [Queue:] |
295 | Queue is the same as Insert except queued tracks are deleted immediately from | 295 | Queue is the same as Insert except queued tracks are deleted immediately from |
296 | the playlist after they've been played. Also, queued tracks are not saved to | 296 | the playlist after they've been played. Also, queued tracks are not saved to |
297 | the playlist file (see page \pageref{ref:playlistoptions}). | 297 | the playlist file (see \rockref{ref:playlistoptions}). |
298 | \item [Queue next:] | 298 | \item [Queue next:] |
299 | Queue track(s) immediately after current playing track. | 299 | Queue track(s) immediately after current playing track. |
300 | \item [Queue last:] | 300 | \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. | |||
6 | \opt{HAVE_LCD_BITMAP}{% | 6 | \opt{HAVE_LCD_BITMAP}{% |
7 | The apperance of the WPS can be configured using wps configuration files. | 7 | The apperance of the WPS can be configured using wps configuration files. |
8 | The items shown depend on your configuration -- all item can be turned on | 8 | The items shown depend on your configuration -- all item can be turned on |
9 | or off independently. Refer to \pageref{ref:wps_tags} for details on how | 9 | or off independently. Refer to \rockref{ref:wps_tags} for details on how |
10 | to change the display of the WPS. | 10 | to change the display of the WPS. |
11 | \begin{itemize} | 11 | \begin{itemize} |
12 | \item Status bar: The Status bar shows Battery level, charger status, | 12 | \item Status bar: The Status bar shows Battery level, charger status, |
@@ -42,7 +42,7 @@ currently playing audio file. | |||
42 | } | 42 | } |
43 | } | 43 | } |
44 | 44 | ||
45 | See page \pageref{ref:ConfiguringtheWPS} for details of customising | 45 | See \rockref{ref:ConfiguringtheWPS} for details of customising |
46 | your WPS (While Playing Screen). | 46 | your WPS (While Playing Screen). |
47 | 47 | ||
48 | 48 | ||
@@ -127,8 +127,8 @@ your WPS (While Playing Screen). | |||
127 | \opt{HAVE_LCD_BITMAP}{ | 127 | \opt{HAVE_LCD_BITMAP}{ |
128 | \subsection{\label{ref:peak_meter}Peak Meter} | 128 | \subsection{\label{ref:peak_meter}Peak Meter} |
129 | The peak meter can be displayed on the While Playing Screen and consists of | 129 | The peak meter can be displayed on the While Playing Screen and consists of |
130 | several indicators. For a picture of the peak meter, please see the While | 130 | several indicators. For a picture of the peak meter, please see the While |
131 | Recording Screen on page \pageref{ref:Whilerecordingscreen}. | 131 | Recording Screen in \rockref{ref:Whilerecordingscreen}. |
132 | 132 | ||
133 | \begin{description} | 133 | \begin{description} |
134 | \item [The bar:] | 134 | \item [The bar:] |
@@ -158,8 +158,8 @@ your WPS (While Playing Screen). | |||
158 | 158 | ||
159 | \subsubsection{Sound Settings} | 159 | \subsubsection{Sound Settings} |
160 | This is a shortchut to the \setting{Sound Settings Menu}, where you can configure volume, | 160 | This is a shortchut to the \setting{Sound Settings Menu}, where you can configure volume, |
161 | bass, treble, and other settings affecting the sound of your music. See page | 161 | bass, treble, and other settings affecting the sound of your music. |
162 | \pageref{ref:configure_rockbox_sound} for more information. | 162 | See \rockref{ref:configure_rockbox_sound} for more information. |
163 | 163 | ||
164 | \subsubsection{Playlist} | 164 | \subsubsection{Playlist} |
165 | The \setting{Playlist} submenu allows you to view, save, search and reshuffle the current | 165 | The \setting{Playlist} submenu allows you to view, save, search and reshuffle the current |
@@ -246,7 +246,7 @@ your WPS (While Playing Screen). | |||
246 | (Playlists), any files that Rockbox supports (Supported) or all files on the | 246 | (Playlists), any files that Rockbox supports (Supported) or all files on the |
247 | disk (All). | 247 | disk (All). |
248 | 248 | ||
249 | See page \pageref{ref:PlaybackOptions} for more information about these | 249 | See \rockref{ref:PlaybackOptions} for more information about these |
250 | settings. | 250 | settings. |
251 | 251 | ||
252 | \begin{table} | 252 | \begin{table} |
@@ -268,7 +268,7 @@ your WPS (While Playing Screen). | |||
268 | assignments swap over with the display orientation where it is logical for | 268 | assignments swap over with the display orientation where it is logical for |
269 | them to do so. | 269 | them to do so. |
270 | 270 | ||
271 | See page \pageref{ref:Displayoptions} for more information about these | 271 | See \rockref{ref:Displayoptions} for more information about these |
272 | settings. | 272 | settings. |
273 | 273 | ||
274 | \begin{table} | 274 | \begin{table} |