[Koha-patches] [PATCH] Updated help files
Nicole Engard
nengard at gmail.com
Wed Sep 23 23:13:21 CEST 2009
>From de3c204f09499a2fa320e93eab9aef9e0dd62ad1 Mon Sep 17 00:00:00 2001
From: Nicole Engard <nengard at gmail.com>
Date: Tue, 22 Sep 2009 10:09:35 -0400
Subject: [PATCH] Updated help files
Content-Type: text/plain; charset="utf-8"
---
.../prog/en/modules/help/members/mancredit.tmpl | 6 +-
.../prog/en/modules/help/members/maninvoice.tmpl | 2 +
.../prog/en/modules/help/members/member-flags.tmpl | 6 +-
.../prog/en/modules/help/reports/dictionary.tmpl | 83 +++++++++------
.../en/modules/help/reports/guided_reports.tmpl | 111 ++++++++++----------
.../prog/en/modules/help/tools/holidays.tmpl | 86 +++++++--------
6 files changed, 161 insertions(+), 133 deletions(-)
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tmpl
b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tmpl
index 6436b49..1d2ecd4 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tmpl
@@ -5,5 +5,7 @@
<li>To create a manual credit, click the 'Create manual credit' tab</li>
<li>Enter in the information related to the credit you're adding</li>
<li>The new credit will appear on the 'Account' tab</li>
- </ul> TIP: Use manual credits to pay partial fines.
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+ </ul>
+
+ <p style="background-color: #ffe599">TIP: Use manual credits to pay
partial fines.</p>
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tmpl
b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tmpl
index d8dc9ab..97d6ebd 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tmpl
@@ -5,6 +5,8 @@
<li>Click the 'Create manual invoice' tab</li>
<li>Enter in the information related to the charge you're adding</li>
<li>The new charge will appear on the 'Account' tab</li>
+ <li>If you would like to define additional categories for manual
invoices you can do so by adding authorized values in the MANUAL_INV
categories.</li>
+ <ul><li style="color: #990000">IMPORTANT: Set the authorized value
field as the description and the description field is the default fee,
if any.</li></ul>
<li>Manual invoices can be paid the same way as automatic fines,
by clicking on 'Pay fines'</li>
</ul>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tmpl
b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tmpl
index b501d66..6caa517 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tmpl
@@ -37,6 +37,10 @@ TIP: If this preference is turned OFF after being
ON, the system reverts to the
<li><strong>circulate</strong>
<ul>
<li>Ability for logged in user to check books out and back in</li>
+ <li>With GranularPermissions on this section will be expanded to
allow access to specific ciculation functions.
+ <ul>
+ <li><em>Get there:</em> More > Administration > Global
System Preferences > Admin > GranularPermissions</li>
+ </ul></li>
</ul></li>
<li><strong>catalog</strong>
<ul>
@@ -84,7 +88,7 @@ TIP: If this preference is turned OFF after being
ON, the system reverts to the
<li>Use tools (export, import, barcodes)</li>
<li>With GranularPermissions on this section will be expanded to
allow access only to specific tools
<ul>
- <li><em>Get there:</em> More > Administration > General
preferences > Admin > GranularPermissions</li>
+ <li><em>Get there:</em> More > Administration > Global
System Preferences > Admin > GranularPermissions</li>
</ul></li>
</ul></li>
<li><strong>editauthorities</strong>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl
b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl
index 1382cbf..351c967 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/dictionary.tmpl
@@ -2,40 +2,63 @@
<h1>Reports Dictionary Help</h1>
-<h2>What is the Reports Dictionary</h2>
-<p>The dictionary provides a way that you can define custom criteria
for reporting by combining existing criteria.</p>
+The dictionary provides a way that you can define custom criteria for
reporting by combining existing criteria.
<h2>Adding A New Definition</h2>
-<h3>Step 1 of 4 Name</h3>
+
+<p><strong>Step 1: Name</strong></p>
+
<p>At this step you will need to fill out the following details:</p>
- <ol>
- <li>
-<p>Definition Name: Short name that is used for display and selection</p></li>
- <li>
-<p>Definition Description: Used within the dictionary only to provide
further detail about the definition</p></li>
- </ol>
-
- <h3>Step 2 of 4 Area</h3>
-<p>Now you will need to select the area that you are binding the
definition to. Definitions can only be bound to one area. If you wish
to use a similar definition in say, Circulation and Patrons, you will
need to create two definitions - one for each area</p>
-
-<h3>Step 3 of 4 Columns</h3>
-<p>Now select the criteria that you wish to use to build your
definition. Click on the database column name and then press the add
button. Once you have selected all your desired columns, press
Next.</p>
-<p>Note: 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.</p>
-
-<h3>Step 4 of 4 Values</h3>
+
+<ul>
+<li>Definition Name: Short name that is used for display and selection</li>
+<li>Definition Description: Used within the dictionary only to
provide further detail about the definition</li>
+</ul>
+
+<p><strong>Step 2: Area</strong></p>
+
+<p>Now you will need to select the area that you are binding the
definition to. </p>
+
+<p style="color: #990000">IMPORTANT: Definitions can only be bound to
one area.</p>
+
+<p style="background-color: #ffe599">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</p>
+
+<p><strong>Step 3: Columns</strong></p>
+
+<p>Now select the criteria that you wish to use to build your definition. </p>
+
+<ul>
+<li>Click on the database column name and then press the 'add' button.</li>
+<li>Once you have selected all your desired columns, press Next.</li>
+</ul>
+
+<p style="background-color: #ffe599">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</p>
+
+<p><strong>Step 4: Values</strong></p>
+
<p>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</p>
- <ul>
- <li><strong>Search String Matches</strong> For free text fields in
that database, enter a string/phrase for the criteria to match on</li>
- <li><strong>Date</strong> For date fields you can either select:
- <ol>
- <li>Date Range: enter values in both date fields</li>
- <li>All Data Before A Given Date: enter a value in the field only</li>
- <li>All Data After A Given Date: enter a value in the field only</li>
- </ol></li>
- <li><strong>Select From Database Value</strong> For data that is
given an authorized value in the Koha database, you the drop down list
to select one value</li>
- </ul>
-
+
+<ul>
+<li>Search String Matches For free text fields in that database,
enter a string/phrase for the criteria to match on</li>
+<li>Date For date fields you can either select:</li>
+<ol><li>Date Range: enter values in both date fields</li>
+ <li>All Data Before A Given Date: enter a value in the XXX field only</li>
+ <li>All Data After A Given Date: enter a value in the XXX field only</li>
+</ol>
+<li>Select From Database Value For data that is given an authorized
value in the Koha database, you the drop down list to select one
value</li>
+</ul>
+
+<p><strong>Step 5: Confirmation</strong></p>
+
+<p>You will be presented with a confirmation once you have finished step 4</p>
+
+<p>Click 'Save'</p>
+
<h2>Using A Definition</h2>
-<p>Once you have created your new definition and it shows on in the
Dictionary, you can use the definition for reporting. When you go to
create a new report, the criteria for the area you are reporting on
will automatically show as limits in the Guided Reports wizard</p>
+<p>Once you have created your new definition and it shows on in the
Dictionary, you can use the definition for reporting.</p>
+
+<ul>
+<li>When you go to create a new report, the criteria for the area you
are reporting on will automatically show as limits in the Guided
Reports wizard</li>
+</ul>
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
index b1c61f3..55dc498 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
@@ -1,56 +1,57 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<a name="#top" title="#top"></a>
-<h1>Guided Reports Help</h1>
- <ul>
- <li><a href="#new">Building A New Report</a></li>
- <li><a href="#save">Saving A Report</a></li>
- <li><a href="#sql">Generating A New Report From SQL</a></li>
- <li><a href="#scheduler">Scheduling A Report</a></li>
- <li>
- <ul>
- <li>
- <ul>
- <li><strong>Tabular:</strong>Simple report of columns only.</li>
- <li><strong>Matrix:</strong><em>Not finished</em></li>
- <li><strong>Summary:</strong><em>Not finished</em></li>
- </ul>
- <ul>
- <li><strong>System Generated Criteria</strong> These criteria are
known to the system and are drawn from your system preferences</li>
- <li><strong>Dictionary Criteria</strong> These are custom defined
criteria defined for your Koha in the Reports Dictionary</li>
- </ul>
- <ul>
- <li>Count : Returns a count of each value</li>
- <li>Sum : Returns the sum of all values</li>
- <li>Average : Returns the average value</li>
- <li>Min : Returns the lowest value</li>
- <li>Max : Returns the highest value</li>
- </ul></li>
-<p>For help with the Reports Dictionary - see online help within the
Dictionary Pages</p>
-<hr/><a name="#new" title="#new"></a><h2>Building A New Report</h2>
<h3>Step 1 of 6: Choose a Module to Report on</h3>
-<p>Select one of the module areas to report on. Guided reports can
only generate reports from within one module. For reports across
modules, you will need to use either a compound report, or build a
custom report using SQL statements.</p><h3>Step 2 of 6: Pick a Report
Type</h3>
-<p>There are 3 types of reports that can be generated:</p><h3>Step 3
of 6: Select Columns for Display</h3>
-<p>Select the columns to draw the report data from. Click the column
to add in the left hand box and then click the "Add" button.
Your column will now show up in the right hand box. To remove a
selected column, click the column name on the right hand side and then
click the delete button. Once you are happy with the columns, select
the "Choose Columns" button to proceed to the next step.</p>
-<p><strong>Be careful selecting columns.</strong> The guided reports
feature expects that you have some knowledge of the Koha database
structure and what each field is used for. Be careful selecting
columns as a poor choice may lead to a report that is so large that it
either times out before it can be generated, or it will require a
large amount of system resources to generate and slow down the
operation of Koha.</p>
-<p>There is no sanity checker in the reports engine</p><h3>Step 4 of
6: Select Criteria to Limit on </h3>
-<p>Criteria allow you to limit your report to display results to a
given criteria.Criteria are bound to a specific reporting
area.</p><h3>Step 5 of 6: Pick which columns to total</h3>
-<p>Now choose operations that you want to preform on each column. The
operations that can be selected are:</p>. <h3>Step 6 of 6: Select
how you want the report ordered</h3>
-<p>Select how you wish to order the report. You can select multiple
criteria to order against and the hierarchy that the are applied. For
example order alphabetically by Surname, and then alphabetically by
First Name</p><br/><a href="#top">
-Back To Top
-</a>
-<hr/><a name="#save" title="#save">
-</a><h2>Saving A Report</h2>
-<p>Once you have generated a report, you can now choose to save the
report definition so that you can run it again when required, or setup
the Task Scheduler to run the report for you.</p><br/><a href="#top">
-Back To Top
-</a>
-<hr/><a name="#sql" title="#sql">
-</a><h2>Generating A New Report From SQL</h2>
-<p>A report can be generated directly using from an SQL statement. On
the "Create from SQL" page, give the report a Title and
Description (using the notes field) and then paste your SQL statement
into the text area.</p><br/><a href="#top">
-Back To Top
-</a>
-<hr/><a name="#scheduler" title="#scheduler">
-</a><h2>Scheduling A Report</h2>
-<p>Reports can be scheduled to run either at a one off time, or
repeatedly at a defined period using the task scheduler. The task
scheduler is found under Tools >Task Scheduler</p><br/><a
href="#top">
-Back To Top
-</a>
- </ul></li>
- </ul><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+
+<h1>Add a Custom Report</h1>
+
+<p>If the report you need is not already available, the 'Guided
Reports' Wizard will walk anyone through creating a custom report.</p>
+
+<p>There are three elements of a standard 'guided' report: columns,
rows and filters. For issues and acquisitions, desired data is placed
in each cell (count or amount, or loan length).</p>
+
+<ul>
+<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
+<li>Choose 'Guided Reports' under 'Guided Reports Wizard'</li>
+</ul>
+
+<p>Now, you can build a report in 6 easy steps!</p>
+
+<p><strong>Step 1: Choose a Module to Report on</strong></p>
+<ul>
+<li>Choose a module to build a report on</li>
+<li>Click 'Next'</li>
+</ul>
+
+<p><strong>Step 2: Pick a Report Type</strong></p>
+<li style="color: #990000">IMPORTANT: Only Tabular should be chosen
with this option</p>
+<p><strong>Step 3: Select Columns for Display</strong></p>
+<p><strong>Step 4: Select Criteria to Limit</strong></p>
+<p>This is optional, if you don't want to limit results by any one
field, just leave this section blank.</p>
+<p><strong>Step 5: Pick which columns to total</strong></p>
+<p>This is optional, if you don't want to do any math on the results,
just leave this section blank.</p>
+<p><strong>Step 6: Choose how you want the report ordered</strong></p>
+<p>This is optional, if you want the results to come out as they are
in the table, just leave this section blank.</p>
+
+<h1>Edit Reports</h1>
+
+<p>Custom reports can be edited in their entirety from the Saved
Guided Reports page.</p>
+
+<ul><li><em>Get there:</em> More > Reports > Guided Reports > Use
Saved</li></ul>
+
+<ul.<li>To edit a report click 'Edit SQL' beside the report</li>
+<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>Can I have reports run on a schedule?</strong></p>
+
+<p>Yes, you can use the Task Scheduler tool.</p>
+
+<ul><li><em>Get there:</em> More > Tools > Task Scheduler</li></ul>
+
+<p><strong>Is there a repository for reports?</strong></p>
+
+<p>There is a page on the Koha Wiki: <a
href="http://wiki.koha.org/doku.php?id=sql_library"
target="_new">http://wiki.koha.org/doku.php?id=sql_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>
+
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl
b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl
index f3d3e46..3f13158 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl
@@ -1,47 +1,43 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>Holidays Calendar Help</h1><h2>What is the Holidays Calendar?</h2>
-<p>The Holidays Calendar allows the library to define days where the
library is closed. Circulation rules are then recalculated to taken in
to account that library is closed and there will be no one present to
return items.</p>
-<p>There are 2 types of holiday:</p>
- <ol>
- <li><strong>Unique Holiday</strong>:One off events or closeures.</li>
- <li><strong>Repeatable Holidays</strong>:Holidays that either
repeat the same day of every week or repeated yearly on the same
date.</li>
- </ol> Holidays are set per library and the same holiday will need to
be set for all libraries in a system.
-<h2>Updating the Calendar:</h2>
- <ul>
- <li>Go to the 'Tools' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Calendar'</li>
- <li>From the pull down you can choose which branch to apply holidays to.
- <ul>
- <li>
- <span style="background-color: #ffff99">
-TIP: At present you will have to enter holidays in for each library,
there is no way to apply holidays to all libraries at
once.</span></li>
- </ul></li>
- <li>To add a new holiday, click on the date you'd like to add a holiday to
- <ul>
- <li>Example, February 18, 2008 is President's Day and the library
is closed.</li>
- </ul></li>
- <li>Click on the 18th of February 2008 and fill in the necessary
fields for your library.</li>
- <li>Chose whether this holiday is repeated every day of the week or yearly.
- <ul>
- <li>In the case of President's Day it is not repeatable.</li>
- <li>
- <span style="background-color: #ffff99">
-TIP: An example of a repeatable holiday would be Christmas, New
Year's or a staff in-service day</span></li>
- </ul></li>
- <li>When you've entered the necessary data click 'Save'</li>
- <li>Once saved your holiday will be color-coded on the calendar</li>
- </ul><h3><strong>Why do I want to add holidays for my
library?</strong></h3>After holidays are entered on the calendar,
circulation rules are then recalculated to taken in to account that
library is closed and there will be no one present to return items.
-<h3>How do I enable the Holiday Calendar? </h3>
-<p>You can make use of the Holidays Calendar by turning on the proper
system preferences</p>
- <ul>
- <li><em>Get there:</em> More > Administration > Global System
Preferences > Circulation > useDaysMode
- <ul>
- <li>Choose the method for calculating due date: select Calendar to
use the holidays module, and Days to ignore the holidays module</li>
- </ul></li>
- <li><em>Get there:</em> More > Administration > Global System
Preferences > Circulation > finescalendar
- <ul>
- <li>This will use the check the holiday calendar before charging fines</li>
- </ul></li>
- </ul>
-<p> </p><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<h1>Holidays Calendar</h1>
+
+The calendar is used to define days when the library is closed for
circulation rules.
+
+<ul>
+<li>From the pull down you can choose which branch to apply holidays to.</li>
+ <ul><li style="background-color: #ffe599">TIP: If you're
entering universal holidays (that apply to all branches) you will be
presented with an option to add to all when adding a new
holiday.</li></ul>
+<li>To add a new holiday, click on the date you'd like to add a holiday to</li>
+ <ul><li style="background-color: #ffe599">TIP: Click the
plus sign (+) to the right of the holiday options for a helpful
tip.</li></ul>
+<li>Click on the date and fill in the necessary fields for your library.</li>
+<li>Chose whether this holiday is repeated every day of the week or
yearly.</li>
+ <ul><li style="background-color: #ffe599">TIP: An example of
a repeatable holiday would be Christmas, New Year's or a staff
in-service day</li></ul>
+<li>When you've entered the necessary data click 'Save'</li>
+<li>Once saved your holiday will be color-coded on the calendar and
listed below the calendar</li>
+</ul>
+
+
+<h2>Questions</h2>
+
+<p><strong>Why do I want to add holidays for my branch?</strong></p>
+
+After holidays are entered on the calendar, circulation rules are
then recalculated to taken in to account that library is closed and
there will be no one present to return items.
+
+
+<p><strong>How do I enable the Holiday Calendar?</strong></p>
+
+You can make use of the Holidays Calendar by turning on the proper
system preferences
+<ul>
+<li><em>Get there:</em> More > Administration > Global System
Preferences > Circulation > useDaysMode</li>
+ <ul> <li>Choose the method for calculating due date: select
Calendar to use the holidays module, and Days to ignore the holidays
module</li></ul>
+<li><em>Get there:</em> More > Administration > Global System
Preferences > Circulation > finescalendar</li>
+ <ul> <li>This will use the check the holiday calendar before
charging fines</li></ul>
+</ul>
+
+<p><strong>How is the dropbox date is determined?</strong></p>
+
+<p>Is it the last open date for the checkout branch? Is it today's
date minus one? Can the dropbox checkin date be set? If the library is
closed for four days for repairs, for example, there would be more
than one day needed for the dropbox date.</p>
+
+<p>You will only have one dropbox date and that will be the last day
that the library open (determined by the holiday calendar) because
there is no real way to know what day the books were dropped into the
box during the 4 closed days. The only way to change the effective
checkin date in dropbox mode is to modify the calendar.</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
--
1.5.6.5
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0004-Updated-help-files.patch
Type: application/octet-stream
Size: 22618 bytes
Desc: not available
URL: </pipermail/koha-patches/attachments/20090923/f116c471/attachment-0001.obj>
More information about the Koha-patches
mailing list