View | Details | Raw Unified | Return to bug 5940
Collapse All | Expand All

(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/admin-home.tmpl (+8 lines)
Lines 5-25 Link Here
5
<p>The administration area is where you set all of your preferences for the system. Preference are broken down into several categories.</p>
5
<p>The administration area is where you set all of your preferences for the system. Preference are broken down into several categories.</p>
6
6
7
<h3>Global System Preferences</h3>
7
<h3>Global System Preferences</h3>
8
8
<p>Koha has an extensive set of system preferences. The system preferences control all the various features within Koha and whether they are active in your install or not. System preferences are generally set once at install and then not changed.</p>
9
<p>Koha has an extensive set of system preferences. The system preferences control all the various features within Koha and whether they are active in your install or not. System preferences are generally set once at install and then not changed.</p>
10
9
<p>If  you are not sure what combination of system preferences to use, try using one of the sample profiles at install. </p>
11
<p>If  you are not sure what combination of system preferences to use, try using one of the sample profiles at install. </p>
12
10
<p style="color: #990000">IMPORTANT: many preferences interact with each other. Turning on one system preference may require that others are also set.</p>
13
<p style="color: #990000">IMPORTANT: many preferences interact with each other. Turning on one system preference may require that others are also set.</p>
11
14
12
<h3>Basic Parameters</h3>
15
<h3>Basic Parameters</h3>
16
13
<p>Basic parameters is where library policies are set and governed. It is best to set your system preferences, and then to work through the Basic Parameters in the order that they appear on this page.</p>
17
<p>Basic parameters is where library policies are set and governed. It is best to set your system preferences, and then to work through the Basic Parameters in the order that they appear on this page.</p>
18
14
<p>Note not all basic parameters are required to be set. For example if you do not plan to use budget based acquisitions, then Accounts and Budgets, Currencies and Exchange Rates can be ignored.</p>
19
<p>Note not all basic parameters are required to be set. For example if you do not plan to use budget based acquisitions, then Accounts and Budgets, Currencies and Exchange Rates can be ignored.</p>
15
20
16
<h3>Patrons and Circulation</h3>
21
<h3>Patrons and Circulation</h3>
22
17
<p>These parameters help with the control of patron records and circulation rules.  It is best to make sure you set the basic parameters before visiting this section.</p>
23
<p>These parameters help with the control of patron records and circulation rules.  It is best to make sure you set the basic parameters before visiting this section.</p>
18
24
19
<h3>Catalog</h3>
25
<h3>Catalog</h3>
26
20
<p>Catalog parameters assist in configuring the cataloging functionality within Koha.  
27
<p>Catalog parameters assist in configuring the cataloging functionality within Koha.  
21
28
22
<h3>Additional Parameters</h3>
29
<h3>Additional Parameters</h3>
30
23
<p>This list of parameters includes functionality that didn't fit in any other category.  These items are optional and may not need to be altered depending on how your library is using Koha.</p>
31
<p>This list of parameters includes functionality that didn't fit in any other category.  These items are optional and may not need to be altered depending on how your library is using Koha.</p>
24
32
25
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
33
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgetperiods.tmpl (-7 / +9 lines)
Lines 2-19 Link Here
2
2
3
<h1>Budgets</h1>
3
<h1>Budgets</h1>
4
4
5
<p>Budgets are the top level used for tracking accounting values related to acquisitions. An example would be to create a budget for the current year and then breaking that into Funds for different areas of the library.</p>
5
<p>Budgets are the top level used for tracking accounting values related to acquisitions.</p>
6
6
7
<h3>Add a budget</h3>
7
<p>An example would be to create a budget for the current year and then breaking that into Funds for different areas of the library.</p>
8
9
<h2>Add a budget</h2>
8
10
9
<p>To add a budget click the 'New Budget' button.</p>
11
<p>To add a budget click the 'New Budget' button.</p>
10
12
11
<ul>
13
<ul>
12
<li>Choose the time period this budget is for, whether it's an academic year, a fiscal year, a quarter, etc.</li>
14
	<li>Choose the time period this budget is for, whether it's an academic year, a fiscal year, a quarter, etc.</li>
13
<li>The Description should be something that will help you identify the budget when ordering</li>
15
	<li>The Description should be something that will help you identify the budget when ordering</li>
14
<li>In the amount box do not use any symbols, simply enter the amount of the budget with numbers and decimals.</li>
16
	<li>In the amount box do not use any symbols, simply enter the amount of the budget with numbers and decimals.</li>
15
<li>Marking a budget active makes it usable when placing orders in the acquisitions module, even if the order is placed after the budget end date. This will allow you to record orders that were places in a previous budget period.</li>
17
	<li>Marking a budget active makes it usable when placing orders in the acquisitions module, even if the order is placed after the budget end date. This will allow you to record orders that were places in a previous budget period.</li>
16
<li>Locking a budget means that Funds will not be able to be modified by librarians</li>
18
	<li>Locking a budget means that Funds will not be able to be modified by librarians</li>
17
</ul>
19
</ul>
18
20
19
<p>Once you have made your edits, click the 'Save Changes' button. You will be brought to a list of your existing budgets.</p>
21
<p>Once you have made your edits, click the 'Save Changes' button. You will be brought to a list of your existing budgets.</p>
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgets.tmpl (-9 / +13 lines)
Lines 2-10 Link Here
2
2
3
<h1>Funds</h1>
3
<h1>Funds</h1>
4
4
5
<p>Budgets are broken in to funds.</p>
6
7
<h2>Add a Fund</h2>
8
5
<p>A fund is added to a budget.</p>
9
<p>A fund is added to a budget.</p>
6
10
7
<p style="color: rgb(153, 0, 0);">IMPORTANT: A budget must be defined before a fund can be created.</p>
11
<p style="color: #990000;">Important: A budget must be defined before a fund can be created.</p>
8
12
9
<p>To add a new fund click the New button and then choose which Budget you would like to add the fund to.</p>
13
<p>To add a new fund click the New button and then choose which Budget you would like to add the fund to.</p>
10
14
Lines 13-26 Link Here
13
<p>The three first fields are required, the rest are optional</p>
17
<p>The three first fields are required, the rest are optional</p>
14
18
15
<ul>
19
<ul>
16
<li>Fund Code is a unique identifer for your fund</li>
20
	<li>Fund Code is a unique identifier for your fund</li>
17
<li>The Fund Name should be something that librarians will understand</li>
21
	<li>The Fund Name should be something that librarians will understand</li>
18
<li>Amount should be entered with only numbers and decimals, no other characters</li>
22
	<li>Amount should be entered with only numbers and decimals, no other characters</li>
19
<li>You can choose to assign this fund to a librarian. Doing so will make it so that only that librarian can make changes to the Fund</li>
23
	<li>You can choose to assign this fund to a librarian. Doing so will make it so that only that librarian can make changes to the Fund</li>
20
<li>Choose which library will be using this fund</li>
24
	<li>Choose which library will be using this fund</li>
21
<li>You can restrict who can order from this fund by choosing either the owner or the library from the 'Restrict access to' menu</li>
25
	<li>You can restrict who can order from this fund by choosing either the owner or the library from the 'Restrict access to' menu</li>
22
<li>Notes are simply for any descriptive notes you might want to add so that librarians know when to use this fund</li>
26
	<li>Notes are simply for any descriptive notes you might want to add so that librarians know when to use this fund</li>
23
<li>Planning categories are used for statistical purposes. To learn more about planning categories, check out the Planning Category FAQ.</li>
27
	<li>Planning categories are used for statistical purposes. To learn more about planning categories, check out the Planning Category FAQ.</li>
24
</ul>
28
</ul>
25
29
26
<p>When complete, click 'Submit' and you will be brought to a list of all of the funds for the budget.</p>
30
<p>When complete, click 'Submit' and you will be brought to a list of all of the funds for the budget.</p>
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqplan.tmpl (-1 / +3 lines)
Lines 4-10 Link Here
4
4
5
<p>When viewing the list of funds click the 'Planning' button and choose how you would like to plan to spend your budget.</p>
5
<p>When viewing the list of funds click the 'Planning' button and choose how you would like to plan to spend your budget.</p>
6
6
7
<p>If you choose 'Plan by MONTHS' you will see the budgeted amount broken down by months</p>
7
<p>If you choose 'Plan by MONTHS' you will see the budgeted amount broken down by months.</p>
8
9
<p>To hide some of the columns you can click the minus sign (-) to the right (or below as in the screenshot above) the dates. To add more columns you can click the plus sign (+) found above the 'Auto-fill row' buttons.</p>
8
10
9
<p>From here you can plan your budget spending by manually entering values or by clicking the 'Auto-fill row' button. If you choose to auto-fill the form the system will try to divide the amount accordingly, you may have to make some edits to split things more accurately.</p>
11
<p>From here you can plan your budget spending by manually entering values or by clicking the 'Auto-fill row' button. If you choose to auto-fill the form the system will try to divide the amount accordingly, you may have to make some edits to split things more accurately.</p>
10
12
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/auth_subfields_structure.tmpl (-28 / +133 lines)
Lines 1-37 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>MARC tag structure administration</h1>
3
<h1>MARC Record Subfields</h1>
4
4
5
<p>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.</p>
5
<p>Frameworks are made up of MARC fields and subfields. To make edits to most Frameworks you must edit the fields and subfields. Clicking 'Edit' to the right of each subfield will allow you to make changes to the text associated with the field</p>
6
<p>You can define as the marc tag structure for each biblio framework you have defined</p>
7
6
8
<p>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.</p>
7
<ul>
9
8
	<li>Each field has a tag (which is the MARC tag)
10
<p>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.</p>
9
<ul>
11
<p>For each subfield you can set :</p>
10
	<li>The 'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels</li>
12
<ul>
11
	<li>The 'Label for OPAC' is what will show on the MARC view in the OPAC</li>
13
<li>repeatable : whether it can be repeated or not. If it can be repeated, separate the values by a | in the MARC editor when you want to have the subfield twice</li>
12
	<li>If you check 'Repeatable' then the field will have a plus sign next to it allowing you to add multiples of that tag</li>
14
<li>Mandatory : whether the field is mandatory or not. If mandatory, the cataloger can't validate the biblio if the subfield is empty.</li>
13
	<li>If you check 'Mandatory' the record will not be allowed to save unless you have a value assigned to this tag</li>
15
<li>Search also : a list of field that Koha will also search on when the user do a search on the subfield</li>
14
	<li>'Authorized value' is where you define an authorized value that your catalogers can choose from a pull down to fill this field in
16
<li>Koha link : <b>very important</b>. Koha is multi-MARC compliant. So, it does not know what the 245$a means, neither what 200$f (those 2 fields being both the title in MARC21 and UNIMARC !). So, in this list you can "map" a MARC subfield to it's meaning. Koha constantly maintains consistency between a subfield and it's meaning. When the user want to search on "title", this link is used to find what is searched (245 if you're MARC21, 200 if you're UNIMARC).</li>
15
To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing</li>
17
<li>Text for librarian : what appears before the subfield in the librarian interface</li>
16
</ul>
18
<li>Text for OPAC : what appears before the field in the OPAC. If empty, the text for librarian is used instead</li>
17
</li>
19
<li>Managed in tab : deals with the tab where the subfield is shown. Ignore means that the subfield is not managed. </li>
18
	<li>From the list of subfields you can click 'Delete' to the right of each to delete the subfields</li>
20
<!-- <li>hidden : allows you to select possible visibility conditions. Each section OPAC INTRANET or Editor can be set separately:</li> -->
19
	<li>To edit the subfields click 'Edit Subfields'</li>
21
 <li>Display: allows you to select possible visibility conditions. It is used only with the 'MARC View'. </li> 
20
	<li>For each subfield you can set the following values
22
<li><b>Is a linking field : Select this if you want to use this field for linking other authorities to this authority. The kohafield should be set to auth_header.linkid in this subfield(preferred) or any other subfield in this field :</b>
21
<ul>
23
<li>URL : if checked, the subfield is an URL, and can be clicked</li>
22
	<li>Text for librarian
24
<li>Auth value : means the value is not free, but in the authorized value list of the selected type</li>
23
<ul>
25
<li>thesaurus : shows the authority type</li>
24
	<li>what appears before the subfield in the librarian interface</li>
26
<li>plugin : means the value is calculated or managed by a plugin. Plugins can do almost anything. For example, in UNIMARC there are plugins for every 1xx fields that are coded fields. The plugin is a huge help for cataloger ! There are also two plugins (unimarc_plugin_210c and unimarc_plugin_225a that can "magically" find the editor from an ISBN, and the collection list for the editor)</li>
25
</ul>
27
<li>
26
</li>
28
<li><b>Example MARC21 Subject Headings Authority</b>
27
	<li>Text for OPAC
29
<ul><li>Use field 035$a for your auth_header.authid and 035$8 for auth_header.authtypecode. Make sure your zebra authorities index these fields</li>
28
<ul>
30
<li>Use field 150 for your subject headings</li>
29
	<li>what appears before the field in the OPAC.</li>
31
<li>Use field 750$9 (add subfield if not present) for auth_header.linkid . Select <b>Is a linking field</b>. You may use any subfield for linking as $9 is not hardcoded
30
	<li>If left empty, the text for librarian is used instead</li>
32
<li>When you add or modify an authority clicking on ... that will appear next to 750$9 will let you search any authority and link it to this record. You may repeat tag 750 and add as many linkages as you like</li></ul>
31
</ul>
32
</li>
33
	<li>Repeatable
34
<ul>
35
	<li>the field will have a plus sign next to it allowing you to add multiples of that tag</li>
36
</ul>
33
</li>
37
</li>
38
	<li>Mandatory
39
<ul>
40
	<li>the record will not be allowed to save unless you have a value assigned to this tag</li>
41
</ul>
42
</li>
43
	<li>Managed in tab
44
<ul>
45
	<li>defines the tab where the subfield is shown. All subfields of a given field must be in the same tab or ignored. Ignore means that the subfield is not managed.</li>
34
</ul>
46
</ul>
47
</li>
48
</ul>
49
<ul>
50
	<li>Default value
51
<ul>
52
	<li>defines what you want to appear in the field by default, this will be editable, but it saves time if you use the same note over and over or the same value in a field often.</li>
53
</ul>
54
</li>
55
</ul>
56
<ul>
57
	<li>hidden
58
<ul>
59
	<li>allows you to select from 19 possible visibility conditions, 17 of which are implemented. They are the following:
60
<ul>
61
	<li>-9 =&gt; Future use</li>
62
	<li>-8 =&gt; Flag</li>
63
	<li>-7 =&gt; OPAC !Intranet !Editor Collapsed</li>
64
	<li>-6 =&gt; OPAC Intranet !Editor !Collapsed</li>
65
	<li>-5 =&gt; OPAC Intranet !Editor Collapsed</li>
66
	<li>-4 =&gt; OPAC !Intranet !Editor !Collapsed</li>
67
	<li>-3 =&gt; OPAC !Intranet Editor Collapsed</li>
68
	<li>-2 =&gt; OPAC !Intranet Editor !Collapsed</li>
69
	<li>-1 =&gt; OPAC Intranet Editor Collapsed</li>
70
	<li>0 =&gt; OPAC Intranet Editor !Collapsed</li>
71
	<li>1 =&gt; !OPAC Intranet Editor Collapsed</li>
72
	<li>2 =&gt; !OPAC !Intranet Editor !Collapsed</li>
73
	<li>3 =&gt; !OPAC !Intranet Editor Collapsed</li>
74
	<li>4 =&gt; !OPAC Intranet Editor !Collapsed</li>
75
	<li>5 =&gt; !OPAC !Intranet !Editor Collapsed</li>
76
	<li>6 =&gt; !OPAC Intranet !Editor !Collapsed</li>
77
	<li>7 =&gt; !OPAC Intranet !Editor Collapsed</li>
78
	<li>8 =&gt; !OPAC !Intranet !Editor !Collapsed</li>
79
	<li>9 =&gt; Future use URL : if checked, the subfield is an URL, and can be clicked</li>
80
</ul>
81
</li>
82
	<li>( ! means 'not visible' or in the case of Collapsed 'not Collapsed')</li>
83
</ul>
84
</li>
85
</ul>
86
<ul>
87
	<li>Is a URL
88
<ul>
89
	<li>if checked, it means that the subfield is a URL and can be clicked</li>
90
</ul>
91
</li>
92
</ul>
93
<ul>
94
	<li>Link
95
<ul>
96
	<li>If you enter a field/subfield here (200b), a link appears after the subfield in the MARC Detail view. This view is present only in the staff client, not the OPAC. If the librarian clicks on the link, a search is done on the database for the field/subfield with the same value. This can be used for 2 main topics :
97
<ul>
98
	<li>on a field like author (200f in UNIMARC), put 200f here, you will be able to see all bib records with the same author.</li>
99
	<li>on a field that is a link (4xx) to reach another bib record. For example, put 011a in 464$x, will find the serials that are with this ISSN.</li>
100
</ul>
101
</li>
102
	<li style="color: #990000;">Important: This value should not change after data has been added to your catalog</li>
103
</ul>
104
</li>
105
</ul>
106
<ul>
107
	<li>Koha link
108
<ul>
109
	<li>Koha is multi-MARC compliant. So, it does not know what the 245$a means, neither what 200$f (those 2 fields being both the title in MARC21 and UNIMARC). So, in this list you can "map" a MARC subfield to its meaning. Koha constantly maintains consistency between a subfield and its meaning. When the user want to search on "title", this link is used to find what is searched (245 if you're MARC21, 200 if you're UNIMARC).</li>
110
</ul>
111
</li>
112
</ul>
113
<ul>
114
	<li>Authorized value
115
<ul>
116
	<li>means the value cannot by typed by the librarian, but must be chosen from a pull down generated by the authorized value list</li>
117
	<li>In the example above, the 504a field will show the MARC504 Authorized Values when cataloging</li>
118
</ul>
119
</li>
120
</ul>
121
<ul>
122
	<li>Thesaurus
123
<ul>
124
	<li>means that the value is not free text, but must be searched in the authority/thesaurus of the selected category</li>
125
</ul>
126
</li>
127
</ul>
128
<ul>
129
	<li>Plugin
130
<ul>
131
	<li>means the value is calculated or managed by a plugin. Plugins can do almost anything.</li>
132
	<li>For example, in UNIMARC there are plugins for every 1xx fields that are coded fields. The plugin is a huge help for cataloger ! There are also two plugins (unimarc_plugin_210c and unimarc_plugin_225a that can "magically" find the editor from an ISBN, and the collection list for the editor)</li>
133
</ul>
134
</li>
135
</ul>
136
</li>
137
	<li>To save your changes simply click the 'Save Changes' button at the top of the screen</li>
138
</ul>
139
35
140
36
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
141
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
37
142
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/auth_tag_structure.tmpl (+24 lines)
Line 0 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
3
<h1>Authority Record Tags</h1>
4
5
<p>To add a field to a Authority Framework click the 'New Tag' button at the top of the Authority Framework definition</p>
6
7
<p>This will open up a blank form for entering MARC field data</p>
8
9
<p>Enter the information about your new tag:</p>
10
11
<ul>
12
	<li>The 'Tag' is the MARC field number</li>
13
	<li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module</li>
14
	<li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record</li>
15
	<li>If this field can be repeated, check the 'Repeatable' box</li>
16
	<li>If this field is mandatory, check the 'Mandatory' box</li>
17
	<li>If you want this field to be a pull down with limited possible answers, choose which 'Authorized value' list you want to use</li>
18
</ul>
19
20
<p>When you're finished, click 'Save Changes' and you will be presented with your new field</p>
21
22
<p>To the right of the new field is a link to 'Subfields,' you will need to add subfields before this tag will appear in your MARC editor.</p>
23
24
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authorised_values.tmpl (-133 / +141 lines)
Lines 1-141 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Authorized values management</h1>
3
<h1>Authorized Values</h1>
4
4
5
<p>Koha allows you to restrict the values that catalogers can place in some MARC subfields to certain pre-defined &quot;authorized&quot; values. These authorized values are defined here.</p>
5
<p>Authorized values can be used in several areas of Koha. One reason you would add an authorized value category would be to control the values that can be entered into MARC fields by catalogers.</p>
6
	<ul>
7
		<li>HINT : if a subfield is non mandatory, Koha automatically adds an empty value to the authorized value list, that is selected by default. If the subfield is mandatory, no empty value is added (and you should NOT add it in the list, as it's an illegal value !)</li>
8
		<li>HINT2 : in the MARC editor, the list is ordered by Text, NOT by value. So you can define a default value by putting a space before the value you want to see first. For example, if your list is related to language, you can set &quot;ENG&quot; as authorized value and &quot; English&quot; as text. The space will order &quot;ENG&quot; as first default value, and the space won't be shown (because HTML automatically discard useless spaces). Super hint : you can put a value 1st with N spaces, then another one 2nd with N-1 space,..., a value in Nth position with 1 space. Don't abuse of this feature, it's easier to find a value in an alphabetical order. It should be used only to have a default value</li>
9
	</ul>
10
<p>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.</p>
11
<p> </p>
12
<h3>Why would I want to define authorized values for MARC tags?</h3>
13
<p>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 &quot;INST&quot;) and enter the institution codes as the authorized values for that category.</p>
14
    <span style="background-color: #ffe599">
15
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</span>.
16
   
17
   <strong>Existing Authorized Values</strong>
18
Koha comes with several other categories and pre-defined values your library is likely to use, for instance 'Lost'.
19
6
20
	<ul>
7
<h2>Existing Values</h2>
21
		<li>Asort1
22
		<ul>
23
			<li>attached to acquisitions, that can be used for stats purposes</li>
24
		</ul></li>
25
		<li>Asort2
26
		<ul>
27
			<li>attached to acquisitions, that can be used for stats purposes</li>
28
		</ul></li>
29
		<li>Bsort1
30
		<ul>
31
			<li>attached to patrons, that can be used for stats purposes</li>
32
		</ul></li>
33
		<li>Bsort2
34
		<ul>
35
			<li>attached to patrons, that can be used for stats purposes</li>
36
		</ul></li>
37
		<li>CCODE
38
		<ul>
39
			<li>collection code (appears when editing at item)</li>
40
		</ul></li>
41
		<li>DAMAGED
42
		<ul>
43
			<li>descriptions for items marked as damaged (appears when editing an item)</li>
44
		</ul></li>
45
		<li>HINGS_AS
46
		<ul>
47
			<li>
48
		    
49
holdings coded value<strong style="color: #0000ff">??</strong></li>
50
		</ul></li>
51
		<li>HINGS_C
52
		<ul>
53
			<li>
54
		    
55
holdings coded value<strong style="color: #0000ff">??</strong></li>
56
		</ul></li>
57
		<li>HINGS_PF
58
		<ul>
59
			<li>
60
		    
61
holdings coded value<strong style="color: #0000ff">??</strong></li>
62
		</ul></li>
63
		<li>HINGS_RD
64
		<ul>
65
			<li>
66
		    
67
holdings coded value<strong style="color: #0000ff">??</strong></li>
68
		</ul></li>
69
		<li>HINGS_UT
70
		<ul>
71
			<li>
72
		    
73
holdings coded value<strong style="color: #0000ff">??</strong></li>
74
		</ul></li>
75
		<li>LOC
76
		<ul>
77
			<li>		    
78
shelving location (usually appears when editing an item)</li>
79
		</ul></li>
80
		<li>LOST
81
		<ul>
82
			<li>descriptions for the items marked as lost (appears when editing an item)</li>
83
		</ul></li>
84
		<li>NOT_LOAN
85
		<ul>
86
			<li>reasons why a title is not for loan</li>
87
		</ul></li>
88
		<li>RESTRICTED
89
		<ul>
90
			<li><strong style="color: #0000ff">??</strong></li>
91
		</ul></li>
92
		<li>STACK
93
		<ul>
94
			<li><strong style="color: #0000ff">??</strong></li>
95
		</ul></li>
96
		<li>SUGGEST
97
		<ul>
98
			<li>list of patron suggestion reject or accept reasons (appears when managing suggestions)</li>
99
		</ul></li>
100
		<li>WITHDRAWN
101
		<ul>
102
			<li>description of a withdrawn item (appears when editing an item)</li>
103
		</ul></li>
104
	</ul>   
105
   <strong>View Authorized Values</strong>
106
8
107
	<ul>
9
<p>Koha installs with pre-defined values that your library is likely to use, for instance 'Lost'.</p>
108
		<li>To view the authorized values defined for a category that already exists like 'Lost', choose 'Lost' from the category dropdown menu</li>
109
		<li>Then, you can see the values defined for the category &quot;Lost&quot; and edit them if you like.</li>
110
	</ul><strong>   
111
   Add Authorized Value</strong>
112
10
113
	<ul>
11
<ul>
114
		<li>To add a new value under an existing category, click &quot;New authorized value for&quot;</li>
12
	<li>Asort1
115
		<li>Enter the value and description and choose an icon if you'd like</li>
13
<ul>
116
		<li>When finished, click 'Save'</li>
14
	<li>Used for acquisitions statistical purposes</li>
117
	</ul><h1>   
15
</ul>
118
   Edit authorized values<br/></h1>
16
</li>
119
	<ul>
17
	<li>Asort2
120
		<li>Choose a category from the 'Show Category' dropdown menu</li>
18
<ul>
121
		<li>Click 'Edit' beside the authorized value you wish to edit</li>
19
	<li>Used for acquisitions statistical purposes</li>
122
		<li>Make the changes you'd like and click 'Save'</li>
20
</ul>
123
		<li>
21
</li>
124
	    <span style="background-color: #ffe599">
22
	<li>BOR_NOTES
125
TIP: Be careful about changing the 'Authorized value' as it may be associated with existing records</span>.</li>
23
<ul>
126
	</ul><h2></h2> <h1><strong>   
24
	<li>Values for custom patron notes that appear on the circulation screen and the OPAC</li>
127
   Add a new Authorized Value Category<br/></strong></h1>
25
</ul>
26
</li>
27
	<li>Bsort1
28
<ul>
29
	<li>Used for patron statistical purposes</li>
30
</ul>
31
</li>
32
	<li>Bsort2
33
<ul>
34
	<li>Used for patron statistical purposes</li>
35
</ul>
36
</li>
37
	<li>CART
38
<ul>
39
	<li>Is the shelving cart location, used by InProcessingToShelvingCart and ReturnToShelvingCart</li>
40
</ul>
41
</li>
42
	<li>CCODE
43
<ul>
44
	<li>Collection codes (appears when cataloging and working with items)</li>
45
</ul>
46
</li>
47
	<li>DAMAGED
48
<ul>
49
	<li>Descriptions for items marked as damaged (appears when cataloging and working with items)</li>
50
</ul>
51
</li>
52
	<li>HINGS_AS
53
<ul>
54
	<li>General Holdings: Acquisition Status Designator :: This data element specifies acquisition status for the unit at the time of the holdings report.a</li>
55
</ul>
56
</li>
57
	<li>HINGS_C
58
<ul>
59
	<li>General Holdings: Completeness Designator</li>
60
</ul>
61
</li>
62
	<li>HINGS_PF
63
<ul>
64
	<li>Physical Form Designators</li>
65
</ul>
66
</li>
67
	<li>HINGS_RD
68
<ul>
69
	<li>General Holdings: Retention Designator :: This data element specifies the retention policy for the unit at the time of the holdings report.</li>
70
</ul>
71
</li>
72
	<li>HINGS_UT
73
<ul>
74
	<li>General Holdings: Type of Unit Designator</li>
75
</ul>
76
</li>
77
	<li>LOC
78
<ul>
79
	<li>Shelving location (usually appears when adding or editing an item)</li>
80
</ul>
81
</li>
82
	<li>LOST
83
<ul>
84
	<li>Descriptions for the items marked as lost (appears when adding or editing an item)</li>
85
	<li>Values given to lost statuses should be numeric and not alphabetical in order for statuses to appear properly</li>
86
</ul>
87
</li>
88
	<li>MANUAL_INV
89
<ul>
90
	<li>Values for manual invoicing types</li>
91
</ul>
92
</li>
93
	<li>NOT_LOAN
94
<ul>
95
	<li>Reasons why a title is not for loan</li>
96
</ul>
97
</li>
98
	<li>PROC
99
<ul>
100
	<li>The location to be used for NewItemsDefaultLocation (change description as desired), also the location expected by InProcessingToShelvingCart.</li>
101
</ul>
102
</li>
103
	<li>RESTRICTED
104
<ul>
105
	<li>Restricted status of an item</li>
106
</ul>
107
</li>
108
	<li>SUGGEST
109
<ul>
110
	<li>List of patron suggestion reject or accept reasons (appears when managing suggestions)</li>
111
</ul>
112
</li>
113
	<li>WITHDRAWN
114
<ul>
115
	<li>Description of a withdrawn item (appears when adding or editing an item)</li>
116
</ul>
117
</li>
118
</ul>
119
120
<h2>Add new Authorized Value Category</h2>
121
122
<p>In addition to the existing categories that come by default with Koha, librarians can add their own authorized value categories to control data that is entered into the system. To add a new category:</p>
123
124
<ul>
125
	<li>Click 'New Category'</li>
126
	<li>Limit your Category to 11 characters (something short to make it clear what the category is for)</li>
127
	<li>When adding a new category you're asked to create at least one authorized value
128
<ul>
129
	<li>Enter a code for your Authorized Value into the 'Authorized value' field</li>
130
	<li>Use the Description field for the actual value that will be entered</li>
131
</ul>
132
</li>
133
	<li>Click 'Save'</li>
134
	<li>Your new category and value will appear on the list of Authorized Values</li>
135
</ul>
136
137
<h2>Add new Authorized Value</h2>
138
139
<p>New authorized values can be added to any existing or new category. To add a value:</p>
140
141
<ul>
142
	<li>Click 'New authorized value for ...'</li>
143
	<li>Enter a code for your Authorized Value into the 'Authorized value' field</li>
144
	<li>Use the Description field for the actual value that will be entered</li>
145
	<li>Click 'Save'</li>
146
	<li>The new value will appear in the list along with existing values</li>
147
</ul>
128
148
129
<h2></h2> <strong><br/></strong>
130
	<ul>
131
		<li>To add a new category, click 'New Category'</li>
132
		<li>Fill in the 'Category', 'Authorized value' and 'Description' fields<br/>
133
		<ul>
134
			<li>
135
		    <span style="color: #ff0000">
136
IMPORTANT: The category name must be 8 characters or less. Also, just input one authorized value for the category. You can edit and add more after you save the category.</span></li>
137
		</ul></li>
138
		<li>Click 'Save'</li>
139
		<li>You've added a new category and can immediately start adding more authorized values to that category by clicking &quot;New authorized value for...&quot;</li>
140
	</ul>
141
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
149
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authtypes.tmpl (-37 / +3 lines)
Lines 2-43 Link Here
2
2
3
<h1>Authority types</h1>
3
<h1>Authority types</h1>
4
4
5
<p>You can define as many Authority types as you want.</p>
5
<p>Authority Types are basically MARC Frameworks for Authority records and because of that the rules below refer to the bibliographic frameworks.</p>
6
	<ul>
7
		<li>with the MARC structure button, you can define the MARC structure of a given authority type</li>
8
		<li>The tag reported must contain a MARC tag number. Every subfield in the selected tag will be copied to the &quot;destination tag&quot; in the biblio. for example, in UNIMARC, the tag 200 ot personal authority will be reported to 600, 700, 701, depending on what is cliqued in the biblio MARC editor.</li>
9
		<li>The summary contains an &quot;ISBD&quot; like description to explain how the entry must be shown in the result list. The syntax is :
10
		<ul>
11
			<li>[xxxFFFSyyy] where are up to 3 digits BEFORE the field, FFF the field number, S the subfield code, yyy up to 3 digits AFTER the field.</li>
12
			<li>things outside [] are kept as is (including HTML)</li>
13
			<li>repeatable fields are managed.
14
			<ul>
15
			</ul></li>
16
<p>IMPORTANT</p>
17
<p>In the biblio framework, the reported tag <strong>MUST</strong> contain a $9 subfield, activated in the tab where the tag is, and hidden (hidden maybe omitted, but the field has no reason to appear anywhere). The $9 subfield in the biblio will contain the Authority number (the internal Koha number)</p>
18
		</ul></li>
19
	</ul>
20
	<h1>Create Authority Types</h1>
21
6
22
<p>Create and manage Authorities frameworks that define the characteristics of your MARC Records (field and subfield definitions).
7
<p>Koha comes with many of the necessary Authority frameworks already installed.</p>
23
To create a new framework...</p>
24
8
25
	<ul>
9
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
26
		<li>Go to the 'Administration' module.</li>
27
		<li>Select 'Authority types'</li>
28
		<li>Click 'New Authority Framework'</li>
29
		<li>Fill in the fields that describe your new authority type<br/>
30
		<ul>
31
			<li>
32
		    <span style="background-color: #ffe599">
33
TIP: In the 'Authority field to copy', enter the authority field that should be copied from the authority record to the bibliographic record. e.g., in MARC21, field 100 in the authority record should be copied to field 100 in the bibliographic record</span></li>
34
		</ul></li>
35
		<li>Click 'Submit'</li>
36
		<li>To update the MARC Framework for your new authority type, click 'MARC structure' next to the authority</li>
37
		<li>From the following screen you can alter fields, subfields and add additional tags</li>
38
		<li>By clicking on the 'edit' link you will be able to alter information related to the field</li>
39
		<li>By clicking the 'subfields' link you will be able to alter all of the subfields associated with that field</li>
40
		<li>By clicking 'Edit subfields' at the bottom of the screen you can alter the information for each subfield</li>
41
		<li>After making your changes, click 'Save Changes' at the top of the screen</li>
42
		<li>To delete a subfield, just click the 'delete' link next to the field you'd like to edit</li>
43
	</ul><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/biblio_framework.tmpl (-4 / +32 lines)
Lines 1-9 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Biblio framework</h1>
3
<h1>MARC Bibliographic Frameworks</h1>
4
4
5
<p>biblio frameworks are used to catalog your biblios.</p>
5
<p>Think of Frameworks as templates for creating new bibliographic records. Koha comes with some predefined frameworks that can be edited or deleted, and librarians can create their own frameworks for content specific to their libraries.</p>
6
	<p>Unlike Koha 2.0, in this version you can have more than 1 framework to catalogate differently various materials. You can, for example, define 1 framework for monographies, 1 framework for serials, 1 framework for URL...</p>
6
7
	<p>Once a framework type is created, you can clic on "MARC structure" to define the exact MARC structure. The first time, Koha will ask you to select an existing framework to copy into the new one. Thus, you don't have to define all the MARC structure</p>
7
<p>Do not delete or edit the Default Framework since this will cause problems with your cataloging records - always create a new template based on the Default Framework, or alter the other Frameworks.</p>
8
9
<p>After clicking the 'MARC structure' link to the right of each framework you can decide how many fields you want to see on one screen by using the pagination options at the top of the table.</p>
10
11
<h2>Add New Framework</h2>
12
13
<p>To add a new framework</p>
14
15
<ul>
16
	<li>Click 'New Framework'
17
<ul>
18
	<li>Enter a code of 4 or fewer characters</li>
19
	<li>Use the Description field to enter a more detailed definition of your framework</li>
20
</ul>
21
</li>
22
	<li>Click 'Submit'</li>
23
	<li>Once your Framework is added click 'MARC structure' to the right of it on the list of Frameworks
24
<ul>
25
	<li>You will be asked to choose a Framework to base your new Framework off of, this will make it easier than starting from scratch</li>
26
</ul>
27
</li>
28
	<li>Once your Framework appears on the screen you can edit or delete each field by following the instructions for editing subfields</li>
29
</ul>
30
31
<h2>Edit Existing Frameworks</h2>
32
33
<p>Clicking 'Edit' to the right of a Framework will only allow you to edit the Description for the Framework</p>
34
35
<p>To make edits to the fields associated with the Framework you must first click 'MARC Structure' and then follow the instructions for editing subfields</p>
8
36
9
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
37
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/branch_transfer_limits.tmpl (-25 / +16 lines)
Lines 1-28 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
<h1>Library Transfer Limits</h1>
3
<h1>Library Transfer Limits</h1>
3
<p>
4
4
Limit the ability to transfer items between libraries based on the
5
<p>Limit the ability to transfer items between libraries based on the library sending, the library receiving, and the collection code involved.</p>
5
library sending, the library receiving, and the item type involved.</p>
6
6
7
<p>These rules only go into effect if the preference UseBranchTransferLimits is set to 'enforce'.</p>
7
<p style="color: #990000">IMPORTANT: These rules only go into effect if the preference UseBranchTransferLimits is set to ON.</p>
8
8
9
<p>Before you begin you will want to choose which library you are setting these limits for.</p>
9
<ul>
10
10
	<li>
11
<p>Transfer limits are set based on the collections codes you have applied via the Authorized Value administration area.</p>
11
	<em>Get there:</em> More &gt; Administration &gt; General System Preferences &gt; Circulation &gt; UseBranchTransferLimits</li>
12
12
</ul>
13
<p>Collection codes will appear as tabs above the checkboxes.</p>
13
<h2>Setting Limits <br />
14
14
</h2>
15
<p>Check the boxes for the libraries that you accept checkins from for the item type you have selected at the top.</p>
15
<ul>
16
16
	<li>Click 'Library Transfer Limits'
17
<p>In the above example, Centerville library will allow patrons to return items from all libraries except Liberty and Franklin to their branch.</p>
17
	</li>
18
18
	<li>Check the boxes for the items that should <em>not</em> be transferable
19
	<ul>
20
		<li style="background-color: #ffe599">TIP:
21
		If you accidentally click all the items that can be transferred, you
22
		can click the 'Swap All' button to change your selection</span></li>
23
	</ul>
24
	</li>
25
	<li>To prevent all transfers, click 'Check All'</li>
26
	<li>If you need to restart you can click 'Uncheck All'</li>
27
</ul>
28
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
19
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/branches.tmpl (-52 / +43 lines)
Lines 1-59 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Libraries and Groups</h1>
3
<h1>Libraries &amp; Groups</h1>
4
4
5
<ul>
5
<p>When setting up your Koha system you will want to add information for every library that will be sharing your system. This data is used in several areas of Koha.</p>
6
	<li>Click on 'Libraries and groups'</li>
6
7
	 
7
<p>When visiting this page you are presented with a list of the libraries and groups that have already been added to the system.</p>
8
	<ul>
8
9
		<li style="background-color: #ffe599">TIP: The terms 'Library' and 'Branch' are interchangeable in Koha.</li>
9
<h2>Adding a Library</h2>
10
	</ul>
10
11
	
11
<p>To add a new library:</p>
12
	<li>You can click the 'Edit' link, next to each library, to make changes.</li>
13
</ul>
14
<h2>Add a new Group</h2>
15
16
<strong>What is Group(s) and why would I want to use it? <br />
17
</strong>
18
<p>
19
A single branch library does not need to utilize the Group(s) feature.
20
</p>
21
<p>
22
Group(s) are used to divide your library system into categories. If, for example, you have
23
one main library and several branch libraries, you might set up an &quot;M&quot;
24
(Main) group and a &quot;B&quot; (Branch) group, with descriptions &quot;Main
25
Library&quot; and &quot;Branch Libraries.&quot; Another example is a library system
26
which is divided into regions. You can create the &quot;North Region&quot; group,
27
which contains libraries A, B, and C and the &quot;South Region&quot; group, which
28
contains libraries D, E, and F.
29
</p>
30
<p style="background-color: #ffe599">TIP: Start by adding your Groups/Categories (if you have any) before adding Libraries.
31
</p>
32
<ul>
33
	<li>To add a new group click 'New Group'
34
	<ul>
35
		<li style="color: #990000">IMPORTANT: Right now category type is still in development. </li>
36
	</ul>
37
	</li>
38
	<li>Enter the group information</li>
39
</ul>
40
12
41
<h2><strong>Add a new Library/Branch</strong> <br />
42
</h2>
43
<ul>
13
<ul>
44
	<li>To add a new library or branch click 'New Library'
14
	<li>Click 'New Library'</li>
45
	</li>
15
	<li>Fill in the data requested on the form that follows
46
	<li>Enter the Library Code
47
	<ul>
48
		<li style="background-color: #ffe599">TIP: Give each library a unique and easily-remembered code (maximum of four
49
		characters). This code will be used in Koha's database to identify each
50
		library.</li>
51
	</ul>
52
	</li>
53
</ul>
54
<ul>
16
<ul>
55
	<li>Enter all other information related to the library</li>
17
	<li>Of the fields listed, only 'Library code' and 'Name' are required</li>
56
	<li>Click 'Submit'</li>
18
	<li>Be sure to enter a library email address to make sure that notices are sent to and from the right address</li>
57
	<li>Your library will now be added to the list
19
	<li>An IP address is required if you have enabled AutoLocation</li>
58
	</li>
20
</ul>
21
</li>
59
</ul>
22
</ul>
23
24
<h2>Editing/Deleting a Library</h2>
25
26
<p>You will be unable to delete any library that has patrons or items attached to it.</p>
27
28
<p>Each library will have an 'Edit' link to the right of it. Click this link to edit/alter details associated with the library in question.</p>
29
30
<p>You will be unable to edit the 'Library code'</p>
31
32
<h2>Adding a group</h2>
33
34
<p>To add a Search Domain or Library Property Group click the 'New Group' button at the top of the screen.</p>
35
36
<p>Of the fields on the group form, 'Category code' and 'Name' are the only required fields</p>
37
38
<h2>Search Domain Groups</h2>
39
40
<p>Search Domain Groups allow you to search a group of libraries at the same time instead of searching just one library or all libraries.</p>
41
42
<p>To see Search Domain Groups in action visit the staff client advanced search page in your Koha system</p>
43
44
<h2>Library Property Groups</h2>
45
46
<p>You can assign specific categories to your libraries by adding groups for them.</p>
47
48
<p>Properties are then applied to libraries via the add or edit library form.</p>
49
50
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tmpl (-27 / +74 lines)
Lines 2-33 Link Here
2
2
3
<h1>Patron Categories</h1>
3
<h1>Patron Categories</h1>
4
4
5
<p>This is where you define the types of users of your library and how they will be handled.</p>
5
<p>Patron categories allow you to organize your patrons into different roles, age groups, and patron types.</p>
6
6
7
<h2>Categories, Descriptions and Types</h2>
7
<p>Patrons are assigned to one of six main categories:</p>
8
<p>Start by assigning a Category Code and a Description to each patron category. Each Category can be one of five types:</p>
8
9
	<ul>
9
<ul>
10
		<li>Adult Patrons: can be linked as &quot;guarantors&quot; to other patrons who are their dependents.  This is the default patron type.</li>
10
	<li>Adult
11
		<li>Child Patrons: a patron category that has a &quot;guarantor&quot;.</li>
11
<ul>
12
		<li>Organizational Patrons: can be used for institutional members, e.g. other libraries that borrow from you, in which case Koha expects slightly different information about the institution.</li>
12
	<li>Most common patron type, usually used for a general 'Patron' category.</li>
13
		<li>Professional Patrons: can also be associated with a guarantor (usually an organization).</li>
13
</ul>
14
		<li>Staff Members: A member of the library staff.</li>
14
</li>
15
		<li>Statistical Patrons: checking out to this patron type creates a statistical (local use) record but does not actually circulate materials.</li>
15
	<li>Child
16
	</ul>
16
<ul>
17
	
17
	<li>Children patrons can have a guardian to be attached to them.</li>
18
<h3>Note on Permissions</h3>
18
</ul>
19
<p>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.</p>
19
</li>
20
20
	<li>Staff
21
<h2>Enrollment Period (months)</h2>
21
<ul>
22
<p>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 ( &gt;= 99).</p>
22
	<li>Patrons within the staff category will have access to the staff client.</li>
23
23
</ul>
24
<h2>Upper Age Limit and Age Required</h2>
24
</li>
25
<p>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 &quot;2&quot; and Upper Age Limit would be &quot;18.&quot; If there is no upper age limit, set this value to 999 (the highest allowed).</p>
25
	<li>Organizational
26
26
<ul>
27
<h2>Enrollment Fee and Reserve Fee</h2>
27
	<li>Organizational patrons are organizations. Organizations can be used as guarantors for Professional patrons.</li>
28
<p>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. &quot;1.250000&quot; instead of &quot;$1.25&quot;).</p>
28
</ul>
29
29
</li>
30
<h2>Overdue Notice Required</h2>
30
	<li>Professional
31
<p>Overdue Notice Required lets you bypass generating overdue notices for this user type.</p>
31
<ul>
32
	<li>Professional patrons can be linked to Organizational patrons</li>
33
</ul>
34
</li>
35
	<li>Statistical
36
<ul>
37
	<li>This patron type is used strictly for statistical purposes, such as in house use of items.</li>
38
</ul>
39
</li>
40
</ul>
41
42
<h2>Adding a patron category</h2>
43
44
<p>To add a new patron category click 'New Category' at the top of the page</p>
45
46
<ul>
47
	<li>The 'Category Code' is an identifier for your new code.
48
<ul>
49
	<li style="color: #990000;">Important: The category code is limited to 10 characters (numbers and letters)</li>
50
</ul>
51
</li>
52
	<li>Enter a plain text version of the category in the 'Description' field.</li>
53
	<li>Enrollment period (in months) should be filled in if you have a limited enrollment period for your patrons (eg. Student cards expire after 9 months or until a specific date)
54
<ul>
55
	<li style="color: #990000;">Important: You cannot enter both a month limit and a date until. Choose to enter either one or the other.</li>
56
</ul>
57
</li>
58
	<li>Some patron categories can have a minimum age (in years) requirement associated with them, enter this age in the 'Age required'</li>
59
	<li>Patron categories can also have a maximum age (in years) associated with them (such as children), enter this age in the 'Upperage limit'</li>
60
	<li>If you charge a membership fee for your patrons (such as those who live in another region) you can enter that in the 'Enrollment fee' field.
61
<ul>
62
	<li style="color: #990000;">Important: Only enter numbers and decimals in this field</li>
63
</ul>
64
</li>
65
	<li>If you want your patron to receive overdue notices, set the 'Overdue notice required' to 'Yes'</li>
66
	<li>If you charge patrons for placing holds on items, enter the fee amount in the 'Hold fee' field.
67
<ul>
68
	<li style="color: #990000;">Important: Only enter numbers and decimals in this field</li>
69
</ul>
70
</li>
71
	<li>In the 'Category type' field choose one of the six main parent categories</li>
72
	<li>Finally you can assign advanced messaging preferences by default to a patron category
73
<ul>
74
	<li style="color: #990000;">Important: Requires that you have EnhancedMessagingPreferences enabled</li>
75
	<li style="color: #990000;">Important: These can be changed for individual patrons, this setting is just a default to make it easier to set up messages for an entire category</li>
76
</ul>
77
</li>
78
</ul>
32
79
33
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
80
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/checkmarc.tmpl (-2 / +3 lines)
Lines 2-8 Link Here
2
2
3
<h1>MARC Bibliographic Framework Test</h1>
3
<h1>MARC Bibliographic Framework Test</h1>
4
4
5
<p>Once you have completed the process of setting up your MARC Frameworks and checked your MARC to Koha mapping, this program checks for major errors in your MARC setup.</p>
5
<p>This tool checks the MARC structure in your frameworks.</p>
6
7
<p>If you change your MARC Bibliographic framework it's recommended that you run this tool to test for errors in your definition.</p>
6
8
7
<p>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 the MARC Bibliographic Framework Test after every revision.</p>
8
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
9
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/cities.tmpl (-15 / +17 lines)
Lines 2-19 Link Here
2
2
3
<h1>Cities and Towns</h1>
3
<h1>Cities and Towns</h1>
4
4
5
<p>This parameter helps you define the cities and towns that your patrons live in.  These will appear as a pull down on the patron add screen to make it easier for entering of consistent data.</p>
5
<p>To standardize patron input you can define cities or towns within your region so that when new patrons are added librarians simply have to select the town from a list instead of having to type the town and zip (or postal) code information.</p>
6
<h2>Add a new city</h2>
6
7
		<ul>
7
<h2>Adding a City</h2>
8
			<li>		   
8
9
		   Click 'New City'</li>
9
<p>To add a new city, click the 'New City' button at the top of the page and enter the city name, state and zip/postal code.</p>
10
			<li>		   
10
11
		   Enter the city or town name and the zipcode</li>
11
<p>One you click Submit, your city will be saved and will be listed on the Cities and Towns page.</p>
12
			<li>		   
12
13
		   Click 'Submit'</li>
13
<p>Cities can be edited or deleted at any time.</p>
14
			<li>		   
14
15
		   You can edit/delete your cities and towns from the main 'Cities and towns' page</li>
15
<h2>Viewing Cities on Patron Add Form</h2>
16
			<li>		   
16
17
		   These fields will then appear when adding/editing a patron as a pull down to make it easier to enter data</li>
17
<p>If you have defined local cities using the New city form, then when adding or editing a patron record you will see those cities in a pull down menu to make city selection easy.</p>
18
		</ul>
18
19
	</div>	<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
19
<p>This will allow for easy entry of local cities into the patron record without risking the potential for typos or mistaken zip/postal codes.</p>
20
21
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/classsources.tmpl (-34 / +52 lines)
Lines 1-38 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>About Classification Sources</h1>
3
<h1>Classification Sources</h1>
4
4
5
<p>Define classification sources (i.e., call number schemes) used by your collection. You can also define 'filing rules' used for sorting call numbers.</p>
5
<p>Source of classification or shelving scheme is an Authorized Values category that is mapped to field 942$2 in Koha's MARC Bibliographic frameworks.</p>
6
	   
6
7
<p><strong>IMPORTANT:</strong> You do not have the option to 'define' a new filing rule. Currently, the filing rules and sorting routines are statically defined with options available in the dropdown menu when creating or editing a 'classification source' or 'filing rule'.</p>
7
<p>Commonly used values of this field are:</p>
8
	   
8
9
<p><strong>TIP:</strong> In the future, this features will be expanded to allow new filing rules to be created (defined) on the fly. In other words, in addition to choosing from a static sorting routine or filing rule, you will be able to actually to define new ones.</p>
9
<ul>
10
10
	<li>ddc - Dewey Decimal Classification</li>
11
<h1>To add a new 'Classification Source'...</h1>
11
	<li>lcc - Library of Congress Classification</li>
12
		<ul>
12
</ul>
13
			<li>Click 'New Classification Source'</li>
13
14
			<li>Enter a 'Classification source code'</li>
14
<p>If you chose to install classification sources during Koha's installation, you would see other values too:</p>
15
			<li>Enter a 'Description' for your new classification source</li>
15
16
			<li>Note if the classification source is in use (check the box for 'yes' and leave unchecked for 'no')</li>
16
<ul>
17
			<li>Choose a 'filing rule' from the dropdown menu to associate with your new classification source</li>
17
	<li>ANSCR (sound recordings)</li>
18
			<li>Click 'Save'</li>
18
	<li>SuDOC classification</li>
19
		</ul>	   
19
	<li>Universal Decimal Classification</li>
20
<p>IMPORTANT: 'Source in use?' controls whether source is available in item editor. For example, Koha ships with Dewey and LCC rules but a Dewey library may not want catalogers to mistakenly use LCC as an item callnumber type. To accomplish this, check box 'source in use?' only for the Dewey Classification Source and leave 'source in use' for all others unchecked.</p>
20
	<li>Other/Generic Classification</li>
21
21
</ul>
22
<h1>To add a new 'Filing Rule'...</h1>
22
23
		<ul>
23
<h2>Adding/Editing Classification Sources</h2>
24
			<li>Click 'New Filing Rules'</li>
24
25
			<li>Enter a 'Filing Rule Code'</li>
25
<p>You can add your own source of classification by using the New Classification Source button. To edit use the Edit link.</p>
26
			<li>Enter a 'Description' for your new filing rule</li>
26
27
			<li>Choose a 'filing routine' from the dropdown menu to associate with your new filing rule</li>
27
<p>When creating or editing:</p>
28
			<li>Click 'Save'</li>
28
29
		</ul>
29
<ul>
30
		
30
	<li>You will need to enter a code and a description.</li>
31
<h1>To edit a new 'Classification Source' or 'Filing Rule'...</h1>
31
	<li>Check the 'Source in use?' checkbox if you want the value to appear in the drop down list for this category.</li>
32
		<ul>
32
	<li>Select the appropriate filing rule from the drop down list.</li>
33
			<li>Click 'edit' next to the 'classification source' or 'filing rule' you wish to edit</li>
33
</ul>
34
			<li>Edit</li>
34
35
			<li>Click 'Save'</li>
35
<h2>Classification Filing Rules</h2>
36
		</ul>
36
37
<p>Filing rules determine the order in which items are placed on shelves.</p>
38
39
<p>Values that are pre-configured in Koha are:</p>
40
41
<ul>
42
	<li>Dewey</li>
43
	<li>LCC</li>
44
	<li>Generic</li>
45
</ul>
46
47
<p>Filing rules are mapped to Classification sources. You can setup new filing rules by using the New Filing Rule button. To edit use the Edit link.</p>
48
49
<p>When creating or editing:</p>
50
51
<ul>
52
	<li>Enter a code and a description</li>
53
	<li>Choose an appropriate filing routine - dewey, generic or lcc</li>
54
</ul>
37
55
38
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
56
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/currency.tmpl (-3 / +5 lines)
Lines 1-9 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Currencies administration</h1>
3
<h1>Currencies and Exchange Rates</h1>
4
4
5
<p>Define the currencies you deal with here.</p>
5
<p>If you place orders from more than one country you will want to input currency exchange rates so that your acquisitions module will properly calculate totals.</p>
6
6
7
<p>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.</p>
7
<p style="background-color: #ffe599">Tip: This data is not automatically updated, so be sure to keep it up to date so that your accounting is kept correct.</p>
8
9
<p>The active currency is the main currency you use in your library. Your active currency will have a check mark in the 'Active' column. If you don't have an active currency you will see an error message telling you to choose an active currency.</p>
8
10
9
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
11
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/fieldmapping.tmpl (-4 / +8 lines)
Lines 2-19 Link Here
2
2
3
<h1>Keyword to MARC Mapping</h1>
3
<h1>Keyword to MARC Mapping</h1>
4
4
5
<p>This tool will allow you to map MARC fields to a set of predefined keywords. </p>
5
<p>This tool will allow you to map MARC fields to a set of predefined keywords.</p>
6
6
7
<p>At this time the only keyword in use is 'subtitle.' </p>
7
<p>At this time the only keyword in use is 'subtitle.'</p>
8
8
9
<p>Using this tool you can define what MARC field prints to the detail screen of the bibliographic record using keywords.  The following example will use the subtitle field.</p>
9
<p>Using this tool you can define what MARC field prints to the detail screen of the bibliographic record using keywords. The following example will use the subtitle field.</p>
10
10
11
<p>Using the Framework pull down menu, choose the Framework you would like to apply this rule to.  For example, the subtitle for books can be found in the 245$b field.</p>
11
<p>Using the Framework pull down menu, choose the Framework you would like to apply this rule to. For example, the subtitle for books can be found in the 245$b field.</p>
12
12
13
<p>However the subtitle for DVDs appears in 245$p</p>
13
<p>However the subtitle for DVDs appears in 245$p</p>
14
14
15
<p>Using this tool you can tell Koha to print the right field as the subtitle when viewing the bibliographic record in the OPAC.</p>
15
<p>Using this tool you can tell Koha to print the right field as the subtitle when viewing the bibliographic record in the OPAC.</p>
16
16
17
<p>This tool can be used to chain together pieces of the record as well. If you want the series number to show in the title on your search results you simply have to map 490 $v to 'subtitle' along with the 245 $b.</p>
18
19
<p style="background-color: #ffe599">Tip: Chain together the fields you want to show after the item title in the order in which you want them to appear.</p>
20
17
<p>Future developments will include additional keyword assigned fields.</p>
21
<p>Future developments will include additional keyword assigned fields.</p>
18
22
19
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
23
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/item_circulation_alerts.tmpl (-29 / +15 lines)
Lines 1-36 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
<h1>Item Circulation Alerts</h1>
3
<h1>Item Circulation Alerts</h1>
3
4
4
<p>
5
<p>Libraries can decide if they want to have patrons automatically notified of circulation events (check ins and check outs).</p>
5
This matrix is to be used to define rules for check-in and checkout
6
6
notifications for combinations of libraries, patron categories, and
7
<p>These preferences are set based on patron types and item types.</p>
7
item types
8
8
</p>
9
<p style="color: #990000;">Important: These preference can be overwritten by changes in the individual patron's messaging preferences.</p>
10
11
<p>To set up circulation alerts:</p>
12
13
<ul>
14
	<li>Choose your library from the pull down at the top of the screen
9
<ul>
15
<ul>
10
	<li>
16
	<li>To set preferences for all libraries, keep the menu set to 'Default'</li>
11
	Click on 'Item Circulation Alerts'&nbsp;</li>
17
</ul>
12
	<li>You will be presented with the option of choosing a branch or applying rules to all branches ('Default')
18
</li>
13
	</li>
19
	<li>By default all item types and all patrons are notified of check ins and check outs. To change this, click on the item/patron type combo that you would like to stop notices for.</li>
14
	<li>Clicking on the squares in the matrix will change the color and also the email alert rules
15
	</li>
16
	<li>To set whether patrons receive alerts for checking books out, click the squares in the 'Check out' matrix
17
	<ul>
18
		<li style="background-color: #ffe599">TIP: If you have the library select box set to 'Default' the matrix will apply to all libraries.</span></li>
19
	</ul>
20
	</li>
21
	<li>To set whether patrons receive alerts for checking books in, click the squares in the 'Check in' matrix
22
	<ul>
23
		<li style="background-color: #ffe599">TIP:
24
		If you have the library select box set to a specific branch the matrix
25
		will apply just to that branch, showing the branch code in the message.</span>
26
		</div>
27
		</li>
28
	</ul>
29
	</li>
30
</ul>
20
</ul>
31
<h3><strong>Can I customize the email sent to my patrons?</strong></h3>
32
<p>
33
Yes, just go to Tools &gt; Notices and edit the Check In and Check Out notices.
34
</p>
35
21
36
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
22
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/itemtypes.tmpl (-39 / +58 lines)
Lines 1-41 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Item types management</h1>
3
<h1>Item Types</h1>
4
4
5
<p>You can define as many item types as you want.</p>
5
<p>Koha allows you to organize your collection by item types and collection codes.</p>
6
<p>The item types are the &quot;categories&quot; 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.</p>
6
7
<p>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.</p>
7
<p>Item types typically refer to the material type (book, cd, dvd, etc), but can be used in any way that works for your library.</p>
8
<p>&quot;Rental charge&quot; is any amount you might charge to users for borrowing items of a certain type (like videos).</p>
8
9
<p>&quot;Renewals allowed&quot; indicates how many times an items of this type may be renewed.</p>
9
<h2>Adding Item Types</h2>
10
<p>Item types are useful for many things, and <strong>very</strong> important in controlling how Koha works :</p>
10
11
	<ul>
11
<p>To add a new item type, simply click the 'New Item Type' button at the top of the Item Types page.</p>
12
		<li>Patrons can search on item types</li>
12
13
		<li>Issuing rules are set for item types (and for patron types / libraries)</li>
13
<ul>
14
	</ul>
14
	<li>In the 'Item Type' field, enter a short code for your item type</li>
15
<p>Setting up item types is one of the first things you should do after installing the Koha software.</p>
15
	<li>The description is the plain text definition of the item type</li>
16
16
	<li>You can choose to have an image associated with your item type
17
<h3>Adding &amp; Editing New Item Types</h3>
17
<ul>
18
	<ul>
18
	<li>You can choose from a series of image collections</li>
19
		<li>Your system will come with some predefined item types.  From this screen you can edit or delete these items</li>
19
	<li>You can link to a remote image</li>
20
		<li>To add a new item type click 'New Item Type'</li>
20
	<li>Or you can just have no image associated with the item type</li>
21
		<li>Enter a short code for the 'Item Type'</li>
21
	<li style="color: #990000;">Important: To have your item type images appear in the OPAC you need to set noItemTypeImages to 'Show'
22
		<li>Enter a longer explanation in the 'Description'</li>
22
<ul>
23
		<li>Feel free to choose an image for each item type (or selected the 'No image' option)</li>
23
	<li>Get there: More &gt; Administration &gt; Global System Preferences &gt; Admin</li>
24
		<li>The 'Not for loan' option can be used for items that cannot be checked out of the library</li>
24
</ul>
25
		<li>'Renewals' should include the number of times this item can be renewed</li>
25
</li>
26
		<li>If you charge a rental fee for items (such as DVDs) enter that amount in the 'Rental charge' field</li>
26
</ul>
27
		<li>The summary field is used to edit the way this item displays on the search results page
27
</li>
28
		<ul>
28
	<li>For items that do not circulate, check the 'Not for loan' options
29
			<li>
29
<ul>
30
		    <span style="background-color: #ffe599">
30
	<li>Items marked 'Not for loan' will appear in the catalog, but cannot be checked out to patrons</li>
31
TIP: For electronic resources you might want to enter</span>
31
</ul>
32
		    <span style="background-color: #ffe599">
32
</li>
33
<em>&lt;a href=&quot;[856u]&quot;&gt;open site&lt;/a&gt;</em></span>
33
	<li>Enter the total number of renewals allowed for the item type in the 'Renewals' box</li>
34
		    <span style="background-color: #ffe599">
34
	<li>For items that you charge a rental fee for, enter the total fee you charge in the 'Rental charge' field
35
to show the item link on the search results page</span></li>
35
<ul>
36
		</ul></li>
36
	<li style="color: #990000;">Important: Do not enter symbols in this field, only numbers and decimal points (ex. $5.00 should be entered as 5 or 5.00)</li>
37
		<li>When you're finished click 'Save Changes'</li>
37
	<li>This will charge the patron on checkout</li>
38
	</ul>
38
</ul>
39
<p><strong>Can I have a different type for new releases and older titles?</strong>
39
</li>
40
Yes.  Just enter an item type for new items and assign different circulation rules for this item type.
40
	<li>When finished, click 'Save Changes'
41
 </p><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
41
<ul>
42
	<li>Tip: All fields, with the exception of the 'Item Type' will be editable from the Item Types list</li>
43
</ul>
44
</li>
45
	<li>Your new item type will now appear on the list</li>
46
</ul>
47
48
<h2>Editing Item Types</h2>
49
50
<p>Each item type has an Edit button beside it. To edit an item simply click the 'Edit' link.</p>
51
52
<p>You will not be able to edit the code you assigned as the 'Item Type' but you will be able to edit the description for the item.</p>
53
54
<h2>Deleting Item Types</h2>
55
56
<p>Each item has a Delete button beside it. To delete an item, simply click the 'Delete' link.</p>
57
58
<p>You will not be able to delete item types that are being used by items within your system.</p>
59
60
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/koha2marclinks.tmpl (-6 / +6 lines)
Lines 1-15 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Koha 2 MARC links</h1>
3
<h1>Koha to MARC Mapping</h1>
4
4
5
<p>This page provides a simplified way to map your MARC tags and subfields to the non-MARC Koha database tables <b>for default biblio framework</b>. 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.</p>
5
<p>While Koha stores the entire MARC record, it also stores common fields for easy access in various tables in the database. Koha to MARC Mapping is used to tell Koha where to find these values in the MARC record. In many cases you will not have to change the default values set by in this tool on installation, but it is important to know that the tool is here and can be used at any time.</p>
6
6
7
<p>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.</p>
7
<p>The Koha to MARC Mapping page offers you the option of choosing from one of three tables in the database to assign values to.</p>
8
8
9
<p>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.</p>
9
<p>After choosing the table you would like to view, click 'OK.' To edit any mapping click on the 'Koha Filed' or the 'Edit' link.</p>
10
10
11
<p>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.</p>
11
<p>Choose which MARC field you would like to map to this Koha Field and click the 'OK' button. If you would like to clear all mappings, click the 'Click to "Unmap"' button.<p>
12
12
13
<p>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.</p>
13
<p style="color: #990000;">Important: At this time you can map only 1 MARC field to 1 Koha field. This means that you won't be able to map both the 100a and the 700a to the author field, you need to choose one or the other.</p>
14
14
15
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
15
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/marc_subfields_structure.tmpl (-49 / +132 lines)
Lines 1-57 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>MARC tag structure administration</h1>
3
<h1>MARC Bibliographic Frameworks Subfields</h1>
4
4
5
<p>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.</p> 
5
<p>Frameworks are made up of MARC fields and subfields. To make edits to most Frameworks you must edit the fields and subfields. Clicking 'Edit' to the right of each subfield will allow you to make changes to the text associated with the field</p>
6
<p>You can define as the marc tag structure for each biblio framework you have defined</p>
7
6
8
<p>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.</p>
7
<ul>
9
8
	<li>Each field has a tag (which is the MARC tag)
10
<p>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.</p> 
9
<ul>
11
<p>For each subfield you can set :</p>
10
	<li>The 'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels</li>
12
<ul>
11
	<li>The 'Label for OPAC' is what will show on the MARC view in the OPAC</li>
13
<li>repeatable : whether it can be repeated or not. If it can be repeated, separate the values by a | in the MARC editor when you want to have the subfield twice</li>
12
	<li>If you check 'Repeatable' then the field will have a plus sign next to it allowing you to add multiples of that tag</li>
14
<li>Mandatory : whether the field is mandatory or not. If mandatory, the cataloger can't validate the biblio if the subfield is empty.</li>
13
	<li>If you check 'Mandatory' the record will not be allowed to save unless you have a value assigned to this tag</li>
15
<li>Search also : a list of field that Koha will also search on when the user do a search on the subfield</li>
14
	<li>'Authorized value' is where you define an authorized value that your catalogers can choose from a pull down to fill this field in
16
<li>Koha link : <strong>very important</strong>. Koha is multi-MARC compliant. So, it does not know what the 245$a means, neither what 200$f (those 2 fields being both the title in MARC21 and UNIMARC !). So, in this list you can &quot;map&quot; a MARC subfield to it's meaning. Koha constantly maintains consistency between a subfield and it's meaning. When the user want to search on &quot;title&quot;, this link is used to find what is searched (245 if you're MARC21, 200 if you're UNIMARC).</li>
15
To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing</li>
17
<li>Text for librarian : what appears before the subfield in the librarian interface</li>
16
</ul>
18
<li>Text for OPAC : what appears before the field in the OPAC. If empty, the text for librarian is used instead</li>
17
</li>
19
<li>Managed in tab : deals with the tab where the subfield is shown. Ignore means that the subfield is not managed. All subfields of a given field must be in the same tab or ignored : 1st it's more logic, 2nd, Koha would be confused to repeat repeatable fields otherwise !!!</li>
18
	<li>From the list of subfields you can click 'Delete' to the right of each to delete the subfields</li>
20
<li>hidden : allows you to select from 19 possible visibility conditions, 17 of which are implemented. They are the following:</li>
19
	<li>To edit the subfields click 'Edit Subfields'</li>
21
<code><br />
20
	<li>For each subfield you can set the following values
22
( ! means 'not visible' or in the case of Collapsed 'not 
21
<ul>
23
Collapsed')
22
	<li>Text for librarian
24
<br /><br />
23
<ul>
25
  -9 =&gt; Future use<br />
24
	<li>what appears before the subfield in the librarian interface</li>
26
  -8 =&gt;  Flag<br />
25
</ul>
27
  -7 =&gt;  OPAC !Intranet !Editor  Collapsed<br />
26
</li>
28
  -6 =&gt;  OPAC  Intranet !Editor !Collapsed<br />
27
	<li>Text for OPAC
29
  -5 =&gt;  OPAC  Intranet !Editor  Collapsed<br />
28
<ul>
30
  -4 =&gt;  OPAC !Intranet !Editor !Collapsed<br />
29
	<li>what appears before the field in the OPAC.</li>
31
  -3 =&gt;  OPAC !Intranet  Editor  Collapsed<br />
30
	<li>If left empty, the text for librarian is used instead</li>
32
  -2 =&gt;  OPAC !Intranet  Editor !Collapsed<br />
31
</ul>
33
  -1 =&gt;  OPAC  Intranet  Editor  Collapsed<br />
32
</li>
34
   0 =&gt;  OPAC  Intranet  Editor !Collapsed<br />
33
	<li>Repeatable
35
   1 =&gt; !OPAC  Intranet  Editor  Collapsed<br />
34
<ul>
36
   2 =&gt; !OPAC !Intranet  Editor !Collapsed<br />
35
	<li>the field will have a plus sign next to it allowing you to add multiples of that tag</li>
37
   3 =&gt; !OPAC !Intranet  Editor  Collapsed<br />
36
</ul>
38
   4 =&gt; !OPAC  Intranet  Editor !Collapsed<br />
37
</li>
39
   5 =&gt; !OPAC !Intranet !Editor  Collapsed<br />
38
	<li>Mandatory
40
   6 =&gt; !OPAC  Intranet !Editor !Collapsed<br />
39
<ul>
41
   7 =&gt; !OPAC  Intranet !Editor  Collapsed<br />
40
	<li>the record will not be allowed to save unless you have a value assigned to this tag</li>
42
   8 =&gt; !OPAC !Intranet !Editor !Collapsed<br />
41
</ul>
43
   9 =&gt; Future use<br />
42
</li>
44
</code>
43
	<li>Managed in tab
45
<li>URL : if checked, the subfield is an URL, and can be clicked</li>
44
<ul>
46
<li>Auth value : means the value is not free, but in the authorized value list of the selected type</li>
45
	<li>defines the tab where the subfield is shown. All subfields of a given field must be in the same tab or ignored. Ignore means that the subfield is not managed.</li>
47
<li>thesaurus : means that the value is not free, but can be searched in authority/thesaurus of the selected category</li>
46
</ul>
48
<li>plugin : means the value is calculated or managed by a plugin. Plugins can do almost anything. For example, in UNIMARC there are plugins for every 1xx fields that are coded fields. The plugin is a huge help for cataloger ! There are also two plugins (unimarc_plugin_210c and unimarc_plugin_225a that can &quot;magically&quot; find the editor from an ISBN, and the collection list for the editor)</li>
47
</li>
49
<li>link : If you enter a field/subfield here (200b), a link appears after the subfield in the MARC Details view. This view is present only in intranet, not in Opac. If the librarian click on the link, a search&nbsp; is done on the DB for the field/subfield with the same value. Can be used for 2 main topic :
48
</ul>
50
  	<ul>
49
<ul>
51
  		<li>on a field like author (200f in UNIMARC), put 200f here, you will be able to see all biblios with the same author.</li>
50
	<li>Default value
52
  		<li>on a field that is a link (4xx) to reach another biblio. For example, put 011a in 464$x, will find the serials that are with this issn. </li>
51
<ul>
53
 	</ul>
52
	<li>defines what you want to appear in the field by default, this will be editable, but it saves time if you use the same note over and over or the same value in a field often.</li>
53
</ul>
54
</li>
55
</ul>
56
<ul>
57
	<li>hidden
58
<ul>
59
	<li>allows you to select from 19 possible visibility conditions, 17 of which are implemented. They are the following:
60
<ul>
61
	<li>-9 =&gt; Future use</li>
62
	<li>-8 =&gt; Flag</li>
63
	<li>-7 =&gt; OPAC !Intranet !Editor Collapsed</li>
64
	<li>-6 =&gt; OPAC Intranet !Editor !Collapsed</li>
65
	<li>-5 =&gt; OPAC Intranet !Editor Collapsed</li>
66
	<li>-4 =&gt; OPAC !Intranet !Editor !Collapsed</li>
67
	<li>-3 =&gt; OPAC !Intranet Editor Collapsed</li>
68
	<li>-2 =&gt; OPAC !Intranet Editor !Collapsed</li>
69
	<li>-1 =&gt; OPAC Intranet Editor Collapsed</li>
70
	<li>0 =&gt; OPAC Intranet Editor !Collapsed</li>
71
	<li>1 =&gt; !OPAC Intranet Editor Collapsed</li>
72
	<li>2 =&gt; !OPAC !Intranet Editor !Collapsed</li>
73
	<li>3 =&gt; !OPAC !Intranet Editor Collapsed</li>
74
	<li>4 =&gt; !OPAC Intranet Editor !Collapsed</li>
75
	<li>5 =&gt; !OPAC !Intranet !Editor Collapsed</li>
76
	<li>6 =&gt; !OPAC Intranet !Editor !Collapsed</li>
77
	<li>7 =&gt; !OPAC Intranet !Editor Collapsed</li>
78
	<li>8 =&gt; !OPAC !Intranet !Editor !Collapsed</li>
79
	<li>9 =&gt; Future use URL : if checked, the subfield is an URL, and can be clicked</li>
80
</ul>
81
</li>
82
	<li>( ! means 'not visible' or in the case of Collapsed 'not Collapsed')</li>
83
</ul>
84
</li>
85
</ul>
86
<ul>
87
	<li>Is a URL
88
<ul>
89
	<li>if checked, it means that the subfield is a URL and can be clicked</li>
90
</ul>
91
</li>
92
</ul>
93
<ul>
94
	<li>Link
95
<ul>
96
	<li>If you enter a field/subfield here (200b), a link appears after the subfield in the MARC Detail view. This view is present only in the staff client, not the OPAC. If the librarian clicks on the link, a search is done on the database for the field/subfield with the same value. This can be used for 2 main topics :
97
<ul>
98
	<li>on a field like author (200f in UNIMARC), put 200f here, you will be able to see all bib records with the same author.</li>
99
	<li>on a field that is a link (4xx) to reach another bib record. For example, put 011a in 464$x, will find the serials that are with this ISSN.</li>
100
</ul>
101
</li>
102
	<li style="color: #990000;">Important: This value should not change after data has been added to your catalog</li>
103
</ul>
104
</li>
105
</ul>
106
<ul>
107
	<li>Koha link
108
<ul>
109
	<li>Koha is multi-MARC compliant. So, it does not know what the 245$a means, neither what 200$f (those 2 fields being both the title in MARC21 and UNIMARC). So, in this list you can "map" a MARC subfield to its meaning. Koha constantly maintains consistency between a subfield and its meaning. When the user want to search on "title", this link is used to find what is searched (245 if you're MARC21, 200 if you're UNIMARC).</li>
110
</ul>
111
</li>
112
</ul>
113
<ul>
114
	<li>Authorized value
115
<ul>
116
	<li>means the value cannot by typed by the librarian, but must be chosen from a pull down generated by the authorized value list</li>
117
	<li>In the example above, the 504a field will show the MARC504 Authorized Values when cataloging</li>
118
</ul>
119
</li>
120
</ul>
121
<ul>
122
	<li>Thesaurus
123
<ul>
124
	<li>means that the value is not free text, but must be searched in the authority/thesaurus of the selected category</li>
125
</ul>
126
</li>
127
</ul>
128
<ul>
129
	<li>Plugin
130
<ul>
131
	<li>means the value is calculated or managed by a plugin. Plugins can do almost anything.</li>
132
	<li>For example, in UNIMARC there are plugins for every 1xx fields that are coded fields. The plugin is a huge help for cataloger ! There are also two plugins (unimarc_plugin_210c and unimarc_plugin_225a that can "magically" find the editor from an ISBN, and the collection list for the editor)</li>
133
</ul>
134
</li>
135
</ul>
54
</li>
136
</li>
137
	<li>To save your changes simply click the 'Save Changes' button at the top of the screen</li>
55
</ul>
138
</ul>
56
139
57
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
140
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/marctagstructure.tmpl (-19 / +15 lines)
Lines 1-28 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>MARC tag structure administration</h1>
3
<h1>MARC Bibliographic Frameworks Tags</h1>
4
4
5
<p>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.</p>
5
<p>To add a field to a Framework click the 'New Tag' button at the top of the Framework definition</p>
6
<p>You can define as the marc tag structure for each biblio framework you have defined</p>
7
6
8
<p>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.</p>
7
<p>This will open up a blank form for entering MARC field data</p>
8
9
<p>Enter the information about your new tag:</p>
9
10
10
<p>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.</p>
11
<p>For each subfield you can set :</p>
12
<ul>
11
<ul>
13
<li>repeatable : whether it can be repeated or not. If it can be repeated, separate the values by a | in the MARC editor when you want to have the subfield twice</li>
12
	<li>The 'Tag' is the MARC field number</li>
14
<li>Mandatory : whether the field is mandatory or not. If mandatory, the cataloger can't validate the biblio if the subfield is empty.</li>
13
	<li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module</li>
15
<li>Search also : a list of field that Koha will also search on when the user do a search on the subfield</li>
14
	<li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record</li>
16
<li>Koha link : <b>very important</b>. Koha is multi-MARC compliant. So, it does not know what the 245$a means, neither what 200$f (those 2 fields being both the title in MARC21 and UNIMARC !). So, in this list you can "map" a MARC subfield to it's meaning. Koha constantly maintains consistency between a subfield and it's meaning. When the user want to search on "title", this link is used to find what is searched (245 if you're MARC21, 200 if you're UNIMARC).</li>
15
	<li>If this field can be repeated, check the 'Repeatable' box</li>
17
<li>Text for librarian : what appears before the subfield in the librarian interface</li>
16
	<li>If this field is mandatory, check the 'Mandatory' box</li>
18
<li>Text for OPAC : what appears before the field in the OPAC. If empty, the text for librarian is used instead</li>
17
	<li>If you want this field to be a pull down with limited possible answers, choose which 'Authorized value' list you want to use</li>
19
<li>Managed in tab : deals with the tab where the subfield is shown. Ignore means that the subfield is not managed. All subfields of a given field must be in the same tab or ignored : 1st it's more logic, 2nd, Koha would be confused to repeat repeatable fields otherwise !!!</li>
20
<li>hidden : means that the field is managed, but NOT shown in opac. It's usually for internal fields</li>
21
<li>URL : if checked, the subfield is an URL, and can be clicked</li>
22
<li>Auth value : means the value is not free, but in the authorized value list of the selected type</li>
23
<li>thesaurus : means that the value is not free, but can be searched in authority/thesaurus of the selected category</li>
24
<li>plugin : means the value is calculated or managed by a plugin. Plugins can do almost anything. For example, in UNIMARC there are plugins for every 1xx fields that are coded fields. The plugin is a huge help for cataloger ! There are also two plugins (unimarc_plugin_210c and unimarc_plugin_225a that can "magically" find the editor from an ISBN, and the collection list for the editor)</li>
25
<li>link : useless for instance</li>
26
</ul>
18
</ul>
27
19
20
<p>When you're finished, click 'Save Changes' and you will be presented with your new field</p>
21
22
<p>To the right of the new field is a link to 'Subfields,' you will need to add subfields before this tag will appear in your MARC editor.</p>
23
28
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
24
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/matching-rules.tmpl (-6 / +42 lines)
Lines 1-13 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Record Matching Rules</h1>   
3
<h1>Record Matching Rules</h1>
4
    <p><span style="background-color: #ffe599">
5
IMPORTANT: This is an advanced feature and should not be altered without knowing how it will effect data migration.</span></p>
6
4
7
<p>Use this tool to create rules to apply during the data migration process. It will prevent duplicates from coming into the system when importing MARC records. An import rule or matching rule consists of one or more 'match points' and zero or more 'match checks'. Each match point specifies a 'search index' and a MARC 'tag', 'subfield', or 'length' (fixed field position) when a record is imported. For each match point, a string is constructed from the tag specified in the match point and the related index is searched.</p>
5
<p>Record matching rules are used when importing MARC records into Koha.</p>
8
6
9
<p>The set of matching records are assigned a score (the value of which is determined by the match point rule). Then, the rest of the match points are considered and the scores of each set of matches is added up. The set of matching records whose total score is over a threshold value defined in the matching rule are candidate matches.</p>
7
<p>The rules that you set up here will be referenced with you Stage MARC Records for Import.</p>
10
8
11
<p>Match checks are applied for all candidate matches. Each match check specifies a tag in the incoming record and a tag in the possible matching record. The values must be the same for a match to be considered good (e.g., doing a match check on title, or publication date).</p>
9
<p>To create a new matching rule:</p>
10
11
<ul>
12
	<li>Click 'New Record Matching Rule'
13
<ul>
14
	<li>Choose a unique name and enter it in the 'Matching rule code' field</li>
15
	<li>'Description' can be anything you want to make it clear to you what rule you're picking</li>
16
	<li>'Match threshold' - ??</li>
17
	<li>Match points are set up to determine what fields to match on</li>
18
	<li>'Search index' can be found by looking at the ccl.properties file on your system which tells the zebra indexing what data to search for in the MARC data".</li>
19
	<li>'Score' - ??</li>
20
	<li>Enter the MARC tag you want to match on in the 'Tag' field</li>
21
	<li>Enter the MARC tag subfield you want to match on in the 'Subfields' field</li>
22
	<li>'Offset' - ??</li>
23
	<li>'Length' - ??</li>
24
	<li>Koha only has one 'Normalization rule' that removes extra characters such as commas and semicolons. The value you enter in this field is irrelevant to the normalization process.</li>
25
	<li>'Required match checks' - ??</li>
26
</ul>
27
</li>
28
</ul>
29
30
<h2>Sample Record Matching Rule: Control Number</h2>
31
32
<ul>
33
	<li>Match threshold: 100</li>
34
	<li>Matchpoints (just the one):</li>
35
	<li>Search index: Control-number</li>
36
	<li>Score: 101</li>
37
	<li>Tag: 001
38
<ul>
39
	<li>this field is for the control number assigned by the organization creating, using, or distributing the record</li>
40
</ul>
41
</li>
42
	<li>Subfields: a</li>
43
	<li>Offset: 0</li>
44
	<li>Length: 0</li>
45
	<li>Normalization rule: Control-number</li>
46
	<li>Required Match checks: none (remove the blank one)</li>
47
</ul>
12
48
13
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
49
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/patron-attr-types.tmpl (-31 / +57 lines)
Lines 1-33 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Patron attribute types</h1>A patron attribute (or extended patron attribute) is an additional piece of information associated with a patron record.  Each attribute has a type that specifies whether the attribute is repeatable, can serve as a unique identifier, can take a password, and whether it can be used to search for patron records in the staff interface.
3
<h1>Patron Attribute Types</h1>
4
The list of attribute types is controlled by staff with 'superlibrarian' permissions.<br/>
4
5
	<ul>
5
<p>Patron attributes can be used to define custom fields to associate with your patron records. In order to enable the use of custom fields you need to set the ExtendedPatronAttributes system preference.</p>
6
		<li>Get there: Patrons &gt; Patron Record &gt; More &gt; Set Permissions</li>
6
7
	</ul>Once an attribute type is defined, values for that attribute can be added to the patron record via the staff interface or the batch patron import.
7
<p>A common use for this field would be for a student ID number or a Driver's license number.</p>
8
Two uses of extended attributes are:
8
9
9
<h2>Adding Patron Attributes</h2>
10
	<ul>
10
11
		<li>defining additional unique identifiers, such as a campus student ID number, a library staff HR number, and so on.  These IDs can be used for searching or matching and overlaying records during a batch import.</li>
11
<p>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at the top of the page</p>
12
		<li>additional statistical categories.  For example, a library could define an attribute type for tracking the academic major of a student patron. Any number of attributes of this sort could be defined.</li>
12
13
	</ul>The extended attributes feature is completely optional.  If the 'ExtendPatronAttributes' system preference is OFF, customizable patron attributes will not be usable.
13
<ul>
14
<h2>Add Patron Attribute</h2>
14
	<li>In the 'Patron attribute type code', enter a short code to identify this field
15
	<ul>
15
<ul>
16
		<li>Click 'Patron attribute types'</li>
16
	<li>This field is limited to 10 characters (numbers and letters only)</li>
17
		<li>	   
17
	<li>This setting cannot be changed after an attribute is defined</li>
18
	   IMPORTANT: You will need to have ExtendedPatronAttributes turned on
18
</ul>
19
		<ul>
19
</li>
20
			<li>Get there: More &gt; Administration &gt; General system preferences &gt; Patrons &gt; ExtendedPatronAttributes</li>
20
	<li>In the 'Description' field, enter a longer (plain text) explanation of what this field will contain</li>
21
		</ul></li>
21
	<li>Check the box next to 'Repeatable' to let a patron record have multiple values of this attribute.
22
		<li>To add a new Patron Attribute, click 'New Patron Attribute Type'</li>
22
<ul>
23
		<li>The 'Patron attribute type code' should be unique and is the only required field
23
	<li>This setting cannot be changed after an attribute is defined</li>
24
		<ul>
24
</ul>
25
			<li>TIP: This field is not editable once it is set</li>
25
</li>
26
		</ul></li>
26
	<li>If 'Unique identifier' is checked, the attribute will be a unique identifier which means, if a value is given to a patron record, the same value cannot be given to a different record.
27
		<li>Fill in all of the fields you need for your attribute
27
<ul>
28
		<ul>
28
	<li>This setting cannot be changed after an attribute is defined</li>
29
			<li>TIP: The repeatibility and unique_id settings of an attribute type cannot be changed after creation - this is to avoid having to deal with changing constraints if an attribute type is already in use by patron records</li>
29
</ul>
30
		</ul></li>
30
</li>
31
		<li>Click 'Save'</li>
31
	<li>Check 'Allow password' to make it possible to associate a password with this attribute.</li>
32
		<li>TIP: An attribute type cannot be deleted if it is used by any patron records</li>
32
	<li>Check 'Display in OPAC' to display this attribute on a patron's details page in the OPAC.</li>
33
	</ul><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
33
	<li>Check 'Searchable' to make this attribute searchable in the staff patron search.</li>
34
	<li>Authorized value category; if one is selected, the patron record input page will only allow values to be chosen from the authorized value list.
35
<ul>
36
	<li>You will first need to add an authorized value list for it to appear in this menu</li>
37
	<li>An authorized value list is not enforced during batch patron import.</li>
38
</ul>
39
</li>
40
	<li>Click Save to save your new attribute</li>
41
</ul>
42
43
<p>Once added your attribute will appear on the list of attributes and also on the patron record add/edit form</p>
44
45
<h2>Editing/Deleting Patron Attributes</h2>
46
47
<p>Each patron attribute has an edit and a delete link beside it on the list of attributes.</p>
48
49
<p>Some fields in the attribute will not be editable once created:</p>
50
51
<ul>
52
	<li>Patron attribute type code</li>
53
	<li>Repeatable</li>
54
	<li>Unique identifier</li>
55
</ul>
56
57
<p>You will be unable to delete an attribute if it's in use.</p>
58
59
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences.tmpl (-3 / +15 lines)
Lines 1-9 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>System preferences administration</h1>
3
<h1>System Preferences</h1>
4
5
<p>Global system preferences control the way your Koha system works in general. Set these preferences before anything else in Koha.</p>
6
7
<p>System preferences can be searched (using any part of the preference name or description) using the search box on the 'Administration' page or the search box at the top of each system preferences page.</p>
8
9
<p>When editing preferences a '(modified)' tag will appear next to items you change until you click the 'Save All' button</p>
10
11
<p>After saving your preferences you'll get a confirmation message telling you what preferences were saved</p>
12
13
<p>Each section of preferences can be sorted alphabetically by clicking the small down arrow to the right of the word 'Preference' in the header column</p>
4
14
5
<p>This page allows you to set the system preferences that control much of the basic behavior of Koha.</p>
6
<p>Each of the tabs on the left holds several different preferences:</p>
15
<p>Each of the tabs on the left holds several different preferences:</p>
16
7
	<ul>
17
	<ul>
8
		<li><strong>Acquisitions:</strong> holds preferences related to acquisitions such as handling patron suggestions and local taxes.</li>
18
		<li><strong>Acquisitions:</strong> holds preferences related to acquisitions such as handling patron suggestions and local taxes.</li>
9
		<li><strong>Administration:</strong> holds administrative preferences such as admin email address, sessions and timout.</li>
19
		<li><strong>Administration:</strong> holds administrative preferences such as admin email address, sessions and timout.</li>
Lines 21-24 Link Here
21
		<li><strong>Serials</strong> holds all preferences related to managing serial subscriptions.</li>
31
		<li><strong>Serials</strong> holds all preferences related to managing serial subscriptions.</li>
22
		<li><strong>Staff Client:</strong> customize the staff client by editing the stylesheet and navigation menu.</li>
32
		<li><strong>Staff Client:</strong> customize the staff client by editing the stylesheet and navigation menu.</li>
23
		<li><strong>Web Services:</strong> includes preferences related to services like OAI-PMH.</li>
33
		<li><strong>Web Services:</strong> includes preferences related to services like OAI-PMH.</li>
24
	</ul><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
34
	</ul>
35
	
36
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/roadtype.tmpl (-13 / +11 lines)
Lines 1-15 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Road Types</h1>
3
<h1>Adding Road Types</h1>
4
4
5
<p>The values defined in this preference will show up in a pull down menu when entering patron information.These values can be used in geographic statistics.</p>
5
<p>To add a road type, click 'New Road Type' and then enter the road type the way you'd like it displayed.</p>
6
6
7
<h2>Add a new road type</h2>
7
<p>Once you submit the form, your new road type will be listed on the Road Types page</p>
8
		<ul>
8
9
			<li>Click 'New Road Type'</li>
9
<h2>Viewing Road Types on Patron Add form</h2>
10
			<li>Enter a value such as Blvd., Avenue, Street or St.</li>
10
11
			<li>Click 'Submit'</li>
11
<p>When adding or editing a patron, if you have road types defined, there will be a pull down to choose the road type from.</p>
12
			<li>Your values will appear on the Road Types page</li>
12
13
			<li>Your values will also appear as authorized values when entering or editing a patron</li>
13
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
14
		</ul>
15
	</div>	<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/smart-rules.tmpl (-55 / +70 lines)
Lines 2-79 Link Here
2
2
3
<h1>Circulation and Fines Rules</h1>
3
<h1>Circulation and Fines Rules</h1>
4
4
5
<p>These rules define how your items are circulated, how/when fines are calculated and how holds are handled. The rules are applied from most specific to less specific, using the first found in this order: </p>
5
<p>These rules define how your items are circulated, how/when fines are calculated and how holds are handled.</p>
6
7
<p>The rules are applied from most specific to less specific, using the first found in this order:</p>
6
8
7
<ul>
9
<ul>
8
<li>same library, same patron type, same item type</li>
10
	<li>same library, same patron type, all item types</li>
9
<li>same library, same patron type, default item type</li>
11
	<li>same library, same patron type, alll item types</li>
10
<li>same library, default patron type, same item type</li>
12
	<li>same library, all patron types, same item type</li>
11
<li>same library, default patron type, default item type</li>
13
	<li>same library, all patron types, all item types</li>
12
<li>default library, same patron type, same item type</li>
14
	<li>all libraries, same patron type, same item type</li>
13
<li>default library, same patron type, default item type</li>
15
	<li>all libraries, same patron type, all item types</li>
14
<li>default library, default patron type, same item type</li>
16
	<li>all libraries, all patron types, same item type</li>
15
<li>default library, default patron type, default item type</li></ul>
17
	<li>all libraries, all patron types, all item types</li>
18
</ul>
19
20
<p style="background-color: #ffe599;">Tip: If you are a single library system choose your branch name before creating rules (sometimes having only rules for the 'all libraries' option can cause issues with holds)</p>
16
21
17
<p><span style="background-color: #ffe599">TIP: If you are a single library system, you can leave your library selection to 'default library' or choose your branch name and experience the same results.</span></p>
22
<p style="color: #990000;">Important: At the very least you will need to set an default circulation rule. This rule should be set for all item types, all libraries and all patron types. That will catch all instances that do not match a specific rule. When checking out if you do not have a rule for all libraries, all item types and all patron types then you may see patrons getting blocked from placing holds. You will also want a rule for your specific library set for all item types and all patron types to avoid this holds issue. Koha needs to know what rule to fall back on.</p>
18
23
19
<h3 class="section">Default Issuing Rule</h3>
24
<h2>Default Circulation Rules</h2>
20
25
21
<p>Using the issuing rules matrix you can define rules that depend on patron/item type combos. To set your rules, choose a library from the pull down: </p>
26
<p>Using the issuing rules matrix you can define rules that depend on patron/item type combos. To set your rules, choose a library from the pull down (or 'all libraries' if you want to apply these rules to all branches):</p>
22
 
23
<p><span style="background-color: #ffe599">TIP: If you leave this set to 'Default' it will apply the rules to all libraries</span></p>
24
27
25
<p>From the matrix you can choose any combination of patron categories and item types to apply the rules to. </p>
28
<p>From the matrix you can choose any combination of patron categories and item types to apply the rules to</p>
26
29
27
<ul><li>First choose which patron category you'd like the rule to   be applied to. If you leave this to 'Default' it will apply to   all patron categories</li>
30
<ul>
28
<li>Choose the 'Item Type' you would like this rule to apply   to. If you leave this to 'Default' it will apply to all item   types</li>
31
	<li>First choose which patron category you'd like the rule to be applied to. If you leave this to 'All' it will apply to all patron categories</li>
29
<li>Limit the number of items a patron can have checked out at   the same time by entering a number in the 'Current Checkouts   Allowed' field</li>
32
	<li>Choose the 'Item Type' you would like this rule to apply to. If you leave this to 'All' it will apply to all item types</li>
30
<li>Define the period of time and item can be checked out to a   patron by entering the number of days in the 'Loan Period'   box.</li>
33
	<li>Limit the number of items a patron can have checked out at the same time by entering a number in the 'Current Checkouts Allowed' field</li>
31
<li>'Fine Amount' should have the amount you would like to   charge for overdue items
34
	<li>Define the period of time and item can be checked out to a patron by entering the number of days in the 'Loan Period' box.</li>
32
<ul><li><span style="color: #ff0000">IMPORTANT: Enter only numbers and decimal points.</span></li></ul></li>
35
	<li>'Fine Amount' should have the amount you would like to charge for overdue items
33
<li>The 'Fine Grace Period' is the period of time an item can   be overdue before you start charging fines.</li>
36
<ul>
34
<li>Enter the 'Fine Charging Interval' in days (ex. charge   fines every 1 day, or every 2 days)</li>
37
	<li>Enter only numbers and decimal points (no currency symbols).</li>
35
<li>If your library 'fines' patrons by suspending their   account you can enter the number of days their fine should be   suspended in the 'Suspension in Days' field</li>
38
</ul>
36
<li>Next decide if the patron can renew this item type and if   so, enter how many times they can renew it in the 'Renewals   Allowed' box</li>
39
</li>
37
<li>If the patron can place holds on this item type, enter the   total numbers of items (of this type) that can be put on hold in   the 'Holds Allowed' field</li>
40
	<li>The 'Fine Grace Period' is the period of time an item can be overdue before you start charging fines.</li>
38
<li>Finally, if you charge a rental fee for the item type and   want to give a specific patron type a discount on that fee,   enter the percentage discount (without the % symbol) in the   'Rental Discount' field</li></ul>
41
	<li>Enter the 'Fine Charging Interval' in days (ex. charge fines every 1 day, or every 2 days)</li>
42
	<li>If your library 'fines' patrons by suspending their account you can enter the number of days their fine should be suspended in the 'Suspension in Days' field</li>
43
	<li>Next decide if the patron can renew this item type and if so, enter how many times they can renew it in the 'Renewals Allowed' box</li>
44
	<li>If the patron can place holds on this item type, enter the total numbers of items (of this type) that can be put on hold in the 'Holds Allowed' field</li>
45
	<li>Finally, if you charge a rental fee for the item type and want to give a specific patron type a discount on that fee, enter the percentage discount (without the % symbol) in the 'Rental Discount' field</li>
46
</ul>
39
47
40
<p>When finished, click 'Add' to save your changes. To modify a rule, create a new one with the same patron type and item type. If you would like to delete your rule, simply click the 'Delete' link to the right of the rule. </p>
48
<p>When finished, click 'Add' to save your changes. To modify a rule, create a new one with the same patron type and item type. If you would like to delete your rule, simply click the 'Delete' link to the right of the rule.</p>
41
49
42
<p>To save time you can clone rules from one library to another by choosing the clone option above the rules matrix. </p>
50
<p>To save time you can clone rules from one library to another by choosing the clone option above the rules matrix.</p>
43
51
44
<p>After choosing to clone you will be presented with a confirmation message. </p>
52
<p>After choosing to clone you will be presented with a confirmation message.</p>
45
53
46
<h3 class="section">Default Checkouts and Hold Policy</h3>
54
<h2>Default Checkouts and Hold Policy</h2>
47
55
48
<p>You can set a default maximum number of checkouts and hold policy that will be used if none is defined below for a particular item type or category. </p>
56
<p>You can set a default maximum number of checkouts and hold policy that will be used if none is defined below for a particular item type or category.</p>
49
57
50
<p>From this menu you can set a default to apply to all item types and patrons in the library. </p>
58
<p>From this menu you can set a default to apply to all item types and patrons in the library.</p>
51
59
52
<ul><li>In 'Total Current Checkouts Allowed' enter the total   number of items patrons can have checked out at one time</li>
60
<ul>
53
<li>Control where patrons can place holds from using the 'Hold   Policy' menu
61
	<li>In 'Total Current Checkouts Allowed' enter the total number of items patrons can have checked out at one time</li>
54
<ul><li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
62
	<li>Control where patrons can place holds from using the 'Hold Policy' menu
55
<li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
63
<ul>
56
<li>No Holds Allowed: No patron may put this book on hold.</li></ul></li>
64
	<li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
57
<li>Once your policy is set, you can unset it by clicking the   'Unset' link to the right of the rule</li></ul>
65
	<li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
66
	<li>No Holds Allowed: No patron may put this book on hold.</li>
67
</ul>
68
</li>
69
	<li>Once your policy is set, you can unset it by clicking the 'Unset' link to the right of the rule</li>
70
</ul>
58
71
59
<h3 class="section">Checkouts Per Patron</h3>
72
<h2>Checkouts Per Patron</h2>
60
73
61
<p>For this library, you can specify the maximum number of loans that a patron of a given category can make, regardless of the item type. </p>
74
<p>For this library, you can specify the maximum number of loans that a patron of a given category can make, regardless of the item type.</p>
62
 
63
<p><span style="background-color: #ffe599">TIP: If the total amount loanable for a given patron category is left blank, no limit applies, except possibly for a limit you define for a specific item type.</span></p>
64
75
65
<h3 class="section">Item Hold Policies</h3>
76
<p>If the total amount loanable for a given patron category is left blank, no limit applies, except possibly for a limit you define for a specific item type.</p>
77
78
<h2>Item Hold Policies</h2>
79
80
<p>For this library, you can edit rules for given itemtypes, regardless of the patron's category. Currently, this means hold policies.</p>
81
82
<p>The various policies have the following effects:</p>
83
84
<ul>
85
	<li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
86
	<li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
87
	<li>No Holds Allowed: No patron may put this book on hold.</li>
88
</ul>
66
89
67
<p>For this library, you can edit rules for given itemtypes, regardless of the patron's category. Currently, this means hold policies. </p>
90
<p style="color: #990000;">Important: Note that if the system preference AllowHoldPolicyOverride set to 'allow', these policies can be overridden by your circulation staff.</p>
68
 
69
<p>The various policies have the following effects: </p>
70
91
71
<ul><li>From Any Library: Patrons from any library may put this   item on hold. (default if none is defined)</li>
92
<p style="color: #990000;">Important: These policies are based on the patron's home branch, not the branch that the reserving staff member is from.</p>
72
<li>From Home Library: Only patrons from the item's home   library may put this book on hold.</li>
73
<li>No Holds Allowed: No patron may put this book on   hold.</li></ul> 
74
 
75
<p><span style="color: #ff0000">IMPORTANT: Note that if the system preference AllowHoldPolicyOverride set to 'allow', these policies can be overridden by your circulation staff.</span></p>
76
 
77
<p><span style="color: #ff0000">IMPORTANT: These policies are based on the patron's home branch, not the branch that the reserving staff member is from.</span> </p>
78
93
79
	<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
94
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/stopwords.tmpl (-7 / +8 lines)
Lines 1-14 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Stop word administration page</h1>
3
<h1>Stop Words</h1>
4
4
5
<p>Here you should list all of the words you wish Koha to ignore when performing catalog searches or building the keyword index.</p>
5
<p style="color: #990000">Important: If NoZebra is set to 'Use' this option will not appear on the administration menu</p>
6
<h3>Koha with Zebra</h3>
7
<p>Zebra handles stopwords internally, and does so effectively and efficiently.  In normal circumstances, there should be no reason for Koha to remove stopwords prior to submitting the search query to Zebra, and in most cases doing so will actually negatively affect relevance ranking and phrase searching without giving any performance benefit.</p>
8
6
9
<h3>Koha without Zebra</h3>
7
<p>Stop words are words that you want the search system to ignore.</p>
10
<p>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.</p>
11
8
12
<p>(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.)</p>
9
<p>Koha comes with a standard list of stop words that can be edited by visiting the Stop Word administration area.</p>
10
11
<p>To add a new stop word to the list, click the 'New Stop Word' button and add the word you'd like ignored</p>
12
13
<p style="color: #990000">Important: If you change something in this table, ask your administrator to run misc/batchRebuildBiblioTables.pl script.</p>
13
14
14
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
15
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/z3950servers.tmpl (-7 / +32 lines)
Lines 1-15 Link Here
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
1
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
2
2
3
<h1>Z39.50 servers administration</h1>
3
<h1>Z39.50 Servers</h1>
4
4
5
<p>Defines the Z39.50 servers you want Koha to search.</p>
5
<p>Koha has a powerful copy cataloging tool. Using Koha you can connect to any Z39.50 target that is publicly available or that you have the log in information to.</p>
6
6
7
<p>Koha comes with one Z39.50 server site defined (the U.S. Library of Congress) for finding catalog records to import directly into your catalog. In this area, you can define other servers for searching.</p>
7
<p>Koha comes with a default list of Z39.50 targets set up that you can add to, edit or delete.</p>
8
8
9
<p>To add servers, you will need to know the domain name or IP address of the server, the port number to use, and the name of the database to access. This information is available for many servers worldwide by acessing the Index Data website at http://www.indexdata.dk/targettest/. All of the servers listed there accept anonymous connections. (Be sure to choose servers which deliver records in the proper MARC format for your Koha installation.)</p>
9
<p>To find additional targets you use IndexData's IRSpy: <a href="http://irspy.indexdata.com">http://irspy.indexdata.com</a></p>
10
10
11
<p>If you have a login name and password for other Z39.50 servers, Koha will save your user ID and password in addition to the other information it needs to make a connection. (For anonymous servers, leave the userid and password fields blank.) The other fields on the form control whether or not the server is automatically searched when you request a Z39.50 search (put a "1" in the "Checked" field) and the order in which it is checked.</p>
11
<h2>Add a Z39.50 Target</h2>
12
<ul>
13
	<li>From the main Z39.50 page, click 'New Z39.50 Server'
14
<ul>
15
	<li>Userid and Password are only required for servers that are password protected</li>
16
</ul>
17
</li>
18
</ul>
12
19
13
<p>It is a good idea to be selective in choosing servers. Defining more than five or six checked servers may slow down your Z39.50 search results, even if they are queried all together.</p>
20
<h2>Suggested Z39.50 Targets</h2>
21
22
<p>The following targets have been used successfully by other Koha libraries (in the Americas):</p>
23
24
<ul>
25
	<li>BIBLIOS z3950.biblios.net:210 bibliographic</li>
26
	<li>BIG COUNTRY KOHA bcls.kohalibrary.com:210 bcls_koha</li>
27
	<li>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC</li>
28
	<li>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</li>
29
	<li>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon</li>
30
	<li>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</li>
31
	<li>LIBRARY OF CONGRESS z3950.loc.gov:7090 Voyager</li>
32
	<li>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC</li>
33
	<li>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</li>
34
	<li>MILTON PL cat.mpl.on.ca:210 horizon</li>
35
	<li>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default</li>
36
	<li>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn</li>
37
	<li>TRI-UNI 129.97.129.194:7090 voyager</li>
38
	<li>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</li>
39
</ul>
14
40
15
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
41
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
16
- 

Return to bug 5940