From 674ad5f4defc570053e276fdfd3770172674d2b2 Mon Sep 17 00:00:00 2001 From: tipaul Date: Fri, 19 Nov 2004 15:13:11 +0000 Subject: [PATCH] online help --- .../default/en/help/admin/aqbookfund.tmpl | 15 ++++ .../en/help/admin/authorised_values.tmpl | 11 +++ .../default/en/help/admin/branches.tmpl | 10 +++ .../default/en/help/admin/categorie.tmpl | 18 +++++ .../default/en/help/admin/checkmarc.tmpl | 5 ++ .../default/en/help/admin/currency.tmpl | 6 ++ .../default/en/help/admin/issuingrules.tmpl | 19 +++++ .../default/en/help/admin/itemtypes.tmpl | 26 ++++--- .../default/en/help/admin/koha2marclinks.tmpl | 12 ++++ .../help/admin/marc_subfields_structure.tmpl | 25 +++++++ .../en/help/admin/marctagstructure.tmpl | 25 +++++++ .../default/en/help/admin/printers.tmpl | 7 ++ .../default/en/help/admin/stopwords.tmpl | 8 +++ .../en/help/admin/systempreferences.tmpl | 70 +++++++++++++++++++ .../default/en/help/admin/z3950servers.tmpl | 15 ++++ 15 files changed, 264 insertions(+), 8 deletions(-) create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/aqbookfund.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/authorised_values.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/branches.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/categorie.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/checkmarc.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/currency.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/issuingrules.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/koha2marclinks.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/marc_subfields_structure.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/marctagstructure.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/printers.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/stopwords.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/systempreferences.tmpl create mode 100644 koha-tmpl/intranet-tmpl/default/en/help/admin/z3950servers.tmpl diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/aqbookfund.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/aqbookfund.tmpl new file mode 100644 index 0000000000..7a91e48423 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/aqbookfund.tmpl @@ -0,0 +1,15 @@ + + +

Book Fund Administration

+ +

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

+ +

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


+ +

"Book Funds" are accounts that you establish to keep track of your expenditures for library materials. They may be used for any kind of material, not just books, 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 Book Funds.

+ +

Each Book 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 book funds described above) and enter the code in the "Book 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 diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/authorised_values.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/authorised_values.tmpl new file mode 100644 index 0000000000..45f84bbe51 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/authorised_values.tmpl @@ -0,0 +1,11 @@ + +

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.

+ diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/branches.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/branches.tmpl new file mode 100644 index 0000000000..eaf254a54c --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/branches.tmpl @@ -0,0 +1,10 @@ + + +

Library Branches

+ +

Fill in information about your library service outlets on this page.

+ +

Begin by defining your branch categories. If, for example, you have one main library and several branch libraries, you might set up an "M" (Main) category and a "B" (Branch) category, with descriptions "Main Library" and "Branch Library."

+ +

Now add the names and addresses, phone numbers, etc of your libraries in the "Branches" section. (All of your libraries should be described here, not just the branch libraries.) Give each library a unique and easily-remembered code (maximum of four characters). This code will be used in Koha's database to identify each library. When libraries are listed in Koha, they will be listed in alphabetical order by code. (Note that until you set your branch the first time you use a computer to circulate items in Koha, the branch will default to the first library in the alphabetical code list -- be careful to set the branch the first time you use Koha or whenever you add a new computer!)

+ \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/categorie.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/categorie.tmpl new file mode 100644 index 0000000000..069f9ec833 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/categorie.tmpl @@ -0,0 +1,18 @@ + +

Borrower Categories

+ +

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

+ +

Start by assigning a Category Code and a Description to each borrower type. The code is limited on no more than two characters and may be anything you choose. Four codes, however, have special meaning for Koha :

+ + +

Enrollment period is a number indicating how many years a user's enrollment is valid. If you consider enrollments to expire after four years for example (as in a school, perhaps), then set this number to 4. If enrollments never expire, set this to an impossibly high number (99).

+ +

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 (if any) should be entered either as whole numbers or with six decimal places, with no currency notation (e.g. "1.250000" instead of "$1.25"). Overdue Notice Required lets you bypass generating overdue notices for this user type, and Issue Limit sets the highest number of items which this type of user may have borrowed.

+ \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/checkmarc.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/checkmarc.tmpl new file mode 100644 index 0000000000..4ab60a9fad --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/checkmarc.tmpl @@ -0,0 +1,5 @@ + +

Once you have completed the process of setting up your MARC tag structure (MarcTagstruct) and checked your MARC to Koha mapping (Koha2MarcLinks), click on this link to activate a small program that checks for major errors in your MARC setup.

+ +

This MARC check does not guarantee that you will like the first results of your efforts to set up your MARC displays, etc. -- it simply checks for major errors. You will probably revise your MARC setup several times before you are completely pleased with it. Be sure to run checkmarc after every revision.

+ diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/currency.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/currency.tmpl new file mode 100644 index 0000000000..20a23796f9 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/currency.tmpl @@ -0,0 +1,6 @@ + +

Currencies administration

+

Define the currencies you deal with here.

+ +

You should at least define your local currency here, giving it a name (like US DOLLAR or EURO) and setting the "rate" at 1. If you do business with vendors who charge in a different currency, enter a name for that currency (e.g. PESO) and set the approximate exchange rate compared to your currency. (Note: names are limited to 10 characters or less.) The exchange rate is used to calculate the remain balances in your materials budgets when you purchase materials using "normal" acquisitions.

+ \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/issuingrules.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/issuingrules.tmpl new file mode 100644 index 0000000000..efce602fc4 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/issuingrules.tmpl @@ -0,0 +1,19 @@ + +

Issuing rules

+

Issuing rules deals with 2 topics :

+ +

Itemtypes and borrower categories must be defined before issuing rules are defined. Your defined items types and borrower categories are then displayed in a grid on this page.

+ +

Issuing length and quantity

+

Each box in the grid contains 2 numbers, separated by commas, defining how many days a given borrower type can issue how many material. For example : 21,5 means the borrower can issue up to 5 books for up to 21 days

+

The * have a specific meaning. They mean "any". If you set 21,5 for itemtype=*, borrower category=student, branch=main, then a student can't issue more than 5 items of ANY item type. This "any" box is cumulative with other boxes. It means that 21,5 as itemtype=book, 14,2 as itemtype=CD and 30,6 as itemtype=* (with category=student) means a student can issue up to 5 books, up to 2 CD but a maximum of 6 items (books or CD). In this case the "30 days" in itemtype=* is discarded and the issuing length is calculated on the exact itemtype

+ +

Overdue charges

+

Each box in the grid contains three numbers separated by commas, defining the fine, how many days overdue the item must be before the fine is assessed and a first notice prepared (the "grace period"), and how many days after that the fine is assessed again and a second notice sent. For example, if you charge adults 1 dollar (or euro, or whatever currency) for overdue videos after three days and add another dollar charge after another five days, put "1,3,5" in the box in the grid that aligns with "Adult" and "Video." If you charge adults 25 cents for overdue fiction books after a grace period of seven days and repeat the charge seven days later, then the entry in the corresponding box in the grid would be ".25,7,7". After the first and second notice are given, Koha prepares a "final notice" after the number of days set by the final number in the grid and sets the charge to the maximum, which is 5.

+ +

(Note : fines are calculated by the fines2.pl script, located in misc directory. Ask your system administrator to put this script in crontab, after midnight, to have fines calculated every night.)

+ + \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/itemtypes.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/itemtypes.tmpl index 9bada1f1a4..6544973b00 100644 --- a/koha-tmpl/intranet-tmpl/default/en/help/admin/itemtypes.tmpl +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/itemtypes.tmpl @@ -1,9 +1,19 @@ - -

Item types

-

You can define as many itemtypes as you want.

-

Item types are useful for many things :

- + +

Item types management

+

You can define as many itemtypes 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" says 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 diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/koha2marclinks.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/koha2marclinks.tmpl new file mode 100644 index 0000000000..6494d49688 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/koha2marclinks.tmpl @@ -0,0 +1,12 @@ + +

Koha 2 MARC links

+

This page provides a simplified way to map your MARC tags and subfields to the non-MARC Koha database tables for default biblio framework. This can also be done while setting the MARC tag structure, but it is easier to see the relationship between the MARC database and the Koha database here.

+ +

The pull-down menu lists all the Koha tables that can receive values from the MARC records. The columns from each table are listed below the pull-down menu.

+ +

Do not expect to have every Koha table.column mapped to a MARC subfield. Some (such as biblionumber, biblioitemnumber, and itemnumber) are values generated by Koha and will probably be automatically mapped. Others are flags which are set in the course of normal circulation activities and will contain information that is not part of your MARC record.

+ +

This is a one-to-one mapping. In other words, a MARC tag/subfield can be mapped to one, and only one, Koha table.column.

+ +

MARC data that is not mapped to a Koha table does not disappear -- it is simply not available for display on circulation screens and on some search results screens.

+ diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/marc_subfields_structure.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/marc_subfields_structure.tmpl new file mode 100644 index 0000000000..f5343e74a6 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/marc_subfields_structure.tmpl @@ -0,0 +1,25 @@ + +

MARC tag structure administration

+

Koha allows you to specify which MARC tags you want to use and which you want to ignore. When you downloaded and installed Koha, you also got the entire list of MARC21 tags and subfields in current use. Now you need to use the administration page to edit this list and tell Koha which tags you want to use and how you want to use them.

+

You can define as the marc tag structure for each biblio framework you have defined

+ +

If you are CERTAIN that you will never use a MARC tag, then you can delete it, but since this will not result in any appreciable improvement in performance, it is probably better to leave it. There will be tags you want to add, however. If you are using older MARC tags that are not in the list of tags supplied with Koha, then use the MARC tag structure administration page to add them. Similarly, you will probably need to add the holdings tag you currently use, or at least check the subfield structure of the 852 tag if you use it for holdings.

+ +

Editing the SubFields from the MARC tag structure page is very time-consuming, but also very important; be sure to click the subfield link for each tag in your MARC tag structure.

+

For each subfield you can set :

+ + diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/marctagstructure.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/marctagstructure.tmpl new file mode 100644 index 0000000000..f5343e74a6 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/marctagstructure.tmpl @@ -0,0 +1,25 @@ + +

MARC tag structure administration

+

Koha allows you to specify which MARC tags you want to use and which you want to ignore. When you downloaded and installed Koha, you also got the entire list of MARC21 tags and subfields in current use. Now you need to use the administration page to edit this list and tell Koha which tags you want to use and how you want to use them.

+

You can define as the marc tag structure for each biblio framework you have defined

+ +

If you are CERTAIN that you will never use a MARC tag, then you can delete it, but since this will not result in any appreciable improvement in performance, it is probably better to leave it. There will be tags you want to add, however. If you are using older MARC tags that are not in the list of tags supplied with Koha, then use the MARC tag structure administration page to add them. Similarly, you will probably need to add the holdings tag you currently use, or at least check the subfield structure of the 852 tag if you use it for holdings.

+ +

Editing the SubFields from the MARC tag structure page is very time-consuming, but also very important; be sure to click the subfield link for each tag in your MARC tag structure.

+

For each subfield you can set :

+ + diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/printers.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/printers.tmpl new file mode 100644 index 0000000000..86660e5544 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/printers.tmpl @@ -0,0 +1,7 @@ + +

If you are going to be using a printer (or several printers) that are attached to your Koha server for producing statistical and operations reports, then you need to give each printer a name and tell Koha how to access it. You do this by telling Koha which print queue to use.

+ +

(In linux, each printer configuration in your printcap file defines a print queue. The default print queue is "lp," but if you use more than one printer you will have other queues, probably with names like "text" or "postscript." Tell Koha which printer queue(s) you want to use for printing reports directly from the server.)

+ +

Note that you can always print Koha screens directly to a printer attached to your workstation just by using your web browser's Print function.

+ diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/stopwords.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/stopwords.tmpl new file mode 100644 index 0000000000..2ec39115a4 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/stopwords.tmpl @@ -0,0 +1,8 @@ + +

Stop word administration page

+

Here you should list all of the words you wish Koha to ignore when performing catalog searches or building the keyword index.

+ +

Normally, you will not want Koha to save keyword references to articles like "The" and "A" and other very common words. Saving keyword references to these words does not help to limit a search and will make the keyword index very large and "cluttered" with words that are not really useful. The "stopwords" list defines these unnecessary words for your installation.

+ +

(Hint: If you are proficient at MySQL, it is often faster and easier to find an existing stopwords list, edit it, put it in the correct format, and use the MySQL "Load Data Infile" command to import the list into the stopwords table. Many academic libraries publish their stopwords list on the Internet, or you can ask other Koha libraries if they would share their stopword list.)

+ diff --git a/koha-tmpl/intranet-tmpl/default/en/help/admin/systempreferences.tmpl b/koha-tmpl/intranet-tmpl/default/en/help/admin/systempreferences.tmpl new file mode 100644 index 0000000000..b86292a8de --- /dev/null +++ b/koha-tmpl/intranet-tmpl/default/en/help/admin/systempreferences.tmpl @@ -0,0 +1,70 @@ + +

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.

+