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

(-)a/Makefile.PL (-1 lines)
Lines 308-314 my $target_map = { Link Here
308
  './course_reserves'           => 'INTRANET_CGI_DIR',
308
  './course_reserves'           => 'INTRANET_CGI_DIR',
309
  './docs/history.txt'          => { target => 'DOC_DIR', trimdir => -1 },
309
  './docs/history.txt'          => { target => 'DOC_DIR', trimdir => -1 },
310
  './offline_circ'              => 'INTRANET_CGI_DIR',
310
  './offline_circ'              => 'INTRANET_CGI_DIR',
311
  './edithelp.pl'               => 'INTRANET_CGI_DIR',
312
  './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
311
  './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
313
  './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
312
  './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
314
  './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
313
  './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
(-)a/edithelp.pl (-116 lines)
Lines 1-116 Link Here
1
#!/usr/bin/perl
2
3
# Copyright 2007 Liblime Ltd
4
#
5
# This file is part of Koha.
6
#
7
# Koha is free software; you can redistribute it and/or modify it
8
# under the terms of the GNU General Public License as published by
9
# the Free Software Foundation; either version 3 of the License, or
10
# (at your option) any later version.
11
#
12
# Koha is distributed in the hope that it will be useful, but
13
# WITHOUT ANY WARRANTY; without even the implied warranty of
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
# GNU General Public License for more details.
16
#
17
# You should have received a copy of the GNU General Public License
18
# along with Koha; if not, see <http://www.gnu.org/licenses>.
19
20
use Modern::Perl;
21
use C4::Output;
22
use C4::Templates;
23
use C4::Auth;
24
use CGI qw ( -utf8 );
25
26
use vars qw($debug);
27
28
BEGIN {
29
	$debug = $ENV{DEBUG} || 0;
30
}
31
32
our $input = new CGI;
33
34
my $type    = $input->param('type') || '';
35
my $referer = $input->param('referer') || '';
36
my $oldreferer = $referer;
37
my $help    = $input->param('help') || '';
38
# strip any DOS-newlines that TinyMCE may have sneaked in
39
$help =~ s/\r//g;
40
my $error;
41
42
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
43
    {
44
        template_name   => "help/edithelp.tt",
45
        query           => $input,
46
        type            => "intranet",
47
        authnotrequired => 0,
48
        flagsrequired   => {
49
            catalogue        => 1,
50
            circulate        => 1,
51
            parameters       => 1,
52
            borrowers        => 'edit_borrowers',
53
            permissions      => 1,
54
            reserveforothers => 1,
55
            reserveforself   => 1,
56
            editcatalogue    => 1,
57
            updatecharges    => 1,
58
        },
59
        debug => 1,
60
    }
61
);
62
63
sub _get_filepath ($;$) {
64
    my $referer = shift;
65
    $referer =~ /koha\/(.*)\.pl/;
66
    my $file = $1;
67
    $file =~ s/[^0-9a-zA-Z_\-\/]*//g;
68
    my $from = "help/$file.tt";
69
    my $htdocs = C4::Context->config('intrahtdocs');
70
    my ($theme, $lang, $availablethemes) = C4::Templates::themelanguage( $htdocs, $from, "intranet", $input );
71
	$debug and print STDERR "help filepath: $htdocs/$theme/$lang/modules/$from";
72
	return "$htdocs/$theme/$lang/modules/$from";
73
}
74
75
$type = 'create' if $type eq 'addnew';
76
if ( $type eq 'create' || $type eq 'save' ) {
77
	my $file = _get_filepath($referer);
78
    open my $fh, ">:encoding(utf-8)", $file;
79
    if ( $fh ) {
80
        # file is open write to it
81
        print $fh
82
            " [% INCLUDE 'help-top.inc' %]\n",
83
		    $type eq 'create' ? "<div class=\"main\">\n$help\n</div>" : $help,
84
            "\n[% INCLUDE 'help-bottom.inc' %]\n";
85
        close $fh;
86
		print $input->redirect("/cgi-bin/koha/help.pl?url=$oldreferer");
87
    }
88
    else {
89
        $error = "Cannot write file: '$file'";
90
    }
91
}
92
elsif ( $type eq 'modify' ) {
93
    # open file load data, kill include calls, pass data to the template
94
	my $file = _get_filepath($referer, 1);	# 2nd argument triggers themelanguage call
95
	if (! -r $file) {
96
		$error = "Cannot read file: '$file'.";
97
	} else {
98
		(-w $file) or $error = 
99
			"WARNING: You will not be able to save, because your webserver cannot write to '$file'. Contact your admin about help file permissions.";
100
        open (my $fh, '<:encoding(utf-8)', $file) or die "Cannot read file '$file'";    # unlikely death, since we just checked
101
        my $help = '';
102
        while ( <$fh> ) {
103
            $help .= /\[% INCLUDE .* %\](.*)$/ ? $1 : $_;
104
        }
105
        close $fh;
106
        $template->param( 'help' => $help );
107
		$type = 'save';
108
	}
109
}
110
111
$template->param(
112
    'referer' => $referer,
113
    'type'    => $type,
114
);
115
($error) and $template->param('error' => $error);
116
output_html_with_http_headers $input, "", $template->output;
(-)a/koha-tmpl/intranet-tmpl/prog/css/help.css (-5 lines)
Lines 1-5 Link Here
1
/* help.css For inclusion on help pages */
2
3
body#help {
4
	padding : 1em;
5
}
(-)a/koha-tmpl/intranet-tmpl/prog/en/includes/help-bottom.inc (-8 lines)
Lines 1-8 Link Here
1
<form action="/cgi-bin/koha/edithelp.pl" method="post">
2
  <fieldset class="action"><input type="button" class="close" value="Close help window" />
3
  <input type="hidden" name="type" value="modify" />
4
  <input type="hidden" name="referer" value="[% referer %]" />
5
  <input type="submit" class="submit" value="Edit help" /></fieldset>
6
</form>
7
</body>
8
</html>
(-)a/koha-tmpl/intranet-tmpl/prog/en/includes/help-top.inc (-21 lines)
Lines 1-21 Link Here
1
[% USE Asset %]
2
[% INCLUDE 'doc-head-open.inc' %]
3
<title>Online help</title>
4
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5
<link rel="shortcut icon" href="[% IF ( IntranetFavicon ) %][% IntranetFavicon %][% ELSE %][% interface %]/[% theme %]/img/favicon.ico[% END %]" type="image/x-icon" />
6
[% Asset.css("lib/jquery/jquery-ui-1.11.4.min.css") %]
7
[% Asset.css("css/print.css", { media = "print" }) %]
8
[% INCLUDE intranetstylesheet.inc %]
9
[% IF ( bidi ) %]
10
   [% Asset.css("css/right-to-left.css") %]
11
[% END %]
12
[% Asset.js("lib/jquery/jquery-2.2.3.min.js") %]
13
[% Asset.js("lib/jquery/jquery-migrate-1.3.0.min.js") %]
14
[% Asset.js("lib/jquery/jquery-ui-1.11.4.min.js") %]
15
[% Asset.js("lib/shortcut/shortcut.js") %]
16
<!-- koha core js -->
17
[% Asset.js("js/staff-global.js") %]
18
19
[% Asset.css("css/help.css") %]
20
</head>
21
<body id="help" class="help">
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/about.tt (-40 lines)
Lines 1-40 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>About Koha</h1>
4
5
<p>This section provides information about your Koha installation. It is useful for developers and if you wish to report bugs or issues to the Koha community.</p>
6
7
<h2>Server information</h2>
8
9
<p>This section tells you which version of Koha and supporting software you are using. If possible, when reporting issues to the Koha community, always give details of which version of Koha you are using. Koha is under active development and it is highly likely that an upgrade to a more recent version will provide patches and bug fixes you require.</p>
10
11
<h2>Perl modules</h2>
12
13
<p>This tab lists all the dependent Perl modules for Koha and whether or not you have them installed, and the version number. If you are reporting an issue, the developer may ask what is the state of the Perl modules you have installed.</p>
14
<p>Note that the version number between parentheses following the module name is the required version; the installed version is in the next column.</p>
15
16
<h2>System information</h2>
17
18
<p>This tab will provide you with warnings if you are using system preferences that have since been deprecated or system preferences that you have set without other required preferences.</p>
19
20
<h2>Koha team</h2>
21
22
<p>Koha is developed and supported by a large number of developers around the world. Thanks to all the developers and libraries who support Koha</p>
23
24
<h2>Licenses</h2>
25
26
<p>Koha is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.</p>
27
28
<p>This tab shows the information related to any and all licenses associated with Koha.</p>
29
30
<h2>Translations</h2>
31
32
<p>This tab lists all of the languages that Koha has been translated to.</p>
33
34
<h2>Timeline</h2>
35
36
<p>This tab provides a summary of Koha's release and development history.</p>
37
38
<p><strong>See the full documentation for the About page in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/plugins.html#about-koha">manual</a> (online).</strong></p>
39
40
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/acqui-home.tt (-15 lines)
Lines 1-15 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Acquisitions</h1>
4
5
<p>The Koha Acquisitions module provides a way for the library to record orders placed with vendors and manage purchase budgets.</p>
6
7
<p>You do not need to use Acquisitions to add items to your catalog. Acquisitions is used only to track vendors and spending against your budgets.</p>
8
9
<p>Before using the Acquisitions Module, you will want to make sure that you have completed all of the set up.</p>
10
11
<p>First, set your Acquisitions System Preferences and Acquisitions Administration to match your library's workflow.</p>
12
13
<p><strong>See the full documentation for Acquisitions in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html">manual</a> (online).</strong></p>
14
15
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/addorderiso2709.tt (-24 lines)
Lines 1-24 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Order from a Staged File</h1>
4
5
<ul>
6
    <li>From the list of files you are presented with, choose the 'Add orders' link.
7
<ul>
8
    <li>From the list of records, click 'Add order' next to the item that you want to add to your order.
9
<ul>
10
    <li>From the order form, you will not be able to edit the catalog details.</li>
11
</ul>
12
</li>
13
</ul>
14
</li>
15
    <li>The other option is to import all records from the staged file by scrolling below the list of records in the staged file and filling in the item information.
16
<ul>
17
    <li>If you choose this option the Koha will look in the 020$c and grab the pricing information from that field and put that on each order line.</li>
18
</ul>
19
</li>
20
</ul>
21
22
<p><strong>See the full documentation for Ordering in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
23
24
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/basket.tt (-124 lines)
Lines 1-124 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h2>Placing an Order</h2>
4
5
<p>Once your basket is created you are presented with several options for adding items to the order.</p>
6
7
<ul>
8
    <li>If you are ordering another copy of an existing item, you can simply search for the record in your system.
9
<ul>
10
    <li>From the results, simply click 'Order' to be brought to the order form.
11
<ul>
12
    <li>All of the details associated with the item will already be listed under 'Catalog details.'</li>
13
</ul>
14
</li>
15
</ul>
16
</li>
17
    <li>If you allow patrons to make purchase suggestions (learn more in the Managing Suggestions section of this manual), then you can place orders from those suggestions.</li>
18
    <li>From the results, click 'Order' next to the item you want to order and you will be presented with the order form including a link to the suggestion
19
<ul>
20
    <li>From this form you can make changes to the Catalog Details if necessary.</li>
21
    <li>When the item appears in your basket it will include a link to the suggestion.</li>
22
</ul>
23
</li>
24
<li>If you're using the Serials module you can link your subscription order information to acquisitions by choosing to order 'From a subscription'
25
<ul>
26
    <li>After clicking the order link you will be brought to a search page that will help you find your subscription</li>
27
    <li>Your results will appear to the right of the form and each subscription will have an 'Order' link to the right</li>
28
    <li>Clicking 'Order' will bring the subscription info in to the order form without an 'Add item' section since you are just ordering a subscription and an item isn't needed</li>
29
</ul></li>
30
    <li>To order from a record that can't be found anywhere else, choose the 'From a new (empty) record.'
31
<ul>
32
    <li>You will be presented with an empty form to fill in all of the necessary details about the item you are ordering.</li>
33
</ul>
34
</li>
35
    <li>If you want to search other libraries for an item to purchase, you can use the 'From an external source' option that will allow you to order from a MARC record found via a Z39.50 search.
36
<ul>
37
    <li>From the results, click the Order link next to the item you want to purchase.</li>
38
    <li>If the item you're ordering from an external source looks like it might be a duplicate, Koha will warn you and give you options on how to proceed.
39
<ul>
40
    <li>From the warning, you can choose to order another copy on the existing bib record, create a new bib record, or cancel your order of this item.</li>
41
</ul>
42
</li>
43
    <li>In the order form that pops up, you will not be able to edit the catalog details.</li>
44
</ul>
45
</li>
46
    <li>The next option for ordering is to order from a staged record.
47
<ul>
48
    <li>From the list of files you are presented with, choose the 'Add orders' link to add the records in the staged file to your order.</li>
49
    <li>Next to each title is a checkbox, check the items you would like to order, or choose 'Check all' at the top. Depending on your settings in the MarcFieldsToOrder preference Koha will populate the next screen with with the relevant Quantity, Price, Fund, Statistic 1, and Statistic 2 found within the staged file.</li>
50
    <li>In the 'Item Information' tab you can enter information that will be added to every ordered item such as item type, collection code and not for loan status.</li>
51
    <li>If no information is imported from the MARC record regarding fund information the 'Default accounting details' tab can be used to apply values related to the accounting.</li>
52
</ul>
53
</li>
54
    <li>The final option for ordering is to order from a list of titles with the highest hold ratios
55
<ul>
56
    <li>This option will take you to the Holds Ratio report where you can find items with a high hold ratio and order additional copies. Next to each title will be a link with the number of items to order, click that and it will add the item to your basket.</li>
57
</ul>
58
</li>
59
</ul>
60
61
<p>With any of the above ordering options you're presented with an option to notify patrons of the new item when it's received. The contents of that notification can be edited in the Notices & Slips tool and will have the code of ACQ_NOTIF_ON_RECEIV. In the 'Patrons' section you will see an option to 'Add user'. Click that button to add patrons who will be notified of the new issue.</p>
62
63
<ul>
64
    <li>In the window that pops up search for the patrons you'd like to notify and click 'Select'</li>
65
    <li>Once you're done you can close the window and you'll see the list of patrons under the 'Patrons' section</li>
66
</ul>
67
68
<p>After bringing in the bib information (for all import methods except for the staged file), if your AcqCreateItem system preference is set to add an item when ordering you will enter the item info next. You need to fill out at least one item record and then click the 'Add' button at the bottom left of the item form.</p>
69
70
<p>After clicking add the item will appear above the form and then you can enter your next item the same way (if ordering more than one item).</p>
71
72
<p>Once you have entered the info about the item, you need to enter the Accounting information.</p>
73
74
<ul>
75
    <li>Quantity is populated by the number of items you've added to the order above.</li>
76
    <li>The list of funds is populated by the funds you have assigned in the Acquisitions Administration area.</li>
77
    <li>The currency pull down will have the currencies you set up in the Acquisitions Administration area.</li>
78
    <li>The vendor price is the price before any taxes or discounts are applied.</li>
79
    <li>If the price is uncertain, check the uncertain price box.
80
<ul>
81
    <li>A basket with at least one uncertain price can't be closed.</li>
82
</ul>
83
</li>
84
    <li>If you are charged sales tax, choose that from the tax_rate field</li>
85
    <li>Enter the percentage discount you're receiving on this order, once you enter this, hit tab and Koha will populate the rest of the cost fields below.</li>
86
    <li>If you added Planning Values when creating the Fund, those values will appear in the two Planning Value fields.</li>
87
</ul>
88
89
<p>Once an item is added to the basket you will be presented with a basket summary.</p>
90
91
<p>If you would like to see more details you can check the 'Show all details' checkbox.</p>
92
93
<p>From here, you can edit or remove the items that you have added.</p>
94
95
<ul>
96
    <li>Choosing to 'Delete the order' will delete the order line but leave the record in the catalog.</li>
97
    <li>Choosing to 'Delete order and catalog record' removes both the order line and the record in the catalog.
98
<ul>
99
    <li>The catalog record cannot always be deleted. You might see notes explaining why.</li>
100
</ul>
101
</li>
102
</ul>
103
104
<p>On the summary page, you also have the option to edit the information that you entered about the basket by clicking the 'Edit basket header information' button, to delete the basket altogether by clicking the 'Delete this basket' button, or to export your basket as a CSV file by clicking the 'Export this basket as CSV' button.</p>
105
106
<p>Once you're sure your basket is complete, you can click 'Close this basket' button to indicate that this basket is complete and has been sent to the vendor.</p>
107
108
<p style="color: #ff0000">Important: A basket with at least one item marked as 'uncertain price' will not be able to be closed</p>
109
110
<p>Clicking the 'Uncertain Prices' button will call up a list of items with uncertain prices to quick editing.</p>
111
112
<p style="color: #ff0000">Important: The Uncertain Prices page is independent of the basket. It is linked to the vendor so you will see all items on order with uncertain prices for that vendor.</p>
113
114
<h2>Printing Baskets</h2>
115
116
<p>When you are finished adding items to your basket, click 'Close this Basket.' You will be asked if you want to create a purchase order at this time.</p>
117
118
<p>Your completed order will be listed on the Basket Grouping page for printing or further modification.</p>
119
120
<p>Clicking 'Print' below your order will generate a PDF for printing, which will have all of your library information followed by the items in your order.</p>
121
122
<p><strong>See the full documentation for Ordering in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
123
124
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/basketgroup.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Basket Groups</h1>
4
5
<p>A basket group is a group of closed baskets that you can perform actions on.</p>
6
7
<h2>Create a basket group</h2>
8
9
<p>A basket group is simply a group of baskets. In some libraries, you have several staff members who create baskets, and, at the end of a period of time, someone then groups them together to send to the vendor in bulk. That said, it is possible to have one basket in a basket group if that's the workflow used in your library.</p>
10
11
<p><strong>See the full documentation for Basket Groups in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket-group">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/basketheader.tt (-23 lines)
Lines 1-23 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h2>Adding a Basket</h2>
4
5
<p>When adding a basket you want to give it a name that will help you identify it later</p>
6
7
<p>Enter in the Billing Place and Delivery Place (this will default the library you're logged in at)</p>
8
9
<p>If you would like to change the vendor you're ordering from you can use the Vendor pull down menu</p>
10
11
<p>The notes fields are optional and can contain any type of information</p>
12
13
<p>If you have added contracts to the vendor you're ordering from, you will also have an option to choose which contract you're ordering these items under.</p>
14
15
<p>When finished, click 'Save'
16
17
<h2>Editing Basket Headers</h2>
18
19
<p>After creating your basket, you can edit the name of the basket, the billing place, delivery place, the notes and the contract you're ordering against.</p>
20
21
<p><strong>See the full documentation for Ordering in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
22
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/booksellers.tt (-19 lines)
Lines 1-19 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Acquisitions Searching</h1>
4
5
<p>At the top of the various Acquisition pages there is a quick search box where you can perform either a Vendor Search or an Order Search.</p>
6
7
<p>In the Vendor Search you can enter any part of the vendor name to get results.</p>
8
9
<p>Using the Orders Search you can search for items that have been ordered with or without the vendor.</p>
10
11
<p>You can enter info in one or both fields and you can enter any part of the title and/or vendor name.</p>
12
13
<p>Clicking the plus sign to the right of the Vendor search box will expand the search and allow you to search for additional fields.</p>
14
15
<p>Clicking Advanced Search to the right of the search button will give you all of the order search options available.</p>
16
17
<p><strong>See the full documentation for Acquisitions Searching in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#acquisition-searches">manual</a> (online).</strong></p>
18
	
19
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/edifactmsgs.tt (-9 lines)
Lines 1-9 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>EDIFACT messages</h1>
4
5
<p>A log of all messages sent and received via EDIFACT can be found under EDIFACT Messages.</p>
6
7
<p><strong>See the full documentation for EDIFACT messages in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#edifact-messages">manual</a> (online).</strong></p>
8
9
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/histsearch.tt (-19 lines)
Lines 1-19 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Acquisitions Searching</h1>
4
5
<p>At the top of the various Acquisition pages there is a quick search box where you can perform either a Vendor Search or an Order Search.</p>
6
7
<p>In the Vendor Search you can enter any part of the vendor name to get results.</p>
8
9
<p>Using the Orders Search you can search for items that have been ordered with or without the vendor.</p>
10
11
<p>You can enter info in one or both fields and you can enter any part of the title and/or vendor name.</p>
12
13
<p>Clicking the plus sign to the right of the Vendor search box will expand the search and allow you to search for additional fields.</p>
14
15
<p>Clicking Advanced Search to the right of the search button will give you all of the order search options available.</p>
16
17
<p><strong>See the full documentation for Acquisitions Searching in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#acquisition-searches">manual</a> (online).</strong></p>
18
	
19
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/invoice.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Invoices</h1>
4
5
<p>When orders are received invoices are generated. Invoices can be searched by clicking on 'Invoices' in the left of the Acquisitions page.</p>
6
7
<p>After searching, your results will appear to the right of the search options.</p>
8
9
<p>From the results you can click the 'Details' link to see the full invoice or 'Close' to note that the invoice is closed/paid for.</p>
10
11
<p><strong>See the full documentation for Invoices in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#invoices">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/invoices.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Invoices</h1>
4
5
<p>When orders are received invoices are generated. Invoices can be searched by clicking on 'Invoices' in the left of the Acquisitions page.</p>
6
7
<p>After searching, your results will appear to the right of the search options.</p>
8
9
<p>From the results you can click the 'Details' link to see the full invoice or 'Close' to note that the invoice is closed/paid for.</p>
10
11
<p><strong>See the full documentation for Invoices in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#invoices">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/lateorders.tt (-21 lines)
Lines 1-21 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Claims &amp; Late Orders</h1>
4
5
<p>If you have entered an email address for the vendors in your system, you can send them claim emails when an order is late. Before you can send claims, you will need to set up an acquisitions claim notice.</p>
6
7
<p>Upon clicking the link to 'Late Orders' from the Acquisitions page, you will be presented with a series of filter options on the left hand side. These filters will be applied only to closed baskets.</p>
8
9
<p><strong>Note:</strong> The vendor pull down only shows vendors with closed baskets that are late.</p>
10
11
<p>Once you filter your orders to show you the things you consider to be late, you will be presented with a list of these items.</p>
12
13
<p>To the right of each late title you will be see a checkbox. Check the ones that you want a claim letter sent to and click 'Claim Order' at the bottom right of the list. This will automatically send an email to the vendor at the email address you have on file.</p>
14
15
<p><strong>Note:</strong> The Estimated Delivery Date is based on the Delivery time value entered on the vendor record.</p>
16
17
<p>There is a default acquisitions claim letter. If you would rather use a different one, you can create that in the notices module and choose it from the menu above the list of late items.</p>
18
19
<p><strong>See the full documentation for Claims and Late Orders in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#claims-late-orders">manual</a> (online).</strong></p>
20
21
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/neworderbiblio.tt (-14 lines)
Lines 1-14 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Order from an Existing Record</h1>
4
5
<p>If you are ordering another copy of an existing item, you can simply search for the record in your system.</p>
6
7
<ul>
8
    <li>From the results, simply click 'Order' to be brought to the order form.</li>
9
	<li>All of the details associated with the item will already be listed under 'Catalog details'</li>
10
</ul>
11
12
<p><strong>See the full documentation for Ordering in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
13
14
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/neworderempty.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Order from a New Empty Record</h1>
4
5
<p>To order from a record that can't be found anywhere else, choose the 'From a new (empty) record.'</p>
6
7
<ul>
8
    <li>You will be presented with an empty form to fill in all of the necessary details about the item.</li>
9
</ul>
10
11
<p><strong>See the full documentation for Ordering in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/newordersubscription.tt (-17 lines)
Lines 1-17 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Order from a subscription</h1>
4
5
<p>To order from a record that can't be found anywhere else, choose the 'From a new (empty) record.'</p>
6
7
<p>If you're using the Serials module you can link your subscription order information to acquisitions by choosing to order 'From a subscription'</p>
8
9
<ul>
10
    <li>After clicking the order link you will be brought to a search page that will help you find your subscription</li>
11
    <li>Your results will appear to the right of the form and each subscription will have an 'Order' link to the right</li>
12
    <li>Clicking 'Order' will bring the subscription info in to the order form without an 'Add item' section since you are just ordering a subscription and an item isn't needed</li>
13
</ul>
14
15
<p><strong>See the full documentation for Ordering in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
16
17
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/newordersuggestion.tt (-19 lines)
Lines 1-19 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Order from Purchase Suggestion</h1>
4
5
<p>If you allow patrons to make purchase suggestions (learn more in the Managing Suggestions section of this manual), then you can place orders from those suggestions. In order to keep track of suggestions that have been ordered and received you must place the order using this link.</p>
6
7
<ul>
8
    <li>From the results, click 'Order' next to the item you want to order and you will be presented with the order form including a link to the suggestion
9
<ul>
10
        <li>From this form you can make changes to the Catalog Details if necessary.</li>
11
        <li>When the item appears in your basket it will include a link to the suggestion.</li>
12
</ul>
13
</li>
14
    <li>Orders added to the basket in this way will notify the patron via email that their suggestion has been ordered and will update the patron's 'My purchase suggestions' page in the OPAC.</li>
15
</ul>
16
17
<p><strong>See the full documentation for Ordering in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
18
19
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/orderreceive.tt (-23 lines)
Lines 1-23 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Receiving Orders</h1>
4
5
<p>Orders can be received from the vendor information page or the vendor search results page.</p>
6
7
<p>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a shipment received date, a shipping cost and a budget to subtract that shipping amount from.</p>
8
9
<p>The receive page will list all items still on order with the vendor regardless of the basket the item is from.</p>
10
11
<p>To receive a specific item, click the 'Receive' link to the right of the item.</p>
12
13
<p>From this form you can alter the cost information. You can also choose to mark only part of the order as received if the vendor didn't send your entire order by checking only the boxes next to the items on the left that you want to receive. The values you enter in the 'Replacement cost' and 'Actual cost' will automatically populate the item record by filling in subfield v (Cost, replacement price) and subfield g (Cost, normal purchase price) on the item record after saving.</p>
14
15
<p>You can also make edits to the item record from this form by clicking the 'Edit' link next to each item. This will allow you to enter in accurate call numbers and barcodes if you'd like to do that at the point of receipt. Once you have made any changes necessary (to the order and/or items, click 'Save' to mark the item(s) as received.</p>
16
17
<p>When you're finished receiving items you can navigate away from this page or click the 'Finish receiving' button at the bottom of the screen.</p>
18
19
<p>You will also see that the item is received and/or cancelled if you view the basket.</p>
20
21
<p><strong>See the full documentation for Receiving Orders in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#receiving-orders">manual</a> (online).</strong></p>
22
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/parcel.tt (-23 lines)
Lines 1-23 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Receiving Orders</h1>
4
5
<p>Orders can be received from the vendor information page or the vendor search results page.</p>
6
7
<p>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a shipment received date, a shipping cost and a budget to subtract that shipping amount from.</p>
8
9
<p>The receive page will list all items still on order with the vendor regardless of the basket the item is from.</p>
10
11
<p>To receive a specific item, click the 'Receive' link to the right of the item.</p>
12
13
<p>From this form you can alter the cost information. You can also choose to mark only part of the order as received if the vendor didn't send your entire order by checking only the boxes next to the items on the left that you want to receive. The values you enter in the 'Replacement cost' and 'Actual cost' will automatically populate the item record by filling in subfield v (Cost, replacement price) and subfield g (Cost, normal purchase price) on the item record after saving.</p>
14
15
<p>You can also make edits to the item record from this form by clicking the 'Edit' link next to each item. This will allow you to enter in accurate call numbers and barcodes if you'd like to do that at the point of receipt. Once you have made any changes necessary (to the order and/or items, click 'Save' to mark the item(s) as received.</p>
16
17
<p>When you're finished receiving items you can navigate away from this page or click the 'Finish receiving' button at the bottom of the screen.</p>
18
19
<p>You will also see that the item is received and/or cancelled if you view the basket.</p>
20
21
<p><strong>See the full documentation for Receiving Orders in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#receiving-orders">manual</a> (online).</strong></p>
22
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/parcels.tt (-23 lines)
Lines 1-23 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Receiving Orders</h1>
4
5
<p>Orders can be received from the vendor information page or the vendor search results page.</p>
6
7
<p>After clicking 'Receive shipment' you will be asked to enter a vendor invoice number, a shipment received date, a shipping cost and a budget to subtract that shipping amount from.</p>
8
9
<p>The receive page will list all items still on order with the vendor regardless of the basket the item is from.</p>
10
11
<p>To receive a specific item, click the 'Receive' link to the right of the item.</p>
12
13
<p>From this form you can alter the cost information. You can also choose to mark only part of the order as received if the vendor didn't send your entire order by checking only the boxes next to the items on the left that you want to receive. The values you enter in the 'Replacement cost' and 'Actual cost' will automatically populate the item record by filling in subfield v (Cost, replacement price) and subfield g (Cost, normal purchase price) on the item record after saving.</p>
14
15
<p>You can also make edits to the item record from this form by clicking the 'Edit' link next to each item. This will allow you to enter in accurate call numbers and barcodes if you'd like to do that at the point of receipt. Once you have made any changes necessary (to the order and/or items, click 'Save' to mark the item(s) as received.</p>
16
17
<p>When you're finished receiving items you can navigate away from this page or click the 'Finish receiving' button at the bottom of the screen.</p>
18
19
<p>You will also see that the item is received and/or cancelled if you view the basket.</p>
20
21
<p><strong>See the full documentation for Receiving Orders in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#receiving-orders">manual</a> (online).</strong></p>
22
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/supplier.tt (-56 lines)
Lines 1-56 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Vendors</h1>
4
5
<p>Before any orders can be placed, you must first enter at least one vendor.</p>
6
7
<h2>Add a Vendor</h2>
8
9
<p>To add a vendor, click the 'New Vendor' button on the Acquisitions page.</p>
10
11
<p>The vendor add form is broken into three pieces:</p>
12
13
<ul>
14
    <li>The first section is for basic information about the vendor.
15
<ul>
16
    <li>Of these fields, only the vendor name is required. The rest of the information should be added to help with generating claim letters and invoices.</li>
17
</ul>
18
</li>
19
    <li>The second section is for information regarding your contact at the Vendor's office.
20
<ul>
21
    <li>None of these fields are required. They should only be entered if you want to keep track of your contact information within Koha.</li>
22
</ul>
23
</li>
24
    <li>The final section is for billing information:
25
<ul>
26
    <li>To be able to order from a vendor, you must make them 'Active.'</li>
27
    <li>For List Prices and Invoice Prices, choose the currency.
28
<ul>
29
    <li>Currencies are assigned in the Currencies &amp; Exchange Rates admin area.</li>
30
</ul>
31
</li>
32
    <li>If your library is charged tax, mark your Tax Number as registered.</li>
33
    <li>Note: if you list prices and/or invoice prices, include tax.</li>
34
    <li>If the vendor offers a consistent blank discount, enter that in the 'Discount' field.
35
<ul>
36
	<li>You can enter item specific discounts when placing an order</li>
37
</ul>
38
</li>
39
    <li>Enter your tax rate if your library is charged taxes on orders.</li>
40
    <li>If you know how long it usually takes orders to arrive from this vendor, you can enter a delivery time. This will allow Koha to estimate when orders will arrive at your library on the late orders report.</li>
41
    <li>Notes are for internal use.</li>
42
</ul>
43
</li>
44
</ul>
45
46
<h2>View/Edit a Vendor</h2>
47
48
<p>To view a vendor's information page, you must search for the vendor from the Acquisitions home page. Your search can be for any part of the vendor's name. From the results, click on the name of the vendor you want to view or edit.</p>
49
50
<p>To make changes to the vendor, simply click the 'Edit' button.</p>
51
52
<p>If the vendor has no baskets attached to it, a 'Delete' button will also be visible, allowing the vendor to be deleted.</p>
53
54
<p><strong>See the full documentation for managing Vendors in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#vendors">manual</a> (online).</strong></p>
55
56
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/uncertainprice.tt (-9 lines)
Lines 1-9 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Uncertain prices</h1>
4
5
<p>The Uncertain Prices page is independent of the basket. It is linked to the vendor so you will see all items on order with uncertain prices for that vendor.</p>
6
7
<p><strong>See the full documentation for Uncertain prices in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
8
9
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/z3950_search.tt (-19 lines)
Lines 1-19 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Order from an External Source</h1>
4
5
<p>If you want to search other libraries for an item to purchase, use the 'From an external source' option, which will allow you to order from a MARC record found via a Z39.50 search.</p>
6
7
<ul>
8
    <li>From the results, click the Order link next to the item you want to purchase.</li>
9
    <li>If the item you're ordering from an external source looks like it might be a duplicate, Koha will warn you and give you options for how to proceed.
10
<ul>
11
    <li>From the warning, you can choose to order another copy on the existing bib record, create a new bib record, or cancel your order of this item.</li>
12
</ul>
13
</li>
14
    <li>In the order form that pops up, you will not be able to edit the catalog details</li>
15
</ul>
16
17
<p><strong>See the full documentation for Ordering in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#create-a-basket">manual</a> (online).</strong></p>
18
19
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/admin-home.tt (-35 lines)
Lines 1-35 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Administration Help</h1>
4
5
<p>The administration area is where you set all of your preferences for the system. Preference are broken down into several categories, detailed below.</p>
6
7
<h3>Global System Preferences</h3>
8
9
<p>Koha has an extensive set of system preferences. The system preferences control all the various features within Koha, whether they are active in your install or not. System preferences are set at install and are generally not changed afterwards.</p>
10
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
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>
14
15
<h3>Basic Parameters</h3>
16
17
<p>"Basic Parameters" is where library policies are set and governed. It is best to set your system preferences and then work through the basic parameters in the order that they appear on this page.</p>
18
19
<p>Please note that it is not required to set all the basic parameters. For example, if you do not plan to use acquisitions, then 'Funds,' 'Budgets,' and 'Currencies and Exchange Rates' can be ignored.</p>
20
21
<h3>Patrons and Circulation</h3>
22
23
<p>These parameters help control patron records and circulation rules. It is best to set the basic parameters before visiting this section.</p>
24
25
<h3>Catalog</h3>
26
27
<p>Catalog parameters assist in configuring the cataloging functionality within Koha.</p>
28
29
<h3>Additional Parameters</h3>
30
31
<p>This list of parameters includes functionalities that didn't fit in any other category.  These items are optional and may not need to be altered, depending on your library's needs.</p>
32
33
<p><strong>See the full documentation for system Administration in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html">manual</a> (online).</strong></p>
34
35
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgetperiods.tt (-88 lines)
Lines 1-88 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Budgets</h1>
4
5
<p>Budgets are used for tracking accounting values related to acquisitions. For example you could create a Budget for the current year (ex. 2015) and then break that into Funds for different areas of the library (ex. Books, Audio, etc).</p>
6
7
<p>When visiting the main budget administration you will see two tabs, one for active and one for inactive budgets.</p>
8
9
<h2>Adding a budget</h2>
10
11
<p>Budgets can either be created from scratch, by duplicating the previous year's budget or by closing a previous year's budget.</p>
12
13
<h3>Adding a new budget</h3>
14
15
<p>If you haven't used Koha before for acquisitions then you'll need to start fresh with a new budget. To add a new budget click the 'New Budget' button.</p>
16
17
<ul>
18
    <li>Choose the time period this budget is for, whether it's an academic year, a fiscal year, a quarter, etc.</li>
19
20
    <li>The Description should be something that will help you identify the budget when ordering</li>
21
22
    <li>In the amount box do not use any symbols, simply enter the amount of the budget with numbers and decimals.</li>
23
24
    <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>
25
26
    <li>Locking a budget means that Funds will not be able to be modified by librarians</li>
27
</ul>
28
29
<p>Once you have made your edits, click the 'Save Changes' button. You will be brought to a list of your existing budgets.</p>
30
31
<h3>Duplicating a budget</h3>
32
33
<p>To duplicate a budget from a previous year, click on the link for the budget name from the list of budgets</p>
34
35
<p>On the screen listing the budget breakdown click the Edit button at the top and choose to Duplicate budget</p>
36
37
<p>You can also click the 'Actions' button to the right of the budget and choose 'Duplicate'.</p>
38
39
<p>In both cases you will be presented with a form where you simply need to enter the new start and end date and save the budget.</p>
40
41
<p>
42
    If you want the amounts of budget and funds to be modified by a percentage,
43
    fill the text field for 'Change amounts by'. This should be a number,
44
    positive or negative. Decimal point can be used.
45
</p>
46
47
<p>
48
    If you decided to change the amounts of budget and funds, you can also
49
    choose how to round the result by filling the text field for 'If amounts
50
    changed, round to a multiple of'. This should be a positive number. Decimal
51
    point can be used.
52
</p>
53
54
<p>
55
    Example: If you duplicate a budget which have an amount of 999, and decide
56
    to change amount by 2.6% (1024.974) and to round to a multiple of 0.5, the
57
    result will be 1024.5 (amounts are rounded down).
58
</p>
59
60
<p>Check the box for 'Mark the original budget as inactive' if the original budget should no longer be used.</p>
61
62
<p>Check the box for 'Set all funds to zero' if you wish the new budget to contain all the same fund structures as the previous budget but no allocations until you manually enter an amount in the fund.</p>
63
64
<p>This will not only duplicate your budget, but all of the funds associated with that budget so that you can reuse budgets and funds from year to year and so that you can move unreceived orders and if desired unspent funds from a previous budget to the new budget.</p>
65
66
<h3>Close a budget</h3>
67
68
<p>Close a budget to move or roll over unreceived orders and if desired unspent funds from a previous budget to a new budget. Before closing your budget you might want to duplicate the previous year's budget so that you have somewhere for the unreceived orders to roll to.</p>
69
70
<p>Find the previous budget with unreceived orders on the Active budgets or the Inactive budgets tab and select 'Close' under 'Actions'.</p>
71
72
<p style="background-color: #ffe599;">Tip: In order for the unreceived orders to be automatically moved to the new budget, the fund structures in the previous budget must exist in the new budget. Budgets without unreceived orders cannot be closed.</p>
73
74
<p>When you select 'Close' you will be presented with a form.</p>
75
76
<p>Use the 'Select a budget' drop down to choose the new budget for the unreceived orders.</p>
77
78
<p>Check the box for 'Move remaining unspent funds' to move the unspent amounts from the funds of the budget being closed to the selected budget.</p>
79
80
<p>Once you have made your choices, click the 'Move unreceived orders' button. You will be presented with a dialog box that says 'You have chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This action cannot be reversed. Do you wish to continue?' Budget X is the budget to be closed and Budget Y is the selected budget.</p>
81
82
<p>If everything seems correct click 'OK' and the unreceived orders and, if selected, unspent funds will be moved.</p>
83
84
<p>Wait until the 'Report after moving unreceived orders from budget X to Y' displays. This will list the order numbers which have been impacted (grouped by fund) and detail if the unreceived order was moved or if there was a problem. For example, if the new budget does not contain a fund with the same name as the previous budget, the order will not be moved.</p>
85
86
<p><strong>See the full documentation for Budgets in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#budgets">manual</a> (online).</strong></p>
87
88
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgets.tt (-42 lines)
Lines 1-42 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Funds</h1>
4
5
<p>Budgets are broken into funds.</p>
6
7
<h2>Add a Fund</h2>
8
9
<p>A fund is added to a budget.</p>
10
11
<p style="color: #990000;">Important: A budget must be defined before a fund can be created.</p>
12
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>
14
15
<p>In the form that appears you want to enter the basics about your fund.</p>
16
17
<p>The three first fields are required, the rest are optional</p>
18
19
<ul>
20
    <li>Fund Code is a unique identifier for your fund</li>
21
    <li>The Fund Name should be something that librarians will understand</li>
22
    <li>Amount should be entered with only numbers and decimals, no other characters</li>
23
    <li>Warning at (%) or Warning at (amount) can be filled in to make Koha warn you before you spend a certain percentage or amount of your budget. This will prevent you from overspending.</li>
24
    <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>
25
    <li>Choose which library will be using this fund</li>
26
    <li>You can restrict who can order from this fund by choosing either the 'owner', 'owner and users' or 'owner, users and library' from the 'Restrict access to' menu</li>
27
    <ul><li style="color: #990000;">Important: Without an owner, the access restriction will be ignored, be sure to enter an owner as well as choose a restriction</li></ul>
28
    <li>Notes are simply for any descriptive notes you might want to add so that librarians know when to use this fund</li>
29
    <li>Planning categories are used for statistical purposes. To learn more about planning categories, check out the Planning Category FAQ.</li>
30
</ul>
31
32
<p>When complete, click 'Submit' and you will be brought to a list of all of the funds for the budget.</p>
33
34
<p>To the right of each fund you will find the 'Actions' button under which you will find the 'Edit,' 'Delete,' and 'Add Child Fund' options.</p>
35
36
<p>A child fund simply a sub-fund of the fund listed. An example would be to have a fund for 'Fiction' and under that have a fund for 'New Releases' and a fund for 'Science Fiction.' It is an optional way to further organize your finances.</p>
37
38
<p>Funds with children will show with a small arrow to the left. Clicking that will show you the children funds.</p>
39
40
<p><strong>See the full documentation for Funds in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#funds">manual</a> (online).</strong></p>
41
42
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqcontract.tt (-21 lines)
Lines 1-21 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Vendor Contracts</h1>
4
5
<p>You can define contracts (with a start and end date) and attach them to a vendor. This is used so that at the end of the year you can see how much you spent on a specific contract with a vendor. In some places, contracts are set up with a minimum and maximum yearly amount.</p>
6
7
<h2>Add a Contract</h2>
8
9
<p>At the top of a Vendor Information Page, you will see a 'New Contract' button.</p>
10
11
<p>The contract form will ask for some very basic information about the contract.</p>
12
13
<p style="color: #ff0000">Important: You cannot enter a contract retrospectively. The end date must not be before today's date.</p>
14
15
<p>Once the contract is saved it will appear below the vendor information.</p>
16
17
<p>It will also be an option when creating a basket.</p>
18
19
<p><strong>See the full documentation for Vendor Contracts in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#vendor-contracts">manual</a> (online).</strong></p>
20
21
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqplan.tt (-17 lines)
Lines 1-17 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Budget Planning</h1>
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>
6
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 'hide' link to the right the dates. To add more columns you can click the 'Show a column' link found below the 'Fund Remaining' heading.</p>
10
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>
12
13
<p>Once your changes are made, click the 'Save' button. If you would like to export your data as a CSV file you can do so by entering a file name in the 'Output to a file named' field and clicking the 'Output' button.</p>
14
15
<p><strong>See the full documentation for Budget Planning in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#budget-planning">manual</a> (online).</strong></p>
16
17
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/audio_alerts.tt (-33 lines)
Lines 1-33 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Audio alerts</h1>
4
5
<p>This section of Koha lets you specify a given sound to play when a given jQuery selector is matched.</p>
6
7
<p><em>Note: Use system preference 'AudioAlerts' to enable/disable sounds.</em><p>
8
9
<h2>Adding a new alert</h2>
10
11
<p>To add a new alert:</p>
12
13
<ul>
14
    <li>Locate the "Add new alert" form.</li>
15
    <li>
16
        Enter a selector in the "selector" input, you can see documentation on jQuery selectors <a href="http://api.jquery.com/category/selectors/">here</a>.
17
        For example, if you use the selector "#circ_impossible" your selected sound will be triggered when a checkout for a patron is not possible (such as the barcode not being found).
18
    <li>Enter a sound to be played, you can either select a built-in Koha sound using the pulldown selector, or you can enter a full URL to a sound file on another server.</li>
19
    <li>At this point, you can preview your sound by clicking the "Play sound" button</li>
20
    <li>Click "Save alert" and your done!</li>
21
</ul>
22
23
<h2>Sound precedence</h2>
24
25
<p>Sounds will be played in order from top to bottom. That is, the first select that finds a match will have its sound played.</p>
26
27
<p>To change the precedence of a given alert, use the four arrows to move it up, down, or to the top or bottom of the list.</o>
28
29
<h2>Deleting alerts</h2>
30
31
<p>To delete one or more alerts, check the checkboxes for those alerts you wish to delete, then click the "Delete selected alerts" button and confirm you want to delete those alerts.
32
33
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/auth_subfields_structure.tt (-68 lines)
Lines 1-68 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>MARC Record Subfields</h1>
4
5
<p>'Frameworks' are made up of MARC fields and subfields. To make edits to most frameworks, you must edit the fields and subfields. Click 'Edit' (on the right of each subfield) to make changes to the text associated with the field.</p>
6
7
<ul>
8
     <li>Each field has a tag (the MARC tag).
9
<ul>
10
  <li>'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels.</li>
11
   <li>'Label for OPAC' is what will show on the MARC view in the OPAC.</li>
12
      <li>If you check 'Repeatable,' the field will have a plus sign next to it that will allow you to add multiples of that tag.</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>
14
        <li>'Authorized value' is where you chose an authorized value list from which your catalogers can select a value for this subfield. To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing.</li>
15
</ul>
16
</li>
17
 <li>From the list of subfields, you can click 'Delete' to the right of each to erase the subfield in question.</li>
18
    <li>To edit the subfields, click 'Edit Subfields'.</li>
19
        <li>For each subfield, you can set the following values:
20
<ul>
21
  <li>'Text for librarian' is what appears before the subfield in the librarian interface.</li>
22
  <li>'Text for OPAC' is what appears before the field in the OPAC.If left empty, the text for librarian is used instead</li>
23
    <li>If 'Repeatable' is checked, the field  will have a plus sign next to it in the MARC cataloging module which allows you to add multiples of that tag.</li>
24
      <li>'Mandatory' prevents the user from saving a record  unless there is a value assigned to the tag.</li>
25
      <li>'Managed in tab' defines the tab where the subfield is shown. All subfields of a given field must either be in the same tab or ignored. 'Ignore' means that the subfield is not managed.</li>
26
      <li>'Default value' defines what you want to appear in the field by default. This field will be editable, but it saves time if you use the same note over and over.</li>
27
       <li>'Hidden' allows you to select from nineteen possible visibility conditions, seventeen of which are implemented. They are the following:
28
<ul>
29
	<li>-9 =&gt; Future use</li>
30
	<li>-8 =&gt; Flag</li>
31
	<li>-7 =&gt; OPAC !Intranet !Editor Collapsed</li>
32
	<li>-6 =&gt; OPAC Intranet !Editor !Collapsed</li>
33
	<li>-5 =&gt; OPAC Intranet !Editor Collapsed</li>
34
	<li>-4 =&gt; OPAC !Intranet !Editor !Collapsed</li>
35
	<li>-3 =&gt; OPAC !Intranet Editor Collapsed</li>
36
	<li>-2 =&gt; OPAC !Intranet Editor !Collapsed</li>
37
	<li>-1 =&gt; OPAC Intranet Editor Collapsed</li>
38
	<li>0 =&gt; OPAC Intranet Editor !Collapsed</li>
39
	<li>1 =&gt; !OPAC Intranet Editor Collapsed</li>
40
	<li>2 =&gt; !OPAC !Intranet Editor !Collapsed</li>
41
	<li>3 =&gt; !OPAC !Intranet Editor Collapsed</li>
42
	<li>4 =&gt; !OPAC Intranet Editor !Collapsed</li>
43
	<li>5 =&gt; !OPAC !Intranet !Editor Collapsed</li>
44
	<li>6 =&gt; !OPAC Intranet !Editor !Collapsed</li>
45
	<li>7 =&gt; !OPAC Intranet !Editor Collapsed</li>
46
	<li>8 =&gt; !OPAC !Intranet !Editor !Collapsed</li>
47
	<li>9 =&gt; Future use</li>
48
</ul>
49
</ul>
50
<ul>
51
    <li>(! means 'not visible' or in the case of collapsed 'not collapsed')</li>
52
    <li>If 'Is a url' is checked, the subfield is a url and can be clicked</li>
53
    <li>'Authorized Value' allows the librarian to select an authorized value list from which catalogers must choose an option.</li>
54
</ul>
55
</li>
56
</ul>
57
<ul>
58
    <li>The 'Thesaurus' chooses the authority file to which the field should be linked.</li>
59
</ul>
60
<ul>
61
    <li>'Plugin' allows the librarian to choose a plugin to calculate or manage a subfield. Plugins can do almost anything. For example, in UNIMARC there are plugins for all 1xx fields that are coded fields. There are also two plugins (unimarc_plugin_210c and unimarc_plugin_225a) that can find the editor from an ISBN, as well as the collection list for the editor.</li>
62
</ul>
63
    <li>To save your changes, click the 'Save Changes' button at the top of the screen.</li>
64
</ul>
65
66
<p><strong>See the full documentation for Authorities in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#authority-types">manual</a> (online).</strong></p>
67
68
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/auth_tag_structure.tt (-24 lines)
Lines 1-24 Link Here
1
[% INCLUDE '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.This will open up a blank form for entering MARC field data.</p>
6
7
<p>Enter the information about your new tag:</p>
8
9
<ul>
10
  <li>The 'Tag' is the MARC field number.</li>
11
  <li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module.</li>
12
  <li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record.</li>
13
  <li>If this field can be repeated, check the 'Repeatable' box.</li>
14
  <li>If this field is mandatory, check the 'Mandatory' box.</li>
15
  <li>If you want this field to be a drop-down menu with limited possible answers, choose which 'Authorized value' list you want to use.</li>
16
</ul>
17
18
<p>When you're finished, click 'Save Changes' and you will be presented with your new field.</p>
19
20
<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>
21
22
<p><strong>See the full documentation for Authorities in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#authority-types">manual</a> (online).</strong></p>
23
24
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authorised_values.tt (-94 lines)
Lines 1-94 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Authorized Values</h1>
4
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
7
<h2>Existing Values</h2>
8
9
<p>Koha installs with pre-defined values that your library is likely to use, for instance, 'Lost.'</p>
10
11
<p>By default, this includes:</p>
12
13
<ul>
14
    <li>'Asort1,' for acquisitions statistical purposes.</li>
15
    <li>'Asort2,' used for acquisitions statistical purposes.</li>
16
    <li>'BOR_NOTES' is for values for custom patron notes that appear on the circulation screen and the OPAC.</li>
17
    <li>'Bsort1' is for patron statistical purposes.</li>
18
    <li>'Bsort2' is used for patron statistical purposes.</li>
19
    <li>'CART' is the shelving cart location, used by InProcessingToShelvingCart and ReturnToShelvingCart</li>
20
    <li>'CCODE' is for collection codes (appears when cataloging and working with items).</li>
21
    <li>'DAMAGED' is for descriptions of damaged items, and appears when cataloging and working with items.</li>
22
    <li>'HINGS_AS' is for General Holdings: Acquisition Status Designator, a data element that specifies the acquisition status for the unit at the time of the holdings report.</li>
23
    <li>'HINGS_C' is for General Holdings: Completeness Designator.</li>
24
    <li>'HINGS_PF' is for Physical Form Designators</li>
25
    <li>'HINGS_RD' is for General Holdings: Retention Designator, a data element that specifies the retention policy for the unit at the time of the holdings report.</li>
26
    <li>'HINGS_UT' is for General Holdings: Type of Unit Designator.</li>
27
    <li>'LOC' is for the shelving location and usually appears when adding or editing an item.</li>
28
    <li>'LOST' is for descriptions for items marked as lost. It appears when adding or editing an item. Values given to lost statuses should be numeric (not alphabetical) in order for statuses to appear properly.
29
<ul>
30
    <li style="color: #990000;">Important: Values given to lost statuses should be numeric and not alphabetical in order for statuses to appear properly</li>
31
</ul>
32
</li>
33
    <li>'MANUAL_INV' includes values for manual invoicing.</li>
34
    <li>'NOT_LOAN' is used to list reasons why a title is not for loan.</li>
35
    <li>'PROC' is for the location to be used for NewItemsDefaultLocation (change description as desired), also the location expected by InProcessingToShelvingCart.</li>
36
    <li>'REPORT_GROUP' provides a way to sort and filter your reports, the default values in this category include the Koha modules (Accounts, Acquisitions, Catalog, Circulation, Patrons)</li>
37
    <li>'REPORT_SUBGROUP' can be used to further sort and filter your reports. This category is empty by default. Values here need to include the authorized value code from REPORT_GROUP in the Description (OPAC) field to link the subgroup to the appropriate group.</li>
38
    <li>'RESTRICTED' is used for the restricted status of an item</li>
39
    <li>'ROADTYPE' is used forRoad types to be used in patron addresses</li>
40
    <li>'SUGGEST' is for a list of reasons to accept or reject patron suggestions. It appears when managing suggestions.</li>
41
    <li>'WITHDRAWN' is for a description of a withdrawn item. It appears when adding or editing an item.</li>
42
    <li>'YES_NO' is a generic authorized value field that can be used anywhere you need a simple yes/no pull down menu.</li>
43
</ul>
44
45
<h2>Add New Authorized Value Category</h2>
46
47
<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>
48
49
<ul>
50
    <li>Click 'New Category.'</li>
51
<ul>
52
	<li>Limit your Category to 10 characters (something short to make it clear what the category is for)
53
<ul>
54
	<li style="color: #990000;">Important: Category cannot have spaces or special characters other than underscores and hyphens in it.</li>
55
</ul>
56
</li>
57
	<li>When adding a new category you're asked to create at least one authorized value
58
<ul>
59
	<li>Enter a code for your Authorized Value into the 'Authorized value' field
60
<ul>
61
	<li style="color: #990000;">Important:  Authorized value is limited to 80 characters and cannot have spaces or special characters other than underscores and hyphens in it.</li>
62
</ul>
63
</li>
64
	<li>Use the Description field for the actual value that will be displayed. If you want something different to show in the OPAC, enter a 'Description (OPAC)'</li>
65
	<li>If you would like to limit this authorized value category to only specific libraries you can choose them from the 'Branches limitation' menu. To have it show for all libraries just choose 'All branches' at the top of the list.</li>
66
</ul>
67
</li>
68
	<li>Click 'Save'</li>
69
	<li>Your new category and value will appear on the list of Authorized Values</li>
70
</ul>
71
</ul>
72
73
<h2>Add New Authorized Value</h2>
74
75
<p>New authorized values can be added to any existing or new category. To add a value:</p>
76
77
<ul>
78
	<li>Click 'New authorized value for ...'</li>
79
<ul>
80
	<li>Enter a code for your Authorized Value into the 'Authorized value' field
81
<ul>
82
	<li style="color: #990000;">Important: Authorized value is limited to 80 characters and cannot have spaces or special characters other than underscores and hyphens in it.</li>
83
</ul>
84
</li>
85
	<li>Use the Description field for the actual value that will be displayed. If you want something different to show in the OPAC, enter a 'Description (OPAC)'</li>
86
	<li>If you would like to limit this authorized value category to only specific libraries you can choose them from the 'Branches limitation' menu. To have it show for all libraries just choose 'All branches' at the top of the list.</li>
87
	<li>Click 'Save'</li>
88
	<li>The new value will appear in the list along with existing values</li>
89
</ul>
90
</ul>
91
92
<p><strong>See the full documentation for Authorized Values in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#authorized-values">manual</a> (online).</strong></p>
93
94
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/authtypes.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Authority Types</h1>
4
5
<p>Authority Types are MARC Frameworks for Authority records. Therefore, the rules below refer to the bibliographic frameworks.</p>
6
7
<p>Koha comes with many of the necessary Authority frameworks already installed.</p>
8
9
<p><strong>See the full documentation for Authorities in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#authority-types">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/biblio_framework.tt (-202 lines)
Lines 1-202 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>MARC Bibliographic Frameworks</h1>
4
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
7
<p style="color: #990000;">Important: 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
<h3>Add New Framework</h3>
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
<h4>Edit Existing Frameworks</h4>
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>
36
37
<h4>Add subfields to Frameworks</h4>
38
39
<p>To add a field to a Framework click the 'New Tag' button at the top of the Framework definition</p>
40
41
<p>This will open up a blank form for entering MARC field data</p>
42
43
<p>Enter the information about your new tag:</p>
44
<ul>
45
   <li>The 'Tag' is the MARC field number</li>
46
   <li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module</li>
47
   <li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record</li>
48
   <li>If this field can be repeated, check the 'Repeatable' box</li>
49
   <li>If this field is mandatory, check the 'Mandatory' box</li>
50
   <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>
51
</ul>
52
53
<p>When you're finished, click 'Save Changes' and you will be presented with your new field</p>
54
55
<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. The process of entering the settings for the new subfield is the same as those found in the editing subfields in frameworks section of the manual.</p>
56
57
<h4>Edit Framework Subfields</h4>
58
59
<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>
60
61
<ul>
62
   <li>Each field has a tag (which is the MARC tag) that is uneditable
63
<ul>
64
   <li>The 'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels</li>
65
   <li>The 'Label for OPAC' is what will show on the MARC view in the OPAC</li>
66
   <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>
67
   <li>If you check 'Mandatory' the record will not be allowed to save unless you have a value assigned to this tag</li>
68
   <li>'Authorized value' is where you define an authorized value that your catalogers can choose from a pull down to fill this field in</li>
69
</ul>
70
</li>
71
</ul>
72
73
<p>To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing</p>
74
75
<ul>
76
   <li>From the list of subfields you can click 'Delete' to the right of each to delete the subfields</li>
77
   <li>To edit the subfields click 'Edit Subfields'</li>
78
   <li>For each subfield you can set the following Basic constraint values
79
<ul>
80
   <li>Text for librarian
81
<ul>
82
   <li>what appears before the subfield in the librarian interface</li>
83
</ul>
84
</li>
85
   <li>Text for OPAC
86
<ul>
87
   <li>what appears before the field in the OPAC.
88
<ul>
89
   <li>If left empty, the text for librarian is used instead</li>
90
</ul>
91
</li>
92
</ul>
93
</li>
94
   <li>Repeatable
95
<ul>
96
   <li>the field will have a plus sign next to it allowing you to add multiples of that tag</li>
97
</ul>
98
</li>
99
   <li>Mandatory
100
<ul>
101
   <li>the record will not be allowed to save unless you have a value assigned to this tag</li>
102
</ul>
103
</li>
104
   <li>Managed in tab
105
<ul>
106
   <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>
107
</ul>
108
</li>
109
</ul>
110
</li>
111
   <li>For each subfield you can set the following Advanced constraint values
112
<ul>
113
   <li>Default value
114
<ul>
115
   <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>
116
</ul>
117
</li>
118
   <li>Visibility
119
<ul>
120
   <li>allows you to select from where this subfield is visible/hidden, simply check the boxes where you would like the field to show and uncheck the boxes where you would like it hidden.</li>
121
</ul>
122
</li>
123
   <li>Is a URL
124
<ul>
125
   <li>if checked, it means that the subfield is a URL and can be clicked</li>
126
</ul>
127
</li>
128
   <li>Link
129
<ul>
130
   <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 :
131
<ul>
132
   <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>
133
   <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>
134
</ul>
135
</li>
136
   <li style="color: #990000;">Warning: This value should not change after data has been added to your catalog. If you need to change this value you must ask your system administrator to run misc/batchRebuildBiblioTables.pl.</li>
137
</ul>
138
</li>
139
   <li>Koha link
140
<ul>
141
   <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>
142
</ul>
143
</li>
144
</ul>
145
</li>
146
   <li>For each subfield you can set the following Other option values
147
<ul>
148
   <li>Authorized value
149
<ul>
150
   <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>
151
</ul>
152
</li>
153
   <li>Thesaurus
154
<ul>
155
   <li>means that the value is not free text, but must be searched in the authority/thesaurus of the selected category</li>
156
</ul>
157
</li>
158
   <li>Plugin
159
<ul>
160
   <li>means the value is calculated or managed by a plugin. Plugins can do almost anything.</li>
161
   <li>Examples:
162
<ul>
163
   <li>For call numbers there is an option to add a call number browser next to the the call number subfield. Simply choose the cn_browser.pl plugin. Learn more in the cataloging section of the manual.</li>
164
   <li>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>
165
</ul>
166
</li>
167
</ul>
168
</li>
169
</ul>
170
</li>
171
   <li>To save your changes simply click the 'Save Changes' button at the top of the screen</li>
172
</ul>
173
174
<h4>Import/Export Frameworks</h4>
175
176
<p>Next to each framework is a link to either import or export the framework.</p>
177
178
<h5>Export Framework</h5>
179
180
<p>To export a framework simply click the 'Export' link to the right of framework title.</p>
181
182
<p>When you click 'Export' you will be prompted to choose what format to export the file in.</p>
183
184
<p>A framework exported this way can be imported into any other Koha installation using the import framework option.</p>
185
186
<h5>Import Framework</h5>
187
188
<p>An easy way to create a new framework is to import one created for your or another Koha installation. This framework would need to be exported from the other system using the instructions above to be available for import here.</p>
189
190
<p>To import a framework you first need to create a new framework. Once you have that framework, click 'Import' to the right of the new framework.</p>
191
192
<p>You will be prompted to find a file on your computer to import into the framework.</p>
193
194
<p>You will be asked to confirm your actions before the file is imported.<p>
195
196
<p>As your file is uploaded you will see an image that will confirm that the system is working.<p>
197
198
<p>Once your import is complete you will be brought to the framework edit tool where you can make any changes you need to the framework you imported.<p>
199
200
<p><strong>See the full documentation for Frameworks in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#marc-bibliographic-frameworks">manual</a> (online).</strong></p>
201
202
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/branch_transfer_limits.tt (-21 lines)
Lines 1-21 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Library Transfer Limits</h1>
4
5
<p>Limit the ability to transfer items between libraries based on the library sending, the library receiving, and the collection code involved.</p>
6
7
<p>These rules only go into effect if the preference UseBranchTransferLimits is set to 'enforce'.</p>
8
9
<p>Before you begin you will want to choose which library you are setting these limits for.</p>
10
11
<p>Transfer limits are set based on the collections codes you have applied via the Authorized Value administration area.</p>
12
13
<p>Collection codes will appear as tabs above the checkboxes.</p>
14
15
<p>Check the boxes for the libraries that you accept checkins from for the item type you have selected at the top.</p>
16
17
<p>In the above example, Centerville library will allow patrons to return items from all libraries except Liberty and Franklin to their library.</p>
18
19
<p><strong>See the full documentation for Library Transfer Limits in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#library-transfer-limits">manual</a> (online).</strong></p>
20
21
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/branches.tt (-82 lines)
Lines 1-82 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Libraries &amp; Groups</h1>
4
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
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
9
<h2>Adding a Library</h2>
10
11
<p>To add a new library:</p>
12
13
<ul>
14
	<li>Click 'New Library'</li>
15
	<li>The top of the form asks for some basics about the library
16
<ul>
17
	<li>The library code should not contain any spaces and be 10 or fewer characters. This code will be used as a unique identifier in the database.</li>
18
	<li>The name will be displayed on the OPAC wherever the library name displays to the public and should be a name that makes sense to your patrons.</li>
19
	<li>If you have groups set up you can choose what group this library belongs to after entering in the code and name</li>
20
</ul>
21
</li>
22
	<li>Next you can enter basic contact info about the branch
23
<ul>
24
	<li>The address and contact fields can be used to make notices custom for each library</li>
25
	<li>The email address field is not required, but it should be filled for every library in your system
26
<ul>
27
	<li style="color: #990000;">Important: Be sure to enter a library email address to make sure that notices are sent to and from the right address</li>
28
</ul>
29
</li>
30
	<li>If you'd like you can enter a different 'Reply-To' email address. This is the email address that all replies will go to.
31
<ul>
32
	<li>Tip: If you do not fill in this value Koha will use the address in the ReplytoDefault preference</li>
33
</ul>
34
</li>
35
	<li>If you'd like you can also enter a different 'Return-Path' email address. This is the email address that all bounced messages will go to.
36
<ul>
37
	<li>Tip: If you do not fill in this value Koha will use the address in the ReturnpathDefault preference</li>
38
</ul>
39
</li>
40
	<li>If the URL field is populated then the library name will be linked in the holdings table on the OPAC</li>
41
	<li>The OPAC Info box is for you to put information about the library that will appear in the OPAC when the branch name is moused over in the holdings table</li>
42
	<li>IP Address does not have be filled in unless you plan on limiting access to your staff client to a specific IP Address
43
<ul>
44
	<li style="color: #990000;">Important: An IP address is required if you have enabled AutoLocation</li>
45
</ul>
46
</li>
47
	<li>Finally, if you have any notes you can put them here. These will not show in the OPAC</li>
48
</ul>
49
</li>
50
</ul>
51
52
<p style="background-color: #ffe599;">Tip: Of the fields listed, only 'Library code' and 'Name' are required</p>
53
54
<h2>Editing/Deleting a Library</h2>
55
56
<p>You will be unable to delete any library that has patrons or items attached to it.</p>
57
58
<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>
59
60
<p>You will be unable to edit the 'Library code'</p>
61
62
<h2>Adding a group</h2>
63
64
<p>To add a Search Domain or Library Property Group click the 'New Group' button at the top of the screen.</p>
65
66
<p>Of the fields on the group form, 'Category code' and 'Name' are the only required fields</p>
67
68
<h2>Search Domain Groups</h2>
69
70
<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>
71
72
<p>To see Search Domain Groups in action visit the staff client advanced search page in your Koha system</p>
73
74
<h2>Library Property Groups</h2>
75
76
<p>You can assign specific categories to your libraries by adding groups for them.</p>
77
78
<p>Properties are then applied to libraries via the add or edit library form.</p>
79
80
<p><strong>See the full documentation for Libraries &amp; Groups in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#libraries-&-groups">manual</a> (online).</strong></p>
81
82
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tt (-93 lines)
Lines 1-93 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patron Categories</h1>
4
5
<p>Patron categories allow you to organize your patrons into different roles, age groups, and patron categories.</p>
6
7
<p>Patrons are assigned to one of six main categories:</p>
8
9
<ul>
10
    <li>Adult
11
<ul>
12
    <li>Most common patron category, usually used for a general 'Patron' category.</li>
13
</ul>
14
</li>
15
    <li>Child
16
<ul>
17
    <li>Children patrons can have a guardian to be attached to them.</li>
18
</ul>
19
</li>
20
    <li>Staff
21
<ul>
22
    <li>Patrons within the staff category will have access to the staff client.</li>
23
</ul>
24
</li>
25
    <li>Organizational
26
<ul>
27
    <li>Organizational patrons are organizations. Organizations can be used as guarantors for Professional patrons.</li>
28
</ul>
29
</li>
30
    <li>Professional
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 category 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'
59
<ul>
60
    <li style="color: #990000;">Important: This value will only be checked if BorrowerMandatoryField defines the dateofbirth as a required field on the patron record</li>
61
</ul>
62
</li>
63
    <li>Patron categories can also have a maximum age (in years) associated with them (such as children), enter this age in the 'Upperage limit'
64
<ul>
65
    <li style="color: #990000;">Important: This value will only be checked if BorrowerMandatoryField defines the dateofbirth as a required field on the patron record</li>
66
</ul>
67
</li>
68
    <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.
69
<ul>
70
    <li style="color: #990000;">Important: Only enter numbers and decimals in this field</li>
71
</ul>
72
</li>
73
    <li>If you want your patron to receive overdue notices, set the 'Overdue notice required' to 'Yes'</li>
74
    <li>If you charge patrons for placing holds on items, enter the fee amount in the 'Hold fee' field.
75
<ul>
76
    <li style="color: #990000;">Important: Only enter numbers and decimals in this field</li>
77
</ul>
78
</li>
79
    <li>In the 'Category type' field choose one of the six main parent categories</li>
80
    <li>The Branch Limitations let you limit this patron category to only some branches in your library system. Select 'All branches' if you would like any library to be able to use this category.</li>
81
    <li>You can decide if this patron category is blocked from performing actions in the OPAC if their card is expired using the next option. By default it will follow the rule set in the BlockExpiredPatronOpacActions preference</li>
82
    <li>Next you can choose the default privacy settings for this patron category. This setting can be edited by the patron via the OPAC if you allow it with the OPACPrivacy system preference.</li>
83
    <li>Finally you can assign advanced messaging preferences by default to a patron category
84
<ul>
85
    <li style="color: #990000;">Important: Requires that you have EnhancedMessagingPreferences enabled</li>
86
    <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>
87
</ul>
88
</li>
89
</ul>
90
91
<p><strong>See the full documentation for Patron Categories in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#patron-categories">manual</a> (online).</strong></p>
92
93
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/checkmarc.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>MARC Bibliographic Framework Test</h1>
4
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>
8
9
<p><strong>See the full documentation for the MARC Bibliographic Framework Test in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#marc-bibliographic-framework-test">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/cities.tt (-23 lines)
Lines 1-23 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Cities and Towns</h1>
4
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
7
<h2>Adding a City</h2>
8
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
11
<p>One you click Submit, your city will be saved and will be listed on the Cities and Towns page.</p>
12
13
<p>Cities can be edited or deleted at any time.</p>
14
15
<h2>Viewing Cities on Patron Add Form</h2>
16
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
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
<p><strong>See the full documentation for Cities and Towns in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#cities-and-towns">manual</a> (online).</strong></p>
22
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/classsources.tt (-58 lines)
Lines 1-58 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Classification Sources</h1>
4
5
<p>Source of classification or shelving scheme is an Authorized Values category that is mapped to field 952$2 and 942$2 in Koha's MARC Bibliographic frameworks.</p>
6
7
<p>Commonly used values of this field are:</p>
8
9
<ul>
10
    <li>ddc - Dewey Decimal Classification</li>
11
    <li>lcc - Library of Congress Classification</li>
12
</ul>
13
14
<p>If you chose to install classification sources during Koha's installation, you would see other values too:</p>
15
16
<ul>
17
	<li>ANSCR (sound recordings)</li>
18
	<li>SuDOC classification</li>
19
    <li>Universal Decimal Classification</li>
20
    <li>Other/Generic Classification</li>
21
</ul>
22
23
<h2>Adding/Editing Classification Sources</h2>
24
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
27
<p>When creating or editing:</p>
28
29
<ul>
30
	<li>You will need to enter a code and a description.</li>
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
	<li>Select the appropriate filing rule from the drop down list.</li>
33
</ul>
34
35
<h2>Classification Filing Rules</h2>
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>
55
56
<p><strong>See the full documentation for Classification Sources in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#classification-sources">manual</a> (online).</strong></p>
57
58
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/columns_settings.tt (-17 lines)
Lines 1-17 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h2>Columns settings</h2>
4
5
<p>This administration area will help you hide or display columns on fixed tables throughout the staff client.</p>
6
7
<p>Clicking on the module you'd like to edit tables for will show you the options available to you.</p>
8
9
<p>This area lets you control the columns that show several of the modules in Koha. If nothing is hidden you will see no check marks and will see all of the columns when viewing the table.</p>
10
11
<p>If columns are hidden they will be checked off and hidden when you view the table.</p>
12
13
<p>You can also toggle columns using the 'Show/Hide Columns' button in the top right of the page you altered the columns for.</p>
14
15
<p><strong>See the full documentation for Columns settings in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#column-settings">manual</a> (online).</strong></p>
16
17
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/currency.tt (-15 lines)
Lines 1-15 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Currencies and Exchange Rates</h1>
4
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
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 ISO code you enter will be used when importing MARC files via the staging tools, the tool will attempt to find and use the price of the currently active currency.</p>
10
11
<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>
12
13
<p><strong>See the full documentation for Currencies and Exchange Rates in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#currencies-and-exchange-rates">manual</a> (online).</strong></p>
14
15
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/didyoumean.tt (-22 lines)
Lines 1-22 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Did you mean?</h1>
4
5
<p>Koha can offer 'Did you mean?' options on searches based on values in your authorities.</p>
6
7
<p style="color: #990000;">Important Did you mean? only works in the OPAC at this time. The Intranet options are here for future development.</p>
8
9
<p>Using this page you can control which options Koha gives patrons on their search results.</p>
10
11
<p>To turn on the 'Did you mean?' bar on your search results you need to check the box next to each plugin you would like to use. The two plugins you have to choose from are:</p>
12
13
<ul>
14
    <li>The ExplodedTerms plugin suggests that the user try searching for broader/narrower/related terms for a given search (e.g. a user searching for "New York (State)" would click the link for narrower terms if they're also interested in "New York (City)"). This is only relevant for libraries with highly hierarchical authority data.</li>
15
    <li>The AuthorityFile plugin searches the authority file and suggests the user might be interested in bibs linked to the top 5 authorities</li>
16
</ul>
17
18
<p>If you want one plugin to take priority over another you simply drag it above the other.</p>
19
20
<p><strong>See the full documentation for the Did you mean? feature in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#did-you-mean?">manual</a> (online).</strong></p>
21
22
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/edi_accounts.tt (-17 lines)
Lines 1-17 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Vendor EDI accounts</h1>
4
5
<p>From here you can set up the information needed to connect to your acquisitions vendors</p>
6
7
<p style="color: #990000;">Note: Before you begin, you must set up at least one <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/acquisitions.html#add-a-vendor">Vendor in Acquisitions</a>.</p>
8
9
<p>To add account information, click the 'New account' button.</p>
10
11
<p>Enter your vendor information in the form that appears.</p>
12
13
<p>Each vendor will have one account.</p>
14
15
<p><strong>See the full documentation for EDI accounts in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#edi-accounts">manual</a> (online).</strong></p>
16
17
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/edi_ean_accounts.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Library EANs</h1>
4
5
<p>A library EAN is the identifier the vendor gives the library to send back to them so they know which account to use when billing. One EDI account can have multiple EANs.</p>
6
7
<p>To add an EAN, click the 'New EAN' button.</p>
8
9
<p>In the form that appears, enter the information provided by your vendor.</p>
10
11
<p><strong>See the full documentation for Library EANs in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#library-eans">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/fieldmapping.tt (-25 lines)
Lines 1-25 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Keyword to MARC Mapping</h1>
4
5
<p>This tool will allow you to map MARC fields to a set of predefined keywords.</p>
6
7
<p>At this time the only keyword in use is 'subtitle.'</p>
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>
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>
12
13
<p>However the subtitle for DVDs appears in 245$p</p>
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>
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
21
<p>Future developments will include additional keyword assigned fields.</p>
22
23
<p><strong>See the full documentation for Keyword to MARC Mapping in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#keywords-to-marc-mapping">manual</a> (online).</strong></p>
24
25
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/item_circulation_alerts.tt (-24 lines)
Lines 1-24 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Item Circulation Alerts</h1>
4
5
<p>Libraries can decide if they want to have patrons automatically notified of circulation events (check ins and check outs).</p>
6
7
<p>These preferences are set based on patron categories and item types.</p>
8
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
15
<ul>
16
	<li>To set preferences for all libraries, keep the menu set to 'Default'</li>
17
</ul>
18
</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 type/patron category combination that you would like to stop notices for.</li>
20
</ul>
21
22
<p><strong>See the full documentation for Item Circulation Alerts in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#item-circulation-alerts">manual</a> (online).</strong></p>
23
24
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/items_search_fields.tt (-25 lines)
Lines 1-25 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Item search fields help</h1>
4
5
<p>From here you can add custom search fields to the item search option in the staff client.</p>
6
7
<p>To add a new search term simply fill in the 'Add a new field' area:</p>
8
9
<ul>
10
<li>Name is a field for you to identify the search term</li>
11
12
<li>Label is what will appear on the item search page</li>
13
14
<li>MARC field allows you to pick which field you'd like to search in</li>
15
16
<li>MARC subfield is the subfield you'd like to search in</li>
17
18
<li>Authorised values category can be used to turn this search field in to a pull down instead of a free text field</li>
19
</ul>
20
21
<p>Once your new field is added it will be visible at the top of this page and on the item search page</p>
22
23
<p><strong>See the full documentation for Item search fields in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#item-search-fields">manual</a> (online).</strong></p>
24
25
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/itemtypes.tt (-62 lines)
Lines 1-62 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Item Types</h1>
4
5
<p>Koha allows you to organize your collection by item types and collection codes.</p>
6
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
9
<h2>Adding Item Types</h2>
10
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
13
<ul>
14
   <li>In the 'Item Type' field, enter a short code for your item type</li>
15
	<li>The description is the plain text definition of the item type</li>
16
	<li>You can choose to have an image associated with your item type
17
<ul>
18
	<li>You can choose from a series of image collections</li>
19
	<li>You can link to a remote image</li>
20
	<li>Or you can just have no image associated with 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
<ul>
23
 <li>Get there: More &gt; Administration &gt; Global System Preferences &gt; Admin</li>
24
</ul>
25
</li>
26
</ul>
27
</li>
28
	<li>For items that do not circulate, check the 'Not for loan' options
29
<ul>
30
	<li>Items marked 'Not for loan' will appear in the catalog, but cannot be checked out to patrons</li>
31
</ul>
32
</li>
33
	<li>Enter the total number of renewals allowed for the item type in the 'Renewals' box</li>
34
	<li>For items that you charge a rental fee for, enter the total fee you charge in the 'Rental charge' field
35
<ul>
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>This will charge the patron on checkout</li>
38
</ul>
39
</li>
40
  <li>When finished, click 'Save Changes'
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
<p><strong>See the full documentation for Item Types in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#item-types">manual</a> (online).</strong></p>
61
62
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/koha2marclinks.tt (-17 lines)
Lines 1-17 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Koha to MARC mapping</h1>
4
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 during installation. If you decide to change mappings here, make sure that you know what you are doing! We would recommend to test such changes first in a non-production environment.</p>
6
7
<p>Historically, the Koha to MARC mappings have been the same throughout all frameworks. But note that it was possible (before) to add or remove a mapping in an individual framework via Administration/MARC bibliographic framework. Since we now consider the Default framework as authoritative for these mappings, this form shows the mappings in Default and applies changes to all other frameworks.</p>
8
9
<p>The mappings are found in three tables: biblio, biblioitems and items.</p>
10
11
<p>In order to add a mapping for a specific Koha field, click the Add button on the corresponding line in the table. You will be asked to enter a field number and a subfield code. In order to remove a specific mapping, click the Remove button on the corresponding line. Both changes (add, delete) are applied immediately.</p>
12
13
<p>The tool now supports multiple mappings too for one Koha field. As an example, you can connect copyrightdate to 260$c as well as 264$c (the RDA equivalent). Since a record normally only contains only one of them, this one value will be found in copyrightdate. (Multiple values would be saved, separated by vertical bars.) Note that you cannot add/remove mappings for biblionumber, biblioitemnumber or itemnumber. You are not recommended to change them.</p>
14
15
<p><strong>See the full documentation for Koha to MARC Mapping in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#koha-to-marc-mapping">manual</a> (online).</strong></p>
16
17
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/marc_subfields_structure.tt (-122 lines)
Lines 1-122 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>MARC Bibliographic Frameworks Subfields</h1>
4
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
7
<ul>
8
   <li>Each field has a tag (which is the MARC tag) that is uneditable
9
<ul>
10
   <li>The 'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels</li>
11
   <li>The 'Label for OPAC' is what will show on the MARC view in the OPAC</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>
13
   <li>If you check 'Mandatory' the record will not be allowed to save unless you have a value assigned to this tag</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</li>
15
</ul>
16
</li>
17
</ul>
18
19
<p>To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing</p>
20
21
<ul>
22
   <li>From the list of subfields you can click 'Delete' to the right of each to delete the subfields</li>
23
   <li>To edit the subfields click 'Edit Subfields'</li>
24
   <li>For each subfield you can set the following Basic constraint values
25
<ul>
26
   <li>Text for librarian
27
<ul>
28
   <li>what appears before the subfield in the librarian interface</li>
29
</ul>
30
</li>
31
   <li>Text for OPAC
32
<ul>
33
   <li>what appears before the field in the OPAC.
34
<ul>
35
   <li>If left empty, the text for librarian is used instead</li>
36
</ul>
37
</li>
38
</ul>
39
</li>
40
   <li>Repeatable
41
<ul>
42
   <li>the field will have a plus sign next to it allowing you to add multiples of that tag</li>
43
</ul>
44
</li>
45
   <li>Mandatory
46
<ul>
47
   <li>the record will not be allowed to save unless you have a value assigned to this tag</li>
48
</ul>
49
</li>
50
   <li>Managed in tab
51
<ul>
52
   <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>
53
</ul>
54
</li>
55
</ul>
56
</li>
57
   <li>For each subfield you can set the following Advanced constraint values
58
<ul>
59
   <li>Default value
60
<ul>
61
   <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>
62
</ul>
63
</li>
64
   <li>Visibility
65
<ul>
66
   <li>allows you to select from where this subfield is visible/hidden, simply check the boxes where you would like the field to show and uncheck the boxes where you would like it hidden.</li>
67
</ul>
68
</li>
69
   <li>Is a URL
70
<ul>
71
   <li>if checked, it means that the subfield is a URL and can be clicked</li>
72
</ul>
73
</li>
74
   <li>Link
75
<ul>
76
   <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 :
77
<ul>
78
   <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>
79
   <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>
80
</ul>
81
</li>
82
   <li style="color: #990000;">Warning: This value should not change after data has been added to your catalog. If you need to change this value you must ask your system administrator to run misc/batchRebuildBiblioTables.pl.</li>
83
</ul>
84
</li>
85
   <li>Koha link
86
<ul>
87
   <li>This field has been disabled on this form. The Koha to MARC mapping is maintained on the corresponding form in the Administration module. For more information on this field, consult the online help page of that form.</li>
88
</ul>
89
</li>
90
</ul>
91
</li>
92
   <li>For each subfield you can set the following Other option values
93
<ul>
94
   <li>Authorized value
95
<ul>
96
   <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>
97
</ul>
98
</li>
99
   <li>Thesaurus
100
<ul>
101
   <li>means that the value is not free text, but must be searched in the authority/thesaurus of the selected category</li>
102
</ul>
103
</li>
104
   <li>Plugin
105
<ul>
106
   <li>means the value is calculated or managed by a plugin. Plugins can do almost anything.</li>
107
   <li>Examples:
108
<ul>
109
   <li>For call numbers there is an option to add a call number browser next to the the call number subfield. Simply choose the cn_browser.pl plugin. Learn more in the cataloging section of the manual.</li>
110
   <li>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>
111
</ul>
112
</li>
113
</ul>
114
</li>
115
</ul>
116
</li>
117
   <li>To save your changes simply click the 'Save Changes' button at the top of the screen</li>
118
</ul>
119
120
<p><strong>See the full documentation for MARC Frameworks in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#marc-bibliographic-frameworks">manual</a> (online).</strong></p>
121
122
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/marctagstructure.tt (-25 lines)
Lines 1-25 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>MARC Bibliographic Frameworks Tags</h1>
4
5
<p>To add a field to a Framework click the 'New Tag' button at the top of the 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
<ul>
11
   <li>The 'Tag' is the MARC field number</li>
12
   <li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module</li>
13
   <li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record</li>
14
   <li>If this field can be repeated, check the 'Repeatable' box</li>
15
   <li>If this field is mandatory, check the 'Mandatory' box</li>
16
   <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>
17
</ul>
18
19
<p>When you're finished, click 'Save Changes' and you will be presented with your new field</p>
20
21
<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. The process of entering the settings for the new subfield is the same as those found in the editing subfields in frameworks section of the manual.</p>
22
23
<p><strong>See the full documentation for MARC Frameworks in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#marc-bibliographic-frameworks">manual</a> (online).</strong></p>
24
25
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/matching-rules.tt (-51 lines)
Lines 1-51 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Record Matching Rules</h1>
4
5
<p>Record matching rules are used when importing MARC records into Koha.</p>
6
7
<p>The rules that you set up here will be referenced with you Stage MARC Records for Import.</p>
8
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' - The total number of 'points' a biblio must earn to be considered a 'match'</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' - The number of 'points' a match on this field is worth.  If the sum of each score is greater than the match threshold, the incoming record is a match to the existing record</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' - For use with control fields, 001-009</li>
23
	<li>'Length' - For use with control fields, 001-009</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>
48
49
<p><strong>See the full documentation for Record Matching Rules in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#record-matching-rules">manual</a> (online).</strong></p>
50
51
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/oai_set_mappings.tt (-23 lines)
Lines 1-23 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>OAI-PMH Sets Mappings Configuration</h1>
4
5
<p>Here you can define how a set will be build (what records will belong to this set) by defining mappings. Mappings are a list of conditions on record content. A record only need to match one condition to belong to the set.</p>
6
7
<h2>Defining a mapping</h2>
8
9
<ol>
10
    <li>Fill the fields 'Field', 'Subfield', 'Operator' and 'Value'. For example if you want to include in this set all records that have a 999$9 equal to 'XXX'. Fill 'Field' with 999, 'Subfield' with 9, 'Operator' with is equal to and 'Value' with XXX.</li>
11
    <li>If you want to add another condition, click on 'OR' button and repeat step 1.</li>
12
    <li>Click on 'Save'</li>
13
</ol>
14
15
<p>To delete a condition, just leave at least one of 'Field' or 'Subfield' empty and click on 'Save'.</p>
16
17
<p>Note: Actually, a condition is true if value in the corresponding subfield is strictly 'equal' or 'not equal' to what is defined if 'Value'. A record having 999$9 = 'XXX YYY' will not belong to a set where condition is 999$9 = 'XXX'.</p>
18
19
<p>And it is case sensitive : a record having 999$9 = 'xxx' will not belong to a set where condition is 999$9 = 'XXX'.</p>
20
21
<p><strong>See the full documentation for OAI Sets in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#oai-sets-configuration">manual</a> (online).</strong></p>
22
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/oai_sets.tt (-34 lines)
Lines 1-34 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>OAI-PMH Sets Configuration</h1>
4
5
<p>On this page you can create, modify and delete OAI-PMH sets<p>
6
7
<h2>Create a set</h2>
8
9
<ol>
10
    <li>Click on the link 'Add a new set'</li>
11
    <li>Fill the mandatory fields 'setSpec' and 'setName'</li>
12
    <li>Then you can add descriptions for this set. To do this click on 'Add description' and fill the newly created text box. You can add as many descriptions as you want.</li>
13
    <li>Click on 'Save' button'</li>
14
</ol>
15
16
<h2>Modify a set</h2>
17
18
<p>To modify a set, just click on the link 'Modify' on the same line of the set you want to modify. A form similar to set creation form will appear and allow you to modify the setSpec, setName and descriptions.</p>
19
20
<h2>Delete a set</h2>
21
22
<p>To delete a set, just click on the link 'Delete' on the same line of the set you want to delete.</p>
23
24
<h2>Define mappings</h2>
25
26
<p>The 'Define mappings' link allow you to tell how the set will be build (what records will belong to this set)</p>
27
28
<h2>Build sets</h2>
29
30
<p>Once you have configured all your sets, you have to build the sets. This is done by calling the script misc/migration_tools/build_oai_sets.pl.</p>
31
32
<p><strong>See the full documentation for OAI Sets in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#oai-sets-configuration">manual</a> (online).</strong></p>
33
34
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/patron-attr-types.tt (-76 lines)
Lines 1-76 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patron Attribute Types</h1>
4
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
7
<ul>
8
   <li><em>Get there:</em> More &gt; Administration &gt; Patrons &amp; Circulation &gt; Patron attribute types</li>
9
</ul>
10
11
<p>A common use for this field would be for a student ID number or a Driver's license number.</p>
12
13
<h3>Adding Patron Attributes</h3>
14
15
<p>To add a new Patron Attribute Type, click the 'New Patron Attribute Type' button at the top of the page</p>
16
17
<ul>
18
    <li>In the 'Patron attribute type code', enter a short code to identify this field
19
<ul>
20
    <li style="color: #990000;">Important: This field is limited to 10 characters (numbers and letters only)</li>
21
    <li style="color: #990000;">Important: This setting cannot be changed after an attribute is defined</li>
22
</ul>
23
</li>
24
	<li>In the 'Description' field, enter a longer (plain text) explanation of what this field will contain</li>
25
	<li>Check the box next to 'Repeatable' to let a patron record have multiple values of this attribute.
26
<ul>
27
    <li style="color: #990000;">Important: This setting cannot be changed after an attribute is defined</li>
28
</ul>
29
</li>
30
	<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.
31
    <li>Unique attributes can be used as match points on the patron import tool</li>
32
<ul>
33
    <li style="color: #990000;">Important: This setting cannot be changed after an attribute is defined</li>
34
</ul>
35
</li>
36
	<li>Check 'Allow password' to make it possible to associate a password with this attribute.</li>
37
	<li>Check 'Display in OPAC' to display this attribute on a patron's details page in the OPAC.</li>
38
	<li>Check 'Searchable' to make this attribute searchable in the staff patron search.</li>
39
	<li>Check 'Display in check-out' to make this attribute visible in the patron's short detail display on the left of the checkout screen and other patron pages</li>
40
	<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.
41
<ul>
42
    <li>You will first need to add an authorized value list for it to appear in this menu
43
<ul>
44
    <li><em>Get there: </em>More &gt; Administration &gt; Basic Parameters &gt; Authorized Values</li>
45
</ul>
46
</li>
47
    <li style="color: #990000;">Important: an authorized value list is not enforced during batch patron import.</li>
48
</ul>
49
</li>
50
    <li>If you would like this attribute to only be used by specific branches you can choose those branches from the 'Branches limitation' list. Choose 'All branches' to show it for all libraries.</li>
51
    <li>If you'd like to only show this attribute on patrons of one type choose that patron type from the 'Category' pull down</li>
52
    <li>If you have a lot of attributes it might be handy to group them so that you can easily find them for editing. If you create an Authorized Value for PA_CLASS it will show in the 'Class' pull down and you can then change your attributes page to have sections of attributes</li>
53
	<li>Click Save to save your new attribute</li>
54
</ul>
55
56
<p>Once added your attribute will appear on the list of attributes and also on the patron record add/edit form</o>
57
58
<p>If you have set up classes for organizing attributes they will appear that way on the add/edit patron form</p>
59
60
<h3>Editing/Deleting Patron Attributes</h3>
61
62
<p>Each patron attribute has an edit and a delete link beside it on the list of attributes.</p>
63
64
<p>Some fields in the attribute will not be editable once created:</p>
65
66
<ul>
67
	<li>Patron attribute type code</li>
68
	<li>Repeatable</li>
69
	<li>Unique identifier</li>
70
</ul>
71
72
<p>You will be unable to delete an attribute if it's in use.</p>
73
74
<p><strong>See the full documentation for Patron Attribute Types in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#patron-attribute-types">manual</a> (online).</strong></p>
75
76
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/preferences.tt (-37 lines)
Lines 1-37 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
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>
14
15
<p>Each of the tabs on the left holds several different preferences:</p>
16
17
<ul>
18
    <li><strong>Acquisitions:</strong> holds preferences related to acquisitions such as handling patron suggestions and local taxes.</li>
19
    <li><strong>Administration:</strong> holds administrative preferences such as admin email address, sessions and timeout.</li>
20
    <li><strong>Authorities:</strong> holds preference related to handling authority records.</li>
21
    <li><strong>Cataloging:</strong> holds preferences that control the cataloging functions. This is where you choose your MARC flavor, set up Z39.50 and barcoding.</li>
22
    <li><strong>Circulation:</strong> holds preferences that control circulation functions such as holds and fines.</li>
23
    <li><strong>Enhanced Content:</strong> holds preferences that will add content from outside sources to your OPAC and Staff Client. This is where you can turn on cover images, FRBR and tagging.</li>
24
    <li><strong>I18N/L10N:</strong> holds preferences related to internationalization and localization such as date formats and languages.</li>
25
    <li><strong>Local Use:</strong> this tab will usually be empty unless your library has a preference just for your library.</li>
26
    <li><strong>Logs:</strong> turn on/off logging functionality in your system.</li>
27
    <li><strong>OPAC:</strong> customize the OPAC and OPAC functions (aside from the Enhanced Content preferences).</li>
28
    <li><strong>Patrons:</strong> holds preferences that control how your system handles patron functions. Some preferences include the minimum password length and membership number settings.</li>
29
    <li><strong>Searching:</strong> holds preference related to advanced search functions such as removing stop words or allowing stemming.</li>
30
    <li><strong>Serials</strong> holds all preferences related to managing serial subscriptions.</li>
31
    <li><strong>Staff Client:</strong> customize the staff client by editing the stylesheet and navigation menu.</li>
32
    <li><strong>Web Services:</strong> includes preferences related to services like OAI-PMH.</li>
33
</ul>
34
	
35
<p><strong>See the full documentation for System Preferences in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/systempreferences.html">manual</a> (online).</strong></p>
36
	
37
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/smart-rules.tt (-164 lines)
Lines 1-164 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Circulation and Fines Rules</h1>
4
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>
8
9
<ul>
10
	<li>same library, same patron category, same item type</li>
11
	<li>same library, same patron category, all item type</li>
12
	<li>same library, all patron categories, same item type</li>
13
	<li>same library, all patron categories, all item types</li>
14
	<li>all libraries, same patron category, same item type</li>
15
	<li>all libraries, same patron category, all item types</li>
16
	<li>all libraries, all patron categories, same item type</li>
17
	<li>all libraries, all patron categories, all item types</li>
18
</ul>
19
20
<p>The CircControl and HomeOrHoldingBranch also come in to play when figuring out which circulation rule to follow.</p>
21
22
<ul>
23
	<li>If CircControl is set to "the library you are logged in at" circ rules will be selected based on the library you are logged in at</li>
24
	<li>If CircControl is set to "the library the patron is from" circ rules will be selected based on the patron's library</li>
25
	<li>If CircControl is set to "the library the item is from" circ rules will be selected based on the item's library where HomeOrHoldingBranch chooses if item's home library is used or holding library is used.</li>
26
	<li>If IndependentBranches is set to 'Prevent' then the value of HomeOrHoldingBranch is used in figuring out if the item can be checked out. If the item's home library does not match the logged in library, the item cannot be checked out unless you are a superlibrarian.</li>
27
</ul>
28
29
<p>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>
30
31
<p style="color: #990000;">Important: At the very least you will need to set a default circulation rule. This rule should be set for all item types, all libraries and all patron categories. 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 categories 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 categories to avoid this holds issue. Koha needs to know what rule to fall back on.</p>
32
33
<h4>Default Circulation Rules</h4>
34
35
<p>Using the circulation and fine rules matrix you can define rules that depend on patron/item type combinations. To set your rules, choose a library from the pull down (or 'all libraries' if you want to apply these rules to all libraries)</p>
36
37
<p>From the matrix you can choose any combination of patron categories and item types to apply the rules to</p>
38
39
<ul>
40
	<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>
41
	<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>
42
	<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>
43
    <li>Define the period of time an item can be checked out to a patron by entering the number of units (days or hours) in the 'Loan Period' box.</li>
44
    <li>Choose which unit of time, Days or Hours, that the loan period and fines will be calculate in</li>
45
    <li>You can also define a hard due date for a specific patron category and item type. A hard due date ignores your usual circulation rules and makes it so that all items of the type defined are due on, before or after the date you specify.</li>
46
    <li>'Fine Amount' should have the amount you would like to charge for overdue items
47
<ul>
48
    <li style="color: #990000;">Important: Enter only numbers and decimal points (no currency symbols).</li>
49
</ul>
50
</li>
51
    <li>Enter the 'Fine Charging Interval' in the unit you set (ex. charge fines every 1 day, or every 2 hours)</li>
52
    <li>The 'Fine Grace Period' is the period of time an item can be overdue before you start charging fines.
53
<ul>
54
    <li style="color: #990000;">Important: This can only be set for the Day unit, not in Hours</li>
55
</ul>
56
</li>
57
    <li>The 'Overdue Fines Cap' is the maximum fine for this patron and item combination
58
<ul>
59
    <li style="color: #990000;">Important: If this field is left blank then Koha will not put a limit on the fines this item will accrue. A maximum fine amount can be set using the MaxFine system preference.</li>
60
</ul>
61
</li>
62
    <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
63
<ul>
64
    <li style="color: #990000;">Important: This can only be set for the Day unit, not in Hours</li>
65
</ul>
66
</li>
67
    <li>You can also define the maximum number of days a patron will be suspended in the 'Max suspension duration' setting</li>
68
    <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>
69
    <li>If you're allowing renewals you can control how long the renewal loan period will be (in the units you have chosen) in the 'Renewal period' box</li>
70
    <li>If you're allowing renewals you can control how soon before the due date patrons can renew their materials with the 'No renewals before' box.
71
    <ul><li>Items can be renewed at any time if this value is left blank. Otherwise items can only be renewed if the item is before the number in units (days/hours) entered in this box.</li></ul></li>
72
    <li>You can enable automatic renewals for certain items/patrons if you'd like. This will renew automatically following your circulation rules unless there is a hold on the item
73
    <ul>
74
    <li style="color: #990000;">Important: You will need to enable the automatic renewal cron job for this to work.</li>
75
    <li style="color: #990000;">Important: This feature needs to have the "no renewal before" column filled in or it will auto renew everyday after the due date.</li>
76
    </ul>
77
    </li>
78
    <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>
79
    <li>Next you can decide if this patron/item combo are allowed to place holds on items that are on the shelf (or available in the library) or not. If you choose 'no' then items can only be placed on hold if checked out</li>
80
    <li>You can also decide if patrons are allowed to place item specific holds on the item type in question. The options are:
81
    <ul>
82
    <li>Allow: Will allow patrons the option to choose next available or item specific</li>
83
    <li>Don't allow: Will only allow patrons to choose next available</li>
84
    <li>Force: Will only allow patrons to choose an specific item</li>
85
    </ul></li>
86
    <li>Finally, if you charge a rental fee for the item type and want to give a specific patron category a discount on that fee, enter the percentage discount (without the % symbol) in the 'Rental Discount' field</li>
87
</ul>
88
89
<p>When finished, click 'Add' to save your changes. To modify a rule, create a new one with the same patron category and item type. If you would like to delete your rule, simply click the 'Delete' link to the right of the rule.</p>
90
91
<p>To save time you can clone rules from one library to another by choosing the clone option above the rules matrix.</p>
92
93
<p>After choosing to clone you will be presented with a confirmation message.</p>
94
95
<h4>Default Checkouts and Hold Policy</h4>
96
97
<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>
98
99
<p>From this menu you can set a default to apply to all item types and patrons in the library.</p>
100
101
<ul>
102
    <li>In 'Total Current Checkouts Allowed' enter the total number of items patrons can have checked out at one time</li>
103
    <li>Control where patrons can place holds from using the 'Hold Policy' menu
104
<ul>
105
    <li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
106
    <li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
107
    <li>No Holds Allowed: No patron may put this book on hold.</li>
108
</ul>
109
</li>
110
    <li>Control where the item returns to once it is checked in
111
<ul>
112
    <li>Item returns home</li>
113
    <li>Item returns to issuing library</li>
114
    <li>Item floats
115
<ul>
116
    <li>When an item floats it stays where it was checked in and does not ever return 'home'</li>
117
</ul>
118
</li>
119
</ul>
120
</li>
121
	<li>Once your policy is set, you can unset it by clicking the 'Unset' link to the right of the rule</li>
122
</ul>
123
124
<h4>Checkouts Per Patron</h4>
125
126
<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>
127
128
<p>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.</p>
129
130
<h4>Item Hold Policies</h4>
131
132
<p>For this library, you can edit rules for given itemtypes, regardless of the patron's category. Currently, this means hold policies.</p>
133
134
<p>The various Hold Policies have the following effects:</p>
135
136
<ul>
137
    <li>From Any Library: Patrons from any library may put this item on hold. (default if none is defined)</li>
138
    <li>From Home Library: Only patrons from the item's home library may put this book on hold.</li>
139
    <li>No Holds Allowed: No patron may put this book on hold.</li>
140
</ul>
141
142
<p style="color: #990000;">Important: Note that if the system preference AllowHoldPolicyOverrideset to 'allow', these policies can be overridden by your circulation staff.</p>
143
144
<p style="color: #990000;">Important: These policies are based on the patron's home library, not the library that the reserving staff member is from.</p>
145
146
<p>The various Return Policies have the following effects:</p>
147
148
<ul>
149
    <li>Item returns home: The item will prompt the librarian to transfer the item to its home library
150
<ul>
151
    <li style="color: #990000;">Important: If the AutomaticItemReturnpreference is set to automatically transfer the items home, then a prompt will not appear</li>
152
</ul>
153
</li>
154
    <li>Item returns to issuing library: The item will prompt the librarian to transfer the item back to the library where it was checked out
155
<ul>
156
    <li style="color: #990000;">Important: If the AutomaticItemReturnpreference is set to automatically transfer the items home, then a prompt will not appear</li>
157
</ul>
158
</li>
159
    <li>Item floats: The item will not be transferred from the library it was checked in at, instead it will remain there until transferred manually or checked in at another library</li>
160
</ul>
161
162
<p><strong>See the full documentation for Circulation and Fine Rules in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#circulation-and-fine-rules">manual</a> (online).</strong></p>
163
164
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/systempreferences.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Local Use System Preferences</h1>
4
5
<p>System preferences not defined in other tabs.</p>
6
7
<p>Some may have been defined just for your library.</p>
8
9
<p>Always contains <i>Version</i> preference, <strong>please do not change it manually.</strong>
10
11
<p><strong>See the full documentation for System Preferences in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/systempreferences.html">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/transport-cost-matrix.tt (-15 lines)
Lines 1-15 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Transport cost matrix</h1>
4
5
<p>The Transport cost matrix lets a library system define relative costs to transport books to one another. In order for the system to use this matrix you must first set the UseTransportCostMatrix preference to 'Use'.</p>
6
7
<p>Costs are decimal values between some arbitrary maximum value (e.g. 1 or 100) and 0 which is the minimum (no) cost. For example, you could just use the distance between each library in miles as your 'cost', if that would accurately reflect the cost of transferring them. Perhaps post offices would be a better measure. Libraries sharing a post office would have a cost of 1, adjacent post offices would have a cost of 2, etc.</p>
8
9
<p>To enter transport costs simply click in the cell you would like to alter, uncheck the 'Disable' box and enter your 'cost'</p>
10
11
<p>After entering in your cost, hit 'Enter' on your keyboard or click the 'Save' button at the bottom of the matrix to save your changes.</p>
12
13
<p><strong>See the full documentation for the Transport Cost Matrix in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#transport-cost-matrix">manual</a> (online).</strong></p>
14
15
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/z3950servers.tt (-104 lines)
Lines 1-104 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Z39.50/SRU Servers</h1>
4
5
<p>Z39.50 and SRU are client–server protocols for searching and retrieving information from remote computer databases, in short tools used for copy cataloging. Using Koha you can connect to any Z39.50/SRU target that is publicly available or that you have the log in information to and copy both bibliographic and/or authority records from that source. (Note that not all SRU targets will offer bibliographic information in MARC format.)</p>
6
7
<p>Koha comes with a default list of Z39.50/SRU targets set up that you can add to, edit or delete.</p>
8
9
<p>To find additional targets you use IndexData's IRSpy: <a href="http://irspy.indexdata.com/" target="_top">http://irspy.indexdata.com</a>.</p>
10
11
<h2>Add a Z39.50/SRU Target</h2>
12
13
<p>From the main Z39.50/SRU page, click 'New Z39.50 Server' or 'New SRU server'.</p>
14
<ul>
15
    <li>'Server name' should be populated with a name that will help you identify the source (such as the library name).</li>
16
    <li>'Hostname' will be the address to the Z39.50 target. For a SRU target, only enter the domain name here. (See example below.)</li>
17
	<li>'Port' tells Koha what port to listen on to get results from this target.</li>
18
    <li>'Database' is the name of the database for Z39.50 targets. For SRU targets enter the path name part of the URL (the local part following domain and port). See also example below.</li>
19
	<li>'Userid' and 'Password' are only required for servers that are password protected.</li>
20
    <li>Check 'Preselected (searched by default)' if you want this target to always be selected by default.</li>
21
    <li>'Rank' lets you enter where in the list you'd like this target to appear. If this is left blank the targets will be in alphabetical order.</li>
22
	<li>'Syntax' is the MARC flavor you use.</li>
23
	<li>'Encoding' tells the system how to read special characters.</li>
24
	<li>'Timeout' is helpful for targets that take a long while. You can set the timeout so that it doesn't keep trying the target if results aren't found in a reasonable amount of time.</li>
25
	<li>'Record type' lets you define if this is a bibliographic or an authority target.</li>
26
    <li>'Additional SRU options': You can enter additional options of the external server here, like sru_version=1.1 or schema=marc21, etc. Note that these options are server dependent.</li>
27
    <li>'SRU Search field mapping': Click on Modify to add or update the mapping from the available fields on the Koha search form to the specific server dependent index names. For instance, a SRU server could use 'cql.anywhere' for the Any field on the Koha form. If you do not enter an index name for a specific search field, the whole record will be searched.</li>
28
    <li>'XSLT file(s)': You can enter here one or more (comma-separated) XSLT file names that you want to apply on the search results.</li>
29
</ul>
30
31
<h2>Using XSLT file(s) to transform the imported records</h2>
32
<p>When retrieving records from external targets you may wish to automate some
33
   changes to those records. XSLT's allow you to do this. Koha ships with some
34
   sample XSLT files ready for use.</p>
35
<ul>
36
    <li>Del952.xsl: Remove items (MARC21/NORMARC)</li>
37
    <li>Del995.xsl: Remove items (UNIMARC)</li>
38
    <li>Del9LinksExcept952.xsl: Remove $9 links. Skip item fields (MARC21/NORMARC).</li>
39
    <li>Del9LinksExcept995.xsl: Remove $9 links. Skip item fields (UNIMARC).</li>
40
</ul>
41
42
<h3>Example</h3>
43
<p>If you want to remove both holdings data and $9 links when importing, you can use:</p>
44
<table>
45
    <thead><tr>
46
        <th>Syntax</th>
47
        <th>XSLT configuration</th>
48
    </tr></thead>
49
    <tbody>
50
        <tr><td>MARC21/NORMARC</td><td>Del9LinksExcept952.xsl, Del952.xsl</td></tr>
51
        <tr><td>UNIMARC</td><td>Del9LinksExcept995.xsl, Del995.xsl</td></tr>
52
    </tbody>
53
</table>
54
55
<h2>SRU example</h2>
56
<p>If you want to enter the Library of Congress SRU server, you should at least use the following information. The full URL http://lx2.loc.gov:210/LCDB must be entered as follows:</p>
57
<table>
58
<tr><td>Host</td><td>lx2.loc.gov</td></tr>
59
<tr><td>Port</td><td>210</td></tr>
60
<tr><td>Database</td><td>LCDB</td></tr>
61
<tr><td>Syntax</td><td>MARC21/USMARC</td></tr>
62
<tr><td>Encoding</td><td>utf8</td></tr>
63
</table>
64
<p>To further refine your searches, you could add the following index names to the SRU search field mappings. To do this, edit the server and click the Modify button next to this field.</p>
65
<table>
66
<tr><td>Title</td><td>dc.title</td></tr>
67
<tr><td>ISBN</td><td>bath.isbn</td></tr>
68
<tr><td>Any</td><td>cql.anywhere</td></tr>
69
<tr><td>Author</td><td>dc.author</td></tr>
70
<tr><td>ISSN</td><td>bath.issn</td></tr>
71
<tr><td>Subject</td><td>dc.subject</td></tr>
72
<tr><td>Standard ID</td><td>bath.standardIdentifier</td></tr>
73
</table>
74
75
<h2>Suggested Bibliographic Z39.50 Targets</h2>
76
77
<p>The following targets have been used successfully by other Koha libraries (in the Americas):</p>
78
<ul>
79
	<li>CUYAHOGA COUNTY PUBLIC webcat.cuyahoga.lib.oh.us:210 INNOPAC</li>
80
	<li>GREATER SUDBURY PUBLIC 216.223.90.51:210 INNOPAC</li>
81
	<li>HALIFAX PUBLIC catalogue.halifaxpubliclibraries.ca:210 horizon</li>
82
	<li>HALTON HILLS PUBLIC cat.hhpl.on.ca:210 halton_hills</li>
83
	<li>LIBRARY OF CONGRESS lx2.loc.gov: 210 LCDB</li>
84
	<li>LONDON PUBLIC LIBRARY catalogue.londonpubliclibrary.ca:210 INNOPAC</li>
85
	<li>MANITOBA PUBLIC library.gov.mb.ca:210 horizon</li>
86
	<li>MILTON PL cat.mpl.on.ca:210 horizon</li>
87
	<li>NATIONAL LIBRARY OF WALES cat.llgc.org.uk:210 default</li>
88
	<li>TORONTO PUBLIC symphony.torontopubliclibrary.ca:2200 unicorn</li>
89
	<li>TRI-UNI 129.97.129.194:7090 voyager</li>
90
	<li>VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon</li>
91
</ul>
92
93
<h2>Suggested Authority Z39.50 Targets</h2>
94
95
<p>The following targets have been used successfully by other Koha libraries:</p>
96
97
<ul>
98
	<li>LIBRARIESAUSTRALIA AUTHORITIES z3950-test.librariesaustralia.nla.gov.au:210 AuthTraining Userid: ANLEZ / Password: z39.50</li>
99
	<li>LIBRARY OF CONGRESS NAME AUTHORITIES lx2.loc.gov:210 NAF</li>
100
	<li>LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF</li>
101
</ul>
102
<p><strong>See the full documentation for Z39.50/SRU Servers in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/administration.html#z39.50/sru-servers">manual</a> (online).</strong></p>
103
104
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/authorities/authorities-home.tt (-20 lines)
Lines 1-20 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Authorities</h1>
4
5
<p>Authority records are a way of controlling fields in your MARC records. Using authority records will provide you with control over subject headings, personal names and places.</p>
6
7
<h2>Searching Authorities</h2>
8
9
<p>From the authorities page you can search for existing terms and the bibliographic records they are attached to.</p>
10
11
<p>From the results you will see the authority record, how many bibliographic records it is attached to, and a delete link (if there are not bibliographic records attached).</p>
12
13
<p>Clicking on the authority record summary will open the full record and the option to edit the record.</p>
14
15
<p>If the authority has See Alsos in it you will see those broken out on the search results, clicking the linked headings will run a search for that heading instead.</p>
16
17
<p><strong>See the full documentation for Authorities in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#authorities">manual</a> (online).</strong></p>
18
19
20
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/authorities/authorities.tt (-31 lines)
Lines 1-31 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h2>Adding Authorities</h2>
4
5
<p>To add a new authority record you can either choose the authority type from the 'New Authority' button or search another library by clicking the 'New from Z39.50' button.</p>
6
7
<p>If you choose to enter a new authority from scratch, the form that appears will allow you to enter all of the necessary details regarding your authority record.</p>
8
9
<p>To expand collapsed values simply click on the title and the subfields will appear. To duplicate a field or subfield just click the plus sign (+) to the right of the label. To use field helper plugins simply click the ellipsis (...) to the right of the field.</p>
10
11
<p>When linking authorities to other headings, you can use the authority finder plugin by clicking the ellipsis (...) to the right of the field.</p>
12
13
<p>From there you can search your authority file for the authority to link. If you can't find the authority to link, you can click the 'Create new' button and add the necessary authority for the link. This plugin also allows for you to choose the link relationship between the authorities.</p>
14
15
<p>If you choose to search another library for the authority record you will be presented with a search box</p>
16
17
<p>From the results you can choose the 'Import' link to the right of the record you would like to add to Koha</p>
18
19
<p>You will then be presented with the form to edit the authority before saving it to your system</p>
20
21
<h2>Editing Authorities</h2>
22
23
<p>Authorities can be edited by clicking on the authority summary from the search results and then clicking the 'Edit' button above the record.</p>
24
25
<p>Once you've made the necessary edits, simply click 'Save' and all of the records that use this authority record will be updated.</p>
26
27
<p>To delete an authority record you first must make sure it's not linked to any bibliographic records. If it is not used by any bibliographic records a 'Delete' link will appear to the right of the record on the search results and as a button that appears after clicking on the summary of the authority record.</p>
28
29
<p><strong>See the full documentation for Authorities in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#authorities">manual</a> (online).</strong></p>
30
31
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/authorities/detail.tt (-19 lines)
Lines 1-19 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Authorities</h1>
4
5
<p>Authority records are a way of controlling fields in your MARC records. Using authority records will provide you with control over subject headings, personal names and places.</p>
6
7
<h2>Searching Authorities</h2>
8
9
<p>From the authorities page you can search for existing terms and the bibliographic records they are attached to.</p>
10
11
<p>From the results you will see the authority record, how many bibliographic records it is attached to, and a delete link (if there are not bibliographic records attached).</p>
12
13
<p>Clicking on the authority record summary will open the full record and the option to edit the record.</p>
14
15
<p>If the authority has See Alsos in it you will see those broken out on the search results, clicking the linked headings will run a search for that heading instead.</p>
16
17
<p><strong>See the full documentation for Authorities in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#authorities">manual</a> (online).</strong></p>
18
19
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/authorities/merge.tt (-15 lines)
Lines 1-15 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Merge authorities</h1>
4
5
<p>From this screen you can choose to merge two authority records.</p>
6
7
<p>First you will be asked which of the two records you would like to keep as your primary record and which will be deleted after the merge.</p>
8
9
<p>You will be presented with the MARC for both of the records (each accessible by tabs labeled with the authority numbers for those records). By default the entire first record will be selected, uncheck the fields you don't want in the final (destination) record and then move on to the second tab to choose which fields should be in the final (destination) record.</p>
10
11
<p>Once you have completed your selections click the 'merge' button. The primary record will now contain the data you chose for it and the second record will be deleted.</p>
12
13
<p><strong>See the full documentation for Merging authorities in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#merging-authorities">manual</a> (online).</strong></p>
14
15
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/detail.tt (-9 lines)
Lines 1-9 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Record detail</h1>
4
5
<p>In Koha the bibliographic record contains the main information related to the material. This includes things like the title, author, ISBN, etc. This information is stored in Koha in Marc (different flavors of Marc are supported in Koha). Once this information is saved, items or holdings can be attached.</p>
6
7
<p><strong>See the full documentation for Cataloging in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#bibliographic-records">manual</a> (online).</strong></p>
8
9
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/issuehistory.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Checkout History</h1>
4
5
<p>Each bibliographic record keeps a circulation history (with or without the patron information depending on your settings), but each item also has its own circulation history page. To see this, click on the 'Items' tab to the left of the record you are viewing.</p>
6
7
<p>Below the 'History' heading is a link to 'View item's checkout history,' clicking that will open up the item's history which will look slightly different from the bibliographic record's history page.</p>
8
9
<p><strong>See the full documentation for Item Checkout History in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#item-specific-circulation-history">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/itemsearch.tt (-15 lines)
Lines 1-15 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Item Search</h1>
4
5
<p>If you are looking for specific items you can use the item search engine in the staff client to find them.</p>
6
7
<p>At the top of the advanced search page in the staff client you will see a link to 'Go to item search'</p>
8
9
<p>Clicking that link will open up a item specific search engine.</p>
10
11
<p>Using the search form that is presented you can find a list of specific items that can be output to the screen or to a CSV file. If your results are printed to the screen you will have the option to narrow your search further using filters at the top.</p>
12
13
<p><strong>See the full documentation for Searching in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/searching.html#item-searching">manual</a> (online).</strong></p>
14
15
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/moredetail.tt (-23 lines)
Lines 1-23 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Item Details</h1>
4
5
<p>This page provides information regarding all of the items attached to a record.</p>
6
7
<h2>Quick Item Status Updates</h2>
8
9
<p>Often circulation staff need to change the status of an item to Lost or Damaged. This doesn't require you to edit the entire item record. Instead clicking on the item barcode on the checkout summary or checkin history will bring you to an item summary. You can also get to the item summary by clicking on the Items tab to the left of the bib detail page.</p>
10
11
<p>From this view you can mark an item lost by choosing a lost status from the pull down and clicking the 'Set Status' button.</p>
12
13
<p>You can also mark an item as damaged by choosing a damaged status from the pull down and clicking the 'Set Status' button.</p>
14
15
<h2>Item Specific Circulation History</h2>
16
17
<p>Each bibliographic record keeps a circulation history (with or without the patron information depending on your settings), but each item also has its own circulation history page. To see this, click on the 'Items' tab to the left of the record you are viewing.</p>
18
19
<p>Below the 'History' heading is a link to 'View item's checkout history,' clicking that will open up the item's history which will look slightly different from the bibliographic record's history page.</p>
20
21
<p><strong>See the full documentation for Item Records in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#item-records">manual</a> (online).</strong></p>
22
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/search-history.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Search history</h1>
4
5
<p>If you have your EnableSearchHistory preference set to keep your search history then you can access this information by clicking on your username in the top right of the staff client and choosing 'Search history'.</p>
6
7
<p>From this page you will see your bibliographic search history and your authority search history.</p>
8
9
<p><strong>See the full documentation for Search History in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/plugins.html#search-history">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/search.tt (-83 lines)
Lines 1-83 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Searching</h1>
4
5
<p>Visit Administration > Global System Preference > Searching to control the settings for the Koha search.</p>
6
7
<h2>Some tips</h2>
8
9
<p>Use the AdvancedSearchTypes preference to control which tabs show for limiting to Item Type, Collection Code and/or Shelving location.</p>
10
11
<p>Use the AdvancedSearchLanguages preference to control which languages appear in the language pull down filter.</p>
12
13
<h2>Searching Subtypes on the Staff Client</h2>
14
15
<p>Below is a summary of  the various pieces of the advanced search limit: </p>
16
17
<h3>Audience</h3>
18
19
<p>The index name is 'aud' and it's derived from 008/22</p>
20
21
<ul><li>aud:a Preschool</li>
22
<li>aud:b Primary</li>
23
<li>aud:c Pre-Adolescent</li>
24
<li>aud:d Adolescent</li>
25
<li>aud:e Adult</li>
26
<li>aud:f Specialized</li>
27
<li>aud:g General</li>
28
<li>aud:j Juvenile</li></ul>
29
30
<h3>Content</h3>
31
32
<p>There are three indexes that comprise Content: 'fic' is derived from 003/33; 'bio' is derived from the 008/34 and 'mus' is derived from LEADER/06. Common values for each of these are:</p>
33
34
<ul><li>fic:1 Fiction</li>
35
<li>fic:0 Non-fiction</li>
36
<li>bio:b Biography</li>
37
<li>mus:j Musical recording</li>
38
<li>mus:i Non-musical recording</li></ul>
39
40
<h3>Format</h3>
41
42
<p>The index name is 'l-format' and it's an index of positions 007/01 and 007/02. Common values are:</p>
43
44
<ul><li>l-format:ta Regular print</li>
45
<li>l-format:tb Large print</li>
46
<li>l-format:fk Braille</li>
47
<li>l-format:sd CD audio</li>
48
<li>l-format:ss Cassette recording</li>
49
<li>l-format:vf VHS tape / Videocassette</li>
50
<li>l-format:vd DVD video / Videodisc</li>
51
<li>l-format:co CD Software</li>
52
<li>l-format:cr Website</li></ul>
53
54
<h3>Additional Content Types</h3>
55
56
<p>The index name is 'ctype' is taken from the 008 and it's where we get the 'additional content types'. It's position 008/24-28 field. Common values are: </p>
57
58
<ul><li>ctype:a Abstracts/summaries</li>
59
<li>ctype:b Bibliographies
60
<li>ctype:c Catalogs</li>
61
<li>ctype:d Dictionaries</li>
62
<li>ctype:e Encyclopedias</li>
63
<li>ctype:f Handbooks</li>
64
<li>ctype:g Legal articles</li>
65
<li>ctype:i Indexes
66
<li>ctype:j Patent document</li>
67
<li>ctype:k Discographies</li>
68
<li>ctype:l Legislation</li>
69
<li>ctype:m Theses</li>
70
<li>ctype:n Surveys</li>
71
<li>ctype:o Reviews
72
<li>ctype:p Programmed texts</li>
73
<li>ctype:q Filmographies</li>
74
<li>ctype:r Directories</li>
75
<li>ctype:s Statistics</li>
76
<li>ctype:t Technical reports</li>
77
<li>ctype:v Legal cases and case notes
78
<li>ctype:w Law reports and digests</li>
79
<li>ctype:z Treaties</li></ul>
80
81
<p><strong>See the full documentation for Searching in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/searching.html">manual</a> (online).</strong></p>
82
83
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/addbiblio.tt (-95 lines)
Lines 1-95 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Cataloging</h1>
4
5
<p>Records can be added to Koha via original or copy cataloging. If you would like to catalog a record using a blank template</p>
6
7
<ul>
8
    <li>Click 'New Record'
9
<ul>
10
    <li>Choose the framework you would like to base your record off of</li>
11
</ul>
12
</li>
13
</ul>
14
15
<p>If you want to catalog a record based on an existing record at another library</p>
16
17
<ul>
18
    <li>Click 'Z39.50/SRU Search'
19
<ul>
20
    <li>Search for the item you would like to catalog
21
<ul>
22
    <li>Tip: If no results are found, try searching for fewer fields, not all Z39.50/SRU targets can search all of the fields above.</li>
23
</ul>
24
</li>
25
    <li>Search targets can be altered by using the Z39.50/SRU Admin area.</li>
26
    <li>From the results you can view the MARC or Card view for the records or choose to Import them into Koha
27
<ul>
28
    <li>In addition to the Import link to the right of each title, you can click on the title you're interested in and a menu will pop up with links to preview the record and import it</li>
29
    <li>If you don't find the title you need in your Z39.50/SRU search results you can click the 'Try Another Search' button at the bottom left of your results</li>
30
</ul>
31
</li>
32
</ul>
33
</li>
34
</ul>
35
36
<p>Once you've opened a blank framework or imported a record via Z39.50/SRU you will be presented with the form to continue cataloging</p>
37
38
<ul>
39
    <li>To expand a collapsed tag click on the tag description</li>
40
    <li>If you would rather not see the MARC tag numbers you can change the value in your hide_marc system preference or each user can check the box next to 'Show tags' at the top of the editor.</li>
41
    <li>To get help from the Library of Congress on a MARC tag click the question mark (?) to the right of each field number
42
<ul>
43
    <li>If you feel that this clutters the screen you can hide the question marks by unchecking the box next to the 'Show MARC tag documentation links' note at the top right of the editor</li>
44
</ul>
45
</li>
46
    <li>Sometimes fields may not be editable due to the value in your BiblioAddsAuthorities system preference. If you have this preference set to not allow catalogers to type in fields controlled by authorities you may see a lock symbol to the left of the field.
47
<ul>
48
    <li>If this icon appears you must click the icon to the right of the field to search for an existing authority.</li>
49
    <li>From the results list click 'Choose authority' to bring that into your catalog record</li>
50
</ul>
51
</li>
52
    <li>To duplicate a field click on the 'repeat this tag' icon to the right of the tag
53
<ul>
54
    <li>To move subfields in to the right order, click the up arrow to the left of the field</li>
55
    <li>To duplicate a subfield click on the clone icon (to remove a copied field, click the delete clone icon) to the right of the field</li>
56
    <li>To remove a subfield (if there is more than one of the same type), click the - (minus sign) to the right of the field</li>
57
</ul>
58
</li>
59
    <li>To use a plugin click on the icon to the right of the filed
60
<ul>
61
    <li>Some fixed fields have editors that will change based on the material type you're cataloging (for example the 006 and the 008 fields)</li>
62
</ul>
63
</li>
64
    <li>Once you've finished, click the 'Save' button at the top and choose whether you want to save and view the bib record you have created or continue on to add/edit items attached to the record
65
<ul>
66
    <li>If you are about to add a duplicate record to the system you will be warned before saving</li>
67
</ul>
68
</li>
69
</ul>
70
71
<h2>Editing records</h2>
72
73
<p>To edit a record you can click 'Edit Biblio' from the search results on the cataloging page or by clicking the Edit button on the Bibliographic Record and choosing 'Edit record'</p>
74
75
<p>The record will open in the MARC editor</p>
76
77
<p>The alternative is to search via Z39.50/SRU to overlay your record with a fuller record found at another library. You can do this by choosing 'Replace record via Z39.50/SRU' from the 'Edit' menu.</p>
78
79
<p>Once you choose that you will be brought to a Z39.50/SRU search window to search other libraries for the record in question.</p>
80
81
<p>Once you have made your edits (via either method) you can click 'Save' at the top left of the editor.</p>
82
83
<h2>Duplicating records</h2>
84
85
<p>Sometimes a copy of the record you need to catalog can't be found via Z39.50/SRU. In these cases you can create a duplicate of similar record and edit the necessary pieces to create a new record. To duplicate an existing record click 'Edit as new (duplicate)' from the 'Edit' menu on the bibliographic record</p>
86
87
<p>This will open a new MARC record with the fields filled in with the values from the original bibliographic record.</p>
88
89
<h2>Merging records</h2>
90
91
<p>If you would like to merge together multiple records you can do that via the lists tool or from the cataloging search results.</p>
92
93
<p><strong>See the full documentation for Cataloging in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#bibliographic-records">manual</a> (online).</strong></p>
94
95
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/addbooks.tt (-35 lines)
Lines 1-35 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Cataloging</h1>
4
5
<p>Before you start cataloging in Koha you're going to want to do some basic setup. Refer to the Implementation Checklist for a full list of these things. Most importantly you're going to want to make sure that your Frameworks are all defined the way you want. Once in the cataloging module you will not be able to add or remove fields and subfields so your frameworks must be ready before you start cataloging.</p>
6
7
<p>From here you can add new bibliographic records to Koha.</p>
8
9
<p>Records can be added to Koha via original or copy cataloging. If you would like to catalog a record using a blank template</p>
10
11
<ul>
12
    <li>Click 'New Record'</li>
13
    <li>Choose the framework you would like to base your record off of</li>
14
</ul>
15
16
<p>If you want to catalog a record based on an existing record at another library</p>
17
18
<ul>
19
    <li>Click 'New from Z39.50/SRU' (optionally, you can choose a framework to which import the record by clicking the caret on the right).</li>
20
    <li>Search for the item you would like to catalog</li>
21
    <li>Tip: If no results are found, try searching for fewer fields, not all Z39.50/SRU targets can search all of the fields above.</li>
22
    <li>Search targets can be altered by using the Z39.50/SRU Admin area.</li>
23
    <li>From the results you can view the MARC or Card view for the records or choose to Import them into Koha
24
<ul>
25
    <li>In addition to the Import link to the right of each title, you can click on the title you're interested in and a menu will pop up with links to preview the record and import it</li>
26
</ul>
27
</li>
28
    <li>If you don't find the title you need in your Z39.50/SRU search results you can click the 'Try Another Search' button at the bottom left of your results</li>
29
</ul>
30
31
<p>Once you've opened a blank framework or imported a record via Z39.50/SRU you will be presented with the form to continue cataloging</p>
32
33
<p><strong>See the full documentation for Cataloging in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html">manual</a> (online).</strong></p>
34
35
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/additem.tt (-79 lines)
Lines 1-79 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h2>Adding items</h2>
4
5
<p>After saving a new bibliographic record, you will be redirected to a blank item record so that you can attach an item to the bibliographic record. You can also click 'Add holdings' from the cataloging search results or you can add new item at any time by clicking 'New' on the bibliographic record and choosing 'New item'</p>
6
7
<p>The item edit form will appear:</p>
8
9
<p>At the very least, if you plan on circulating the item, the following fields should be entered for new items:</p>
10
11
<ul>
12
	<li>2 - Source of classification</li>
13
	<li>a - Permanent location</li>
14
	<li>b - Shelving location</li>
15
	<li>o - Full call number</li>
16
	<li>p - Barcode</li>
17
	<li>v - Cost, replacement price
18
<ul>
19
	<li>This value will be charged to patrons when you mark and item they have checked out as 'Lost'</li>
20
</ul>
21
</li>
22
	<li>y - Koha item type</li>
23
</ul>
24
25
<p>To make sure that these values are filled in you can mark them as mandatory in the framework you're using and then they will appear in red with a 'required' label. The item will not save until the required fields are filled in.</p>
26
27
<p>Tip: To make item subfields required in a framework you'll want to edit the 952 field in the framework editor.</p>
28
29
<p>Below the add form there are 3 buttons for adding the item</p>
30
31
<ul>
32
    <li>'Add item' will add just the one item</li>
33
    <li>'Add &amp; duplicate' will add the item and fill in a new form with the same values for your to alter</li>
34
    <li>'Add multiple items' will ask how many items and will then add that number of items adding +1 to the barcode so each barcode is unique</li>
35
</ul>
36
37
<p>Your added items will appear above the add form once submitted</p>
38
39
<p>Your items will also appear below the bibliographic details on the bib record display.</p>
40
41
<p>If you have SpineLabelShowPrintOnBibDetails set to 'Display' then there will also be a link to print a quick spine label next to each item.</p>
42
43
<h2>Editing items</h2>
44
45
<p>Items can be edited in several ways.</p>
46
47
<ul>
48
    <li>Clicking 'Edit' and 'Edit Items' from the bibliographic record
49
<ul>
50
    <li>Which will open up a list of items where you can click 'Edit' to the left of the specific item you would like to edit.</li>
51
</ul>
52
</li>
53
    <li>Clicking 'Edit Items' beside the item on the 'Items' tab
54
<ul>
55
    <li>Which will open up a list of items where you can click 'Edit' to the left of the specific item you would like to edit.</li>
56
</ul>
57
</li>
58
    <li>Clicking 'Edit' and then 'Edit items in batch'
59
<ul>
60
    <li>This will open up the batch item modification tool where you can edit all of the items on this record as a batch.</li>
61
</ul>
62
</li>
63
</ul>
64
65
<p>The edit menu is also where items can be deleted from</p>
66
67
<h2>Deleting items</h2>
68
69
<p>There are many ways to delete item records. If you only need to delete one item you can do this by opening up the detail page for the bib record and clicking the 'Edit' button at the top. From there you can choose to 'Edit items'.</p>
70
71
<p>You will be presented with a list of items and next to each one will be a link labeled 'Delete'. Click that link and if the item is not checked out it will delete that item.</p>
72
73
<p>If you know that all of the items attached to your record are not currently checked out you can use the 'Delete all items' option under the 'Edit menu' and it will remove all items from the record.</p>
74
75
<p>Finally you can use the batch delete tool to delete a batch of items.</p>
76
77
<p><strong>See the full documentation for Adding/Editing Items in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#item-records">manual</a> (online).</strong></p>
78
79
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/linkitem.tt (-32 lines)
Lines 1-32 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Analytics</h1>
4
5
<p>Libraries sometimes make journal articles and articles within monographs and serials accessible to library patrons through analytics cataloging. Analytics cataloging creates separate bibliographic records for these articles, chapters, sections, etc. found within a larger resource such as a book, an article within a journal, newspaper or serial. In analytics cataloging, although a separate bib record is created for the title, it is not physically separated from the host item.  Learn more about Analytics in Chapter 13 of AACR2.</p>
6
7
<p>If you would like to catalog analytic records in Koha you first need to update the EasyAnalyticalRecords preference to 'Display.'</p>
8
9
<p>After cataloging your analytic record (see Adding Records for more on creating records) click 'Edit' from the normal view and choose to 'Link to Host Item'</p>
10
11
<p>This will prompt you to enter the barcode for the item this record should be linked to.</p>
12
13
<p>After entering the item's barcode and clicking 'Select' you will receive a confirmation message.</p>
14
15
<p>The record will now have the 773 field filled in properly to complete the link.</p>
16
17
<p>If you have linked an analytic record incorrectly you can remove that link by editing the item on the analytic record (not the host record). To do this, go to the analytic record and click the 'Edit' button and choose to 'Edit items'. To the left of each item you will see two options.</p>
18
19
<ul>
20
    <li>Clicking 'Edit in Host' will allow you to edit the item on the host record.</li>
21
    <li>Clicking 'Delink' will remove the 773 field and the link between the analytic and the host.</li>
22
</ul>
23
24
<p>To view all of the items tied to the host record, do a search for the record, click the Analytics tab on the left and the analytics tied to each barcode will be shown under the "Used in" column.</p>
25
26
<p>Tip: It is also possible to create analytic records from this screen by clicking on "Create Analytics"</p>
27
28
<p>You can also see the analytics attached to this record by clicking the 'Show Analytic' link towards the top of the record in the normal view.</p>
29
30
<p><strong>See the full documentation for Analytics in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#adding-analytic-records">manual</a> (online).</strong></p>
31
32
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/merge.tt (-24 lines)
Lines 1-24 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Merging items</h1>
4
5
<p>To merge bibliographic records together you will want to go to the Cataloging module and perform a search.</p>
6
7
<p>If you see duplicates on that search results screen you can check the boxes next to the duplicates and click the 'Merge selected' button at the top of the results. If you choose more than or fewer than 2, you will be presented with an error.</p>
8
9
<p>Once you have selected the records you want to merge, click the 'Merge selected' button at the top of the list. You will be asked which of the two records you would like to keep as your primary record and which will be deleted after the merge. If the records were created using different frameworks, Koha will also ask you what Framework you would like the newly merged record to use.</p>
10
11
<p>You will be presented with the MARC for both of the records (each accessible by tabs labeled with the bib numbers for those records). By default the entire first record will be selected, uncheck the fields you don't want in the final (destination) record and then move on to the second tab to choose which fields should be in the final (destination) record.</p>
12
13
<p>Should you try to add a field that is not repeatable two times (like choosing the 245 field from both record #1 and #2) you will be presented with an error.</p>
14
15
<p>Once you have completed your selections click the 'merge' button. The primary record will now CONTAIN the data you chose for it as well as all of the items/holdings from both bib records, and the second record will be deleted.</p>
16
Important
17
18
<p>It is important to rebuild your zebra index immediately after merging records. If a search is performed for a record which has been deleted Koha will present the patrons with an error in the OPAC.</p>
19
20
<p>Note: If you would like you can also use the Lists tool for merging records together.</p>
21
22
<p><strong>See the full documentation for Merging Items in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#merging-records">manual</a> (online).</strong></p>
23
24
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/moveitem.tt (-15 lines)
Lines 1-15 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Moving items</h1>
4
5
<p>Items can be moved from one bibliographic record to another using the 'Attach item' option</p>
6
7
<p>Visit the bibliographic record you want to attach the item to and choose 'Attach item' from the 'Edit' menu.</p>
8
9
<p>Simply enter the barcode for the item you want to move and click 'Select'</p>
10
11
<p>If you want to move all items to a new record creating only one bibliographic record you can use the 'Merge records' tool instead.</p>
12
13
<p><strong>See the full documentation for Moving Items in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/cataloging.html#moving-items">manual</a> (online).</strong></p>
14
15
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/branchoverdues.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
	   
3
<h1>Overdues with fines</h1>
4
5
<p>This report will show you any overdues at your library that have accrued fines on them.</p>
6
7
<p>If you would like to limit the report you can use the pull down menu at the top to limit to a specific shelving location at your library. To see overdues with fines at other libraries you will have to change your library or log in at that library.</p>
8
9
<p style="color: #990000">Important: If you do not charge fines and/or don't have the fines cron job running you will see no data on this report.</p>
10
11
<p><strong>See the full documentation for Overdues with Fines in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#overdues-with-fines">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/branchtransfers.tt (-26 lines)
Lines 1-26 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Transfers</h1>
4
5
<p>If you work in a multi-library system you can transfer items from one library to another by using the Transfer tool. To transfer an item</p>
6
7
<ul>
8
	<li>Click 'Transfer' on the Circulation page
9
<ul>
10
	<li>Enter the library you would like to transfer the item to</li>
11
	<li>Scan or type the barcode on the item you would like to transfer</li>
12
</ul>
13
</li>
14
	<li>Click 'Submit'</li>
15
	<li>The item will now say that it is in transit</li>
16
	<li>When the item arrives at the other library the librarian must check the item in to acknowledge that it is no longer in transit</li>
17
	<li>The item will not be permanently moved to the new library
18
<ul>
19
    <li>The item shows the same 'Home Library' but has updated the 'Current Location' to note where it resides at this time</li>
20
</ul>
21
</li>
22
</ul>
23
24
<p><strong>See the full documentation for Transfers in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#transfers">manual</a> (online).</strong></p>
25
26
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation-home.tt (-26 lines)
Lines 1-26 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
 
3
<h1>Circulation</h1>
4
5
<p>Circulation functions can be accessed in several different ways. On the main page of the staff client there are some quick links in the center of the page to check items out, in or transfer them. For a complete listing of Circulation functions you can visit the Circulation page which is linked from the top left of every page or from the center of the main page.</p>
6
7
<p>Before circulating your collection you will want to set your Global System Preferences, Basic Parameters and Patrons &amp; Circulation Rules.</p>
8
9
<p>While in Circulation you can jump between the tabs on the quick search box at the top of the screen by using the following hot keys:</p>
10
11
<ul>
12
	<li>jump to the catalog search with Alt+Q</li>
13
	<li>jump to the checkout with Alt+U
14
	<ul>
15
		<li>this will not work for Mac user</li>
16
	</ul>
17
	</li>
18
	<li>jump to the checkin with Alt+R</li>
19
        <li>jump to the renew tab with Alt+W</li>
20
</ul>
21
22
<p style="background-color: #ffe599">Tip: Mac users use the OPTION button in place of ALT</p>
23
24
<p><strong>See the full documentation for Circulation in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html">manual</a> (online).</strong></p>
25
26
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/circulation.tt (-167 lines)
Lines 1-167 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Checking out (Issuing)</h1>
4
5
<p>To check an item out to a patron, first search for that patron using one of the many options listed above. You will then be presented with the checkout screen.</p>
6
7
<p>If you have chosen to 'Always show checkouts immediately' then you will see the list of checkouts below the check out box.</p>
8
9
<p>At the top of the Check Out screen is a box for you to type or scan the item's barcode into.
10
11
<ul>
12
    <li style="color: #990000">Important: Many modern barcode scanners will send a 'return' to the browser, making it so that the 'Check Out' button is automatically clicked</li>
13
</ul>
14
<ul>
15
	<li>If the barcode is not found you will be prompted to use fast cataloging to add the item. Learn more about fast cataloging later in this manual.</li>
16
	<li>If you have itemBarcodeFallbackSearch set to 'Enable' then you can enter a keyword search in this box instead of just a barcode (this will make it possible to check out using title and/or call number).</li>
17
</ul>
18
19
<p>Below the box for the barcode you will see a checkbox for 'Automatic renewal'. This will allow this item to automatically renew if the appropriate cron job is running and there are no holds on the item.</p>
20
21
<p>Below the box for the barcode there may be options for you to override the default due date for the item.</p>
22
23
<ul>
24
	<li>This option will only appear if you have set the SpecifyDueDate system preference to allow staff to override the due date</li>
25
</ul>
26
27
<p>If you're allowing the checkout of items on site to patrons (these are usually items that are not for loan that you would like to check for in library use) then you will see the 'On-site checkout' checkbox.</p>
28
29
<p>At the bottom of the page there is a summary of the patron's current checked out items along with the due date (and time if the item is an hourly loan), items checked out today will appear at the top.</p>
30
31
<p style="background-color: #ffe599"><strong>Tip</strong> If the checked out time is listed as 00:00 then the item is a daily loan item. The due time for daily checkouts will show 23:59 which is the last minute of the day.</p>
32
33
<p>If you checked out an item for on site use you will see that highlighted in red in the checkout summary.</p>
34
35
<p>If you have set your ExportCircHistory preference, you will also see the option to export the patron's current checkout information using a CSV Profile or ISO2709 (MARC21) format.</p>
36
37
<p>Also at the bottom of the page is the list of items the patron has on hold</p>
38
39
<p>From the holds list you can suspend or resume patrons holds using the options at the bottom of the list if you have the SuspendHoldsIntranet preference set to 'allow.'</p>
40
41
<p>Note: If you have your AutoResumeSuspendedHolds preference set to "Don't allow" then you will not have the option to put an end date on the hold suspension.</p>
42
43
<p>If there are notes on the patron record these will appear to the right of the checkout box</p>
44
45
<p>If the patron has a hold waiting at the library that too will appear to the right of the check out box making it easy for the circulation librarian to see that there is another item to give the patron</p>
46
47
<p>The details of the checkouts will appear on the bib detail page in the staff client as well.</p>
48
49
<h3>Printing Receipts</h3>
50
51
<p>Once you have checked out all of the items for the patron you can print them a receipt by choosing one of two methods.</p>
52
53
<p>If you have the CircAutoPrintQuickSlip preference set to 'open a print quick slip window' or 'open a print slip window' you can simply hit enter on your keyboard or scan a blank piece of paper with your barcode scanner. The idea being that you're "checking out" a blank barcode which triggers Koha to print the 'Quick slip' or the 'Slip.'</p>
54
55
<p>You can also click the Print button at the top of the screen and choose 'Print slip' or 'Print quick slip'.</p>
56
57
<p>If you choose 'Print slip' it will print all of the items the patron has checked out, including those they checked out at an earlier date. Choosing 'Print quick slip' will print only the items that were checked out today.</p>
58
59
<p>What prints on the slips can be customized by altering the slip templates under the Notices & Slips tool.</p>
60
61
<h3>Clear Patron Information</h3>
62
63
<p>When you're done checking an item out if you have the DisplayClearScreenButton preference set to 'Show' you can clear the current patron by clicking the X in the top right of the patron's info to remove the current patron from the screen and start over.</p>
64
65
<p>If you have the CircAutoPrintQuickSlip preference set to 'clear the screen' then you simply need to hit enter or scan a blank barcode and the screen will be cleared of the current patron.</p>
66
67
<h2>Check Out Messages</h2>
68
69
<p>If you check out an item that has multiple pieces and you have cataloged that information in subfield 3 of the item record (in MARC21) a message will pop up when you check out that item telling you how many pieces should be there.</p>
70
71
<p>There are times when Koha will prevent the librarian from being able to check out items to a patron. When this happens a warning will appear notifying the librarian of why the patron cannot check items out.</p>
72
73
<ul>
74
	<li>Patron owes too much in fines
75
<ul>
76
	<li>You can set the amount at which patron checkouts are blocked with the noissuescharge system preference</li>
77
</ul>
78
</li>
79
	<li>Patron has a restriction on their account
80
<ul>
81
    <li>This can be set by the librarian editing a patron record and adding a restriction or by the Overdue/Notice Status Triggers</li>
82
83
    <li>If the staff member has the right permission they can override the restriction temporarily</li>
84
</ul>
85
</li>
86
	<li>Patron needs to confirm their address
87
<ul>
88
	<li>This can be set by the librarian editing a patron record and adding a flag</li>
89
</ul>
90
</li>
91
	<li>Patrons has lost their library card
92
<ul>
93
	<li>This can be set by the librarian editing a patron record and adding a flag</li>
94
</ul>
95
</li>
96
</ul>
97
98
<h2>Check Out Warnings</h2>
99
100
<p>Sometimes checkouts will trigger warning messages that will appear in a yellow box above the check out field. These warnings need to be acknowledged before you will be able to continue checking items out.</p>
101
102
<ul>
103
	<li>Patron has outstanding fines</li>
104
	<li>Item on hold for someone else</li>
105
	<li>Item should be on the hold shelf waiting for someone else</li>
106
	<li>Item already checked out to this patron</li>
107
	<li>Item checked out to another patron</li>
108
	<li>Item not for loan</li>
109
	<li>Patron has too many things checked out</li>
110
	<li>Item cannot be renewed
111
<ul>
112
	<li>This can be overridden with the AllowRenewalLimitOverride system preference</li>
113
</ul>
114
</li>
115
    <li>Barcode not found
116
<ul>
117
    <li>Learn more about fast cataloging later in this file.</li>
118
</ul>
119
</li>
120
    <li>Item being checked out is marked as 'lost'
121
<ul>
122
    <li>Depending on the value in your IssueLostItem preference, you may just see a warning or a confirmation box</li>
123
</ul>
124
</li>
125
    <li>Item being checked out is not recommended for a patron of this age</li>
126
    <li>Item being checked out meets the decreaseLoanHighHolds system preference criteria</li>
127
</ul>
128
129
<h2>Fast Add Cataloging</h2>
130
131
<p>Sometimes circulation librarians need to quickly add a record to the system for an item they are about to check out. This is called 'Fast Add.' To allow circulation librarians access to the Fast Add Cataloging tool, simply make sure they have the fast_cataloging permissions. There are two ways to add titles via fast add. If you know that you're about to check out an item that isn't in you catalog you can go to the Circulation module and click 'Fast cataloging.'</p>
132
133
<p>The cataloging interface will open up with the short cataloging record</p>
134
135
<p>After adding your cataloging data you will be asked to enter item data. Enter the items barcode, collection code, etc and save the item before checking it out.</p>
136
137
<p>The other way to fast catalog is from the checkout screen. When you enter a barcode at checkout that Koha can't find, it will prompt you to use fast cataloging to add the item to Koha and check it out.</p>
138
139
<p>Clicking 'Fast cataloging' will bring you to the fast cataloging form where you can enter the title information</p>
140
141
<p>After clicking 'Save' you will be brought to the item record where the barcode will already be filled in with the barcode you're trying to check out.</p>
142
143
<p>After clicking the 'Add item' button the item will automatically be checked out the patron you were trying to check the book out to originally.</p>
144
145
<h2>Circulation Messages</h2>
146
147
<p>Circulation messages are short messages that librarians can leave for their patrons or their colleagues that will appear at the time of circulation.</p>
148
149
<h3>Setting up Messages</h3>
150
151
<p>Circulation messages are set up as Authorized Values. To add or edit Circulation Messages you want to work with the BOR_NOTES value.</p>
152
153
<h3>Adding a Message</h3>
154
155
<p>When on the patron's check out tab you will see a link to 'Add a new message' to the right of the check out box.</p>
156
157
<p>When you click 'Add a new message' you will be asked to choose if the message is for the librarians or the patron and the message you would like to leave.</p>
158
159
<h3>Viewing Messages</h3>
160
161
<p>Circulation messages meant for the staff will appear on the patron's checkout screen.</p>
162
163
<p>Circulation messages meant for the patron will appear when they log into the OPAC.</p>
164
165
<p><strong>See the full documentation for Checking Out in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#check-out-(issuing)">manual</a> (online).</strong></p>
166
167
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/offline.tt (-37 lines)
Lines 1-37 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Offline Circulation</h1>
4
5
<p>If the AllowOfflineCirculation preference is set to 'Enable' the library staff can continue to perform circulation actions within Koha when the system is offline.
6
7
<h2>Setup</h2>
8
9
<p>Before the first time the system goes offline go to Circulation and choose 'Built-in offline circulation interface'</p>
10
11
<p>And synchronize your data on every circulation computer by clicking the 'Synchronize' link on the right of the screen.</p>
12
13
<p>This will allow you download a local copy of your patrons and circulation data. Click the 'Download records' link at the top of the page to synchronize your data.</p>
14
15
<p>Once your data is downloaded you will see the dates your data was last synced to the right of each data set.</p>
16
17
<p>This should be done regularly in preparation for any unexpected connection losses.</p>
18
19
<h2>Circulating</h2>
20
21
<p>When your system goes offline visit the Offline Circulation page in Koha and click 'Check out' or 'Check in' to perform offline actions.</p>
22
23
<p>Checking out is done by searching for the patron by barcode or name at the top of the 'Check out' screen. After selecting a patron you will be presented with the synced patron info, including fines and check outs.</p>
24
25
<p>Scan the barcode of the item you would like to check out and enter a due date. If you don't enter a due date Koha will prompt you for one.</p>
26
27
<p>Once the item is checked out it will appear below the patron's info.</p>
28
29
<p>Once the system is back online visit the Synchronize page on the Offline Circulation module and click 'Upload transactions'</p>
30
31
<h2>Upload transactions</h2>
32
33
<p>After the files are uploaded you can click 'View pending offline circulation actions' on the right to process the actions.</p>
34
35
<p><strong>See the full documentation for Offline Circulation in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#offline-circulation-in-koha">manual</a> (online).</strong></p>
36
37
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/on-site_checkouts.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Pending on-site checkouts</h1>
4
5
<p>If you are using the on site checkouts functionality (OnSiteCheckouts) then you'll have a report to view all items that are currently checked out on site.</p>
6
7
<p>This will list the due date (overdues in red), who has the item, item information and what library the item is at.</p>
8
9
<p><strong>See the full documentation for Pending on-site checkouts in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#pending-on-site-checkouts">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/overdue.tt (-16 lines)
Lines 1-16 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Overdues</h1>
4
5
<p>This report will list all items that are overdue at your library.</p>
6
7
<p>The report can be filtered using the menu options found on the left of the report.</p>
8
9
<p style="color: #990000">Important: For libraries with a large patron base, this report may take a significant amount of time to run.</p>
10
<ul>
11
	<li style="background-color: #ffe599">Tip: Large libraries can choose to filter the report before it runs by setting the FilterBeforeOverdueReport system preference to 'Require'.</li>
12
</ul>
13
14
<p><strong>See the full documentation for Overdues in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#overdues">manual</a> (online).</strong></p>
15
16
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/pendingreserves.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Holds to pull</h1>
4
5
<p>This report will show you all of the items that have holds on them that are available at the library for pulling. If the items are available at multiple libraries then all libraries with that item available will see the hold to pull until one library triggers the hold.</p>
6
7
<p>You can limit the results you see by using the Refine box on the left side of the page</p>
8
9
<p><strong>See the full documentation for Holds to Pull in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#holds-to-pull">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/renew.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Renew</h1>
4
5
<p>Checked out items can be renewed (checked out for another period of time) based on your circulation rules and renewal preferences.</p>
6
7
<p>To renew an item from this page you scan the barcodes of the items you would like to renew.</p>
8
9
<p>If the barcode is not found or the item is not actually checked out you will be presented with an error. Otherwise the item is renewed and you will receive a confirmation message.</p>
10
11
<p><strong>See the full documentation for Renewing in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#renewing">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/reserveratios.tt (-9 lines)
Lines 1-9 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Hold ratios</h1>
4
5
<p>Hold ratios help with collection development. Using this report you will be able to see how many of your patrons have holds on items and whether you should buy more. By default it will be set to the library needing 3 items per hold that has been placed. The report will tell you how many additional items need to be purchased to meet this quota.</p>
6
7
<p><strong>See the full documentation for Hold Ratios in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#hold-ratios">manual</a> (online).</strong></p>
8
9
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/returns.tt (-79 lines)
Lines 1-79 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Checking in (Returning)</h1>
4
5
<p>Checking in items can be performed from various different locations</p>
6
7
<ul>
8
    <li>The check in box on the top of the main staff client</li>
9
	<li>The check in option on the quick search bar on the Circulation page</li>
10
	<li>The check in link on the patron's checkout summary (and on the checkout summary page)</li>
11
    <li>The Check in page under the Circulation menu</li>
12
</ul>
13
14
<h3>Checking Items In</h3>
15
16
<p>To check an item in scan the barcode for the item into the box provided. A summary of all items checked in will appear below the checkin box</p>
17
18
<p>If you are checking items in that were put in the book drop while the library was closed you can check the 'Book drop mode' box before scanning items. This will effectively roll back the returned date to the last date the library was open.</p>
19
20
<ul>
21
    <li>This requires that you have your closings added to the Holidays & Calendar Tool</li>
22
</ul>
23
24
<p>You can also choose to forgive all overdue charges for items you are checking in by checking the 'Forgive overdue charges' box before scanning items.</p>
25
26
<p>If you have the SpecifyReturnDate preference set to 'Allow' you will be able to arbitrarily set the return date from below the check in box.</p>
27
28
<h3>Check In Messages</h3>
29
30
<p>There are several messages that can appear when checking items in:</p>
31
32
<ul>
33
	<li>If you are checking an item in at a library other than the home branch, a message will appear asking you to transfer the book to the home library
34
<ul>
35
	<li>After this item is checked in the status of the item will be changed in the catalog to 'in transit'</li>
36
	<li>To mark an item as back at the home branch, check the item in at the home branch
37
<ul>
38
	<li>A message will appear tell you that the item is not checked out, but the status will now say available in the catalog. This step is necessary to mark items as received by the home branch.</li>
39
</ul>
40
</li>
41
</ul>
42
</li>
43
	<li>If you are checking in an item that should have multiple parts or pieces a message will appear warning you about the number of pieces you should have in your hand</li>
44
	<li>If you're checking an item in that has a hold on it, you will be prompted to confirm the hold
45
<ul>
46
	<li>Clicking the Confirm hold button will mark the item as waiting for pickup from the library</li>
47
	<li>Clicking the Print Slip and Confirm button will mark the item as waiting for pickup at the library and present the library with a receipt to print and place on the book with the patron's information</li>
48
	<li>Ignoring the hold will leave the item on hold, but leave its status as Available (it will not cancel the hold)</li>
49
</ul>
50
</li>
51
	<li>If you're checking in an item that has a hold on it at another branch you will be prompted to confirm and transfer the item
52
<ul>
53
	<li>Clicking the Confirm hold and Transfer button will mark the item as in transit to the library where the hold was placed</li>
54
	<li>Clicking the Print Slip, Transfer and Confirm button will mark the item as in transit to the library where the hold was placed and present the library with a receipt to print and place on the book with the patron's information</li>
55
	<li>Ignoring the hold will leave the item on hold, but leave its status as Available (it will not cancel the hold)</li>
56
</ul>
57
</li>
58
	<li>If you have the system showing you fines at the time of checkin (FineNotifyAtCheckin) you will see a message telling you about the fine and providing you a link to the payment page for that patron</li>
59
</ul>
60
61
<h2>Receiving Holds</h2>
62
63
<p>When items that are on hold are checked in or out the system will remind the circulation librarian that the item is on hold and offer them options for managing the hold.</p>
64
65
<p>When you check in an item that has a hold on it the system will ask you to either confirm and transfer the item or just confirm the hold</p>
66
67
<p>Clicking the Confirm button will mark the item as on hold for the patron. If the item needs to be transferred the item will also be marked as in transit to the proper library. Clicking 'Ignore' will retain the hold, but allow you to check the item out to another patron. Choosing to confirm and print will present you with a printable page that you can slip inside the book with the necessary hold and/or transfer information.</p>
68
69
<p>Once confirmed the hold will show on the patron record and on the checkout screen under the 'Hold' tab.</p>
70
71
<p>The item record will also show that the item is on hold.</p>
72
73
<p>In some cases a patron may come in to pick up a hold for their partner (or someone else in their household). In this case you want to make sure that the hold is cancelled when you check the item out to someone else. When trying to check out an item that is already waiting for someone else you will be presented with a warning message.</p>
74
75
<p>From here you can check the item out to the patron at the desk and cancel the hold for the patron.</p>
76
77
<p><strong>See the full documentation for Checking In in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#check-in-returning">manual</a> (online).</strong></p>
78
79
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/selectbranchprinter.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Set library</h1>
4
5
<p>By default you will enter the staff client as if you are at your home library. This library will appear in the top right of the Staff Client.</p>
6
7
<p>This is the library that all circulation transactions will take place at. If you are at another library (or on a bookmobile) you will want to set your library before you start circulating items. To do this you can click 'Set' at the top right or on the Circulation page.</p>
8
9
<p>Once you have saved your changes you new library will appear in the top right.</p>
10
11
<p><strong>See the full documentation for Setting your Library in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#set-library">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/transferstoreceive.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Transfers to receive</h1>
4
5
<p>This report will list all of the items that Koha thinks are in transit to your library.</p>
6
7
<p>If your transfers are late in arriving at your library you will see a message stating how late your items are.</p>
8
9
<p style="color: #990000">Important: An item is considered late based on the number of days you have entered in the TransfersMaxDaysWarning system preference.</p>
10
11
<p><strong>See the full documentation for Transfers to Receive in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#transfers-to-receive">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/view_holdsqueue.tt (-23 lines)
Lines 1-23 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Holds queue</h1>
4
5
<p>This report will show you all of the holds at your library.</p>
6
7
<p>To generate this report, you must have the Build Holds Queue cron job running. This cron job is a script that should be run periodically if your library system allows borrowers to place on-shelf holds. This script decides which library should be responsible for fulfilling a given hold request.</p>
8
9
<p>It's behavior is controlled by the system preferences StaticHoldsQueueWeight and RandomizeHoldsQueueWeight.</p>
10
11
<p>If you do not want all of your libraries to participate in the on-shelf holds fulfillment process, you should list the the libraries that *do* participate in the process here by inputting all the participating library's branchcodes, separated by commas ( e.g. "MPL,CPL,SPL,BML" etc. ).</p>
12
13
<p>By default, the holds queue will be generated such that the system will first attempt to hold fulfillment using items already at the pickup library if possible. If there are no items available at the pickup library to fill a hold, build_holds_queue.pl will then use the list of libraries defined in StaticHoldsQueueWeight. If RandomizeHoldsQueueWeight is disabled ( which it is by default ), the script will assign fulfillment requests in the order the libraries are placed in the StaticHoldsQueueWeight system preference.</p>
14
15
<p>For example, if your system has three libraries, of varying sizes ( small, medium and large ) and you want the burden of holds fulfillment to be on larger libraries before smaller libraries, you would want StaticHoldsQueueWeight to look something like "LRG,MED,SML".</p>
16
17
<p>If you want the burden of holds fulfillment to be spread out equally throughout your library system, simply enable RandomizeHoldsQueueWeight. When this system preference is enabled, the order in which libraries will be requested to fulfill an on-shelf hold will be randomized each time the list is regenerated.</p>
18
19
<p>Leaving StaticHoldsQueueWeight empty is contraindicated at this time. Doing so will cause the build_holds_queue script to ignore RandomizeHoldsQueueWeight, causing the script to request hold fulfillment not randomly, but by alphabetical order.</p>
20
21
<p><strong>See the full documentation for the Holds Queue in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#holds-queue">manual</a> (online).</strong></p>
22
23
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/circ/waitingreserves.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Holds awaiting pickup</h1>
4
5
<p>This report will show all of the holds that are waiting for patrons to pick them up.</p>
6
7
<p>Items that have been on the hold shelf longer than you normally allow (based on the ReservesMaxPickUpDelay preference value) will appear on the 'Holds Over' tab, they will not automatically be cancelled unless you have set the cron job to do that for you, but you can cancel all holds using the button at the top of the list.</p>
8
9
<p><strong>See the full documentation for Holds Awaiting Pickup in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/circulation.html#holds-awaiting-pickup">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/course_reserves/add_items.tt (-15 lines)
Lines 1-15 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Add/edit course items</h1>
4
5
<p>Before adding reserve materials you will need at least one course to add them to. To add materials visit the Course Reserves module.</p>
6
7
<p>Click on the title of the course you would like to add materials to.</p>
8
9
<p>At the top of the course description click the 'Add reserves' button to add titles to this reserve list. You will be asked to enter the barcode for the reserve item.</p>
10
11
<p>After you are done scanning the barcodes to add to the course you can see them on the course page.</p>
12
13
<p><strong>See the full documentation for adding items to Course reserves in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/course_reserves.html">manual</a> (online).</strong></p>
14
15
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/course_reserves/course-details.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Course details</h1>
4
5
<p>The course reserves module in Koha allows you to temporarily move items to 'reserve' and assign different circulation rules to these items while they are being used for a specific course.</p>
6
7
<p>The details page will show you the items you have on reserve for your course. From here you can add/remove items and edit the course.</p>
8
9
<p><strong>See the full documentation for Course reserves in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/course_reserves.html">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/course_reserves/course-reserves.tt (-21 lines)
Lines 1-21 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Course reserves</h1>
4
5
<p>The course reserves module in Koha allows you to temporarily move items to 'reserve' and assign different circulation rules to these items while they are being used for a specific course.</p>
6
7
<h2>Course Reserves Setup</h2>
8
9
<p>Before using Course Reserves you will need to do some set up.</p>
10
11
<p>First you will need to enable course reserves by setting the UseCourseReserves preference to 'Use'.</p>
12
13
<p>Next you will need to have all of your course instructors added as patrons.</p>
14
15
<p>Next you will want to add a couple of new authorized values for Departments and Terms.</p>
16
17
<p>You may also want to create new item types, collection codes and/or shelving locations to make it clear that the items are on reserve to your patrons. You will also want to be sure to confirm that your circulation and fine rules are right for your new item types (whether they be hourly or daily loans).</p>
18
19
<p><strong>See the full documentation for Course reserves in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/course_reserves.html">manual</a> (online).</strong></p>
20
21
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/course_reserves/course.tt (-19 lines)
Lines 1-19 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Add/edit a course</h1>
4
5
<p>Once you have completed your set up for Course Reserves you can start creating courses and adding titles to the reserve list.</p>
6
7
<p>From the main course reserves page you can add a new course by clicking the 'New course' button at the top left.</p>
8
9
<p>Your new course will need a Department, Number and Name at the bare minimum. You can also add in additional details like course section number and term. To link an instructor to this course simply start typing their name and Koha will search your patron database to find you the right person.</p>
10
11
<p>Once the instructor you want appears just click their name and they will be added. You can repeat this for all instructors on this course. Each instructor will appear above the search box and can be removed by clicking the 'Remove' link to the right of their name.</p>
12
13
<p>If you would like your course to show publicly you'll want to be sure to check the 'Enabled?' box before saving your new course.</p>
14
15
<p>Once your course is saved it will show on the main course reserves page and be searchable by any field in the course.</p>
16
17
<p><strong>See the full documentation for adding Course reserves in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/course_reserves.html#adding-courses">manual</a> (online).</strong></p>
18
19
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/edithelp.tt (-44 lines)
Lines 1-44 Link Here
1
[% USE Asset %]
2
[% INCLUDE 'doc-head-open.inc' %]
3
<title>Online help</title>
4
[% Asset.js("lib/tiny_mce/tiny_mce.js") %]
5
<script type="text/javascript">//<![CDATA[
6
tinyMCE.baseURL = "[% interface %]/lib/tiny_mce";
7
tinyMCE.init({
8
	mode : "textareas",
9
        theme : "advanced",
10
    content_css : "[% interface %]/[% theme %]/css/tinymce.css",
11
    plugins : "table,save,advhr,advlink,searchreplace,print,contextmenu",
12
        theme_advanced_disable : "underline,strikethrough,styleselect,image",
13
	theme_advanced_buttons1_add_before : "save,|",
14
	theme_advanced_buttons2_add_before: "cut,copy,paste,|,search,replace,|",
15
	theme_advanced_buttons3_add_before : "tablecontrols,|",
16
    theme_advanced_buttons3_add : "advhr,|,print",
17
	theme_advanced_toolbar_location : "top",
18
	theme_advanced_toolbar_align : "left",
19
	theme_advanced_path_location : "bottom",
20
	plugin_insertdate_dateFormat : "%Y-%m-%d",
21
	plugin_insertdate_timeFormat : "%H:%M:%S",
22
    apply_source_formatting : true
23
});
24
//]]>
25
</script>
26
[% INCLUDE intranetstylesheet.inc %]
27
[% Asset.css("css/help.css") %]
28
</head>
29
<body id="help_edithelp" class="help">
30
	<h1>Online Help</h1>
31
[% IF ( error ) %]
32
<h5>[% error %]</h5>
33
[% END %]
34
<form action="/cgi-bin/koha/edithelp.pl" method="post">
35
<input type="hidden" name="referer" value="[% referer %]" />
36
<input type="hidden" name="type" value="[% type %]" />
37
<textarea name="help" cols="60" rows="20">[% help %]</textarea>
38
<fieldset class="action"><input type="submit" name="submit" class="submit" value="Submit" /> <a class="cancel" href="#" onclick="history.back(); return false;">Cancel</a></fieldset>
39
</form>
40
	
41
</body>
42
</html>
43
44
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/labels/label-edit-batch.tt (-27 lines)
Lines 1-27 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Batches</h1>
4
5
<p>Batches are made up of the barcodes you would like to print. Once in this tool you can search for the item records you would like to print out labels for.</p>
6
7
<h2>Add a Batch</h2>
8
9
<p>Batches can be created in one of two ways. The first is to click the 'Create Label Batch' link on the 'Staged MARC Management' page</p>
10
11
<p>The other is to choose to create a new batch from the label creator tool</p>
12
13
<p>You will be brought to an empty batch with an 'Add item(s)' button at the top of the page. Clicking 'Add item(s)' will open a search window for you to find the items you want to add to the batch.</p>
14
15
<p>From the search results, click the check box next to the items you want to add to the batch and click the 'Add checked' button. You can also add items one by one by clicking the 'Add' link to the left of each item.</p>
16
17
<p>Once you have added all of the items click the 'Done' button. The resulting page will list the items you have selected.</p>
18
19
<p>To print your labels, click the 'Export Batch' button. To print only some of the labels, click the 'Export Item(s)' button. Either way you will be presented with a confirmation screen where you can choose your template and layout.</p>
20
21
<p>You will then be presented with three download options: PDF, Excel, and CSV.</p>
22
23
<p>After saving your file, simply print to the blank labels you have in your library.</p>
24
25
<p><strong>See the full documentation for Label Batches in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#batches">manual</a> (online).</strong></p>
26
27
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/labels/label-edit-layout.tt (-17 lines)
Lines 1-17 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Layouts</h1>
4
5
<p>A layout is used to define the fields you want to appear on your labels.</p>
6
7
<h2>Add a Layout</h2>
8
9
<p>To add a new layout, you want to click on the 'Layouts' button at the top of your page and choose 'New Layout'</p>
10
11
<p>Using the form that appears you can create a profile to fix any problems with your template.</p>
12
13
<p>After saving, your layouts will appear on the 'Manage Layouts' page.</p>
14
15
<p><strong>See the full documentation for Label Layouts in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#layouts">manual</a> (online).</strong></p>
16
17
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/labels/label-edit-profile.tt (-33 lines)
Lines 1-33 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Profiles</h1>
4
5
<p>A profile is a set of "adjustments" applied to a given template just prior to printing which compensates for anomalies unique and peculiar to a given printer (to which the profile is assigned). This means if you set a template up and then print a sample set of data and find that the items are not all aligned the same on each label, you need to set up a profile for each printer to make up for the differences in printing styles, such as the shifting of text to the left, right, top or bottom.</p>
6
7
<p>If your labels are printing just the way you want, you will not need a profile.</p>
8
9
<h2>Add a Profile</h2>
10
11
<p>To add a new profile, you want to click on the 'Profiles' button at the top of your page and choose 'New Profile'</p>
12
13
<p>Using the form that appears you can create a profile to fix any problems with your template.</p>
14
15
<ul>
16
    <li>The Printer Name and Paper Bin do not have to match your printer exactly, they are for your reference so you can remember what printer you have set the profile for. So if you want to use the Printer model number in printer name or you can call it 'the printer on my desk'</li>
17
	<li>Template will be filled in once you have chosen which template to apply the profile to on the template edit form</li>
18
    <li>The Units pull down is used to define what measurement scale you're going to be using for your profile.&nbsp;</li>
19
    <li>Offset describes what happens when the entire image is off center either vertically or horizontally and creep describes a condition where the distance between the labels changes across the page or up and down the page
20
<ul>
21
	<li>For these values, negative numbers move the error up and to the left and positive numbers move the error down and to the right</li>
22
	<li>Example: the text is .25" from the left edge of the first label, .28" from the left edge of the second label and .31" from the left edge of the third label. This means the horizontal creep should be set to .03" to make up for this difference.</li>
23
</ul>
24
</li>
25
</ul>
26
27
<p>After saving, your profiles will appear on the 'Manage Profiles' page.</p>
28
29
<p>Once you have saved your new profile, you can return to the list of templates and choose to edit the template that this profile is for.</p>
30
31
<p><strong>See the full documentation for Label Profiles in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#profiles">manual</a> (online).</strong></p>
32
33
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/labels/label-edit-template.tt (-35 lines)
Lines 1-35 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Templates</h1>
4
5
<p>A template is based on the label/card stock you are using. This might be Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery 28371 for your patron cards, just to give a couple of examples. These labels will include all of the information you will need for setting up a Koha, this information may be on the packaging, and if not it can usually be found on the vendor's website.</p>
6
7
<h2>Add a Template</h2>
8
9
<p>To add a new template, you want to click on the 'Templates' button at the top of your page and choose 'New Template'</p>
10
11
<p>Using the form that appears you can define the template for your sheet of labels or cards.</p>
12
13
<ul>
14
    <li>Template ID will be automatically generated after saving your template, this is simply a system generated unique id</li>
15
    <li>Template Code should be something you can use to identify your template on a list of templates</li>
16
    <li>You can use the Template Description to add additional information about the template</li>
17
    <li>The Units pull down is used to define what measurement scale you're going to be using for the template. This should probably match the unit of measurement used on the template description provided by the product vendor.&nbsp;</li>
18
	<li>The measurements, number of columns and number of rows can be found on the vendor product packaging or website.
19
<ul>
20
	<li style="color: #990000">Important: If you do not supply a left text margin in the template, a 3/16" (13.5 point) left text margin will apply by default.</li>
21
</ul>
22
</li>
23
	<li>A profile is a set of "adjustments" applied to a given template just prior to printing which compensates for anomalies unique and peculiar to a given printer (to which the profile is assigned).
24
<ul>
25
	<li>Before picking a profile try printing some sample labels so that you can easily define a profile that is right for your printer/template combination.</li>
26
	<li>After finding any anomalies in the printed document, create a profile and assign it to the template.</li>
27
</ul>
28
</li>
29
</ul>
30
31
<p>After saving, your templates will appear on the 'Manage Templates' page.</p>
32
33
<p><strong>See the full documentation for Label Templates in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#templates">manual</a> (online).</strong></p>
34
35
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/labels/label-home.tt (-46 lines)
Lines 1-46 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Label Creator</h1>
4
5
<p>The Label Creator allow you to use layouts and templates which you design to print a nearly unlimited variety of labels including barcodes. Here are some of the features of the Label Creator module:</p>
6
7
<ul>
8
	<li>Customize label layouts</li>
9
	<li>Design custom label templates for printed labels</li>
10
	<li>Build and manage batches of labels</li>
11
	<li>Export single or multiple batches</li>
12
	<li>Export single or multiple labels from within a batch</li>
13
	<li>Export label data in one of three formats:
14
<ul>
15
	<li>PDF - Readable by any standard PDF reader, making labels printable directly on a printer&nbsp;</li>
16
	<li>CSV - Export label data after your chosen layout is applied allowing labels to be imported in to a variety of applications</li>
17
	<li>XML - Included as an alternate export format</li>
18
</ul>
19
</li>
20
</ul>
21
22
<p>At the top of each screen within the Label Creator, you will see a toolbar allowing quick access to relevant functions. The menu to the left of each screen also allows easy access to the different sections of the Label Creator. The breadcrumb trail near the top of each screen will give specific indication as to where you are within the Label Creator module and allow quick navigation to previously traversed sections. And finally, you can find more detailed information on each section of the Label Creator by clicking the online help link at the upper left-hand corner of every page.</p>
23
24
<p>The developers of the Label Creator module hope you will find this an extremely useful tool in the course of your cataloging work. You are encouraged to submit any enhancement requests as well as any bugs via Koha Project Bugzilla.</p>
25
26
<h2>Templates</h2>
27
28
<p>A template is based on the label/card stock you are using. This might be Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery 28371 for your patron cards, just to give a couple of examples. These labels will include all of the information you will need for setting up a Koha, this information may be on the packaging, and if not it can usually be found on the vendor's website.</p>
29
30
<h2>Profiles</h2>
31
32
<p>A profile is a set of "adjustments" applied to a given template just prior to printing which compensates for anomalies unique and peculiar to a given printer (to which the profile is assigned). This means if you set a template up and then print a sample set of data and find that the items are not all aligned the same on each label, you need to set up a profile for each printer to make up for the differences in printing styles, such as the shifting of text to the left, right, top or bottom.</p>
33
34
<p>If your labels are printing just the way you want, you will not need a profile.</p>
35
36
<h2>Layouts</h2>
37
38
<p>A layout is used to define the fields you want to appear on your labels.</p>
39
40
<h2>Batches</h2>
41
42
<p>Batches are made up of the barcodes you would like to print. Once in this tool you can search for the item records you would like to print out labels for.</p>
43
44
<p><strong>See the full documentation for the Label Creator in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#label-creator">manual</a> (online).</strong></p>
45
46
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/labels/label-manage.tt (-105 lines)
Lines 1-105 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Manage Labels</h1>
4
5
<h2>Layouts</h2>
6
7
<p>A layout is used to define the fields you want to appear on your labels.</p>
8
9
<h3>Add a Layout</h3>
10
11
<p>To add a new layout, you want to click on the 'Layouts' button at the top of your page and choose 'New Layout'</p>
12
13
<p>Using the form that appears you can create a profile to fix any problems with your template.</p>
14
15
<p>After saving, your layouts will appear on the 'Manage Layouts' page.</p>
16
17
<p><strong>See the full documentation for Label Layouts in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#layouts">manual</a> (online).</strong></p>
18
19
<h2>Templates</h2>
20
21
<p>A template is based on the label/card stock you are using. This might be Avery 5160 for address labels, Gaylord 47-284 for spine labels or Avery 28371 for your patron cards, just to give a couple of examples. These labels will include all of the information you will need for setting up a Koha, this information may be on the packaging, and if not it can usually be found on the vendor's website.</p>
22
23
<h3>Add a Template</h3>
24
25
<p>To add a new template, you want to click on the 'Templates' button at the top of your page and choose 'New Template'</p>
26
27
<p>Using the form that appears you can define the template for your sheet of labels or cards.</p>
28
29
<ul>
30
    <li>Template ID will be automatically generated after saving your template, this is simply a system generated unique id</li>
31
    <li>Template Code should be something you can use to identify your template on a list of templates</li>
32
    <li>You can use the Template Description to add additional information about the template</li>
33
    <li>The Units pull down is used to define what measurement scale you're going to be using for the template. This should probably match the unit of measurement used on the template description provided by the product vendor.&nbsp;</li>
34
    <li>The measurements, number of columns and number of rows can be found on the vendor product packaging or website.
35
<ul>
36
    <li style="color: #990000">Important: If you do not supply a left text margin in the template, a 3/16" (13.5 point) left text margin will apply by default.</li>
37
</ul>
38
</li>
39
    <li>A profile is a set of "adjustments" applied to a given template just prior to printing which compensates for anomalies unique and peculiar to a given printer (to which the profile is assigned).
40
<ul>
41
    <li>Before picking a profile try printing some sample labels so that you can easily define a profile that is right for your printer/template combination.</li>
42
    <li>After finding any anomalies in the printed document, create a profile and assign it to the template.</li>
43
</ul>
44
</li>
45
</ul>
46
47
<p>After saving, your templates will appear on the 'Manage Templates' page.</p>
48
49
<p><strong>See the full documentation for Label Templates in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#templates">manual</a> (online).</strong></p>
50
51
<h2>Profiles</h2>
52
53
<p>A profile is a set of "adjustments" applied to a given template just prior to printing which compensates for anomalies unique and peculiar to a given printer (to which the profile is assigned). This means if you set a template up and then print a sample set of data and find that the items are not all aligned the same on each label, you need to set up a profile for each printer to make up for the differences in printing styles, such as the shifting of text to the left, right, top or bottom.</p>
54
55
<p>If your labels are printing just the way you want, you will not need a profile.</p>
56
57
<h3>Add a Profile</h3>
58
59
<p>To add a new profile, you want to click on the 'Profiles' button at the top of your page and choose 'New Profile'</p>
60
61
<p>Using the form that appears you can create a profile to fix any problems with your template.</p>
62
63
<ul>
64
    <li>The Printer Name and Paper Bin do not have to match your printer exactly, they are for your reference so you can remember what printer you have set the profile for. So if you want to use the Printer model number in printer name or you can call it 'the printer on my desk'</li>
65
    <li>Template will be filled in once you have chosen which template to apply the profile to on the template edit form</li>
66
    <li>The Units pull down is used to define what measurement scale you're going to be using for your profile.&nbsp;</li>
67
    <li>Offset describes what happens when the entire image is off center either vertically or horizontally and creep describes a condition where the distance between the labels changes across the page or up and down the page
68
<ul>
69
    <li>For these values, negative numbers move the error up and to the left and positive numbers move the error down and to the right</li>
70
    <li>Example: the text is .25" from the left edge of the first label, .28" from the left edge of the second label and .31" from the left edge of the third label. This means the horizontal creep should be set to .03" to make up for this difference.</li>
71
</ul>
72
</li>
73
</ul>
74
75
<p>After saving, your profiles will appear on the 'Manage Profiles' page.</p>
76
77
<p>Once you have saved your new profile, you can return to the list of templates and choose to edit the template that this profile is for.</p>
78
79
<p><strong>See the full documentation for Label Profiles in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#profiles">manual</a> (online).</strong></p>
80
81
<h2>Batches</h2>
82
83
<p>Batches are made up of the barcodes you would like to print. Once in this tool you can search for the item records you would like to print out labels for.</p>
84
85
<h3>Add a Batch</h3>
86
87
<p>Batches can be created in one of two ways. The first is to click the 'Create Label Batch' link on the 'Staged MARC Management' page</p>
88
89
<p>The other is to choose to create a new batch from the label creator tool</p>
90
91
<p>You will be brought to an empty batch with an 'Add item(s)' button at the top of the page. Clicking 'Add item(s)' will open a search window for you to find the items you want to add to the batch.</p>
92
93
<p>From the search results, click the check box next to the items you want to add to the batch and click the 'Add checked' button. You can also add items one by one by clicking the 'Add' link to the left of each item.</p>
94
95
<p>Once you have added all of the items click the 'Done' button. The resulting page will list the items you have selected.</p>
96
97
<p>To print your labels, click the 'Export Batch' button. To print only some of the labels, click the 'Export Item(s)' button. Either way you will be presented with a confirmation screen where you can choose your template and layout.</p>
98
99
<p>You will then be presented with three download options: PDF, Excel, and CSV.</p>
100
101
<p>After saving your file, simply print to the blank labels you have in your library.</p>
102
103
<p><strong>See the full documentation for Label Batches in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#batches">manual</a> (online).</strong></p>
104
105
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/labels/spinelabel-home.tt (-16 lines)
Lines 1-16 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Quick Spine Label Creator</h1>
4
5
<p style="background-color: #ffe599">Tip: This tool does not use the label layouts or templates, it simply prints a spine label in the first spot on the label sheet.</p>
6
7
<ul>
8
	<li>Define the fields you want to print on the spine label in the SpineLabelFormat system preference</li>
9
    <li>Format your label printing by editing spinelabel.css found in [% interface %]/[% theme %]/css/</li>
10
</ul>
11
12
<p>To use this tool you simply need the barcode for the book you'd like to print the spine label for.</p>
13
14
<p><strong>See the full documentation for Quick Spine Label Creator in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/tools.html#quick-spine-label-creator">manual</a> (online).</strong></p>
15
16
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/mainpage.tt (-30 lines)
Lines 1-30 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h2>Welcome to Koha</h2>
4
5
<p>If this is your first time logging into Koha, you should now go to Koha Administration and set up all system preferences, patron categories, item types and libraries. You should also review the other settings found in Administration.</p>
6
7
<p>Once you have set up patron categories, you should create a new user in the Patrons module with superlibrarian permissions. Once that user is created, you should log in as that user rather than the root user which is set up as part of installation.</p>
8
9
<p>Here are some other places to look for more information about how to proceed:</p>
10
11
<ul>
12
<li><a href="http://koha-community.org/documentation/">Read Koha documentation</a></li>
13
<li><a href="http://wiki.koha-community.org">Read/Write to the Koha wiki</a></li>
14
<li><a href="http://koha-community.org/support/koha-mailing-lists/">Read and contribute to discussions</a></li>
15
<li><a href="http://bugs.koha-community.org">Report Koha bugs</a></li>
16
<li><a href="http://wiki.koha-community.org/wiki/Version_Control_Using_Git">Submit patches to Koha using git (version control system)</a></li>
17
<li><a href="http://koha-community.org/get-involved/irc/">Chat with Koha users and developers</a></li>
18
</ul>
19
20
<h2>Can I edit the online help?</h2>
21
22
<p>You can edit the online help through the Koha Staff Client by clicking the &quot;Edit Help&quot; button. This feature has been designed so that library workflow and policies can be documented within Koha.</p>
23
24
<p><strong>IMPORTANT:</strong> Your online help will be overwritten by the new Help when there is an upgrade. If you want to keep a copy of your online help, you should instruct your System Administrator to upgrade the Online Help directory in the Koha file tree.</p>
25
26
<p>The online help directory is: <pre>[% themelang %]/modules/help</pre></p>
27
28
<p><strong>See the full documentation for Koha in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/">manual</a> (online).</strong></p>
29
30
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/boraccount.tt (-24 lines)
Lines 1-24 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patron fines</h1>
4
5
<p>The patron's complete accounting history will appear on the Fines tab. Contrary to its name, the Fines tab does not just show fine data, it also shows membership fees, rental fees, reserve fees and any other charge you may have for patrons.</p>
6
7
<h2>Charging Fines/Fees</h2>
8
9
<p>Most fees and fines will be charged automatically if the fines cron job is running:</p>
10
11
<ul>
12
	<li>Fines will be charged based on your Circulation &amp; Fines Rules</li>
13
	<li>Hold fees will be charged based on the rules you set for the patron category in administration</li>
14
	<li>Rental fees will be charged based on the settings in your Item Types administration area</li>
15
	<li>Marking an item 'Lost' via the cataloging module will automatically charge the patron the replacement cost for that item</li>
16
</ul>
17
18
<h2>Printing Invoices</h2>
19
20
<p>To the right of each account line there is a print link. Clicking that link will print an invoice for the line item that includes the date and description of the line item along with the total outstanding on the account.</p>
21
22
<p><strong>See the full documentation for Patron Fines in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#fines">manual</a> (online).</strong></p>
23
24
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/discharge.tt (-21 lines)
Lines 1-21 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patron discharges</h1>
4
5
<p>A discharge is a certificate that says the patron has no current checkouts, no holds and owe no money. To enable this option on the patron record you need to set the useDischarge system preference to 'Allow'.</p>
6
7
<p>Note: In France a "quitus" ("discharge") is needed if you want to register for an account in a library or a university).</p>
8
9
<p>Note: Academic libraries often require that you have a clear record at the library before you can graduate.</p>
10
11
<p>To generate a discharge for a patron click the 'Discharge' tab on the left of the patron record</p>
12
13
<p>If the patron can have a discharge generated then it will have a button that says 'Generate discharge'</p>
14
15
<p>If not then you'll see an error explaining why you can't discharge the patron.</p>
16
17
<p>Once the letter is generated you will have a PDF to download</p>
18
19
<p><strong>See the full documentation for the Patron discharges in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#patron-discharges">manual</a> (online).</strong></p>
20
21
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/files.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patron files</h1>
4
5
<p>If you set the EnableBorrowerFiles preference to 'Do' the Files tab will be visible on the patron information page.</p>
6
7
<p>From here you can upload files to attach to the patron record.</p>
8
9
<p>All files that are uploaded will appear above a form where additional files can be uploaded from.</p>
10
11
<p><strong>See the full documentation for Patron Files in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#files">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/mancredit.tt (-16 lines)
Lines 1-16 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Create manual credit</h1>
4
5
<p>Manual credits can be used to pay off parts of fines, or to forgive a fine amount.</p>
6
7
<ul>
8
	<li>First choose the type of credit you'd like to apply</li>
9
	<li>If this credit is associated with an item you can enter that item's barcode so that the line item links to the right item</li>
10
	<li>The description field is where you will enter the description of the credit</li>
11
	<li>In the amount field, do not enter currency symbols, only numbers and decimals</li>
12
</ul>
13
14
<p><strong>See the full documentation for Creating Manual Credits in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#creating-manual-credits">manual</a> (online).</strong></p>
15
16
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/maninvoice.tt (-19 lines)
Lines 1-19 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Create manual invoice</h1>
4
5
<p>For fees that are not automatically charged, librarians can create a manual invoice</p>
6
<ul>
7
	<li>First choose the type of invoice you would like to create
8
<ul>
9
	<li>To add additional values to the manual invoice type pull down menu, add them to the MANUAL_INV Authorized Value</li>
10
</ul>
11
</li>
12
	<li>If the fee is associated with an item you can enter its barcode so that the line item shows a link to that item</li>
13
	<li>The description field is where you will enter the description of the charge</li>
14
	<li>In the amount field, do not enter currency symbols, only numbers and decimals</li>
15
</ul>
16
17
<p><strong>See the full documentation for Creating Manual Invoices in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#creating-manual-invoices">manual</a> (online).</strong></p>
18
19
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-flags.tt (-527 lines)
Lines 1-527 Link Here
1
[% INCLUDE 'help-top.inc' %]   
2
3
<h2>Patron permissions</h2>
4
5
<p>Patron Permissions are used to allow staff members access to the staff client.</p>
6
7
<p style="color: #990000">Important: In order for a staff member to log into the staff interface they must have (at the very least) 'catalogue' permissions which allow them to view the staff interface.</p>
8
9
<h3>Setting Patron Permissions</h3>
10
11
<p>To set patron permissions, you must first have a patron of the 'Staff' type open</p>
12
13
<ul>
14
	<li>On the patron record click More and choose Set Permissions to alter patron permissions</li>
15
	<li>You will be presented with a list of preferences, some of which can be expanded by clicking the plus sign to the left of the section title.</li>
16
</ul>
17
18
<h3>Patron Permissions Defined</h3>
19
20
<ul>
21
	<li>superlibrarian
22
<ul>
23
	<li>Access to all librarian functions
24
<ul>
25
	<li style="background-color: #ffe599;">Tip: With this selected there is no need to choose any other permissions</li>
26
</ul>
27
</li>
28
</ul>
29
</li>
30
	<li>circulate
31
<ul>
32
	<li>Check out and check in items</li>
33
	<li>This section can be expanded</li>
34
</ul>
35
</li>
36
	<li>catalogue
37
<ul>
38
	<li><strong>Required for staff login.</strong> Staff access, allows viewing the catalogue in staff client
39
<ul>
40
	<li style="color: #990000;">Important: Must be given to all staff members to allow them to login to the staff client</li>
41
</ul>
42
</li>
43
</ul>
44
</li>
45
	<li>parameters
46
<ul>
47
	<li>Manage Koha system settings (Administration panel)</li>
48
	<li>This section can be expanded</li>
49
</ul>
50
</li>
51
	<li>borrowers
52
<ul>
53
	<li>Add or modify patrons</li>
54
</ul>
55
</li>
56
	<li>permissions
57
<ul>
58
	<li>Set user permissions</li>
59
</ul>
60
</li>
61
	<li>reserveforothers
62
<ul>
63
	<li>Place and modify holds for patrons</li>
64
	<li>This section can be expanded</li>
65
</ul>
66
</li>
67
	<li>borrow
68
<ul>
69
	<li>Borrow books</li>
70
</ul>
71
</li>
72
	<li>editcatalogue
73
<ul>
74
	<li>Edit Catalog (Modify bibliographic/holdings data)</li>
75
	<li>This section can be expanded</li>
76
</ul>
77
</li>
78
	<li>updatecharges
79
<ul>
80
	<li>Manage patrons fines and fees</li>
81
</ul>
82
</li>
83
	<li>acquisition
84
<ul>
85
	<li>Acquisition and/or suggestion management</li>
86
	<li>This section can be expanded</li>
87
</ul>
88
</li>
89
	<li>tools
90
<ul>
91
	<li>Use all tools</li>
92
	<li>This section can be expanded</li>
93
</ul>
94
</li>
95
	<li>editauthorities
96
<ul>
97
	<li>Edit Authorities</li>
98
</ul>
99
</li>
100
	<li>serials
101
<ul>
102
	<li>Manage serial subscriptions</li>
103
	<li>This section can be expanded</li>
104
</ul>
105
</li>
106
	<li>reports
107
<ul>
108
	<li>Allow access to the reports module</li>
109
	<li>Reports found on the Circulation page are not controlled by this permission</li>
110
	<li>This section can be expanded</li>
111
</ul>
112
</li>
113
	<li>staffaccess
114
<ul>
115
	<li>Allow staff members to modify permissions for other staff members</li>
116
	<li style="color: #990000;">Important: Requires the borrowers permission above</li>
117
</ul>
118
</li>
119
	<li>lists
120
<ul>
121
	<li>Koha Lists</li>
122
	<li style="color: #990000;">Important: All staff have permission to create and modify their own lists, this permission is only necessary if you'd like to give a staff member permission to delete public lists that they have not created.</li>
123
	<li>This section can be expanded</li>
124
</ul>
125
</li>
126
</ul>
127
128
<h4>Granular Circulate Permissions</h4>
129
130
<p>If the staff member has 'circulate' permissions they have the ability to perform all of these actions. If you would like to control circulation permissions on a more granular level choose from these options:</p>
131
132
<ul>
133
	<li>circulate_remaining_permissions
134
<ul>
135
	<li>Remaining circulation permissions</li>
136
	<li>All circulation rights except the ability to override renewals</li>
137
</ul>
138
</li>
139
	<li>overdues_report
140
<ul>
141
	<li>Execute overdue items report</li>
142
	<li>The permission to run the overdues reports found under Circulation</li>
143
</ul>
144
</li>
145
	<li>override_renewals
146
<ul>
147
	<li>Override blocked renewals</li>
148
	<li>Requires that the staff member also has circulate_remaining_permissions</li>
149
</ul>
150
</li>
151
</ul>
152
153
<h4>Granular Parameters Permissions</h4>
154
155
<p>If the staff member has 'parameters' permissions they have the ability to perform all of these actions. If you would like to control parameter permissions on a more granular level choose from these options:</p>
156
157
<ul>
158
	<li>manage_circ_rules
159
<ul>
160
	<li>Manage circulation rules</li>
161
	<li>The ability to access the Circulation and fines rules in the administration area</li>
162
</ul>
163
</li>
164
	<li>parameters_remaining_permissions
165
<ul>
166
	<li>Remaining system parameters permissions</li>
167
	<li>The ability to access all areas in Administration (other than the Circulation and fine rules)</li>
168
</ul>
169
</li>
170
</ul>
171
172
<h4>Granular Holds Permissions</h4>
173
174
<p>If the staff member has 'reserveforothers' permissions they have the ability to perform all of these actions. If you would like to control holds permissions on a more granular level choose from these options:</p>
175
176
<ul>
177
	<li>modify_holds_priority
178
<ul>
179
	<li>Modify holds priority</li>
180
	<li>Allow staff members to alter the holds priority (moving patrons up and down the queue)</li>
181
</ul>
182
</li>
183
	<li>place_holds
184
<ul>
185
	<li>Place holds for patrons</li>
186
</ul>
187
</li>
188
</ul>
189
190
<h4>Granular Cataloging Permissions</h4>
191
192
<p>If the staff member has 'editcatalogue' permissions they have the ability to perform all of these actions. If you would like to control cataloging permissions on a more granular level choose from these options:</p>
193
194
<ul>
195
	<li>delete_all_items
196
<ul>
197
	<li>Delete all items at once</li>
198
	<li>Ability to use the 'Delete all items' option found under the 'Edit' menu in cataloging</li>
199
</ul>
200
</li>
201
	<li>edit_catalogue
202
<ul>
203
	<li>Edit catalog (Modify bibliographic/holdings data)</li>
204
	<li>Ability to access all cataloging functions via the Cataloging page</li>
205
</ul>
206
</li>
207
	<li>edit_items
208
<ul>
209
	<li>Edit items</li>
210
	<li>Ability to make edits to item/holdings records, but not bibliographic records</li>
211
</ul>
212
</li>
213
	<li>edit_items_restricted
214
<ul>
215
	<li>Limit item modification to subfields defined in the SubfieldsToAllowForRestrictedEditing preference</li>
216
	<li>Note: Please note that edit_items permission is still required</li>
217
</ul>
218
</li>
219
	<li>fast_cataloging
220
<ul>
221
	<li>Fast cataloging</li>
222
	<li>The ability to catalog using only the Fast Add Framework found on the Circulation page</li>
223
</ul>
224
</li>
225
</ul>
226
227
<h4>Granular Acquisitions Permissions</h4>
228
229
<p>If the staff member has 'acquisition' permissions they have the ability to perform all of these actions. If you would like to control acquisitions permissions on a more granular level choose from these options:</p>
230
231
<ul>
232
	<li>budget_add_del
233
<ul>
234
	<li>Add and delete budgets (but can't modify them)</li>
235
</ul>
236
</li>
237
	<li>budget_manage
238
<ul>
239
	<li>Manage budgets</li>
240
</ul>
241
</li>
242
	<li>budget_manage_all
243
<ul>
244
	<li>Manage all budgets</li>
245
</ul>
246
</li>
247
	<li>budget_modify
248
<ul>
249
	<li>Modify budget (can't create lines, but can modify existing ones)</li>
250
</ul>
251
</li>
252
	<li>contracts_manage
253
<ul>
254
	<li>Manage contracts</li>
255
</ul>
256
</li>
257
	<li>group_manage
258
<ul>
259
	<li>Manage orders and basket groups</li>
260
</ul>
261
</li>
262
	<li>order_manage
263
<ul>
264
	<li>Manage orders and baskets</li>
265
</ul>
266
</li>
267
	<li>order_manage_all
268
<ul>
269
	<li>Manage all orders and baskets, regardless of restrictions on them</li>
270
</ul>
271
</li>
272
	<li>order_receive
273
<ul>
274
	<li>Manage orders and baskets</li>
275
</ul>
276
</li>
277
	<li>period_manage
278
<ul>
279
	<li>Manage periods</li>
280
</ul>
281
</li>
282
	<li>planning_manage
283
<ul>
284
	<li>Manage budget planning</li>
285
</ul>
286
</li>
287
	<li>vendors_manage
288
<ul>
289
	<li>Manage vendors</li>
290
</ul>
291
</li>
292
</ul>
293
294
<h4>Granular Serials Permissions</h4>
295
296
<p>If the staff member has 'serials' permissions they have the ability to perform all of these actions. If you would like to control serials permissions on a more granular level choose from these options:</p>
297
298
<ul>
299
	<li>check_expiration
300
<ul>
301
	<li>Check the expiration of a serial</li>
302
</ul>
303
</li>
304
	<li>claim_serials
305
<ul>
306
	<li>Claim missing serials via the Claims section</li>
307
</ul>
308
</li>
309
	<li>create_subscription
310
<ul>
311
	<li>Create a new subscription</li>
312
</ul>
313
</li>
314
	<li>delete_subscription
315
<ul>
316
	<li>Delete an existing subscription</li>
317
</ul>
318
</li>
319
	<li>edit_subscription
320
<ul>
321
	<li>Edit an existing subscription</li>
322
	<li>This permission does not include the ability to delete or create a subscription</li>
323
</ul>
324
</li>
325
	<li>receive_serials
326
<ul>
327
	<li>Serials receiving</li>
328
	<li>Receive serials on existing subscriptions</li>
329
</ul>
330
</li>
331
	<li>renew_subscription
332
<ul>
333
	<li>Renew a subscription</li>
334
</ul>
335
</li>
336
	<li>routing
337
<ul>
338
	<li>Routing</li>
339
	<li>Manage routing lists</li>
340
</ul>
341
</li>
342
	<li>superserials
343
<ul>
344
	<li>Manage subscriptions from any branch (only applies when IndependentBranches is used)</li>
345
</ul>
346
</li>
347
</ul>
348
349
<h4>Granular Tools Permissions</h4>
350
351
<p>If the staff member has 'tools' permissions they have the ability to access and use all items under the Tools menu. If you would like to control which tools staff members have access to on a more granular level choose from these options:</p>
352
353
<ul>
354
	<li>batch_upload_patron_images
355
<ul>
356
	<li>Upload patron images in batch or one at a time</li>
357
	<li>Access to the Image Upload Tool</li>
358
</ul>
359
</li>
360
	<li>delete_anonymize_patrons
361
<ul>
362
	<li>Delete old borrowers and anonymize circulation/reading history (deletes borrower reading history)</li>
363
	<li>Access to the Anonymize Patron Tool</li>
364
</ul>
365
</li>
366
	<li>edit_calendar
367
<ul>
368
	<li>Define days when the library is closed</li>
369
	<li>Access to the Calendar/Holidays Tool</li>
370
</ul>
371
</li>
372
	<li>edit_news
373
<ul>
374
	<li>Write news for the OPAC and staff interfaces</li>
375
	<li>Access to the News Tool</li>
376
</ul>
377
</li>
378
	<li>edit_notice_status_triggers
379
<ul>
380
	<li>Set notice/status triggers for overdue items</li>
381
	<li>Access to the Overdue Notice Status/Triggers Tool</li>
382
</ul>
383
</li>
384
	<li>edit_notices
385
<ul>
386
	<li>Define notices</li>
387
	<li>Access to the Notices Tool</li>
388
</ul>
389
</li>
390
	<li>export_catalog
391
<ul>
392
	<li>Export bibliographic, authorities and holdings data</li>
393
	<li>Access to the Export Data Tool</li>
394
</ul>
395
</li>
396
	<li>import_patrons
397
<ul>
398
	<li>Import patron data</li>
399
	<li>Access to the Import Patrons Tool</li>
400
</ul>
401
</li>
402
	<li>inventory
403
<ul>
404
	<li>Perform inventory of your catalog</li>
405
	<li>Access to the Inventory Tool</li>
406
</ul>
407
</li>
408
	<li>items_batchdel
409
<ul>
410
	<li>Perform batch deletion of items</li>
411
	<li>Access to the Batch Item Deletion Tool</li>
412
</ul>
413
</li>
414
	<li>items_batchmod
415
<ul>
416
	<li>Perform batch modification of items</li>
417
	<li>Access to the Batch Item Modification Tool</li>
418
</ul>
419
</li>
420
	<li>items_batchmod_restricted
421
<ul>
422
	<li>Limit batch item modification to subfields defined in the SubfieldsToAllowForRestrictedBatchmod preference</li>
423
	<li>Note: Please note that items_batchmod permission is still required</li>
424
</ul>
425
</li>
426
	<li>label_creator
427
<ul>
428
	<li>Create printable labels and barcodes from catalog and patron data</li>
429
	<li>Access to the Label Creator and Quick Label Creator Tools</li>
430
</ul>
431
</li>
432
	<li>manage_csv_profiles
433
<ul>
434
	<li>Manage CSV export profiles</li>
435
	<li>Access to the CSV Profiles Tool</li>
436
</ul>
437
</li>
438
	<li>manage_staged_marc
439
<ul>
440
	<li>Managed staged MARC records, including completing and reversing imports</li>
441
	<li>Access to the Manage Staged MARC Records Tool</li>
442
</ul>
443
</li>
444
	<li>moderate_comments
445
<ul>
446
	<li>Moderate patron comments</li>
447
	<li>Access to the Comments Tool</li>
448
</ul>
449
</li>
450
	<li>moderate_tags
451
<ul>
452
	<li>Moderate patron tags</li>
453
	<li>Access to the Tags Tool</li>
454
</ul>
455
</li>
456
	<li>records_batchdel
457
<ul>
458
	<li>Perform batch deletion of records (bibliographic or authority)</li>
459
	<li>Access to the Batch Record Deletion Tool</li>
460
</ul>
461
</li>
462
	<li>schedule_tasks
463
<ul>
464
	<li>Schedule tasks to run</li>
465
	<li>Access to the Task Scheduler Tool</li>
466
</ul>
467
</li>
468
	<li>stage_marc_import
469
<ul>
470
	<li>Stage MARC records into the reservoir</li>
471
	<li>Access to the Stage MARC Records Tool</li>
472
</ul>
473
</li>
474
	<li>upload_local_cover_images
475
<ul>
476
	<li>Upload local cover images</li>
477
	<li>Access to the Upload Local Cover Image Tool</li>
478
</ul>
479
</li>
480
	<li>view_system_logs
481
<ul>
482
	<li>Browse the system logs</li>
483
	<li>Access to the Log Viewer Tool</li>
484
</ul>
485
</li>
486
</ul>
487
488
<h4>Granular Reports Permissions</h4>
489
490
<p>If the staff member has 'reports' permissions they have the ability to perform all of these actions. If you would like to control reports permissions on a more granular level choose from these options:</p>
491
492
<ul>
493
        <li>delete_reports
494
<ul>
495
        <li>Delete SQL Reports</li>
496
        <li>The ability to delete but not run SQL reports</li>
497
</ul>
498
</li>
499
	<li>create_reports
500
<ul>
501
	<li>Create SQL Reports</li>
502
	<li>The ability to create and edit but not run SQL reports</li>
503
</ul>
504
</li>
505
	<li>execute_reports
506
<ul>
507
	<li>Execute SQL Reports</li>
508
	<li>The ability to run but not create or edit SQL reports</li>
509
</ul>
510
</li>
511
</ul>
512
513
<h4>Granular Lists Permissions</h4>
514
515
<p>All staff members have permission to access lists. This section only needs to be checked off if you want to give permission to a staff member to delete public lists that they have no created themselves.</p>
516
517
<ul>
518
	<li>delete_public_lists
519
<ul>
520
	<li>Delete public lists</li>
521
</ul>
522
</li>
523
</ul>
524
525
<p><strong>See the full documentation for Patron Permissions in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#patron-permissions">manual</a> (online).</strong></p>
526
527
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member-password.tt (-16 lines)
Lines 1-16 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Change Patron Password</h1>
4
5
<p>Patron passwords are not recoverable. The stars show on the patron detail next to the Password label are always there even if a password isn't set. If a patron forgets their password the only option is to reset their password. To change the patron's password, click the 'Change Password' button</p>
6
7
<ul>
8
    <li>Koha cannot display existing passwords. Leave the field blank to leave password unchanged.</li>
9
    <li>This form can automatically generate a random password if you click the link labeled "Click to fill with a randomly generated suggestion. Passwords will be displayed as text."</li>
10
</ul>
11
12
<p>The default minimum password length is 3 characters long.  To change this value, update your system preferences.</p>
13
14
<p><strong>See the full documentation for Editing Patrons in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#editing-patrons">manual</a> (online).</strong></p>
15
16
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/member.tt (-65 lines)
Lines 1-65 Link Here
1
[% INCLUDE 'help-top.inc' %]   
2
3
<h1>Patron search</h1>
4
5
<p>Clicking on the link to the Patron module will bring you to a search/browse screen for patrons. From here you can search for a patron by any part of their name or their card number.</p>
6
7
<p>Clicking the small plus sign [+] to the right of the search box will open up an advanced patron search with more filters including the ability to limit to a specific category and/or library.</p>
8
9
<p>You can also filter your patron results using the search options on the left hand side of the page.</p>
10
11
<p>Depending on what you have chosen for the 'Search fields' you can search for patrons in various different ways.</p>
12
13
<ul>
14
	<li>Standard:
15
<ul>
16
	<li>Enter any part of their name, username, email address or barcode</li>
17
</ul>
18
</li>
19
	<li>Email:
20
<ul>
21
	<li>Enter any part of their email address and choose 'Contains' instead of 'Starts with'</li>
22
</ul>
23
</li>
24
	<li>Borrower number:
25
<ul>
26
	<li>Enter the Koha borrower number</li>
27
</ul>
28
</li>
29
	<li>Phone number:
30
<ul>
31
	<li>Enter the phone number exactly as it is in the system or by using spaces between each batch of numbers.</li>
32
	<li>Example: To find (212) 555-1212 you can search for it exactly as it was entered or by searching for 212 555 1212</li>
33
</ul>
34
</li>
35
	<li>Street address:
36
<ul>
37
	<li>Enter any part of the patron's address (includes all address fields) and choose 'Contains' instead of 'Starts with' to find the string anywhere in the address</li>
38
</ul>
39
</li>
40
	<li>Date of birth
41
<ul>
42
	<li>Birthdates should be entered using the format set forth in the dateformat preference.</li>
43
</ul>
44
</li>
45
<li>Sort field 1
46
<ul>
47
	<li>This is a custom field that libraries can use for any type of data about the patron.</li>
48
</ul>
49
</li>
50
<li>Sort field 2
51
<ul>
52
	<li>This is a custom field that libraries can use for any type of data about the patron.</li>
53
</ul>
54
</li>
55
</ul>
56
57
<p>You can also choose to either search for fields that start with the string you entered or contain the string. Choosing 'Contains' will work like a wildcard search.</p>
58
59
<p>You can also choose how your results will be sorted by using the 'Order by' pull down menu at the end of the form.</p>
60
61
<p>You can also browse through the patron records by clicking on the linked letters across the top.</p>
62
63
<p><strong>See the full documentation for Patron Search in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#patron-search">manual</a> (online).</strong></p>
64
65
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/memberentry.tt (-91 lines)
Lines 1-91 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Add patrons</h1>
4
5
<p>Patron categories belong to one of six overreaching categories in Koha.</p>
6
7
<ul>
8
	<li>Staff = A user that can be configured to perform functions in the staff client</li>
9
	<li>Adult = A regular patron (can have child patrons attached to it)</li>
10
	<li>Child = A patron who can belong to an Adult patron</li>
11
	<li>Organization = An organization that can have Professional patrons attached to it</li>
12
	<li>Professional = A patron that can belong to an Organization</li>
13
	<li>Statistical = A patron type used solely for tracking in house usage
14
<ul>
15
	<li><span style="background-color: #ffe599;">TIP: This can be used to record statistics of items that are used, but do not get checked out, such as reference items, magazines, etc. You can then run a report to gather the statistics from this card</span></li>
16
</ul>
17
</li>
18
</ul>
19
20
<h2>Add a new Patron</h2>
21
22
<p>Patrons are added by going to the 'Patrons' module.</p>
23
24
<ul>
25
	<li>Click 'New'</li>
26
    <li>First enter the identifying information regarding your patron
27
<ul>
28
	<li>Required fields are defined in the BorrowerMandatoryField system preference</li>
29
	<li>Salutation is populated by the BorrowersTitles system preference</li>
30
</ul>
31
</li>
32
    <li>Next enter the contact information
33
<ul>
34
    <li>For contact information, note that the primary phone and email addresses are the ones that appear on notices and slips printed during circulation (receipts, transfer slips and hold slips). The primary email is also the one that overdue notices and other messages go to.</li>
35
</ul>
36
</li>
37
	<li>If this patron is a child, you will be asked to attach the child patron to an adult patron
38
<ul>
39
	<li>Click 'Set to Patron' to search your system for an existing patron</li>
40
	<li>If the Guarantor is not in the system, you can enter the first and last name in the fields available</li>
41
	<li>The relationships are set using the borrowerRelationship system preference</li>
42
</ul>
43
</li>
44
	<li>If this patron is a professional, you will be asked to attach the patron to an organizational patron
45
<ul>
46
	<li>Click 'Set to Patron to search your system for an existing patron</li>
47
</ul>
48
</li>
49
	<li>Each patron can have an alternate contact
50
<ul>
51
	<li>An alternate contact could be a parent or guardian. It can also be used in academic settings to store the patron's home address.</li>
52
</ul>
53
</li>
54
	<li>The library management section includes values that are used within the library
55
<ul>
56
	<li>The card number field is automatically calculated if you have the autoMemberNum system preference set that way</li>
57
    <li><strong>Note:</strong> For a newly installed system this preference will start at 1 and increment by 1 each time after. To have it start with the starting number of your barcodes, enter the first barcode by hand in the patron record and save the patron. After that the field will increment that number by 1.</li>
58
	<li>If you accidentally chose the wrong patron category at the beginning you can fix that here</li>
59
	<li>Sort 1 and 2 are used for statistical purposes within your library</li>
60
</ul>
61
</li>
62
	<li>Next, the Library Setup section includes additional library settings
63
<ul>
64
	<li>The registration date will automatically be filled in with today's date</li>
65
	<li>If your patron cards expire (based on your patron category settings) the Expiry date will automatically be calculated</li>
66
	<li>The OPAC Note is a note for the patron - it will appear in the OPAC on the patron's record</li>
67
	<li>The Circulation Note is meant solely for your library staff and will appear when the circulation staff goes to check an item out to the patron</li>
68
    <li>The Staff/OPAC asks for the username and password to be used by the patron (and/or staff member) to log into their account in the OPAC and for staff to log in to the staff client.</li>
69
</ul>
70
</li>
71
	<li>If you have set additional patron attributes up, these will appear next</li>
72
	<li>Finally, if you have EnhancedMessagingPreferences set to 'allow,' you can choose the messaging preferences for this patron.
73
<ul>
74
    <li style="color: #990000">Important: These preferences will override any you set via the patron categories</li>
75
    <li style="color: #990000">Important: These preference can be altered by the patron via the OPAC</li>
76
</ul>
77
</li>
78
	<li>Once finished, click 'Save'</li>
79
</ul>
80
81
<p>If the system suspects this patron is a duplicate of another it will warn you.</p>
82
83
<h2>Add a Staff Patron</h2>
84
85
<p>All staff members must be entered into Koha as patrons of the 'Staff' type. Follow the steps in Add a Patron to add a staff member. To give the staff member permissions to access the staff client, follow the steps in Patron Permissions</p>
86
87
<p style="color: #990000">Remember to assign your staff secure usernames and passwords since these will be used to log into the staff client.</p>
88
89
<p><strong>See the full documentation for Adding Patrons in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#add-a-new-patron">manual</a> (online).</strong></p>
90
91
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/members-home.tt (-67 lines)
Lines 1-67 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patrons</h1>
4
5
<p>The Patrons module stores the information you add about your patrons.</p>
6
7
<p>Clicking on the link to the Patron module will bring you to a search/browse screen for patrons. From here you can search for a patron by any part of their name or their card number.</p>
8
9
<p>Clicking the small plus sign [+] to the right of the search box will open up an advanced patron search with more filters including the ability to limit to a specific category and/or library.</p>
10
11
<p>You can also filter your patron results using the search options on the left hand side of the page.</p>
12
13
<p>Depending on what you have chosen for the 'Search fields' you can search for patrons in various different ways.</p>
14
15
<ul>
16
	<li>Standard:
17
<ul>
18
	<li>Enter any part of their name, username, email address or barcode</li>
19
</ul>
20
</li>
21
	<li>Email:
22
<ul>
23
	<li>Enter any part of their email address and choose 'Contains' instead of 'Starts with'</li>
24
</ul>
25
</li>
26
	<li>Borrower number:
27
<ul>
28
	<li>Enter the Koha borrower number</li>
29
</ul>
30
</li>
31
	<li>Phone number:
32
<ul>
33
	<li>Enter the phone number exactly as it is in the system or by using spaces between each batch of numbers.</li>
34
	<li>Example: To find (212) 555-1212 you can search for it exactly as it was entered or by searching for 212 555 1212</li>
35
</ul>
36
</li>
37
	<li>Street address:
38
<ul>
39
	<li>Enter any part of the patron's address (includes all address fields) and choose 'Contains' instead of 'Starts with' to find the string anywhere in the address</li>
40
</ul>
41
</li>
42
	<li>Date of birth
43
<ul>
44
	<li>Birthdates should be entered using the format set forth in the dateformat preference.</li>
45
</ul>
46
</li>
47
<li>Sort field 1
48
<ul>
49
	<li>This is a custom field that libraries can use for any type of data about the patron.</li>
50
</ul>
51
</li>
52
<li>Sort field 2
53
<ul>
54
	<li>This is a custom field that libraries can use for any type of data about the patron.</li>
55
</ul>
56
</li>
57
</ul>
58
59
<p>You can also choose to either search for fields that start with the string you entered or contain the string. Choosing 'Contains' will work like a wildcard search.</p>
60
61
<p>You can also choose how your results will be sorted by using the 'Order by' pull down menu at the end of the form.</p>
62
63
<p>You can also browse through the patron records by clicking on the linked letters across the top.</p>
64
65
<p><strong>See the full documentation for the Patrons module in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html">manual</a> (online).</strong></p>
66
	
67
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/members-update.tt (-13 lines)
Lines 1-13 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Update patron records</h1>
4
5
<p>If you are allowing patrons to edit their accounts via the OPAC with the OPACPatronDetails preference then you will need to approve all changes via the staff client before they're applied. If there are patron edits awaiting action they will appear on the staff client dashboard below the modules list (along with other items awaiting action).</p>
6
7
<p>When you click the 'Patrons requesting modifications' link you will be brought to a list of patrons with requested changes.</p>
8
9
<p>From here you can 'Approve' and apply the changes to the patron record, 'Delete' and remove the changes or 'Ignore' and keep the changes pending to review later.</p>
10
11
<p><strong>See the full documentation for Updating patron records in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#managing-patron-self-edits">manual</a> (online).</strong></p>
12
13
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/moremember.tt (-144 lines)
Lines 1-144 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patron details</h1>
4
5
<p>When viewing a patron record you have the option to view information from one of many tabs found on the left hand side of the record.</p>
6
7
<h2>Check Out</h2>
8
9
<p>For instruction on checking items out click the Check Out tab and read the help file there.</p>
10
11
<h2>Details</h2>
12
13
<p>All patron information will appear on the Details tab. This includes all the contact information, notes, messaging preferences, etc entered when adding the patron. In the case of patrons who are marked as 'Child' or 'Professional' and their Guarantors additional information will appear on their record.</p>
14
15
<ul>
16
<li>A child patron will list their Guarantor</li>
17
<li>On the Guarantor's record, all children and/or professionals will be listed</li>
18
</ul>
19
20
<p>Below the patron's information on the details screen is a tabbed display of the items they have checked out, overdue, and on hold.</p>
21
22
<p>If they have family at the library staff can see what the other family members have checked out.</p>
23
24
<h2>Fines</h2>
25
26
<p>The patron's complete accounting history will appear on the Fines tab. Contrary to its name, the Fines tab does not just show fine data, it also shows membership fees, rental fees, reserve fees and any other charge you may have for patrons.</p>
27
28
<h2>Routing Lists</h2>
29
30
<p>A list of all of the serial routing lists the patron belongs to will be accessible via the 'Routing Lists' tab on the patron record.</p>
31
32
<p>On this tab you will be able to see and edit all of the routing lists that this patron is on.</p>
33
34
<h2>Circulation History</h2>
35
36
<p>The circulation history tab will appear if you have set the intranetreadinghistory preference to allow it to appear. If you have the OPACPrivacy system preference set to 'Allow' and the patron has decided that the library cannot keep this information this tab will only show currently checked out items.</p>
37
38
<h2>Modification Log</h2>
39
40
<p>If you have set your BorrowersLog to track changes to patron records, then this tab will appear. The Modification Log will show all changes made to the patron record.</p>
41
42
<ul>
43
<li>The Librarian field shows the patron number for the librarian who made the changes</li>
44
<li>The Object field lists the patron that is being modified</li>
45
</ul>
46
47
<h2>Notices</h2>
48
49
<p>The patron's messaging preferences are set when adding or editing the patron. This tab will show the messages that have been sent and those that are queued to be sent</p>
50
51
<p>Clicking on the message title will expand the view to show you the full text of the message that was sent.</p>
52
53
<h2>Statistics</h2>
54
55
<p>Depending on what you set for the values of your StatisticsFields system preference, you can see statistics for one patron's circulation actions.</p>
56
57
<h2>Files</h2>
58
59
<p>If you set the EnableBorrowerFiles preference to 'Do' the Files tab will be visible on the patron information page.</p>
60
61
<p>From here you can upload files to attach to the patron record.</p>
62
63
<p>All files that are uploaded will appear above a form where additional files can be uploaded from.</p>
64
65
<h2>Purchase Suggestions</h2>
66
67
<p>If the patron has made any purchase suggestions you will see a purchase suggestions tab on the patron record.</p>
68
69
<p>From here you can see all suggestions made by the patron and their status, you can also create a purchase suggestion on the patron's behalf by clicking the 'New purchase suggestion' button at the top.</p>
70
71
<p>Learn more about Purchase suggestions in the Acquisitions chapter of the manual.</p>
72
73
<h2>Patron discharges</h2>
74
75
<p>A discharge is a certificate that says the patron has no current checkouts, no holds and owe no money. To enable this option on the patron record you need to set the useDischarge system preference to 'Allow'.</p>
76
77
<p>Note: In France a "quitus" ("discharge") is needed if you want to register for an account in a library or a university).</p>
78
79
<p>Note: Academic libraries often require that you have a clear record at the library before you can graduate.</p>
80
81
<p>To generate a discharge for a patron click the 'Discharge' tab on the left of the patron record</p>
82
83
<p>If the patron can have a discharge generated then it will have a button that says 'Generate discharge'</p>
84
85
<p>If not then you'll see an error explaining why you can't discharge the patron.</p>
86
87
<p>Once the letter is generated you will have a PDF to download</p>
88
89
<h2>Editing Patrons</h2>
90
91
<p>Patrons in Koha can be edited using one of many edit buttons.</p>
92
93
<ul>
94
	<li>To edit the entire patron record simply click the 'Edit' button at the top of the patron record.</li>
95
	<li>To only change the patron's password, click the 'Change Password' button
96
<ul>
97
    <li>Koha cannot display existing passwords. Leave the field blank to leave password unchanged.</li>
98
    <li>This form can automatically generate a random password if you click the link labeled "Click to fill with a randomly generated suggestion. Passwords will be displayed as text."</li>
99
</ul>
100
</li>
101
	<li>To edit a specific section of the patron record (for example the Library Use section) click the 'Edit' link below the section</li>
102
	<li>A patron image can be added by browsing for the image on your machine from the 'Manage Patron Image' section
103
<ul>
104
    <li>This form will not appear if you have the patronimages system preference to not allow patron images</li>
105
	<li>To add patron images in bulk, use the Upload Patron Images Tool</li>
106
</ul>
107
</li>
108
	<li>Patrons can also be blocked from checking items out by setting Patron Flags
109
<ul>
110
	<li>If you would like your circulation staff to confirm a patron's address before checking items out to the patron, you can see the 'Gone no Address' flag</li>
111
    <li>If you would like to bar a patron from the library you can set the 'Restricted' flag
112
<ul>
113
    <li>This flag can automatically be set with the Overdue/Notice StatusTriggers</li>
114
</ul>
115
</li>
116
    <li>If you enter in a date and/or note related to the restriction you will see that in the restricted message as well</li>
117
	<li>If the patron reports that they have lost their card you can set the 'Lost Card' flag to prevent someone else from using that card to check items out</li>
118
</ul>
119
</li>
120
    <li>Children patrons do not become adults automatically in Koha. To upgrade a child patron to and adult patron category click on the 'More' menu and choose 'Update Child to Adult Patron'
121
<ul>
122
    <li>You will then be presented with a pop up window asking which one of your adult patron categories this Child should be updated to</li>
123
</ul>
124
</li>
125
</ul>
126
127
<h2>Duplicate a Patron</h2>
128
129
<p>Sometimes when you're adding a new family to your system you don't want to type the contact information over and over. Koha allows for you to duplicate a patron and change only the parts you want to (or need to) change.</p>
130
131
<ul>
132
	<li>Open the patron you want to use as your base (the patron you want to duplicate information from)</li>
133
	<li>Click the 'Duplicate' button at the top of their record</li>
134
	<li>All of the fields with the exception of first name, card number, opac login and opac password have been duplicated. Fill in the missing pieces and click 'Save'
135
<ul>
136
	<li><span style="background-color: #ffe599;">TIP: Clicking in a field that is already populated with data will clear that field of all information (making it easier for you to type in something different)</span></li>
137
</ul>
138
</li>
139
	<li>You will be brought to your new patron</li>
140
</ul>
141
142
<p><strong>See the full documentation for the Patron Details in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#patron-information">manual</a> (online).</strong></p>
143
144
[% INCLUDE 'help-bottom.inc' %]
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/notices.tt (-11 lines)
Lines 1-11 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Patron notices</h1>
4
5
<p>The patron's messaging preferences are set when adding or editing the patron. This tab will show the messages that have been sent and those that are queued to be sent</p>
6
7
<p>Clicking on the message title will expand the view to show you the full text of the message that was sent.</p>
8
9
<p><strong>See the full documentation for Patron Notices in the <a href="http://koha-community.org/manual/[% helpVersion %]/en/html/patrons.html#notices">manual</a> (online).</strong></p>
10
11
[% INCLUDE 'help-bottom.inc' %]
<
(-)a/koha-tmpl/intranet-tmpl/prog/en/modules/help/members/pay.tt (-62 lines)
Lines 1-62 Link Here
1
[% INCLUDE 'help-top.inc' %]
2
3
<h1>Pay and Writeoff Fines</h1>
4
5
<p>Each line item can be paid in full (or written off) using the 'Pay Fines' tab.</p>
6
7
<ul>
8
    <li>Each line item can be paid in full, partially paid, or written off.</li>
9
    <li>Pay a fine in full
10
<ul>
11
	<li>Click "Pay" next to the fine you want to pay in full</li>
12
	<li>The full amount of the fine will be populated for you in the "Collect From Patron" box</li>
13
    <li>Click "Confirm"</li>
14
	<li>The fine will be removed from outstanding fines, and displayed as fully paid.</li>
15
</ul>
16
</li>
17
    <li>Pay a partial fine
18
<ul>
19
	<li>Click "Pay" next to the fine you want to partially pay</li>
20
	<li>Enter the amount you are collecting from the patron in the "Collect From Patron" box</li>
21
    <li>Click "Confirm"</li>
22
	<li>The fine will be updated to show the original Amount, and the current Amount Outstanding</li>
23
</ul>
24
</li>
25
    <li>Pay an amount towards all fines
26
<ul>
27
	<li>Click the "Pay Amount" button</li>
28
	<li>Enter the amount you are collecting from the patron in "Collect from Patron." The sum of all fines is shown in "Total Amount Outstanding"</li>
29
	<li>Click "Confirm"</li>
30
	<li>The fine totals will be updated with the payment applied to oldest fines first.</li>
31
</ul>
32
</li>
33
    <li>Pay Selected fines
34
<ul>
35
	<li>Check the selection boxes next to the fines you wish to pay, click "Pay Selected"</li>
36
	<li>Enter an amount to pay towards the fines.</li>
37
	<li>Click "Confirm"</li>
38
	<li>The fine totals will be updated with the payment applied to the oldest selected fines first.</li>
39
</ul>
40
</li>
41
    <li>Writeoff a single fine
42
<ul>
43
    <li>Click "Writeoff" next to the fine you wish to writeoff.</li>
44
    <li>The fine will be removed from outstanding fines, and displayed as written off.</li>
45
</ul>
46
</li>
47
    <li>Writeoff All fines
48
<ul>
49
    <li>Click the "Writeoff All" button</li>
50
    <li>All fines will be removed from outstanding fines, and displayed as written off.</li>
51
</ul>
52
</li>