This updates the existing help files and adds a new help file for the holds stats report. --- .../en/modules/help/reports/acquisitions_stats.tt | 2 +- .../prog/en/modules/help/reports/bor_issues_top.tt | 2 +- .../prog/en/modules/help/reports/borrowers_out.tt | 2 +- .../en/modules/help/reports/borrowers_stats.tt | 2 +- .../prog/en/modules/help/reports/cat_issues_top.tt | 2 +- .../prog/en/modules/help/reports/catalogue_out.tt | 2 +- .../en/modules/help/reports/catalogue_stats.tt | 2 +- .../prog/en/modules/help/reports/dictionary.tt | 2 +- .../prog/en/modules/help/reports/guided_reports.tt | 53 ++++++++++++++------ .../en/modules/help/reports/issues_avg_stats.tt | 2 +- .../prog/en/modules/help/reports/issues_stats.tt | 2 +- .../prog/en/modules/help/reports/itemslost.tt | 2 +- .../prog/en/modules/help/reports/manager.tt | 2 +- .../prog/en/modules/help/reports/reports-home.tt | 4 +- .../prog/en/modules/help/reports/reserves_stats.tt | 15 ++++++ .../prog/en/modules/help/reports/serials_stats.tt | 2 +- 16 files changed, 69 insertions(+), 29 deletions(-) create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt index 63a2f53..59d31ca 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/acquisitions_stats.tt @@ -12,6 +12,6 @@ <p>Choosing amount will change your results to appear as the sum of the amounts spent.</p> -<p><strong>See the full documentation for Acquisitions Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#acqstats";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for Acquisitions Statistics in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#acqstats";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt index 384844c..2811f37 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/bor_issues_top.tt @@ -8,6 +8,6 @@ <p>You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for the Patrons with the most Checkouts report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#mostcheckouts";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for the Patrons with the most Checkouts report in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#mostcheckouts";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt index 13d88ee..22c8a8f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_out.tt @@ -8,6 +8,6 @@ <p>You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for the Patrons with no Checkouts report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#patnocheckouts";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for the Patrons with no Checkouts report in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#patnocheckouts";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt index eeeeca3..f26347f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/borrowers_stats.tt @@ -8,7 +8,7 @@ <p>Based on your selections, you may see some query information above your results table. You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for Patron Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#patstats";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for Patron Statistics in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#patstats";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt index 90e956e..8dd03cc 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/cat_issues_top.tt @@ -8,6 +8,6 @@ <p>You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for the Most Circulation Items report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#mostcirculated";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for the Most Circulation Items report in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#mostcirculated";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt index 3cbd511..9efdf8f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_out.tt @@ -8,6 +8,6 @@ <p>You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for the Items with no Checkouts report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#itemnocheckouts";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for the Items with no Checkouts report in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#itemnocheckouts";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt index 946b23c..fc346e9 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/catalogue_stats.tt @@ -8,7 +8,7 @@ <p>You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for Catalog Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#catstats";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for Catalog Statistics in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#catstats";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt index 137883c..1880846 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tt @@ -18,6 +18,6 @@ <p>Then when generating reports on the module you created the value for you will see an option to limit by the definition at the bottom of the usual filters.</p> -<p><strong>See the full documentation for the Reports Dictionary in the <a href="http://manual.koha-community.org/3.6/en/reportdic.html";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for the Reports Dictionary in the <a href="http://manual.koha-community.org/3.8/en/reportdic.html";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt index 2eaba5a..7858baa 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tt @@ -2,6 +2,8 @@ <h1>Add a Custom Report</h1> +<h2>Guided Report Wizard</h2> + <p>If the report you need is not already available, the 'Guided Reports' Wizard will walk you through creating a custom report.</p> <ul> @@ -47,32 +49,53 @@ <li>A page with editable fields will open so that you can change the title, notes and SQL related to the report</li> </ul> -<h1>Questions</h1> - -<p><strong>Is there a repository for reports?</strong></p> +<h2>Report from SQL</h2> -<p>There is a page on the Koha Wiki: <a href="http://wiki.koha-community.org/wiki/SQL_Reports_Library"; target="_new">http://wiki.koha-community.org/wiki/SQL_Reports_Library</a> with reports written by Koha libraries around the world.</p> +<p>In addition to the report wizard, you have the option to write your own queries using SQL. To find reports written by other Koha users, visit the Koha Wiki: <a href="http://wiki.koha-community.org/wiki/SQL_Reports_Library";>http://wiki.koha-community.org/wiki/SQL_Reports_Library</a>. You can also find your database structure in /installer/data/mysql/kohastructure.sql or online at: <a href="http://schema.koha-community.org";>http://schema.koha-community.org</a>.</p> -<p>NEKLS also has a great page (<a href="http://www.nexpresslibrary.org/training/reports-training/"; target="_new">http://www.nexpresslibrary.org/training/reports-training/</a>) with a list of reports they have written.</p> +<p>To add your query, click the link to 'Create from SQL' on the main reports module or the New button at the top of the Saved Reports page.</p> -<p><strong>Can I have run-time defined parameters?</strong></p> +<p>Fill in the form presented</p> +<ul> + <li>The name is what will appear on the Saved Reports page to help you identify the report later. It will also be searchable using the filters found the left of the Saved Reports page.</li> + <li>Notes will also appear on the Saved Reports page, this can be used to provide more details about the report or tips on how to enter values when it runs</li> + <li>The type should always be 'Tabular' at this time since the other formats have not been implemented</li> + <li>In the SQL box you will type or paste the SQL for the report</li> + <li>If you feel that your report might be too resource intensive you might want to consider using runtime parameters to your query. Runtime parameters basically make a filter appear before the report is run to save your system resources. +<ul> + <li><strong>Note:</strong> There is a limit of 10,000 records put on SQL statements entered in Koha. To get around this you want to add 'LIMIT 100000' to the end of your SQL statement (or any other number above 10,000.</li> + <li>There is a specific syntax that Koha will understand as 'ask for values when running the report'. The syntax is <<Question to ask|authorized_value>>.</li> + <li>The << and >> are just delimiters. You must put << at the beginning and >> at the end of your parameter</li> + <li>The 'Question to ask' will be displayed on the left of the string to enter.</li> + <li>The authorized_value can be omitted if not applicable. If it contains an authorized value category, or branches or itemtype or categorycode, a list with the Koha authorized values will be displayed instead of a free field Note that you can have more than one parameter in a given SQL Note that entering nothing at run time won't probably work as you expect. It will be considered as "value empty" not as "ignore this parameter". For example entering nothing for : "title=<<Enter title>>" will display results with title='' (no title). If you want to have to have something not mandatory, use "title like <<Enter title>>" and enter a % at run time instead of nothing</li> +</ul> -<p>Yes, you can: there is a specific syntax that Koha will understand as 'ask for values when running the report'. The syntax is <<Question to ask|authorised_value>>.</p> +<p>Examples:</p> <ul> -<li>The << and >> are just delimiters. You must put << at the beginning and >> at the end of your parameter</li> -<li>The <strong>Question to ask</strong> will be displayed on the left of the string to enter. -<li>The <strong>authorised_value</strong> can be omitted if not applicable. If it contains an authorised value category, or <strong>branches</strong> or <strong>itemtype</strong> or <strong>categorycode</strong>, a list with the Koha authorised values will be displayed instead of a free field. If the authorised value is <strong>date</strong>, a date selector button will be added after the input field</li> + <li>SELECT surname, firstname<br /> + FROM borrowers<br /> + WHERE branchcode=<<Enter patrons library|branches>> AND surname like <<Enter filter for patron surname (% if none)>></li> + <li>SELECT *<br /> + FROM items<br /> + WHERE homebranch = <<Pick your branch|branches>> and barcode like <<Partial barcode value here (use % for wildcard)>></li> +</ul> +</li> + <li style="background-color: #ffe599;">Tip: To generate a date picker calendar to the right of the field when running a report you can use the 'date' keyword like this: <<Enter Date|date>></li> + <li style="background-color: #ffe599;">Tip: You have to put "%" in a text box to 'leave it blank'. Otherwise, it literally looks for "" (empty string) as the value for the field.</li> + <li style="color: #990000;">Important: In addition to using any authorized value code to generate a dropdown, you can use the following values as well: Branches (branches), Item Types (itemtypes) and Patron Categories (categorycode). For example a branch pull down would be generated like this <<Branch|branches>></li> </ul> -<p>Note that you can have more than one parameter in a given SQL</p> +<p>Once everything is entered click the 'Save Report' button and you'll be presented with options to run it. Once a report is saved you do not have to recreate it you can simply find it on the Saved Reports page and run or edit it.</p> -<p>Note that entering nothing at run time won't probably work as you expect. It will be considered as "value empty" not as "ignore this parameter". For example entering nothing for : "title=<<Enter title>>" will display results with title='' (no title). If you want to have to have something not mandatory, use "title like <<Enter title>>" and enter a % at run time instead of nothing</p> +<h1>Questions</h1> -<p>Sample :</p> +<p><strong>Is there a repository for reports?</strong></p> -<ul><li>SELECT surname,firstname FROM borrowers WHERE branchcode=<<Enter patrons library|branches>> AND surname like <<Enter filter for patron surname (% if none)>></li></ul> +<p>There is a page on the Koha Wiki: <a href="http://wiki.koha-community.org/wiki/SQL_Reports_Library"; target="_new">http://wiki.koha-community.org/wiki/SQL_Reports_Library</a> with reports written by Koha libraries around the world.</p> + +<p>NEKLS also has a great page (<a href="http://www.nexpresslibrary.org/training/reports-training/"; target="_new">http://www.nexpresslibrary.org/training/reports-training/</a>) with a list of reports they have written.</p> -<p><strong>See the full documentation for Custom Reports in the <a href="http://manual.koha-community.org/3.6/en/reports.html#customreports";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for Custom Reports in the <a href="http://manual.koha-community.org/3.8/en/reports.html#customreports";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt index 5b83f72..09ec95f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_avg_stats.tt @@ -8,6 +8,6 @@ <p>You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for the Average Loan Time report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#avloantime";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for the Average Loan Time report in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#avloantime";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt index 9a36808..7080f07 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/issues_stats.tt @@ -19,6 +19,6 @@ <li>For a single day, an example would be: 11/15/2009 to 11/16/2009 to find what circulated on the 15th</li> </ul> -<p><strong>See the full documentation for Circulation Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#circstats";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for Circulation Statistics in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#circstats";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt index 3bd1c3a..8ee9408 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/itemslost.tt @@ -16,6 +16,6 @@ </ul> </div> -<p><strong>See the full documentation for the Lost Items report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#lostreport";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for the Lost Items report in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#lostreport";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt index 21bc077..e4fecf1 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt @@ -8,6 +8,6 @@ <p>You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for the Catalog by Item Type report in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#catbyitem";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for the Catalog by Item Type report in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#catbyitem";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt index a20a122..3b5fc33 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt @@ -8,6 +8,8 @@ <li>Custom Reports <ul> <li>Koha's data is stored in a MySQL database which means that librarians can generate nearly any report they would like by either using the Guided Reports Wizard or writing their own SQL query.</li> + <li>The <a href="http://schema.koha-community.org/"; target="blank">Koha database schema</a> will help you learn the Koha database structure so that you can write effective SQL Queries</li> + <li>The <a href="http://wiki.koha-community.org/wiki/SQL_Reports_Library"; target="blank">Koha reports library</a> lists reports written by Koha users around the world.</li> </ul> </li> <li>Statistical Reports @@ -17,6 +19,6 @@ </li> </ul> -<p><strong>See the full documentation for Reports in the <a href="http://manual.koha-community.org/3.6/en/reports.html";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for Reports in the <a href="http://manual.koha-community.org/3.8/en/reports.html";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt new file mode 100644 index 0000000..5383afd --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reserves_stats.tt @@ -0,0 +1,15 @@ +[% INCLUDE 'help-top.inc' %] + +<h1>Holds Statistics</h1> + +<p><strong>Note:</strong> These reports are limited in what data they can look at, so it's often recommended to use custom reports for official end of the year statistics.</p> + +<p>Using the form provided you can see statistics for holds placed, filled, cancelled and more at your library. From the form choose what value you want to display in the column and what value to show in the row. You can also choose from the filters on the far right of the form.</p> + +<p>If you choose to output to the browser your results will print to the screen.</p> + +<p>You can also choose to export to a file that you can manipulate to your needs.</p> + +<p><strong>See the full documentation for Holds Statistics in the <a href="manual.koha-community.org/3.8/en/statsreports.html#holdstats">manual</a> (online).</strong></p> + +[% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt index cba7247..2dd4c57 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt @@ -8,6 +8,6 @@ <p>You can also choose to export to a file that you can manipulate to your needs.</p> -<p><strong>See the full documentation for Serials Statistics in the <a href="http://manual.koha-community.org/3.6/en/statsreports.html#serialstats";>manual</a> (online).</strong></p> +<p><strong>See the full documentation for Serials Statistics in the <a href="http://manual.koha-community.org/3.8/en/statsreports.html#serialstats";>manual</a> (online).</strong></p> [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file -- 1.7.2.3 _______________________________________________ Koha-patches mailing list [email protected] http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-patches website : http://www.koha-community.org/ git : http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
