len0rd/rockbox
1
0
Fork 1
mirror of https://github.com/Rockbox/rockbox.git synced 2025-10-13 10:07:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

manual: fix red in 7967c050df

Browse source 
The new announce_status plugin manual had some errors:

 * unescaped '_'
 * spurious trailing '}'

Also made the time/date stuff gated behind the 'rtc' option, as
they won't function otherwise.

Change-Id: Iddd49472d4961ed167678ec835e777320570024a
This commit is contained in:
Solomon Peachy 2025-03-29 07:58:56 -04:00
parent 7967c050df
commit 2d4def6fd9
1 changed files with 14 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

26
manual/plugins/announce_status.tex
View file

@ -4,8 +4,10 @@ The \setting{Announce Status} plugin allows you to use the voice system to annou
Currently the list includes: Currently the list includes:
\begin{itemize} \begin{itemize}
\item Time (If applicable) \opt{rtc}{
\item Date (If applicable) \item Time
\item Date
}
\item Track name (spelled) \item Track name (spelled)
\item Artist name (spelled) \item Artist name (spelled)
\item Track Elapsed / Remaining \item Track Elapsed / Remaining
@ -20,7 +22,7 @@ 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. 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 If you choose to manually edit the option string the input box helpfully has all valid options for the parser
\opt{rtc}{
\setting{TIME} \setting{TIME}
\begin{itemize} \begin{itemize}
\item DT current time \item DT current time
@ -28,6 +30,7 @@ If you choose to manually edit the option string the input box helpfully has all
\item DD current date \item DD current date
\item D2 'date' \item D2 'date'
\end{itemize} \end{itemize}
}
\setting{TRACK} \setting{TRACK}
\begin{itemize} \begin{itemize}
@ -68,13 +71,13 @@ If you choose to manually edit the option string the input box helpfully has all
\subsubsection{Usage} \subsubsection{Usage}
\begin{description} \begin{description}
\item[Timeout] [0-360] seconds announcements will not repeat until timeout is met. \item [Timeout] [0-360] seconds announcements will not repeat until timeout is met.
\item[Announce on] [Off, Track Change]. \item [Announce on] [Off, Track Change].
\item[Grouping] [0-7] 0- play all, 1-7 only announce the first n items. \item [Grouping] [0-7] 0- play all, 1-7 only announce the first n items.
Helpful for infrequently used items. Helpful for infrequently used items.
\item[Announcement format] Select from preset options or manually enter your own. \item [Announcement format] Select from preset options or manually enter your own.
\item[Quit] Exit without Saving. \item [Quit] Exit without Saving.
\item[Save and Exit] Save settings and exit \item [Save and Exit] Save settings and exit
\end{description} \end{description}
Now that we have configuration out of the way (don't forget the preset options if this looks daunting) Now that we have configuration out of the way (don't forget the preset options if this looks daunting)
@ -85,10 +88,10 @@ You can choose to get announcements each track change or only when you run the p
it would get quite annoying to have to go run the plugin every time you wanted a status update though 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} Enter the \setting{WPS Hotkey}
now we will assign the wps hotkey to announce_status now we will assign the wps hotkey to announce\_status
Settings>General Settings>What's Playing Screen>WPS Hotkey Settings>General Settings>What's Playing Screen>WPS Hotkey
choose 'OpenPlugin' browse to 'demos' choose 'OpenPlugin' browse to 'demos'
finally choose 'announce_status' finally choose 'announce\_status'
Now you should be able to press your wps hotkey and get status updates on command. Now you should be able to press your wps hotkey and get status updates on command.
@ -96,4 +99,3 @@ Now you should be able to press your wps hotkey and get status updates on comman
This is actually a plugin running on top of the WPS screen and as such running other plugins stops the announce plugin 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 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.} in mind that you may have to start the plugin again later.}
}