From 06d40a7cbb863fe0dbfd3347e888ac6b552826f9 Mon Sep 17 00:00:00 2001 From: Nicole Engard Date: Fri, 11 Jul 2008 16:47:01 -0400 Subject: [PATCH] Additional help files Signed-off-by: Joshua Ferraro --- .../modules/help/admin/authorised_values.tmpl | 14 +-- .../prog/en/modules/help/admin/categorie.tmpl | 32 +------ .../prog/en/modules/help/admin/itemtypes.tmpl | 22 +---- .../en/modules/help/circ/branchtransfers.tmpl | 19 +---- .../help/circ/selectbranchprinter.tmpl | 13 +-- .../en/modules/help/members/memberentry.tmpl | 20 +---- .../en/modules/help/members/members-home.tmpl | 16 +--- .../en/modules/help/reports/dictionary.tmpl | 37 +------- .../modules/help/reports/guided_reports.tmpl | 85 +------------------ .../en/modules/help/serials/serials-home.tmpl | 2 +- .../prog/en/modules/help/tools/holidays.tmpl | 10 +-- .../prog/en/modules/help/tools/koha-news.tmpl | 32 +------ .../en/modules/help/tools/picture-upload.tmpl | 9 +- 13 files changed, 27 insertions(+), 284 deletions(-) diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authorised_values.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authorised_values.tmpl index 331ef5bc1f..b8f666cbb3 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authorised_values.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authorised_values.tmpl @@ -1,13 +1,3 @@ - -

Authorised values management

-

Koha allows you to restrict the values that catalogers can place in some MARC subfields to certain pre-defined "authorised" values. These authorised values are defined here.

- -

For example, if your Koha installation is used by several libraries, and you use MARC21, you might want to restrict the 850a MARC subfield to the instition codes for just those libraries. In that case, you could define a new authorised values category (perhaps called "INST") and enter the institution codes as the authorised values for that category. Once the 850a subfield is linked to the INST authorised values category in your MARC tag structure, catalogers must choose a value from the list you define here, and may not type in any other value.

- -

Koha automatically sets up authorised value categories for your item types and branch codes, and you can link these authorised values to MARC subfields when you set up your MARC tag structure.

- - \ No newline at end of file +

Authorized values management

Koha allows you to restrict the values that catalogers can place in some MARC subfields to certain pre-defined "authorized" values. These authorized values are defined here.

Koha automatically sets up authorized value categories for your item types and branch codes, and you can link these authorised values to MARC subfields when you set up your MARC tag structure.

 

"Why would I want to define authorized values for MARC tags?

Authorized Values create a 'controlled vocabulary' for your staff. As an example, let us assume that your Koha installation is used by several libraries, and you use MARC 21. You might want to restrict the 850a MARC subfield to the institution codes for just those libraries. In that case, you could define an authorized values category (perhaps called "INST") and enter the institution codes as the authorized values for that category.


TIP: Koha automatically sets up authorized value categories for your item types and branch codes, and you can link these authorized values to MARC subfields when you set up your MARC tag structure.

Existing Authorized Values

Koha comes with several other categories and pre-defined values your library is likely to use, for instance 'Lost'.


View Authorized Values

Add Authorized Value

Edit authorized values


Add a new Authorized Value Category

 

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tmpl index 1ab892ef16..899e0043d6 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tmpl @@ -1,31 +1,3 @@ - -

Patron Categories

- -

This is where you define the types of users of your library and how they will be handled.

- -

Categories, Descriptions and Types

-

Start by assigning a Category Code and a Description to each patron category. Each Category can be one of five types:

- -

Note on Permissions

-

Patrons in any category type may be assigned permissions in the staff interface. The Staff patron type has additional security features over the other types.

-

Enrollment Period (months)

-

Enrollment period is a number indicating the length in months of a patron enrollment. If enrollments never expire, set this to an impossibly high number ( >= 99).

- -

Upper Age Limit and Age Required

-

Upper Age Limit and Age Required set the age parameters for this type of user. If you issue children's cards to users between the ages of 2 and 18, for example, then Age Required would be "2" and Upper Age Limit would be "18." If there is no upper age limit, set this value to 99 (the highest allowed).

- -

Enrollment Fee and Reserve Fee

-

Enrollment Fee and Reserve Fee (if any) should be entered either as whole numbers or with (up to) six decimal places, with no currency notation (e.g. "1.250000" instead of "$1.25").

- -

Overdue Notice Required

-

Overdue Notice Required lets you bypass generating overdue notices for this user type.

- - +

Patron Categories

This is where you define the types of users of your library and how they will be handled.

Categories, Descriptions and Types

Start by assigning a Category Code and a Description to each patron category. Each Category can be one of five types:

Note on Permissions

Patrons in any category type may be assigned permissions in the staff interface. The Staff patron type has additional security features over the other types.

Enrollment Period (months)

Enrollment period is a number indicating the length in months of a patron enrollment. If enrollments never expire, set this to an impossibly high number ( >= 99).

Upper Age Limit and Age Required

Upper Age Limit and Age Required set the age parameters for this type of user. If you issue children's cards to users between the ages of 2 and 18, for example, then Age Required would be "2" and Upper Age Limit would be "18." If there is no upper age limit, set this value to 999 (the highest allowed).

Enrollment Fee and Reserve Fee

Enrollment Fee and Reserve Fee (if any) should be entered either as whole numbers or with (up to) six decimal places, with no currency notation (e.g. "1.250000" instead of "$1.25").

Overdue Notice Required

Overdue Notice Required lets you bypass generating overdue notices for this user type.

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/itemtypes.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/itemtypes.tmpl index ad95063d6f..14e6406e63 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/itemtypes.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/itemtypes.tmpl @@ -1,21 +1,3 @@ - -

Item types management

-

You can define as many item types as you want.

- -

The item types are the "categories" into which your library items fall. For instance, you probably want to have videocassettes in a different category from non-fiction books, and mysteries in a different category from children's picture books. If you already are using a commercial ILS, you almost certainly already have all of your materials divided up into such categories. Now you need to tell Koha what your categories are.

- -

The itemtype code is limited to four characters. This code is rarely displayed by Koha; instead the description of the type will be what users see.

- -

"Rental charge" is any amount you might charge to users for borrowing items of a certain type (like videos).

- -

"Renewals allowed" indicates how many times an items of this type may be renewed.

- -

Item types are useful for many things, and very important in controlling how Koha works :

- -

Setting up item types is one of the first things you should do after installing the Koha software.

- - \ No newline at end of file +

Item types management

You can define as many item types as you want.

The item types are the "categories" into which your library items fall. For instance, you probably want to have videocassettes in a different category from non-fiction books, and mysteries in a different category from children's picture books. If you already are using a commercial ILS, you almost certainly already have all of your materials divided up into such categories. Now you need to tell Koha what your categories are.

The itemtype code is limited to four characters. This code is rarely displayed by Koha; instead the description of the type will be what users see.

"Rental charge" is any amount you might charge to users for borrowing items of a certain type (like videos).

"Renewals allowed" indicates how many times an items of this type may be renewed.

Item types are useful for many things, and very important in controlling how Koha works :

Setting up item types is one of the first things you should do after installing the Koha software.

 

Adding & Editing New Item Types



Can I have a different type for new releases and older titles?

Yes.  Just enter an item type for new items and assign different circulation rules for this item type.

 

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/branchtransfers.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/branchtransfers.tmpl index 8f9608ffc6..0265b91a90 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/branchtransfers.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/branchtransfers.tmpl @@ -1,18 +1,3 @@ - -

Circulation Transfers -

- -

Q: What is Circulation Transfers? -

-

A: Allows reassignment of an item to another Library.

- -

Q: How do I use Circulation Transfers?

- -

A: Enter the item’s barcode, select the destination library, click on the “transfer button”. A successful transfer will result in a “Transferred Items” confirmation box appearing.

- - -

Q: How does Circulation Transfers change the status of the item? -

A: The item is shown as belonging to the transferred library.

- - +Circulation Transfers

This tool allows temporary reassignment of an item to another branch.

+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/selectbranchprinter.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/selectbranchprinter.tmpl index 58aac825b0..05556cad77 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/selectbranchprinter.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/selectbranchprinter.tmpl @@ -1,12 +1,3 @@ - -

What is a home branch? -

The home branch is the branch you want recorded as the origination of circulation functions for a computer session. For example, if your home branch is set to “main”, any items scanned to a patron on from that computer will be considered by Koha to be checked ‘from’ the “main” branch. An item transferred on that computer will be recorded as transferred ‘from’ the “main” branch.

-

How do I select a home branch? -

Select your home branch from the “Choose your branch” dropdown menu.

IMPORTANT: You must set your home branch each time you login to Koha’s intranet. For instance, you set home branch at the beginning of the work day, or each time the computer is restarted.

-

Why would I want to set a home branch? -

Setting your home branch is critical. It enables Koha to accurately record statistics, circulation (what branch an item has been checked out from or returned to), and transfers.

-

IMPORTANT: Check your branch -

If you forget to set your home branch at the beginning of a computer session, Koha will set the first branch in the dropdown list as the ‘home branch’. This means Koha’s statistics will be inaccurate.

- - \ No newline at end of file +

Set Library:

There are three ways to set your home branch.

IMPORTANT:  You will not be able to perform circulation functions without first setting a library.

What is a home branch?

The home branch is the branch you want recorded as the origination of circulation functions while you are logged in.

For example, if your home branch is set to 'Main Library', any items checked out to a patron on your terminal will be considered by Koha to be checked out from the 'Main Library' branch. An item transferred on that computer will be recorded as transferred from the 'Main Library' branch.

Why would I want to set a home branch?

Setting your home branch is critical. It enables Koha to accurately record statistics, circulation (what branch an item has been checked out from or returned to), and transfers.


+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/memberentry.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/memberentry.tmpl index b90328feb3..6fc928aba8 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/memberentry.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/memberentry.tmpl @@ -1,19 +1,3 @@ - -

Add member help

-

Add Member, person

-

This is the form for adding a new single member to the database. There is also a form for organisations, such as other libraries and non profit organisations you might lend to. You should use the Add Organisation tab at the top of the Member page for that.

-

Every field with an asterisk must be filled out, or you will get an error, and the record will not be added to the database.

-

If you accidentally have two members with the same card number, the second duplicate will show up as just commas after you confirm the record.

-

When you are done with the record, click the Save button at the bottom.

-

The clear all Fields button will reset the page to a blank form in case you made a mistake.

- -

Add Member, Institutional

-

This is the form for adding a group of members. Suppose you had a YMCA group, or lend books to other Libraries. This would be the form to use for that purpose.

-

Every field with an asterisk must be filled out, or you will get an error, and the record will not be added to the database.

-

If you accidentally have two members with the same card number, the second duplicate will show up as just commas after you confirm the record.

-

When you are done with the record, click the Save button at the bottom.

-

The clear all Fields button will reset the page to a blank form in case you made a mistake.

-

You can always come back and edit what you enter in the Add Member screen by searching for the patron by using their last name or card number, selecting a user by clicking on the entry in the search list, and then clicking the Modify button on the member information screen.

- - \ No newline at end of file +

Add Patrons

Adding a New Patron

IMPORTANT: System preferences should be defined before adding new patrons.
Add a new patron:
+ diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/members-home.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/members-home.tmpl index 452ae6051c..f3d232ddc2 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/members-home.tmpl +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/members-home.tmpl @@ -1,15 +1,3 @@ - -

Patrons help

-

This is the Patrons module of Koha.

-

The Patrons portion stores the information you add about your patrons.

-

To add a patron, type their name into the search box on the left, and -click the OK button.

-

If there is already a patron matching the name you searched, it will show -after you click OK. This can be particularly useful when people have lost -their cards or when children forget their cards. That way, you can avoid having -multiple numbers for the same patron.

-

Alternatively, you can browse a section of patron by selecting the first -letter of the Patron's last name from the list on the right.

- - \ No newline at end of file +

Patrons help

This is the Patrons module of Koha.

The Patrons portion stores the information you add about your patrons.

+ 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 1ffd6c8fb4..db90e7fef1 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 @@ -1,36 +1,3 @@ - -

Guided Reports Dictionary Help

- -

What is the Guided Reports Dictionary

-

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

- -

Adding A New Definition

-

Step 1 of 4 Name

-

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

-
    -
  1. Definition Name: Short name that is used for display and selection
    2. -
  2. Definition Description: Used within the dictionary only to provide further detail about the definition
    3. -
-

Step 2 of 4 Area

-

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

-

Step 3 of 4 Columns

-

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.

-

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.

-

Step 4 of 4 Values

-

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

- - -

Using A Definition>

-

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

- - \ No newline at end of file +

Reports Dictionary Help

What is the Reports Dictionary

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

Adding A New Definition

Step 1 of 4 Name

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

  1. Definition Name: Short name that is used for display and selection

  2. Definition Description: Used within the dictionary only to provide further detail about the definition

Step 2 of 4 Area

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

Step 3 of 4 Columns

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.

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.

Step 4 of 4 Values

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

Using A Definition

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

+ 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 92fe07a60a..703b45bd6d 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,84 +1,3 @@ - - -

Guided Reports Help

- -