From 0b69b8ffc327cb497b5455e5ff855cbcdaf1c072 Mon Sep 17 00:00:00 2001 From: Nicole Engard Date: Thu, 10 Jul 2008 09:11:46 -0400 Subject: [PATCH] Adding some further help files Signed-off-by: Joshua Ferraro --- .../en/modules/help/acqui/acqui-home.tmpl | 23 +----- .../en/modules/help/admin/aqbookfund.tmpl | 16 +--- .../modules/help/admin/systempreferences.tmpl | 74 +------------------ .../en/modules/help/members/moremember.tmpl | 18 +---- .../en/modules/help/reports/reports-home.tmpl | 8 +- .../prog/en/modules/help/serials/claims.tmpl | 14 +--- .../en/modules/help/serials/serials-home.tmpl | 29 +------- .../help/suggestion/acceptorreject.tmpl | 17 +---- .../modules/help/virtualshelves/shelves.tmpl | 41 +--------- 9 files changed, 19 insertions(+), 221 deletions(-) diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/acqui-home.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/acqui-home.tmpl index 2e467f4c3a..9cf439c87f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/acqui-home.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/acqui-home.tmpl @@ -1,22 +1,3 @@ -

Acquisitions Help

What is Acquisitions?

- -

The Koha Acquisitions module provides a way where the library can record orders placed with vendors and manage purchase budgets.

You do not need to use Acquisitions to add items to your catalogue. If you do not want to track orders and budget expenditure, then use the "Add MARC" feature in Cataloging to add new bibliographic and item records.

- -

How to place an order?

- -

To place an order, the first step is to locate your Vendor (supplier). If no Vendor exists, you will need to create one. Once you have a Vendor you can place an order.

- -

How to receive an order?

- -

There are two ways to receive an order:

  1. By Supplier (Supplier Search) - search for the vendor and view all order associated with the item.
  2. By Order (Orders Search) - enter the title of the ordered Item in the orders search and locate the item.

What needs to be setup to use Acquisitions?

- -

To make the most of acquisitions the following needs to be setup under System Administration

- -

How do you handle donated items?

In Koha, doners are simply vendors who do not charge anything for items. You can either setup a catchall vendor account for all donations, or setup a new vendor account for each doner. When items are "ordered" from a vendor, simply enter 0 in the purchase price. If you wish to, you can record the actual value of the item in the "Replacement Cost" field.  - - +

Acquisitions Help

What is Acquisitions?

The Koha Acquisitions module provides a way where the library can record orders placed with vendors and manage purchase budgets.

You do not need to use Acquisitions to add items to your catalogue. If you do not want to track orders and budget expenditure, then use the "Add MARC" feature in Cataloging to add new bibliographic and item records.

How to place an order?

To place an order, the first step is to locate your Vendor (supplier). If no Vendor exists, you will need to create one. Once you have a Vendor you can place an order.

What needs to be setup to use Acquisitions?

To make the most of acquisitions the following needs to be setup under System Administration

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbookfund.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbookfund.tmpl index 3c82b08384..dddcbe8bd9 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbookfund.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbookfund.tmpl @@ -1,15 +1,3 @@ - -

Fund Administration

- -

The first time you access this page, you will be asked to add your first fund -- thereafter you will also have the option of editing and deleting funds.

- -

Funds may be ignored if you are setting your System Preferences to "simple" acquisitions: the funds are only useful when using "normal" acquisitions.

- -

"Funds" are accounts that you establish to keep track of your expenditures for library materials. They may be used for any kind of material and should match the lines in your materials budget. For instance, if your library establishes a budget line for books, another for audiovisual materials, a third line for magazines, and a fourth budget line for electronic databases, then you would have four funds.

- -

Each fund has a unique fund code, limited to no more than five characters, that identifies it. You should decide on your fund codes (e.g. something like BOOKS, AV, MAGS, DATA for the four funds described above) and enter the code in the "fund" box, then a full name in the "Name" box.

- -

Once you have set up a fund, you will see a link to a page for setting up the fund budget. Here you will enter the beginning and ending dates of your budget year and the amount of money in that particular budget line. Do not use any kind of currency notation (like "$") or commas when entering the number. (Commas will be converted to decimal points.) NOTE: Your dates will not saved correctly unless you have set your date format in the System Preferences section of the Parameters page -- DO THIS BEFORE setting budgets.)

- - \ No newline at end of file +

Fund Administration

The first time you access this page, you will be asked to add your first fund -- thereafter you will also have the option of editing and deleting funds.

Funds may be ignored if you are setting your System Preferences to "simple" acquisitions: the funds are only useful when using "normal" acquisitions.

"Funds" are accounts that you establish to keep track of your expenditures for library materials. They may be used for any kind of material and should match the lines in your materials budget. For instance, if your library establishes a budget line for books, another for audiovisual materials, a third line for magazines, and a fourth budget line for electronic databases, then you would have four funds.

Each fund has a unique fund code, limited to no more than five characters, that identifies it. You should decide on your fund codes (e.g. something like BOOKS, AV, MAGS, DATA for the four funds described above) and enter the code in the "fund" box, then a full name in the "Name" box.

Once you have set up a fund, you will see a link to a page for setting up the fund budget. Here you will enter the beginning and ending dates of your budget year and the amount of money in that particular budget line. Do not use any kind of currency notation (like "$") or commas when entering the number. (Commas will be converted to decimal points.)

NOTE: Your dates will not save correctly unless you have set your date format in the System Preferences section of the Parameters page -- DO THIS BEFORE setting budgets.)

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/systempreferences.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/systempreferences.tmpl index 981e14c799..421319c6a5 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/systempreferences.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/systempreferences.tmpl @@ -1,73 +1,3 @@ - -

System preferences administration

-

This page allows you to set the system preferences that control much of the basic behavior of Koha. These parameters should be set before any other parameters.

- - - \ No newline at end of file +

System preferences administration

This page allows you to set the system preferences that control much of the basic behavior of Koha.

Each of the tabs on the left holds several different preferences:

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/moremember.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/moremember.tmpl index 71df82bf46..b8158cbc98 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/moremember.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/moremember.tmpl @@ -1,17 +1,3 @@ - -

Member Information Screen

-

This screen shows the information associated with a given patron.

-

On the top left is their address and card number.

-

A patron's annual membership fee payment status also shows on this screen.

-

Any fines a patron has will show up in the top middle of this screen.

-

Any materials a patron has requested will show up on the top right of this screen.

-

You can get information on what a patron has read in the past by clicking on the Circulation History button.

-

Any items a patron currently has out will show up under "Items currently checked out".

-

If you would like to edit a patron's information, click the modify button on the lower left.

-

If you would like to PERMANENTLY delete a user, click the delete button on the lower left. A confirmation box will -appear, so don't worry about accidentally deleting a record. Just be absolutely sure before you delete!

-

The change password button allows a user to either set a new password or change their current password. This is useful to patrons that wish to place reserves online from home. You cannot see a password again once you change it, but you can reset a password.

-

Modify user flags allows an administrator to set which clerks, librarians, patrons, technical support people or trustees have access to certain parts of the database. Right now, one can either have permission to access everything on the Intranet side, or just have access to the OPAC.

-

If no patron image exists for this patron, click the "Add Patron Images" link to add an image or images. The pixel dimensions should not exceed 120 X 200. Keep this in mind when obtaining patron images as it will affect how the images appear on this page.

- +

Member Information Screen

This screen shows the information associated with a given patron.

On the top left is their address and card number.

A patron's annual membership fee payment status also shows on this screen.

At the bottom of the patron information page you will find quick access to items the patron has checked out, overdue and on hold.

You can get information on what a patron has read in the past by clicking on the Circulation History button.

If you would like to edit a patron's information, click the 'Edit' button.  You can also click one of the 'Edit' links below each section on the patron record.

If you would like to PERMANENTLY delete a user, click 'Delete' under 'More'. A confirmation box will appear, so don't worry about accidentally deleting a record. Just be absolutely sure before you delete!

If no patron image exists for this patron, click the "Add Patron Images" link to add an image or images. The pixel dimensions should not exceed 120 X 200.

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tmpl index 194f2923cf..7132a04e10 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/reports-home.tmpl @@ -1,7 +1,3 @@ - -

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 the Circulation module for 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. Note this feature is under active development.

- - \ No newline at end of file +

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

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/serials/claims.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/serials/claims.tmpl index e2aa23f632..be63d4b606 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/serials/claims.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/serials/claims.tmpl @@ -1,13 +1,3 @@ - -

Serials Claims

What are Claims?

- -

Claims are where an issue that was expected has not been received by the library. The claims interface is used to manage those claims, in particular provide the expected issue information that can be sent to the supplier.

- -

How to lodge a Claim?

- -

Make a selection from the drop down list. The "All Supplies" count gives you a count of the total number of current item claims across all suppliers.

There are two ways to lodge a claim with the supplier:

  1. Using a Letter defined in Notices. Note that you will need to set up the notice.
  2. Exporting the claims information. This downloads a CSV file to your local machine with all the claim data ready for additional formatting before sending to the supplier.

How to resolve a Claim?

- -

The claim will be resolved once received status has changed. Search for the Subscription and then click "Serial receive" to locate the issue and change it's status.

- - +

Serials Claims

What are Claims?

Claims are where an issue that was expected has not been received by the library. The claims interface is used to manage those claims, in particular provide the expected issue information that can be sent to the supplier.

How to lodge a Claim?

Make a selection from the drop down list. The "All Suppliers" count gives you a count of the total number of current item claims across all suppliers.

There are two ways to lodge a claim with the supplier:

  1. Using a Letter defined in Notices. Note that you will need to set up the notice.
  2. Exporting the claims information. This downloads a CSV file to your local machine with all the claim data ready for additional formatting before sending to the supplier.

How to resolve a Claim?

The claim will be resolved once received status has changed. Search for the Subscription and then click "Serial receive" to locate the issue and change it's status.

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/serials/serials-home.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/serials/serials-home.tmpl index 78abef0cea..4b201cad1f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/serials/serials-home.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/serials/serials-home.tmpl @@ -1,28 +1,3 @@ - -

Serials

Q: What does the serials module do?

- -

The serials module is used to manage subscriptions the library has to vairous titles. These are normally Serials or Journals, but in practice can be anything.

- -

Q: What do I need before I can setup a subscription?

- -

Before you can setup up a subscription, you will need to setup a "Vendor" under Acquisitions, and a new "Biblio" under Cataloging. When cataloging the new biblio, do not add any items. Adding of items is handled by the Serials module.

- -

Q: How to search for a subscription? -

-

A: Search by using the filter button (either title or ISSN).

- -

Q: How do I create a new subscription?

-

A: Click the “Add subscription” button.

- -

Q: What can I do when I have found a subscription? -

-

A: View subscription details, receive any item and/or manage what appears in subscription summary (in OPAC and librarian interface.

- -

TIP. USING WILDCARDS. -

- -

If you enter a title, you can use the wildcard % : entering %Times% returns every subscription containing Times in the title. Entering New York% returns every subscription with title starting with New York.

- - - \ No newline at end of file +

Serials

Q: What does the serials module do?

The serials module is used to manage subscriptions the library has to vairous titles. These are normally Serials or Journals, but in practice can be anything.

Q: What do I need before I can setup a subscription?

Before you can setup up a subscription, you will need to setup a "Vendor" under Acquisitions, and a new "Biblio" under Cataloging. When cataloging the new biblio, do not add any items. Adding of items is handled by the Serials module.

Q: How do I create a new subscription?

A: Click the “Add subscription” button.

Q: What can I do when I have found a subscription?

A: View subscription details, receive any item and/or manage what appears in subscription summary (in OPAC and librarian interface.

TIP. USING WILDCARDS.

If you enter a title, you can use the wildcard % : entering %Times% returns every subscription containing Times in the title. Entering New York% returns every subscription with title starting with New York.

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/suggestion/acceptorreject.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/suggestion/acceptorreject.tmpl index 819557c499..864a898385 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/suggestion/acceptorreject.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/suggestion/acceptorreject.tmpl @@ -1,16 +1,3 @@ - -

Suggestions Management

What are Purchase Suggestions?

- -

Purchase suggestions give the users of the OPAC a way to lodge requests for the library to purchase for items.

To use this feature, purchase suggestions need to be turned on in system preferences. (System Preferences > OPAC Features > Suggest set to "on").

- -

How do I manage suggestions?

- -

Suggestions that have been placed but not acted upon will show on the "Waiting" tab below. To process a suggestion the "Status" needs to be changed and a "Reason" chosen.

-

Marking an item as "Accepted", will move the suggestion to the Accepted tab. The suggested item can now be added to an order in Acquisitions by using the "From a Suggestion" feature under "Add To Order".

-

Marking an item  as "Rejected", will move the selected item to the rejected tab.

-

When ever the status is changed to Accepted or Rejected, the reason for the status change can be selected from the "Reason" drop down. Reasons are Authorised values that need to be setup by the library. There is also the option to select "Other" and enter a custom reason.

-

The authorised values for "Reason" can be set under System Administration > Authorised Values. From the drop down select the "SUGGEST" authorised value category and add your custom reasons.

-

Once the status and reason have been selected, these will display for the suggestor in the OPAC.

- - +

Suggestions Management

What are Purchase Suggestions?

Purchase suggestions give the users of the OPAC a way to lodge requests for the library to purchase for items.

To use this feature, purchase suggestions need to be turned on in system preferences. (System Preferences > OPAC Features > Suggest set to "on").

How do I manage suggestions?

Suggestions that have been placed but not acted upon will show on the "Waiting" tab below. To process a suggestion the "Status" needs to be changed and a "Reason" chosen.

Marking an item as "Accepted", will move the suggestion to the Accepted tab. The suggested item can now be added to an order in Acquisitions by using the "From a Suggestion" feature under "Add To Order".

Marking an item  as "Rejected", will move the selected item to the rejected tab.

When ever the status is changed to Accepted or Rejected, the reason for the status change can be selected from the "Reason" drop down. Reasons are AuthoriZed values that need to be setup by the library. There is also the option to select "Other" and enter a custom reason.

The authorized values for "Reason" can be set under System Administration > Authorised Values. From the drop down select the "SUGGEST" authorized value category and add your custom reasons.

Once the status and reason have been selected, these will display for the suggestor in the OPAC.

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/virtualshelves/shelves.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/virtualshelves/shelves.tmpl index d77f43f136..612350d8e6 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/virtualshelves/shelves.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/virtualshelves/shelves.tmpl @@ -1,38 +1,3 @@ - - -

Q: What are "Lists"? -

Lists are editable, permanent book lists. If the Systems Preference for Lists has been enabled, both staff and patrons may create Lists. An item included on a Virtual Shelf is directly linked to that item’s bibliographic record in the Online Catalog. Clicking on the item will take you directly the the item’s “Details Screen” and allow you to check for availability, find the item’s location or reserve the item.

-

IMPORTANT: Patrons must be logged in to their account online to create and edit shelves. -

-

TIP: Why staff might use Lists -

Lists are a great tool for Reader’s Advisory. Staff can use Lists to create a variety of reading lists for patrons (for example, according to age and reading level, or on specific topics).

-

TIP: Why educators might use Lists -

Lists can be used by professors to create a bibliography/ reading list for class assignments. Clicking on an item in a List connects directly to the details page of that item in the Online Catalog. Students can easily see where the item is in the library and whether or not ist is available for checking out.

-

Q: What types of "Lists" are there? -

Koha supports three types of Lists:

-

TIP: Patron uses for Lists -

Patrons can use Lists to share their reading favorites/ preferences with other patrons by creating one or more “Public Shelves”. By creating “Private Shelves”, patrons can keep lists of what they’ve read, or what they want to read for research or recreation. “Free Shelves” are a great way to create an evolving, community-based reader advisory.

-

Q: How do I create a new "List" from the Staff Intranet? -

To create a new List:

  1. Click on “Lists” (You should see a list of shelves that have already been created)
  2. Click on “Add or Remove Book Shelves”
  3. Under “Add Shelf”, enter a name for your new shelf in the “Name” field.
  4. Choose a “Category” (”Public” or “Private”)
  5. Click on “Add New Shelf”
-

Q: How do you add items to a "List" from the Staff Intranet? -

A: You can add items to a List in one of two ways: by barcode OR through a search in the online catalog.

-

To add items by barcode? -

  1. Click on the List you wish to add items to.
  2. In the “Barcode” field, scan or type the barcode and click “Save”
-

To add items through the online catalog? -

  1. Search for the item/s using the Quick or Advanced Search
  2. Click on “Brief Display” in that item’s Details Screen
  3. Click “Add to Shelf”. A pop-up window will open.
  4. Choose an existing shelf in the pull-down menu (”Add to List”) OR Create a New Bookshelf at that time by entering a name for the shelf and choosing a “Category” (”Public” or “Private”)
  5. Click “Add to List”
-

IMPORTANT: No Bulk Additions -

At present, there is no option to add a list of items to the Lists in ‘bulk’. You must search on the item and add in via the “Brief Display” or enter the barcode.

-

TIP: Staff Accounts -

Staff may login to their own account and add/create Lists from within their account, though it is not necessary.

-

TIP: Easy to remember -

The “Brief Display” of an item in the Staff Intranet is the same display as the Details Screen of that item in the OPAC. This is an easy way to remember that you add to the List from this page.

-

Q: How do you add items to a "List" from the OPAC (the publicly accessible catalog)? -

  1. Log in to your account
  2. Search for the item/s using the Quick or Advanced Search.
  3. Click on “Brief Display” in that item’s Details Screen
  4. Click “Add to My List”. A pop-up window will open.
  5. Choose an existing shelf in the pull-down menu (”Add to List”) OR Create a New Bookshelf at that time by entering a name for the shelf and choosing a “Category” (”Public”,”Private” or “Free”)
  6. Click “Add to My List”
-

IMPORTANT: No Bulk Additions -

At present, there is no option to add a list of items to the Lists in ‘bulk’. You must search on the item and add in via the “Brief Display” or enter the barcode.

-

Q: How do you delete an item in a List? -

  1. Check the box next to the item/s you wish to delete.
  2. Click “Remove Selected Items”
-

Q: How do you delete a List? -

  1. Click on Shelf you wish to delete.
  2. Click “Delete this Shelf”

OR

  1. Click on “Add or Remove Book Shelves”
  2. Under Delete Lists, Check the box next to the item/s you wish to delete.
  3. Click “Remove Selected Items”
- - \ No newline at end of file + +

Q: What are "Lists"?

Lists are editable, permanent book lists. If the 'virtualshelves' Systems Preference has been enabled, both staff and patrons may create Lists. An item included on a List is directly linked to that item’s bibliographic record in the Online Catalog. Clicking on the item will take you directly the the item’s “Details Screen” and allow you to check for availability, find the item’s location or reserve the item.

IMPORTANT: Patrons must be logged in to their account online to create and edit lists.

TIP: Why staff might use Lists

Lists are a great tool for Reader’s Advisory. Staff can use Lists to create a variety of reading lists for patrons (for example, according to age and reading level, or on specific topics).

TIP: Why educators might use Lists

Lists can be used by professors to create a bibliography/reading list for class assignments. Clicking on an item in a List connects directly to the details page of that item in the Online Catalog. Students can easily see where the item is in the library and whether or not ist is available for checking out.

Q: What types of "Lists" are there?

Koha supports two types of Lists:

TIP: Patron uses for Lists

Patrons can use Lists to share their reading favorites/ preferences with other patrons by creating one or more “Public Lists”. By creating “Private Lists”, patrons can keep lists of what they’ve read, or what they want to read for research or recreation.

Q: How do I create a new "List" from the Staff Intranet?

To create a new List:

  1. Click on “Lists” (You should see a list of shelves that have already been created)
  2. Click 'New List'
  3. Name your list
  4. Choose a “Category” (”Public” or “Private”)
  5. Click 'Save'
+ -- 2.39.5