From 84a13ac022e5e49430b0533b5bcc5e8b6b25e0da Mon Sep 17 00:00:00 2001
From: "Nicole C. Engard"
Date: Fri, 7 Oct 2011 15:30:37 -0400
Subject: [PATCH] Bug 6966 Update tools help files
This updates the tools help files.
---
.../prog/en/modules/help/tools/batchMod.tt | 10 +-
.../en/modules/help/tools/cleanborrowers.tt | 28 +++---
.../en/modules/help/tools/csv-profiles.tt | 45 +++++++--
.../prog/en/modules/help/tools/export.tt | 42 +++++---
.../prog/en/modules/help/tools/holidays.tt | 95 +++++++++----------
.../en/modules/help/tools/import_borrowers.tt | 83 ++++++++++------
.../prog/en/modules/help/tools/inventory.tt | 3 +
.../prog/en/modules/help/tools/koha-news.tt | 33 ++++---
.../prog/en/modules/help/tools/letter.tt | 53 +++++++----
.../modules/help/tools/manage-marc-import.tt | 49 +++++++---
.../en/modules/help/tools/overduerules.tt | 25 ++---
.../en/modules/help/tools/picture-upload.tt | 68 ++++---------
.../prog/en/modules/help/tools/scheduler.tt | 44 +++++----
.../modules/help/tools/stage-marc-import.tt | 38 +++++---
.../prog/en/modules/help/tools/tools-home.tt | 11 ++-
.../prog/en/modules/help/tools/viewlog.tt | 27 +++---
16 files changed, 380 insertions(+), 274 deletions(-)
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchMod.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchMod.tt
index 103769e4d8..09563fec80 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchMod.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchMod.tt
@@ -3,15 +3,15 @@
Batch Modify Items
-This tool will allow you to modify a batch of item records from Koha.
+This tool will allow you to modify a batch of item records in Koha.
From the tool you can choose to upload a file of barcodes or item ids, or you can scan items one by one into the box below the upload tool. Once you have your file uploaded or the barcodes listed you can click 'Continue.'
-You will be presented with a confirmation screen. From here you can uncheck the items you don't want to modify.
+You will be presented with a summary of the items you want to modify. From here you can uncheck the items you don't want to modify before making changes in the form below. You can also hide columns you don't need to see to prevent having to scroll from left to right to see the entire item form.
-Below the list of items there will be an item editor. Using this form you can choose which fields you want to edit on all of the records (like applying a note to all of them, or moving them from one library to another).
+Using the edit form you can choose which fields to make edits to. By checking the checkbox to the right of each field you can clear the values in that field for the records you are modifying.
-Once you have made your changes, you can click the 'Go' button and your items will be updated.
+Once you have made you changes you will be presented with the resulting items.
Batch Delete Items
@@ -23,4 +23,6 @@
If the items can be deleted they will be and you will be presented with a confirmation of your deletion.
+See the full documentation for Batch Item Modifications and Batch Item Deletions 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/tools/cleanborrowers.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/cleanborrowers.tt
index d2273bf589..df1a6c7098 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/cleanborrowers.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/cleanborrowers.tt
@@ -2,20 +2,20 @@
Patrons (anonymize, bulk-delete)
-This tool allows you to bulk anonymize circulation histories or bulk delete patron records. This means that the system keeps a link between old loans and their items but severs the link to the borrower.
+This tool allows you to bulk anonymize circulation histories (this means that you keep records of how many times items were checked out - but not the patrons who checked the items out) or bulk delete patrons (remove them from the system completely).
-
- - Once in the tool, you have two options
- - Check the box next to the action(s) you'd like to perform
-
- - To delete borrowers, enter the date since the last time they borrowed
- - To anonymize circulation history enter the date before which you'd like that data deleted
-
-
-
-Is there a way to run this tool automatically?
-Not at this time.
-Will running this report sever the connection between patrons and items that are checked out to them currently?
-No, this report will only remove connections between patrons and items they have checked out in the past but have returned to the library.
+Important: Patrons with outstanding fines or items checked out are not saved. They are not completely removed from the system (moved to the delete_borrowers table), but this tool does not provide as many checks as one may desire.
To either delete or anonymize patrons
+
+
+ - Check the task you would like to perform (Delete or Anonymize)
+ - Enter a date before which you want to alter the data
+ - Click 'Next'
+ - A confirmation will appear asking if you're sure this is what you want to happen
+ - Clicking 'Finish' will delete or anonymize your data
+
+
+See the full documentation for Anonymizing Patrons 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/tools/csv-profiles.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tt
index 9542af2382..86cb3912aa 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tt
@@ -4,21 +4,50 @@
CSV Profiles are created to define how you would like your cart or list to export.
-To add a CSV Profile enter the following info:
+Add CSV Profiles
+
+To add a CSV Profile
+
+
+ - Click 'CSV Profiles' from the Tools menu
+
+ - The 'Profile name' will appear on the export pull down list when choosing 'Download' from your cart or list
+ - The 'Profile description' is for your own benefit
+ - The 'CSV separator' is the character used to separate values and value groups
+ - The 'Field separator' is the character used to separate duplicate fields
+
+ - Example: You may have multiple 650 fields
+
+
+ - The 'Subfield separator' is the character used to separate duplicate subfields
+
+ - Example: You may have multiple $a subfields in a field
+
+
+ - The 'Encoding' field lets you define the encoding used when saving the file
+ - Finally format your CSV file using the 'Profile marcfields' fields
-- The 'Profile name' will appear on the export pull down list when choosing 'Download' from your cart or list
-- The 'Profile description' is for your own benefit
-- Finally format your CSV file using the 'Profile marcfields' fields
-
- Define which fields or subfields you want to export, separated by pipes. Example : 200|210$a|301
+ - Define which fields or subfields you want to export, separated by pipes. Example : 200|210$a|301
+ - Tip: You can also use your own headers (instead of the ones from Koha) by prefixing the field number with an header, followed by the equal sign. Example : Personal name=200|Entry element=210$a|300|009
+
+
+
+
+Modify CSV Profiles
-Once you have created at least one CSV Profile an option to 'Modify CSV Profiles' will appear below the Add form
-
- Choose the profile you would like to edit and alter the necessary fields.
-- To delete a profile, check the 'Delete selelcted profile' option before clicking 'Submit Query'
+Once you have created at least one CSV Profile an 'Edit profile' tab will appear next to the 'New profile' button.
+
+
+ - Choose the profile you would like to edit and alter the necessary fields.
+ - To delete a profile, check the 'Delete selected profile' option before clicking 'Submit Query'
+
Using CSV Profiles
+
Your CSV Profiles will appear on the export list or cart menu under the 'Download' button
+See the full documentation for CSV Profiles 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/tools/export.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tt
index d3a53c032b..df3425af24 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tt
@@ -4,20 +4,32 @@
Koha comes with a tool that will allow you to export your bibliographic and/or holdings data in bulk. This can be used to send your records to fellow libraries, organizations or services; or simply for backup purposes.
-- Fill in the form in order to limit your export to a specific range (all fields are optional)
-- Choose to limit your export by any one or more of the following options
-- Limit to a bib number range
-- Limit to a specific item type
-- Limit to a specific library
-- Limit to a call number range
-- Limit to an acquisition date range
-- Next choose what to skip when exporting
-- By default items will be exported, if you would like to only export bibliographic data, check the 'Don't export items' box
-- To limit your export only to items from the library you're logged in as (if you leave the 'Library' field set to 'All') or to the library you selected above check the 'Remove non-local items' box
-- You can also choose what fields you don't want to export. This can be handy if you're sharing your data, you can remove all local fields before sending your data to another library
-- Finally choose the file type and file name
-- Choose to export your data in marc or marcxml format
-- Choose the name you want your file to save as
-- Click 'Export'
+
+ - Fill in the form in order to limit your export to a specific range (all fields are optional)
+
+ - Choose to limit your export by any one or more of the following options
+
+ - Limit to a bib number range
+ - Limit to a specific item type
+ - Limit to a specific library
+ - Limit to a call number range
+ - Limit to an acquisition date range
+
+ - Next choose what to skip when exporting
+
+ - By default items will be exported, if you would like to only export bibliographic data, check the 'Don't export items' box
+ - To limit your export only to items from the library you're logged in as (if you leave the 'Library' field set to 'All') or to the library you selected above check the 'Remove non-local items' box
+ - You can also choose what fields you don't want to export. This can be handy if you're sharing your data, you can remove all local fields before sending your data to another library
+
+ - Finally choose the file type and file name
+
+ - Choose to export your data in marc or marcxml format
+ - Choose the name you want your file to save as
+
+ - Click 'Export'
+
+
+
+See the full documentation for Exporting MARC Records 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/tools/holidays.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tt
index 505661c517..5ff99edcc8 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tt
@@ -2,65 +2,58 @@
Holidays Calendar
-Libraries can define library closings and holidays to be used when
- calculating due dates. You can make use of the Calendar by turning on
- the proper system preferences:
- Adding Events
- Before adding events, choose the library you would like to apply
- the closings to. When adding events you will be asked if you would
- like to apply the event to one branch or all branches. To add events,
- simply
Click on the date on the calendar that you would like to
- apply the closing to
In the form that appears above the calendar, enter the
- closing information
Library will be filled in automatically based on the
- library you chose from the pull down at the top of the
- page
The day information will also be filled in automatically
- based on the date you clicked on the calendar
In the description enter the reason the library is
- closed
Next you can choose if this event is a one time event or
- if it is repeatable.
Finally decide if this event should be applied to all
- libraries or just the one you have originally selected
After saving you will see the event listed in the summary
- below the calendar
- Editing Events
To edit events
Click on the event on the calendar that you want to change
- (do this by clicking on the date on the calendar, not the event
- listed in the summary)
From this form you can make edits to the holiday or delete
- the holiday completely. Both actions require that you click 'Save'
- before the change will be made.
Clicking on repeatable events will offer slightly different
- options
-
- Additional Help
When adding or editing events you can get additional help by
- clicking on the blue plus sign next to various different options on
- the form
-
-Questions
+Libraries can define library closings and holidays to be used when calculating due dates. You can make use of the Calendar by turning on the proper system preferences:
-Why do I want to add holidays for my branch?
+
+ - Get there: More > Administration > Global System Preferences > Circulation > useDaysMode
+
+ - Choose the method for calculating due date - either include days the library is closed in the calculation or don't include them.
+
+
+ - Get there: More > Administration > Global System Preferences > Circulation > finescalendar
+
+ - This will check the holiday calendar before charging fines
+
+
+
+
+Adding Events
+
+Before adding events, choose the library you would like to apply the closings to. When adding events you will be asked if you would like to apply the event to one branch or all branches. To add events, simply
-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.
+
+ - Click on the date on the calendar that you would like to apply the closing to
+ - In the form that appears above the calendar, enter the closing information
+
+ - Library will be filled in automatically based on the library you chose from the pull down at the top of the page
+ - The day information will also be filled in automatically based on the date you clicked on the calendar
+ - In the description enter the reason the library is closed
+ - Next you can choose if this event is a one time event or if it is repeatable.
+ - Finally decide if this event should be applied to all libraries or just the one you have originally selected
+
+
+ - After saving you will see the event listed in the summary to the right the calendar
+
-
-How do I enable the Holiday Calendar?
+Editing Events
-You can make use of the Holidays Calendar by turning on the proper system preferences
+To edit events
+
+
+
+Additional Help
-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.
+When adding or editing events you can get additional help by clicking on the question mark next to various different options on the form
-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.
+See the full documentation for the Calendar in the manual (online).
[% INCLUDE 'help-bottom.inc' %]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/import_borrowers.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/import_borrowers.tt
index 23f7d0f375..6f8a0bb543 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/import_borrowers.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/import_borrowers.tt
@@ -2,30 +2,59 @@
Patron Import
-
- - Create a CSV file for your patron data
-
- - Format your file with the following fields
-
- - 'surname', 'firstname', 'title', 'othernames', 'initials', 'streetnumber', 'streettype', 'address', 'address2', 'city', 'state', 'zipcode', 'country', 'email', 'phone', 'mobile', 'fax', 'emailpro', 'phonepro', 'B_streetnumber', 'B_streettype', 'B_address', 'B_address2', 'B_city', 'B_state', 'B_zipcode', 'B_country', 'B_email', 'B_phone', 'dateofbirth', 'branchcode', 'categorycode', 'dateenrolled', 'dateexpiry', 'gonenoaddress', 'lost', 'debarred', 'contactname', 'contactfirstname', 'contacttitle', 'guarantorid', 'borrowernotes', 'relationship', 'ethnicity', 'ethnotes', 'sex', 'password', 'flags', 'userid', 'opacnote', 'contactnote', 'sort1', 'sort2', 'altcontactfirstname', 'altcontactsurname', 'altcontactaddress1', 'altcontactaddress2', 'altcontactaddress3', 'altcontactstate', 'altcontactzipcode', 'altcontactcountry', 'altcontactphone', 'smsalertnumber', 'patron_attributes'
-
- -
-
-TIP: Consult your system administrator if you are unsure of how to fill in the above fields.
- -
- IMPORTANT: Make sure the 'branchcode' and 'categorycode' are valid entries in your database.
- - Passwords should be stored in plain text, and will be encrypted as they're imported
-
- -
-
-TIP: If your passwords are already encrypted, talk to your systems administrator about options.
-
-
-
-
- - Select a file to import into the borrowers table
- - If a cardnumber exists in the table, you can choose whether to ignore the new one or overwrite the old one.
- - Click 'Import'
- - You will be brought to a confirmation screen.
-
- [% INCLUDE 'help-bottom.inc' %]
+The patron import tool can be used at any time to add patrons in bulk. It is commonly used in universities and schools when a new batch of students registers.
+
+Creating Patron File
+
+Your Koha installation comes with a blank CSV file that you can use as a template for your patron records. If you would like to create the file yourself, make sure that your file has the following fields in this order as the header row:
+
+borrowernumber, cardnumber, surname, firstname, title, othernames, initials, streetnumber, streettype, address, address2, city, zipcode, country, email, phone, mobile, fax, emailpro, phonepro, B_streetnumber, B_streettype, B_address, B_address2, B_city, B_zipcode, B_country, B_email, B_phone, dateofbirth, branchcode, categorycode, dateenrolled, dateexpiry, gonenoaddress, lost, debarred, contactname, contactfirstname, contacttitle, guarantorid, borrowernotes, relationship, ethnicity, ethnotes, sex, password, flags, userid, opacnote, contactnote, sort1, sort2, altcontactfirstname, altcontactsurname, altcontactaddress1, altcontactaddress2, altcontactaddress3, altcontactzipcode, altcontactcountry, altcontactphone, smsalertnumber, patron_attributes
+
+Important: The 'password' value should be stored in plain text, and will be converted to a md5 hash (which is an encrypted version of the password).
+
+
+ - If your passwords are already encrypted, talk to your systems administrator about options
+
+
+Important: Date formats should match your system preference, and must be zero-padded, e.g. '01/02/2008'.
+
+Important: The fields 'branchcode' and 'categorycode' are required and must match valid entries in your database.
+
+Tip: If loading patron attributes, the 'patron_attributes' field should contain a comma-separated list of attribute types and values.
+
+
+ - The attribute type code and a colon should precede each value.
+
+ - For example: INSTID:12345,LANG:fr or STARTDATE:January 1 2010,TRACK:Day
+ - If an input record has more than one attribute, the fields should either be entered as an unquoted string (previous examples), or with each field wrapped in separate double quotes and delimited by a comma:
+
+ - "STARTDATE:January 1, 2010","TRACK:Day"
+ - This syntax would be required if the data might have a comma in it, like a date string.
+
+
+
+
+
+
+Importing Patrons
+
+Once you have created your file, you can use the Patron Import Tool to bring the data into Koha.
+
+
+ - Choose your CSV file and choose to match on 'Cardnumber' to prevent adding of duplicate card numbers to the system
+ - Next you can choose default values to apply to all patrons you are importing
+
+ - ex. If you're importing patrons specific to one branch you can use the field on the Import form to apply the branch code to all those you are importing.
+
+
+ - Finally you need to decide on what data you want to replace if there are duplicates.
+
+ - A matching record is found using the field you chose for matching criteria to prevent duplication
+ - If you included patron attributes in your file you can decide whether to add your values to existing values or erase existing values and enter only your new values.
+
+
+
+
+See the full documentation for Patron Import in the manual (online).
+
+[% INCLUDE 'help-bottom.inc' %]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/inventory.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/inventory.tt
index 55f4ad9b2e..070de90f76 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/inventory.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/inventory.tt
@@ -15,4 +15,7 @@
If you have a portable scanner (or a laptop and USB scanner) you can walk through the library with the scanner in hand and scan barcodes as you come across them. Once finished you can then upload the text file generated by the scanner to Koha
Choose the text file and the date you want to mark all times as seen and click 'Submit.'
+
+See the full documentation for Inventory 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/tools/koha-news.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tt
index 9c5a3743dc..95916f3739 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tt
@@ -2,15 +2,26 @@
News
-Koha's news module allows librarians to post news to the OPAC and the staff interface.
+
Koha's news module allows librarians to post news to the OPAC, staff interface and circulation receipts.
-To add news to either the OPAC or the Staff Client:
-
- Click 'New Entry'
-- Under 'Display Location' choose whether to put the news on the OPAC or the Librarian (Staff) Interface.
-- Choose a title for your entry
-- Using the publication and expiration date fields you can control how long your item appears
-- 'Appear in position' lets you decide what order your news items appear in
-- The 'News' box allows for the use of html for formatting of your news item
-After filling in all of the fields, click 'Submit'
-- News in the OPAC will appear above the OpacMainUserBlock
-- News in the Staff Client will appear on the far left of the screen
\ No newline at end of file
+To add news to either the OPAC, the Staff Client or a Circulation receipt:
+
+
+ - Click 'New Entry'
+
+ - Under 'Display Location' choose whether to put the news on the OPAC, Slip (circulation receipt) or the Librarian (Staff) Interface.
+ - Choose a title for your entry
+ - Using the publication and expiration date fields you can control how long your item appears
+ - 'Appear in position' lets you decide what order your news items appear in
+ - The 'News' box allows for the use of HTML for formatting of your news item
+
+
+ - After filling in all of the fields, click 'Submit'
+ - News in the OPAC will appear above the OpacMainUserBlock
+ - News in the Staff Client will appear on the far left of the screen
+ - News on the circulation receipts will appear below the items that are checked out
+
+
+See the full documentation for News 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/tools/letter.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt
index 85f731baab..b44cdbd1fc 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt
@@ -1,12 +1,15 @@
[% INCLUDE 'help-top.inc' %]
Notices
-All notices sent by Koha can be customized using the Notices Tool. The system comes with several predefined templates that will appear when you first visit the Notices Tool
-Each notice can be edited, but only a few can be deleted, this is to prevent system errors should a message try to send without a template.
+All notices sent by Koha can be customized using the Notices Tool. The system comes with several predefined templates that will appear when you first visit the Notices Tool
+
+Each notice can be edited, but only a few can be deleted, this is to prevent system errors should a message try to send without a template.
+
Adding Notices
-
- - To add a new notice
+
+
To add a new notice
+
- Click 'New Notice'
- Choose the module this notice is related to
@@ -15,16 +18,17 @@ Each notice can be edited, but only a few can be deleted, this is to prevent sys
- Message Subject is what will appear in the subject line of the email
- In the message body feel free to type whatever message you feel is best, use the fields on the left hand side to enter individualized data from the from database.
- - Important: On overdue notices make sure to use <<items.content>> to print out the data related to all items that are overdue. The other option is to use the <item></item> tags to span the line so that it will print out multiple lines
- - Important: Only the overdue notices take advantage of the <item></item> tags, all other notices referencing items need to use <<items.content>>
-
-
+ - Important: On overdue notices make sure to use <<items.content>> to print out the data related to all items that are overdue. The other option is to use the <item></item> tags to span the line so that it will print out multiple lines
+ - Important: Only the overdue notices take advantage of the <item></item> tags, all other notices referencing items need to use <<items.content>>
+
Notice Markup
-When creating your overdue notices there are two tags in addition to the various database fields that you can use in your notices.
-Important: These new tags only work on the overdue notices, not other circulation related notices at this time.
+
+When creating your overdue notices there are two tags in addition to the various database fields that you can use in your notices.
+
+Important: These new tags only work on the overdue notices, not other circulation related notices at this time.
- <item></item> which should enclose all fields from the biblio, biblioitems, and items tables.
@@ -34,17 +38,26 @@ When creating your overdue notices there are two tags in addition to the various
-An example of using these two tags in a notice template might be like:
-The following item(s) is/are currently overdue:
+An example of using these two tags in a notice template might be like:
+
+
+The following item(s) is/are currently overdue:
<item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item>
-Which, assuming two items were overdue, would result in a notice like:
+
+
+Which, assuming two items were overdue, would result in a notice like:
+
+
The following item(s) is/are currently overdue:
+"A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
+"History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50
+
- "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
- "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50
Existing Notices
-Among the default notices are notices for several common actions within Koha, here are some of what those notices do
+
+Among the default notices are notices for several common actions within Koha, here are some of what those notices do
+
- ACCTDETAILS
@@ -65,7 +78,7 @@ Among the default notices are notices for several common actions within Koha, he
- The patron has requested to receive this notice
- Get there: OPAC > Login > my messaging
- - Get there: Staff Client > Patron Record > Messaging
+ - Get there: Staff Client > Patron Record > Notices
@@ -85,7 +98,6 @@ Among the default notices are notices for several common actions within Koha, he
- ODUE (Overdue Notice)
- This notice is used to send Overdue Notices to Patrons
- - See a Sample Overdue Notice
- Requires that you set Overdue Notice/Status Triggers
@@ -97,8 +109,11 @@ Among the default notices are notices for several common actions within Koha, he
You have the option to select the 'Routing List' notice when creating a new subscription (Choose from the 'Patron notification' drop down).
- Tip: Notice also that if you'd like to notify patrons of new serial issues, you can click on 'define a notice' which will take you to the 'Notices' tool
+ Tip: Notice also that if you'd like to notify patrons of new serial issues, you can click on 'define a notice' which will take you to the 'Notices' tool
+
+See the full documentation for Notices 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/tools/manage-marc-import.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tt
index e2fa5467b2..54bd3f7e12 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tt
@@ -4,24 +4,43 @@
Once you have staged your records for import you can complete the import using this tool.
-- From the list of staged records, click on the file name that you want to finish importing
-- You will note that records that have already been imported will say so under 'Status'
-- A summary of your import will appear along with the option to change your matching rules
-- Below the summary there will be a list of the records that will be imported
-- Review your summary before completing your import to make sure that your matching rule worked and that the records appear as you expect them to
-- Click 'Import into catalog' to complete the import
-- Once your import is complete a link to the new bib records will appear to the right of each title that was imported
-- You can also undo your import by clicking the 'Undo import into catalog' button
-- Records imported using this tool remain in the 'reservoir' until they are cleaned. These items will appear when searching the catalog from the Cataloging tool.
+
+ - From the list of staged records, click on the file name that you want to finish importing
+
+ - You will note that records that have already been imported will say so under 'Status'
+
+
+ - A summary of your import will appear along with the option to change your matching rules
+ - Below the summary is the option to import the batch of bib records using a specific framework
+
+ - Choosing a framework other than 'Default' isn't necessary, but it's helpful for running reports and having the right bib level item type selected on import.
+
+
+ - Below the framework selection there will be a list of the records that will be imported
+
+ - Review your summary before completing your import to make sure that your matching rule worked and that the records appear as you expect them to
+
+
+ - Click 'Import into catalog' to complete the import
+ - Once your import is complete a link to the new bib records will appear to the right of each title that was imported
+ - You can also undo your import by clicking the 'Undo import into catalog' button
+
+
+Records imported using this tool remain in the 'reservoir' until they are cleaned. These items will appear when searching the catalog from the Cataloging tool:
To clean items out of the 'reservoir':
-- Visit the main screen of the Manage Staged MARC Records tool
-- To clean a batch, click the 'Clean' button to the right
-- You will be presented with a confirmation message
-- Accept the deletion and the records will be removed from the reservoir and the status will be changed to 'cleaned'
-- This action cannot be undone, so make sure you confirm that you are cleaning the correct import
+
+ - Visit the main screen of the Manage Staged MARC Records tool
+ - To clean a batch, click the 'Clean' button to the right
+ - You will be presented with a confirmation message
+
+ - Accept the deletion and the records will be removed from the reservoir and the status will be changed to 'cleaned'
+
+
+
+
+See the full documentation for the the Managing Staged MARC Records in the manual (online).
-
[% INCLUDE 'help-bottom.inc' %]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt
index 7b7704b4a8..65e5a85fbf 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt
@@ -1,22 +1,23 @@
[% INCLUDE 'help-top.inc' %]
-Overdue 'Notice/Status Triggers'
-
-This tool lets you define triggers for overdue notices. You can send a borrower up to three reminder emails (depending on your library workflow)
+Overdue Notice/Status Triggers
In order to send the overdue notices that you defined using the Notices tool, you need to first set the triggers to have these messages.
-In order to have overdue notices sent to your patrons, you need to set that patron category to require overdue notices.
+Important: In order to have overdue notices sent to your patrons, you need to set that patron category to require overdue notices.
The Overdue Notice/Status Triggers tool gives the librarian the power to send up to three notices to each patron type notifying them of overdue items
-- Delay is the number of days after an issue is due before an action is triggered.
-- Important: These rules should not be used for Advanced Notices. Advanced Notices should be set using the Enhanched Messaging Preferences on the Patron Profile.
-- Important: If you want Koha to trigger an action (send a letter or restrict a member), a delay value is required.
-- To send additional notices, click on the tabs for 'Second' and 'Third' notice
-- If you would like to prevent a patron from checking items out because of their overdue items, check the 'Restrict' box, this will put a notice on the patron's record at checkout informing the librarian that the patron cannot check out due to overdue items.
-
-If the numbers you've entered in a give row beneath the 'delay' columns are logically inconsistent, Koha will give you an alert, and explain the inconsistency.
+
+ - Delay is the number of days after an issue is due before an action is triggered.
+
+ - Important: If you want Koha to trigger an action (send a letter or restrict member), a delay value is required.
+
+
+ - To send additional notices, click on the tabs for 'Second' and 'Third' notice
+ - If you would like to prevent a patron from checking items out because of their overdue items, check the 'Restrict' box, this will put a notice on the patron's record at checkout informing the librarian that the patron cannot check out due to overdue items.
+ - See a Sample Overdue Notice
+
Sample Overdue Notice
@@ -40,5 +41,7 @@
Sincerely, Library Staff
+See the full documentation for the the Overdue Notice/Status Triggers in the manual (online).
+
[% INCLUDE 'help-bottom.inc' %]
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/picture-upload.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/picture-upload.tt
index 10f160452f..a1e70de6e5 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/picture-upload.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/picture-upload.tt
@@ -1,51 +1,25 @@
[% INCLUDE 'help-top.inc' %]
-
- Upload Patron Images
This tool allows you to upload multiple patron images as a batch.
-
- IMPORTANT: Requires that the 'patronimages' system preference is set to 'ON' to use this feature.
-
- - Get there: More > Administration > Global System Preferences > Patrons > patronimages
-
Upload images in bulk
-
- - Go to the 'Tools' module (usually under 'More' in your Global Nav)
- - Choose 'Upload patron images'
- - You can choose to upload images in bulk by making a zip file with the images and a text file entitled "DATALINK.TXT" or "IDLINK.TXT"
- - For each group of pictures that has the cardnumber of the patron and the file containing that patrons picture. One patron per line separated by either commas or tabs.
-
- -
- IMPORTANT: Make sure that your TXT file is a plain text document, not RTF.
- -
-IMPORTANT: Make sure that you use either a comma or a tab to separate IDs from image names
-
- - Add the images and the TXT file to a .ZIP file
- - Browse for the file from the Koha interface
- - Click 'Unpack' and you will receive a confirmation screen
- - To see the image(s) you imported search for the patron(s) and view their profile
- - If you'd like to change the image, just upload a new image
- - If you'd like to delete the patron image, click the 'Delete' button under 'Manage Patron Image'
-
- Uploading Single Images
-If you only have one patron image you might want to upload it via the patron information page instead of using this bulk tool.
+Upload Patron Images
+
+Patron images can be uploaded in bulk if you are allowing patron images to be attached to patron records. These images can also be used when creating patron cards.
+
+
+ - Create a txt file and title it "DATALINK.TXT" or "IDLINK.TXT"
+ - On each line in the text file enter the patron's card number followed by comma (or tab) and then the image file name
+
+ - Make sure that your TXT file is a plain text document, not RTF.
+
+
+ - Zip up the text file and the image files
+ - Go to the Upload Patron Images Tool
+ - For a single image, simply point to the image file and enter the patron card number
+ - For multiple images, choose to upload a zip file
+ - After uploading you will be presented with a confirmation
+
+
+Important: There is a limit of 520K on the size of the picture uploaded and it is recommended that the image be 200x300 pixels, but smaller images will work as well.
+
+See the full documentation for the the Patron Image Uploader in the manual (online).
-
- - Go to the Patrons menu at the top of the staff client
- - Search for the patron you have the image for
- - If there is more than one result, click on the name of the patron you'd like to add an image to
- - Scroll down to the image upload form
- - Browse for the image on your computer and click 'Upload'
- - If you'd like to change the image, just upload a new image
- - If you'd like to delete the patron image, click the 'Delete' button under 'Manage Patron Image'
-
Why can't I upload patron images?
-First you will need
-
-a patronimages/directory. If you do not have this directory you will see an error.
-
- - Contact your system administrator to create this directory and you'll be set to go.
-
-What size should my images be?
-There is a limit of 520K on the size of the picture uploaded and it is recommended that the image be 200x300 pixels, but smaller images will work as well.
-What image formats are supported?
-Only PNG, GIF, JPEG, XPM formats are supported.
-
[% INCLUDE 'help-bottom.inc' %]
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tt
index af36018196..55537b49fd 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tt
@@ -1,22 +1,28 @@
[% INCLUDE 'help-top.inc' %]
+
Task Scheduler
-The task scheduler is a way to schedule reports to run whenever
- you want.
To schedule a task, visit the Task Scheduler and fill in the
- form
- Current Server Time shows the time on your server (schedule
- all of your reports to run based on that time - not on your local
- time)
Time should be entered as hh:mm (2 digit hour, 2 digit
- minute)
Date should be entered using the calendar pop up
From Report choose the report you want to schedule
Choose whether to receive the text of or a link to the
- results
In the Email filed enter the email of the person you want to
- receive your report
Below the task scheduler form, there is a list of scheduled
- reports
- You can also schedule reports directly from the list of saved
- reports by clicking the 'Schedule' link
- Troubleshooting
Task scheduler will not work if the user the webserver runs as
- doesn't have the permission to use it. To find out if the right user
- has the permissions necessary, check /etc/at.allow to see what users
- are in it. If you don't have that file, check etc/at.deny. If at.deny
- exists but is blank, then every user can use it. Talk to your system
- admin about adding the user to the right place to make the task
- scheduler work.
+
+The task scheduler is a way to schedule reports to run whenever you want.
+
+To schedule a task, visit the Task Scheduler and fill in the form
+
+
+ - Current Server Time shows the time on your server (schedule all of your reports to run based on that time - not on your local time)
+ - Time should be entered as hh:mm (2 digit hour, 2 digit minute)
+ - Date should be entered using the calendar pop up
+ - From Report choose the report you want to schedule
+ - Choose whether to receive the text of or a link to the results
+ - In the Email filed enter the email of the person you want to receive your report
+
+
+Below the task scheduler form, there is a list of scheduled reports
+
+You can also schedule reports directly from the list of saved reports by clicking the 'Schedule' link
+
+Troubleshooting
+
+Task scheduler will not work if the user the web server runs as doesn't have the permission to use it. To find out if the right user has the permissions necessary, check /etc/at.allow to see what users are in it. If you don't have that file, check etc/at.deny. If at.deny exists but is blank, then every user can use it. Talk to your system admin about adding the user to the right place to make the task scheduler work.
+
+See the full documentation for the the Task Scheduler 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/tools/stage-marc-import.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tt
index 34ca8a7172..fbee311f43 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tt
@@ -4,17 +4,31 @@
Importing records into Koha includes two steps. The first is to stage records for import.
-- First find the MARC file on your computer
-- Next you will be presented with options for record matching and item imports
-- Enter 'Comments about this file' to identify your upload when going to the 'Manage Staged MARC Records' tool
-- Choose the character encoding
-- Choose whether or not you want to look for matching records
-- You can set up record matching rules through the administration area
-- Next choose what to do with matching records if they are found
-- Finally choose what to do with records that are unique
-- Next you can choose whether or not to import the item data found in the MARC records
-- Click 'Stage for import'
-- You will be presented with a confirmation of your MARC import
-- To complete the process continue to the Managed Staged MARC Records Tool
+
+ - First find the MARC file on your computer
+ - Next you will be presented with options for record matching and item imports
+
+ - Enter 'Comments about this file' to identify your upload when going to the 'Manage Staged MARC Records' tool
+ - Choose the character encoding
+
+ - If you leave this set to Default Koha will try to guess the encoding, but it should be noted that this is almost always wrong for non-UTF8 records with non-ASCII characters. Specifying a character set is much more reliable if you're not using UTF-8.
+
+
+ - Choose whether or not you want to look for matching records
+
+ - You can set up record matching rules through the administration area
+
+
+ - Next choose what to do with matching records if they are found
+ - Finally choose what to do with records that are unique
+ - Next you can choose whether or not to import the item data found in the MARC records
+
+
+ - Click 'Stage for import'
+ - You will be presented with a confirmation of your MARC import
+ - To complete the process continue to the Managed Staged MARC Records Tool
+
+
+See the full documentation for the MARC Import 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/tools/tools-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/tools-home.tt
index c4b6f8823a..6823273b4f 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/tools-home.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/tools-home.tt
@@ -1,8 +1,9 @@
[% INCLUDE 'help-top.inc' %]
+
Tools
- Many of the subsidiary modules can be found under Tools.
-
- To move forward, select the task you would like to complete.
-
- Specialized help will be available after that point.
[% INCLUDE 'help-bottom.inc' %]
\ No newline at end of file
+Tools in Koha all perform some sort of action. Often many of the items listed under Tools in Koha are referred to as 'Reports' in other library management systems.
+
+See the full documentation for Tools 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/tools/viewlog.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/viewlog.tt
index 31048b1fb2..6bf9cb1fe2 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/viewlog.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/viewlog.tt
@@ -1,18 +1,13 @@
[% INCLUDE 'help-top.inc' %]
-Log View
-
- - The log viewer will show you what actions are being taking in your ILS during a set time period
- - Choose the start and end date you'd like to see and click 'Go' to see the results on your screen
- - You also have the option of exporting this data to use in a different format just by choosing to export to an application.
-
- - This will result in a comma separated value (csv) file.
-
- - You can also choose to filter what you see by any of the fields visible.
-
-Why aren't my cataloging actions being logged?
-You may not have the 'Logs' system preference turned on
-
- - Get there: More > Administration > Global System Preferences > Logs
-
- [% INCLUDE 'help-bottom.inc' %]
\ No newline at end of file
+Log Viewer
+
+Actions within the Koha system are tracked in log files. Your system preferences can be changed to prevent the logging of different actions. These logs can be viewed using the Log Viewer Tool.
+
+Choosing different combinations of menu options will produce the log file for that query.
+
+You will note that real names do not appear on the log, only identifying numbers. You need to use the identifying numbers when searching the logs as well.
+
+See the full documentation for the Log Viewer in the manual (online).
+
+[% INCLUDE 'help-bottom.inc' %]
\ No newline at end of file
--
2.39.5