openlp-core team mailing list archive

[Tim Bentley <tim.bentley@xxxxxxxxx>]

Tim Bentley has proposed merging lp:~trb143/openlp/bugs into lp:openlp.

Requested reviews:
  OpenLP Core (openlp-core)


Lets try to document song usage
-- 
https://code.launchpad.net/~trb143/openlp/bugs/+merge/41933
Your team OpenLP Core is requested to review the proposed merge of lp:~trb143/openlp/bugs into lp:openlp.

=== modified file 'documentation/manual/source/index.rst'
--- documentation/manual/source/index.rst	2010-10-15 20:09:57 +0000
+++ documentation/manual/source/index.rst	2010-11-26 07:43:00 +0000
@@ -14,6 +14,7 @@
    introduction
    glossary
    dualmonitors
+   songusage
 
 Indices and tables
 ==================

=== added file 'documentation/manual/source/pics/songusage.png'
Binary files documentation/manual/source/pics/songusage.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songusage.png	2010-11-26 07:43:00 +0000 differ
=== added file 'documentation/manual/source/pics/songusagedelete.png'
Binary files documentation/manual/source/pics/songusagedelete.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songusagedelete.png	2010-11-26 07:43:00 +0000 differ
=== added file 'documentation/manual/source/pics/songusagereport.png'
Binary files documentation/manual/source/pics/songusagereport.png	1970-01-01 00:00:00 +0000 and documentation/manual/source/pics/songusagereport.png	2010-11-26 07:43:00 +0000 differ
=== added file 'documentation/manual/source/songusage.rst'
--- documentation/manual/source/songusage.rst	1970-01-01 00:00:00 +0000
+++ documentation/manual/source/songusage.rst	2010-11-26 07:43:00 +0000
@@ -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