tsiry-sandratraina.com
A modern Music Player Daemon based on Rockbox open source high quality audio player
libadwaita
audio
rust
zig
deno
mpris
rockbox
mpd
manual: fix red in 7967c050df
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
+14
-12
manual/plugins/announce_status.tex
+14
-12
manual/plugins/announce_status.tex
···
4
4
5
5
Currently the list includes:
6
6
\begin{itemize}
7
-
\item Time (If applicable)
8
-
\item Date (If applicable)
7
+
\opt{rtc}{
8
+
\item Time
9
+
\item Date
10
+
}
9
11
\item Track name (spelled)
10
12
\item Artist name (spelled)
11
13
\item Track Elapsed / Remaining
···
20
22
while you can edit the items directly to get your preferred order preset options are included.
21
23
If you choose to manually edit the option string the input box helpfully has all valid options for the parser
22
24
23
-
25
+
\opt{rtc}{
24
26
\setting{TIME}
25
27
\begin{itemize}
26
28
\item DT current time
···
28
30
\item DD current date
29
31
\item D2 'date'
30
32
\end{itemize}
33
+
}
31
34
32
35
\setting{TRACK}
33
36
\begin{itemize}
···
68
71
69
72
\subsubsection{Usage}
70
73
\begin{description}
71
-
\item[Timeout] [0-360] seconds announcements will not repeat until timeout is met.
72
-
\item[Announce on] [Off, Track Change].
73
-
\item[Grouping] [0-7] 0- play all, 1-7 only announce the first n items.
74
+
\item [Timeout] [0-360] seconds announcements will not repeat until timeout is met.
75
+
\item [Announce on] [Off, Track Change].
76
+
\item [Grouping] [0-7] 0- play all, 1-7 only announce the first n items.
74
77
Helpful for infrequently used items.
75
-
\item[Announcement format] Select from preset options or manually enter your own.
76
-
\item[Quit] Exit without Saving.
77
-
\item[Save and Exit] Save settings and exit
78
+
\item [Announcement format] Select from preset options or manually enter your own.
79
+
\item [Quit] Exit without Saving.
80
+
\item [Save and Exit] Save settings and exit
78
81
\end{description}
79
82
80
83
Now that we have configuration out of the way (don't forget the preset options if this looks daunting)
···
85
88
it would get quite annoying to have to go run the plugin every time you wanted a status update though
86
89
87
90
Enter the \setting{WPS Hotkey}
88
-
now we will assign the wps hotkey to announce_status
91
+
now we will assign the wps hotkey to announce\_status
89
92
Settings>General Settings>What's Playing Screen>WPS Hotkey
90
93
choose 'OpenPlugin' browse to 'demos'
91
-
finally choose 'announce_status'
94
+
finally choose 'announce\_status'
92
95
93
96
Now you should be able to press your wps hotkey and get status updates on command.
94
97
···
96
99
This is actually a plugin running on top of the WPS screen and as such running other plugins stops the announce plugin
97
100
so if you only choose the track change option you should probably set the announce plugin to open on startup and keep
98
101
in mind that you may have to start the plugin again later.}
99
-
}