From c44892d3180c52eb38f441088cd1cf7e84798846 Mon Sep 17 00:00:00 2001 From: "Nicole C. Engard" Date: Fri, 7 Oct 2011 13:13:53 -0400 Subject: [PATCH] Bug 6966 Reports Help This patch updates all the help files in the reports folder and adds links to the manual pages. --- .../help/reports/acquisitions_stats.tt | 22 ++++--- .../en/modules/help/reports/bor_issues_top.tt | 23 +++---- .../en/modules/help/reports/borrowers_out.tt | 20 +++--- .../modules/help/reports/borrowers_stats.tt | 30 +++------ .../en/modules/help/reports/cat_issues_top.tt | 22 +++---- .../en/modules/help/reports/catalogue_out.tt | 24 ++++---- .../modules/help/reports/catalogue_stats.tt | 27 +++----- .../en/modules/help/reports/dictionary.tt | 61 +++---------------- .../en/modules/help/reports/guided_reports.tt | 30 ++++++--- .../modules/help/reports/issues_avg_stats.tt | 17 +++--- .../en/modules/help/reports/issues_stats.tt | 43 +++++++------ .../prog/en/modules/help/reports/itemslost.tt | 6 +- .../prog/en/modules/help/reports/manager.tt | 17 +++--- .../en/modules/help/reports/reports-home.tt | 26 +++++--- .../en/modules/help/reports/serials_stats.tt | 22 ++----- 15 files changed, 165 insertions(+), 225 deletions(-) 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 374032667e..63a2f5369e 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 @@ -2,12 +2,16 @@

Acquisitions Statistics

-

IMPORTANT: The Acquisitions 'Wizard' is designed to be a simple statistical snapshot,  In each wizard, you will choose a single category to represent 'row' and another to represent 'column'.

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

Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.

+ +

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.

+ +

When generating your report, note that you get to choose between counting or summing the values.

+ +

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).

+ +[% 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 a4e24f4e6e..384844cfde 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 @@ -1,16 +1,13 @@ [% INCLUDE 'help-top.inc' %] -

Patrons with the most checkouts

+

Patrons With The Most Checkouts

-

This guided report will show you which patrons have checked out the most items.

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

This report will simply list the patrons who have the most checkouts.

+ +

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 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 2bebbb940f..13d88eec4e 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 @@ -1,11 +1,13 @@ [% INCLUDE 'help-top.inc' %] -

Patrons who haven't checked out

- -

This guided report will give you a snapshot of which (OR HOW MANY?) items have not been checked out at all. You can limit these items by branch

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

Patrons With No Checkouts

+ +

This report will list for you the patrons in your system who haven't checked any items out.

+ +

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 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 460661b02d..eeeeca30a5 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 @@ -2,29 +2,13 @@

Patron Statistics

-

IMPORTANT: The Patron 'Wizard' is designed to be a simple statistical snapshot, In each wizard, you will choose a single category to represent 'row' and another to represent 'column'.

- - +

Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.

+ +

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

+ +

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).

[% 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 f786c3e753..90e956edd6 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 @@ -1,17 +1,13 @@ [% INCLUDE 'help-top.inc' %] -

Most -Circulated Items

+

Most Circulated Items

-

This guided report will show you which patrons

+

This report will simply list the items that have the been checked out the most.

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

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 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 168d0c2374..515237160e 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 @@ -1,15 +1,13 @@ [% INCLUDE 'help-top.inc' %] -

Items not checked out

- -

This guided report will give you a snapshot of items have not been checked out at all. You can limit these items by branch

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

Items With No Checkouts

+ +

This report will list items in your collection that have never been checked out.

+ +

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 the Issues 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 f2f14f66f7..946b23c261 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 @@ -1,27 +1,14 @@ [% INCLUDE 'help-top.inc' %] -

Catalog Statistics

+

Catalog Statistics

-

IMPORTANT: The Catalog 'Wizard' is designed to be a simple statistical snapshot. You will choose a single category to represent 'row' and another to represent 'column'.

+

Using the form provided, choose which value you would like to appear in the Column and which will appear in the Row.

- - - +

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 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 efed2103b1..137883c035 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 @@ -1,64 +1,23 @@ [% INCLUDE 'help-top.inc' %] -

Reports Dictionary Help

+

Reports Dictionary

-The dictionary provides a way that you can define custom criteria for reporting by combining existing criteria. +

The report dictionary is a way to pre-define common filters you'd like to apply to your reports. This is a good way to add in filters that the report wizard doesn't include by default. To add a new definition, or filter, click 'New Definition' on the Reports Dictionary page and follow the 4 step process.

-

Adding A New Definition

+

Step 1: Name the definition and provide a description if necessary

-

Step 1: Name

+

Step 2: Choose the module that the will be queried.

-

At this step you will need to fill out the following details:

+

Step 3: Choose columns to query from the tables presented.

- +

Step 4: Choose the value(s) from the field(s). These will be automatically populated with options available in your database.

-

Step 2: Area

+

Confirm your selections to save the definition.

-

Now you will need to select the area that you are binding the definition to.

+

Your definitions will all appear on the Reports Dictionary page

-

IMPORTANT: Definitions can only be bound to one area.

+

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.

-

TIP: If you wish to use a similar definition in say, Circulation and Patrons, you will need to create two definitions - one for each area

+

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

-

Step 3: Columns

- -

Now select the criteria that you wish to use to build your definition.

- - - -

TIP: Definitions can be deleted easily, and if you are still learning the structure of the Koha data, it may take a little while to sort out which fields you require. Some trial and error may be required

- -

Step 4: Values

- -

Now you need to select the values for each column that will make up your new criteria. There are different ways to define the values, based on the type of data in the column you have selected

- - - -

Step 5: Confirmation

- -

You will be presented with a confirmation once you have finished step 4

- -

Click 'Save'

- -

Using A Definition

- -

Once you have created your new definition and it shows on in the Dictionary, you can use the definition for reporting.

- - [% 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 240a05a1cb..f89e887835 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 @@ -4,7 +4,6 @@

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

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

See the full documentation for the Lost 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/manager.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tt index e2e9e6ddf5..37d686ce5b 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 @@ -2,11 +2,12 @@

Catalog by Item Type

-

This one-step report will show you how many items of each item type are currently in your branch library or libraries.

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

This report will list the total number of items of each item type per branch.

+ +

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 the Catalog by Item Type 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/reports-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tt index 7ebc985891..a20a122d89 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 @@ -2,13 +2,21 @@

Reports

-

What Reports are there in Koha?

- -

Koha comes with a number of predefined (or "canned") reports, along with two report builder engines.

-

Pre-defined Reports

-

There are number of predefined reports in Koha. Check the Circulation module for additional Circulation specific reports.

-

Statistics Wizards

-

The statistics wizards provide a way to build simple reports for each module. The reports produced can either be viewed on screen or downloaded for opening in a spreadsheet program or text editor.

-

Guided Reports Wizard

-

The Guided Reports Wizard helps you build reports using all the fields in the database for each module. The reports can then be saved and run using the scheduler.

[% INCLUDE 'help-bottom.inc' %] +

Koha's reporting module allows you to gather data from your system. There are two main types of reports: +

+ +

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/serials_stats.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/serials_stats.tt index 79a941d493..cba7247244 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 @@ -2,22 +2,12 @@

Serials Statistics

-

IMPORTANT: The Serials 'Wizard' is designed to be a simple -statistical snapshot. -

- +

Using the form provided, choose how you would like to list the serials in your system.

+

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 Serials Statistics in the manual (online).

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