From 1a93eb0071c0422751ed1f28d034182f6368e441 Mon Sep 17 00:00:00 2001 From: Nicole C. Engard Date: Thu, 12 Apr 2012 10:03:49 -0400 Subject: [PATCH] Bug 7936: Reports Help Files for 3.8 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 @@

Choosing amount will change your results to appear as the sum of the amounts spent.

-

See the full documentation for Acquisitions Statistics in the manual (online).

+

See the full documentation for Acquisitions Statistics in the manual (online).

[% 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 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Patrons with the most Checkouts report in the manual (online).

+

See the full documentation for the Patrons with the most Checkouts report in the manual (online).

[% 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 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Patrons with no Checkouts report in the manual (online).

+

See the full documentation for the Patrons with no Checkouts report in the manual (online).

[% 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 @@

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.

-

See the full documentation for Patron Statistics in the manual (online).

+

See the full documentation for Patron Statistics in the manual (online).

[% 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 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Most Circulation Items report in the manual (online).

+

See the full documentation for the Most Circulation Items report in the manual (online).

[% 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 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Items with no Checkouts report in the manual (online).

+

See the full documentation for the Items with no Checkouts report in the manual (online).

[% 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 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for Catalog Statistics in the manual (online).

+

See the full documentation for Catalog Statistics in the manual (online).

[% 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 @@

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.

-

See the full documentation for the Reports Dictionary in the manual (online).

+

See the full documentation for the Reports Dictionary in the manual (online).

[% 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 @@

Add a Custom Report

+

Guided Report Wizard

+

If the report you need is not already available, the 'Guided Reports' Wizard will walk you through creating a custom report.

-

Questions

- -

Is there a repository for reports?

+

Report from SQL

-

There is a page on the Koha Wiki: http://wiki.koha-community.org/wiki/SQL_Reports_Library with reports written by Koha libraries around the world.

+

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: http://wiki.koha-community.org/wiki/SQL_Reports_Library. You can also find your database structure in /installer/data/mysql/kohastructure.sql or online at: http://schema.koha-community.org.

-

NEKLS also has a great page (http://www.nexpresslibrary.org/training/reports-training/) with a list of reports they have written.

+

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.

-

Can I have run-time defined parameters?

+

Fill in the form presented

+ -

Note that you can have more than one parameter in a given SQL

+

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.

-

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

+

Questions

-

Sample :

+

Is there a repository for reports?

- +

There is a page on the Koha Wiki: http://wiki.koha-community.org/wiki/SQL_Reports_Library with reports written by Koha libraries around the world.

+ +

NEKLS also has a great page (http://www.nexpresslibrary.org/training/reports-training/) with a list of reports they have written.

-

See the full documentation for Custom Reports in the manual (online).

+

See the full documentation for Custom Reports in the manual (online).

[% 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 @@

You can also choose to export to a file that you can manipulate to your needs.

-

See the full documentation for the Average Loan Time report in the manual (online).

+

See the full documentation for the Average Loan Time report in the manual (online).

[% 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 @@
  • For a single day, an example would be: 11/15/2009 to 11/16/2009 to find what circulated on the 15th
  • -

    See the full documentation for Circulation Statistics in the manual (online).

    +

    See the full documentation for Circulation Statistics in the manual (online).

    [% 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 @@ -

    See the full documentation for the Lost Items report in the manual (online).

    +

    See the full documentation for the Lost Items report in the manual (online).

    [% 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 @@

    You can also choose to export to a file that you can manipulate to your needs.

    -

    See the full documentation for the Catalog by Item Type report in the manual (online).

    +

    See the full documentation for the Catalog by Item Type report in the manual (online).

    [% 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 @@
  • Custom Reports
  • Statistical Reports @@ -17,6 +19,6 @@
  • -

    See the full documentation for Reports in the manual (online).

    +

    See the full documentation for Reports in the manual (online).

    [% 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' %] + +

    Holds Statistics

    + +

    Note: 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.

    + +

    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.

    + +

    If you choose to output to the browser your results will print to the screen.

    + +

    You can also choose to export to a file that you can manipulate to your needs.

    + +

    See the full documentation for Holds Statistics in the manual (online).

    + +[% 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 @@

    You can also choose to export to a file that you can manipulate to your needs.

    -

    See the full documentation for Serials Statistics in the manual (online).

    +

    See the full documentation for Serials Statistics in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file -- 1.7.2.3