diff --git a/documentation/manual/source/index.rst b/documentation/manual/source/index.rst index ac29c4360..5228256cf 100644 --- a/documentation/manual/source/index.rst +++ b/documentation/manual/source/index.rst @@ -14,6 +14,7 @@ Contents: introduction glossary dualmonitors + songusage Indices and tables ================== diff --git a/documentation/manual/source/pics/songusage.png b/documentation/manual/source/pics/songusage.png new file mode 100644 index 000000000..10f29f2a9 Binary files /dev/null and b/documentation/manual/source/pics/songusage.png differ diff --git a/documentation/manual/source/pics/songusagedelete.png b/documentation/manual/source/pics/songusagedelete.png new file mode 100644 index 000000000..fec1b5e5d Binary files /dev/null and b/documentation/manual/source/pics/songusagedelete.png differ diff --git a/documentation/manual/source/pics/songusagereport.png b/documentation/manual/source/pics/songusagereport.png new file mode 100644 index 000000000..c0d9df3dd Binary files /dev/null and b/documentation/manual/source/pics/songusagereport.png differ diff --git a/documentation/manual/source/songusage.rst b/documentation/manual/source/songusage.rst new file mode 100644 index 000000000..d77cc3632 --- /dev/null +++ b/documentation/manual/source/songusage.rst @@ -0,0 +1,35 @@ +========== +Song Usage +========== + +The Songusage plugin records the usage of Songs when they are used in a **Live** situation. +If the plugin is active all songs sent to the Live Service Manager are recorded by this plugin. +Once the plugin has been activated by the plugin menu it can be turned on and off by use of +the``F4`` key or the SongUsage menus. + +The image below shows the menu items and how to access them. + +.. image:: pics/songusage.png + + +Generating reports +------------------ +Reports can be generated between any two dates. The system defaults to 1st September previous year to 31st +August current year. The data is written to a file in a selectable directory. +The file name is **usage_detail_fromdate_todate.txt**. + +.. image:: pics/songusagereport.png + +The details extracted are: + - Date item used + - Time item used + - Song Title + - Song Copyright + - Song CCLI. + +Removing data +------------- +To remove stored data use the option below which can be access from the Tools Toolbar. Select the +date you wish to remove data up to and press``Ok`` + +.. image:: pics/songusagedelete.png \ No newline at end of file