diff --git a/manual/plugins/announce_status.tex b/manual/plugins/announce_status.tex new file mode 100644 index 0000000000..c933486b9c --- /dev/null +++ b/manual/plugins/announce_status.tex @@ -0,0 +1,99 @@ +\subsection{Announce Status} + +The \setting{Announce Status} plugin allows you to use the voice system to announce things in the audio stream + +Currently the list includes: +\begin{itemize} +\item Time (If applicable) +\item Date (If applicable) +\item Track name (spelled) +\item Artist name (spelled) +\item Track Elapsed / Remaining +\item Playlist position +\item Battery level +\item Sleep Timer remaining +\item Running time +\end{itemize} + +\subsubsection{Configuration} +The input for announce format is actually a parsed string of options +while you can edit the items directly to get your preferred order preset options are included. +If you choose to manually edit the option string the input box helpfully has all valid options for the parser + + +\setting{TIME} +\begin{itemize} +\item DT current time +\item D1 'time' +\item DD current date +\item D2 'date' +\end{itemize} + +\setting{TRACK} +\begin{itemize} +\item TT title (spelled) +\item TA artist (spelled) +\item TE elapsed +\item TL length +\item TR remaining +\item T1 'elapsed' +\item T2 'remaining' +\item T3 'of' +\end{itemize} + +\setting{PLAYLIST} +\begin{itemize} +\item PC current track +\item PN total tracks +\item PR remaining tracks +\item P1 'track' +\item P2 'of' +\end{itemize} + +\setting{BATTERY} +\begin{itemize} +\item BP level (percentage 0-100) +\item BM remaining time (HMS) +\item B1 'battery level' +\end{itemize} + +\setting{SLEEPTIMER/RUNTIME} +\begin{itemize} +\item RT runtime (HMS) +\item R1 'running time' +\item RS sleep timer remaining (HMS) +\item R2 'sleep time' +\item R3 'remaining' +\end{itemize} + +\subsubsection{Usage} +\begin{description} +\item[Timeout] [0-360] seconds announcements will not repeat until timeout is met. +\item[Announce on] [Off, Track Change]. +\item[Grouping] [0-7] 0- play all, 1-7 only announce the first n items. + Helpful for infrequently used items. +\item[Announcement format] Select from preset options or manually enter your own. +\item[Quit] Exit without Saving. +\item[Save and Exit] Save settings and exit +\end{description} + +Now that we have configuration out of the way (don't forget the preset options if this looks daunting) + +Not quite out of the woods yet though... + +You can choose to get announcements each track change or only when you run the plugin again +it would get quite annoying to have to go run the plugin every time you wanted a status update though + +Enter the \setting{WPS Hotkey} +now we will assign the wps hotkey to announce_status +Settings>General Settings>What's Playing Screen>WPS Hotkey +choose 'OpenPlugin' browse to 'demos' +finally choose 'announce_status' + +Now you should be able to press your wps hotkey and get status updates on command. + +\note{ +This is actually a plugin running on top of the WPS screen and as such running other plugins stops the announce plugin +so if you only choose the track change option you should probably set the announce plugin to open on startup and keep +in mind that you may have to start the plugin again later.} +} diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex index 9c65baa7f6..4d8bc63c07 100644 --- a/manual/plugins/main.tex +++ b/manual/plugins/main.tex @@ -120,6 +120,8 @@ text files% \section{Demos} +\input{plugins/announce_status.tex} + \input{plugins/bounce.tex} \input{plugins/credits.tex} @@ -239,6 +241,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).} \input{plugins/zxbox.tex} + \section{Applications} \opt{rtc}{\input{plugins/alarmclock.tex}} @@ -269,10 +272,14 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).} \input{plugins/main_menu_config.tex} +\opt{multi_boot}{\input{plugins/multiboot_select.tex}} + \input{plugins/md5sum.tex} \input{plugins/metronome.tex} +\input{plugins/open_plugins.tex} + \input{plugins/otp.tex} \input{plugins/periodic_table.tex} diff --git a/manual/plugins/multiboot_select.tex b/manual/plugins/multiboot_select.tex new file mode 100644 index 0000000000..8a3bfad1f7 --- /dev/null +++ b/manual/plugins/multiboot_select.tex @@ -0,0 +1,21 @@ +\subsection{Multiboot Select} +The \setting{Multiboot Select} plugin allows you to select from multiple +versions of rockbox on devices that support it. + +\subsubsection{How it works} +Normally your \setting{Rockbox} install lives in the root of your main drive +On devices with multiboot your rockbox install can live in a separate folder +\opt{multidrive_usb}{on the external drive}. + +Once several installs exist, \setting{Multiboot Select} will allow you to +select them for next boot or even reboot with your selected install immediately. + +\subsubsection{Menu} +\begin{description} +\item[Select root] Displays a list of installs found on the device. +\item[Clear redirect] Removes all redirects returning to default install +\item[Using root] Displays the currently selected install path +\item[Save and Exit] Saves the currently selected install to be run next boot. +\item[Save and Reboot] Saves the currently selected install and reboots immediately. +\item[Save and Exit] Exit without saving changes. +\end{description} diff --git a/manual/plugins/open_plugins.tex b/manual/plugins/open_plugins.tex new file mode 100644 index 0000000000..474807cbbf --- /dev/null +++ b/manual/plugins/open_plugins.tex @@ -0,0 +1,26 @@ +\subsection{OpenPlugins} +\setting{Rockbox} uses an on disk database to store plugins and parameters. +\setting{OpenPlugins} allows viewing/editing/exporting items from this database. + +\subsubsection{How it works} +\setting{OpenPlugins} displays a list of plugins you have set for actions such +as your \setting{Wps Hotkey}, \setting{Wps Context Plugin}, or \setting{Startup Plugin}. +You can export these entries or your own custom entries to a shortcut. +Any time this shortcut is run your selected parameters (or file) will be supplied. + +If no items currently exist there will only be a single item 'Add', +on selection you will be presented with the file browser choose a plugin. + +After selecting a plugin you will have a new entry long press on an entry will +display the context menu where you can edit the name, +add parameters or even remove the entry. +Selecting the entry will run it immediately. + +\begin{description} +\item[Run] Exit and run selected entry. +\item[Edit] Edit the name, path or parameters of the selected entry. +\item[Remove] Delete the selected entry. +\item[Export] Export selected entry you can change the filename if desired. +\item[Add] On selection you will be presented with the file browser choose a plugin. +\item[Back] Return to previous menu. +\end{description}