From 4a948ca0ade98bad3bd6cf3c8efc93e0e6fa163a Mon Sep 17 00:00:00 2001 From: tomers Date: Mon, 5 Oct 2009 16:40:27 +0000 Subject: [PATCH] FS#10654 - Fix descriptions in manual to obey Latex guidelines git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22960 a1c6a512-1295-4272-9138-f99709370657 --- manual/configure_rockbox/bookmarking.tex | 8 +-- manual/configure_rockbox/display_options.tex | 86 ++++++++++++------------- manual/configure_rockbox/file_view.tex | 32 ++++----- manual/configure_rockbox/playback_options.tex | 42 ++++++------ manual/configure_rockbox/playlist_options.tex | 4 +- manual/configure_rockbox/recording_settings.tex | 34 +++++----- manual/configure_rockbox/sound_settings.tex | 42 ++++++------ manual/configure_rockbox/system_options.tex | 24 +++---- manual/configure_rockbox/theme_settings.tex | 38 +++++------ 9 files changed, 155 insertions(+), 155 deletions(-) diff --git a/manual/configure_rockbox/bookmarking.tex b/manual/configure_rockbox/bookmarking.tex index 8c61704e8..927dcc410 100644 --- a/manual/configure_rockbox/bookmarking.tex +++ b/manual/configure_rockbox/bookmarking.tex @@ -6,7 +6,7 @@ stored next to the directory/playlist they reference. You can store multiple bookmarks for the same track. \begin{description} - \item [Bookmark on Stop. ]This option controls whether Rockbox writes a + \item [Bookmark on Stop.] This option controls whether Rockbox writes a bookmark to the disk when playback is stopped. Setting this to \setting{No} turns automatic bookmarking completely off. In contrast \setting{Yes} turns automatic bookmarking on while \setting{Ask} @@ -34,7 +34,7 @@ recently accessed track regardless of how the \setting{Bookmark on Stop} option is set.} - \item [Load Last Bookmark. ] + \item [Load Last Bookmark.] When the \setting{Load Last Bookmark} option is set to \setting{Yes}, Rockbox automatically returns to the position of the last bookmark within a file @@ -49,7 +49,7 @@ or use the \setting{Load Bookmark} function in the Main Menu, while the file is playing, to resume at the bookmarked location. - \item [Maintain a list of Recently Used Bookmarks. ] + \item [Maintain a list of Recently Used Bookmarks.] This list of Most Recent Bookmarks (MRB's) may be accessed through the \setting{Recent Bookmarks} option of the \setting{Bookmarks} sub menu of the @@ -59,7 +59,7 @@ but in addition all older entries for the current (dynamic) playlist will be removed from the MRB whenever a new entry is added. - \item [Bookmark list keys.] The following keys can be used to navigate in + \item [Bookmark list keys.] The following keys can be used to navigate in any bookmark list.\\ \begin{table} \begin{btnmap}{}{} diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex index d06ab81bb..95455df7b 100644 --- a/manual/configure_rockbox/display_options.tex +++ b/manual/configure_rockbox/display_options.tex @@ -3,38 +3,38 @@ \begin{description} - \item[LCD Settings:] + \item[LCD Settings.] This sub menu contains settings that relate to the display of the \dap. \begin{description} \opt{HAVE_BACKLIGHT}{ - \item[Backlight:] + \item[Backlight.] The amount of time the backlight shines after a key press. If set to \setting{Off}, the backlight will not light when a button is pressed. If set to \setting{On}, the backlight will never shut off. If set to a time (1 to 90 seconds), the backlight will stay lit for that amount of time after a button press. - \item[Backlight (While Plugged In):] + \item[Backlight (While Plugged In).] This setting is equivalent to the \setting{Backlight} setting except it applies when the \dap{} is plugged into the charger. - \item[Backlight on Hold:] + \item[Backlight on Hold.] This setting controls the behavior of the backlight when the Hold switch is toggled. If set to \setting{Normal} the backlight will behave as usual. If set to \setting{Off} the backlight will be turned off immediately when the Hold switch is engaged and if set to \setting{On} the backlight will be turned on and stay on while the Hold switch is engaged. - \item[Caption Backlight:] + \item[Caption Backlight.] This option turns on the backlight a number of seconds before the start of a new track, and keeps it on for the same number of seconds after the beginning so that the display can be read to see song information. The amount of time is determined by the value of the backlight timeout setting, but is no less than 5 seconds. \opt{backlight_fade_int}{ - \item[Backlight Fade In:] + \item[Backlight Fade In.] The amount of time that the backlight will take to fade from off to on after a button is pressed. If set to \setting{Off} the backlight will turn on immediately, with no fade in. Can also be set to \setting{500ms}, \setting{1s} or \setting{2s}. - \item[Backlight Fade Out:] + \item[Backlight Fade Out.] Like Backlight fade in, this controls the amount of time that the backlight will take to fade from on to off after a button is pressed. If set to \setting{Off} the backlight will turn off immediately, with no @@ -42,22 +42,22 @@ \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or \setting{10s}. } \opt{backlight_fade_bool}{ - \item[Backlight Fade In:] + \item[Backlight Fade In.] This options turns on smooth backlight fading when the backlight is turning on. The fading time may dependent on the brightness level you have chosen. If it is turned off, the backlight will turn on immediately. - \item[Backlight Fade Out:] + \item[Backlight Fade Out.] This options turns on smooth backlight fading when the backlight is turning off. The fading time may dependent on the brightness level you have chosen. If it is turned off, the backlight will turn off immediately. } - \item[First Keypress Enables Backlight Only:] + \item[First Keypress Enables Backlight Only.] With this option enabled the first keypress while the backlight is turned off will only turn the backlight on without having any other effect. When disabled the first keypress will \emph{also} perform its appropriate action. \opt{lcd_sleep}{ - \item[Sleep (After Backlight Off):] + \item[Sleep (After Backlight Off).] This setting controls how long rockbox will wait before turning off the display after the backlight is turned off. Turning off the display saves a little bit of battery power but turning on the display takes @@ -65,25 +65,25 @@ } \opt{backlight_brightness}{ - \item[Brightness:] + \item[Brightness.] Changes the brightness of your LCD display. } } % \opt{HAVE_BACKLIGHT} \opt{archos,h100,ipodmini,ipod3g,ipod4g,x5}{ - \item[Contrast:] + \item[Contrast.] Changes the contrast of your LCD display. \warn{Setting the contrast too dark or too light can make it hard to find this menu option again!} } % \opt{archos,h100,ipodmini,ipod4g,x5} \opt{lcd_invert}{ - \item[LCD Mode:] + \item[LCD Mode.] This setting lets you invert the colours of the display. } \opt{lcd_flip}{ - \item[Upside Down:] + \item[Upside Down.] Displays the screen so that the top of the display is nearest the buttons. This is sometimes useful when carrying the \dap{} in a pocket for easy access to the headphone socket. @@ -91,68 +91,68 @@ \end{description} % \opt{HAVE_REMOTE_LCD}{ - \item[Remote-LCD Settings:] + \item[Remote-LCD Settings.] This sub menu contains settings that relate to the display of the remote. \begin{description} - \item[Backlight:] + \item[Backlight.] Similar to the main unit backlight this option controls the backlight timeout for the remote control. The remote backlight is independent from the main unit backlight. - \item[Backlight on When Plugged:] + \item[Backlight on When Plugged.] This controls the backlight when the \dap\ is plugged into the charger. - \item[Caption Backlight:] + \item[Caption Backlight.] This option turns on the backlight a number of seconds before the start of a new track, and keeps it on for the same number of seconds after the beginning so that the display can be read to see song information. The amount of time is determined by the value of the backlight timeout setting, but is no less than 5 seconds. - \item[First Keypress Enables Backlight Only:] + \item[First Keypress Enables Backlight Only.] This controls what happens when you press a button on your remote while the backlight is turned off. Like for the main unit, if this setting is set to \setting{Yes}, the first keypress will light up the remote backlight, but have no other effect. If set to \setting{No}, the first keypress will light up the remote backlight \emph{and} engage the function of the key that is pressed. - \item[Contrast:] + \item[Contrast.] Changes the contrast of your remote's LCD display. \warn{Setting the contrast too dark or too light can make it hard to find this menu option again!} - \item[LCD Mode:] + \item[LCD Mode.] This setting lets you invert the whole screen, so now you get a black background and light text and graphics. - \item[Upside Down:] + \item[Upside Down.] Displays the screen so that the top of the display is nearest the buttons. This is sometimes useful when carrying the \dap\ in a pocket for easy access to the headphone socket. \opt{h100,h300}{ - \item[Reduce Ticking:] + \item[Reduce Ticking.] Enable this option if you can hear a ticking sound in your headphones when using your remote. } \end{description} } % - \item[Scrolling] + \item[Scrolling.] This feature controls how text will scroll in Rockbox. You can configure the following parameters: \begin{description} - \item[Scroll Speed:] + \item[Scroll Speed.] Sets how many times per second the automatic horizontal scrolling text will move a step. - \item[Scroll Start Delay:] + \item[Scroll Start Delay.] Controls how many milliseconds Rockbox should wait before a new text begins automatically scrolling. \opt{lcd_bitmap}{ - \item[Scroll Step Size:] + \item[Scroll Step Size.] Defines the number of pixels the text should move for each step, as used by the Scroll Speed setting. } \opt{HAVE_REMOTE_LCD}{ - \item[Remote Scrolling Options:] + \item[Remote Scrolling Options.] The options here have the same effect on the remote LCD as the options mentioned above have on the main LCD. } - \item[Bidirectional Scroll Limit:] + \item[Bidirectional Scroll Limit.] Rockbox has two different automatic horizontal scrolling methods: 1) always scrolling the text to the left until the line has ended and then beginning again at the start, and 2) moving to the left until you can read the end of @@ -161,7 +161,7 @@ scroll to the left. This setting lets you tell Rockbox where that limit is, expressed in percentage of the line length. \opt{lcd_bitmap}{ - \item[Screen Scrolls Out of View:] + \item[Screen Scrolls Out of View.] Screens can be manually scrolled horizontally by pressing \opt{recorder,recorderv2fm}{\ButtonOn+\ButtonRight/\ButtonLeft} \opt{ondio}{\ButtonMenu+\ButtonRight/\ButtonLeft} @@ -172,50 +172,50 @@ will keep the list entries at their fixed positions and allow them to be scrolled out of view, whereas \setting{No} will only scroll those entries which surpass the right margin. - \item[Screen Scroll Step Size:] + \item[Screen Scroll Step Size.] Defines the number of pixels the horizontal manual screen scroll should move for each step. } \opt{player}{ - \item[Jump Scroll:] + \item[Jump Scroll.] This setting makes text scroll a page at a time instead of a character at a time. If set to \setting{One time}, \setting{2}, \setting{3} or \setting{4} it will scroll a line in paged mode that many times and then scroll it a character at a time. If set to \setting{Always} lines will always scroll in paged mode. - \item[Jump Scroll Delay:] + \item[Jump Scroll Delay.] Controls how long the delay is before a page is scrolled. } - \item[Paged Scrolling:] + \item[Paged Scrolling.] When set to \setting{Yes} scrolling vertically on pages that surpass the screen size will page up/down instead of simply changing lines. This can be useful on slow displays. \end{description} % \opt{lcd_bitmap}{ - \item[Peak Meter:] + \item[Peak Meter.] The peak meter can be configured with a number of parameters. \begin{description} - \item[Peak Release:] + \item[Peak Release.] This determines how fast the bar shrinks when the music becomes softer. Lower values make the peak meter look smoother. Expressed in scale units per 10ms. - \item[Peak Hold Time:] + \item[Peak Hold Time.] Specifies the time after which the peak indicator will reset. For example, if you set this value to 5s, the peak indicator displays the loudest volume value that occurred within the last 5 seconds. Larger values are useful if you want to find the peak level of a song, which might be of interest when copying music from the \dap\ via the analogue output to some other recording device. - \item[Clip Hold Time:] + \item[Clip Hold Time.] The number of seconds that the clipping indicator will be visible after clipping is detected. \opt{recording}{ - \item[Clip Counter:] + \item[Clip Counter.] Show the number of times the clip indicator went active during recording in front of the peak meters. } - \item[\label{ref:Peakmetersetting}Scale:] + \item[\label{ref:Peakmetersetting}Scale.] Select whether the peak meter displays linear or logarithmic values. The human ear perceives loudness on a logarithmic scale. If the Scale setting is set to \setting{Logarithmic} (dB) scale, the volume values @@ -225,7 +225,7 @@ you should choose \setting{Linear} display. This setting cannot be displayed in units like volts or watts because such units depend on your headphones. - \item[Minimum and maximum range:] + \item[Minimum and maximum range.] These two options define the full value range that the peak meter displays. Recommended values for the \setting{Logarithmic} (dB) setting are {}-40 dB for minimum and 0 dB for maximum. Recommended values @@ -236,7 +236,7 @@ into the peak meter. \end{description} } - \item[\label{ref:Defaultcodepage}Default Codepage:] + \item[\label{ref:Defaultcodepage}Default Codepage.] A codepage describes the way extended characters that are not available within the ASCII character set are encoded. ID3v1 tags do not have a codepage encoding contained so Rockbox needs to know what encoding has diff --git a/manual/configure_rockbox/file_view.tex b/manual/configure_rockbox/file_view.tex index 21dbe4042..b4f8da7b7 100644 --- a/manual/configure_rockbox/file_view.tex +++ b/manual/configure_rockbox/file_view.tex @@ -4,23 +4,23 @@ The File View menu deals with options relating to how the File Browser displays files. % \begin{description} -\item[Sort Case Sensitive:] +\item[Sort Case Sensitive.] If this option is set to \setting{Yes}, all files that start with upper case letters will be listed first, followed by all files that begin with lower case letters. If this option is set to NO, then case will be ignored when sorting files. -\item[Sort Directories:] +\item[Sort Directories.] This option controls how Rockbox sorts directories. The default is to sort them alphabetically. \setting{By date} sorts them with the oldest directory first. \setting{By newest date} sorts them with the newest directory first. -\item[Sort Files:] +\item[Sort Files.] This option controls how Rockbox sorts files. All of the options for \setting{Sort Directories} are available in this option. In addition, there is a \setting{By type} option which sorts files alphabetically by their type (such as \fname{.mp3}) then alphabetically within each type. -\item[Interpret numbers when sorting:] +\item[Interpret numbers when sorting.] \setting{As whole numbers} enables a sorting algorithm which is similar to the default sorting of, for example, Windows Explorer, Mac OS X's Finder or Nautilus, with regards to numbers at the beginning or within filenames. @@ -42,36 +42,36 @@ displays files. \end{table} -\item[\label{ref:ShowFiles}Show Files:] +\item[\label{ref:ShowFiles}Show Files.] This option controls which files are displayed in the File Browser. % \begin{description} - \item[All:] The \setting{File Browser} displays all files and directories. + \item[All.] The \setting{File Browser} displays all files and directories. Extensions are shown. No files or directories are hidden. - \item[Supported:] The \setting{File Browser} displays all directories and + \item[Supported.] The \setting{File Browser} displays all directories and files supported by Rockbox (see \reference{ref:Supportedfileformats}). Files and directories starting with \fname{.} (\emph{dot}) or with the \emph{hidden} flag set are hidden. - \item[Music:] The \setting{File Browser} displays only directories, playlists and + \item[Music.] The \setting{File Browser} displays only directories, playlists and the supported \emph{audio} file formats. Extensions are stripped. Files and directories starting with \fname{.} or with the ``hidden'' flag set are hidden. - \item[Playlists:] The \setting{File Browser} displays only directories and playlists, + \item[Playlists.] The \setting{File Browser} displays only directories and playlists, for simplified navigation. \end{description} -\item[\label{ref:ShowExtensions}Show Filename Extensions:] +\item[\label{ref:ShowExtensions}Show Filename Extensions.] This option controls how file extensions are shown in the File Browser. % \begin{description} - \item[Off:] The file extensions are never shown. - \item[On:] The file extensions are always shown. - \item[Only unknown types:] Only the extensions of unknown filetypes are shown. - \item[Only when viewing all types:] Only show file extensions when + \item[Off.] The file extensions are never shown. + \item[On.] The file extensions are always shown. + \item[Only unknown types.] Only the extensions of unknown filetypes are shown. + \item[Only when viewing all types.] Only show file extensions when \setting{Show Files} is set to \setting{All}. \end{description} -\item[Follow Playlist:] +\item[Follow Playlist.] This option determines what directory the \setting{File Browser} displays first. If \setting{Follow Playlist} is set to \setting{Yes}, when you enter the \setting{File Browser} from the WPS, you will find yourself in the same @@ -80,7 +80,7 @@ displays files. will find yourself in the directory you were in when you last left the \setting{File Browser}. -\item[Show Path:] +\item[Show Path.] If this setting is set to \setting{Full Path} the full path to the current directory will be displayed on the first line in the \setting{File Browser}. If set to \setting{Current Directory Only} only the name of the current diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex index e34fc8734..c40fd4fb7 100644 --- a/manual/configure_rockbox/playback_options.tex +++ b/manual/configure_rockbox/playback_options.tex @@ -16,22 +16,22 @@ you to configure settings related to audio playback. \setting{A-B}: \begin{description} % - \item[Off]The current playlist will not repeat when it is finished. + \item[Off.] The current playlist will not repeat when it is finished. \note{If you have the \setting{Auto-Change Directory} option set to \setting{Yes}, Rockbox will move on to the next directory on your hard drive. If the \setting{Auto-Change Directory} option is set to \setting{No}, playback will stop when the current directory or playlist is finished.} % - \item[All]The current playlist will repeat when it is finished. + \item[All.] The current playlist will repeat when it is finished. % - \item[One]Repeat one track over and over. + \item[One. ]Repeat one track over and over. % - \item[Shuffle]When the current playlist has finished playing, it will + \item[Shuffle.] When the current playlist has finished playing, it will be shuffled and then repeated. % - \item[A-B]Repeats between two user defined points within a track, + \item[A-B.] Repeats between two user defined points within a track, typically used by musicians when attempting to learn a piece of music. This option is more complicated to use than the others as the \dap\ must first be placed into A-B repeat mode and then the start and end @@ -105,7 +105,7 @@ you to configure settings related to audio playback. Options for crossfade settings are: \begin{description} - \item[Enable Crossfade]If set to \setting{Off}, crossfade is disabled. + \item[Enable Crossfade.] If set to \setting{Off}, crossfade is disabled. If set to \setting{Shuffle}, crossfade is enabled when the shuffle feature is set to \setting{Yes}, but disabled otherwise. If set to \setting{Track Skip Only}, tracks will only crossfade when manually @@ -114,21 +114,21 @@ you to configure settings related to audio playback. \setting{Yes} and the track is manually skipped. If set to \setting{Always}, tracks will always crossfade into one another. % - \item[Fade In Delay]The ``fade in delay'' is the length of time between + \item[Fade In Delay.] The ``fade in delay'' is the length of time between when the crossfade process begins and when the new track begins to fade in. % - \item[Fade In Duration]The length of time, in seconds, that it takes + \item[Fade In Duration.] The length of time, in seconds, that it takes your music to fade in once the \setting{Fade In Delay} has ended. % - \item[Fade Out Delay]The ``fade out delay'' is the length of time + \item[Fade Out Delay.] The ``fade out delay'' is the length of time between when the crossfade process begins and when the old track begins to fade out. % - \item[Fade Out Duration]The length of time, in seconds, that it takes + \item[Fade Out Duration.] The length of time, in seconds, that it takes your music to fade out once the \setting{Fade Out Delay} has ended. % - \item[Fade Out Mode]If set to \setting{Crossfade}, one song will fade + \item[Fade Out Mode.] If set to \setting{Crossfade}, one song will fade out and the next song will simultaneously fade in. If set to \setting{Mix}, the ending song will continue to play as normal until its end, while the starting song will fade in from under it. @@ -158,30 +158,30 @@ you to configure settings related to audio playback. Options for replaygain are: \begin{description} - \item[Replaygain Type]Choose the type of replaygain to apply: + \item[Replaygain Type.] Choose the type of replaygain to apply: \begin{description} - \item[Album Gain]Maintain a constant volume level between + \item[Album Gain.] Maintain a constant volume level between albums, but keep any intentional volume variations between songs in an album. (If album gain value is not available, uses track gain information). % - \item[Track Gain]Maintain a constant volume level between + \item[Track Gain.] Maintain a constant volume level between tracks. If track gain value is not available, no replaygain is applied. % - \item[Track Gain If Shuffling]Maintains a constant volume + \item[Track Gain If Shuffling.] Maintains a constant volume between tracks if \setting{Shuffle} is set to \setting{Yes}. Reverts to album mode if \setting{Shuffle} is set to \setting{No}. % - \item[Off]Do not process replaygain information, i.e. turn off + \item[Off.] Do not process replaygain information, i.e. turn off the replaygain function. \end{description} % - \item[Prevent Clipping]Avoid clipping of a song's waveform. + \item[Prevent Clipping.] Avoid clipping of a song's waveform. If a song would clip during playback, the volume is lowered for that song. Replaygain information is needed for this to work. % - \item[Pre-amp]This allows you to adjust the volume when replaygain + \item[Pre-amp.] This allows you to adjust the volume when replaygain is applied. Replaygain often lowers the volume, sometimes quite much, so here you can compensate for that. Please note that a (large) positive pre-amp setting can cause clipping, unless @@ -225,7 +225,7 @@ you to configure settings related to audio playback. socket. % \begin{description} - \item[Pause on Headphone Unplug]Options for automatic pause: + \item[Pause on Headphone Unplug.] Options for automatic pause: \begin{description} \item[Off.] Disables automatic pause. % @@ -234,10 +234,10 @@ you to configure settings related to audio playback. \item[Pause and Resume.] Pauses when the headphones are removed, and resumes playback when they are reconnected. \end{description} - \item[Duration to Rewind] Number of seconds (between 0 and 15) to rewind + \item[Duration to Rewind.] Number of seconds (between 0 and 15) to rewind playback when the headphones are removed. % - \item[Disable Auto-Resume If Phones Not Present] This option will disable + \item[Disable Auto-Resume If Phones Not Present.] This option will disable the automatic resumption of playback at startup if the headphones are not connected to the \dap{}. \note{This requires \setting{Resume on Startup} to be enabled.} diff --git a/manual/configure_rockbox/playlist_options.tex b/manual/configure_rockbox/playlist_options.tex index 880d0c635..35a2648f7 100644 --- a/manual/configure_rockbox/playlist_options.tex +++ b/manual/configure_rockbox/playlist_options.tex @@ -3,12 +3,12 @@ The \setting{Playlist} sub menu allows you to configure settings related to playlists. \begin{description} -\item[Recursively Insert Directories. ] +\item[Recursively Insert Directories.] If set to \setting{On}, then when a directory is inserted or queued into a dynamic playlist, all subdirectories will also be inserted. If set to \setting{Ask}, Rockbox will prompt the user about whether to include sub-directories. -\item[Warn When Erasing Dynamic Playlist. ] +\item[Warn When Erasing Dynamic Playlist.] If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to take an action that will cause Rockbox to erase the current dynamic playlist. \end{description} diff --git a/manual/configure_rockbox/recording_settings.tex b/manual/configure_rockbox/recording_settings.tex index 67be4f254..2c9847a7a 100644 --- a/manual/configure_rockbox/recording_settings.tex +++ b/manual/configure_rockbox/recording_settings.tex @@ -99,24 +99,24 @@ is only the time required to stop and restart the recording, on the order of 2 -- 4 seconds. \begin{description} - \item[Split Measure:] + \item[Split Measure.] This option controls wether to split the recording when the \setting{Split Filesize} is reached or when the \setting{Split Time} has elapsed. - \item[What to do when Splitting:] + \item[What to do when Splitting.] This controls what will happend when the splitting condition is fullfilled the two available options here are \setting{Start a new file} or \setting{Stop recording}. - \item[Split Time:] + \item[Split Time.] Set the time to record between each split, if time is used as \setting{Split Measure}.\\ Options (hours:minutes between splits): Off, 00:05, 00:10, 00:15, 00:30, 1:00, 1:14 (74 minute CD), 1:20 (80 minute CD), 2:00, 4:00, 8:00, 10:00, 12:00, 18:00, 24:00. - \item[Split Filesize:] + \item[Split Filesize.] Set the filesize to record between each split, if filesize is used as \setting{Split Measure}. @@ -154,7 +154,7 @@ the show to verify his amp is turned on. The trigger features numerous parameters to adapt its behaviour to the desired situation. \begin{description} - \item[Trigger] + \item[Trigger.] This parameter specifies the trigger mode. When set to \setting{Off} the recording must be started manually and apart from the Prerecord time no other parameter has any effect. \setting{Once} will have the trigger start @@ -162,11 +162,11 @@ not start another recording. \setting{Repeat} will have the trigger start multiple recordings. - \item[Trigtype] + \item[Trigtype.] \fixme{Add description of Trigtype} Options: \setting{Stop}, \setting{Pause}, \setting{New File}. - \item[Prerecord Time] + \item[Prerecord Time.] This specifies the time that is included into the recording before the trigger event occurs. This is very useful if you record a signal that fades in. Usually you want to set the prerecord time >= start duration. That @@ -174,7 +174,7 @@ time is not a special parameter of the trigger. It is available during normal recordings too. - \item[Start Above] + \item[Start Above.] The start threshold defines the minimal volume a sound must have to start the recording. It is displayed numerically in the line "Start Above". Note that the unit of the threshold depends on the settings of the peak meter. (i.e. @@ -189,7 +189,7 @@ you record via a digital input as even the noise of the device itself would exceed this threshold immediately. - \item[for at least] + \item[for at least.] The start duration defines the minimal duration that a signal must exceed the start threshold to start the recording. Depending on your situation you may want to set this setting to 0 (e.g. when copying a song from a commercial @@ -197,7 +197,7 @@ (think of percussion) neglectable dropouts are tolerated during this start duration. - \item[Stop Below] + \item[Stop Below.] When the sound level drops below the stop threshold the recording is stopped. It is displayed numerically in the line "Stop Below". Just like the start threshold the unit of the stop threshold depends on the settings of the peak @@ -206,12 +206,12 @@ left. The value \setting{Off} turns the stop condition off. With this setting you have to stop the recording manually. - \item[for at least] + \item[for at least.] This time specifies the duration the signal must drop below the stop threshold to stop the recording. By selecting high values you can ensure that, for example, trailing fade-outs are recorded entirely. - \item[Presplit Gap] + \item[Presplit Gap.] When the signal drops below the stop threshold for the time specified by the presplit gap a new recording may be started when the signal raises above the start threshold. Thus the value of the presplit gap should be smaller than @@ -233,24 +233,24 @@ More information can be found at \wikilink{VolumeTriggeredRecording}. The \setting{Automatic Gain Control} has five different presets for automatically controlling the gain while recording. \begin{description} - \item[Safety (clip):] + \item[Safety (clip).] This preset will lower the gain when the levels get too high (-1dB) and will never increase gain. - \item[Live (slow):] + \item[Live (slow).] This preset is designed to be used for recording of live shows and has quite large headroom for loud parts. It heads for a nominal target peak level of -9dB and will slowly increase or decrease gain to reach it. - \item[DJ-Set (slow):] + \item[DJ-Set (slow).] This preset heads for a nominal target peak level of -5dB and will slowly increase or decrease gain to reach it. - \item[Medium:] + \item[Medium.] This preset heads for a nominal target peak level of -6dB and will increase or decrease gain to reach it. - \item[Voice (fast):] + \item[Voice (fast).] This preset is designed to be used for voice recording and heads for a nominal target peak level of -7dB and will quickly increase or decrease gain to reach it. diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex index c24b38a89..fc93070b9 100644 --- a/manual/configure_rockbox/sound_settings.tex +++ b/manual/configure_rockbox/sound_settings.tex @@ -167,21 +167,21 @@ change to customise your listening experience. The MDB parameters are as follows: % \begin{description} - \item[MDB enable:] + \item[MDB enable.] This turns the MDB feature on or off. For many users this will be the only setting they need, since Rockbox picks sensible defaults for the other parameters. MDB is turned off by default. - \item[MDB strength:] + \item[MDB strength.] How loud the harmonics generated by MDB will be. - \item[MDB Harmonics:] + \item[MDB Harmonics.] The percentage of the low notes that is converted into harmonics. If low notes are causing speaker distortion, this can be set to 100\% to eliminate the fundamental completely and only produce harmonics in the signal. If set to 0\% this is the same as turning the MDB feature off. - \item[MDB Centre Frequency:] + \item[MDB Centre Frequency.] The cutoff frequency of your headphones or speakers. This is usually given in the specification for the headphones/speakers. - \item[MDB shape:] + \item[MDB shape.] It is recommended that this parameter be set to 1.5 times the centre frequency. This is the frequency up to which harmonics are generated. Some of the @@ -235,19 +235,19 @@ change to customise your listening experience. Crossfeed has the following settings: \begin{description} - \item[Crossfeed:] + \item[Crossfeed.] Selects whether the crossfeed effect is to be enabled or not. - \item[Direct Gain:] + \item[Direct Gain.] How much the level of the audio that travels the direct path from a speaker to the corresponding ear is supposed to be decreased. - \item[Cross Gain:] + \item[Cross Gain.] How much the level of the audio that travels the cross path from a speaker to the opposite ear is to be decreased. - \item[High-Frequency Attenuation:] + \item[High-Frequency Attenuation.] How much the upper frequencies of the cross path audio will be dampened. Note that the total level of the higher frequencies will be a combination of both this setting and the \setting{Cross Gain} setting. - \item[High-Frequency Cutoff] + \item[High-Frequency Cutoff.] Decides at which frequency the cross path audio will start to be cut by the amount described by the \setting{High-Frequency Attenuation} setting. @@ -273,7 +273,7 @@ change to customise your listening experience. Rockbox's parametric EQ is composed of five different bands: \begin{description} - \item[Band 0: Low shelf filter] + \item[Band 0: Low shelf filter.] The low shelf filter boosts or lowers all frequencies below a certain frequency limit, much like what a ``bass'' control found on ordinary stereo systems does. @@ -287,7 +287,7 @@ change to customise your listening experience. The ``Q'' parameter should always be set to 0.7 for the shelving filters. Higher values will add a small boost around the cutoff frequency that is almost always undesirable. - \item[Bands 1-3: Peaking filters] + \item[Bands 1-3: Peaking filters.] Peaking EQ filters boost or lower a frequency range centered at the center frequency chosen. Graphic equalizers in home stereos are usually peaking @@ -301,7 +301,7 @@ change to customise your listening experience. frequency range is. Higher Q values will affect a narrower band of frequencies, while lower Q values will affect a wider band of frequencies. - \item[Band 4: High shelf filter] + \item[Band 4: High shelf filter.] A high shelf filter boosts or lowers all frequencies above a certain frequency limit, much like what a ``treble'' control found on ordinary stereo systems does. @@ -313,10 +313,10 @@ change to customise your listening experience. through 3 should be used for mids, and EQ band 4 should be used for highs. \begin {description} - \item[Enable EQ:] + \item[Enable EQ.] This option controls whether the EQ is on or off. - \item[Graphical EQ:] + \item[Graphical EQ.] This option brings up a graphic EQ screen, which allows adjustment of each of the three parameters described above (gain, center frequency, and Q) for each of the five EQ bands. @@ -377,27 +377,27 @@ change to customise your listening experience. \end{btnmap} \end{table} - \item[Pre-cut:] + \item[Pre-cut.] If too much gain is added through the graphical EQ, your music may distort. The \setting{Precut} setting allows you to adjust the overall gain of the EQ. If your music distorts when using the EQ, trying changing this setting to a negative value. -\item[Simple EQ:] +\item[Simple EQ.] This option provides an easier alternative for those who are daunted by all of the parameters that can be adjusted using the graphical EQ. With the \setting{Simple EQ}, the only parameter that can be adjusted is the gain. -\item[Advanced EQ:] +\item[Advanced EQ.] This sub menu provides options for adjusting the same parameters as the \setting{Graphical EQ}. The only difference is that the parameters are adjusted through textual menus rather than through a graphic interface. -\item[Save EQ Preset:] +\item[Save EQ Preset.] This option saves the current EQ configuration in a \fname{.cfg} file. -\item[Browse EQ Presets:] +\item[Browse EQ Presets.] This menu displays a list of EQ presets, as well as any EQ configurations saved using the \setting{Save EQ Preset} option. Users unfamiliar with the operation of a parametric EQ may wish to use the presets instead of trying to @@ -459,4 +459,4 @@ Think of this as a smart volume control. The preamp in effect turns up the volu amount you select so that you can hear quiet passages. But it senses when a loud section is about to play and quickly and smoothly lowers the volume as necessary to keep the audio under the maximum limit. As the loud section fades, the volume is turned back up. -} \ No newline at end of file +} diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex index da41d2ddd..8240c96f1 100644 --- a/manual/configure_rockbox/system_options.tex +++ b/manual/configure_rockbox/system_options.tex @@ -13,7 +13,7 @@ Options relating to the \opt{archos}{batteries}\nopt{archos}{battery} in the \dap. \begin{description} - \item [Battery Capacity: ]This setting can be used to tell Rockbox what + \item [Battery Capacity.] This setting can be used to tell Rockbox what capacity (in mAh) the battery being used has. The default is \opt{player,recorder}{1500mAh}% \opt{recorderv2fm}{2200mAh}% @@ -44,12 +44,12 @@ determine battery life.} \opt{battery_types}{ - \item [Battery Type: ]This setting tells Rockbox which type of battery + \item [Battery Type.] This setting tells Rockbox which type of battery is currently used in the \dap{}. The two supported battery types are ``Alkaline'' or ``NiMH''.} \opt{usb_charging}{ - \item [Charge During USB Connection: ]This option lets you control whether + \item [Charge During USB Connection.] This option lets you control whether the \dap{} should charge during the USB connection and hence draw the full 500mA. Turning it \setting{Off} is recommended if the dap{} is connected through an unpowered USB hub or a laptop port. @@ -63,7 +63,7 @@ \begin{description} \opt{HAVE_DISK_STORAGE}{ - \item [Disk Spindown: ]Rockbox has a timer that makes it spin down the + \item [Disk Spindown.] Rockbox has a timer that makes it spin down the hard disk after it is idle for a certain amount of time. This setting controls the amount of time between the last user activity and the time that the disk spins down. This idle time is only affected by user @@ -73,7 +73,7 @@ } \opt{dircache}{ - \item [Directory Cache: ]Rockbox has the ability to cache the contents of + \item [Directory Cache.] Rockbox has the ability to cache the contents of your drive in RAM. The \setting{Directory Cache} takes a small amount of memory away from Rockbox that would otherwise be used to buffer music, but it speeds up navigation in the file browser by eliminating @@ -102,14 +102,14 @@ available. \subsection{Limits} This sub menu relates to limits in the Rockbox operating system. \begin{description} - \item [Max Entries in File Browser: ]This setting controls the limit on + \item [Max Entries in File Browser.] This setting controls the limit on the number of files that you can put in any particular directory in the file browser. You can configure the size to be between 50 and 10,000 files in steps of 50. The default is 400. Higher values will shorten the music buffer, so you should increase this setting \emph{only} if you have directories with a large number of files. - \item [Max Playlist Size: ]This setting controls the maximum size of + \item [Max Playlist Size.] This setting controls the maximum size of a playlist. The playlist size can be between 1,000 and 32,000 files, in steps of 1,000 (default is 10,000). Higher values will shorten the music buffer, so you should increase this setting \emph{only} if you @@ -132,7 +132,7 @@ This sub menu relates to limits in the Rockbox operating system. This option turns \setting{On} and \setting{Off} the car ignition auto stop function. \begin{description} - \item [Car Adapter Mode: ]When using the \dap{} in a car, + \item [Car Adapter Mode.] When using the \dap{} in a car, \setting{Car Adapter Mode} automatically stops playback on the \dap{} when power (i.e. from cigarette lighter power adapter) to the external DC in jack is turned off. If the \setting{Car Adapter Mode} is set to \setting{On}, @@ -216,7 +216,7 @@ this option \setting{On}. If it is not required, then turning this setting The following modes are available: \begin{description} - \item [Multimedia: ]This mode lets you control the volume, playback, and + \item [Multimedia.] This mode lets you control the volume, playback, and skips tracks on the host computer. It is equivalent for the multimedia keys found on top of some multimedia keyboards. \begin{table} @@ -284,7 +284,7 @@ this option \setting{On}. If it is not required, then turning this setting \end{btnmap} \end{table} - \item [Presentation: ]This mode lets you control a presentation program + \item [Presentation.] This mode lets you control a presentation program (e.g. OpenOffice Impress, and some other popular application), making the \dap{} a wired remote control device. This mode is can be useful for lecturers who does not have a wireless remote control for this @@ -376,7 +376,7 @@ this option \setting{On}. If it is not required, then turning this setting \end{btnmap} \end{table} - \item [Browser: ]This mode lets you control a web browser (e.g. Firefox). + \item [Browser.] This mode lets you control a web browser (e.g. Firefox). It uses the \dap{}'s keys to navigate through the web page and different tabs, navigate through history, and to control zoom. \begin{table} @@ -467,7 +467,7 @@ this option \setting{On}. If it is not required, then turning this setting \end{table} {\opt{usb_hid_mouse}{ - \item [Mouse: ]This mode emulates a mouse. Features supported: Mouse + \item [Mouse.] This mode emulates a mouse. Features supported: Mouse movement; left and right button clicking; and dragging and dropping. \begin{table} \begin{btnmap}{}{} diff --git a/manual/configure_rockbox/theme_settings.tex b/manual/configure_rockbox/theme_settings.tex index 5db6013a3..feab3b37c 100644 --- a/manual/configure_rockbox/theme_settings.tex +++ b/manual/configure_rockbox/theme_settings.tex @@ -80,35 +80,35 @@ customize the visual apperance of Rockbox. } \opt{lcd_non-mono}{% - \item[Clear Backdrop:] + \item[Clear Backdrop.] Rockbox allows you to select bitmap pictures to use as backdrops, see \reference{ref:LoadingBackdrops} for further information. This option allows you to clear the backdrops that you set. } % \opt{lcd_bitmap}{ - \item[Status/Scrollbar:] + \item[Status/Scrollbar.] Settings related to on screen status display and the scrollbar. \begin{description} - \item[Scroll Bar:] Allows you to choose where the vertical scroll bar + \item[Scroll Bar.] Allows you to choose where the vertical scroll bar should appear. - \item[Scroll Bar Width:] Allows you to choose the width of the + \item[Scroll Bar Width.] Allows you to choose the width of the scroll bar (in pixels). Default value is 6. - \item[Status Bar:] Allows you to choose where to display the + \item[Status Bar.] Allows you to choose where to display the statusbar\opt{remote}{ on the main display}. \opt{remote}{ - \item[Remote Status Bar:] Allows you to choose where to display the + \item[Remote Status Bar.] Allows you to choose where to display the statusbar on the remote display. } \opt{RECORDER_PAD}{ - \item[Button Bar:] Enables or disables the button bar prompts for the + \item[Button Bar.] Enables or disables the button bar prompts for the ``F''-keys at the bottom of the screen. } - \item[Volume Display:] Controls whether the volume is displayed as a + \item[Volume Display.] Controls whether the volume is displayed as a graphic or a numeric value on the Status Bar. If you select a numeric display, volume is displayed in decibels. See \reference{ref:volume} for more on the volume setting. - \item[Battery Display:] Controls whether the battery charge status is + \item[Battery Display.] Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar. \end{description} } @@ -117,15 +117,15 @@ customize the visual apperance of Rockbox. \item[Line Selector Type.] This option allows you to select which type of line selector to use. \begin{description} - \item[Pointer:] + \item[Pointer.] A small arrow to the left of the menu text. - \item[Bar (inverse):] + \item[Bar (inverse).] A bar with inverted foreground and background colour. \opt{lcd_color}{ - \item[Bar (Solid Colour):] + \item[Bar (Solid Colour).] A bar with a solid colour, the colour is set in the \setting{Colours} submenu. - \item[Bar (Gradient Colour):] + \item[Bar (Gradient Colour).] A bar with a colour gradient, the colours are set in the \setting{Colours} submenu. } @@ -139,21 +139,21 @@ customize the visual apperance of Rockbox. \item[Line Selector Colours.] These options sets the colours for the line selector bars. \begin{description} - \item[Primary Colour:] + \item[Primary Colour.] Set the primary colour used for the gradient line selector bar and the colour used for the solid color line selector bar. - \item[Secondary Colour:] + \item[Secondary Colour.] Set the secondary colour used for the gradient line selector bar. - \item[Text Colour:] + \item[Text Colour.] Set the colour of the selected text when using the solid colour or the gradient colour line selection bars. \end{description} - \item[Background Colour:] + \item[Background Colour.] Sets the background colour for the display. - \item[Foreground Colour:] + \item[Foreground Colour.] Sets the colour used for text and icons. - \item[Reset Colours:] + \item[Reset Colours.] Resets the LCD display to Rockbox's default colours. \end{description} }% lcd_color -- 2.11.4.GIT