Fix another fixme: rework of the split editor chapter in the Archos manuals. If someone knows how to impelement the explained screenshot in a cleaner way that works with both pdf and html version, feel free to improve.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@14676 a1c6a512-1295-4272-9138-f99709370657

manual/configure_rockbox/display_options.tex

@@ -248,7 +248,7 @@
           Show the number of times the clip indicator went active during
           recording in front of the peakmeters.
       }
-      \item[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

manual/plugins/split_editor.tex

@@ -1,142 +1,155 @@
 \subsection{Split Editor}
-\fixme{This chapter has to be rewritten, to fit in the multi-platform latex
+
-source code that we currently use}
 When recording an mp3 file, it is common practice to start the recording
 a little bit early and stop it a little bit late to ensure all the
-desired sound is recorded. This results in recordings that contains
+desired sound is recorded. This results in recordings that contain
 extra snippets of sound in the beginning and the end. Unfortunately these
 snippets can not be deleted easily because they are stored in the same
 file as the desired recording. The purpose of the split editor is to
-split a mp3 file (the input file) at a point in time (split point). Two
+split an mp3 file (the input file) at a point in time (split point). Two
 new files can be generated from the input file. The first file contains
 the part before the split point and the second file contains the part
 after the split point. Once this process has been successful the
-original file can be deleted or kept as a backup. 
+original file can be deleted or kept as a backup. %
-
+%
-The whole process of splitting a mp3 file consists of three steps: 
+The whole process of splitting an mp3 file consists of three steps:
-
+%
-\begin{enumerate}
-\item defining the split point 
-\item generating the result files. 
-\item if desired delete the input file (with the browser, not the split
-editor) 
-\end{enumerate}
-
-\subsubsection{How to use the Split Editor}
-
 \begin{itemize}
-\item \textbf{Pause near the split point}
+  \item Defining the split point
-When the device plays the song just hit the PAUSE button, when playback
+  \item Generating the result files
-has roughly reached the split point. This need not be very precise as
+  \item If desired deleting the input file (with the browser, not the split editor)
-the split point can be fine tuned later.
+\end{itemize}
-\item \textbf{Open the split editor}
 
-Open the plugin.  A screen similar to the one below will appear. 
+\subsubsection{How To Use The Split Editor}
+  When the device plays the song just hit the \ActionWpsPlay{} button
+  to pause, when playback has roughly reached the split point. This need
+  not be very precise as the split point can be fine tuned later. A screen
+  similar to the one below will appear.
 
-{\centering\itshape
+  \begin{figure}[H]
-  [Warning: Image ignored] % Unhandled or unsupported graphics:
+    \begin{center}
-%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img67.gif}
+      \includegraphics[width=8.0cm]{plugins/images/ss-splitedit-main-112x64x1}
- \newline
+      \caption{The Split Editor's Main Screen}
-The Split Editor
+    \end{center}
-\par}
+  \end{figure}
 
-{\centering\upshape
+\subsubsection{The Split Editor's Main Screen}
-Here is an explanation of the areas marked in red on the screenshot.
+  \begin{description}
-\par}
+    \item[The waveform]
-
+      displays the volume of the song over time. It will appear as the song
-\begin{enumerate}
+      plays and help to visually identify the point in time where the split is
-\item The waveform \newline
+      desired
-\newline
+      %
-The waveform displays the volume of the song over time. It will appear
+    \item[The split point indicator]
-as the song plays and help to visually identify the point in time where
+      is a vertical line with a small triangle at the top end. It is the most
-the split is desired
+      important control element of the split editor. It can be moved with the
-\item The split point indicator\newline
+      \ButtonLeft\ and \ButtonRight\ buttons. Later, when you have fine tuned
-\newline
+      the split point, the song will be split at this position.
-The split point indicator is a vertical line with a small triangle at
+      %
-the top end. It is the most important control element of the split
+    \item[The split time]
-editor. It can be moved with the LEFT and RIGHT buttons. Later, when
-you have fine tuned the split point, the song will be split at this
-position.
-\item The split time\newline
-\newline
       At the top of the window a time value is displayed. This is the point in
       time within the song at which the split point indicator is positioned.
-\item The locator\newline
+      %
-\newline
+    \item[The locator]
       Another vertical bar represents the position locator. It moves along as
       the song plays. In contrast to the split point indicator it has no
       triangles at the ends.
-\item The time bar\newline
+      %
-\newline
+    \item[The time bar]
-The time bar displays the current position within the song relative to
+      displays the current position within the song relative to the whole song.
-the whole song. The entire length of the time bar represents the song
+      The entire length of the time bar represents the song length. The length
-length. The length of the solid part of the time bar represents the position and length
+      of the solid part of the time bar represents the position and length of
-of the displayed part of the song.
+      the displayed part of the song.
-\item The scale mode\newline
+      %
-\newline
+    \item[The scale mode]
-Directly above the F3 button the scale mode is displayed. The waveform
+      On the right side of the bottom line the scale mode is displayed. The
-can be scaled either logarithmically or linearly. In logarithmic scale
+      waveform can be scaled either logarithmically or linearly. In logarithmic
-mode the letters ``dB'' are displayed, in linear mode ``\%''. Use F3 to
+      scale mode the letters ``dB'' are displayed, in linear mode ``\%''. Use
-switch between these modes. Linear mode usually gives better optical
+      \opt{RECORDER_PAD}{\ButtonFThree}
+      \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonRight}
+      to switch between these modes. Linear mode usually gives better optical
       hints with commercially recorded music. For quiet recordings,
       especially of human speech, the logarithmic scale often is preferable.
-\item The loop mode \newline
+      More information in the Scale \reference{ref:Scalemode} below.
-\newline
+      %
-Directly above the F2 button the loop mode icon is displayed. There are
+    \item[The loop mode]
-4 different loop modes. Pressing F2 changes to the next loop mode. 
+      In the middle of the bottom line the loop mode icon is displayed.
-
+      There are 4 different loop modes. Pressing
-\begin{itemize}
+      \opt{RECORDER_PAD}{\ButtonFTwo}
-\item   [Warning: Image ignored] % Unhandled or unsupported graphics:
+      \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonUp}
-%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img68.gif}
+      changes to the next loop mode.
+      %
+      \begin{description}
+        \item
+        \includegraphics[width=0.53cm]{plugins/images/icon-splitedit-loop-1}
           Playback loops around the split point indicator. This mode is best
           used when searching and zooming for the desired point at which to split
           the recording.
-\item   [Warning: Image ignored] % Unhandled or unsupported graphics:
+        \item
-%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img69.gif}
+        \includegraphics[width=0.53cm]{plugins/images/icon-splitedit-loop-2}
           Playback loops from the split point indicator to the end of the
           visible area. This mode is best used when fine tuning the split
           indicator position at the beginning of a recording.
-\item   [Warning: Image ignored] % Unhandled or unsupported graphics:
+        \item
-%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img70.gif}
+        \includegraphics[width=0.53cm]{plugins/images/icon-splitedit-loop-3}
           Playback loops from the beginning of the
           visible area to the split point. This mode is best used when fine
           tuning the split indicator position at the end of a recording.
-\item   [Warning: Image ignored] % Unhandled or unsupported graphics:
+        \item
-%\includegraphics[width=0.688cm,height=0.476cm]{images/rockbox-manual-img71.gif}
+        \includegraphics[width=0.53cm]{plugins/images/icon-splitedit-loop-4}
           Playback doesn't loop, the borders of the visible
           area as well as the split point indicator are ignored. This mode is
           best used when playing the song outside of the borders of the displayed
           region.
-\end{itemize}
+      \end{description}
+    \item[Perform the split (8)]
+          The icon above the
+          \opt{RECORDER_PAD}{\ButtonFOne}
+          \opt{ONDIO_PAD}{\ButtonLeft}
+          button indicates its function to execute the split. When split
+          positioning is complete open the save dialogue with
+          \opt{RECORDER_PAD}{\ButtonFOne}
+          \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonLeft}.
+  \end{description}
 
-\item Perform the split \newline
+  \begin{table}
-\newline
+    \begin{btnmap}{Controls in the split editor}{}
-The icon directly above the F1 button indicates its function to execute
+      \ButtonOff & Quit plugin \\
-the split. When split positioning is complete open the save dialogue with F1.
+      %
-\end{enumerate}
+      \ButtonLeft\ / \ButtonRight &  Move the split point indicator \\
-
+      %
-{\bfseries
+      \ButtonUp\ / \ButtonDown & Zoom in / out \\
-Controls in the split editor }
+      %
-\end{itemize}
+      \opt{RECORDER_PAD}{\ButtonPlay}
-
+      \opt{ONDIO_PAD}{\ButtonMenu}
-\begin{table}[h!]
+      & Play from the split position \\
-\begin{tabular}{|c|c|c|}
+      %
-\hline
+      \opt{RECORDER_PAD}{\ButtonFOne}
-Recorder & Ondio & Function \\\hline
+      \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonLeft}
-Off & On/Off & Quit plugin \\\hline
+      & Enter the save dialogue \\
-Left/Right & Left/Right & Move the split point indicator \\\hline
+      %
-Up/Down & Up/Down & Zoom in / out \\\hline
+      \opt{RECORDER_PAD}{\ButtonFTwo}
-Play & Mode & Play from the split position \\\hline
+      \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonUp}
-F1 & Mode+Left & Enter the save dialogue \\\hline
+      & Toggle loop modes \\
-F2 & Mode+Up & Toggle loop modes \\\hline
+      %
-F3 & Mode+Right & Toggle logarithmic / linear scaling \\\hline
+      \opt{RECORDER_PAD}{\ButtonFThree}
-On+Left & ~ & Play half speed \\\hline
+      \opt{ONDIO_PAD}{\ButtonMenu\ + \ButtonRight}
-On+Right & ~ & Play 150\% speed \\\hline
+      & Toggle logarithmic / linear scaling \\
-On+Play & ~ & Play normal speed \\\hline
+      \opt{RECORDER_PAD}{
-\end{tabular}
+      %
+      \ButtonOn\ + ButtonLeft
+      & Play half speed \\
+      %
+      \ButtonOn\ + ButtonRight
+      & Play 150\% speed \\
+      %
+      \ButtonOn\ + \ButtonPlay
+      & Play normal speed \\
+    }
+    \end{btnmap}
   \end{table}
 
-\subsubsection{Save the files}
+\subsubsection{Save dialogue}
 In the save dialogue it is possible to specify which of the files you
 want to save and their names.  When finished, select
 ``Save'' and the files will be written to
@@ -146,27 +159,25 @@ file already exists simply try to save it. If another file with this
 name exists the dialogue will return and you can choose another
 filename
 
-{\centering\itshape
+\screenshot{plugins/images/ss-splitedit-save}{The Split Editor's
-  [Warning: Image ignored] % Unhandled or unsupported graphics:
+Save Dialogue}{}
-%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img72.gif}
- \newline
-Save dialogue
-\par}
 
-Controls in the save dialogue
+\begin{table}
-\begin{table}[h!]
+  \begin{btnmap}{Controls in the save dialogue}{}
-\begin{tabular}{|c|c|c|}
+    \ButtonUp\ / \ButtonDown & Select item \\
-\hline
+    %
-RECORDER & ONDIO & FUNCTION \\\hline
+    \opt{RECORDER_PAD}{\ButtonPlay}
-UP/DOWN & UP/DOWN & Select item \\\hline
+    \opt{ONDIO_PAD}{\ButtonRight}
-PLAY & RIGHT & Toggle / edit item \\\hline
+    & Toggle / edit item \\
-\end{tabular}
+    %
+    \ButtonOff & Cancel \\
+  \end{btnmap}
 \end{table}
 
-\subsubsection{Scale}
+\subsubsection{\label{ref:Scalemode}Scale}
 The values in the waveform are scaled according to the settings of the
-peak meter. These can be altered in the menu
+peak meter. These can be altered in the peak meter settings,
-\textbf{General Settings {}-{\textgreater} Display{}-{\textgreater} Peak Meter}. If extreme minimum /
+see \reference{ref:Peakmetersetting}. If extreme minimum or
 maximum values are set the waveform might be cut off.  A minimum
 setting of {}-60 dB and a maximum setting of 0 dB are recommended.
 These settings should be capable of producing useful waveforms for very
@@ -174,6 +185,7 @@ soft sounds in logarithmic mode (dB). When the editor is used on loud
 sounds (such as commercial rock or pop music) switching to the linear
 scale may prove more effective since the logarithmic scale compresses
 loud noises and makes it more difficult to identify characteristic
-shapes. Note that it is always possible to toggle the scale with F3. 
+shapes. Note that it is always possible to toggle between the two scale
+modes.