Introduction
============
-`Koha Basics <#introbasics>`__
+.. _koha-basics-label:
+
+Koha Basics
------------------------------
Koha is the first free and open source software library automation
Learn more about Koha by visiting the official Koha website:
http://koha-community.org
-`Koha Recommendations <#introrecommend>`__
+.. _koha-recommendations-label:
+
+Koha Recommendations
------------------------------------------
Full system recommendations can be found on the official Koha wiki along
Internet Explorer and has not yet been fully optimized for Google
Chrome.
-`Using this Manual <#usingmanual>`__
+.. _using-this-manual-label:
+
+Using this Manual
------------------------------------
This manual is always changing and suggestions for edits can be sent to
Links will be found throughout the manual to other sections in the
manual and images will depict what should be seen on the screen.
-`Contributing to the Manual <#contributing>`__
+.. _contributing-to-the-manual-label:
+
+Contributing to the Manual
----------------------------------------------
This manual is an ever-changing document and edits to the manual are
Administration
==============
-`Global System Preferences <#globalsysprefs>`__
+.. _global-system-preferences-label:
+
+Global System Preferences
-----------------------------------------------
Global system preferences control the way your Koha system works in
|image4|
If the preference refers to monetary values (like
-`maxoutstanding <#maxoutstanding>`__) the currency displayed will be the
+:ref:`maxoutstanding`) the currency displayed will be the
default you set in your :ref:`Currencies and Exchange Rates`
administration area. In the examples to
follow they will all read USD for U.S. Dollars.
highlighted terms. Consult with your system administrator for more
information.
-`Acquisitions <#acqprefs>`__
+.. _acquisitions-label:
+
+Acquisitions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences >
Acquisitions
-`Policy <#acqprefspolicy>`__
+.. _policy-label:
+
+Policy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AcqCreateItem <#AcqCreateItem>`__
+.. _acqcreateitem-label:
+
+AcqCreateItem
''''''''''''''''''''''''''''''''''
Default: placing an order
acquisitions at all, you will need to go to the cataloging module to
add the items.
-`AcqEnableFiles <#AcqEnableFiles>`__
+.. _acqenablefiles-label:
+
+AcqEnableFiles
''''''''''''''''''''''''''''''''''''
Default: Don't
- This preference controls whether or not you allow the uploading of
invoice files via the acquisitions module.
-`AcqItemSetSubfieldsWhenReceiptIsCancelled <#AcqItemSetSubfieldsWhenReceiptIsCancelled>`__
+.. _acqitemsetsubfieldswhenreceiptiscancelled-label:
+
+AcqItemSetSubfieldsWhenReceiptIsCancelled
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Upon cancelling a receipt, update the item's subfields if they
7=0 in this preference. That will set the Not for Loan status
(subfield 7) to 0 which is available.
-`AcqViewBaskets <#AcqViewBaskets>`__
+.. _acqviewbaskets-label:
+
+AcqViewBaskets
''''''''''''''''''''''''''''''''''''
Default: created by staff member
of owner). Regardless of which value you choose for this preference,
superlibrarians can see all baskets created in the system.
-`AcqWarnOnDuplicateInvoice <#AcqWarnOnDuplicateInvoice>`__
+.. _acqwarnonduplicateinvoice-label:
+
+AcqWarnOnDuplicateInvoice
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Do not warn
- Warn
-`BasketConfirmations <#BasketConfirmations>`__
+.. _basketconfirmations-label:
+
+BasketConfirmations
''''''''''''''''''''''''''''''''''''''''''''''
Default: always ask for confirmation
reopening a basket. If you skip the confirmation, you do not create a
new basket group.
-`ClaimsBccCopy <#ClaimsBccCopy>`__
+.. _claimsbcccopy-label:
+
+ClaimsBccCopy
''''''''''''''''''''''''''''''''''
Default: Don't send
Acquisitions module this preference will allow for
the sending of a copy of the email to the librarian.
-`CurrencyFormat <#CurrencyFormat>`__
+.. _currencyformat-label:
+
+CurrencyFormat
''''''''''''''''''''''''''''''''''''
Default: 360,000.00 (US)
- 360 000,00 (FR)
-`gist <#gist>`__
+.. _gist-label:
+
+gist
''''''''''''''''
Default: 0
Enter this value as a number (.06) versus a percent (6%).
-`MarcFieldsToOrder <#MarcFieldsToOrder>`__
+.. _marcfieldstoorder-label:
+
+MarcFieldsToOrder
''''''''''''''''''''''''''''''''''''''''''
Asks: Set the mapping values for a new order line created from a MARC
quantity: 969$h
budget_code: 922$a
-`MarcItemFieldsToOrder <#MarcItemFieldsToOrder>`__
+.. _marcitemfieldstoorder-label:
+
+MarcItemFieldsToOrder
''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Set the mapping values for new item records created from a MARC record
in a staged file.
-`UniqueItemFields <#UniqueItemFields>`__
+.. _uniqueitemfields-label:
+
+UniqueItemFields
''''''''''''''''''''''''''''''''''''''''
Default: barcode
barcode can be created in acquisitions which will cause errors later
when checking items in and out.
-`Printing <#acqprefsprinting>`__
+.. _printing-label:
+
+Printing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`OrderPdfFormat <#OrderPdfFormat>`__
+.. _orderpdfformat-label:
+
+OrderPdfFormat
''''''''''''''''''''''''''''''''''''
Default: pdfformat::layout2pages
Asks: Use \_\_\_ when printing basket groups.
-`Administration <#adminprefs>`__
+.. _administration-label:
+
+Administration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These preferences are general settings for your system.
*Get there:* More > Administration > Global System Preferences >
Administration
-`CAS Authentication <#casauthentication>`__
+.. _cas-authentication-label:
+
+CAS Authentication
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The Central Authentication Service (CAS) is a single sign-on protocol
for the web. If you don't know what this is, leave these preferences set
to their defaults.
-`casAuthentication <#casAuthentication>`__
+.. _casauthentication-label:
+
+casAuthentication
''''''''''''''''''''''''''''''''''''''''''
Default: Don't use
Asks: \_\_\_ CAS for login authentication.
-`casLogout <#casLogout>`__
+.. _caslogout-label:
+
+casLogout
''''''''''''''''''''''''''
Default: Don't logout
Asks: \_\_\_ of CAS when logging out of Koha.
-`casServerUrl <#casServerUrl>`__
+.. _casserverurl-label:
+
+casServerUrl
''''''''''''''''''''''''''''''''
Asks: The CAS Authentication Server can be found at \_\_\_
-`Google OpenID Connect <#googleopenid>`__
+.. _google-openid-connect-label:
+
+Google OpenID Connect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit the `Google Developers
OAuth Client ID and Secret
|image11|
-`GoogleOAuth2ClientID <#GoogleOAuth2ClientID>`__
+.. _googleoauth2clientid-label:
+
+GoogleOAuth2ClientID
''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Google OAuth2 Client ID \_\_\_
-`GoogleOAuth2ClientSecret <#GoogleOAuth2ClientSecret>`__
+.. _googleoauth2clientsecret-label:
+
+GoogleOAuth2ClientSecret
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Google OAuth2 Client Secret \_\_\_
-`GoogleOpenIDConnect <#GoogleOpenIDConnect>`__
+.. _googleopenidconnect-label:
+
+GoogleOpenIDConnect
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't use
- Use
-`GoogleOpenIDConnectDomain <#GoogleOpenIDConnectDomain>`__
+.. _googleopenidconnectdomain-label:
+
+GoogleOpenIDConnectDomain
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Google OpenID Connect Restrict to domain (or subdomain of this
Leave blank for all google domains
-`Interface options <#adminprefsinterface>`__
+.. _interface-options-label:
+
+Interface options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
These preference are related to your Koha interface
-`DebugLevel <#DebugLevel>`__
+.. _debuglevel-label:
+
+DebugLevel
''''''''''''''''''''''''''''
Default: lots of
in working out the bugs (errors or problems) quickly. Having detailed
error messages makes quick fixes more likely in problem areas.
-`DefaultToLoggedInLibraryCircRules <#DefaultToLoggedInLibraryCircRules>`__
+.. _defaulttologgedinlibrarycircrules-label:
+
+DefaultToLoggedInLibraryCircRules
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: all libraries
found at the top of the :ref:`Circulation and Fine
Rules`.
-`DefaultToLoggedInLibraryNoticesSlips <#DefaultToLoggedInLibraryNoticesSlips>`__
+.. _defaulttologgedinlibrarynoticesslips-label:
+
+DefaultToLoggedInLibraryNoticesSlips
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: all libraries
- This preference controls the default value in the branch pull down
found at the top of the :ref:`Notices & Slips` tool.
-`DefaultToLoggedInLibraryOverdueTriggers <#DefaultToLoggedInLibraryOverdueTriggers>`__
+.. _defaulttologgedinlibraryoverduetriggers-label:
+
+DefaultToLoggedInLibraryOverdueTriggers
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: all libraries
- This preference controls the default value in the branch pull down
found at the top of the :ref:`Overdue Notice/Status Triggers`.
-`delimiter <#delimiter>`__
+.. _delimiter-label:
+
+delimiter
''''''''''''''''''''''''''
Default: semicolons
separate data. In many cases you will be able to change this option
when exporting if you'd like.
-`KohaAdminEmailAddress <#KohaAdminEmailAddress>`__
+.. _kohaadminemailaddress-label:
+
+KohaAdminEmailAddress
''''''''''''''''''''''''''''''''''''''''''''''''''
This is the default 'From' address for emails unless there is one for
this purpose so that if one librarian is out the others can address
these requests. This email address can be changed when needed.
-`noItemTypeImages <#noItemTypeImages>`__
+.. _noitemtypeimages-label:
+
+noItemTypeImages
''''''''''''''''''''''''''''''''''''''''
Default: Show
item types are disabled, text labels for item types will still appear
in the OPAC and Staff Client.
-`ReplytoDefault <#ReplytoDefault>`__
+.. _replytodefault-label:
+
+ReplytoDefault
''''''''''''''''''''''''''''''''''''
Asks: Use \_\_\_ as the email address that will be set as the replyto in
address <#libraries-groups>`__, if you would like to specify a default
email address for all replies to notices you can do that here.
-`ReturnpathDefault <#ReturnpathDefault>`__
+.. _returnpathdefault-label:
+
+ReturnpathDefault
''''''''''''''''''''''''''''''''''''''''''
Asks: Use \_\_\_ as the email address set as the return path, if you
address <#libraries-groups>`__, if you would like to specify a default
email address for bounces to go to then fill in this preference.
-`virtualshelves <#virtualshelves>`__
+.. _virtualshelves-label:
+
+virtualshelves
''''''''''''''''''''''''''''''''''''
Default: Allow
allow" then no one will be able to save items to public or private
lists.
-`Login options <#adminprefslogin>`__
+.. _login-options-label:
+
+Login options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
These preferences are related to logging into your Koha system
-`AutoLocation <#AutoLocation>`__
+.. _autolocation-label:
+
+AutoLocation
''''''''''''''''''''''''''''''''
Default: Don't require
authorized. When set to 'Don't require', anyone with a staff client
login will have access no matter which IP address they are using.
-`IndependentBranches <#IndependentBranches>`__
+.. _independentbranches-label:
+
+IndependentBranches
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't prevent
It is important that this value be set before going live and that it
NOT be changed
-`IndependentBranchesPatronModifications <#IndependentBranchesPatronModifications>`__
+.. _independentbranchespatronmodifications-label:
+
+IndependentBranchesPatronModifications
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: No
- Yes
-`SessionRestrictionByIP <#SessionRestrictionByIP>`__
+.. _sessionrestrictionbyip-label:
+
+SessionRestrictionByIP
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Enable
recommended otherwise because it is removing important security
features from your staff client.
-`SessionStorage <#SessionStorage>`__
+.. _sessionstorage-label:
+
+SessionStorage
''''''''''''''''''''''''''''''''''''
Default: in the MySQL database
- This preference allows administrators to choose what format session
data is stored in during web sessions.
-`timeout <#timeout>`__
+.. _timeout-label:
+
+timeout
''''''''''''''''''''''
Default: 12000000
time before a session times out must be the same for both the Staff
Client and the OPAC.
-`SSL client certificate authentication <#sslclientcertificateauthenticationprefs>`__
+.. _ssl-client-certificate-authentication-label:
+
+SSL client certificate authentication
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AllowPKIAuth <#AllowPKIAuth>`__
+.. _allowpkiauth-label:
+
+AllowPKIAuth
''''''''''''''''''''''''''''''''
Default: no
- the email address
-`Search Engine <#searchengineprefs>`__
+.. _search-engine-label:
+
+Search Engine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`SearchEngine <#SearchEngine>`__
+.. _searchengine-label:
+
+SearchEngine
''''''''''''''''''''''''''''''''
Default: Zebra
- Zebra
-`Share anonymous usage statistics <#heaprefs>`__
+.. _share-anonymous-usage-statistics-label:
+
+Share anonymous usage statistics
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
As an open source project Koha is used all over the world. These
:ref:`Share Usage Stats` cronjob to send this information at regular
intervals to the community.
-`UsageStats <#UsageStats>`__
+.. _usagestats-label:
+
+UsageStats
''''''''''''''''''''''''''''
Default: Don't share
`Hea Koha community website <http://hea.koha-community.org>`__. This
information is sent using the :ref:`Share Usage Stats` cronjob.
-`UsageStatsCountry <#UsageStatsCountry>`__
+.. _usagestatscountry-label:
+
+UsageStatsCountry
''''''''''''''''''''''''''''''''''''''''''
Asks: The country where your library is located: \_\_\_
This preference depends on the `UsageStats <#usagestats>`__
preference. Set that to 'Share' to share your information.
-`UsageStatsGeolocation <#UsageStatsGeolocation>`__
+.. _usagestatsgeolocation-label:
+
+UsageStatsGeolocation
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: blank
Asks: Geolocation of the main library: \_\_\_ Note that this value has no effect
-if the `UsageStats <#UsageStats>`__ systemp preference is set to "Don't share"
+if the :ref:`UsageStats` systemp preference is set to "Don't share"
+
+.. _usagestatslibrariesinfo-label:
-`UsageStatsLibrariesInfo <#UsageStatsLibrariesInfo>`__
+UsageStatsLibrariesInfo
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Do not Share
Asks: \_\_\_ libraries information (name, url, country) Note that this value
-has no effect if the `UsageStats <#UsageStats>`__ system preference is set to
+has no effect if the :ref:`UsageStats` system preference is set to
"Don't share"
Values:
- Share
-`UsageStatsLibraryName <#UsageStatsLibraryName>`__
+.. _usagestatslibraryname-label:
+
+UsageStatsLibraryName
''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: The library name \_\_\_ will be shown on the `Hea Koha community
field is empty data will be sent anonymously if you choose 'Share'
for the `UsageStats <#usagestats>`__ preference.
-`UsageStatsLibraryType <#UsageStatsLibraryType>`__
+.. _usagestatslibrarytype-label:
+
+UsageStatsLibraryType
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: public
This preference depends on the `UsageStats <#usagestats>`__
preference. Set that to 'Share' to share your information.
-`UsageStatsLibraryUrl <#UsageStatsLibraryUrl>`__
+.. _usagestatslibraryurl-label:
+
+UsageStatsLibraryUrl
''''''''''''''''''''''''''''''''''''''''''''''''
Asks: The library URL \_\_\_ will be shown on the `Hea Koha community
This preference depends on the `UsageStats <#usagestats>`__
preference. Set that to 'Share' to share your information.
-`Authorities <#authprefs>`__
+.. _authorities-label:
+
+Authorities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences >
Authorities
-`General <#generalauthorities>`__
+.. _general-label:
+
+General
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AuthDisplayHierarchy <#AuthDisplayHierarchy>`__
+.. _authdisplayhierarchy-label:
+
+AuthDisplayHierarchy
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't display
to broader and/or narrower see also references this preference will
turn on a display of those authorities at the top of the record.
-`AuthorityMergeLimit <#AuthorityMergeLimit>`__
+.. _authoritymergelimit-label:
+
+AuthorityMergeLimit
''''''''''''''''''''''''''''''''''''''''''''''
Default: 50
records if the number exceeds \_\_\_ records. (Above this limit, the merge_authority
cron job will merge them.)
-`AuthorityMergeMode <#AuthorityMergeMode>`__
+.. _authoritymergemode-label:
+
+AuthorityMergeMode
''''''''''''''''''''''''''''''''''''''''''''
Default: loose
- strict
-`AutoCreateAuthorities <#AutoCreateAuthorities>`__
+.. _autocreateauthorities-label:
+
+AutoCreateAuthorities
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: do not generate
to enter headings that don't match an existing authority. When
BiblioAddsAuthorities is off, this has no effect.
-`BiblioAddsAuthorities <#BiblioAddsAuthorities>`__
+.. _biblioaddsauthorities-label:
+
+BiblioAddsAuthorities
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: allow
you to search for an authority versus allowing you to type the
information in yourself.
-`MARCAuthorityControlField008 <#MARCAuthorityControlField008>`__
+.. _marcauthoritycontrolfield008-label:
+
+MARCAuthorityControlField008
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: \|\| aca\|\|aabn \| a\|a d
- This preference controls the default value in the 008 field on
Authority records. It does not effect bibliographic records.
-`UNIMARCAuthorityField100 <#UNIMARCAuthorityField100>`__
+.. _unimarcauthorityfield100-label:
+
+UNIMARCAuthorityField100
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: afrey50 ba0
Authority records cataloged in UNIMARC. It does not effect
bibliographic records.
-`UseAuthoritiesForTracings <#UseAuthoritiesForTracings>`__
+.. _useauthoritiesfortracings-label:
+
+UseAuthoritiesForTracings
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't use
perform a keyword search against those fields, finding all possible
relevant results instead.
-`Linker <#linkerauthorities>`__
+.. _linker-label:
+
+Linker
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
These preferences will control how Koha links bibliographic records to
(misc/link\_bibs\_to\_authorities.pl) that your system administrator can
run to link records together.
-`CatalogModuleRelink <#CatalogModuleRelink>`__
+.. _catalogmodulerelink-label:
+
+CatalogModuleRelink
''''''''''''''''''''''''''''''''''''''''''''''
Default: Do not
linking should set CatalogModuleRelink to 'Do'. Once setting this to
'Do' the following preferences can also be set.
-`LinkerKeepStale <#LinkerKeepStale>`__
+.. _linkerkeepstale-label:
+
+LinkerKeepStale
''''''''''''''''''''''''''''''''''''''
Default: Do not
- When set to 'Do', the linker will never remove a link to an authority
record, though, depending on the value of
- `LinkerRelink <#LinkerRelink>`__, it may change the link.
+ :ref:`LinkerRelink`, it may change the link.
+
+.. _linkermodule-label:
-`LinkerModule <#LinkerModule>`__
+LinkerModule
''''''''''''''''''''''''''''''''
Default: Default
- Retains Koha's previous behavior of only creating links when there
is an exact match to one and only one authority record; if the
- `LinkerOptions <#LinkerOptions>`__ preference is set to
+ :ref:`LinkerOptions` preference is set to
'broader\_headings', it will try to link headings to authority
records for broader headings by removing subfields from the end of
the heading
- This preference tells Koha which match to use when searching for
authority matches when saving a record.
-`LinkerOptions <#LinkerOptions>`__
+.. _linkeroptions-label:
+
+LinkerOptions
''''''''''''''''''''''''''''''''''
Asks: Set the following options for the authority linker \_\_\_
Next: Camins-Esakov, Jared (matches! if a previous attempt had
matched, it would not have tried this)
-`LinkerRelink <#LinkerRelink>`__
+.. _linkerrelink-label:
+
+LinkerRelink
''''''''''''''''''''''''''''''''
Default: Do
heading with an existing link will be ignored, even if the existing
link is invalid or incorrect.
-`Cataloging <#catprefs>`__
+.. _cataloging-label:
+
+Cataloging
~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences >
Cataloging
-`Display <#catdisplayprefs>`__
+.. _display-label:
+
+Display
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AcquisitionDetails <#AcquisitionDetails>`__
+.. _acquisitiondetails-label:
+
+AcquisitionDetails
''''''''''''''''''''''''''''''''''''''''''''
Default: Display
for the title. This tab will include links to order information
stored in the acquisitions module.
-`AuthoritySeparator <#authoritysep>`__
+.. _authorityseparator-label:
+
+AuthoritySeparator
''''''''''''''''''''''''''''''''''''''
Default: --
Asks: Separate multiple displayed authors, series or subjects with
\_\_\_.
-`hide\_marc <#hide_marc>`__
+.. _hide\_marc-label:
+
+hide\_marc
'''''''''''''''''''''''''''
Default: Display
MARC editor without tags showing
|image16|
-`IntranetBiblioDefaultView <#IntranetBiblioDefaultView>`__
+.. _intranetbibliodefaultview-label:
+
+IntranetBiblioDefaultView
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: ISBD form
- ISBD form -- displays records in the staff client in the old card
catalog format
- - See `ISBD <#isbdpref>`__ preference for more information
+ - See :ref:`ISBD` preference for more information
- Labelled MARC form -- displays records in the staff client in MARC
with text labels to explain the different fields
- This setting determines the bibliographic record display when
searching the catalog on the staff client. This setting does not
affect the display in the OPAC which is changed using the
- `BiblioDefaultView <#BiblioDefaultView>`__ preference under the OPAC
+ :ref:`BiblioDefaultView` preference under the OPAC
preference tab. This setting changes the look of the record when
first displayed. The MARC and ISBD views can still be seen by
clicking in the sidebar.
-`ISBD <#isbdpref>`__
+.. _isbd-label:
+
+ISBD
''''''''''''''''''''
-Default: `MARC21 Default Appendix <#isbddefault>`__ or `UNIMARC Default
-Appendix <#unimarcdefault>`__
+Default: :ref:`MARC21 Default Appendix <marc-default-label>` or :ref:`UNIMARC Default
+Appendix <unimarc-default-label>`
Asks: Use the following as the ISBD template:
international exchange of bibliographic records for a variety of
materials.
-`LabelMARCView <#LabelMARCView>`__
+.. _labelmarcview-label:
+
+LabelMARCView
''''''''''''''''''''''''''''''''''
Default: Don't
MARC View in the Staff Client with LabelMARCView set to Don't
|image18|
-`MergeReportFields <#MergeReportFields>`__
+.. _mergereportfields-label:
+
+MergeReportFields
''''''''''''''''''''''''''''''''''''''''''
Asks: \_\_\_ fields to display for deleted records after merge
- all subfields of fields 600
-`NotesBlacklist <#NotesBlacklist>`__
+.. _notesblacklist-label:
+
+NotesBlacklist
''''''''''''''''''''''''''''''''''''
Asks: Don't show these \_\_\_ note fields in title notes separator (OPAC
values as a comma separated list. For example to hide the local note
and the bibliography note in MARC21 enter 504, 590.
-`OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and OpacSuppressionMessage <#OpacSuppression>`__
+.. _opacsuppression,-opacsuppressionbyiprange,-opacsuppressionredirect,-and-opacsuppressionmessage-label:
+
+OpacSuppression, OpacSuppressionByIPRange, OpacSuppressionRedirect, and OpacSuppressionMessage
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
OpacSuppression Default: Don't hide
**Note**
- An `authorized value <#authorizedvalues>`__ for the MARC21 942$n
+ An :ref:`authorized value <authorized-values-label>` for the MARC21 942$n
field (or the equivalent UNIMARC field) should be set to
eliminate errors. One example would be to create an authorized
value titled SUPPRESS with a value of 0 for don't suppress and 1
that they are suppressed from view in the OPAC.Suppressed in Staff
This note can be styled by using the
- `IntranetUserCSS <#IntranetUserCSS>`__ preference to stand out more
+ :ref:`IntranetUserCSS` preference to stand out more
if you'd like.Style suppression note
-`SeparateHoldings & SeparateHoldingsBranch <#SeparateHoldings>`__
+.. _separateholdings-&-separateholdingsbranch-label:
+
+SeparateHoldings & SeparateHoldingsBranch
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
SeparateHoldings default: Don't separate
Separate holdings tabs
|image19|
-`URLLinkText <#URLLinkText>`__
+.. _urllinktext-label:
+
+URLLinkText
''''''''''''''''''''''''''''''
Default: Online Resource
will say 'Click here to access online.' If you would like the field
to say something else enter that in this field.
-`UseControlNumber <#UseControlNumber>`__
+.. _usecontrolnumber-label:
+
+UseControlNumber
''''''''''''''''''''''''''''''''''''''''
Default: Don't use
Unless you are going in and manually changing 773$w to match your
rigorously-defined bibliographic relationships, you should set this
preference to "Don't use" and instead set
- `EasyAnalyticalRecords <#EasyAnalyticalRecords>`__ to "Display"
+ :ref:`EasyAnalyticalRecords` to "Display"
Description:
"Journal of Interesting Things" and "Transactions of the Interesting
Stuff Society" respectively.
-`Exporting <#catexportprefs>`__
+.. _exporting-label:
+
+Exporting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`BibtexExportAdditionalFields <#BibtexExportAdditionalFields>`__
+.. _bibtexexportadditionalfields-label:
+
+BibtexExportAdditionalFields
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Include following fields when exporting BibTeX
- Use '@' ( with quotes ) as the BT\_TAG to replace the bibtex record
type with a field value of your choosing.
-`RisExportAdditionalFields <#RisExportAdditionalFields>`__
+.. _risexportadditionalfields-label:
+
+RisExportAdditionalFields
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Include following fields when exporting RIS
- Use of TY ( record type ) as a key will *replace* the default TY with
the field value of your choosing.
-`Importing <#catimportprefs>`__
+.. _importing-label:
+
+Importing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AggressiveMatchOnISBN <#AggressiveMatchOnISBN>`__
+.. _aggressivematchonisbn-label:
+
+AggressiveMatchOnISBN
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: don't
**Important**
Note that this preference has no effect if
- `UseQueryParser <#UseQueryParser>`__ is on.
+ :ref:`UseQueryParser` is on.
-`AggressiveMatchOnISSN <#AggressiveMatchOnISSN>`__
+.. _aggressivematchonissn-label:
+
+AggressiveMatchOnISSN
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: don't
Asks: When matching on ISSN with the record import tool, \_\_\_ attempt
to match aggressively by trying all variations of the ISSNs in the imported
record as a phrase in the ISSN fields of already cataloged records. Note that
-this preference has no effect if `UseQueryParser <#UseQueryParser>`__ is on.
+this preference has no effect if :ref:`UseQueryParser` is on.
+
+.. _interface-label:
-`Interface <#catinterfaceprefs>`__
+Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`advancedMARCeditor <#advancedMARCeditor>`__
+.. _advancedmarceditor-label:
+
+advancedMARCeditor
''''''''''''''''''''''''''''''''''''''''''''
Default: Don't display
MARC editor without text labels
|image21|
-`DefaultClassificationSource <#DefaultClassificationSource>`__
+.. _defaultclassificationsource-label:
+
+DefaultClassificationSource
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Dewey Decimal System
Adding another classification under Administration > Classification Sources
will make it show up in this list as well.
-`EasyAnalyticalRecords <#EasyAnalyticalRecords>`__
+.. _easyanalyticalrecords-label:
+
+EasyAnalyticalRecords
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't Display
**Important**
If you decide to use this feature you'll want to make sure that your
- `UseControlNumber <#UseControlNumber>`__ preference is set to "Don't
+ :ref:`UseControlNumber` preference is set to "Don't
use" or else the "Show analytics" links in the staff client and the
OPAC will be broken.
new menu options to the staff cataloging detail pages to allow that
to happen.
-`Record Structure <#catrecordprefs>`__
+.. _record-structure-label:
+
+Record Structure
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AlternateHoldingsField & AlternateHoldingsSeparator <#AlternateHoldingsField>`__
+.. _alternateholdingsfield-&-alternateholdingsseparator-label:
+
+AlternateHoldingsField & AlternateHoldingsSeparator
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Display MARC subfield \_\_\_ as holdings information for records
Alternate Holdings Display
|image22|
-`autoBarcode <#autoBarcode>`__
+.. _autobarcode-label:
+
+autoBarcode
''''''''''''''''''''''''''''''
Default: generated in the form <branchcode>yymm0001
field in the framework. Set the plugin for 952$p (if using MARC21 or
equivalent field mapped to items.barcode in your local MARC format)
for your frameworks to barcode\_manual.pl instead of barcode.pl.
- Learn more about editing frameworks under the `MARC Bibliographic
- Frameworks <#marcbibframeworks>`__ section of this manual.
+ Learn more about editing frameworks under the :ref:`MARC Bibliographic
+ Frameworks <marc-bibliographic-frameworks-label>` section of this manual.
-`DefaultLanguageField008 <#DefaultLanguageField008>`__
+.. _defaultlanguagefield008-label:
+
+DefaultLanguageField008
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Empty defaults to eng
This preference won't have any effect if your records are in
UNIMARC.
-`item-level\_itypes <#item-level_itypes>`__
+.. _item-level\_itypes-label:
+
+item-level\_itypes
'''''''''''''''''''''''''''''''''''''''''''
Default: specific item
Item Type Icons to the Left of Result Information
|image23|
-`itemcallnumber <#itemcallnumber>`__
+.. _itemcallnumber-label:
+
+itemcallnumber
''''''''''''''''''''''''''''''''''''
Default: 082ab
- Dewey: 082ab or 092ab; LOC: 050ab or 090ab; from the item record:
852hi
-`marcflavour <#marcflavour>`__
+.. _marcflavour-label:
+
+marcflavour
''''''''''''''''''''''''''''''
Default: MARC21
Changing the value of this preference will not convert your records
from one MARC style to an other.
-`MARCOrgCode <#MARCOrgCode>`__
+.. _marcorgcode-label:
+
+MARCOrgCode
''''''''''''''''''''''''''''''
Default: OSt
This preference won't have any effect if your records are in
UNIMARC.
-`NewItemsDefaultLocation <#NewItemsDefaultLocation>`__
+.. _newitemsdefaultlocation-label:
+
+NewItemsDefaultLocation
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: When items are created, give them the temporary location of \_\_\_
(should be a location code, or blank to disable).
-`PrefillItem <#PrefillItem>`__
+.. _prefillitem-label:
+
+PrefillItem
''''''''''''''''''''''''''''''
Default: the new item is not prefilled with last created item values.
Using the options here you can choose to have your next new item
prefill with the values used in the last item was added to save time
typing values or to have the item form appear completely blank. Using
- `SubfieldsToUseWhenPrefill <#SubfieldsToUseWhenPrefill>`__ you can
+ :ref:`SubfieldsToUseWhenPrefill` you can
control specifically which fields are prefilled.
-`SubfieldsToAllowForRestrictedBatchmod <#SubfieldsToAllowForRestrictedBatchmod>`__
+.. _subfieldstoallowforrestrictedbatchmod-label:
+
+SubfieldsToAllowForRestrictedBatchmod
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Define a list of subfields for which editing is authorized when
Description:
- This preference lets you define what fields can be edited via the
- `batch item modification tool <#batchmodifyitems>`__ if the
+ :ref:`batch item modification tool <batch-item-modification-label>` if the
items\_batchmod\_restricted permission is enabled.
**Note**
The FA framework is excluded from the permission. If the pref is
empty, no fields are restricted.
-`SubfieldsToAllowForRestrictedEditing <#SubfieldsToAllowForRestrictedEditing>`__
+.. _subfieldstoallowforrestrictedediting-label:
+
+SubfieldsToAllowForRestrictedEditing
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Define a list of subfields for which editing is authorized when
The Fast Add (FA) framework is excluded from the permission. If
the pref is empty, no fields are restricted.
-`SubfieldsToUseWhenPrefill <#SubfieldsToUseWhenPrefill>`__
+.. _subfieldstousewhenprefill-label:
+
+SubfieldsToUseWhenPrefill
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Define a list of subfields to use when prefilling items \_\_\_
Description:
-- When the `PrefillItem <#PrefillItem>`__ preference is set to prefill
+- When the :ref:`PrefillItem` preference is set to prefill
item values with those from the last added item, this preference can
control which fields are prefilled (and which are not). Enter a space
separated list of fields that you would like to prefill when adding a
new item.
-`UNIMARCField100Language <#UNIMARCField100Language>`__
+.. _unimarcfield100language-label:
+
+UNIMARCField100Language
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: fre
Asks: Use the language (ISO 690-2) \_\_\_ as default language in the
UNIMARC field 100 when creating a new record or in the field plugin.
-`z3950NormalizeAuthor & z3950AuthorAuthFields <#z3950NormalizeAuthor>`__
+.. _z3950normalizeauthor-&-z3950authorauthfields-label:
+
+z3950NormalizeAuthor & z3950AuthorAuthFields
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Defaults: Don't copy & 701,702,700
'z3950NormalizeAuthor' is set to "Copy". The default field are 700,
701, and 702.
-`Spine Labels <#catspineprefs>`__
+.. _spine-labels-label:
+
+Spine Labels
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`SpineLabelAutoPrint <#SpineLabelAutoPrint>`__
+.. _spinelabelautoprint-label:
+
+SpineLabelAutoPrint
''''''''''''''''''''''''''''''''''''''''''''''
Default: don't
- don't
-`SpineLabelFormat <#SpineLabelFormat>`__
+.. _spinelabelformat-label:
+
+SpineLabelFormat
''''''''''''''''''''''''''''''''''''''''
Default: <itemcallnumber><copynumber>
(Enter in columns from the biblio, biblioitems or items tables,
surrounded by < and >.)
-`SpineLabelShowPrintOnBibDetails <#SpineLabelShowPrintOnBibDetails>`__
+.. _spinelabelshowprintonbibdetails-label:
+
+SpineLabelShowPrintOnBibDetails
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't display
- Don't display
-`Circulation <#circprefs>`__
+.. _circulation-label:
+
+Circulation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences >
-`Article Requests <#articlerequestsprefs>`__
+.. _article-requests-label:
+
+Article Requests
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`ArticleRequests <#ArticleRequests>`__
+.. _articlerequests-label:
+
+ArticleRequests
''''''''''''''''''''''''''''''''''''''
Default: Don't enable
- This preference controls whether or not article requests are allowed to be placed by patrons in the OPAC.
-`ArticleRequestsMandatoryFields <#ArticleRequestsMandatoryFields>`__
+.. _articlerequestsmandatoryfields-label:
+
+ArticleRequestsMandatoryFields
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: None selected
listed (Author, Chapters, Date, Issue, Pages, Title, Volume) must be completed before the article
request can be placed.
-`ArticleRequestsMandatoryFieldsItemsOnly <#ArticleRequestsMandatoryFieldsItemsOnly>`__
+.. _articlerequestsmandatoryfieldsitemsonly-label:
+
+ArticleRequestsMandatoryFieldsItemsOnly
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: None selected
listed (Author, Chapters, Date, Issue, Pages, Title, Volume) must be completed before the article
request can be placed.
-`ArticleRequestsMandatoryFieldsRecordOnly <#ArticleRequestsMandatoryFieldsRecordOnly>`__
+.. _articlerequestsmandatoryfieldsrecordonly-label:
+
+ArticleRequestsMandatoryFieldsRecordOnly
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: None selected
request can be placed.
-`Batch Checkout <#batchcheckoutprefs>`__
+.. _batch-checkout-label:
+
+Batch Checkout
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`BatchCheckouts <#BatchCheckouts>`__
+.. _batchcheckouts-label:
+
+BatchCheckouts
''''''''''''''''''''''''''''''''''''
Default: Don't allow
- Don't allow
-`BatchCheckoutsValidCategories <#BatchCheckoutsValidCategories>`__
+.. _batchcheckoutsvalidcategories-label:
+
+BatchCheckoutsValidCategories
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Patron categories allowed to checkout in a batch \_\_\_ (list of
patron categories separated with a pipe '\|')
-`Checkin Policy <#checkinpolicyprefs>`__
+.. _checkin-policy-label:
+
+Checkin Policy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`BlockReturnOfWithdrawnItems <#BlockReturnOfWithdrawnItems>`__
+.. _blockreturnofwithdrawnitems-label:
+
+BlockReturnOfWithdrawnItems
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Block
- This preference controls whether and item with a withdrawn status
(952$0 in MARC21) can be checked in or not.
-`CalculateFinesOnReturn <#CalculateFinesOnReturn>`__
+.. _calculatefinesonreturn-label:
+
+CalculateFinesOnReturn
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Do
Description:
-- If this preference is set to "Do" and the `fines cron
- job <#finescronjob>`__ is off then Koha will calculate fines only
+- If this preference is set to "Do" and the :ref:`fines cron
+ job <fines-label>` is off then Koha will calculate fines only
when items are returned. If you have the fines cron job on and this
preference set to "Do" then this preference will calculate fines
based on the cron (usually run nightly) and then again when you check
If you are doing hourly loans then you should have this set to 'Do'.
-`CumulativeRestrictionPeriods <#CumulativeRestrictionPeriods>`__
+.. _cumulativerestrictionperiods-label:
+
+CumulativeRestrictionPeriods
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't cumulate
- Cumulate
-`UpdateNotForLoanStatusOnCheckin <#UpdateNotForLoanStatusOnCheckin>`__
+.. _updatenotforloanstatusoncheckin-label:
+
+UpdateNotForLoanStatusOnCheckin
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: This is a list of value pairs. When an item is checked in, if the
that was set to 'Ordered' to now be available for loan. Each pair of
values should be on a separate line.
-`Checkout Policy <#circcheckoutpolicy>`__
+.. _checkout-policy-label:
+
+Checkout Policy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AgeRestrictionMarker <#AgeRestrictionMarker>`__
+.. _agerestrictionmarker-label:
+
+AgeRestrictionMarker
''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Restrict patrons with the following target audience values from
- This preference defines certain keywords that will trigger Koha to
restrict checkout based on age. These restrictions can be overridden
- by the `AgeRestrictionOverride <#AgeRestrictionOverride>`__
+ by the :ref:`AgeRestrictionOverride`
preference. Enter in this field a series of keywords separated by bar
(\|) with no spaces. For example PG\|R\|E\|EC\|Age\| will look for PG
followed by an age number, R folllowed by an age number, Age followed
by an age number, and so on. These values can appear in any MARC
field, but Library of Congress recommends the 521$a (Target Audience
Note). Whatever field you decide to use you must map the word
- agerestriction in the biblioitems table to that field in the `Koha to
- MARC Mapping <#kohamarcmapping>`__. When cataloging you can enter
+ agerestriction in the biblioitems table to that field in the :ref:`Koha to
+ MARC Mapping <koha-to-marc-mapping-label>`. When cataloging you can enter
values like PG 13 or E 10 in the 521$a and Koha will then notify
circulation librarians that the material may not be recommended for
the patron based on their age.
**Important**
You must map the word agerestriction in the biblioitems table to
- the MARC field where this information will appear via the `Koha
- to MARC Mapping <#kohamarcmapping>`__ administration area.
+ the MARC field where this information will appear via the :ref:`Koha
+ to MARC Mapping <koha-to-marc-mapping-label>` administration area.
+
+.. _agerestrictionoverride-label:
-`AgeRestrictionOverride <#AgeRestrictionOverride>`__
+AgeRestrictionOverride
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
Description:
-- When the `AgeRestrictionMarker <#AgeRestrictionMarker>`__ preference
+- When the :ref:`AgeRestrictionMarker` preference
is set, Koha will try to warn circulation librarians before checking
out an item that might have an age restriction listed in the MARC
record. This preference asks if you would like the staff to be able
to still check out these items to patrons under the age limit.
-`AllFinesNeedOverride <#AllFinesNeedOverride>`__
+.. _allfinesneedoverride-label:
+
+AllFinesNeedOverride
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Require
Asks: \_\_\_ staff to manually override all fines, even fines less than
-`noissuescharge <#noissuescharge>`__.
+:ref:`noissuescharge`.
Values:
'Require' then no matter how much money the patron owes a message
will pop up warning you that the patron owes money.
-`AllowFineOverride <#AllowFineOverride>`__
+.. _allowfineoverride-label:
+
+AllowFineOverride
''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
Asks: \_\_\_ staff to manually override and check out items to patrons
-who have more than `noissuescharge <#noissuescharge>`__ in fines.
+who have more than :ref:`noissuescharge` in fines.
Values:
If set to 'Allow' staff will be warned that the patrons owes money,
but it won't stop the staff from checking out to the patron.
-`AllowItemsOnHoldCheckout <#AllowItemsOnHoldCheckout>`__
+.. _allowitemsonholdcheckout-label:
+
+AllowItemsOnHoldCheckout
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
prevent people from checking out books that are on hold for someone
else set this preference to "Don't allow."
-`AllowItemsOnHoldCheckoutSCO <#AllowItemsOnHoldCheckoutSCO>`__
+.. _allowitemsonholdcheckoutsco-label:
+
+AllowItemsOnHoldCheckoutSCO
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
prevent people from checking out books that are on hold for someone
else set this preference to "Don't allow".
-`AllowMultipleIssuesOnABiblio <#AllowMultipleIssuesOnABiblio>`__
+.. _allowmultipleissuesonabiblio-label:
+
+AllowMultipleIssuesOnABiblio
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
This will only effect records without a subscription attached.
-`AllowNotForLoanOverride <#AllowNotForLoanOverride>`__
+.. _allownotforloanoverride-label:
+
+AllowNotForLoanOverride
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
items meant to stay in the library, such as reference materials, and
other library resources can be checked out by patrons.
-`AllowRenewalLimitOverride <#AllowRenewalLimitOverride>`__
+.. _allowrenewallimitoverride-label:
+
+AllowRenewalLimitOverride
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
for special cases, setting it to "Don't allow" prevents an
opportunity for abuse by the library staff.
-`AllowReturnToBranch <#AllowReturnToBranch>`__
+.. _allowreturntobranch-label:
+
+AllowReturnToBranch
''''''''''''''''''''''''''''''''''''''''''''''
Default: to any library
allow you to limit item returns (checkins) to the branch(es) set in
the value.
-`AllowTooManyOverride <#AllowTooManyOverride>`__
+.. _allowtoomanyoverride-label:
+
+AllowTooManyOverride
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- If this preference is set to "Allow" then staff all will be presented
with an option to checkout more items to a patron than are normally
- allowed in the `Circulation and Fine Rules <#circfinerules>`__. If
+ allowed in the :ref:`Circulation and Fine Rules`. If
this preference is set to "Don't allow" then no staff member will be
able to check out more than the circulation limit.
-`AutomaticItemReturn <#AutomaticItemReturn>`__
+.. _automaticitemreturn-label:
+
+AutomaticItemReturn
''''''''''''''''''''''''''''''''''''''''''''''
Default: Do
ensure that items checked in at a branch other than their home branch
will be sent to that home branch.
-`AutoRemoveOverduesRestrictions <#AutoRemoveOverduesRestrictions>`__
+.. _autoremoveoverduesrestrictions-label:
+
+AutoRemoveOverduesRestrictions
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Do not
Description:
-- Using the `Overdue Notice/Status Triggers <#noticetriggers>`__ you
+- Using the :ref:`Overdue Notice/Status Triggers` you
can restrict patrons after they receive an overdue notice. This
preference lets you define whether Koha will automatically remove
that restriction once the overdue items in question are returned or
not.
-`CircControl <#CircControl>`__
+.. _circcontrol-label:
+
+CircControl
''''''''''''''''''''''''''''''
Default: the library the item is from
- the library the item is from
- - The `circulation and fines policies <#circfinerules>`__ will be
+ - The :ref:`circulation and fines policies <circulation-and-fine-rules-label>` will be
determined by the item's library where
- `HomeOrHoldingBranch <#HomeOrHoldingBranch>`__ chooses if item's
+ :ref:`HomeOrHoldingBranch` chooses if item's
home library is used or holding library is used.
- the library the patron is from
- - The `circulation and fines policies <#circfinerules>`__ will be
+ - The :ref:`circulation and fines policies <circulation-and-fine-rules-label>` will be
determined the patron's home library
- the library you are logged in at
- - The `circulation and fines policies <#circfinerules>`__ will be
+ - The :ref:`circulation and fines policies <circulation-and-fine-rules-label>` will be
determined by the library that checked the item out to the patron
-`ConsiderOnSiteCheckoutsAsNormalCheckouts <#ConsiderOnSiteCheckoutsAsNormalCheckouts>`__
+.. _consideronsitecheckoutsasnormalcheckouts-label:
+
+ConsiderOnSiteCheckoutsAsNormalCheckouts
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Consider
Description:
- This preference allows you to decide if checkouts that are
- `OnSiteCheckouts <#OnSiteCheckouts>`__ are counted toward the total
- checkouts a patron can have. You can also set your `circulation and
- fine rules <#circfinerules>`__ to allow only a certain number of
+ :ref:`OnSiteCheckouts` are counted toward the total
+ checkouts a patron can have. You can also set your :ref:`circulation and
+ fine rules <circulation-and-fine-rules-label>` to allow only a certain number of
normal and OnSite checkouts.
-`DefaultLongOverdueChargeValue <#DefaultLongOverdueChargeValue>`__
+.. _defaultlongoverduechargevalue-label:
+
+DefaultLongOverdueChargeValue
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Charge a lost item to the borrower's account when the LOST value
- Leave this field empty if you don't want to charge the user for lost
items. If you want the user to be charged enter the `LOST authorized
value <#lost>`__ you are using in the
- `DefaultLongOverdueLostValue <#DefaultLongOverdueLostValue>`__
- preference. This preference is used when the `longoverdue cron
- job <#longoverduecron>`__ is called without the --charge parameter.
+ :ref:`DefaultLongOverdueLostValue <defaultlongoverduelostvalue-&-defaultlongoverduedays-label>`
+ preference. This preference is used when the :ref:`longoverdue cron
+ job <long-overdues-label>` is called without the --charge parameter.
-`DefaultLongOverdueLostValue & DefaultLongOverdueDays <#DefaultLongOverdueLostValue>`__
+.. _defaultlongoverduelostvalue-&-defaultlongoverduedays-label:
+
+DefaultLongOverdueLostValue & DefaultLongOverdueDays
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: By default, set the LOST value of an item to \_\_\_ when the item
Description:
-- These preferences are used when the `longoverdue cron
- job <#longoverduecron>`__ is called without the --lost parameter. It
- allows users to set the values of the `longoverdue
- cron <#longoverduecron>`__ without having to edit the crontab.
+- These preferences are used when the :ref:`longoverdue cron
+ job <long-overdues-label>` is called without the --lost parameter. It
+ allows users to set the values of the :ref:`longoverdue
+ cron <long-overdues-label>` without having to edit the crontab.
Setting the values to 1 and 30 for example will mark the item with
the `LOST authorized value <#lost>`__ of 1 after the item is 30 days
overdue.
-`HoldsInNoissuesCharge <#HoldsInNoissuesCharge>`__
+.. _holdsinnoissuescharge-label:
+
+HoldsInNoissuesCharge
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't include
- Include
-`HomeOrHoldingBranch <#HomeOrHoldingBranch>`__
+.. _homeorholdingbranch-label:
+
+HomeOrHoldingBranch
''''''''''''''''''''''''''''''''''''''''''''''
Default: the library the item was checked out from
- This preference does several things.
- - If `CircControl <#CircControl>`__ is set to 'the library the item
- is from' then the `circulation and fines
- policies <#circfinerules>`__ will be determined by the item's
+ - If :ref:`CircControl` is set to 'the library the item
+ is from' then the :ref:`circulation and fines
+ policies <circulation-and-fine-rules-label>` will be determined by the item's
library where HomeOrHoldingBranch chooses if item's home library
is used or holding library is used.
- - If `IndependentBranches <#IndependentBranches>`__ is set to
+ - If :ref:`IndependentBranches` is set to
'Prevent' then the value of this preference 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 <#patronpermsdefined>`__.
+ out unless you are a :ref:`superlibrarian <patron-permissions-defined-label>`.
**Important**
of Koha because it will change the behavior of items already checked
out.
-`InProcessingToShelvingCart <#InProcessingToShelvingCart>`__
+.. _inprocessingtoshelvingcart-label:
+
+InProcessingToShelvingCart
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't move
Description:
- This preference is used to manage automatically changing item
- locations from processing (PROC) to the book cart (CART). A `cron
- job <#proccartcron>`__ needs to be set to run at specified intervals
+ locations from processing (PROC) to the book cart (CART). A :ref:`cron
+ job <in-processing/book-cart-label>` needs to be set to run at specified intervals
to age items from CART to the permanent shelving location. (For
example, an hourly cron entry of cart\_to\_shelf.pl --hours 3 where
--hours is the amount of time an item should spend on the cart before
aging to its permanent location.) More information can be found in
- the `related chapter <#processinglocations>`__ in this manual.
+ the :ref:`related chapter <in-processing-/-book-cart-locations-label>` in this manual.
- **Note**
- If the `ReturnToShelvingCart <#ReturnToShelvingCart>`__ system
+ If the :ref:`ReturnToShelvingCart` system
preference is turned on, any newly checked-in item is also
automatically put into the shelving cart, to be covered by the
same script run.
cart. If items on the shelving cart are checked out, the cart
location will be cleared.
-`IssueLostItem <#IssueLostItem>`__
+.. _issuelostitem-label:
+
+IssueLostItem
''''''''''''''''''''''''''''''''''
Default: display a message
'require confirmation.' If you choose to 'do nothing,' there will be
no notification that the item being checked out is marked as 'lost.'
-`IssuingInProcess <#IssuingInProcess>`__
+.. _issuinginprocess-label:
+
+IssuingInProcess
''''''''''''''''''''''''''''''''''''''''
Default: Don't prevent
a rental charge of $1, therefore making the total fines on the patron's
account suddenly $5 (the limit).
-`ManInvInNoissuesCharge <#ManInvInNoissuesCharge>`__
+.. _maninvinnoissuescharge-label:
+
+ManInvInNoissuesCharge
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Include
- This preference lets you decide if charges entered as manual invoices
are included when calculating the
- `noissuescharge <#noissuescharge>`__. If this is set to include then
+ :ref:`noissuescharge`. If this is set to include then
Koha will include all manual invoices when deciding if the patron
owes too much money to check anything else out of the library. If
it's set to Don't include then Koha will ignore all manual invoice
charges when figuring out if the patron owes too much money to
checkout additional materials.
-`maxoutstanding <#maxoutstanding>`__
+.. _maxoutstanding-label:
+
+maxoutstanding
''''''''''''''''''''''''''''''''''''
Default: 5
Asks: Prevent patrons from making holds on the OPAC if they owe more
than \_\_\_ USD in fines.
-`noissuescharge <#noissuescharge>`__
+.. _noissuescharge-label:
+
+noissuescharge
''''''''''''''''''''''''''''''''''''
Default: 5
- This preference is the maximum amount of money owed to the library
before the user is banned from borrowing more items. Using the
- `ManInvInNoissuesCharge <#ManInvInNoissuesCharge>`__ and
- `RentalsInNoissuesCharge <#RentalsInNoissuesCharge>`__ preferences
+ :ref:`ManInvInNoissuesCharge` and
+ :ref:`RentalsInNoissuesCharge` preferences
you can control which types of charges are considered in this total.
- This also coincides with `maxoutstanding <#maxoutstanding>`__ that
+ This also coincides with :ref:`maxoutstanding` that
limits patrons from placing holds when the maximum amount is owed to
the library.
-`NoIssuesChargeGuarantees <#NoIssuesChargeGuarantees>`__
+.. _noissueschargeguarantees-label:
+
+NoIssuesChargeGuarantees
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Prevent a patron from checking out if the patron has guarantees
- Allows a library to prevent patrons from checking out items if his or
her guarantees owe too much in fines.
-`NoRenewalBeforePrecision <#NoRenewalBeforePrecision>`__
+.. _norenewalbeforeprecision-label:
+
+NoRenewalBeforePrecision
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: date
Description:
- This preference allows you to control how the 'No renewal before"
- option in the `Circulation and fine rules <#circfinerules>`__
+ option in the :ref:`Circulation and fine rules <circulation-and-fine-rules-label>`
administration area.
-`NoticeBcc <#NoticeBcc>`__
+.. _noticebcc-label:
+
+NoticeBcc
''''''''''''''''''''''''''''''''''''''''
Asks: Send all notices as a BCC to this email address \_\_\_
If you'd like more than one person to receive the blind copy you can
simply enter in multiple email addresses separated by commas.
-`OnSiteCheckouts <#OnSiteCheckouts>`__
+.. _onsitecheckouts-label:
+
+OnSiteCheckouts
''''''''''''''''''''''''''''''''''''''
Default: Disable
you to track who's using items that are normally not for loan or are
in a closed stack setting.
-`OnSiteCheckoutsForce <#OnSiteCheckoutsForce>`__
+.. _onsitecheckoutsforce-label:
+
+OnSiteCheckoutsForce
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Disable
- This preference lets the staff override any restrictions a patron
might have and check out items for use within the library. The
- `OnSiteCheckouts <#OnSiteCheckouts>`__ preference must first be set
+ :ref:`OnSiteCheckouts` preference must first be set
to 'Enable' for this preference to be considered.
-`OPACFineNoRenewalsBlockAutoRenew <#OPACFineNoRenewalsBlockAutoRenew>`__
+.. _opacfinenorenewalsblockautorenew-label:
+
+OPACFineNoRenewalsBlockAutoRenew
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
-Asks: If a patron owes more than the value of `OPACFineNoRenewals <#OPACFineNoRenewals>`__,
+Asks: If a patron owes more than the value of :ref:`OPACFineNoRenewals`,
\_\_\_ his/her auto renewals.
Values:
- Block
-`OverdueNoticeCalendar <#OverdueNoticeCalendar>`__
+.. _overduenoticecalendar-label:
+
+OverdueNoticeCalendar
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Ignore calendar
- Notices take holidays into account, so they will not be sent if
holidays mean the item is not actually overdue yet
-`OverduesBlockCirc <#OverduesBlockCirc>`__
+.. _overduesblockcirc-label:
+
+OverduesBlockCirc
''''''''''''''''''''''''''''''''''''''''''
Default: Ask for confirmation
- Allow all patrons with overdue items to continue to check out
-`OverduesBlockRenewing <#OverduesBlockRenewing>`__
+.. _overduesblockrenewing-label:
+
+OverduesBlockRenewing
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: allow renewing
- block renewing for only this item
-`PrintNoticesMaxLines <#PrintNoticesMaxLines>`__
+.. _printnoticesmaxlines-label:
+
+PrintNoticesMaxLines
''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Include up to \_\_\_ item lines in a printed overdue notice.
This preference only refers to the print notices, not those sent via
email.
-`RenewalPeriodBase <#RenewalPeriodBase>`__
+.. _renewalperiodbase-label:
+
+RenewalPeriodBase
''''''''''''''''''''''''''''''''''''''''''
Default: the old due date of the checkout
- the current date
-`RenewalSendNotice <#RenewalSendNotice>`__
+.. _renewalsendnotice-label:
+
+RenewalSendNotice
''''''''''''''''''''''''''''''''''''''''''
Default: Don't send
- If a patron has chosen to receive a check out notice in their
messaging preferences and this preference is set to 'Send' then those
patrons will also receive a notice when they renew materials. You
- will want to set up a `new notice <#addnotices>`__ with the code of
+ will want to set up a :ref:`new notice <adding-notices-&-slips-label>` with the code of
RENEWAL (if you don't already have it) with custom text for renewing
items.
**Important**
This preference requires that you have
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
set to 'Allow'
-`RentalFeesCheckoutConfirmation <#RentalFeesCheckoutConfirmation>`__
+.. _rentalfeescheckoutconfirmation-label:
+
+RentalFeesCheckoutConfirmation
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: do not ask
it so that you can show (or not show) a confirmation before checking
out an item that will incur a rental charge.
-`RentalsInNoissuesCharge <#RentalsInNoissuesCharge>`__
+.. _rentalsinnoissuescharge-label:
+
+RentalsInNoissuesCharge
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Include
Description:
- This preference lets you decide if rental charges are included when
- calculating the `noissuescharge <#noissuescharge>`__. If this is set
+ calculating the :ref:`noissuescharge`. If this is set
to include then Koha will include all rental charges when deciding if
the patron owes too much money to check anything else out of the
library. If it's set to Don't include then Koha will ignore all
rental charges when figuring out if the patron owes too much money to
checkout additional materials.
-`RestrictionBlockRenewing <#RestrictionBlockRenewing>`__
+.. _restrictionblockrenewing-label:
+
+RestrictionBlockRenewing
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Block
-`ReturnBeforeExpiry <#ReturnBeforeExpiry>`__
+.. _returnbeforeexpiry-label:
+
+ReturnBeforeExpiry
''''''''''''''''''''''''''''''''''''''''''''
Default: Don't require
left "Don't require" then item check out dates may exceed the
expiration date for the patron's library card.
-`ReturnToShelvingCart <#ReturnToShelvingCart>`__
+.. _returntoshelvingcart-label:
+
+ReturnToShelvingCart
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't move
Description:
-- More information can be found in the `related
- chapter <#processinglocations>`__ in this manual.
+- More information can be found in the :ref:`related
+ chapter <in-processing-/-book-cart-locations-label>` in this manual.
-`StaffSearchResultsDisplayBranch <#StaffSearchResultsDisplayBranch>`__
+.. _staffsearchresultsdisplaybranch-label:
+
+StaffSearchResultsDisplayBranch
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: the library the item is held by
- the library the items is held by
-`SwitchOnSiteCheckouts <#SwitchOnSiteCheckouts>`__
+.. _switchonsitecheckouts-label:
+
+SwitchOnSiteCheckouts
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't switch
- Switch
-`TransfersMaxDaysWarning <#TransfersMaxDaysWarning>`__
+.. _transfersmaxdayswarning-label:
+
+TransfersMaxDaysWarning
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 3
- The TransferMaxDaysWarning preference is set at a default number of
days. This preference allows for a warning to appear after a set
amount of time if an item being transferred between library branches
- has not been received. The warning will appear in the `Transfers to
- Receive <#transferstoreceive>`__ report.
+ has not been received. The warning will appear in the :ref:`Transfers to
+ Receive <transfers-to-receive-label>` report.
+
+.. _usebranchtransferlimits-&-branchtransferlimitstype-label:
-`UseBranchTransferLimits & BranchTransferLimitsType <#UseBranchTransferLimits>`__
+UseBranchTransferLimits & BranchTransferLimitsType
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Defaults: Don't enforce & collection code
determines how the library manager is able to restrict what items can
be transferred between the branches.
-`useDaysMode <#useDaysMode>`__
+.. _usedaysmode-label:
+
+useDaysMode
''''''''''''''''''''''''''''''
Default: Don't include
December to accommodate for the two closed days.
The calendar is defined on a branch by branch basis. To learn more about
-the calendar, check out the '`Calendar & Holidays <#calholidays>`__'
+the calendar, check out the ':ref:`Calendar & Holidays <calendar-label>`'
section of this manual.
-`UseTransportCostMatrix <#UseTransportCostMatrix>`__
+.. _usetransportcostmatrix-label:
+
+UseTransportCostMatrix
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't use
Description:
-- If the system is configured to use the `Transport cost
- matrix <#transportcostmatrix>`__ for filling holds, then when
+- If the system is configured to use the :ref:`Transport cost
+ matrix <transport-cost-matrix-label>` for filling holds, then when
attempting to fill a hold, the system will search for the lowest cost
branch, and attempt to fill the hold with an item from that branch
first. Branches of equal cost will be selected from randomly. The
determining whether the item can fulfill a hold using the Transport
Cost Matrix.
-`Course Reserves <#coursereserveprefs>`__
+.. _course-reserves-label:
+
+Course Reserves
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`UseCourseReserves <#UseCourseReserves>`__
+.. _usecoursereserves-label:
+
+UseCourseReserves
''''''''''''''''''''''''''''''''''''''''''
Default: Don't use
circulation rules to these items while they are being used for a
specific course.
-`Fines Policy <#circfinespolicy>`__
+.. _fines-policy-label:
+
+Fines Policy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`finesCalendar <#finesCalendar>`__
+.. _finescalendar-label:
+
+finesCalendar
''''''''''''''''''''''''''''''''''
Default: not including the days the library is closed
during instances when the library is closed. Examples include
holidays, library in-service days, etc. Choosing "not including the
days the library is closed" setting will enable Koha to access its
- `Calendar <#calholidays>`__ module and be considerate of dates when
+ :ref:`Calendar` module and be considerate of dates when
the library is closed. To make use of this setting the administrator
must first access Koha's calendar and mark certain days as "holidays"
ahead of time.
The calendar is defined on a branch by branch basis. To learn more about
-the calendar, check out the '`Calendar & Holidays <#calholidays>`__'
+the calendar, check out the ':ref:`Calendar & Holidays <calendar-label>`'
section of this manual.
-`FinesIncludeGracePeriod <#FinesIncludeGracePeriod>`__
+.. _finesincludegraceperiod-label:
+
+FinesIncludeGracePeriod
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Include
not to include the grace period then Koha will only charge for the
days overdue after the grace period.
-`finesMode <#finesMode>`__
+.. _finesmode-label:
+
+finesMode
''''''''''''''''''''''''''
Default: Calculate (but only for mailing to the admin)
Requires that you have the fines cron job running
(misc/cronjobs/fines.pl)
-`HoldFeeMode <#HoldFeeMode>`__
+.. _holdfeemode-label:
+
+HoldFeeMode
''''''''''''''''''''''''''''''
Default: only if all items are checked out and the record has at least one hold already.
- only if all items are checked out and the record has at least one hold already.
-`RefundLostOnReturnControl <#RefundLostOnReturnControl>`__
+.. _refundlostonreturncontrol-label:
+
+RefundLostOnReturnControl
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: check-in library.
- item home branch.
-`WhenLostChargeReplacementFee <#WhenLostChargeReplacementFee>`__
+.. _whenlostchargereplacementfee-label:
+
+WhenLostChargeReplacementFee
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Charge
listed on the item they lost or it can do nothing in reference to the
patron and just mark the item lost in the catalog.
-`WhenLostForgiveFine <#WhenLostForgiveFine>`__
+.. _whenlostforgivefine-label:
+
+WhenLostForgiveFine
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't forgive
this preference is set to 'Forgive' then the patron won't be charged
fines in addition to the replacement fee.
-`Holds Policy <#circholdspolicy>`__
+.. _holds-policy-label:
+
+Holds Policy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AllowHoldDateInFuture <#AllowHoldDateInFuture>`__
+.. _allowholddateinfuture-label:
+
+AllowHoldDateInFuture
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Don't allow
-`AllowHoldItemTypeSelection <#AllowHoldItemTypeSelection>`__
+.. _allowholditemtypeselection-label:
+
+AllowHoldItemTypeSelection
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- Don't allow
-`AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__
+.. _allowholdpolicyoverride-label:
+
+AllowHoldPolicyOverride
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
no abuse of the system is possible, but it makes the system entirely
inflexible in respect to holds.
-`AllowHoldsOnDamagedItems <#AllowHoldsOnDamagedItems>`__
+.. _allowholdsondamageditems-label:
+
+AllowHoldsOnDamagedItems
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
patron to place a hold on an item and therefore receive it as soon as
it becomes available.
-`AllowHoldsOnPatronsPossessions <#AllowHoldsOnPatronsPossessions>`__
+.. _allowholdsonpatronspossessions-label:
+
+AllowHoldsOnPatronsPossessions
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
holds on items they already have out, thus preventing them from
blocking anyone else from getting an item.
-`AllowRenewalIfOtherItemsAvailable <#AllowRenewalIfOtherItemsAvailable>`__
+.. _allowrenewalifotheritemsavailable-label:
+
+AllowRenewalIfOtherItemsAvailable
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- Don't allow
-`AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__
+.. _autoresumesuspendedholds-label:
+
+AutoResumeSuspendedHolds
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- If this preference is set to 'Allow' then all suspended holds will be
able to have a date at after which they automatically become
unsuspended. If you have this preference set to 'Allow' you will also
- need the `Unsuspend Holds <#unsuspendholdcron>`__ cron job running.
+ need the :ref:`Unsuspend Holds` cron job running.
**Important**
The holds will become unsuspended the date after that entered by the
patron.
-`canreservefromotherbranches <#canreservefromotherbranches>`__
+.. _canreservefromotherbranches-label:
+
+canreservefromotherbranches
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Allow
-- Don't allow (with `independent branches <#IndependentBranches>`__)
+- Don't allow (with :ref:`independent branches <independentbranches-label>`)
+
+.. _confirmfutureholds-label:
-`ConfirmFutureHolds <#ConfirmFutureHolds>`__
+ConfirmFutureHolds
''''''''''''''''''''''''''''''''''''''''''''
Default: 0
**Important**
This preference is only looked at if you're allowing hold dates in
- the future with `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__
- or `OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
+ the future with :ref:`AllowHoldDateInFuture`
+ or :ref:`OPACAllowHoldDateInFuture`
-`decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue, decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses <#decreaseLoanHighHolds>`__
+.. _decreaseloanhighholds,-decreaseloanhighholdsduration,-decreaseloanhighholdsvalue,-decreaseloanhighholdscontrol,-and-decreaseloanhighholdsignorestatuses-label:
+
+decreaseLoanHighHolds, decreaseLoanHighHoldsDuration, decreaseLoanHighHoldsValue, decreaseLoanHighHoldsControl, and decreaseLoanHighHoldsIgnoreStatuses
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: \_\_\_ the reduction of loan period \_\_\_ to days for items with
Warning on checkout
|image32|
-`DisplayMultiPlaceHold <#DisplayMultiPlaceHold>`__
+.. _displaymultiplacehold-label:
+
+DisplayMultiPlaceHold
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't enable
- Enable
-`emailLibrarianWhenHoldIsPlaced <#emailLibrarianWhenHoldIsPlaced>`__
+.. _emaillibrarianwhenholdisplaced-label:
+
+emailLibrarianWhenHoldIsPlaced
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't enable
**Important**
In order for this email to send you must have a
- `notice <#notices>`__ template with the code of HOLDPLACED
+ :ref:`notice <notices-&-slips-label>` template with the code of HOLDPLACED
**Important**
- This notice will only be sent if the `process\_message\_queue.pl
- cronjob <#msgqueuecron>`__ being run periodically to send the
+ This notice will only be sent if the :ref:`process\_message\_queue.pl
+ cronjob <message-queue-label>` being run periodically to send the
messages.
-`ExcludeHolidaysFromMaxPickUpDelay <#ExcludeHolidaysFromMaxPickUpDelay>`__
+.. _excludeholidaysfrommaxpickupdelay-label:
+
+ExcludeHolidaysFromMaxPickUpDelay
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- Allow
-`ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__
+.. _expirereservesmaxpickupdelay-label:
+
+ExpireReservesMaxPickUpDelay
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
Asks: \_\_\_ holds to expire automatically if they have not been picked
by within the time period specified in
-`ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
+:ref:`ReservesMaxPickUpDelay`
Values:
- If set to 'allow' this will cancel holds that have been waiting for
longer than the number of days specified in the
- `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__ system
- preference. Holds will only be cancelled if the `Expire Holds cron
- job <#expiredholdscron>`__ is runnning.
+ :ref:`ReservesMaxPickUpDelay` system
+ preference. Holds will only be cancelled if the :ref:`Expire Holds cron
+ job <expired-holds-label>` is runnning.
+
+.. _expirereservesmaxpickupdelaycharge-label:
-`ExpireReservesMaxPickUpDelayCharge <#ExpireReservesMaxPickUpDelayCharge>`__
+ExpireReservesMaxPickUpDelayCharge
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 0
Asks: If using
-`ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__, charge
+:ref:`ExpireReservesMaxPickUpDelay`, charge
a borrower who allows his or her waiting hold to expire a fee of \_\_\_
USD
this preference to charge the patron for not picking up their hold.
If you don't charge patrons for items that aren't picked up you can
leave this set to the default which is 0. Holds will only be
- cancelled and charged if the `Expire Holds cron
- job <#expiredholdscron>`__ is running.
+ cancelled and charged if the :ref:`Expire Holds cron
+ job <expired-holds-label>` is running.
-`ExpireReservesOnHolidays <#ExpireReservesOnHolidays>`__
+.. _expirereservesonholidays-label:
+
+ExpireReservesOnHolidays
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Don't allow
-`LocalHoldsPriority, LocalHoldsPriorityPatronControl, LocalHoldsPriorityItemControl <#LocalHoldsPriority>`__
+.. _localholdspriority,-localholdsprioritypatroncontrol,-localholdspriorityitemcontrol-label:
+
+LocalHoldsPriority, LocalHoldsPriorityPatronControl, LocalHoldsPriorityItemControl
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: \_\_\_ priority for filling holds to patrons whose \_\_\_ matches
returned, a local hold may be given priority for fulfillment even
though it is of lower priority in the list of unfilled holds.
-`maxreserves <#maxreserves>`__
+.. _maxreserves-label:
+
+maxreserves
''''''''''''''''''''''''''''''
Default: 50
Asks: Patrons can only have \_\_\_ holds at once.
-`OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
+.. _opacallowholddateinfuture-label:
+
+OPACAllowHoldDateInFuture
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Allow
- - `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__ must also be
+ - :ref:`AllowHoldDateInFuture` must also be
enabled for this to work
- Don't allow
-`OPACAllowUserToChooseBranch <#OPACAllowUserToChooseBranch>`__
+.. _opacallowusertochoosebranch-label:
+
+OPACAllowUserToChooseBranch
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
only prevent patrons from saying they plan on picking a book up at a
branch other than their home branch.
-`OPACHoldsIfAvailableAtPickup <#OPACHoldsIfAvailableAtPickup>`__
+.. _opacholdsifavailableatpickup-label:
+
+OPACHoldsIfAvailableAtPickup
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Allow
-`OPACHoldsIfAvailableAtPickupExceptions <#OPACHoldsIfAvailableAtPickupExceptions>`__
+.. _opacholdsifavailableatpickupexceptions-label:
+
+OPACHoldsIfAvailableAtPickupExceptions
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: blank
-Asks: Patron categories not affected by `OPACHoldsIfAvailableAtPickup <#OPACHoldsIfAvailableAtPickup>`__
+Asks: Patron categories not affected by :ref:`OPACHoldsIfAvailableAtPickup`
\_\_\_ (list of patron categories separated with a pipe '|')
-`ReservesControlBranch <#ReservesControlBranch>`__
+.. _reservescontrolbranch-label:
+
+ReservesControlBranch
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: item's home library
- patron's home library.
-`ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
+.. _reservesmaxpickupdelay-label:
+
+ReservesMaxPickUpDelay
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 7
Description:
-- This preference (based on calendar days, not the `Koha holiday
- calendar <#calholidays>`__) puts an expiration date on an item a
+- This preference (based on calendar days, not the :ref:`Koha holiday
+ calendar <calendar-label>`) puts an expiration date on an item a
patron has on hold. After this expiration date the staff will have
the option to release the unclaimed hold which then may be returned
to the library shelf or issued to the next patron on the item's hold
list. Items that are 'expired' by this preference are moved to the
- 'Holds Over' tab on the '`Holds Awaiting Pickup <#holdspickup>`__'
+ 'Holds Over' tab on the ':ref:`Holds Awaiting Pickup <holds-awaiting-pickup-label>`'
report.
-`ReservesNeedReturns <#ReservesNeedReturns>`__
+.. _reservesneedreturns-label:
+
+ReservesNeedReturns
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't automatically
that their item is 'Waiting' for them at their library and ready for
check out.
-`StaticHoldsQueueWeight, HoldsQueueSkipClosed & RandomizeHoldsQueueWeight <#holdqueueweight>`__
+.. _staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label:
+
+StaticHoldsQueueWeight, HoldsQueueSkipClosed & RandomizeHoldsQueueWeight
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
StaticHoldsQueueWeight Default: 0
Descriptions:
-- These preferences control how the `Holds Queue
- report <#holdsqueue>`__ is generated using `a cron
- job <#buildholdscron>`__.
+- These preferences control how the :ref:`Holds Queue
+ report <holds-queue-label>` is generated using :ref:`a cron
+ job <holds-queue-label>`.
If you do not want all of your libraries to participate in the
on-shelf holds fulfillment process, you should list the the libraries
**Important**
- The `Transport Cost Matrix <#transportcostmatrix>`__ takes
+ The :ref:`Transport Cost Matrix <transport-cost-matrix-label>` takes
precedence in controlling where holds are filled from, if the matrix
is not used then Koha checks the StaticHoldsQueueWeight. To use the
Transport Cost Matrix simply set your
- `UseTransportCostMatrix <#UseTransportCostMatrix>`__ preference to
+ :ref:`UseTransportCostMatrix` preference to
'Use'
-`SuspendHoldsIntranet <#SuspendHoldsIntranet>`__
+.. _suspendholdsintranet-label:
+
+SuspendHoldsIntranet
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- The holds suspension feature can be turned on and off in the staff
client by altering this system preference. If this is set to 'allow'
you will want to set the
- `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ system
+ :ref:`AutoResumeSuspendedHolds` system
preference.
-`SuspendHoldsOpac <#SuspendHoldsOpac>`__
+.. _suspendholdsopac-label:
+
+SuspendHoldsOpac
''''''''''''''''''''''''''''''''''''''''
Default: Allow
- The holds suspension feature can be turned on and off in the OPAC by
altering this system preference. If this is set to 'allow' you will
want to set the
- `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ system
+ :ref:`AutoResumeSuspendedHolds` system
preference.
-`TransferWhenCancelAllWaitingHolds <#TransferWhenCancelAllWaitingHolds>`__
+.. _transferwhencancelallwaitingholds-label:
+
+TransferWhenCancelAllWaitingHolds
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't transfer
go. When that system preference set to "Transfer", branch transfers
are created, so the holds may be cancelled.
-`Housebound module <#circhouseboundmoduleprefs>`__
+.. _housebound-module-label:
+
+Housebound module
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`HouseboundModule <#HouseboundModule>`__
+.. _houseboundmodule-label:
+
+HouseboundModule
''''''''''''''''''''''''''''''''''''''''
Default: Disable
- This preference enables or disables the Housebound module which
handles management of circulation to Housebound readers.
-`Interface <#circinterfaceprefs>`__
+.. _interface-label:
+
+Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AllowAllMessageDeletion <#AllowAllMessageDeletion>`__
+.. _allowallmessagedeletion-label:
+
+AllowAllMessageDeletion
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- Don't allow
-`AllowCheckoutNotes <#AllowCheckoutNotes>`__
+.. _allowcheckoutnotes-label:
+
+AllowCheckoutNotes
''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- Allow
-`AllowOfflineCirculation <#AllowOfflineCirculation>`__
+.. _allowofflinecirculation-label:
+
+AllowOfflineCirculation
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Do not enable
Description:
- Setting this preference to 'Enable' allows you to use the Koha
- interface for `offline circulation <#offlinecirc>`__. This system
- preference does not affect the `Firefox
- plugin <#firefoxofflinecirc>`__ or the `desktop
- application <#windowsofflinecirc>`__, any of these three options can
+ interface for :ref:`offline circulation <offline-circulation-utilities-label>`. This system
+ preference does not affect the :ref:`Firefox
+ plugin <firefox-plugin-label>` or the :ref:`desktop
+ application <offline-circ-tool-for-windows-label>`, any of these three options can
be used for offline circulation without effecting the other.
-`CircAutocompl <#CircAutocompl>`__
+.. _circautocompl-label:
+
+CircAutocompl
''''''''''''''''''''''''''''''''''
Default: Try
search box
|image33|
-`CircAutoPrintQuickSlip <#CircAutoPrintQuickSlip>`__
+.. _circautoprintquickslip-label:
+
+CircAutoPrintQuickSlip
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: open a print quick slip window
Description:
- If this preference is set to open a quick slip
- (`ISSUEQSLIP <#existingnotices>`__) or open a slip
- (`ISSUESLIP <#existingnotices>`__) for printing it will eliminate the
+ (:ref:`ISSUEQSLIP <existing-notices-&-slips-label>`) or open a slip
+ (:ref:`ISSUESLIP <existing-notices-&-slips-label>`) for printing it will eliminate the
need for the librarian to click the print button to generate a
checkout receipt for the patron they're checking out to. If the
preference is set to clear the screen then "checking out" an empty
barcode will clear the screen of the patron you were last working
with.
-`CircSidebar <#CircSidebar>`__
+.. _circsidebar-label:
+
+CircSidebar
''''''''''''''''''''''''''''''
Default: Deactivate
- Activate
-`DisplayClearScreenButton <#DisplayClearScreenButton>`__
+.. _displayclearscreenbutton-label:
+
+DisplayClearScreenButton
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Show
X in the top right will clear the screen
|image37|
-`ExportCircHistory <#ExportCircHistory>`__
+.. _exportcirchistory-label:
+
+ExportCircHistory
''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- Show
-`ExportRemoveFields <#ExportRemoveFields>`__
+.. _exportremovefields-label:
+
+ExportRemoveFields
''''''''''''''''''''''''''''''''''''''''''''
Asks: The following fields should be excluded from the patron checkout
ExportRemoveFields
|image38|
-`FilterBeforeOverdueReport <#FilterBeforeOverdueReport>`__
+.. _filterbeforeoverduereport-label:
+
+FilterBeforeOverdueReport
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't require
- Require
-`FineNotifyAtCheckin <#FineNotifyAtCheckin>`__
+.. _finenotifyatcheckin-label:
+
+FineNotifyAtCheckin
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't notify
Fine notification at checkin
|image35|
-`HoldsToPullStartDate <#HoldsToPullStartDate>`__
+.. _holdstopullstartdate-label:
+
+HoldsToPullStartDate
''''''''''''''''''''''''''''''''''''''''''''''''
Default: 2
Description:
-- The `Holds to Pull <#holdspull>`__ report in circulation defaults to
+- The :ref:`Holds to Pull <holds-to-pull-label>` report in circulation defaults to
filtering holds placed 2 days ago. This preference allows you to set
this default filter to any number of days.
-`itemBarcodeFallbackSearch <#itemBarcodeFallbackSearch>`__
+.. _itembarcodefallbacksearch-label:
+
+itemBarcodeFallbackSearch
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't enable
title you check out. Only titles with barcodes will appear in the
search results.
-`itemBarcodeInputFilter <#itemBarcodeInputFilter>`__
+.. _itembarcodeinputfilter-label:
+
+itemBarcodeInputFilter
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't filter
- This format is common among those libraries migrating from Follett
systems
-`NoticeCSS <#NoticeCSS>`__
+.. _noticecss-label:
+
+NoticeCSS
''''''''''''''''''''''''''
Asks: Include the stylesheet at \_\_\_ on Notices.
fonts and colors you can use this preference to point Koha to a
stylesheet specifically for your notices.
-`numReturnedItemsToShow <#numReturnedItemsToShow>`__
+.. _numreturneditemstoshow-label:
+
+numReturnedItemsToShow
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 20
Asks : Show the \_\_\_ last returned items on the checkin screen.
-`previousIssuesDefaultSortOrder <#previousIssuesDefaultSortOrder>`__
+.. _previousissuesdefaultsortorder-label:
+
+previousIssuesDefaultSortOrder
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: earliest to latest
- latest to earliest
-`RecordLocalUseOnReturn <#RecordLocalUseOnReturn>`__
+.. _recordlocaluseonreturn-label:
+
+RecordLocalUseOnReturn
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't record
out to the statistical patron and/or by checking in a book that is
not currently checked out.
-`ShowAllCheckins <#ShowAllCheckins>`__
+.. _showallcheckins-label:
+
+ShowAllCheckins
''''''''''''''''''''''''''''''''''''''
Default: Do not show
don't show on the list of checked in items. This preference allows
you to choose how you'd like the log of checked in items displays.
-`SpecifyDueDate <#SpecifyDueDate>`__
+.. _specifyduedate-label:
+
+SpecifyDueDate
''''''''''''''''''''''''''''''''''''
Default: Allow
Specify Due Date Box Doesn't Show
|image42|
-`SpecifyReturnDate <#SpecifyReturnDate>`__
+.. _specifyreturndate-label:
+
+SpecifyReturnDate
''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- This preference lets you decide if staff can specify an arbitrary
return date when checking in items.
-`todaysIssuesDefaultSortOrder <#todaysIssuesDefaultSortOrder>`__
+.. _todaysissuesdefaultsortorder-label:
+
+todaysIssuesDefaultSortOrder
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: latest to earliest
- latest to earliest
-`UpdateTotalIssuesOnCirc <#UpdateTotalIssuesOnCirc>`__
+.. _updatetotalissuesoncirc-label:
+
+UpdateTotalIssuesOnCirc
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Do not
**Important**
This increases server load significantly; if performance is a
- concern, use the `cron job <#updateissuescron>`__ to update the
+ concern, use the :ref:`cron job <track-total-checkouts-label>` to update the
total issues count instead.
- Do not
that on the item record in the database. This information is not
stored by default. Setting this preference to 'Do' will tell Koha to
track that info everytime the item is checked out in real time.
- Otherwise you could use the `cron job <#updateissuescron>`__ to have
+ Otherwise you could use the :ref:`cron job <track-total-checkouts-label>` to have
Koha update that field nightly.
-`WaitingNotifyAtCheckin <#WaitingNotifyAtCheckin>`__
+.. _waitingnotifyatcheckin-label:
+
+WaitingNotifyAtCheckin
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't notify
time a hold is found for the patron who had the book out last a
message will appear on your check in screen.
-`Self Checkout <#circscoprefs>`__
+.. _self-checkout-label:
+
+Self Checkout
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AllowSelfCheckReturns <#AllowSelfCheckReturns>`__
+.. _allowselfcheckreturns-label:
+
+AllowSelfCheckReturns
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
allowed to return items through your self check machines. By default
Koha's self check interface is simply for checking items out.
-`AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass <#AutoSelfCheckAllowed>`__
+.. _autoselfcheckallowed,-autoselfcheckid-&-autoselfcheckpass-label:
+
+AutoSelfCheckAllowed, AutoSelfCheckID & AutoSelfCheckPass
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
**Important**
AutoSelfCheckID Value:
- The username of a staff patron with 'circulate'
- `permissions <#patronpermissions>`__.
+ :ref:`permissions <patron-permissions-label>`.
AutoSelfCheckPass Value:
- The password of a staff patron with 'circulate'
- `permissions <#patronpermissions>`__.
+ :ref:`permissions <patron-permissions-label>`.
-`SCOUserCSS <#SCOUserCSS>`__
+.. _scousercss-label:
+
+SCOUserCSS
''''''''''''''''''''''''''''
Asks: Include the following CSS on all pages in the web-based self
- The CSS entered in this preference will be used on all of your Koha
self checkout screens.
-`SCOUserJS <#SCOUserJS>`__
+.. _scouserjs-label:
+
+SCOUserJS
''''''''''''''''''''''''''
Asks: Include the following JavaScript on all pages in the web-based
- The JavaScript entered in this preference will effect all of your
Koha self checkout screens.
-`SelfCheckHelpMessage <#SelfCheckHelpMessage>`__
+.. _selfcheckhelpmessage-label:
+
+SelfCheckHelpMessage
''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Include the following HTML in the Help page of the web-based self
interface. Adding HTML to this system preference will print that
additional help text above what's already included.
-`SelfCheckoutByLogin <#SelfCheckoutByLogin>`__
+.. _selfcheckoutbylogin-label:
+
+SelfCheckoutByLogin
''''''''''''''''''''''''''''''''''''''''''''''
Default: Barcode
username and password is set using the opac/staff username and
password fields on the patron record.
-`SelfCheckReceiptPrompt <#SelfCheckReceiptPrompt>`__
+.. _selfcheckreceiptprompt-label:
+
+SelfCheckReceiptPrompt
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Show
- This preference controls whether a prompt shows up on the web based
self check out when the patron clicks the 'Finish' button.
-`SelfCheckTimeout <#SelfCheckTimeout>`__
+.. _selfchecktimeout-label:
+
+SelfCheckTimeout
''''''''''''''''''''''''''''''''''''''''
Default: 120
self check out system will log out the current patron and return to
the starting screen.
-`ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
+.. _showpatronimageinwebbasedselfcheck-label:
+
+ShowPatronImageInWebBasedSelfCheck
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- Show
-`WebBasedSelfCheck <#WebBasedSelfCheck>`__
+.. _webbasedselfcheck-label:
+
+WebBasedSelfCheck
''''''''''''''''''''''''''''''''''''''''''
Default: Don't enable
- Enable
-Enabling this preference will allow access to the `self
-checkout <#selfcheckout>`__ module in Koha.
+Enabling this preference will allow access to the :ref:`self
+checkout <self-checkout-label>` module in Koha.
+
+.. _enhanced-content-label:
-`Enhanced Content <#enhancedcontent>`__
+Enhanced Content
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences >
multiple cover images. Instead choose only one source for cover
images.
-`All <#frbrenhancedprefs>`__
+.. _all-label:
+
+All
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`FRBRizeEditions <#FRBRizeEditions>`__
+.. _frbrizeeditions-label:
+
+FRBRizeEditions
''''''''''''''''''''''''''''''''''''''
Default: Don't show
is set to "Show", the OPAC will query one or more ISBN web services
for associated ISBNs and display an Editions tab on the details
pages. Once this preference is enabled, the library must select one
- of the ISBN options (`ThingISBN <#ThingISBN>`__ and/or
- `XISBN <#XISBN>`__). This option is only for the Staff Client; the
- `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ option must be enabled
+ of the ISBN options (:ref:`ThingISBN` and/or
+ :ref:`XISBN`). This option is only for the Staff Client; the
+ :ref:`OPACFRBRizeEditions` option must be enabled
to have the Editions tab appear on the OPAC.
**Important**
Requires that you turn on one or more of the ISBN services
- (`ThingISBN <#ThingISBN>`__ and/or `XISBN <#XISBN>`__)
+ (:ref:`ThingISBN` and/or :ref:`XISBN`)
-`OPACFRBRizeEditions <#OPACFRBRizeEditions>`__
+.. _opacfrbrizeeditions-label:
+
+OPACFRBRizeEditions
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
is set to "Show", the OPAC will query one or more ISBN web services
for associated ISBNs and display an Editions tab on the details
pages. Once this preference is enabled, the library must select one
- of the ISBN options (`ThingISBN <#ThingISBN>`__ and/or
- `XISBN <#XISBN>`__). This option is only for the OPAC; the
- `FRBRizeEditions <#FRBRizeEditions>`__ option must be turned "On" to
+ of the ISBN options (:ref:`ThingISBN` and/or
+ :ref:`XISBN`). This option is only for the OPAC; the
+ :ref:`FRBRizeEditions` option must be turned "On" to
have the Editions tab appear on the Staff Client.
Values:
**Important**
Requires that you turn on one or more of the ISBN services
- (`ThingISBN <#ThingISBN>`__ and/or `XISBN <#XISBN>`__)
+ (:ref:`ThingISBN` and/or :ref:`XISBN`)
+
+.. _amazon-label:
-`Amazon <#amazonprefs>`__
+Amazon
^^^^^^^^^^^^^^^^^^^^^^^^^
-`AmazonAssocTag <#AmazonAssocTag>`__
+.. _amazonassoctag-label:
+
+AmazonAssocTag
''''''''''''''''''''''''''''''''''''
Asks: Put the associate tag \_\_\_ on links to Amazon.
Sign up at: https://affiliate-program.amazon.com/
-`AmazonCoverImages <#AmazonCoverImages>`__
+.. _amazoncoverimages-label:
+
+AmazonCoverImages
''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
If they are not disabled, they will prevent AmazonCoverImages from
functioning properly.
-`AmazonLocale <#AmazonLocale>`__
+.. _amazonlocale-label:
+
+AmazonLocale
''''''''''''''''''''''''''''''''
Default: American
- Japanese
-`OPACAmazonCoverImages <#OPACAmazonCoverImages>`__
+.. _opacamazoncoverimages-label:
+
+OPACAmazonCoverImages
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
disabled, they will prevent AmazonCoverImages from functioning
properly.
-`Babelthèque <#Babelthequeprefs>`__
+.. _babelthã¨que-label:
+
+Babelthèque
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`Babeltheque <#Babeltheque>`__
+.. _babeltheque-label:
+
+Babeltheque
''''''''''''''''''''''''''''''
Default: Don't
- Don't
-`Babeltheque\_url\_js <#Babeltheque_url_js>`__
+.. _babeltheque\_url\_js-label:
+
+Babeltheque\_url\_js
''''''''''''''''''''''''''''''''''''''''''''''
Asks: \_\_\_ Defined the url for the Babeltheque javascript file (eg.
http://www.babeltheque.com/bw\_XX.js)
-`Babeltheque\_url\_update <#Babeltheque_url_update>`__
+.. _babeltheque\_url\_update-label:
+
+Babeltheque\_url\_update
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: \_\_\_ Defined the url for the Babeltheque update periodically
(eq. http://www.babeltheque.com/.../file.csv.bz2).
-`Baker & Taylor <#btcontentprefs>`__
+.. _baker-&-taylor-label:
+
+Baker & Taylor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Important**
This is a pay service, you must contact Baker & Taylor to subscribe
to this service before setting these options.
-`BakerTaylorBookstoreURL <#BakerTaylorBookstoreURL>`__
+.. _bakertaylorbookstoreurl-label:
+
+BakerTaylorBookstoreURL
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Baker and Taylor "My Library Bookstore" links should be accessed
Be sure to get this information from Baker & Taylor when
subscribing.
-`BakerTaylorEnabled <#BakerTaylorEnabled>`__
+.. _bakertaylorenabled-label:
+
+BakerTaylorEnabled
''''''''''''''''''''''''''''''''''''''''''''
Default: Don't add
**Important**
- To use this you will need to also set the `BakerTaylorUsername &
- BakerTaylorPassword <#btuserpass>`__ system preferences
+ To use this you will need to also set the :ref:`BakerTaylorUsername &
+ BakerTaylorPassword <bakertaylorusername-&-bakertaylorpassword-label>` system preferences
-`BakerTaylorUsername & BakerTaylorPassword <#btuserpass>`__
+.. _bakertaylorusername-&-bakertaylorpassword-label:
+
+BakerTaylorUsername & BakerTaylorPassword
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Access Baker and Taylor using username \_\_\_ and password \_\_\_
subscription to the external Content Café service from Baker &
Taylor. Use the box provided to enter in the library's Content Café
username and password. Also, ensure that the
- `BakerTaylorBookstoreURL <#BakerTaylorBookstoreURL>`__ and
- `BakerTaylorEnabled <#BakerTaylorEnabled>`__ settings are properly
+ :ref:`BakerTaylorBookstoreURL` and
+ :ref:`BakerTaylorEnabled` settings are properly
set. The Content Café service is a feed of enhanced content such as
cover art, professional reviews, and summaries that is displayed
along with Staff Client/OPAC search results. For more information on
Be sure to get this information from Baker & Taylor when
subscribing.
-`Coce Cover images cache <#coceimages>`__
+.. _coce-cover-images-cache-label:
+
+Coce Cover images cache
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Coce is a remote image URL cache. With this option, cover images are not
fetched directly from Amazon, Google, and so on. Their URLs are
requested via a web service to Coce which manages a cache of URLs.
-`Coce <#Coce>`__
+.. _coce-label:
+
+Coce
''''''''''''''''
Default: Don't enable
up. Instructions on installing and setting up Coce can be found
on the official github page at https://github.com/fredericd/coce.
-`CoceHost <#CoceHost>`__
+.. _cocehost-label:
+
+CoceHost
''''''''''''''''''''''''
Asks: Coce server URL \_\_\_
- This will be the full URL (starting with http://) to your Coce
server.
-`CoceProviders <#CoceProviders>`__
+.. _coceproviders-label:
+
+CoceProviders
''''''''''''''''''''''''''''''''''
Asks: Use the following providers to fetch the covers \_\_\_
- The providers chosen here will be used to gather cover images for
display in your Koha catalog.
-`Google <#googleprefs>`__
+.. _google-label:
+
+Google
^^^^^^^^^^^^^^^^^^^^^^^^^
-`GoogleJackets <#GoogleJackets>`__
+.. _googlejackets-label:
+
+GoogleJackets
''''''''''''''''''''''''''''''''''
Default: Don't add
that to use this feature, all other cover services should be turned
off.
-`HTML5 Media <#html5>`__
+.. _html5-media-label:
+
+HTML5 Media
^^^^^^^^^^^^^^^^^^^^^^^^
-`HTML5MediaEnabled <#HTML5MediaEnabled>`__
+.. _html5mediaenabled-label:
+
+HTML5MediaEnabled
''''''''''''''''''''''''''''''''''''''''''
Default: not at all
preference can run/show those media files in a separate tab using
HTML5.
-`HTML5MediaExtensions <#HTML5MediaExtensions>`__
+.. _html5mediaextensions-label:
+
+HTML5MediaExtensions
''''''''''''''''''''''''''''''''''''''''''''''''
Default: webm\|ogg\|ogv\|oga\|vtt
- Enter in file extensions separated with bar (\|)
-`HTML5MediaYouTube <#HTML5MediaYouTube>`__
+.. _html5mediayoutube-label:
+
+HTML5MediaYouTube
''''''''''''''''''''''''''''''''''''''''''
Default: Don't embed
**Important**
To turn this on first enable
- `HTML5MediaEnabled <#HTML5MediaEnabled>`__
+ :ref:`HTML5MediaEnabled`
Asks: \_\_\_ YouTube links as videos.
- This preference will allow MARC21 856$u that points to YouTube to
appear as a playable video on the pages defined in
- `HTML5MediaEnabled <#HTML5MediaEnabled>`__.
+ :ref:`HTML5MediaEnabled`.
+
+.. _idreamlibraries-label:
-`IDreamLibraries <#IDreamLibraries>`__
+IDreamLibraries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
`IDreamBooks.com <http://idreambooks.com/>`__ aggregates book reviews by
these features on new popular titles until the database grows some
more.
-`IDreamBooksReadometer <#IDreamBooksReadometer>`__
+.. _idreambooksreadometer-label:
+
+IDreamBooksReadometer
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't add
- Don't add
-`IDreamBooksResults <#IDreamBooksResults>`__
+.. _idreambooksresults-label:
+
+IDreamBooksResults
''''''''''''''''''''''''''''''''''''''''''''
Default: Don't add
- Don't add
-`IDreamBooksReviews <#IDreamBooksReviews>`__
+.. _idreambooksreviews-label:
+
+IDreamBooksReviews
''''''''''''''''''''''''''''''''''''''''''''
Default: Don't add
- Don't add
-`LibraryThing <#librarythingprefs>`__
+.. _librarything-label:
+
+LibraryThing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
LibraryThing for Libraries is a pay service. You must first contact
configuration instructions please see the LibraryThing Wiki:
http://www.librarything.com/wiki/index.php/Koha
-`LibraryThingForLibrariesEnabled <#LibraryThingForLibrariesEnabled>`__
+.. _librarythingforlibrariesenabled-label:
+
+LibraryThingForLibrariesEnabled
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
**Important**
If this is set to 'show' you will need to enter a value in the
- '`LibraryThingForLibrariesID <#LibraryThingForLibrariesID>`__'
+ ':ref:`LibraryThingForLibrariesID`'
system preference.
-`LibraryThingForLibrariesID <#LibraryThingForLibrariesID>`__
+.. _librarythingforlibrariesid-label:
+
+LibraryThingForLibrariesID
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Access Library Thing for Libraries using the customer ID \_\_\_
offer advanced features like tagged browsing, patron written reviews,
and a virtual library display accessed from the details tab.
-`LibraryThingForLibrariesTabbedView <#LibraryThingForLibrariesTabbedView>`__
+.. _librarythingforlibrariestabbedview-label:
+
+LibraryThingForLibrariesTabbedView
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: in line with bibliographic information
can offer advanced features like tagged browsing, patron written
reviews, and a virtual library display accessed from the details tab.
-`ThingISBN <#ThingISBN>`__
+.. _thingisbn-label:
+
+ThingISBN
''''''''''''''''''''''''''
Default: Don't use
**Important**
- Requires `FRBRizeEditions <#FRBRizeEditions>`__ and/or
- `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to 'show'
+ Requires :ref:`FRBRizeEditions` and/or
+ :ref:`OPACFRBRizeEditions` set to 'show'
**Important**
This is separate from Library Thing for Libraries and does not have
a cost associated with it.
-`Local Cover Images <#localimages>`__
+.. _local-cover-images-label:
+
+Local Cover Images
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AllowMultipleCovers <#AllowMultipleCovers>`__
+.. _allowmultiplecovers-label:
+
+AllowMultipleCovers
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- If this preference is set to 'Allow' then you can upload multiple
images that will appear in the images tab on the bib record in the
OPAC and the staff client. This preference requires that either one
- or both `LocalCoverImages <#LocalCoverImages>`__ and
- `OPACLocalCoverImages <#OPACLocalCoverImages>`__ are set to
+ or both :ref:`LocalCoverImages` and
+ :ref:`OPACLocalCoverImages` are set to
'Display.'
Multiple cover images
|image54|
-`LocalCoverImages <#LocalCoverImages>`__
+.. _localcoverimages-label:
+
+LocalCoverImages
''''''''''''''''''''''''''''''''''''''''
Default: Don't display
'Images' tab on the holdings table on the detail display, not next to
the title at the top left or on the search results.
-`OPACLocalCoverImages <#OPACLocalCoverImages>`__
+.. _opaclocalcoverimages-label:
+
+OPACLocalCoverImages
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't display
cover images to bib records and display them on the detail page and
search results in the OPAC.
-`Novelist Select <#novelistselect>`__
+.. _novelist-select-label:
+
+Novelist Select
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Novelist Select is not a free service. Contact your Ebsco representitive
Novelist Select does not include cover images for the search results
and bibliographic detail pages. You can choose any other cover image
service for this content or you can contract with Ebsco to get
- access to the `Baker & Taylor Content Cafe <#btcontentprefs>`__ for
+ access to the :ref:`Baker & Taylor Content Cafe <baker-&-taylor-label>` for
an added fee.
-`NovelistSelectEnabled <#NovelistSelectEnabled>`__
+.. _novelistselectenabled-label:
+
+NovelistSelectEnabled
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't add
**Important**
Enabling this requires that you have entered in a user profile and
- password in the `NovelistSelectProfile &
- NovelistSelectPassword <#NovelistSelectProfile>`__ preferences
+ password in the :ref:`NovelistSelectProfile &
+ NovelistSelectPassword <novelistselectprofile-&-novelistselectpassword-label>` preferences
Description:
- Novelist Select from Ebsco is a subscription service that can provide
additional content in the OPAC.
-`NovelistSelectProfile & NovelistSelectPassword <#NovelistSelectProfile>`__
+.. _novelistselectprofile-&-novelistselectpassword-label:
+
+NovelistSelectProfile & NovelistSelectPassword
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Access Novelist Select using user profile \_\_\_ and password
- Novelist Select from Ebsco is a subscription service that can provide
additional content in the OPAC.
-`NovelistSelectStaffEnabled <#NovelistSelectStaffEnabled>`__
+.. _novelistselectstaffenabled-label:
+
+NovelistSelectStaffEnabled
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't add
- Add
-`NovelistSelectStaffView <#NovelistSelectStaffView>`__
+.. _novelistselectstaffview-label:
+
+NovelistSelectStaffView
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: in a tab
- in a tab
-`NovelistSelectView <#NovelistSelectView>`__
+.. _novelistselectview-label:
+
+NovelistSelectView
''''''''''''''''''''''''''''''''''''''''''''
Default: in an OPAC tab
- under the Save Record dropdown on the right
-`OCLC <#oclcprefs>`__
+.. _oclc-label:
+
+OCLC
^^^^^^^^^^^^^^^^^^^^^
-`OCLCAffiliateID <#OCLCAffiliateID>`__
+.. _oclcaffiliateid-label:
+
+OCLCAffiliateID
''''''''''''''''''''''''''''''''''''''
Asks: Use the OCLC affiliate ID \_\_\_ to access the xISBN service.
ID. This allows WorldCat searching in the OPAC via the XISBN
programming interface. Simply enter the library's OCLC Affiliate ID
in the box provided. Please note that using this data is only
- necessary if `FRBRizeEditions <#FRBRizeEditions>`__ and/or
- `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ and `XISBN <#XISBN>`__
+ necessary if :ref:`FRBRizeEditions` and/or
+ :ref:`OPACFRBRizeEditions` and :ref:`XISBN`
settings are enabled. For more information on this service please
visit the OCLC website:
http://www.worldcat.org/affiliate/default.jsp.
1000 requests per day. Available at:
http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
-`XISBN <#XISBN>`__
+.. _xisbn-label:
+
+XISBN
''''''''''''''''''
Default: Don't use
**Important**
- Requires `FRBRizeEditions <#FRBRizeEditions>`__ and/or
- `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to 'show'
+ Requires :ref:`FRBRizeEditions` and/or
+ :ref:`OPACFRBRizeEditions` set to 'show'
+
+.. _xisbndailylimit-label:
-`XISBNDailyLimit <#XISBNDailyLimit>`__
+XISBNDailyLimit
''''''''''''''''''''''''''''''''''''''
Default: 999
1000 requests per day. Available at:
http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
-`Open Library <#OpenLibraryPrefs>`__
+.. _open-library-label:
+
+Open Library
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`OpenLibraryCovers <#OpenLibraryCovers>`__
+.. _openlibrarycovers-label:
+
+OpenLibraryCovers
''''''''''''''''''''''''''''''''''''''''''
Default: Don't add
that to use this feature, all other cover services should be turned
off.
-`OpenLibrarySearch <#OpenLibrarySearch>`__
+.. _openlibrarysearch-label:
+
+OpenLibrarySearch
''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- ShowOpen Library results
-`Overdrive <#overdriveprefs>`__
+.. _overdrive-label:
+
+Overdrive
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
OverDrive is an pay service. You must first contact OverDrive directly
Overdrive results
|image57|
-`OverDriveCirculation <#OverDriveCirculation>`__
+.. _overdrivecirculation-label:
+
+OverDriveCirculation
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't enable
- Enable
-`OverDriveClientKey and OverDriveClientSecret <#OverDriveClientKey>`__
+.. _overdriveclientkey-and-overdriveclientsecret-label:
+
+OverDriveClientKey and OverDriveClientSecret
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Include OverDrive availability information with the client key
`OverDrive Developer
Portal <https://developer.overdrive.com/docs/getting-started>`__ and
following the instructions found there to apply as an API developer.
- Once this data and the `OverDriveLibraryID <#OverDriveLibraryID>`__
+ Once this data and the :ref:`OverDriveLibraryID`
are populated you will see OverDrive results on your OPAC searches.
-`OverDriveLibraryID <#OverDriveLibraryID>`__
+.. _overdrivelibraryid-label:
+
+OverDriveLibraryID
''''''''''''''''''''''''''''''''''''''''''''
Asks: Show items from the OverDrive catalog of library # \_\_\_
`OverDrive Developer
Portal <https://developer.overdrive.com/docs/getting-started>`__ and
following the instructions found there to apply as an API developer.
- Once this data and the `OverDriveClientKey and
- OverDriveClientSecret <#OverDriveClientKey>`__ are populated you will
+ Once this data and the :ref:`OverDriveClientKey and
+ OverDriveClientSecret <overdriveclientkey-and-overdriveclientsecret-label>` are populated you will
see OverDrive results on your OPAC searches.
-`Plugins <#pluginprefs>`__
+.. _plugins-label:
+
+Plugins
^^^^^^^^^^^^^^^^^^^^^^^^^^
-`UseKohaPlugins <#UseKohaPlugins>`__
+.. _usekohaplugins-label:
+
+UseKohaPlugins
''''''''''''''''''''''''''''''''''''
Default: Don't enable
file to be fully enabled. Learn more in the `Plugins
chapter <#pluginsystem>`__.
-`Syndetics <#Syndeticsprefs>`__
+.. _syndetics-label:
+
+Syndetics
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Syndetics is a pay service. You must first contact Syndetics directly
for pricing and subscription information.
-`SyndeticsAuthorNotes <#SyndeticsAuthorNotes>`__
+.. _syndeticsauthornotes-label:
+
+SyndeticsAuthorNotes
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
Syndetics Author Notes on the OPAC. According to the Syndetics
Solutions website (http://www.bowker.com/syndetics/), Author Notes
include lists of contributors for many multi-author texts and
- compilations. The `SyndeticsClientCode <#SyndeticsClientCode>`__ must
- be entered and the `SyndeticsEnabled <#SyndeticsEnabled>`__ option
+ compilations. The :ref:`SyndeticsClientCode` must
+ be entered and the :ref:`SyndeticsEnabled` option
must be activated before this service can be used.
-`SyndeticsAwards <#SyndeticsAwards>`__
+.. _syndeticsawards-label:
+
+SyndeticsAwards
''''''''''''''''''''''''''''''''''''''
Default: Don't show
the user clicks on any title in the list, they will see holdings
information about that title in their region. This option is a paid
subscription service. The
- `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
- the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
+ :ref:`SyndeticsClientCode` must be entered and
+ the :ref:`SyndeticsEnabled` option must be activated
before this service can be used.
-`SyndeticsClientCode <#SyndeticsClientCode>`__
+.. _syndeticsclientcode-label:
+
+SyndeticsClientCode
''''''''''''''''''''''''''''''''''''''''''''''
Asks: Use the client code \_\_\_ to access Syndetics.
This is the code that must be entered to access Syndetics'
subscription services. Syndetics is a paid subscription service. This
value must be entered before
- `SyndeticsEditions <#SyndeticsEditions>`__ can be enabled. If the
+ :ref:`SyndeticsEditions` can be enabled. If the
code is lost, corrupted, or forgotten, a new one can be obtained from
http://www.bowker.com/syndetics/.
You will need to get your client code directly from Syndetics.
-`SyndeticsCoverImages & SyndeticsCoverImageSize <#SyndeticsCoverImages>`__
+.. _syndeticscoverimages-&-syndeticscoverimagesize-label:
+
+SyndeticsCoverImages & SyndeticsCoverImageSize
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
SyndeticsCoverImages Default: Don't show
after SyndeticsCoverImages are enabled. Syndetics cover images come
in two sizes: mid-size (187 x 187 pixels), and large (400 x 400
pixels). Syndetics is a paid subscription service. The
- `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
- the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
+ :ref:`SyndeticsClientCode` must be entered and
+ the :ref:`SyndeticsEnabled` option must be activated
before this service can be used. Other cover image preferences should
also be disabled to avoid interference.
- large
-`SyndeticsEditions <#SyndeticsEditions>`__
+.. _syndeticseditions-label:
+
+SyndeticsEditions
''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- When enabled this option shows information on other editions of a
title from Syndetics on the item detail pages of the OPAC. Syndetics
is a paid subscription service. The
- `SyndeticsClientCode <#SyndeticsClientCode>`__ must be entered and
- the `SyndeticsEnabled <#SyndeticsEnabled>`__ option must be activated
+ :ref:`SyndeticsClientCode` must be entered and
+ the :ref:`SyndeticsEnabled` option must be activated
before this service can be used.
Values:
**Important**
- Requires `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ set to
+ Requires :ref:`OPACFRBRizeEditions` set to
'show'
-`SyndeticsEnabled <#SyndeticsEnabled>`__
+.. _syndeticsenabled-label:
+
+SyndeticsEnabled
''''''''''''''''''''''''''''''''''''''''
Default: Don't use
**Important**
Requires that you enter your
- `SyndeticsClientCode <#SyndeticsClientCode>`__ before this content
+ :ref:`SyndeticsClientCode` before this content
will appear.
-`SyndeticsExcerpt <#SyndeticsExcerpt>`__
+.. _syndeticsexcerpt-label:
+
+SyndeticsExcerpt
''''''''''''''''''''''''''''''''''''''''
Default: Don't show
library OPACs. For more information see
(http://www.bowker.com/syndetics/).
-`SyndeticsReviews <#SyndeticsReviews>`__
+.. _syndeticsreviews-label:
+
+SyndeticsReviews
''''''''''''''''''''''''''''''''''''''''
Default: Don't show
secured, high-speed Internet servers to the library OPACs. For more
information see (http://www.bowker.com/syndetics/).
-`SyndeticsSeries <#SyndeticsSeries>`__
+.. _syndeticsseries-label:
+
+SyndeticsSeries
''''''''''''''''''''''''''''''''''''''
Default: Don't show
speed Internet servers to the library OPACs. For more information see
(http://www.bowker.com/syndetics/).
-`SyndeticsSummary <#SyndeticsSummary>`__
+.. _syndeticssummary-label:
+
+SyndeticsSummary
''''''''''''''''''''''''''''''''''''''''
Default: Don't show
scholarly titles. For more information see
(http://www.bowker.com/syndetics/).
-`SyndeticsTOC <#SyndeticsTOC>`__
+.. _syndeticstoc-label:
+
+SyndeticsTOC
''''''''''''''''''''''''''''''''
Default: Don't show
high-speed Internet servers to the library OPACs. For more
information see (http://www.bowker.com/syndetics/).
-`Tagging <#taggingprefs>`__
+.. _tagging-label:
+
+Tagging
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`TagsEnabled <#TagsEnabled>`__
+.. _tagsenabled-label:
+
+TagsEnabled
''''''''''''''''''''''''''''''
Default: Allow
features. TagsEnable must be set to 'Allow' to allow for other
tagging features.
-`TagsExternalDictionary <#TagsExternalDictionary>`__
+.. _tagsexternaldictionary-label:
+
+TagsExternalDictionary
''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Allow tags in the dictionary of the ispell executable \_\_\_ on
on your server to a local ispell executable, used to set
$Lingua::Ispell::path.
-`TagsInputOnDetail <#TagsInputOnDetail>`__
+.. _tagsinputondetail-label:
+
+TagsInputOnDetail
''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Don't allow
-`TagsInputOnList <#TagsInputOnList>`__
+.. _tagsinputonlist-label:
+
+TagsInputOnList
''''''''''''''''''''''''''''''''''''''
Default: Allow
- Don't allow
-`TagsModeration <#TagsModeration>`__
+.. _tagsmoderation-label:
+
+TagsModeration
''''''''''''''''''''''''''''''''''''
Default: Don't require
When moderation is required all tags go through the tag moderation tool
before becoming visible.
-- *Get there:* More > Tools > `Tags <#tagsmoderation>`__
+- *Get there:* More > Tools > :ref:`Tags <tag-moderation-label>`
-`TagsShowOnDetail <#TagsShowOnDetail>`__
+.. _tagsshowondetail-label:
+
+TagsShowOnDetail
''''''''''''''''''''''''''''''''''''''''
Default: 10
Set the value to 0 (zero) to turn this feature off.
-`TagsShowOnList <#TagsShowOnList>`__
+.. _tagsshowonlist-label:
+
+TagsShowOnList
''''''''''''''''''''''''''''''''''''
Default: 6
Set the value to 0 (zero) to turn this feature off.
-`I18N/L10N <#l18nprefs>`__
+.. _i18n/l10n-label:
+
+I18N/L10N
~~~~~~~~~~~~~~~~~~~~~~~~~~
These preferences control your Internationalization and Localization
*Get there:* More > Administration > Global System Preferences >
I18N/L10N
-`AddressFormat <#AddressFormat>`__
-''''''''''''''''''''''''''''''''''
+.. _addressformat-label:
+
+AddressFormat
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: US style ([Street number], [Address] - [City], [Zip/Postal
Code], [Country])
addresses given the information entered in the various fields on
their record.
-`alphabet <#alphabet>`__
-''''''''''''''''''''''''
+.. _alphabet-label:
+
+alphabet
+^^^^^^^^^^^^^^^^^^^^^^^^
Default: A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Alphabet browse on patron module
|image60|
-`CalendarFirstDayOfWeek <#CalendarFirstDayOfWeek>`__
-''''''''''''''''''''''''''''''''''''''''''''''''''''
+.. _calendarfirstdayofweek-label:
+
+CalendarFirstDayOfWeek
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Sunday
in your browser try clearing your cache since it makes changes to the
Javascript on these pages.
-`dateformat <#dateformat>`__
-''''''''''''''''''''''''''''
+.. _dateformat-label:
+
+dateformat
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: mm/dd/yyyy
regarding the ISO date format can be found at
http://www.iso.org/iso/iso_catalogue.htm.
-`language <#languagepref>`__
-''''''''''''''''''''''''''''
+.. _language-label:
+
+language
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: English
To install additional languages please refer to
http://wiki.koha-community.org/wiki/Installation_of_additional_languages_for_OPAC_and_INTRANET_staff_client
-`opaclanguages <#opaclanguages>`__
-''''''''''''''''''''''''''''''''''
+.. _opaclanguages-label:
+
+opaclanguages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: English
templates, once they exist and are in the right place then they will
show up as an option in this preference.
-`opaclanguagesdisplay <#opaclanguagesdisplay>`__
-''''''''''''''''''''''''''''''''''''''''''''''''
+.. _opaclanguagesdisplay-label:
+
+opaclanguagesdisplay
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Don't allow
Description:
-- Using the `OpacLangSelectorMode <#OpacLangSelectorMode>`__ preference
+- Using the :ref:`OpacLangSelectorMode` preference
you can decide where these language options will appear in the public
catalog.
-`TimeFormat <#TimeFormat>`__
-''''''''''''''''''''''''''''
+.. _timeformat-label:
+
+TimeFormat
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: 24 hour format
- 24 hour format (eg 14:18)
-`TranslateNotices <#TranslateNotices>`__
-''''''''''''''''''''''''''''''''''''''''
+.. _translatenotices-label:
+
+TranslateNotices
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Don't allow
- Allow
-`Labs <#labsprefs>`__
+.. _labs-label:
+
+Labs
~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences > Labs
The preferences in this section are for experimental features that need
additional testing and debugging.
-`EnableAdvancedCatalogingEditor <#EnableAdvancedCatalogingEditor>`__
+.. _enableadvancedcatalogingeditor-label:
+
+EnableAdvancedCatalogingEditor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Don't enable
Description:
- This preference will allow you to choose between a basic editor and a
- advanced editor for cataloging.
+advanced editor for cataloging.
- **Important**
+**Important**
+
+This feature is currently experimental, and may have bugs that cause
+corruption of records. It also does not include any support for
+UNIMARC or NORMARC fixed fields. Please help us test it and report
+any bugs, but do so at your own risk.
- This feature is currently experimental, and may have bugs that cause
- corruption of records. It also does not include any support for
- UNIMARC or NORMARC fixed fields. Please help us test it and report
- any bugs, but do so at your own risk.
+.. _local-use-label:
-`Local Use <#localprefs>`__
+Local Use
~~~~~~~~~~~~~~~~~~~~~~~~~~~
These preferences are defined locally.
*Get there:* More > Administration > Global System Preferences > Local
Use
- **Note**
+**Note**
+
+Sometimes preferences which are either new or outdated will appear
+in this tab, if you didn't add any preferences to this tab then it's
+best to ignore preferences listed here.
- Sometimes preferences which are either new or outdated will appear
- in this tab, if you didn't add any preferences to this tab then it's
- best to ignore preferences listed here.
+.. _articlerequestsmandatoryfieldsitemsonly-label:
-`ArticleRequestsMandatoryFieldsItemsOnly <#ArticleRequestsMandatoryFieldsItemsOnly>`__
+ArticleRequestsMandatoryFieldsItemsOnly
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: blank
Asks: Comma delimited list of required fields for bibs where artciel requests
rule = "item_only"
-`INTRAdidyoumean <#INTRAdidyoumean>`__
+.. _intradidyoumean-label:
+
+INTRAdidyoumean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: blank
Asks: Did you mean? configuration for the Intranet. Do not change, as this is
controlled by /cgi-bin/koha/admin/didyoumean.pl.
-`OPACdidyoumean <#OPACdidyoumean>`__
+.. _opacdidyoumean-label:
+
+OPACdidyoumean
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: blank
Asks: Did you mean? configuration for the OPAC. Do not change, as this is
controlled by /cgi-bin/koha/admin/didyoumean.pl.
-`printcirculationships <#printcirculationships>`__
+.. _printcirculationships-label:
+
+printcirculationships
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: ON
- OFF
-`UsageStatsID <#UsageStatsID>`__
+.. _usagestatsid-label:
+
+UsageStatsID
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: blank
Asks: This preference is part of Koha but it should not be deleted or
updated manually.
-`UsageStatsLastUpdateTime <#UsageStatsLastUpdateTime>`__
+.. _usagestatslastupdatetime-label:
+
+UsageStatsLastUpdateTime
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: blank
Asks: This preference is part of Koha but it should not be deleted or
updated manually.
-`UsageStatsPublicID <#UsageStatsPublicID>`__
+.. _usagestatspublicid-label:
+
+UsageStatsPublicID
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: blank
Asks: Public ID for Hea website
-`Version <#Version>`__
+.. _version-label:
+
+Version
^^^^^^^^^^^^^^^^^^^^^^
Default: automatically generated
Asks: The Koha database version. WARNING: Do not change this value
manually. It is maintained by the webinstaller
-`Logs <#logs>`__
+.. _logs-label:
+
+Logs
~~~~~~~~~~~~~~~~
Logs keep track of transaction on the system. You can decide which
actions you want to log and which you don't using these preferences.
-Logs can then be viewed in the `Log Viewer <#logviewer>`__ under Tools.
+Logs can then be viewed in the :ref:`Log Viewer` under Tools.
*Get there:* More > Administration > Global System Preferences > Logs
-`Debugging <#debuggingprefs>`__
+.. _debugging-label:
+
+Debugging
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`DumpTemplateVarsIntranet <#DumpTemplateVarsIntranet>`__
+.. _dumptemplatevarsintranet-label:
+
+DumpTemplateVarsIntranet
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't
- Do
-`DumpTemplateVarsOpac <#DumpTemplateVarsOpac>`__
+.. _dumptemplatevarsopac-label:
+
+DumpTemplateVarsOpac
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't
- Do
-`Logging <#loggingprefs>`__
+.. _logging-label:
+
+Logging
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AuthoritiesLog <#AuthoritiesLog>`__
+.. _authoritieslog-label:
+
+AuthoritiesLog
''''''''''''''''''''''''''''''''''''
Default: Don't log
- Log
-`BorrowersLog <#BorrowersLog>`__
+.. _borrowerslog-label:
+
+BorrowersLog
''''''''''''''''''''''''''''''''
Default: Log
- Log
-`CataloguingLog <#CataloguingLog>`__
+.. _cataloguinglog-label:
+
+CataloguingLog
''''''''''''''''''''''''''''''''''''
Default: Don't log
- Log
- **Important**
+**Important**
+
+Since this occurs whenever a book is cataloged, edited, or checked
+in or out it can be very resource intensive - slowing down your
+system.
- Since this occurs whenever a book is cataloged, edited, or checked
- in or out it can be very resource intensive - slowing down your
- system.
+.. _cronjoblog-label:
-`CronjobLog <#CronjobLog>`__
+CronjobLog
''''''''''''''''''''''''''''
Default: Don't log
- Log
-`FinesLog <#FinesLog>`__
+.. _fineslog-label:
+
+FinesLog
''''''''''''''''''''''''
Default: Log
- Log
-`HoldsLog <#HoldsLog>`__
+.. _holdslog-label:
+
+HoldsLog
''''''''''''''''''''''''
Default: Don't log
- Log
-`IssueLog <#IssueLog>`__
+.. _issuelog-label:
+
+IssueLog
''''''''''''''''''''''''
Default: Log
- Log
-`LetterLog <#LetterLog>`__
+.. _letterlog-label:
+
+LetterLog
''''''''''''''''''''''''''
Default: Log
- Log
- **Note**
+**Note**
- This log tracks all notices that go to patrons including the overdue
- notices.
+This log tracks all notices that go to patrons including the overdue
+notices.
-`RenewalLog <#RenewalLog>`__
+.. _renewallog-label:
+
+RenewalLog
''''''''''''''''''''''''''''
Default: Don't log
- Log
-`ReportsLog <#ReportsLog>`__
+.. _reportslog-label:
+
+ReportsLog
''''''''''''''''''''''''''''
Default: Don't log
- Log
-`ReturnLog <#ReturnLog>`__
+.. _returnlog-label:
+
+ReturnLog
''''''''''''''''''''''''''
Default: Log
- Log
-`SubscriptionLog <#SubscriptionLog>`__
+.. _subscriptionlog-label:
+
+SubscriptionLog
''''''''''''''''''''''''''''''''''''''
Default: Log
- Log
-`OPAC <#opacprefs>`__
+.. _opac-label:
+
+OPAC
~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences > OPAC
-`Advanced Search Options <#advancedsearchopt>`__
+.. _advanced-search-options-label:
+
+Advanced Search Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`OpacAdvSearchMoreOptions <#OpacAdvSearchMoreOptions>`__
+.. _opacadvsearchmoreoptions-label:
+
+OpacAdvSearchMoreOptions
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Select All
Description:
- The settings in this preference will determine which search fields
- will show when the patron is using the 'More options' mode on the
- advanced search page.
+will show when the patron is using the 'More options' mode on the
+advanced search page.
+
+.. _opacadvsearchoptions-label:
-`OpacAdvSearchOptions <#OpacAdvSearchOptions>`__
+OpacAdvSearchOptions
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Item types, Language, Location and availability, Publication
Description:
- The settings in this preference will determine which search fields
- will show when the patron is using the 'Fewer options' mode on the
- advanced search page.
+will show when the patron is using the 'Fewer options' mode on the
+advanced search page.
-`Appearance <#opacappearanceprefs>`__
+.. _appearance-label:
+
+Appearance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
These preferences control how things appear in the OPAC.
-`AuthorisedValueImages <#AuthorisedValueImages>`__
+.. _authorisedvalueimages-label:
+
+AuthorisedValueImages
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- Show
-*Get there:* More > Administration > `Authorized
-Values <#authorizedvalues>`__
+*Get there:* More > Administration > :ref:`Authorized
+Values <authorized-values-label>`
-`BiblioDefaultView <#BiblioDefaultView>`__
+.. _bibliodefaultview-label:
+
+BiblioDefaultView
''''''''''''''''''''''''''''''''''''''''''
Default: in simple form
- as specified in the ISBD template.
- - See `ISBD <#isbdpref>`__ preference for more information
+- See :ref:`ISBD` preference for more information
- in simple form.
Description:
- This preference determines the level of bibliographic detail that the
- patron will see on the OPAC detail page. The simple form displays the
- graphical interface; MARC format displays the MARC21 cataloging view;
- ISBD displays the ISBD (International Standard Bibliographic
- Description, AACR2) view.
+patron will see on the OPAC detail page. The simple form displays the
+graphical interface; MARC format displays the MARC21 cataloging view;
+ISBD displays the ISBD (International Standard Bibliographic
+Description, AACR2) view.
+
+.. _coinsinopacresults-label:
-`COinSinOPACResults <#COinSinOPACResults>`__
+COinSinOPACResults
''''''''''''''''''''''''''''''''''''''''''''
Default: Include
- Don't include
- - If you choose not to include COinS on the search results, it will
- still be loaded on the individual bibliographic records.
+- If you choose not to include COinS on the search results, it will
+ still be loaded on the individual bibliographic records.
- Include
- - Enabling this feature will slow OPAC search response times.
+- Enabling this feature will slow OPAC search response times.
Description:
- COinS stands for ContextObjects in Spans. COinS is a method to embed
- bibliographic metadata in the HTML code of web pages. This allows
- bibliographic software to publish machine-readable bibliographic
- items and client reference management software (such as Zotero) to
- retrieve bibliographic metadata. The metadata can also be sent to an
- OpenURL resolver. This allows, for instance, searching for a copy of
- a book in one's own library.
-
-`DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__
+bibliographic metadata in the HTML code of web pages. This allows
+bibliographic software to publish machine-readable bibliographic
+items and client reference management software (such as Zotero) to
+retrieve bibliographic metadata. The metadata can also be sent to an
+OpenURL resolver. This allows, for instance, searching for a copy of
+a book in one's own library.
+
+.. _displayopaciconsxslt-label:
+
+DisplayOPACiconsXSLT
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
Asks: On pages displayed with XSLT stylesheets on the OPAC, \_\_\_ icons
for itemtype and authorized values.
- **Important**
+**Important**
- `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ and/or
- `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ must be set to
- use an XSLT stylesheet for this to show (default or custom)
+:ref:`OPACXSLTResultsDisplay` and/or
+:ref:`OPACXSLTDetailsDisplay` must be set to
+use an XSLT stylesheet for this to show (default or custom)
Values:
- Show
- DisplayOPACiconsXSLT
- |image62|
+DisplayOPACiconsXSLT
+|image62|
- **Note**
+**Note**
- See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
- these icons.
+See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
+these icons.
-`GoogleIndicTransliteration <#GoogleIndicTransliteration>`__
+.. _googleindictransliteration-label:
+
+GoogleIndicTransliteration
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- Show
-`hidelostitems <#hidelostitems>`__
+.. _hidelostitems-label:
+
+hidelostitems
''''''''''''''''''''''''''''''''''
Default: Don't show
Description:
- Items that are marked lost by the library can either be shown or not
- shown on the OPAC. By setting the value to "Don't show," the lost
- item is not shown on the OPAC. By setting the value "Show," the lost
- item is shown on the OPAC for patrons to view with a status of
- 'lost.'
+shown on the OPAC. By setting the value to "Don't show," the lost
+item is not shown on the OPAC. By setting the value "Show," the lost
+item is shown on the OPAC for patrons to view with a status of
+'lost.'
Values:
- Show
- Lost item showing in the OPAC
- |image63|
+Lost item showing in the OPAC
+|image63|
+
+.. _highlightownitemsonopac-&-highlightownitemsonopacwhich-label:
-`HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich <#HighlightOwnItemsOnOPAC>`__
+HighlightOwnItemsOnOPAC & HighlightOwnItemsOnOPACWhich
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
HighlightOwnItemsOnOPAC Default: Don't emphasize
- OPAC's branch based via the URL
- - The library is chosen based on the Apache environment variable
- BRANCHCODE. For example, this could be added to the OPAC section
- of koha-httpd.conf: SetEnv BRANCHCODE "CPL"
+- The library is chosen based on the Apache environment variable
+ BRANCHCODE. For example, this could be added to the OPAC section
+ of koha-httpd.conf: SetEnv BRANCHCODE "CPL"
- patron's home library
- - The items emphasized will be those of the same library as the
- patron's library. If no one is logged into the OPAC, no items will
- be highlighted.
+- The items emphasized will be those of the same library as the
+ patron's library. If no one is logged into the OPAC, no items will
+ be highlighted.
- **Important**
+**Important**
+
+This preference will only effect sites that are not using an XSLT
+stylesheet. XSLT stylesheets are defined in the
+:ref:`OPACXSLTResultsDisplay` and
+:ref:`OPACXSLTDetailsDisplay` preferences.
- This preference will only effect sites that are not using an XSLT
- stylesheet. XSLT stylesheets are defined in the
- `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ and
- `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preferences.
+.. _libraryname-label:
-`LibraryName <#LibraryName>`__
+LibraryName
''''''''''''''''''''''''''''''
Asks: Show \_\_\_ as the name of the library on the OPAC.
- **Note**
+**Note**
- This value will appear in the title bar of the browser
+This value will appear in the title bar of the browser
- **Note**
+**Note**
- Edit '`opacheader <#opacheader>`__' if you'd like to add a library
- name above your search box on the OPAC
+Edit ':ref:`opacheader`' if you'd like to add a library
+name above your search box on the OPAC
Browser title and address bar
|image64|
-`NoLoginInstructions <#NoLoginInstructions>`__
+.. _nologininstructions-label:
+
+NoLoginInstructions
''''''''''''''''''''''''''''''''''''''''''''''
Asks: Show the following HTML on the OPAC login form when a patron is
Description:
- This preference allows you to override the default text seen on the
- log in page in the Koha OPAC. The default HTML is:
+log in page in the Koha OPAC. The default HTML is:
- ::
+::
- <h5>Don't have a password yet?</h5>
- <p> If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.</p>
- <h5>Don't have a library card?</h5>
- <p> If you don't have a library card, stop by your local library to sign up.</p>
+ <h5>Don't have a password yet?</h5>
+ <p> If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.</p>
+ <h5>Don't have a library card?</h5>
+ <p> If you don't have a library card, stop by your local library to sign up.</p>
- Any HTML in this box will replace the above text below the log in
- box.No login instructions
+Any HTML in this box will replace the above text below the log in
+box.No login instructions
-`OpacAdditionalStylesheet <#OpacAdditionalStylesheet>`__
+.. _opacadditionalstylesheet-label:
+
+OpacAdditionalStylesheet
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Include the additional CSS stylesheet \_\_\_ to override specified
Description:
- The preference can look for stylesheets in the template directory for
- your OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css.
- If you upload a custom file, opac-mystyles.css to this directory, you
- can specify it by entering opac-mystyles.css in your
- opaccolorstylesheet system preference. This adds your custom
- stylesheet as a linked stylesheet alongside the OPAC's default CSS
- files. This method is preferable because linked stylesheets are
- cached by the user's browser, meaning upon repeat visits to your site
- the user's browser will not have to re-download the stylesheet,
- instead using the copy in the browser's cache.
+your OPAC language, for instance: /koha-tmpl/opac-tmpl/prog/en/css.
+If you upload a custom file, opac-mystyles.css to this directory, you
+can specify it by entering opac-mystyles.css in your
+opaccolorstylesheet system preference. This adds your custom
+stylesheet as a linked stylesheet alongside the OPAC's default CSS
+files. This method is preferable because linked stylesheets are
+cached by the user's browser, meaning upon repeat visits to your site
+the user's browser will not have to re-download the stylesheet,
+instead using the copy in the browser's cache.
- If you would rather, you can upload your CSS to another server and
- enter the full URL pointing to it's location remember to begin the
- URL with http://
+enter the full URL pointing to it's location remember to begin the
+URL with http://
- **Note**
+**Note**
- Leave this field blank to disable it
+Leave this field blank to disable it
- **Note**
+**Note**
- This file will add a linked CSS, not replace the existing default
- CSS.
+This file will add a linked CSS, not replace the existing default
+CSS.
-`OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__
+.. _opacaddmastheadlibrarypulldown-label:
+
+OpacAddMastheadLibraryPulldown
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't add
- Add
- Library select box on Koha OPAC
- |image65|
+Library select box on Koha OPAC
+|image65|
- Don't Add
- No library select box on Koha OPAC
- |image66|
+No library select box on Koha OPAC
+|image66|
+
+.. _opacbaseurl-label:
-`OPACBaseURL <#OPACBaseURL>`__
+OPACBaseURL
''''''''''''''''''''''''''''''
Asks: The OPAC is located at \_\_\_
Description:
- This preference is looking for the URL of your public catalog (OPAC)
- with the http:// in front of it (enter http://www.mycatalog.com
- instead of www.mycatalog.com). Once it is filled in Koha will use it
- to generate permanent links in your RSS feeds, for your social
- network share buttons and in your staff client when generating links
- to bib records in the OPAC.
+with the http:// in front of it (enter http://www.mycatalog.com
+instead of www.mycatalog.com). Once it is filled in Koha will use it
+to generate permanent links in your RSS feeds, for your social
+network share buttons and in your staff client when generating links
+to bib records in the OPAC.
- **Important**
+**Important**
- Do not include a trailing slash in the URL this will break links
- created using this URL. (example: http://www.google.com not
- http://www.google.com/)
+Do not include a trailing slash in the URL this will break links
+created using this URL. (example: http://www.google.com not
+http://www.google.com/)
- **Important**
+**Important**
- This must be filled in with the URL of your public catalog for RSS,
- unAPI, and search plugins to work.
+This must be filled in with the URL of your public catalog for RSS,
+unAPI, and search plugins to work.
- **Important**
+**Important**
- This must be filled in with the URL of your public catalog to show
- 'OPAC View' links from bib records in the staff client:
+This must be filled in with the URL of your public catalog to show
+'OPAC View' links from bib records in the staff client:
With OPACBaseURL set, links to the OPAC will appear on each individual
bib record in the staff client
|image67|
-`opaccredits <#opaccredits>`__
+.. _opaccredits-label:
+
+opaccredits
''''''''''''''''''''''''''''''
Asks: Include the following HTML in the footer of all pages in the OPAC:
- **Note**
+**Note**
- Click the 'Click to edit; link to enter HTML to appear at the bottom
- of every page in the OPAC
+Click the 'Click to edit; link to enter HTML to appear at the bottom
+of every page in the OPAC
HTML version of a footer for your OPAC
|image68|
Description:
- This setting is for credits that will appear at the bottom of your
- OPAC pages. Credits traditionally encompass copyright information,
- last date updated, hyperlinks or other information represented in an
- HTML format. This is static information and any updates must be
- entered manually.
+OPAC pages. Credits traditionally encompass copyright information,
+last date updated, hyperlinks or other information represented in an
+HTML format. This is static information and any updates must be
+entered manually.
+
+Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
-Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
+.. _opaccustomsearch-label:
-`OpacCustomSearch <#OpacCustomSearch>`__
+OpacCustomSearch
''''''''''''''''''''''''''''''''''''''''
Asks: Replace the search box at the top of OPAC pages with the following
Description:
- This preference allows you to replace the default search box at the
- top of the OPAC : Default search box
+top of the OPAC : Default search box
+
+with any HTML you would like :Edited search box area
- with any HTML you would like :Edited search box area
+.. _opacdisplay856uasimage-label:
-`OPACDisplay856uAsImage <#OPACDisplay856uAsImage>`__
+OPACDisplay856uAsImage
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Neither details or results page
- Both results and details pages
- - **Important**
+- **Important**
- Not implemented yet
+ Not implemented yet
- Detail page only
- - **Important**
+- **Important**
- `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ needs to
- have a value in it for this preference to work.
+ :ref:`OPACXSLTDetailsDisplay` needs to
+ have a value in it for this preference to work.
- Showing the 856u as an image
- |image70|
+Showing the 856u as an image
+|image70|
- Neither details or results page
- Results page only
- - **Important**
+- **Important**
- Not yet implemented
+ Not yet implemented
Description:
- In addition to this option being set, the corresponding XSLT option
- must be turned on. Also, the corresponding 856q field must have a
- valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
- starting with "image/"), or the generic indicator "img" entered in
- the field. When all of the requirements are met, an image file will
- be displayed instead of the standard link text. Clicking on the image
- will open it in the same way as clicking on the link text. When you
- click on the image it should open to full size, in the current window
- or in a new window depending on the value in the system pref
- `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__.
-
- Sample 856 in MARC Record
- |image71|
-
-`OpacExportOptions <#OpacExportOptions>`__
+must be turned on. Also, the corresponding 856q field must have a
+valid MIME image extension (e.g., "jpg") or MIME image type (i.e.
+starting with "image/"), or the generic indicator "img" entered in
+the field. When all of the requirements are met, an image file will
+be displayed instead of the standard link text. Clicking on the image
+will open it in the same way as clicking on the link text. When you
+click on the image it should open to full size, in the current window
+or in a new window depending on the value in the system pref
+:ref:`OPACURLOpenInNewWindow`.
+
+Sample 856 in MARC Record
+|image71|
+
+.. _opacexportoptions-label:
+
+OpacExportOptions
''''''''''''''''''''''''''''''''''''''''''
Default: Default OpacExportOptions options
Description:
- In the OPAC on the right of each bib record there is a menu that
- allows for saving the record in various formats. This patch will
- allow you to define which options are in the pull down menu.
- Available options are: BIBTEX (bibtex), Dublin Core (dc), MARCXML
- (marcxml), MARC-8 encoded MARC (marc8), Unicode/UTF-8 encoded MARC
- (utf8), Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9-
- fields and subfields (marcstd), MODS (mods), and RIS (ris).
-
-`OPACFallback <#OPACFallback>`__
+allows for saving the record in various formats. This patch will
+allow you to define which options are in the pull down menu.
+Available options are: BIBTEX (bibtex), Dublin Core (dc), MARCXML
+(marcxml), MARC-8 encoded MARC (marc8), Unicode/UTF-8 encoded MARC
+(utf8), Unicode/UTF-8 encoded MARC without local use -9xx, x9x, xx9-
+fields and subfields (marcstd), MODS (mods), and RIS (ris).
+
+.. _opacfallback-label:
+
+OPACFallback
''''''''''''''''''''''''''''''''
Default: bootstrap
Description:
- This preference has no use right now, as Koha has only one theme, but
- if your library has a custom theme it will show here as an option.
- The purpose of this preference is to provide a way to choose to what
- theme to fallback on when you have a partial theme in place.
+if your library has a custom theme it will show here as an option.
+The purpose of this preference is to provide a way to choose to what
+theme to fallback on when you have a partial theme in place.
+
+.. _opacfavicon-label:
-`OpacFavicon <#OpacFavicon>`__
+OpacFavicon
''''''''''''''''''''''''''''''
Asks: Use the image at \_\_\_ for the OPAC's favicon.
- **Important**
+**Important**
- This should be a complete URL, starting with http://
+This should be a complete URL, starting with http://
- **Note**
+**Note**
- Turn your logo into a favicon with the `Favicon
- Generator <http://antifavicon.com/>`__.
+Turn your logo into a favicon with the `Favicon
+Generator <http://antifavicon.com/>`__.
Description:
- The favicon is the little icon that appears next to the URL in the
- address bar in most browsers. The default value for this field (if
- left blank) is the small 'K' in the Koha logo.
+address bar in most browsers. The default value for this field (if
+left blank) is the small 'K' in the Koha logo.
- Default Koha Favicon
- |image72|
+Default Koha Favicon
+|image72|
+
+.. _opacheader-label:
-`opacheader <#opacheader>`__
+opacheader
''''''''''''''''''''''''''''
Asks: Include the following HTML in the header of all pages in the OPAC
Sample HTML to be displayed at the top of my OPAC
|image73|
- **Note**
+**Note**
- This value will appear above the main content of your page
+This value will appear above the main content of your page
OPAC display of the value from 'opacheader'
|image74|
- **Note**
+**Note**
- Edit '`LibraryName <#LibraryName>`__' if you'd like to edit the
- contents of the <title> tag
+Edit ':ref:`LibraryName`' if you'd like to edit the
+contents of the <title> tag
-Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
+Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
-`OpacHighlightedWords & NotHighlightedWords <#OpacHighlightedWords>`__
+.. _opachighlightedwords-&-nothighlightedwords-label:
+
+OpacHighlightedWords & NotHighlightedWords
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
OpacHighlightedWords Default: Don't highlight
- Highlight
-`OPACHoldingsDefaultSortField <#OPACHoldingsDefaultSortField>`__
+.. _opacholdingsdefaultsortfield-label:
+
+OPACHoldingsDefaultSortField
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: First column of the table
- Home library
-`OpacKohaUrl <#OpacKohaUrl>`__
+.. _opackohaurl-label:
+
+OpacKohaUrl
''''''''''''''''''''''''''''''
Default: Don't show
Description:
- When this preference is set to 'Show' text will appear in the bottom
- right of the OPAC footer stating 'Powered by Koha' and linking to the
- official Koha website.
+right of the OPAC footer stating 'Powered by Koha' and linking to the
+official Koha website.
+
+Powered by Koha
+|image75|
- Powered by Koha
- |image75|
+.. _opaclangselectormode-label:
-`OpacLangSelectorMode <#OpacLangSelectorMode>`__
+OpacLangSelectorMode
''''''''''''''''''''''''''''''''''''''''''''''''
Default: only footer
Description:
-- If you have the `opaclanguagesdisplay <#opaclanguagesdisplay>`__
- preference set to display language options in the public catlaog,
- then this preference will allow you to control where the language
- selector shows. You can choose to show it only on the top or bottom
- or in both places.
+- If you have the :ref:`opaclanguagesdisplay`
+preference set to display language options in the public catlaog,
+then this preference will allow you to control where the language
+selector shows. You can choose to show it only on the top or bottom
+or in both places.
+
+.. _opaclayoutstylesheet-label:
-`opaclayoutstylesheet <#opaclayoutstylesheet>`__
+opaclayoutstylesheet
''''''''''''''''''''''''''''''''''''''''''''''''
Default: opac.css
Description:
- This setting's function is to point to the \*.css file used to define
- the OPAC layout. A \*.css file is a cascading stylesheet which is
- used in conjunction with HTML to set how the HTML page is formatted
- and will look on the OPAC. There are two stylesheets that come with
- the system; opac.css and opac2.css. A custom stylesheet may also be
- used. The stylesheets listed in the opaclayoutstylesheet preference
- are held on the Koha server.
+the OPAC layout. A \*.css file is a cascading stylesheet which is
+used in conjunction with HTML to set how the HTML page is formatted
+and will look on the OPAC. There are two stylesheets that come with
+the system; opac.css and opac2.css. A custom stylesheet may also be
+used. The stylesheets listed in the opaclayoutstylesheet preference
+are held on the Koha server.
- **Note**
+**Note**
- Leave this field blank to disable it and let Koha use the default
- file instead
+Leave this field blank to disable it and let Koha use the default
+file instead
- **Important**
+**Important**
+
+Using a custom value in this preference causes Koha to completely
+ignore the default layout stylesheet.
- Using a custom value in this preference causes Koha to completely
- ignore the default layout stylesheet.
+.. _opaclocationbranchtodisplay-label:
-`OpacLocationBranchToDisplay <#OpacLocationBranchToDisplay>`__
+OpacLocationBranchToDisplay
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: holding library
Description:
- Defines whether to display the holding library, the home library, or
- both for the opac details page.
+both for the opac details page.
-`OpacLocationBranchToDisplayShelving <#OpacLocationBranchToDisplayShelving>`__
+.. _opaclocationbranchtodisplayshelving-label:
+
+OpacLocationBranchToDisplayShelving
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: holding library
Description:
- Defines where the shelving location should be displayed, under the
- home library, the holding library, or both.
+home library, the holding library, or both.
+
+.. _opacmaintenance-label:
-`OpacMaintenance <#OpacMaintenance>`__
+OpacMaintenance
''''''''''''''''''''''''''''''''''''''
Default: Don't show
Asks: \_\_\_ a warning that the OPAC is under maintenance, instead of
the OPAC itself.
- **Note**
+**Note**
- this shows the same warning as when the database needs to be
- upgraded, but unconditionally.
+this shows the same warning as when the database needs to be
+upgraded, but unconditionally.
Description:
- This preference allows the system administrator to turn off the OPAC
- during maintenance and display a message to users. When this
- preference is switched to "Show" the OPAC is not usable. The text of
- this message is not editable at this time.
+during maintenance and display a message to users. When this
+preference is switched to "Show" the OPAC is not usable. The text of
+this message is not editable at this time.
Values:
- Show
- - When this preference is set to show the maintenance message the
- ability to search the OPAC is disabled and a message appears. The
- default message can be altered by using the
- `OpacMaintenanceNotice <#OpacMaintenanceNotice>`__ preference.
+- When this preference is set to show the maintenance message the
+ ability to search the OPAC is disabled and a message appears. The
+ default message can be altered by using the
+ :ref:`OpacMaintenanceNotice` preference.
- OPAC Maintenance Message
- |image76|
+ OPAC Maintenance Message
+ |image76|
-`OpacMaintenanceNotice <#OpacMaintenanceNotice>`__
+.. _opacmaintenancenotice-label:
+
+OpacMaintenanceNotice
''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Show the following HTML when OpacMaintenance is enabled
Descritpion:
- This preference will allow you to set the text the OPAC displays when
- the `OpacMaintenance <#OpacMaintenance>`__ preference is set to
- 'Show.'
+the :ref:`OpacMaintenance` preference is set to
+'Show.'
+
+.. _opacmainuserblock-label:
-`OpacMainUserBlock <#OpacMainUserBlock>`__
+OpacMainUserBlock
''''''''''''''''''''''''''''''''''''''''''
Default: Welcome to Koha... <hr>
Description:
- HTML entered in this field will appear in the center of the main page
- of your OPAC
+of your OPAC
Sample OpacMainUserBlock appears below the search bar
|image77|
-Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
+Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
-`OpacMaxItemsToDisplay <#OpacMaxItemsToDisplay>`__
+.. _opacmaxitemstodisplay-label:
+
+OpacMaxItemsToDisplay
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 50
Description:
- This preference will help with slow load times on the bibliographic
- detail pages by limiting the number of items to display by default.
- If the biblio has more items than this, a link is displayed instead
- that allows the user to choose to display all items.
+detail pages by limiting the number of items to display by default.
+If the biblio has more items than this, a link is displayed instead
+that allows the user to choose to display all items.
+
+.. _opacmysummaryhtml-label:
-`OPACMySummaryHTML <#OPACMySummaryHTML>`__
+OPACMySummaryHTML
''''''''''''''''''''''''''''''''''''''''''
Asks: Include a "Links" column on the "my summary" tab when a user is
Description:
- In this preference you can enter HTML that will appear on the
- 'Checked Out' tab on the 'My Summary' section when logged in to the
- OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR}
- will be replaced with information from the displayed record. This can
- be used to enter in 'share' links for social networks or generate
- searches against other library catalogs.
+'Checked Out' tab on the 'My Summary' section when logged in to the
+OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR}
+will be replaced with information from the displayed record. This can
+be used to enter in 'share' links for social networks or generate
+searches against other library catalogs.
- Example of 'Links' column with a value in the OPACMySummaryHTML
- preference
- |image78|
+Example of 'Links' column with a value in the OPACMySummaryHTML
+preference
+|image78|
Sample Data:
::
- <p><a href="http://www.facebook.com/sharer.php?u=http://YOUROPAC.ORG/cgi-bin/koha/opac-detail.pl?biblionumber={BIBLIONUMBER}">Share on Facebook</a>
- <br />TITLE: {TITLE}
- <br />AUTHOR: {AUTHOR}
- <br />ISBN: {ISBN}
- <br />BIBLIONUMBER: {BIBLIONUMBER}</p>
+<p><a href="http://www.facebook.com/sharer.php?u=http://YOUROPAC.ORG/cgi-bin/koha/opac-detail.pl?biblionumber={BIBLIONUMBER}">Share on Facebook</a>
+<br />TITLE: {TITLE}
+<br />AUTHOR: {AUTHOR}
+<br />ISBN: {ISBN}
+<br />BIBLIONUMBER: {BIBLIONUMBER}</p>
-`OPACMySummaryNote <#OPACMySummaryNote>`__
+.. _opacmysummarynote-label:
+
+OPACMySummaryNote
''''''''''''''''''''''''''''''''''''''''''
Asks: Note to display on the patron summary page.
Description:
- This preference will display text above the patron's summary and
- below the welcome message when the patron logs in to the OPAC and
- view their 'my summary' tab.OPACMySummaryNote in the OPAC
+below the welcome message when the patron logs in to the OPAC and
+view their 'my summary' tab.OPACMySummaryNote in the OPAC
+
+.. _opacnav-label:
-`OpacNav <#OpacNav>`__
+OpacNav
''''''''''''''''''''''
Default: Important links here.
Sample navigation links
|image79|
-Learn more in the `OPAC Editable Regions <#editableopac>`__ section.
+Learn more in the :ref:`OPAC Editable Regions <editable-opac-regions-label>` section.
+
+.. _opacnavbottom-label:
-`OpacNavBottom <#OpacNavBottom>`__
+OpacNavBottom
''''''''''''''''''''''''''''''''''
Asks: Show the following HTML on the left hand column of the main page
-and patron account on the OPAC, after `OpacNav <#OpacNav>`__, and before
+and patron account on the OPAC, after :ref:`OpacNav`, and before
patron account links if available:
Description: When a patron is logged in to their account they see a
series of tabs to access their account information.
-`OpacNav <#OpacNav>`__ appears above this list of tabs and OpacNavBottom
+:ref:`OpacNav` appears above this list of tabs and OpacNavBottom
will appear below them. When not on the patron account pages the HTML in
-OpacNavBottom will just appear right below `OpacNav <#OpacNav>`__.
+OpacNavBottom will just appear right below :ref:`OpacNav`.
OpacNav and OpacNavBottom on Patron Account
|image80|
-`OpacNavRight <#OpacNavRight>`__
+.. _opacnavright-label:
+
+OpacNavRight
''''''''''''''''''''''''''''''''
Asks: Show the following HTML in the right hand column of the main page
OpacNavRight
|image81|
-`OPACNoResultsFound <#OPACNoResultsFound>`__
+.. _opacnoresultsfound-label:
+
+OPACNoResultsFound
''''''''''''''''''''''''''''''''''''''''''''
No Default
HTML in OPACNoResultsFound will appear below lines that look like this
|image82|
- **Note**
+**Note**
+
+You can insert placeholders {QUERY\_KW} that will be replaced with
+the keywords of the query.
- You can insert placeholders {QUERY\_KW} that will be replaced with
- the keywords of the query.
+.. _opacpublic-label:
-`OpacPublic <#OpacPublic>`__
+OpacPublic
''''''''''''''''''''''''''''
Default: Enable
Description:
- This preference determines if your OPAC is accessible and searchable
- by anyone or only by members of the library. If set to 'Don't enable'
- only members who are logged into the OPAC can search. Most libraries
- will leave this setting at its default of 'Enable' to allow their
- OPAC to be searched by anyone and only require login for access to
- personalized content.
+by anyone or only by members of the library. If set to 'Don't enable'
+only members who are logged into the OPAC can search. Most libraries
+will leave this setting at its default of 'Enable' to allow their
+OPAC to be searched by anyone and only require login for access to
+personalized content.
+
+.. _opacresultslibrary-label:
-`OPACResultsLibrary <#OPACResultsLibrary>`__
+OPACResultsLibrary
''''''''''''''''''''''''''''''''''''''''''''
Default: home library
- home library
-`OPACResultsSidebar <#OPACResultsSidebar>`__
+.. _opacresultssidebar-label:
+
+OPACResultsSidebar
''''''''''''''''''''''''''''''''''''''''''''
Asks: Include the following HTML under the facets in OPAC search results
Description:
- The HTML entered in this preference will appear on the search results
- pages below the list of facets on the left side of the screen.
+pages below the list of facets on the left side of the screen.
+
+.. _opacsearchfortitlein-label:
-`OPACSearchForTitleIn <#OPACSearchForTitleIn>`__
+OPACSearchForTitleIn
''''''''''''''''''''''''''''''''''''''''''''''''
Default: <li><a href="http://worldcat.org/search?q={TITLE}"
Asks: Include a "More Searches" box on the detail pages of items on the
OPAC, with the following HTML (leave blank to disable)
- **Note**
+**Note**
- The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN},
- {ISSN} and {AUTHOR} will be replaced with information from the
- displayed record.
+The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN},
+{ISSN} and {AUTHOR} will be replaced with information from the
+displayed record.
-`OpacSeparateHoldings & OpacSeparateHoldingsBranch <#OpacSeparateHoldings>`__
+.. _opacseparateholdings-&-opacseparateholdingsbranch-label:
+
+OpacSeparateHoldings & OpacSeparateHoldingsBranch
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
OpacSeparateHoldings default: Don't separate
Description:
- This preference lets you decide if you would like to have the holding
- information on the bibliographic detail page in the OPAC split in to
- multiple tabs. The default is to show all holdings on one tab.
+information on the bibliographic detail page in the OPAC split in to
+multiple tabs. The default is to show all holdings on one tab.
- Separate holdings tabs
- |image83|
+Separate holdings tabs
+|image83|
+
+.. _opacshowbarcode-label:
-`OPACShowBarcode <#OPACShowBarcode>`__
+OPACShowBarcode
''''''''''''''''''''''''''''''''''''''
Default: Don't show
- Don't show
- Barcode not shown in the OPAC
- |image84|
+Barcode not shown in the OPAC
+|image84|
- Show
- Barcode shown in the OPAC
- |image85|
+Barcode shown in the OPAC
+|image85|
Description:
- This preference allows you to control whether patrons can see items'
- barcodes in the OPAC.
+barcodes in the OPAC.
-`OPACShowCheckoutName <#OPACShowCheckoutName>`__
+.. _opacshowcheckoutname-label:
+
+OPACShowCheckoutName
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
Description:
- This preference allows all patrons to see who has the item checked
- out if it is checked out. In small corporate libraries (where the
- OPAC is behind a firewall and not publicly available) this can be
- helpful so coworkers can just contact the patron with the book
- themselves. In larger public and academic libraries setting this to
- 'Show' would pose serious privacy issues.
+out if it is checked out. In small corporate libraries (where the
+OPAC is behind a firewall and not publicly available) this can be
+helpful so coworkers can just contact the patron with the book
+themselves. In larger public and academic libraries setting this to
+'Show' would pose serious privacy issues.
+
+.. _opacshowholdqueuedetails-label:
-`OPACShowHoldQueueDetails <#OPACShowHoldQueueDetails>`__
+OPACShowHoldQueueDetails
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show any hold details
- Show holds
- The holdings table on the bibliographic record will show the number
- of holds
- |image86|
+The holdings table on the bibliographic record will show the number
+of holds
+|image86|
- Show holds and priority level
- Show priority level
- Patron record in the OPAC shows where in line the patron waits for
- their hold.
- |image87|
+Patron record in the OPAC shows where in line the patron waits for
+their hold.
+|image87|
+
+- :ref:`opacuserlogin` needs to be set to 'allow'
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
+.. _opacshowrecentcomments-label:
-`OpacShowRecentComments <#OpacShowRecentComments>`__
+OpacShowRecentComments
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
Description:
- If you have chosen to allow comments in your OPAC by setting
- `reviewson <#reviewson>`__ to 'Allow' you can include a link to the
- recent comments under the search box at the top of your OPAC with
- this preference.
+:ref:`reviewson` to 'Allow' you can include a link to the
+recent comments under the search box at the top of your OPAC with
+this preference.
- Recent Comments link on OPAC
- |image88|
+Recent Comments link on OPAC
+|image88|
-`OPACShowUnusedAuthorities <#OPACShowUnusedAuthorities>`__
+.. _opacshowunusedauthorities-label:
+
+OPACShowUnusedAuthorities
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Show
- Show
- - **Important**
+- **Important**
- Requires that the `OpacAuthorities <#OpacAuthorities>`__
- preference is set to 'Allow'
+ Requires that the :ref:`OpacAuthorities`
+ preference is set to 'Allow'
Description:
- When patrons search your authority file via the OPAC they will see
- all authorities in your system even if you don't have them linked to
- any bibliographic records. This preference lets you determine what
- the default behavior is when searching authorities via the OPAC. If
- you choose 'Do not show' it will only show patrons authority records
- that are linked to bib records in the search results. Otherwise the
- system will show all authority records even if they aren't linked to
- records.
-
-`OpacStarRatings <#OpacStarRatings>`__
+all authorities in your system even if you don't have them linked to
+any bibliographic records. This preference lets you determine what
+the default behavior is when searching authorities via the OPAC. If
+you choose 'Do not show' it will only show patrons authority records
+that are linked to bib records in the search results. Otherwise the
+system will show all authority records even if they aren't linked to
+records.
+
+.. _opacstarratings-label:
+
+OpacStarRatings
''''''''''''''''''''''''''''''''''''''
Default: no
- only details
- Star Ratings on the Details Page
- |image89|
+Star Ratings on the Details Page
+|image89|
- results and details
- OPAC Star Ratings on the Search Results
- |image90|
+OPAC Star Ratings on the Search Results
+|image90|
Description:
- Star ratings are a way for your patrons to leave ratings without
- having to leave a full review. Patrons who are not logged in will
- only be able to see the stars, once logged in patrons can click on
- the stars on the details page to leave their own rating. Clicking on
- the stars on the search results will not submit a rating.
+having to leave a full review. Patrons who are not logged in will
+only be able to see the stars, once logged in patrons can click on
+the stars on the details page to leave their own rating. Clicking on
+the stars on the search results will not submit a rating.
+
+.. _opacsuggestionmanagedby-label:
-`OpacSuggestionManagedBy <#OpacSuggestionManagedBy>`__
+OpacSuggestionManagedBy
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Show
Description:
-- If you're `allowing patrons to make purchase
- suggestions <#suggestionspref>`__ then they will see the 'my
- suggestions' tab when logged in. This tab shows the patron the
- librarian who approved or rejected the purchase suggestion. This
- preference controls if the patron sees the librarian's name or not.
+- If you're :ref:`allowing patrons to make purchase
+suggestions <suggestion-label>` then they will see the 'my
+suggestions' tab when logged in. This tab shows the patron the
+librarian who approved or rejected the purchase suggestion. This
+preference controls if the patron sees the librarian's name or not.
-`opacthemes <#opacthemes>`__
+.. _opacthemes-label:
+
+opacthemes
''''''''''''''''''''''''''''
Default: bootstrap
- bootstrap
- Bootstrap Theme
+Bootstrap Theme
+
+This theme is completely responsive
- This theme is completely responsive
+.. _opacurlopeninnewwindow-label:
-`OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__
+OPACURLOpenInNewWindow
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: don't
Description:
- This preference determines if URLs in the OPAC will open in a new
- window or not. When clicking on a link in the OPAC, a patron does not
- need to worry about navigating away from their search results.
+window or not. When clicking on a link in the OPAC, a patron does not
+need to worry about navigating away from their search results.
+
+.. _opacusercss-label:
-`OPACUserCSS <#OPACUserCSS>`__
+OPACUserCSS
''''''''''''''''''''''''''''''
Asks: Include the following CSS on all pages in the OPAC
Description:
- OPACUserCSS allows the administrator to enter styles that will
- overwrite the OPAC's default CSS as defined in 'opaclayoutstylesheet'
- or 'opacstylesheet'. Styles may be entered for any of the selectors
- found in the default style sheet. The default stylesheet will likely
- be found at
- http://your\_koha\_address/opac-tmpl/bootstrap/css/opac.css. Unlike
- `OpacAdditionalStylesheet <#OpacAdditionalStylesheet>`__ and
- `opaclayoutstylesheet <#opaclayoutstylesheet>`__ this preference will
- embed the CSS directly on your OPAC pages.
-
-`OPACUserJS <#opacuserjs>`__
+overwrite the OPAC's default CSS as defined in 'opaclayoutstylesheet'
+or 'opacstylesheet'. Styles may be entered for any of the selectors
+found in the default style sheet. The default stylesheet will likely
+be found at
+http://your\_koha\_address/opac-tmpl/bootstrap/css/opac.css. Unlike
+:ref:`OpacAdditionalStylesheet` and
+:ref:`opaclayoutstylesheet` this preference will
+embed the CSS directly on your OPAC pages.
+
+.. _opacuserjs-label:
+
+OPACUserJS
''''''''''''''''''''''''''''
Asks: Include the following JavaScript on all pages in the OPAC
Description:
- This preference allows the administrator to enter JavaScript or
- JQuery that will be embedded across all pages of the OPAC.
- Administrators may use this preference to customize some of the
- interactive sections of Koha, customizing the text for the login
- prompts, for example. Sample JQuery scripts used by Koha libraries
- can be found on the wiki:
- http://wiki.koha-community.org/wiki/JQuery_Library.
+JQuery that will be embedded across all pages of the OPAC.
+Administrators may use this preference to customize some of the
+interactive sections of Koha, customizing the text for the login
+prompts, for example. Sample JQuery scripts used by Koha libraries
+can be found on the wiki:
+http://wiki.koha-community.org/wiki/JQuery_Library.
+
+.. _opacxsltdetailsdisplay-label:
-`OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__
+OPACXSLTDetailsDisplay
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: default
- leave empty to not use the XSLT stylesheet
- - In previous versions of Koha this was the setting that read
- 'normally'
+- In previous versions of Koha this was the setting that read
+ 'normally'
- enter "default" for the default one
- put a path to define a XSLT file
- - ex: /path/to/koha/and/your/stylesheet.xsl
+- ex: /path/to/koha/and/your/stylesheet.xsl
- - If in a multi-language system you can enter {langcode} in the path
- to tell Koha to look in the right language folder
+- If in a multi-language system you can enter {langcode} in the path
+ to tell Koha to look in the right language folder
- - ex:
- /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.xsl
+ - ex:
+ /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACDetail.xsl
- - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
+ - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
- put an URL for an external specific stylesheet
- - ex: http://mykohaopac.org/stylesheet.xsl
+- ex: http://mykohaopac.org/stylesheet.xsl
Description:
- XSLT stylesheets allow for the customization of the details shows on
- the screen when viewing a bib record. This preference will allow you
- either use the default look that comes with Koha or design your own
- stylesheet.
-
-`OPACXSLTListsDisplay <#OPACXSLTListsDisplay>`__
+the screen when viewing a bib record. This preference will allow you
+either use the default look that comes with Koha or design your own
+stylesheet.
+
+.. _opacxsltlistsdisplay-label:
+
+OPACXSLTListsDisplay
''''''''''''''''''''''''''''''''''''''''''''''''
Default: default
- leave empty to not use the XSLT stylesheet
- - In previous versions of Koha this was the setting that read
- 'normally'
+- In previous versions of Koha this was the setting that read
+ 'normally'
- enter "default" for the default one
- put a path to define a XSLT file
- - ex: /path/to/koha/and/your/stylesheet.xsl
+- ex: /path/to/koha/and/your/stylesheet.xsl
- - If in a multi-language system you can enter {langcode} in the path
- to tell Koha to look in the right language folder
+- If in a multi-language system you can enter {langcode} in the path
+ to tell Koha to look in the right language folder
- - ex:
- /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
+ - ex:
+ /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
- - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
+ - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
- put an URL for an external specific stylesheet
- - ex: http://mykohaopac.org/stylesheet.xsl
+- ex: http://mykohaopac.org/stylesheet.xsl
Description:
- XSLT stylesheets allow for the customization of the details shows on
- the screen when viewing lists. This preference will
- allow you either use the default look that comes with Koha or design
- your own stylesheet.
+the screen when viewing lists. This preference will
+allow you either use the default look that comes with Koha or design
+your own stylesheet.
-`OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__
+.. _opacxsltresultsdisplay-label:
+
+OPACXSLTResultsDisplay
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: default
- leave empty to not use the XSLT stylesheet
- - In previous versions of Koha this was the setting that read
- 'normally'
+- In previous versions of Koha this was the setting that read
+ 'normally'
- enter "default" for the default one
- put a path to define a XSLT file
- - ex: /path/to/koha/and/your/stylesheet.xsl
+- ex: /path/to/koha/and/your/stylesheet.xsl
- - If in a multi-language system you can enter {langcode} in the path
- to tell Koha to look in the right language folder
+- If in a multi-language system you can enter {langcode} in the path
+ to tell Koha to look in the right language folder
- - ex:
- /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
+ - ex:
+ /home/koha/src/koha-tmpl/opac-tmpl/bootstrap/{langcode}/xslt/MARC21slim2OPACResults.xsl
- - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
+ - ex. http://mykohaopac.org/{langcode}/stylesheet.xsl
- put an URL for an external specific stylesheet
- - ex: http://mykohaopac.org/stylesheet.xsl
+- ex: http://mykohaopac.org/stylesheet.xsl
Description:
- XSLT stylesheets allow for the customization of the details shows on
- the screen when viewing the search results. This preference will
- allow you either use the default look that comes with Koha or design
- your own stylesheet.
+the screen when viewing the search results. This preference will
+allow you either use the default look that comes with Koha or design
+your own stylesheet.
+
+.. _features-label:
-`Features <#opacfeaturesprefs>`__
+Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`numSearchRSSResults <#numSearchRSSResults>`__
+.. _numsearchrssresults-label:
+
+numSearchRSSResults
''''''''''''''''''''''''''''''''''''''''''''''
Default: 50
Description:
- By default the RSS feed that is automatically generated for every
- search results page will list 50 items. This can sometimes be too
- much for some RSS feed readers and for some people this isn't enough.
- This preference allows you to adjust this number to show the best
- number of results for your patrons.
+search results page will list 50 items. This can sometimes be too
+much for some RSS feed readers and for some people this isn't enough.
+This preference allows you to adjust this number to show the best
+number of results for your patrons.
-`OPACAcquisitionDetails <#OPACAcquisitionDetails>`__
+.. _opacacquisitiondetails-label:
+
+OPACAcquisitionDetails
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't display
Description:
- This preference shows the patrons how many items are on order in the
- Holdings tab if you have the `AcqCreateItem <#AcqCreateItem>`__ set
- to 'cataloging the record'
+Holdings tab if you have the :ref:`AcqCreateItem` set
+to 'cataloging the record'
+
+.. _opacauthorities-label:
-`OpacAuthorities <#OpacAuthorities>`__
+OpacAuthorities
''''''''''''''''''''''''''''''''''''''
Default: Allow
Description:
- This preference displays the link on the OPAC for the authority
- search. By setting the preference to "Allow" patrons can use this
- search link of the OPAC.
+search. By setting the preference to "Allow" patrons can use this
+search link of the OPAC.
Values:
- Allow
- - A link labeled 'Authority search' will appear at the top of your
- OPAC under the search box
+- A link labeled 'Authority search' will appear at the top of your
+ OPAC under the search box
- 'Browse by Subject' link under search box on OPAC
- |image94|
+ 'Browse by Subject' link under search box on OPAC
+ |image94|
- Don't allow
-`opacbookbag <#opacbookbag>`__
+.. _opacbookbag-label:
+
+opacbookbag
''''''''''''''''''''''''''''''
Default: Allow
Description:
- This preference allows the user to temporarily save a list of items
- found on the catalog. By using the Book Bag, or Cart, the user can
- print out or email a list of items found. The user does not need to
- be logged in. This list is temporary and will be emptied, or cleared,
- at the end of the session.
+found on the catalog. By using the Book Bag, or Cart, the user can
+print out or email a list of items found. The user does not need to
+be logged in. This list is temporary and will be emptied, or cleared,
+at the end of the session.
-`OpacBrowser <#OpacBrowser>`__
+.. _opacbrowser-label:
+
+OpacBrowser
''''''''''''''''''''''''''''''
- **Important**
+**Important**
- This preference only applies to installations using UNIMARC at this time.
+This preference only applies to installations using UNIMARC at this time.
Default: Don't allow
- Don't allow
- **Important**
+**Important**
- run the `Authorities Browser Cron Job <#authbrowsercron>`__ to
- create the browser list
+run the :ref:`Authorities Browser Cron Job <authorities-browser-label>` to
+create the browser list
-`OpacBrowseResults <#OpacBrowseResults>`__
+.. _opacbrowseresults-label:
+
+OpacBrowseResults
''''''''''''''''''''''''''''''''''''''''''
Default: enable
- enable
- Browsing and Paging Search Results
- |image95|
+Browsing and Paging Search Results
+|image95|
Description:
- This preference will control the option to return to your results
- and/or browse them from the detail page in the OPAC.
+and/or browse them from the detail page in the OPAC.
+
+.. _opaccloud-label:
-`OpacCloud <#OpacCloud>`__
+OpacCloud
''''''''''''''''''''''''''
- **Important**
+**Important**
- This preference only applies to French systems at this time.
+This preference only applies to French systems at this time.
Default: Don't show
- Show
- **Important**
+**Important**
- run the `Authorities Browser Cron Job <#authbrowsercron>`__ to
- create the browser list
+run the :ref:`Authorities Browser Cron Job <authorities-browser-label>` to
+create the browser list
-`OPACFinesTab <#OPACFinesTab>`__
+.. _opacfinestab-label:
+
+OPACFinesTab
''''''''''''''''''''''''''''''''
Default: Allow
- Allow
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
+- :ref:`opacuserlogin` needs to be set to 'allow'
- Don't allow
-`OpacHoldNotes <#OpacHoldNotes>`__
+.. _opacholdnotes-label:
+
+OpacHoldNotes
''''''''''''''''''''''''''''''''''
Default: Do not allow
- Allow
- Holds notes in the OPAC
- |image96|
+Holds notes in the OPAC
+|image96|
- Do not allow
-`OPACISBD <#OPACISBD>`__
+.. _opacisbd-label:
+
+OPACISBD
''''''''''''''''''''''''
-Default: `MARC21 Default Appendix <#opacisbdmarcdefault>`__
+Default: :ref:`MARC21 Default Appendix <marc-label>`
Asks: Use the following as the OPAC ISBD template:
Description:
- This determines how the ISBD information will display in the OPAC.
- Elements in the list can be reordered to produce a different ISBD
- view. ISBD, the International Standard Bibliographic Description, was
- first introduced by IFLA (International Federation of Library
- Associations) in 1969 in order to provide guidelines for descriptive
- cataloging. The purpose of ISBD is to aid the international exchange
- of bibliographic records for a variety of materials.
-
-`OpacItemLocation <#OpacItemLocation>`__
+Elements in the list can be reordered to produce a different ISBD
+view. ISBD, the International Standard Bibliographic Description, was
+first introduced by IFLA (International Federation of Library
+Associations) in 1969 in order to provide guidelines for descriptive
+cataloging. The purpose of ISBD is to aid the international exchange
+of bibliographic records for a variety of materials.
+
+.. _opacitemlocation-label:
+
+OpacItemLocation
''''''''''''''''''''''''''''''''''''''''
Default: call number only
Description:
- This setting allows users of the OPAC results XSLT stylesheet to
- choose to display collection code or location in addition to call
- number.
+choose to display collection code or location in addition to call
+number.
+
+.. _opacnewslibraryselect-label:
-`OpacNewsLibrarySelect <#OpacNewsLibrarySelect>`__
+OpacNewsLibrarySelect
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't display
- Display
-`OpacPasswordChange <#OpacPasswordChange>`__
+.. _opacpasswordchange-label:
+
+OpacPasswordChange
''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Allow
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
+- :ref:`opacuserlogin` needs to be set to 'allow'
- Don't allow
- **Important**
+**Important**
+
+Enabling this will break LDAP authentication.
- Enabling this will break LDAP authentication.
+.. _opacpatrondetails-label:
-`OPACPatronDetails <#OPACPatronDetails>`__
+OPACPatronDetails
''''''''''''''''''''''''''''''''''''''''''
Default: Allow
- Allow
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
+- :ref:`opacuserlogin` needs to be set to 'allow'
- Don't allow
Description:
- If patrons are allowed to notify the library of changes to their
- account then staff will need to approve the changes via the staff
- client. Notification of patron account requests will appear on the
- dashaboard below the list of modules with other pending actions.
+account then staff will need to approve the changes via the staff
+client. Notification of patron account requests will appear on the
+dashaboard below the list of modules with other pending actions.
- Patrons requesting modifications
- |image97|
+Patrons requesting modifications
+|image97|
- Once you click the notification you will be presented with the
- changes the patron would like to make to their account and from there
- you can choose how to proceed.
+Once you click the notification you will be presented with the
+changes the patron would like to make to their account and from there
+you can choose how to proceed.
- Patrons modifications
- |image98|
+Patrons modifications
+|image98|
- **Note**
+ **Note**
+
+ You can control what fields patrons see and can modify via the
+ OPAC by setting the
+ :ref:`PatronSelfRegistrationBorrowerMandatoryField`
+ :ref:`PatronSelfRegistrationBorrowerUnwantedField`
+ preferences.
- You can control what fields patrons see and can modify via the
- OPAC by setting the
- `PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
- `PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
- preferences.
+.. _opacpatronimages-label:
-`OPACpatronimages <#OPACpatronimages>`__
+OPACpatronimages
''''''''''''''''''''''''''''''''''''''
Default: Don't show
Description:
-- If `patronimages <#patronimages>`__ is set to allow the upload of
- patron images via the staff client, then setting this preference to
- 'show' will show the patron what image you have on file for them when
- they view their personal information on their account in the OPAC.
+- If :ref:`patronimages` is set to allow the upload of
+patron images via the staff client, then setting this preference to
+'show' will show the patron what image you have on file for them when
+they view their personal information on their account in the OPAC.
-`OPACPopupAuthorsSearch <#OPACPopupAuthorsSearch>`__
+.. _opacpopupauthorssearch-label:
+
+OPACPopupAuthorsSearch
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't display
- Display
- Subject search pop up
+Subject search pop up
- - **Important**
+- **Important**
- This will only display the pop up if you are not using an XSLT
- stylesheet. Review your
- `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ to find
- out what stylesheet you're using.
+ This will only display the pop up if you are not using an XSLT
+ stylesheet. Review your
+ :ref:`OPACXSLTDetailsDisplay` to find
+ out what stylesheet you're using.
- Don't display
- - Authors and subjects will display as search links instead of pop
- up menus.
+- Authors and subjects will display as search links instead of pop
+ up menus.
Description:
- If this preference is set to 'Display' then clicking a subject or
- author from the details page in the OPAC will present the searcher
- with a pop up box. From this box you can check off any of the
- subjects or authors listed and search them all at once by clicking
- 'Search' at the bottom of the pop up. The default behavior is for
- Koha to search just the clicked author or subject.
+author from the details page in the OPAC will present the searcher
+with a pop up box. From this box you can check off any of the
+subjects or authors listed and search them all at once by clicking
+'Search' at the bottom of the pop up. The default behavior is for
+Koha to search just the clicked author or subject.
+
+.. _opacresetpassword-label:
-`OpacResetPassword <#OpacResetPassword>`__
+OpacResetPassword
''''''''''''''''''''''''''''''''''''''''''
Default: not allowed
Description:
- This preference controls whether you present users of the public
- catalog with a 'Forgot your password' link or not. Learn more in the
- `OPAC section <#resetpwopac>`__ of this manual.
+catalog with a 'Forgot your password' link or not. Learn more in the
+:ref:`OPAC section <resetting-your-password-label>` of this manual.
+
+.. _opactopissue-label:
-`OpacTopissue <#OpacTopissue>`__
+OpacTopissue
''''''''''''''''''''''''''''''''
Default: Don't allow
- Allow
- - A link to 'Most Popular' will appear at the top of your OPAC
+- A link to 'Most Popular' will appear at the top of your OPAC
- 'Most Popular' link under the search box
- |image99|
+ 'Most Popular' link under the search box
+ |image99|
- Don't allow
Description:
- This preference allows the administrator to choose to show the "Most
- Popular" link at the top of the OPAC under the search box. The "Most
- Popular" page shows the top circulated items in the library, as
- determined by the number of times a title has been circulated. This
- allows users to see what titles are popular in their community. It is
- recommended that you leave this preference set to 'Don't allow' until
- you have been live on Koha for a couple of months, otherwise the data
- that it shows will not be an accurate portrayal of what's popular in
- your library.
-
- Sample top issues page
- |image100|
-
-`opacuserlogin <#opacuserlogin>`__
+Popular" link at the top of the OPAC under the search box. The "Most
+Popular" page shows the top circulated items in the library, as
+determined by the number of times a title has been circulated. This
+allows users to see what titles are popular in their community. It is
+recommended that you leave this preference set to 'Don't allow' until
+you have been live on Koha for a couple of months, otherwise the data
+that it shows will not be an accurate portrayal of what's popular in
+your library.
+
+Sample top issues page
+|image100|
+
+.. _opacuserlogin-label:
+
+opacuserlogin
''''''''''''''''''''''''''''''''''
Default: Allow
- Don't allow
- - The OPAC will still be searchable if patrons can't log in, this
- just disables the patron account access via the OPAC
+- The OPAC will still be searchable if patrons can't log in, this
+ just disables the patron account access via the OPAC
-`QuoteOfTheDay <#QuoteOfTheDay>`__
+.. _quoteoftheday-label:
+
+QuoteOfTheDay
''''''''''''''''''''''''''''''''''
Default: Disable
Description:
- This feature will allow you to enter a series of quotes that will
- then show on the OPAC homepage in random order. To add/edit quotes,
- visit the `Quote of the Day Editor <#QOTDEditor>`__ under Tools.
+then show on the OPAC homepage in random order. To add/edit quotes,
+visit the :ref:`Quote of the Day Editor <quote-of-the-day-(qotd)-editor-label>` under Tools.
+
+.. _requestonopac-label:
-`RequestOnOpac <#RequestOnOpac>`__
+RequestOnOpac
''''''''''''''''''''''''''''''''''
Default: Allow
- Allow
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
+- :ref:`opacuserlogin` needs to be set to 'allow'
- Don't allow
-`reviewson <#reviewson>`__
+.. _reviewson-label:
+
+reviewson
''''''''''''''''''''''''''
Default: Allow
- Allow
- - Patrons comments/reviews all require moderation before they appear
- in the OPAC
+- Patrons comments/reviews all require moderation before they appear
+ in the OPAC
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'Allow'
+- :ref:`opacuserlogin` needs to be set to 'Allow'
- Don't allow
Description:
- This button allows the patrons to submit comments on books they have
- read via the OPAC. If this preference is set to "Allow" reviews are
- first sent to the staff client for staff approval before the review
- is displayed in the OPAC. The staff member who reviews and approves
- comments may find the pending comments on the
- `Comments <#comments>`__ tool. The staff member can then choose to
- approve or delete the comments.
-
-`ShowReviewer <#ShowReviewer>`__
+read via the OPAC. If this preference is set to "Allow" reviews are
+first sent to the staff client for staff approval before the review
+is displayed in the OPAC. The staff member who reviews and approves
+comments may find the pending comments on the
+:ref:`Comments` tool. The staff member can then choose to
+approve or delete the comments.
+
+.. _showreviewer-label:
+
+ShowReviewer
''''''''''''''''''''''''''''''''
Default: full name
Description:
- If you would like to protect your patron's privacy in the OPAC you
- can choose to hide their names or parts of their names from any of
- the comments they leave on bib records in your system.
- `reviewson <#reviewson>`__ needs to be set to 'Allow' for this to
- preference to come in to play
+can choose to hide their names or parts of their names from any of
+the comments they leave on bib records in your system.
+:ref:`reviewson` needs to be set to 'Allow' for this to
+preference to come in to play
-`ShowReviewerPhoto <#ShowReviewerPhoto>`__
+.. _showreviewerphoto-label:
+
+ShowReviewerPhoto
''''''''''''''''''''''''''''''''''''''''''
Default: Show
- Show
- - `reviewson <#reviewson>`__ needs to be set to 'Allow' and
- `ShowReviewer <#ShowReviewer>`__ needs to be set to 'Show' for
- this to preference to come in to play
+- :ref:`reviewson` needs to be set to 'Allow' and
+ :ref:`ShowReviewer` needs to be set to 'Show' for
+ this to preference to come in to play
- ShowReviewerPhoto set to 'Show'
- |image101|
+ ShowReviewerPhoto set to 'Show'
+ |image101|
Description:
- This system preference allows libraries to show avatars next to
- patron's comments in the OPAC. These avatars are pulled from the
- `Libravatar <https://www.libravatar.org>`__ library, an open source
- powered product that allows Internet users to choose a small icon to
- display next to their name on various different websites. The library
- has no control over the images the patron chooses to display.
+patron's comments in the OPAC. These avatars are pulled from the
+`Libravatar <https://www.libravatar.org>`__ library, an open source
+powered product that allows Internet users to choose a small icon to
+display next to their name on various different websites. The library
+has no control over the images the patron chooses to display.
+
+.. _socialnetworks-label:
-`SocialNetworks <#SocialNetworks>`__
+SocialNetworks
''''''''''''''''''''''''''''''''''''
Default: Disable
- Enable
- Social Networks
- |image102|
+Social Networks
+|image102|
Description:
- This preference will enable a line of social network share buttons
- below the right hand column on the detail pages of records in the
- OPAC.
+below the right hand column on the detail pages of records in the
+OPAC.
- **Important**
+**Important**
- In order for these share buttons to work when clicked you must have
- filled in your `OPACBaseURL <#OPACBaseURL>`__ preference.
+In order for these share buttons to work when clicked you must have
+filled in your :ref:`OPACBaseURL` preference.
-`suggestion <#suggestionspref>`__
+.. _suggestion-label:
+
+suggestion
'''''''''''''''''''''''''''''''''
Default: Allow
- Allow
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
- unless `AnonSuggestions <#AnonSuggestions>`__ is set to 'allow'
+- :ref:`opacuserlogin` needs to be set to 'allow'
+ unless :ref:`AnonSuggestions` is set to 'allow'
- Don't allow
-`Payments <#opacpayments>`__
+.. _payments-label:
+
+Payments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
These preferences will allow you control the tools you use to accept
online payments from your patrons via the OPAC.
-`EnablePayPalOpacPayments & PayPalSandboxMode <#EnablePayPalOpacPayments>`__
+.. _enablepaypalopacpayments-&-paypalsandboxmode-label:
+
+EnablePayPalOpacPayments & PayPalSandboxMode
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
EnablePayPalOpacPayments Default: Don't all
- Production
- - Visit https://developer.paypal.com/ to get information for
- accepting payments in production
+- Visit https://developer.paypal.com/ to get information for
+ accepting payments in production
- Sandbox
- - Visit https://developer.paypal.com/developer/accounts/ to get
- information for your sandbox account
+- Visit https://developer.paypal.com/developer/accounts/ to get
+ information for your sandbox account
Description:
- This preference will allow you to accept credit card payments via the
- OPAC for fines via PayPal. You will need to set up your PayPal
- account and it is recommended that you run tests before using this in
- production.
+OPAC for fines via PayPal. You will need to set up your PayPal
+account and it is recommended that you run tests before using this in
+production.
- **Important**
+**Important**
+
+PayPayl's terms of service state that you cannot charge your patrons
+for the processing fees and so this plugin will not add additional
+fees to the charges.
- PayPayl's terms of service state that you cannot charge your patrons
- for the processing fees and so this plugin will not add additional
- fees to the charges.
+.. _paypalchargedescription-label:
-`PayPalChargeDescription <#PayPalChargeDescription>`__
+PayPalChargeDescription
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Koha fee payment
Description
- This preference controls what the patron will see on their PayPal
- account/Bank account for this charge.
+account/Bank account for this charge.
+
+.. _paypalpwd-label:
-`PayPalPwd <#PayPalPwd>`__
+PayPalPwd
''''''''''''''''''''''''''
Asks: The password for the PayPal account to receive payments is \_\_\_
-`PayPalSignature <#PayPalSignature>`__
+.. _paypalsignature-label:
+
+PayPalSignature
''''''''''''''''''''''''''''''''''''''
Asks: The signature for the PayPal account to receive payments is \_\_\_
-`PayPalUser <#PayPalUser>`__
+.. _paypaluser-label:
+
+PayPalUser
''''''''''''''''''''''''''''
Asks: The email address to receive PayPal payments is \_\_\_
-`Policy <#opacpolicyprefs>`__
+.. _policy-label:
+
+Policy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AllowPurchaseSuggestionBranchChoice <#AllowPurchaseSuggestionBranchChoice>`__
+.. _allowpurchasesuggestionbranchchoice-label:
+
+AllowPurchaseSuggestionBranchChoice
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
Description:
- If your library system lets patrons make purchase suggestions for a
- specific branch you can set this preference to 'Allow' to add a
- branch selection option to the purchase suggestion form.
+specific branch you can set this preference to 'Allow' to add a
+branch selection option to the purchase suggestion form.
+
+.. _blockexpiredpatronopacactions-label:
-`BlockExpiredPatronOpacActions <#BlockExpiredPatronOpacActions>`__
+BlockExpiredPatronOpacActions
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't block
Description:
- This preference lets you set a default value for how Koha handles
- permissions for patrons who are expired. This preference can be
- overwritten by the setting on `individual patron
- categories <#patcats>`__.
+permissions for patrons who are expired. This preference can be
+overwritten by the setting on :ref:`individual patron
+categories <patron-categories-label>`.
+
+.. _maxopensuggestions-label:
-`MaxOpenSuggestions <#MaxOpenSuggestions>`__
+MaxOpenSuggestions
''''''''''''''''''''''''''''''''''''''''''''
Default: blank
Asks: Limit patrons to \_\_\_ open suggestions. Leave empty for no limit.
**Note: this setting does not affect anonymous suggestions.
-`OpacAllowPublicListCreation <#OpacAllowPublicListCreation>`__
+.. _opacallowpubliclistcreation-label:
+
+OpacAllowPublicListCreation
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
Description:
- Public lists are visible to anyone who visits your OPAC. With this
- preference you can control whether or now patrons are allowed to
- create these public lists. If this is set to "Don't allow" then only
- staff will be able to create public lists.
+preference you can control whether or now patrons are allowed to
+create these public lists. If this is set to "Don't allow" then only
+staff will be able to create public lists.
- **Important**
+**Important**
+
+This preference will only be taken in to account if you have
+:ref:`virtualshelves` set to 'Allow'
- This preference will only be taken in to account if you have
- `virtualshelves <#virtualshelves>`__ set to 'Allow'
+.. _opacallowsharingprivatelists-label:
-`OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
+OpacAllowSharingPrivateLists
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
Description:
- This feature will add the option for patrons to share their lists
- with other patrons. When this is set to 'Allow' patrons will see a
- share link at the top of their list. When they click that link it
- will ask for the email of the patron they would like to share with.
- Koha will then email the patron an invitation to see the list.
+with other patrons. When this is set to 'Allow' patrons will see a
+share link at the top of their list. When they click that link it
+will ask for the email of the patron they would like to share with.
+Koha will then email the patron an invitation to see the list.
-`OPACFineNoRenewals <#OPACFineNoRenewals>`__
+.. _opacfinenorenewals-label:
+
+OPACFineNoRenewals
''''''''''''''''''''''''''''''''''''''''''''
Default: 99999
Asks: Only allow patrons to renew their own books on the OPAC if they
have less than \_\_\_ USD in fines
- **Note**
+**Note**
- Leave this field blank to disable
+Leave this field blank to disable
- **Important**
+**Important**
- To allow renewals in the OPAC, `opacuserlogin <#opacuserlogin>`__
- needs to be set to 'allow'
+To allow renewals in the OPAC, :ref:`opacuserlogin`
+needs to be set to 'allow'
-`OpacHiddenItems <#OpacHiddenItems>`__
+.. _opachiddenitems-label:
+
+OpacHiddenItems
''''''''''''''''''''''''''''''''''''''
Asks: Allows to define custom rules for hiding specific items at opac.
- **Note**
+**Note**
- See docs/opac/OpacHiddenItems.txt in your Koha install directory for
- more information
+See docs/opac/OpacHiddenItems.txt in your Koha install directory for
+more information
Description:
- In this field you can enter criteria for items you would like to hide
- from display in the OPAC. This field takes any combination of item
- fields (from the items table in the Koha database) for blocking. For
- example a value of:
+from display in the OPAC. This field takes any combination of item
+fields (from the items table in the Koha database) for blocking. For
+example a value of:
- ::
+::
- itype: [07, 10]
- location: [STAFF, ISO]
+ itype: [07, 10]
+ location: [STAFF, ISO]
- Will block items with an itype code of 07 or 10 as well as items that
- have a shelving location of STAFF or ISO.
+Will block items with an itype code of 07 or 10 as well as items that
+have a shelving location of STAFF or ISO.
- In items my items.itype 07 is defined in Item Types Administration as
- Staff Assigned My items.itype 10 in Item Types is Archival Copy The
- locations STAFF and ISO are in Authorized Values for category=LOC
- STAFF means it's assigned to the staff reading room and ISO means it
- is in the isolation room.
+In items my items.itype 07 is defined in Item Types Administration as
+Staff Assigned My items.itype 10 in Item Types is Archival Copy The
+locations STAFF and ISO are in Authorized Values for category=LOC
+STAFF means it's assigned to the staff reading room and ISO means it
+is in the isolation room.
-`OpacRenewalAllowed <#OpacRenewalAllowed>`__
+.. _opacrenewalallowed-label:
+
+OpacRenewalAllowed
''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- Allow
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
+- :ref:`opacuserlogin` needs to be set to 'allow'
- Don't allow
- - Staff will still be able to renew items for patrons via the staff
- client
+- Staff will still be able to renew items for patrons via the staff
+ client
Description:
- This preference allows the administration to choose if patrons can
- renew their checked out materials via their checked out history in
- the OPAC. It allows patrons to renew their materials without having
- to contact the library or having to return to the library.
+renew their checked out materials via their checked out history in
+the OPAC. It allows patrons to renew their materials without having
+to contact the library or having to return to the library.
+
+.. _opacrenewalbranch-label:
-`OpacRenewalBranch <#OpacRenewalBranch>`__
+OpacRenewalBranch
''''''''''''''''''''''''''''''''''''''''''
Default: the branch the item was checked out from
Description:
- This value is used in the statistics table to help with reporting.
- The statistics table in Koha keeps track of all checkouts and
- renewals, this preference defines which branch is entered in to the
- table when a patron renews an item for themselves via the OPAC.
+The statistics table in Koha keeps track of all checkouts and
+renewals, this preference defines which branch is entered in to the
+table when a patron renews an item for themselves via the OPAC.
+
+.. _opacsuggestionmandatoryfields-label:
-`OPACSuggestionMandatoryFields <#OPACSuggestionMandatoryFields>`__
+OPACSuggestionMandatoryFields
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: blank
- Title
-`OPACViewOthersSuggestions <#OPACViewOthersSuggestions>`__
+.. _opacviewotherssuggestions-label:
+
+OPACViewOthersSuggestions
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- Show
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
+- :ref:`opacuserlogin` needs to be set to 'allow'
+
+.. _searchmylibraryfirst-label:
-`SearchMyLibraryFirst <#SearchMyLibraryFirst>`__
+SearchMyLibraryFirst
''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't limit
- Don't limit
- - Searching the OPAC will show results from all libraries
+- Searching the OPAC will show results from all libraries
- - If you're a one branch system, choose 'Don't limit'
+- If you're a one branch system, choose 'Don't limit'
- Limit
- - Patrons will still be able to search other libraries via the
- Advanced search page - but will be limited to searches for their
- library only from the basic search box
+- Patrons will still be able to search other libraries via the
+ Advanced search page - but will be limited to searches for their
+ library only from the basic search box
+
+- :ref:`opacuserlogin` needs to be set to 'allow'
- - `opacuserlogin <#opacuserlogin>`__ needs to be set to 'allow'
+.. _privacy-label:
-`Privacy <#opacprivacyprefs>`__
+Privacy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AllowPatronToSetCheckoutsVisibilityForGuarantor <#AllowPatronToSetCheckoutsVisibilityForGuarantor>`__
+.. _allowpatrontosetcheckoutsvisibilityforguarantor-label:
+
+AllowPatronToSetCheckoutsVisibilityForGuarantor
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
Description:
- By default staff can see checkouts to family members via the staff
- client. This preference will allow guarantees (children) to grant
- permission to guarantors (guardians) to view their current checkouts
- via the public catalog. This preference requires that you allow
- patrons to se their own privacy with the
- `OPACPrivacy <#OPACPrivacy>`__ preference.
+client. This preference will allow guarantees (children) to grant
+permission to guarantors (guardians) to view their current checkouts
+via the public catalog. This preference requires that you allow
+patrons to se their own privacy with the
+:ref:`OPACPrivacy` preference.
+
+.. _anonsuggestions-label:
-`AnonSuggestions <#AnonSuggestions>`__
+AnonSuggestions
''''''''''''''''''''''''''''''''''''''
Default: Don't allow
Asks: \_\_\_ patrons that aren't logged in to make purchase suggestions.
- **Important**
+**Important**
- If set to 'Allow', suggestions are connected to the
- `AnonymousPatron <#AnonymousPatron>`__
+If set to 'Allow', suggestions are connected to the
+:ref:`AnonymousPatron`
Values:
- Don't allow
-`AnonymousPatron <#AnonymousPatron>`__
+.. _anonymouspatron-label:
+
+AnonymousPatron
''''''''''''''''''''''''''''''''''''''
Default: 0
Asks: Use borrowernumber \_\_\_ as the Anonymous Patron (for anonymous
suggestions and reading history)
- **Note**
+**Note**
- Before setting this preference `create a patron <#addnewpatron>`__
- to be used for all anonymous suggestions and/or reading history
- items. This patron can be any type and should be named something to
- make it clear to you that they're anonymous (ex. Anonymous Patron).
+Before setting this preference :ref:`create a patron <add-a-new-patron-label>`
+to be used for all anonymous suggestions and/or reading history
+items. This patron can be any type and should be named something to
+make it clear to you that they're anonymous (ex. Anonymous Patron).
- **Important**
+**Important**
- Remember to use the borrowernumber note the patron's cardnumber for
- this value. The borrowernumber can be found on the patron record
- under 'Library use' on the right.Borrowernumber
+Remember to use the borrowernumber note the patron's cardnumber for
+this value. The borrowernumber can be found on the patron record
+under 'Library use' on the right.Borrowernumber
-`EnableOpacSearchHistory <#EnableOpacSearchHistory>`__
+.. _enableopacsearchhistory-label:
+
+EnableOpacSearchHistory
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Keep
- Keep
-`OPACPrivacy <#OPACPrivacy>`__
+.. _opacprivacy-label:
+
+OPACPrivacy
''''''''''''''''''''''''''''''
Default: Don't allow
Asks: \_\_\_ patrons to choose their own privacy settings for their
reading history.
- **Important**
+**Important**
- This requires `opacreadinghistory <#opacreadinghistory>`__ set to
- 'Allow' and `AnonymousPatron <#AnonymousPatron>`__ to be set to your
- anonymous patron's borrowernumber.
+This requires :ref:`opacreadinghistory` set to
+'Allow' and :ref:`AnonymousPatron` to be set to your
+anonymous patron's borrowernumber.
Values:
Description:
- The default privacy setting for each patron category can be set in
- the `Patrons Categories <#patcats>`__ area. If you set this
- preference to 'allow' then patrons can change that for themselves via
- the OPAC.
+the :ref:`Patrons Categories <patron-categories-label>` area. If you set this
+preference to 'allow' then patrons can change that for themselves via
+the OPAC.
- **Important**
+**Important**
+
+If patron has chosen to have their reading history anonymized and
+you have :ref:`StoreLastBorrower` set to "Don't
+store" then as soon as the item is checked in the last borrower will
+be anonymized.
- If patron has chosen to have their reading history anonymized and
- you have `StoreLastBorrower <#StoreLastBorrower>`__ set to "Don't
- store" then as soon as the item is checked in the last borrower will
- be anonymized.
+.. _opacreadinghistory-label:
-`opacreadinghistory <#opacreadinghistory>`__
+opacreadinghistory
''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
Asks: \_\_\_ patrons to see what books they have checked out in the
past.
- **Important**
+**Important**
- Enabling this will make it so that patrons can view their
- circulation history in the OPAC unless you have
- `OPACPrivacy <#OPACPrivacy>`__ set to 'Allow.'
+Enabling this will make it so that patrons can view their
+circulation history in the OPAC unless you have
+:ref:`OPACPrivacy` set to 'Allow.'
- **Important**
+**Important**
+
+This data is stored in the system regardless of your choice, unless
+your patrons have chosen to never have their reading history kept.
- This data is stored in the system regardless of your choice, unless
- your patrons have chosen to never have their reading history kept.
+.. _storelastborrower-label:
-`StoreLastBorrower <#StoreLastBorrower>`__
+StoreLastBorrower
''''''''''''''''''''''''''''''''''''''''''
Default: Don't store
Description:
- This preference allows you to store the last patron to borrow an item
- even if the patron has chosen to have their reading history
- anonymized.
+even if the patron has chosen to have their reading history
+anonymized.
- **Note**
+**Note**
+
+This setting is independent of
+:ref:`opacreadinghistory` and/or
+:ref:`AnonymousPatron`.
- This setting is independent of
- `opacreadinghistory <#opacreadinghistory>`__ and/or
- `AnonymousPatron <#AnonymousPatron>`__.
+.. _trackclicks-label:
-`TrackClicks <#TrackClicks>`__
+TrackClicks
''''''''''''''''''''''''''''''
Default: Don't track
Description:
- By setting this preference to one of the track options you will allow
- Koha to track every link clicked in Koha. This data will be stored in
- a database table so that you can run reports against that data. If
- you choose to 'Track' clicks then Koha will record both the link
- clicked and the logged in user who clicked the link. If you choose to
- 'Track anonymously' then the borrowernumber will not be recorded, but
- the rest of the data will.
+Koha to track every link clicked in Koha. This data will be stored in
+a database table so that you can run reports against that data. If
+you choose to 'Track' clicks then Koha will record both the link
+clicked and the logged in user who clicked the link. If you choose to
+'Track anonymously' then the borrowernumber will not be recorded, but
+the rest of the data will.
- **Note**
+ **Note**
- Remember to update your local privacy policies and link to them
- from the OPAC to notify your users that you are tracking their
- information.
+ Remember to update your local privacy policies and link to them
+ from the OPAC to notify your users that you are tracking their
+ information.
-`Restricted Page <#opacrestrictedpg>`__
+.. _restricted-page-label:
+
+Restricted Page
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Using the following preference you can create a page within your Koha
used to house links to databases that can only be accessed from with the
library or other licensed content.
-`RestrictedPageContent <#RestrictedPageContent>`__
+.. _restrictedpagecontent-label:
+
+RestrictedPageContent
''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: HTML content of your restricted page.
-`RestrictedPageLocalIPs <#RestrictedPageLocalIPs>`__
+.. _restrictedpagelocalips-label:
+
+RestrictedPageLocalIPs
''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Access from IP addresses beginning with \_\_\_ do not need to be
Description:
- You can enter individual IPS as a comma separated list (ex:
- '127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
- '127.0.')
+'127.0.0,127.0.1') or just the beginning of the IP range allowed (ex:
+'127.0.')
-`RestrictedPageTitle <#RestrictedPageTitle>`__
+.. _restrictedpagetitle-label:
+
+RestrictedPageTitle
''''''''''''''''''''''''''''''''''''''''''''''
Asks: Use \_\_\_ as title of your restricted page
Description:
- This title will appear in the breadcrumb and on the top of the
- restricted page.
+restricted page.
+
+.. _self-registration-label:
-`Self Registration <#opacselfregistrationprefs>`__
+Self Registration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`PatronSelfModificationBorrowerUnwantedField <#PatronSelfModificationBorrowerUnwantedField>`__
+.. _patronselfmodificationborrowerunwantedfield-label:
+
+PatronSelfModificationBorrowerUnwantedField
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: password
Description:
- This preference allows you to define what fields patrons can edit if
- you're allowing them to update their personal information via the
- public catalog with the `OPACPatronDetails <#OPACPatronDetails>`__
- preference.
+you're allowing them to update their personal information via the
+public catalog with the :ref:`OPACPatronDetails`
+preference.
- **Important**
+**Important**
- Separate columns with \|
+Separate columns with \|
-`PatronSelfRegistration <#PatronSelfRegistration>`__
+.. _patronselfregistration-label:
+
+PatronSelfRegistration
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
Description:
- Setting this preference to 'Allow' will provide a link on the OPAC to
- register for a new account. Using the other `Self
- Registration <#opacselfregistrationprefs>`__ system preferences you
- can control how this preference will function.
+register for a new account. Using the other :ref:`Self
+Registration <self-registration-label>` system preferences you
+can control how this preference will function.
- Register link in the OPAC
- |image103|
+Register link in the OPAC
+|image103|
- **Important**
+**Important**
+
+Patrons registering via the OPAC will not need to be approved by a
+librarian. For this reason it is recommended that you set up a
+provisional :ref:`patron category <patron-categories-label>` with no :ref:`circulation
+rights <circulation-and-fine-rules-label>`. That way patrons will have to come in to
+the library to verify their identity before given circulation rights
+at the library. Once the patron confirms their identiy the library
+staff can change the category to one with permissions to check items
+out and place holds.
- Patrons registering via the OPAC will not need to be approved by a
- librarian. For this reason it is recommended that you set up a
- provisional `patron category <#patcats>`__ with no `circulation
- rights <#circfinerules>`__. That way patrons will have to come in to
- the library to verify their identity before given circulation rights
- at the library. Once the patron confirms their identiy the library
- staff can change the category to one with permissions to check items
- out and place holds.
+.. _patronselfregistrationadditionalinstructions-label:
-`PatronSelfRegistrationAdditionalInstructions <#PatronSelfRegistrationAdditionalInstructions>`__
+PatronSelfRegistrationAdditionalInstructions
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Display the following additional instructions for patrons who self
Description:
- This preference takes any HTML you'd like to display on the page the
- patron sees after successfully registering for their library card.
+patron sees after successfully registering for their library card.
-`PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
+.. _patronselfregistrationborrowermandatoryfield-label:
+
+PatronSelfRegistrationBorrowerMandatoryField
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: surname\|firstname
Description:
- This preference allows you to define what fields patrons must fill in
- on their self regisration form. If any of the required fields are
- blank Koha will not let the patron register.
+on their self regisration form. If any of the required fields are
+blank Koha will not let the patron register.
- **Important**
+**Important**
- Separate columns with \|
+Separate columns with \|
- **Note**
+**Note**
- For help with field names, ask your system administrator or `view
- the database
- structure <http://schema.koha-community.org/tables/borrowers.html>`__
- associated with the borrowers table.
+For help with field names, ask your system administrator or `view
+the database
+structure <http://schema.koha-community.org/tables/borrowers.html>`__
+associated with the borrowers table.
+
+**Note**
- **Note**
+If you're going to require that patrons verify their accounts via
+email with the
+:ref:`PatronSelfRegistrationVerifyByEmail`
+preference the email field will automatically be marked as required.
- If you're going to require that patrons verify their accounts via
- email with the
- `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
- preference the email field will automatically be marked as required.
+.. _patronselfregistrationborrowerunwantedfield-label:
-`PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
+PatronSelfRegistrationBorrowerUnwantedField
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: password
Description:
- Using this preference you can hide fields from the patron registraion
- and update form in the OPAC.
+and update form in the OPAC.
- **Important**
+**Important**
- Separate columns with \|
+Separate columns with \|
- **Note**
+**Note**
- For help with field names, ask your system administrator or `view
- the database
- structure <http://schema.koha-community.org/tables/borrowers.html>`__
- associated with the borrowers table.
+For help with field names, ask your system administrator or `view
+the database
+structure <http://schema.koha-community.org/tables/borrowers.html>`__
+associated with the borrowers table.
+
+.. _patronselfregistrationdefaultcategory-label:
-`PatronSelfRegistrationDefaultCategory <#PatronSelfRegistrationDefaultCategory>`__
+PatronSelfRegistrationDefaultCategory
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Use the patron category code \_\_\_ as the default patron category
Description:
- Enter in the patron category code for the category that all new
- patrons registered via the OPAC will be put in to.
+patrons registered via the OPAC will be put in to.
- **Important**
+**Important**
- Patrons registering via the OPAC will not need to be approved by a
- librarian. For this reason it is recommended that you set up a
- provisional `patron category <#patcats>`__ with no `circulation
- rights <#circfinerules>`__. That way patrons will have to come in to
- the library to verify their identity before given circulation rights
- at the library. Once the patron confirms their identiy the library
- staff can change the category to one with permissions to check items
- out and place holds.
+Patrons registering via the OPAC will not need to be approved by a
+librarian. For this reason it is recommended that you set up a
+provisional :ref:`patron category <patron-categories-label>` with no :ref:`circulation
+rights <circulation-and-fine-rules-label>`. That way patrons will have to come in to
+the library to verify their identity before given circulation rights
+at the library. Once the patron confirms their identiy the library
+staff can change the category to one with permissions to check items
+out and place holds.
- **Important**
+**Important**
- If you leave this blank or enter in an invalid code your patrons
- will still be able to register but will not be given a username.
- There will be no errors on the page to explain this, so be sure to
- enter a valid patron category code.
-
-`PatronSelfRegistrationEmailMustBeUnique <#PatronSelfRegistrationEmailMustBeUnique>`__
+If you leave this blank or enter in an invalid code your patrons
+will still be able to register but will not be given a username.
+There will be no errors on the page to explain this, so be sure to
+enter a valid patron category code.
+
+.. _patronselfregistrationemailmustbeunique-label:
+
+PatronSelfRegistrationEmailMustBeUnique
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Do not consider
- Consider
-`PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
+.. _patronselfregistrationexpiretemporaryaccountsdelay-label:
+
+PatronSelfRegistrationExpireTemporaryAccountsDelay
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 0
Description:
-- This prefence links to the `delete\_expired\_opac\_registrations.pl
- cron job <#deleteexpiredregistrationcron>`__. If that cron is set to
+- This preference links to the :ref:`delete\_expired\_opac\_registrations.pl
+ cron job <unverified-registrations-label>`. If that cron is set to
run nightly it will clean up any registrations that have not been
verified via email in the number of days entered on this preference.
This is dependent on
- `PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
+ :ref:`PatronSelfRegistrationVerifyByEmail`
preference.
-`PatronSelfRegistrationLibraryList <#PatronSelfRegistrationLibraryList>`__
+.. _patronselfregistrationlibrarylist-label:
+
+PatronSelfRegistrationLibraryList
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: blank
Asks: Enable the self registration for the following libraries: \_\_\_
(separate branchcode with |). If empty, all libraries will be listed.
-`PatronSelfRegistrationPrefillForm <#PatronSelfRegistrationPrefillForm>`__
+.. _patronselfregistrationprefillform-label:
+
+PatronSelfRegistrationPrefillForm
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Display and prefill
- Display and prefill
-`PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
+.. _patronselfregistrationverifybyemail-label:
+
+PatronSelfRegistrationVerifyByEmail
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't require
not be able to log in to the OPAC until they acknowledge the email
sent by Koha. If you don't require this then patrons will be able to
log in as soon as they fill in the registration form. You can set the
- `PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
+ :ref:`PatronSelfRegistrationExpireTemporaryAccountsDelay`
preference to delete the un-verified self registrations after a
certain number of days.
If you're going to require that patrons verify their accounts via
email then the email field will automatically be marked as required.
-`Shelf Browser <#shelfbrowseprefs>`__
+.. _shelf-browser-label:
+
+Shelf Browser
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`OPACShelfBrowser <#OPACShelfBrowser>`__
+.. _opacshelfbrowser-label:
+
+OPACShelfBrowser
''''''''''''''''''''''''''''''''''''''''
Default: Show
This uses up a fairly large amount of resources on your server, and
should be avoided if your collection has a large number of items.
-`ShelfBrowserUsesCcode <#ShelfBrowserUsesCcode>`__
+.. _shelfbrowserusesccode-label:
+
+ShelfBrowserUsesCcode
''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't use
browser to take into consideration what collection the books belong
to when populating the virtual shelf browser.
-`ShelfBrowserUsesHomeBranch <#ShelfBrowserUsesHomeBranch>`__
+.. _shelfbrowseruseshomebranch-label:
+
+ShelfBrowserUsesHomeBranch
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Use
Koha takes into consideration what branch owns the books when
populating the virtual shelf browser for accuracy.
-`ShelfBrowserUsesLocation <#ShelfBrowserUsesLocation>`__
+.. _shelfbrowseruseslocation-label:
+
+ShelfBrowserUsesLocation
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Use
browser to take into consideration what shelving location the books
belong to when populating the virtual shelf browser.
-`Patrons <#patronprefs>`__
+.. _patrons-label:
+
+Patrons
~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences > Patrons
-`General <#generalpatronpref>`__
+.. _general-label:
+
+General
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AllowStaffToSetCheckoutsVisibilityForGuarantor <#AllowStaffToSetCheckoutsVisibilityForGuarantor>`__
+.. _allowstafftosetcheckoutsvisibilityforguarantor-label:
+
+AllowStaffToSetCheckoutsVisibilityForGuarantor
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't allow
- Allow
-`AutoEmailOpacUser <#AutoEmailOPACUser>`__
+.. _autoemailopacuser-label:
+
+AutoEmailOpacUser
''''''''''''''''''''''''''''''''''''''''''
Default: Don't send
- AutoEmailOpacUser allows library users to be notified by email of
their account details when a new account is opened at the email
address specified in the
- `AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__ preference.
+ :ref:`AutoEmailPrimaryAddress` preference.
The email contains the username and password given to or chosen by
the patron when signing up for their account and can be customized by
editing the `ACCTDETAILS <#ACCTDETAILS>`__ notice.
- Send
-`AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__
+.. _autoemailprimaryaddress-label:
+
+AutoEmailPrimaryAddress
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: alternate
then alternate. Otherwise the system will use the email address you
specify.
-`autoMemberNum <#autoMemberNum>`__
+.. _automembernum-label:
+
+autoMemberNum
''''''''''''''''''''''''''''''''''
Default: Do
'Do' the system will calculate a new patron barcode by adding 1 to
the maximum barcode already present in the database.
-`BorrowerMandatoryField <#BorrowerMandatoryField>`__
+.. _borrowermandatoryfield-label:
+
+BorrowerMandatoryField
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: surname\|cardnumber\|barcode
structure <http://schema.koha-community.org/tables/borrowers.html>`__
associated with the borrowers table.
-`borrowerRelationship <#borrowerRelationship>`__
+.. _borrowerrelationship-label:
+
+borrowerRelationship
''''''''''''''''''''''''''''''''''''''''''''''''
Default: father\|mother
Input multiple choices separated by \|
-`BorrowerRenewalPeriodBase <#BorrowerRenewalPeriodBase>`__
+.. _borrowerrenewalperiodbase-label:
+
+BorrowerRenewalPeriodBase
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: current date
subscription period to the old expiration date for the patron when
renewing their account.
-`BorrowersTitles <#BorrowersTitles>`__
+.. _borrowerstitles-label:
+
+BorrowersTitles
''''''''''''''''''''''''''''''''''''''
Default: Mr\|Mrs\|Miss\|Ms
Input multiple choices separated by \|
-`BorrowerUnwantedField <#BorrowerUnwantedField>`__
+.. _borrowerunwantedfield-label:
+
+BorrowerUnwantedField
''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: The following database columns will not appear on the patron entry
structure <http://schema.koha-community.org/tables/borrowers.html>`__
associated with the borrowers table.
-`CardnumberLength <#CardnumberLength>`__
+.. _cardnumberlength-label:
+
+CardnumberLength
''''''''''''''''''''''''''''''''''''''''
Asks: Card numbers for patrons must be \_\_\_ characters long.
- The length can be a single number to specify an exact length, a range
separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum
(i.e., ',Max'). If 'cardnumber' is included in the
- `BorrowerMandatoryField <#BorrowerMandatoryField>`__ list, the
+ :ref:`BorrowerMandatoryField` list, the
minimum length, if not specified here, defaults to one.
-`checkdigit <#checkdigit>`__
+.. _checkdigit-label:
+
+checkdigit
''''''''''''''''''''''''''''
Default: Don't
**Important**
- This overrides `autoMemberNum <#autoMemberNum>`__ if on.
+ This overrides :ref:`autoMemberNum` if on.
-`CheckPrevCheckout <#CheckPrevCheckout>`__
+.. _checkprevcheckout-label:
+
+CheckPrevCheckout
''''''''''''''''''''''''''''''''''''''''''
Default: Do not
- Unless overridden, do not
-`DefaultPatronSearchFields <#DefaultPatronSearchFields>`__
+.. _defaultpatronsearchfields-label:
+
+DefaultPatronSearchFields
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: surname,firstname,othernames,cardnumber,userid
**Important** possible values can be found in the borrowers table of Koha's schema
located at http://schema.koha-community.org/
-`EnableBorrowerFiles <#EnableBorrowerFiles>`__
+.. _enableborrowerfiles-label:
+
+EnableBorrowerFiles
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't
- When enabled this will add a 'Files' tab to the left of the patron
detail page where you can view and upload files to the patron record.
-`EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+.. _enhancedmessagingpreferences-label:
+
+EnhancedMessagingPreferences
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
**Note**
To manage if patrons have also access to these settings, use
- `EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__.
+ :ref:`EnhancedMessagingPreferencesOPAC`.
Description:
- Advanced Notice : A notice in advance of the patron's items being
due (Staff can choose the number of days in advance)
-`EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__
+.. _enhancedmessagingpreferencesopac-label:
+
+EnhancedMessagingPreferencesOPAC
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Show
**Important**
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
must be enabled for messaging options to show in the OPAC
Description:
- Advanced Notice : A notice in advance of the patron's items being
due (The patron can choose the number of days in advance)
-`ExtendedPatronAttributes <#ExtendedPatronAttributes>`__
+.. _extendedpatronattributes-label:
+
+ExtendedPatronAttributes
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Enable
- Define attributes in Koha administration
- - Get there: More > Administration > `Patron Attribute
- Types <#patronattributetypes>`__
+ - Get there: More > Administration > :ref:`Patron Attribute
+ Types <patron-attribute-types-label>`
Description:
Use custom attributes for fields that the default patron record does
not support such as driver's license number or student ID number.
-`FeeOnChangePatronCategory <#FeeOnChangePatronCategory>`__
+.. _feeonchangepatroncategory-label:
+
+FeeOnChangePatronCategory
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Do
- Don't
-`intranetreadinghistory <#intranetreadinghistory>`__
+.. _intranetreadinghistory-label:
+
+intranetreadinghistory
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Allow
**Important**
- If you have the `OPACPrivacy <#OPACPrivacy>`__ preference set to
+ If you have the :ref:`OPACPrivacy` preference set to
'Allow' and the patron has decided to not have their history kept
staff will only see currently checked out items.
Reading history is still stored, regardless of staff being allowed
access or not unless the patron has chosen to have their history
- anonymized via their `privacy page <#opacmyprivacy>`__.
+ anonymized via their :ref:`privacy page <my-privacy-label>`.
+
+.. _maxfine-label:
-`MaxFine <#MaxFine>`__
+MaxFine
''''''''''''''''''''''
Default: 9999
- This preference controls the default cap on fines accrued by the
patron. Leaving this preference blank means that there is no cap on
the amount of fines a patron can accrue. If you'd like, single item
- caps can be specified in the `circulation rules
- matrix <#circfinerules>`__.
+ caps can be specified in the :ref:`circulation rules
+ matrix <circulation-and-fine-rules-label>`.
-`MembershipExpiryDaysNotice <#MembershipExpiryDaysNotice>`__
+.. _membershipexpirydaysnotice-label:
+
+MembershipExpiryDaysNotice
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Send an account expiration notice when a patron's card will expire
- If you would like to notify patrons that their accounts are about to
expire then you can enter a number of days before expiration in this
- preference. The notice text can be customized in the `Notices &
- Slips <#notices>`__ tool.
+ preference. The notice text can be customized in the :ref:`Notices &
+ Slips <notices-&-slips-label>` tool.
**Important**
- You will need to enable the `membership expiry cron
- job <#patronexpirycron>`__ for this notice to send.
+ You will need to enable the :ref:`membership expiry cron
+ job <notify-patrons-of-expiration-label>` for this notice to send.
+
+.. _minpasswordlength-label:
-`minPasswordLength <#minPasswordLength>`__
+minPasswordLength
''''''''''''''''''''''''''''''''''''''''''
Default: 3
This applies to both the staff login and the patron OPAC login.
-`NotifyBorrowerDeparture <#NotifyBorrowerDeparture>`__
+.. _notifyborrowerdeparture-label:
+
+NotifyBorrowerDeparture
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 30
This notice will appear on the patron's record in the staff client.
-`patronimages <#patronimages>`__
+.. _patronimages-label:
+
+patronimages
''''''''''''''''''''''''''''''''
Default: Allow
Description:
- If this preference is set to 'Allow' the staff will be able to upload
- images of patrons either `one by one <#addpatronimages>`__ or `in
- bulk <#uploadpatronimages>`__. Patrons images will show on the detail
+ images of patrons either :ref:`one by one <add-patron-images-label>` or :ref:`in
+ bulk <upload-patron-images-label>`. Patrons images will show on the detail
page to the left of the patron information. They can also show in the
- OPAC if you set the `OPACpatronimages <#OPACpatronimages>`__ preference
+ OPAC if you set the :ref:`OPACpatronimages` preference
or in the self check out module if you set the
- `ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
+ :ref:`ShowPatronImageInWebBasedSelfCheck`
preference.
-`PatronQuickAddFields <#PatronQuickAddFields>`__
+.. _patronquickaddfields-label:
+
+PatronQuickAddFields
''''''''''''''''''''''''''''''''''''''''''''''''
Default: blank
and fields specified here. If applicable, the guarantor form will be shown
as well, individual fields in that form will be ignored.
-`PatronsPerPage <#PatronsPerPage>`__
+.. _patronsperpage-label:
+
+PatronsPerPage
''''''''''''''''''''''''''''''''''''
Default: 20
- This preference will let you define how many patrons to show on
patron search results pages.
-`SMSSendDriver, SMSSendUsername, and SMSSendPassword <#SMSSendDriver>`__
+.. _smssenddriver,-smssendusername,-and-smssendpassword-label:
+
+SMSSendDriver, SMSSendUsername, and SMSSendPassword
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Use the SMS::Send:: \_\_\_ driver to send SMS messages. Define a
**Important**
You must allow
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ for
+ :ref:`EnhancedMessagingPreferences` for
this to work.
-`StatisticsFields <#StatisticsFields>`__
+.. _statisticsfields-label:
+
+StatisticsFields
''''''''''''''''''''''''''''''''''''''''
Default: location\|itype\|ccode
- This preference lets you set which fields will show on the patron
record on the Statistics tab.
-`TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
+.. _talkingtechitivaphonenotification-label:
+
+TalkingTechItivaPhoneNotification
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Disable
**Important**
Requires that you have
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ set
+ :ref:`EnhancedMessagingPreferences` set
to Allow to use.
-`TrackLastPatronActivity <#TrackLastPatronActivity>`__
+.. _tracklastpatronactivity-label:
+
+TrackLastPatronActivity
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't
- Do
-`uppercasesurnames <#uppercasesurnames>`__
+.. _uppercasesurnames-label:
+
+uppercasesurnames
''''''''''''''''''''''''''''''''''''''''''
Default: Don't
- Don't
-`useDischarge <#useDischarge>`__
+.. _usedischarge-label:
+
+useDischarge
''''''''''''''''''''''''''''''''
Default: Don't allow
Academic libraries often require that you have a clear record at
the library before you can graduate.
-`Norwegian patron database <#norwegianpref>`__
+.. _norwegian-patron-database-label:
+
+Norwegian patron database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`FailedLoginAttempts <#FailedLoginAttempts>`__
+.. _failedloginattempts-label:
+
+FailedLoginAttempts
''''''''''''''''''''''''''''''''''''''''''''''
Default: blank
Asks: Block a patron's account if it reaches \_\_\_ failed login attempts.
-`NorwegianPatronDBEnable & NorwegianPatronDBEndpoint <#NorwegianPatronDBEnable>`__
+.. _norwegianpatrondbenable-&-norwegianpatrondbendpoint-label:
+
+NorwegianPatronDBEnable & NorwegianPatronDBEndpoint
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
NorwegianPatronDBEnable Default: Disable
- Enable
-`NorwegianPatronDBSearchNLAfterLocalHit <#NorwegianPatronDBSearchNLAfterLocalHit>`__
+.. _norwegianpatrondbsearchnlafterlocalhit-label:
+
+NorwegianPatronDBSearchNLAfterLocalHit
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't
- Don't
-`NorwegianPatronDBUsername & NorwegianPatronDBPassword <#NorwegianPatronDBUsername>`__
+.. _norwegianpatrondbusername-&-norwegianpatrondbpassword-label:
+
+NorwegianPatronDBUsername & NorwegianPatronDBPassword
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Communicate with the Norwegian national patron database using the
- You can get these from "Base Bibliotek", which is maintained by the
Norwegian National Library.
-`Searching <#searchingprefs>`__
+.. _searching-label:
+
+Searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences >
Searching
-`Features <#searchfeatureprefs>`__
+.. _features-label:
+
+Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`EnableSearchHistory <#EnableSearchHistory>`__
+.. _enablesearchhistory-label:
+
+EnableSearchHistory
''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't keep
history for logged in users. Search history will be accessible under
the link to your account in the top right of the staff client.
-`IncludeSeeFromInSearches <#IncludeSeeFromInSearches>`__
+.. _includeseefrominsearches-label:
+
+IncludeSeeFromInSearches
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't include
You will need to reindex your bibliographic database when changing
this preference.
-`OpacGroupResults <#OpacGroupResults>`__
+.. _opacgroupresults-label:
+
+OpacGroupResults
''''''''''''''''''''''''''''''''''''''''
Default: Don't use
This requires that `PazPar2 <http://www.indexdata.com/pazpar2>`__ is
set up and running.
-`QueryAutoTruncate <#QueryAutoTruncate>`__
+.. _queryautotruncate-label:
+
+QueryAutoTruncate
''''''''''''''''''''''''''''''''''''''''''
Default: automatically
results. Auto truncation bypasses the necessity to type long search
strings in their entirety.
-`QueryFuzzy <#QueryFuzzy>`__
+.. _queryfuzzy-label:
+
+QueryFuzzy
''''''''''''''''''''''''''''
Default: Try
**Important**
- Requires that `UseICU <#UseICU>`__ set to 'Not using'
+ Requires that :ref:`UseICU` set to 'Not using'
+
+.. _querystemming-label:
-`QueryStemming <#QueryStemming>`__
+QueryStemming
''''''''''''''''''''''''''''''''''
Default: Try
function to return multiple versions of the same word, as well as
related terms (i.e., both fish and fishing would be returned).
-`QueryWeightFields <#QueryWeightFields>`__
+.. _queryweightfields-label:
+
+QueryWeightFields
''''''''''''''''''''''''''''''''''''''''''
Default: Enable
- Enable
-`TraceCompleteSubfields <#TraceCompleteSubfields>`__
+.. _tracecompletesubfields-label:
+
+TraceCompleteSubfields
''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Force
**Important**
This preference assumes that you're using XSLT stylesheets as set in
- the `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preference.
+ the :ref:`OPACXSLTDetailsDisplay` preference.
-`TraceSubjectSubdivisions <#TraceSubjectSubdivisions>`__
+.. _tracesubjectsubdivisions-label:
+
+TraceSubjectSubdivisions
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Include
**Important**
This preference assumes that you're using XSLT stylesheets as set in
- the `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ preference.
+ the :ref:`OPACXSLTDetailsDisplay` preference.
+
+.. _useicu-label:
-`UseICU <#UseICU>`__
+UseICU
''''''''''''''''''''
Default: Not using
support for software applications. What this means is ICU Zebra
indexing is only necessary if you use non-roman characters in your
cataloging. If using ICU Zebra indexing you will want to not use
- `QueryFuzzy <#QueryFuzzy>`__.
+ :ref:`QueryFuzzy`.
**Important**
Talk to your system administrator when changing this preference to
make sure that your system is set up properly for this to work.
-`UseQueryParser <#UseQueryParser>`__
+.. _usequeryparser-label:
+
+UseQueryParser
''''''''''''''''''''''''''''''''''''
Default: Do not try
- This preference enables an experimental new query parser which opens
the door for a more expressive and more-effective search syntax.
-`Results Display <#searchresultsprefs>`__
+.. _results-display-label:
+
+Results Display
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`defaultSortField & defaultSortOrder <#defaultSortField>`__
+.. _defaultsortfield-&-defaultsortorder-label:
+
+defaultSortField & defaultSortOrder
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
defaultSortField Default: author
- from Z to A
-`displayFacetCount <#displayFacetCount>`__
+.. _displayfacetcount-label:
+
+displayFacetCount
''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- This preference lets you decide if you show how many times a facet is
used in your search results in the OPAC and the staff client. The
relevance of these numbers highly depends on the value of the
- `maxRecordsForFacets <#maxRecordsForFacets>`__ preference. Showing
+ :ref:`maxRecordsForFacets` preference. Showing
these numbers can potentially effect the performance of your
searching, so test your system with different values for this
preference to see what works best.
Number of times each Facet is found in results
|image107|
-`DisplayLibraryFacets <#DisplayLibraryFacets>`__
+.. _displaylibraryfacets-label:
+
+DisplayLibraryFacets
''''''''''''''''''''''''''''''''''''''''''''''''
Default: holding library
results in the staff and opac. The value selected here will determin
which library(s) show in the facets when a search is run.
-`FacetLabelTruncationLength <#FacetLabelTruncationLength>`__
+.. _facetlabeltruncationlength-label:
+
+FacetLabelTruncationLength
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 20
or two few letters, this preference lets you decide what number is
best for your library's design.
-`FacetMaxCount <#FacetMaxCount>`__
+.. _facetmaxcount-label:
+
+FacetMaxCount
''''''''''''''''''''''''''''''''''
Default: 20
under each heading (Author, Series, Topics, etc) on the facets in the
OPAC.
-`maxItemsInSearchResults <#maxItemsInSearchResults>`__
+.. _maxitemsinsearchresults-label:
+
+maxItemsInSearchResults
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 20
- This preference will let you set how many results display by default
when a search is run on the Staff Client.
-`maxRecordsForFacets <#maxRecordsForFacets>`__
+.. _maxrecordsforfacets-label:
+
+maxRecordsForFacets
''''''''''''''''''''''''''''''''''''''''''''''
Default: 20
search results to return, so test with various different values to
find the best balance for your library.
-`MaxSearchResultsItemsPerRecordStatusCheck <#MaxSearchResultsItemsPerRecordStatusCheck>`__
+.. _maxsearchresultsitemsperrecordstatuscheck-label:
+
+MaxSearchResultsItemsPerRecordStatusCheck
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: 20
record has more items than the limit set. Statuses will display
correctly in the record details. Leave empty for no limit.
-`numSearchResults <#numSearchResults>`__
+.. _numsearchresults-label:
+
+numSearchResults
''''''''''''''''''''''''''''''''''''''''
Default: 20
Asks: By default, show \_\_\_ results per page in the staff client.
-`OPACdefaultSortField & OPACdefaultSortOrder <#opacdefaultsort>`__
+.. _opacdefaultsortfield-and-opacdefaultsortorder-label:
+
+OPACdefaultSortField & OPACdefaultSortOrder
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
OPACdefaultSortField Default: relevance
- from Z to A
-`OPACItemsResultsDisplay <#OPACItemsResultsDisplay>`__
+.. _opacitemsresultsdisplay-label:
+
+OPACItemsResultsDisplay
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
be displayed on the search results page, the information can be
overwhelming for large collections with multiple branches.
-`OPACnumSearchResults <#OPACnumSearchResults>`__
+.. _opacnumsearchresults-label:
+
+OPACnumSearchResults
''''''''''''''''''''''''''''''''''''''''''''''''
Default: 20
Asks: By default, show \_\_\_ results per page in the OPAC.
-`SearchWithISBNVariations <#SearchWithISBNVariations>`__
+.. _searchwithisbnvariations-label:
+
+SearchWithISBNVariations
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: don't search
**Important**
This preference has no effect if
- `UseQueryParser <#UseQueryParser>`__ is on
+ :ref:`UseQueryParser` is on
+
+.. _unimarcauthorsfacetsseparator-label:
-`UNIMARCAuthorsFacetsSeparator <#UNIMARCAuthorsFacetsSeparator>`__
+UNIMARCAuthorsFacetsSeparator
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: , (comma)
Asks: Use the following text as separator for UNIMARC authors facets \_\_\_
-`Search Form <#searchformprefs>`__
+.. _search-form-label:
+
+Search Form
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AdvancedSearchLanguages <#AdvancedSearchLanguages>`__
+.. _advancedsearchlanguages-label:
+
+AdvancedSearchLanguages
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Limit the languages listed in the advanced search drop-down to the
separated by comma ( , ) or bar ( \| ). For example to limit listing
to French and Italian, enter ita\|fre.
-`AdvancedSearchTypes <#AdvancedSearchTypes>`__
+.. _advancedsearchtypes-label:
+
+AdvancedSearchTypes
''''''''''''''''''''''''''''''''''''''''''''''
Default: itemtype
Searching by Item Type and Shelving Location
|image108|
-`expandedSearchOption <#expandedSearchOption>`__
+.. _expandedsearchoption-label:
+
+expandedSearchOption
''''''''''''''''''''''''''''''''''''''''''''''''
Default: don't show
- show
-`IntranetNumbersPreferPhrase <#IntranetNumbersPreferPhrase>`__
+.. _intranetnumberspreferphrase-label:
+
+IntranetNumbersPreferPhrase
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: don't use
search by setting this preference to 'use.' This will allow for more
accurate results over doing a general keyword field search.
-`LoadSearchHistoryToTheFirstLoggedUser <#LoadSearchHistoryToTheFirstLoggedUser>`__
+.. _loadsearchhistorytothefirstloggeduser-label:
+
+LoadSearchHistoryToTheFirstLoggedUser
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Load
- Load
-`OPACNumbersPreferPhrase <#OPACNumbersPreferPhrase>`__
+.. _opacnumberspreferphrase-label:
+
+OPACNumbersPreferPhrase
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: don't use
search by setting this preference to 'use.' This will allow for more
accurate results over doing a general keyword field search.
-`Serials <#serialsprefs>`__
+.. _serials-label:
+
+Serials
~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences > Serials
-`makePreviousSerialAvailable <#makePreviousSerialAvailable>`__
+.. _makepreviousserialavailable-label:
+
+makePreviousSerialAvailable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Do not make
Asks: \_\_\_ previous serial automatically available when receiving a
new serial issue. The previous issue can also be set to another item
-type when receiving a new one. Please note that the `item-level\_itypes <#item-level_itypes>`__
+type when receiving a new one. Please note that the :ref:`item-level\_itypes <item-level\_itypes-label>`
syspref must be set to specific item.
Values:
- Make
-`opacSerialDefaultTab <#opacSerialDefaultTab>`__
+.. _opacserialdefaulttab-label:
+
+opacSerialDefaultTab
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Subscriptions tab
Subscriptions tab
|image110|
-`OPACSerialIssueDisplayCount <#OPACSerialIssueDisplayCount>`__
+.. _opacserialissuedisplaycount-label:
+
+OPACSerialIssueDisplayCount
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: 3
serial is accessed. This is just the default value, patrons can
always click to see a full list of serials.
-`RenewSerialAddsSuggestion <#RenewSerialAddsSuggestion>`__
+.. _renewserialaddssuggestion-label:
+
+RenewSerialAddsSuggestion
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Don't add
option. If you don't use the Acquisitions module to manage serials
purchases it's best to leave this set as 'Don't add.'
-`RoutingListAddReserves <#RoutingListAddReserves>`__
+.. _routinglistaddreserves-label:
+
+RoutingListAddReserves
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Place
- Don't place
-`RoutingListNote <#RoutingListNote>`__
+.. _routinglistnote-label:
+
+RoutingListNote
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Asks: Include following note on all routing lists
- Text entered in this box will appear below the routing list
information.
-`RoutingSerials <#RoutingSerials>`__
+.. _routingserials-label:
+
+RoutingSerials
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: Don't add
established for each serial to be passed using the Serials module.
This preference can be used to ensure each person who needs to see a
serial when it arrives at the library will get it. Learn more in the
- `routing list <#routinglist>`__ section of this manual.
+ :ref:`routing list <create-a-routing-list-label>` section of this manual.
Values:
- Don't add
-`StaffSerialIssueDisplayCount <#StaffSerialIssueDisplayCount>`__
+.. _staffserialissuedisplaycount-label:
+
+StaffSerialIssueDisplayCount
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: 3
the serial is accessed. This is just the default value, staff members
can always click to see a full list of serials.
-`SubscriptionDuplicateDroppedInput <#SubscriptionDuplicateDroppedInput>`__
+.. _subscriptionduplicatedroppedinput-label:
+
+SubscriptionDuplicateDroppedInput
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Asks: List of fields which must not be rewritten when a subscription is
Schema <http://schema.koha-community.org/tables/subscription.html>`__
site.
-`SubscriptionHistory <#SubscriptionHistory>`__
+.. _subscriptionhistory-label:
+
+SubscriptionHistory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Default: full history
detailed breakdown of issues per year, including information such as
the issue date and the status of each issue.
-`Staff Client <#staffprefs>`__
+.. _staff-client-label:
+
+Staff Client
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences > Staff
Client
-`Appearance <#staffappearprefs>`__
+.. _appearance-label:
+
+Appearance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`Display856uAsImage <#Display856uAsImage>`__
+.. _display856uasimage-label:
+
+Display856uAsImage
''''''''''''''''''''''''''''''''''''''''''''
Default: Neither details or results page
- **Important**
- `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__ needs to be on
+ :ref:`XSLTDetailsDisplay` needs to be on
for this preference to work.
Showing the 856u as an image
will open it in the same way as clicking on the link text. When you
click on the image it should open to full size, in the current window
or in a new window depending on the value in the system pref
- `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__.
+ :ref:`OPACURLOpenInNewWindow`.
Sample 856 Field
|image114|
-`DisplayIconsXSLT <#DisplayIconsXSLT>`__
+.. _displayiconsxslt-label:
+
+DisplayIconsXSLT
''''''''''''''''''''''''''''''''''''''''
Default: Show
**Important**
- `XSLTResultsDisplay <#XSLTResultsDisplay>`__ and/or
- `XSLTDetailsDisplay <#XSLTDetailsDisplay>`__ must be set to use an
+ :ref:`XSLTResultsDisplay` and/or
+ :ref:`XSLTDetailsDisplay` must be set to use an
XSLT stylesheet (default or custom) for these icons to show.
Values:
See the `XSLT Icon Guide <#XSLTiTypes>`__ for more information on
these icons.
-`intranet\_includes <#intranet_includes>`__
+.. _intranet\_includes-label:
+
+intranet\_includes
'''''''''''''''''''''''''''''''''''''''''''
Default: includes
Asks: Use include files from the \_\_\_ directory in the template
directory, instead of includes/. (Leave blank to disable)
-`IntranetCirculationHomeHTML <#IntranetCirculationHomeHTML>`__
+.. _intranetcirculationhomehtml-label:
+
+IntranetCirculationHomeHTML
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Show the following HTML in its own div on the bottom of the home
page of the circulation module: IntranetCirculationHomeHTML
-`intranetcolorstylesheet <#intranetcolorstylesheet>`__
+.. _intranetcolorstylesheet-label:
+
+intranetcolorstylesheet
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Include the additional CSS stylesheet \_\_\_ to override specified
Leave this field blank to disable.
-`IntranetFavicon <#IntranetFavicon>`__
+.. _intranetfavicon-label:
+
+IntranetFavicon
''''''''''''''''''''''''''''''''''''''
Asks: Use the image at \_\_\_ for the Staff Client's favicon.
Default Koha Favicon
|image116|
-`IntranetmainUserblock <#IntranetmainUserblock>`__
+.. _intranetmainuserblock-label:
+
+IntranetmainUserblock
''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Show the following HTML in its own column on the main page of the
main page
|image118|
-`IntranetNav <#IntranetNav>`__
+.. _intranetnav-label:
+
+IntranetNav
''''''''''''''''''''''''''''''
Asks: Show the following HTML in the More menu at the top of each page
on the staff client (should be a list of links or blank)
-`IntranetReportsHomeHTML <#IntranetReportsHomeHTML>`__
+.. _intranetreportshomehtml-label:
+
+IntranetReportsHomeHTML
''''''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Show the following HTML in its own div on the bottom of the home
page of the reports module: HTML on Reports page
-`IntranetSlipPrinterJS <#IntranetSlipPrinterJS>`__
+.. _intranetslipprinterjs-label:
+
+IntranetSlipPrinterJS
''''''''''''''''''''''''''''''''''''''''''''''''''
Asks: Use the following JavaScript for printing slips.
wiki at
http://wiki.koha-community.org/wiki/Setting_up_slip_printer_to_print_silently.
-`intranetstylesheet <#intranetstylesheet>`__
+.. _intranetstylesheet-label:
+
+intranetstylesheet
''''''''''''''''''''''''''''''''''''''''''''
Asks: Use the CSS stylesheet \_\_\_ on all pages in the staff interface,
theme and language within the Koha templates directory. A full local
path is expected to start from your HTTP document root.
-`IntranetUserCSS <#IntranetUserCSS>`__
+.. _intranetusercss-label:
+
+IntranetUserCSS
''''''''''''''''''''''''''''''''''''''
Asks: Include the following CSS on all pages in the staff client
-`IntranetUserJS <#intranetuserjs>`__
+.. _intranetuserjs-label:
+
+IntranetUserJS
''''''''''''''''''''''''''''''''''''
Asks: Include the following JavaScript on all pages in the staff
can be found on the wiki:
http://wiki.koha-community.org/wiki/JQuery_Library.
-`SlipCSS <#SlipCSS>`__
+.. _slipcss-label:
+
+SlipCSS
''''''''''''''''''''''
Asks: Include the stylesheet at \_\_\_ on Issue and Reserve Slips.
set of fonts and colors you can use this preference to point Koha to
a stylesheet specifically for your slips.
-`staffClientBaseURL <#staffClientBaseURL>`__
+.. _staffclientbaseurl-label:
+
+staffClientBaseURL
''''''''''''''''''''''''''''''''''''''''''''
Asks: The staff client is located at http:// \_\_\_
-`template <#template>`__
+.. _template-label:
+
+template
''''''''''''''''''''''''
Default: prog
created using this URL. (example: www.google.com not
www.google.com/)
-`XSLTDetailsDisplay <#XSLTDetailsDisplay>`__
+.. _xsltdetailsdisplay-label:
+
+XSLTDetailsDisplay
''''''''''''''''''''''''''''''''''''''''''''
Default: default
either use the default look that comes with Koha or design your own
stylesheet.
-`XSLTListsDisplay <#XSLTListsDisplay>`__
+.. _xsltlistsdisplay-label:
+
+XSLTListsDisplay
''''''''''''''''''''''''''''''''''''''''
Default: default
either use the default look that comes with Koha or design your own
stylesheet.
-`XSLTResultsDisplay <#XSLTResultsDisplay>`__
+.. _xsltresultsdisplay-label:
+
+XSLTResultsDisplay
''''''''''''''''''''''''''''''''''''''''''''
Default: default
allow you either use the default look that comes with Koha or design
your own stylesheet.
-`Options <#staffoptsprefs>`__
+.. _options-label:
+
+Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`AudioAlerts <#AudioAlerts>`__
+.. _audioalerts-label:
+
+AudioAlerts
''''''''''''''''''''''''''''''
Default: Don't enable
This feature is not supported by all browsers. Requires an HTML5
compliant browser.
-`HidePatronName <#HidePatronName>`__
+.. _hidepatronname-label:
+
+HidePatronName
''''''''''''''''''''''''''''''''''''
Default: Show
- Show
-`intranetbookbag <#intranetbookbag>`__
+.. _intranetbookbag-label:
+
+intranetbookbag
''''''''''''''''''''''''''''''''''''''
Default: Show
- Show
-`IntranetCatalogSearchPulldown <#IntranetCatalogSearchPulldown>`__
+.. _intranetcatalogsearchpulldown-label:
+
+IntranetCatalogSearchPulldown
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- Show
-`StaffDetailItemSelection <#StaffDetailItemSelection>`__
+.. _staffdetailitemselection-label:
+
+StaffDetailItemSelection
''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Enable
Items with the checkboxes enabled
|image121|
-`UseWYSIWYGinSystemPreferences <#UseWYSIWYGinSystemPreferences>`__
+.. _usewysiwyginsystempreferences-label:
+
+UseWYSIWYGinSystemPreferences
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Don't show
- This preference allows you to chang system preferences with HTML in
them to WYSIWYG editors instead of plain text boxes.
-`viewISBD <#viewISBD>`__
+.. _viewisbd-label:
+
+viewISBD
''''''''''''''''''''''''
Default: Allow
- Don't allow
-`viewLabeledMARC <#viewLabeledMARC>`__
+.. _viewlabeledmarc-label:
+
+viewLabeledMARC
''''''''''''''''''''''''''''''''''''''
Default: Allow
- Don't allow
-`viewMARC <#viewMARC>`__
+.. _viewmarc-label:
+
+viewMARC
''''''''''''''''''''''''
Default: Allow
- Don't allow
-`Tools <#toolsprefs>`__
+.. _tools-label:
+
+Tools
~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences > Tools
-`Batch Item <#batchitemprefs>`__
+.. _batch-item-label:
+
+Batch Item
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-These preferences are in reference to the `Batch Item
-Modification <#batchmodifyitems>`__ tool.
+These preferences are in reference to the :ref:`Batch Item
+Modification <batch-item-modification-label>` tool.
+
+.. _maxitemsforbatchdel-label:
-`MaxItemsForBatchDel <#MaxItemsForBatchDel>`__
+MaxItemsForBatchDel
''''''''''''''''''''''''''''''''''''''''
Default: 1000
Description:
-- In the `batch item delete tool <#batchdeleteitems>`__ this will
+- In the :ref:`batch item delete tool <batch-item-deletion-label>` this will
prevent the display of more than the items you entered in this
preference, but you will be able to delete more than the number you
enter here.
-`MaxItemsForBatchMod <#MaxItemsForBatchMod>`__
+.. _maxitemsforbatchmod-label:
+
+MaxItemsForBatchMod
''''''''''''''''''''''''''''''''''''''''
Default: 1000
Description:
-- In the `batch item modification
- tool <#batchmodifyitems>`__ this preference will prevent the editing
+- In the :ref:`batch item modification
+ tool <batch-item-modification-label>` this preference will prevent the editing
of more than the number entered here.
-`News <#newstoolprefs>`__
+.. _news-label:
+
+News
^^^^^^^^^^^^^^^^^^^^^^^^^
-`NewsAuthorDisplay <#NewsAuthorDisplay>`__
+.. _newsauthordisplay-label:
+
+NewsAuthorDisplay
''''''''''''''''''''''''''''''''''''''''''
Default: not at all
- Staff client only
-`Patron Cards <#patcardprefs>`__
+.. _patron-cards-label:
+
+Patron Cards
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-These preferences are in reference to the `Patron Card
-Creator <#patroncardcreator>`__ tool.
+These preferences are in reference to the :ref:`Patron Card
+Creator <patron-card-creator-label>` tool.
-`ImageLimit <#ImageLimit>`__
+.. _imagelimit-label:
+
+ImageLimit
''''''''''''''''''''''''''''
Asks: Limit the number of creator images stored in the database to
\_\_\_ images.
-`Reports <#reportsprefstools>`__
+.. _reports-label:
+
+Reports
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
These preferences are in reference to the Reports module.
-`NumSavedReports <#NumSavedReports>`__
+.. _numsavedreports-label:
+
+NumSavedReports
''''''''''''''''''''''''''''''''''''''
Default: 20
Asks: By default, show \_\_\_ reports on the Saved Reports page.
-`Upload <#uploadprefstools>`__
+.. _upload-label:
+
+Upload
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`UploadPurgeTemporaryFilesDays <#UploadPurgeTemporaryFilesDays>`__
+.. _uploadpurgetemporaryfilesdays-label:
+
+UploadPurgeTemporaryFilesDays
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Default: blank
Asks: Automatically delete temporary uploads older than \_\_\_ days in
cleanup_database cron job.
-`Web Services <#webserviceprefs>`__
+.. _web-services-label:
+
+Web Services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Global System Preferences > Web
Services
-`ILS-DI <#ilsdiprefs>`__
+.. _ils-di-label:
+
+ILS-DI
^^^^^^^^^^^^^^^^^^^^^^^^
-`ILS-DI <#ILS-DI>`__
+.. _ils-di-label:
+
+ILS-DI
''''''''''''''''''''
Default: Disable
- Enable
-`ILS-DI:AuthorizedIPs <#ILS-DIAuthorized_IPs>`__
+.. _ils-di:authorizedips-label:
+
+ILS-DI:AuthorizedIPs
''''''''''''''''''''''''''''''''''''''''''''''''
Asks: \_\_\_ allowed IPs to use the ILS-DI services
-`IdRef <#idrefprefs>`__
+.. _idref-label:
+
+IdRef
^^^^^^^^^^^^^^^^^^^^^^^
-`IdRef <#idref>`__
+.. _idref-label:
+
+IdRef
''''''''''''''''''
Default: Disable
The French Sudoc database should not be confused with the US
Superintendent of Documents (SuDocs) Classification Scheme.
-`OAI-PMH <#oaiprefs>`__
+.. _oai-pmh-label:
+
+OAI-PMH
^^^^^^^^^^^^^^^^^^^^^^^
-`OAI-PMH <#OAI-PMH>`__
+.. _oai-pmh-label:
+
+OAI-PMH
''''''''''''''''''''''
Default: Disable
Learn more about OAI-PMH at: http://www.openarchives.org/pmh/
-`OAI-PMH:archiveID <#OAI-PMHarchiveID>`__
+.. _oai-pmh:archiveid-label:
+
+OAI-PMH:archiveID
'''''''''''''''''''''''''''''''''''''''''
Default: KOHA-OAI-TEST
Asks: Identify records at this site with the prefix \_\_\_ :
-`OAI-PMH:AutoUpdateSets <#OAI-PMHAutoUpdateSets>`__
+.. _oai-pmh:autoupdatesets-label:
+
+OAI-PMH:AutoUpdateSets
'''''''''''''''''''''''''''''''''''''''''''''''''''
Default: Disable
- Enable
-`OAI-PMH:ConfFile <#OAI-PMHConfFile>`__
+.. _oai-pmh:conffile-label:
+
+OAI-PMH:ConfFile
'''''''''''''''''''''''''''''''''''''''
If this preference is left empty, Koha's OAI Server operates in normal
OAI-PMH:ConfFile specify a YAML configuration file which list available
metadata formats and XSL file used to create them from marcxml records.
-For more information, see the `sample conf file <#oaiconfsample>`__ in
+For more information, see the :ref:`sample conf file <sample-oai-conf-file-label>` in
the appendix.
-`OAI-PMH:DeletedRecord <#OAI-PMHDeletedRecord>`__
+.. _oai-pmh:deletedrecord-label:
+
+OAI-PMH:DeletedRecord
'''''''''''''''''''''''''''''''''''''''''''''''''
Default: will never be emptied or truncated (persistent)
- might be emptied or truncated at some point (transient)
-`OAI-PMH:MaxCount <#OAI-PMHMaxCount>`__
+.. _oai-pmh:maxcount-label:
+
+OAI-PMH:MaxCount
'''''''''''''''''''''''''''''''''''''''
Default: 50
harvest the entire records while the ListIdentifier is an abbreviated
form of ListRecords, retrieving only headers rather than records.
-`Reporting <#reportingservice>`__
+.. _reporting-label:
+
+Reporting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-`SvcMaxReportRows <#SvcMaxReportRows>`__
+.. _svcmaxreportrows-label:
+
+SvcMaxReportRows
''''''''''''''''''''''''''''''''''''''''
Default: 10
- This value will be used to limit the number of results returned by
`public reports <#publicreport>`__.
-`Basic Parameters <#basicparams>`__
+.. _basic-parameters-label:
+
+Basic Parameters
-----------------------------------
*Get there:* More > Administration
Configure all 'parameters' in the order they appear.
-`Libraries & Groups <#libsgroups>`__
+.. _libraries-&-groups-label:
+
+Libraries & Groups
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When setting up your Koha system you will want to add information for
Group Lists
|image123|
-`Adding a Library <#addingalibrary>`__
+.. _adding-a-library-label:
+
+Adding a Library
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a new library:
displays to the public and should be a name that makes sense to
your patrons.
- - If you have `groups <#addinglibgroup>`__ set up you can choose
+ - If you have :ref:`groups <adding-a-group-label>` set up you can choose
what group this library belongs to after entering in the code and
name
- **Note**
If you do not fill in this value Koha will use the address
- in the `ReplytoDefault <#ReplytoDefault>`__ preference
+ in the :ref:`ReplytoDefault` preference
- If you'd like you can also enter a different 'Return-Path' email
address. This is the email address that all bounced messages will
- **Note**
If you do not fill in this value Koha will use the address
- in the `ReturnpathDefault <#ReturnpathDefault>`__
+ in the :ref:`ReturnpathDefault`
preference
- If the URL field is populated then the library name will be linked
- **Important**
An IP address is required if you have enabled
- `AutoLocation <#AutoLocation>`__
+ :ref:`AutoLocation`
- Finally, if you have any notes you can put them here. These will
not show in the OPAC
Of the fields listed, only 'Library code' and 'Name' are required
-`Editing/Deleting a Library <#editingalibrary>`__
+.. _editing/deleting-a-library-label:
+
+Editing/Deleting a Library
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You will be unable to delete any library that has patrons or items
You will be unable to edit the 'Library code'
-`Adding a group <#addinglibgroup>`__
+.. _adding-a-group-label:
+
+Adding a group
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a Search Domain or Library Property Group click the 'New Group'
Give the group a 'Category type; of 'searchdomain' and if you would like
the group to show up in the library pull down at the top of the OPAC
(with
-`OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__ set
+:ref:`OpacAddMastheadLibraryPulldown` set
to 'Add') and on the advanced search page you can check the 'Show in
search pulldown' box.
Of the fields on the group form, 'Category code', 'Name', and 'Category
type' are the only required fields
-`Search Domain Groups <#searchdomaingroups>`__
+.. _search-domain-groups-label:
+
+Search Domain Groups
''''''''''''''''''''''''''''''''''''''''''''''
Search Domain Groups allow you to search a group of libraries at the
Library group search on staff client
|image131|
-`Library Property Groups <#libpropertygroups>`__
+.. _library-property-groups-label:
+
+Library Property Groups
''''''''''''''''''''''''''''''''''''''''''''''''
You can assign specific categories to your libraries by adding groups
Groups on the Add/Modify library form
|image133|
-`Item Types <#itemtypeadmin>`__
+.. _item-types-label:
+
+Item Types
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Koha allows you to organize your collection by item types and collection
Item Types
|image134|
-`Adding Item Types <#additemtype>`__
+.. _adding-item-types-label:
+
+Adding Item Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a new item type, simply click the 'New Item Type' button at the
- **Important**
To have your item type images appear in the OPAC you need to
- set `noItemTypeImages <#noItemTypeImages>`__ to 'Show'
+ set :ref:`noItemTypeImages` to 'Show'
- *Get there:*\ More > Administration > Global System Preferences
- > `Admin <#adminprefs>`__
+ > :ref:`Admin <administration-label>`
- For items that you are suppressing from the OPAC you can hide their
item type from being searched in the OPAC
New DVD Item Type
|image139|
-`Editing Item Types <#edititemtype>`__
+.. _editing-item-types-label:
+
+Editing Item Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Each item type has an Edit button beside it. To edit an item simply
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.
-`Deleting Item Types <#deleteitemtype>`__
+.. _deleting-item-types-label:
+
+Deleting Item Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Each item has a Delete button beside it. To delete an item, simply click
Warning when you try to delete an item that is in use
|image140|
-`Authorized Values <#authorizedvalues>`__
+.. _authorized-values-label:
+
+Authorized Values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Authorized values can be used in several areas of Koha. One reason you
- *Get there:* More > Administration > Basic Parameters > Authorized
Values
-`Existing Values <#existingauthvalues>`__
+.. _existing-values-label:
+
+Existing Values
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Koha installs with pre-defined values that your library is likely to
- CART
- Is the shelving cart location, used by
- `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__ and
- `ReturnToShelvingCart <#ReturnToShelvingCart>`__
+ :ref:`InProcessingToShelvingCart` and
+ :ref:`ReturnToShelvingCart`
- CCODE
- PROC
- The location to be used for
- `NewItemsDefaultLocation <#NewItemsDefaultLocation>`__ (change
+ :ref:`NewItemsDefaultLocation` (change
description as desired), also the location expected by
- `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__.
+ :ref:`InProcessingToShelvingCart`.
- REPORT\_GROUP
- SIP\_MEDIA\_TYPE
- - Used when `creating <#additemtype>`__ or
- `editing <#edititemtype>`__ an item type to assign a SIP specific
+ - Used when :ref:`creating <adding-item-types-label>` or
+ :ref:`editing <editing-item-types-label>` an item type to assign a SIP specific
media type for devices like lockers and sorters.
- SUGGEST
- A generic authorized value field that can be used anywhere you
need a simple yes/no pull down menu.
-`Add new Authorized Value Category <#newauthvalcat>`__
+.. _add-new-authorized-value-category-label:
+
+Add new Authorized Value Category
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In addition to the existing categories that come by default with Koha,
- If you have
`StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__
- and/or `AuthorisedValueImages <#AuthorisedValueImages>`__ set to
+ and/or :ref:`AuthorisedValueImages` set to
show images for authorized values you can choose the image under
'Choose an icon'
Custom Authorized Value on list of values
|image145|
-`Add new Authorized Value <#newauthval>`__
+.. _add-new-authorized-value-label:
+
+Add new Authorized Value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New authorized values can be added to any existing or new category. To
- If you have
`StaffAuthorisedValueImages <#StaffAuthorisedValueImages>`__ and/or
- `AuthorisedValueImages <#AuthorisedValueImages>`__ set to show images
+ :ref:`AuthorisedValueImages` set to show images
for authorized values you can choose the image under 'Choose an icon'
- Click 'Save'
List of authorized values in MARC504 category
|image147|
-`Patrons & Circulation <#patscirc>`__
+.. _patrons-&-circulation-label:
+
+Patrons & Circulation
-------------------------------------
Settings for controlling circulation and patron information.
-`Patron Categories <#patcats>`__
+.. _patron-categories-label:
+
+Patron Categories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Patron categories allow you to organize your patrons into different
- Staff
- Librarians (and library workers) should be assigned the staff
- category so that you can `set their
- permissions <#patronpermissions>`__ and give them access to the
+ category so that you can :ref:`set their
+ permissions <patron-permissions-label>` and give them access to the
staff client.
- Organizational
- This patron type is used strictly for statistical purposes, such
as in house use of items.
-`Adding a patron category <#addingpatroncat>`__
+.. _adding-a-patron-category-label:
+
+Adding a patron category
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a new patron category click 'New Category' at the top of the page
- **Important**
This value will only be checked if
- `BorrowerMandatoryField <#BorrowerMandatoryField>`__ defines
+ :ref:`BorrowerMandatoryField` defines
the dateofbirth as a required field on the patron record
- Patron categories can also have a maximum age (in years) associated
- **Important**
This value will only be checked if
- `BorrowerMandatoryField <#BorrowerMandatoryField>`__ defines
+ :ref:`BorrowerMandatoryField` defines
the dateofbirth as a required field on the patron record
- If you charge a membership fee for your patrons (such as those who
- **Note**
Depending on your value for the
- `FeeOnChangePatronCategory <#FeeOnChangePatronCategory>`__
+ :ref:`FeeOnChangePatronCategory`
preference this fee will be charged on patron renewal as well
as when they are first enrolled.
- 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 <#BlockExpiredPatronOpacActions>`__
+ :ref:`BlockExpiredPatronOpacActions`
preferenceBlock expired patrons
- 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 <#OPACPrivacy>`__ system
+ you allow it with the :ref:`OPACPrivacy` system
preference.Default privacy
- Finally you can assign advanced messaging preferences by default to a
- **Important**
Requires that you have
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
enabled
- These defaults will be applied to new patrons that are added to
*misc/maintenance* folder. Ask your system administrator
for assistance with this script.
-`Circulation and Fine Rules <#circfinerules>`__
+.. _circulation-and-fine-rules-label:
+
+Circulation and Fine Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These rules define how your items are circulated, how/when fines are
- default (all libraries), all patron types, all item types
-The `CircControl <#CircControl>`__ and
-`HomeOrHoldingBranch <#HomeOrHoldingBranch>`__ also come in to play when
+The :ref:`CircControl` and
+:ref:`HomeOrHoldingBranch` also come in to play when
figuring out which circulation rule to follow.
- If CircControl is set to "the library you are logged in at" circ
HomeOrHoldingBranch chooses if item's home library is used or holding
library is used.
-- If `IndependentBranches <#IndependentBranches>`__ is set to 'Prevent'
+- If :ref:`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 <#patronpermsdefined>`__.
+ a :ref:`superlibrarian <patron-permissions-defined-label>`.
**Note**
types to avoid this holds issue. Koha needs to know what rule to
fall back on.
-`Default Circulation Rules <#defaultcircrules>`__
+.. _default-circulation-rules-label:
+
+Default Circulation Rules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Using the issuing rules matrix you can define rules that depend on
- 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
-- If you're allowing `OnSiteCheckouts <#OnSiteCheckouts>`__ then you
+- If you're allowing :ref:`OnSiteCheckouts` then you
may also want to set a limit on the number of items patron's can have
onsite.
- **Note**
This setting also depends on the
- `ConsiderOnSiteCheckoutsAsNormalCheckouts <#ConsiderOnSiteCheckoutsAsNormalCheckouts>`__
+ :ref:`ConsiderOnSiteCheckoutsAsNormalCheckouts`
preference
- Define the period of time an item can be checked out to a patron by
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 <#MaxFine>`__ system preference.
+ set using the :ref:`MaxFine` system preference.
- If you would like to prevent overcharging patrons for a lost items,
you can check the box under 'Cap fine at replacement price.' This
number in units (days/hours) entered in this box.
- To control this value on a more granular level please set the
- `NoRenewalBeforePrecision <#NoRenewalBeforePrecision>`__
+ :ref:`NoRenewalBeforePrecision`
preference.
- You can enable automatic renewals for certain items/patrons if you'd
- **Important**
- You will need to enable the `automatic renewal cron
- job <#autorenewcron>`__ for this to work.
+ You will need to enable the :ref:`automatic renewal cron
+ job <automatic-renewal-label>` for this to work.
- **Important**
Circulation & Fine Rules Successfully Cloned Message
|image160|
-`Default Checkouts and Hold Policy <#defaultcheckoutpolicy>`__
+.. _default-checkouts-and-hold-policy-label:
+
+Default Checkouts and Hold Policy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can set a default maximum number of checkouts and hold policy that
- In 'Total current on-site checkouts allowed' enter the total number
of items patrons can have checked out on site at a time
- (`OnSiteCheckouts <#OnSiteCheckouts>`__ needs to be set to 'Enable')
+ (:ref:`OnSiteCheckouts` needs to be set to 'Enable')
- Control where patrons can place holds from using the 'Hold Policy'
menu
- Once your policy is set, you can unset it by clicking the 'Unset'
link to the right of the rule
-`Checkouts Per Patron <#checkoutperpatron>`__
+.. _checkouts-per-patron-label:
+
+Checkouts Per Patron
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For this library, you can specify the maximum number of loans that a
12 here and the patron has 10 books out already they will only be
allowed 2 DVDs to equal the 12 total they're allowed.
-`Item Hold Policies <#holdpolicies>`__
+.. _item-hold-policies-label:
+
+Item Hold Policies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For this library, you can edit hold and return policies for a given item
**Important**
Note that if the system preference
- `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__ set to
+ :ref:`AllowHoldPolicyOverride` set to
'allow', these policies can be overridden by your circulation staff.
**Important**
- **Important**
- If the `AutomaticItemReturn <#AutomaticItemReturn>`__
+ If the :ref:`AutomaticItemReturn`
preference is set to automatically transfer the items home,
then a prompt will not appear
- **Important**
- If the `AutomaticItemReturn <#AutomaticItemReturn>`__
+ If the :ref:`AutomaticItemReturn`
preference is set to automatically transfer the items home,
then a prompt will not appear
item types from this form. This is also how you can set up floating item
types and types that remain with their home library.
-`Patron Attribute Types <#patronattributetypes>`__
+.. _patron-attribute-types-label:
+
+Patron Attribute Types
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 <#ExtendedPatronAttributes>`__
+need to set the :ref:`ExtendedPatronAttributes`
system preference.
- *Get there:* More > Administration > Patrons & Circulation > Patron
List of Patron Attributes
|image164|
-`Adding Patron Attributes <#addpatattributes>`__
+.. _adding-patron-attributes-label:
+
+Adding Patron Attributes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a new Patron Attribute Type, click the 'New Patron Attribute
identifier which means, if a value is given to a patron record, the
same value cannot be given to a different record.
- - Unique attributes can be used as match points on the `patron
- import tool <#patronimport>`__
+ - Unique attributes can be used as match points on the :ref:`patron
+ import tool <patron-import-label>`
- **Important**
appear in this menu
- *Get there:*\ More > Administration > Basic Parameters >
- `Authorized Values <#authorizedvalues>`__
+ :ref:`Authorized Values`
- **Important**
- 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 <#authorizedvalues>`__ for PA\_CLASS it will show
+ :ref:`Authorized Value <authorized-values-label>` for PA\_CLASS it will show
in the 'Class' pull down and you can then change your attributes page
to have sections of attributes
Grouped Attributes
|image169|
-`Editing/Deleting Patron Attributes <#editpatattributes>`__
+.. _editing/deleting-patron-attributes-label:
+
+Editing/Deleting Patron Attributes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Each patron attribute has an edit and a delete link beside it on the
Warning when trying to delete an attribute that is in use
|image170|
-`Library Transfer Limits <#libtransferlimits>`__
+.. _library-transfer-limits-label:
+
+Library Transfer Limits
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Limit the ability to transfer items between libraries based on the
Transfer Limits
These rules only go into effect if the preference
-`UseBranchTransferLimits <#UseBranchTransferLimits>`__ is set to
+:ref:`UseBranchTransferLimits <usebranchtransferlimits-&-branchtransferlimitstype-label>` is set to
'enforce'.
Before you begin you will want to choose which library you are setting
|image171|
Transfer limits are set based on the collections codes you have applied
-via the `Authorized Value <#authorizedvalues>`__ administration area.
+via the :ref:`Authorized Value <authorized-values-label>` administration area.
Collection Code values assigned in the Authorized Value area
|image172|
In the above example, Centerville library will allow patrons to return
items from all libraries except Liberty and Franklin to their branch.
-`Transport cost matrix <#transportcostmatrix>`__
+.. _transport-cost-matrix-label:
+
+Transport cost matrix
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 <#UseTransportCostMatrix>`__ preference to
+:ref:`UseTransportCostMatrix` preference to
'Use'.
**Important**
The Transport cost matrix takes precedence in controlling where
holds are filled from, if the matrix is not used then Koha checks
- the `StaticHoldsQueueWeight <#holdqueueweight>`__.
+ the :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
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
put a number in there ( even if you choose to disable that given
To/From option ).
-`Item Circulation Alerts <#itemcircalerts>`__
+.. _item-circulation-alerts-label:
+
+Item Circulation Alerts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Libraries can decide if they want to have patrons automatically notified
- In the above example, Juveniles and Kids will not receive check
out notices.
-`Cities and Towns <#citytowns>`__
+.. _cities-and-towns-label:
+
+Cities and Towns
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To standardize patron input you can define cities or towns within your
- *Get there:* More > Administration > Patrons & Circulation > Cities
and Towns
-`Adding a City <#addingcity>`__
+.. _adding-a-city-label:
+
+Adding a City
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a new city, click the 'New City' button at the top of the page
Cities can be edited or deleted at any time.
-`Viewing Cities on Patron Add Form <#citiesonpatform>`__
+.. _viewing-cities-on-patron-add-form-label:
+
+Viewing Cities on Patron Add Form
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have defined local cities using the New city form, then when
This will allow for easy entry of local cities into the patron record
without risking the potential for typos or mistaken zip/postal codes.
-`Catalog Administration <#catadmin>`__
+.. _catalog-administration-label:
+
+Catalog Administration
--------------------------------------
Set these controls before you start cataloging on your Koha system.
- *Get there:* More > Administration > Catalog
-`MARC Bibliographic Frameworks <#marcbibframeworks>`__
+.. _marc-bibliographic-frameworks-label:
+
+MARC Bibliographic Frameworks
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Think of Frameworks as templates for creating new bibliographic records.
Pagination options
|image182|
-`Add New Framework <#addframework>`__
+.. _add-new-framework-label:
+
+Add New Framework
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a new framework
off of, this will make it easier than starting from scratch
- Once your Framework appears on the screen you can edit or delete each
- field by following the instructions for `editing
- subfields <#editsubfields>`__
+ field by following the instructions for :ref:`editing
+ subfields <edit-framework-subfields-label>`
-`Edit Existing Frameworks <#editframeworks>`__
+.. _edit-existing-frameworks-label:
+
+Edit Existing Frameworks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Clicking 'Edit' to the right of a Framework will only allow you to edit
|image185|
To make edits to the fields associated with the Framework you must first
-click 'MARC Structure' and then follow the instructions for `editing
-subfields <#editsubfields>`__
+click 'MARC Structure' and then follow the instructions for :ref:`editing
+subfields <edit-framework-subfields-label>`
+
+.. _add-subfields-to-frameworks-label:
-`Add subfields to Frameworks <#addsubfieldsframework>`__
+Add subfields to Frameworks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a field to a Framework click the 'New Tag' button at the top of
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 <#editsubfields>`__
+those found in the :ref:`editing subfields in frameworks <edit-framework-subfields-label>`
section of this manual.
-`Edit Framework Subfields <#editsubfields>`__
+.. _edit-framework-subfields-label:
+
+Edit Framework Subfields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Frameworks are made up of MARC fields and subfields. To make edits to
- Each field has a tag (which is the MARC tag) that is uneditable
- The 'Label for lib' is what will show in the staff client if you
- have `advancedMARCeditor <#advancedMARCeditor>`__ set to display
+ have :ref:`advancedMARCeditor` set to display
labels
- The 'Label for OPAC' is what will show on the MARC view in the
- If you check 'Mandatory' the record will not be allowed to save
unless you have a value assigned to this tag
- - 'Authorized value' is where you define an `authorized
- value <#authorizedvalues>`__ that your catalogers can choose from
+ - 'Authorized value' is where you define an :ref:`authorized
+ value <authorized-values-label>` that your catalogers can choose from
a pull down to fill this field in
To edit the subfields associated with the tag, click 'Subfields' to the
- Authorized value
- means the value cannot by typed by the librarian, but must be
- chosen from a pull down generated by the `authorized
- value <#authorizedvalues>`__ list
+ chosen from a pull down generated by the :ref:`authorized
+ value <authorized-values-label>` list
- In the example above, the 504a field will show the MARC504
Authorized Values when cataloging
browser next to the the call number subfield so that you can
identify which call numbers are in use and which are not.
Simply choose the cn\_browser.pl plugin. Learn more in the
- `cataloging section <#addingitems>`__ of this manual.
+ :ref:`cataloging section <adding-items-label>` of this manual.
- If you'd like to let file uploads via cataloging you can
choose the upload.pl plugin and this will allow you to
- `upload files to Koha to link to your
- records <#uploadbibfile>`__.
+ :ref:`upload files to Koha to link to your
+ records <attaching-files-to-records-label>`.
- In UNIMARC there are plugins for every 1xx fields that are
coded fields. The plugin is a huge help for cataloger! There
- To save your changes simply click the 'Save Changes' button at the
top of the screen
-`Import/Export Frameworks <#importexportframeworks>`__
+.. _import/export-frameworks-label:
+
+Import/Export Frameworks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Next to each framework is a link to either import or export the
framework.
-`Export Framework <#exportframeworks>`__
+.. _export-framework-label:
+
+Export Framework
''''''''''''''''''''''''''''''''''''''''
To export a framework simply click the 'Export' link to the right of
A framework exported this way can be imported into any other Koha
installation using the import framework option.
-`Import Framework <#importframeworks>`__
+.. _import-framework-label:
+
+Import Framework
''''''''''''''''''''''''''''''''''''''''
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 <#exportframeworks>`__ to be available for import here.
+from the other system :ref:`using the instructions
+above <export-framework-label>` to be available for import here.
-To import a framework you first need to create `a new
-framework <#addframework>`__. Once you have that framework, click
+To import a framework you first need to create :ref:`a new
+framework <add-new-framework-label>`. Once you have that framework, click
'Import' to the right of the new framework.
Import link next to framework
tool where you can make any changes you need to the framework you
imported.
-`Koha to MARC Mapping <#kohamarcmapping>`__
+.. _koha-to-marc-mapping-label:
+
+Koha to MARC Mapping
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
While Koha stores the entire MARC record, it also stores common fields
means that you won't be able to map both the 100a and the 700a to
the author field, you need to choose one or the other.
-`Keywords to MARC Mapping <#keywordmapping>`__
+.. _keywords-to-marc-mapping-label:
+
+Keywords to MARC Mapping
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This tool will allow you to map MARC fields to a set of predefined
will use the subtitle field.
Using the Framework pull down menu, choose the
-`Framework <#marcbibframeworks>`__ you would like to apply this rule to.
+:ref:`Framework <marc-bibliographic-frameworks-label>` you would like to apply this rule to.
For example, the subtitle for books can be found in the 245$b field.
Assigning Book Subtitle
Future developments will include additional keyword assigned fields.
-`MARC Bibliographic Framework Test <#marcbibframeworkstest>`__
+.. _marc-bibliographic-framework-test-label:
+
+MARC Bibliographic Framework Test
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Checks the MARC structure.
Framework Test
|image206|
-`Authority Types <#authoritiesadmin>`__
+.. _authority-types-label:
+
+Authority Types
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Authority Types are basically MARC Frameworks for Authority records and
-because of that they follow the same editing rules found in the `MARC
-Bibliographic Frameworks <#marcbibframeworks>`__ section of this manual.
+because of that they follow the same editing rules found in the :ref:`MARC
+Bibliographic Frameworks <marc-bibliographic-frameworks-label>` section of this manual.
Koha comes with many of the necessary Authority frameworks already
installed. To learn how to add and edit Authority Types, simply review
-the `MARC Bibliographic Frameworks <#marcbibframeworks>`__ section of
+the :ref:`MARC Bibliographic Frameworks` section of
this manual.
- *Get there:* More > Administration > Catalog > Authority Types
-`Classification Sources <#classificationsources>`__
+.. _classification-sources-label:
+
+Classification Sources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Source of classification or shelving scheme is an `Authorized
-Values <#authorizedvalues>`__ category that is mapped to field 952$2 and
+Source of classification or shelving scheme is an :ref:`Authorized
+Values <authorized-values-label>` category that is mapped to field 952$2 and
942$2 in Koha's MARC Bibliographic frameworks and stored in the
items.cn\_source field in the database.
- Other/Generic Classification
-`Adding/Editing Classification Sources <#addingclasssource>`__
+.. _adding/editing-classification-sources-label:
+
+Adding/Editing Classification Sources
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can add your own source of classification by using the New
- Check the 'Source in use?' checkbox if you want the value to appear
in the drop down list for this category.
-- Select the appropriate `filing rule <#classfilingrules>`__ from the
+- Select the appropriate :ref:`filing rule <classification-filing-rules-label>` from the
drop down list.
-`Classification Filing Rules <#classfilingrules>`__
+.. _classification-filing-rules-label:
+
+Classification Filing Rules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Filing rules determine the order in which items are placed on shelves.
- Generic
-Filing rules are mapped to `Classification
-sources <#addingclasssource>`__. You can setup new filing rules by using
+Filing rules are mapped to :ref:`Classification
+sources <adding/editing-classification-sources-label>`. You can setup new filing rules by using
the New Filing Rule button. To edit use the Edit link.
When creating or editing:
- Choose an appropriate filing routine - dewey, generic or lcc
-`Record Matching Rules <#recordmatchingrules>`__
+.. _record-matching-rules-label:
+
+Record Matching Rules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Record matching rules are used when importing MARC records into Koha.
- *Get there:* More > Administration > Catalog > Record Matching Rules
-The rules that you set up here will be referenced with you `Stage MARC
-Records for Import <#stagemarc>`__.
+The rules that you set up here will be referenced with you :ref:`Stage MARC
+Records for Import <stage-marc-records-for-import-label>`.
It is important to understand the difference between Match Points and
Match Checks before adding new matching rules to Koha.
Table: Authority Indexes
-`Adding Matching Rules <#addrecordmatchrule>`__
+.. _adding-matching-rules-label:
+
+Adding Matching Rules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To create a new matching rule :
- 'Required match checks' - ??
-`Sample Bibliographic Record Matching Rule: Control Number <#samplerecordmatch>`__
+.. _sample-bibliographic-record-matching-rule:-control-number-label:
+
+Sample Bibliographic Record Matching Rule: Control Number
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
LOC Matching Rule
Remove match check
|image211|
-`OAI Sets Configuration <#oaisetsconfig>`__
+.. _oai-sets-configuration-label:
+
+OAI Sets Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
On this page you can create, modify and delete OAI-PMH sets
-`Create a set <#oaicreate>`__
+.. _create-a-set-label:
+
+Create a set
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To create a set:
- Click on 'Save' button'
-`Modify/Delete a set <#oaimodify>`__
+.. _modify/delete-a-set-label:
+
+Modify/Delete a set
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To modify a set, just click on the link 'Modify' on the same line of the
To delete a set, just click on the link 'Delete' on the same line of the
set you want to delete.
-`Define mappings <#oaimapping>`__
+.. _define-mappings-label:
+
+Define mappings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Here you can define how a set will be build (what records will belong to
And it is case sensitive : a record having 999$9 = 'xxx' will not belong
to a set where condition is 999$9 = 'XXX'.
-`Build sets <#oaibuild>`__
+.. _build-sets-label:
+
+Build sets
^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
-`Item search fields <#itemsearchadmin>`__
+.. _item-search-fields-label:
+
+Item search fields
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From here you can add custom search fields to the `item
-search <#searchguide-itemsearch>`__ option in the staff client. Item
+From here you can add custom search fields to the :ref:`item
+search <item-searching-label>` option in the staff client. Item
search fields
To add a new search term simply click the 'New search field' buttonAdd
Once your new field is added it will be visible at the top of this page
and on the item search pageSearch option
-`Acquisitions <#acqadmin>`__
+.. _acquisitions-label:
+
+Acquisitions
----------------------------
The Koha Acquisitions module provides a way for the library to record
- *Get there:* More > Administration > Acquisitions
-`Currencies and Exchange Rates <#currexchangeadmin>`__
+.. _currencies-and-exchange-rates-label:
+
+Currencies and Exchange Rates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you place orders from more than one country you will want to input
No active currency warning
|image213|
-`Budgets <#budgetplanning>`__
+.. _budgets-label:
+
+Budgets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 <#funds>`__ for different areas of the
+and then break that into :ref:`Funds` for different areas of the
library (ex. Books, Audio, etc).
- *Get there:* More > Administration > Acquisitions > Budgets
Budgets List
|image214|
-`Adding budgets <#addbudget>`__
+.. _adding-budgets-label:
+
+Adding budgets
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Budgets can either be created `from scratch <#addnewbudget>`__, by
-`duplicating the previous year's budget <#duplicatebudget>`__ or by
-`closing a previous year's budget <#closebudget>`__.
+Budgets can either be created :ref:`from scratch <add-a-new-budget-label>`, by
+:ref:`duplicating the previous year's budget <duplicate-a-budget-label>` or by
+:ref:`closing a previous year's budget <close-a-budget-label>`.
-`Add a new budget <#addnewbudget>`__
+.. _add-a-new-budget-label:
+
+Add a new budget
''''''''''''''''''''''''''''''''''''
If you haven't used Koha before for acquisitions then you'll need to
List of Budgets
|image216|
-`Duplicate a budget <#duplicatebudget>`__
+.. _duplicate-a-budget-label:
+
+Duplicate a budget
'''''''''''''''''''''''''''''''''''''''''
To duplicate a budget from a previous year, click on the link for the
year to year and so that you can move unreceived orders and if desired
unspent funds from a previous budget to the new budget.
-`Close a budget <#closebudget>`__
+.. _close-a-budget-label:
+
+Close a budget
'''''''''''''''''''''''''''''''''
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 <#duplicatebudget>`__ so that you have somewhere for the
+your budget you might want to :ref:`duplicate the previous year's
+budget <duplicate-a-budget-label>` so that you have somewhere for the
unreceived orders to roll to.
Find the previous budget with unreceived orders on the Active budgets or
Close report
|image220|
-`Funds <#funds>`__
+.. _funds-label:
+
+Funds
~~~~~~~~~~~~~~~~~~
- *Get there:* More > Administration > Acquisitions > Funds
-`Add a Fund <#addbudgetfund>`__
+.. _add-a-fund-label:
+
+Add a Fund
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A fund is added to a budget.
**Important**
- A `budget <#addbudget>`__ must be defined before a fund can be
+ A :ref:`budget <adding-budgets-label>` must be defined before a fund can be
created.
To add a new fund click the New button and then choose which Budget you
option from the dropdown lists for the Statiscal 1 done on: and
Statistical 2 done on: fields.
-- To learn more about planning categories, check out the `Planning Category
- FAQ <#planningcatfaq>`__.
+- To learn more about planning categories, check out the :ref:`Planning Category
+ FAQ <planning-categories-label>`.
When complete, click 'Submit' and you will be brought to a list of all
of the funds for the budget.
Child funds
|image226|
-`Budget Planning <#fundsplanning>`__
+.. _budget-planning-label:
+
+Budget Planning
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When viewing the list of funds click the 'Planning' button and choose
Export planning as CSV
|image231|
-`EDI Accounts <#ediaccounts>`__
+.. _edi-accounts-label:
+
+EDI Accounts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
From here you can set up the information needed to connect to your
**Note**
- Before you begin you will need at least one `Vendor set up in
- Acquisitions <#addacqvendor>`__.
+ Before you begin you will need at least one :ref:`Vendor set up in
+ Acquisitions <add-a-vendor-label>`.
To add account information click the 'New account' button.New account
Each vendor will have one account.
-`Library EANs <#libraryeans>`__
+.. _library-eans-label:
+
+Library EANs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A library EAN is the identifier the vendor gives the library to send
New EAN Form
-`Additional Parameters <#additionaladmin>`__
+.. _additional-parameters-label:
+
+Additional Parameters
--------------------------------------------
- *Get there:* More > Administration > Additional Parameters
-`Z39.50/SRU servers <#z3950admin>`__
+.. _z39.50/sru-servers-label:
+
+Z39.50/SRU servers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Z39.50 is a client–server protocol for searching and retrieving
`http://irspy.indexdata.com <http://irspy.indexdata.com/>`__ or the
Library of Congress's List of Targets http://www.loc.gov/z3950/
-`Add a Z39.50 Target <#addztarget>`__
+.. _add-a-z39.50-target-label:
+
+Add a Z39.50 Target
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- From the main Z39.50 page, click 'New Z39.50 Server'
- Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
(UNIMARC)
-`Suggested Bibliographic Z39.50 Targets <#suggestztarget>`__
+.. _suggested-bibliographic-z39.50-targets-label:
+
+Suggested Bibliographic Z39.50 Targets
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Koha libraries with open Z39.50 targets can share and find connection
- VANCOUVER PUBLIC LIBRARY z3950.vpl.ca:210 Horizon
-`Suggested Authority Z39.50 Targets <#suggestauthz39>`__
+.. _suggested-authority-z39.50-targets-label:
+
+Suggested Authority Z39.50 Targets
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following targets have been used successfully by other Koha
- LIBRARY OF CONGRESS SUBJECT AUTHORITIES lx2.loc.gov:210 SAF
-`Add a SRU Target <#addsru>`__
+.. _add-a-sru-target-label:
+
+Add a SRU Target
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- From the main Z39.50/SRU page, click 'New SRU Server'
- Del9LinksExcept995.xsl: Remove $9 links. Skip item fields
(UNIMARC)
-`Did you mean? <#didyoumean>`__
+.. _did-you-mean?-label:
+
+Did you mean?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Get there:* More > Administration > Additional Parameters > Did you
mean?
Koha can offer 'Did you mean?' options on searches based on values in
-your `authorities <#catauthorities>`__.
+your :ref:`authorities <authorities-label>`.
**Important**
AuthorityFile
|image238|
-`Column settings <#admincolumns>`__
+.. _column-settings-label:
+
+Column settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This administration area will help you hide or display columns on fixed
Toggle columns
|image244|
-`Audio alerts <#audioadmin>`__
+.. _audio-alerts-label:
+
+Audio alerts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you have your `AudioAlerts <#AudioAlerts>`__ preference set to
+If you have your :ref:`AudioAlerts` preference set to
'Enable' you will be able to control the various alert sounds that Koha
uses from this area.
Any ID selector (where html contains id="name\_of\_id" ) and can also be
a trigger as: #name\_of\_selector
-`SMS cellular providers <#smsadmin>`__
+.. _sms-cellular-providers-label:
+
+SMS cellular providers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Important**
This option will only appear if the
- `SMSSendDriver <#SMSSendDriver>`__ preference is set to 'Email'
+ :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference is set to 'Email'
From here you can enter as many cellular providers as you need to send
SMS notices to your patrons using the email protocol.SMS Providers
to save.Add SMS Provider
These options will appear in the OPAC for patrons to choose from on the
-`messaging tab <#opacmymsgs>`__ if you have
-`EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+:ref:`messaging tab <my-messaging-label>` if you have
+:ref:`EnhancedMessagingPreferences`
enabled.Options for providers in the OPAC
- *Get there:* More > Tools
-`Patrons and Circulation <#patrontools>`__
+.. _patrons-and-circulation-label:
+
+Patrons and Circulation
------------------------------------------
-`Patron lists <#patronlists>`__
+.. _patron-lists-label:
+
+Patron lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Patron lists
Patron lists are a way to store a group of patrons for easy modification
-via the `batch patron modification tool <#batchpatronmod>`__ or
+via the :ref:`batch patron modification tool <batch-patron-modification-label>` or
reporting.
Patron lists
List of patrons
|image250|
-`Comments <#comments>`__
+.. _comments-label:
+
+Comments
~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Comments
Approved comments
|image254|
-`Patron Import <#patronimport>`__
+.. _patron-import-label:
+
+Patron Import
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Import Patrons
It is commonly used in universities and schools when a new batch of
students registers.
-`Creating Patron File <#createpatronfile>`__
+.. _creating-patron-file-label:
+
+Creating Patron File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your Koha installation comes with a blank CSV file that you can use as a
**Important**
- Date formats should match your `system preference <#dateformat>`__,
+ Date formats should match your :ref:`system preference <dateformat-label>`,
and must be zero-padded, e.g. '01/02/2008'.
**Important**
The fields 'branchcode', 'categorycode' and all fields you have
- defined in the `BorrowerMandatoryField <#BorrowerMandatoryField>`__
+ defined in the :ref:`BorrowerMandatoryField`
preference are required and must match valid entries in your
database.
**Note**
- If loading `patron attributes <#patronattributetypes>`__, the
+ If loading :ref:`patron attributes <patron-attribute-types-label>`, the
'patron\_attributes' field should contain a comma-separated list of
attribute types and values.
the input file replace all of the attribute values of any type
that were previously assigned to the patron record.
-`Importing Patrons <#importpatrons>`__
+.. _importing-patrons-label:
+
+Importing Patrons
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once you have created your file, you can use the Patron Import Tool to
whether to add your values to existing values or erase existing
values and enter only your new values.
-`Notices & Slips <#notices>`__
+.. _notices-&-slips-label:
+
+Notices & Slips
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Notices & Slips
you will see the notices for all libraries.
If you have a style you'd like applied to all slips you can point the
-`SlipCSS <#SlipCSS>`__ preference to a stylesheet. The same is true for
-notices, using the `NoticeCSS <#NoticeCSS>`__ preference to define a
+:ref:`SlipCSS` preference to a stylesheet. The same is true for
+notices, using the :ref:`NoticeCSS` preference to define a
stylesheet.
-You will also want to review the `Notices & Slips Field
-Guide <#noticesfieldguide>`__ for more information on formatting these
+You will also want to review the :ref:`Notices & Slips Field
+Guide <field-guide-for-notices-&-slips-label>` for more information on formatting these
notices.
-`Adding Notices & Slips <#addnotices>`__
+.. _adding-notices-&-slips-label:
+
+Adding Notices & Slips
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a new notice or slip
- **Important**
Not all notices can be branch specific for more information
- review the `Notices & Slips Field
- Guide <#noticesfieldguide>`__ in this manual.
+ review the :ref:`Notices & Slips Field
+ Guide <field-guide-for-notices-&-slips-label>` in this manual.
- Choose the module this notice is related to
With overdue notices, be sure to put your branch name in the
description as well so that it will be visible when setting up
- your `triggers <#noticetriggers>`__.
+ your :ref:`triggers <overdue-notice/status-triggers-label>`.
- Next you can customize the notice for every possible delivery method
notice
- If you're using the
- `TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
+ :ref:`TalkingTechItivaPhoneNotification`
service you can set up a Phone notificationNew Phone notice
- If you plan on printing this notice you can set the Print template
nextNew Print notice
- If you have enabled SMS notices with the
- `SMSSendDriver <#SMSSendDriver>`__ preference you can set the text
+ :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference you can set the text
for your SMS notices nextNew SMS notice
- Each notice offers you the same options
- **Note**
- Review the `Notices & Slip Field
- Guide <#noticesfieldguide>`__ for info on what fields can
+ Review the :ref:`Notices & Slip Field
+ Guide <field-guide-for-notices-&-slips-label>` for info on what fields can
be used here.
- **Important**
Overdue notices can use <<items.content>> tags by
themselves, or use <item></item> to span all of the tags.
- Learn more about the `Overdue Notice
- Markup <#noticemarkup>`__
+ Learn more about the :ref:`Overdue Notice
+ Markup <overdue-notice-markup-label>`
- On overdue notices make sure to use <<items.content>>
tags to print out the data related to all items that are
slips or notice you can enter data in the Other name or
Initials field for each patron and use that value instead.
-`Overdue Notice Markup <#noticemarkup>`__
+.. _overdue-notice-markup-label:
+
+Overdue Notice Markup
'''''''''''''''''''''''''''''''''''''''''
When creating your overdue notices there are two tags in addition to the
various database fields that you can use in your notices. You will also
-want to review the `Notices & Slips Field Guide <#noticesfieldguide>`__
+want to review the :ref:`Notices & Slips Field Guide <field-guide-for-notices-&-slips-label>`
for information on formatting item information in these notices.
**Important**
"A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: 3.50
"History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: 3.50
-`Existing Notices & Slips <#existingnotices>`__
+.. _existing-notices-&-slips-label:
+
+Existing Notices & Slips
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Among the default notices are notices for several common actions within
Koha. All of these notices can be customized by altering their text via
the Notices & Slips tool and their style using the
-`NoticeCSS <#NoticeCSS>`__ preference to define a stylesheet. You will
-also want to review the `Notices & Slips Field
-Guide <#noticesfieldguide>`__ for information on formatting item
+:ref:`NoticeCSS` preference to define a stylesheet. You will
+also want to review the :ref:`Notices & Slips Field
+Guide <field-guide-for-notices-&-slips-label>` for information on formatting item
information in these notices. Here are some of what those notices do:
- ACCTDETAILS
- Sent to patrons when their account is set up if the
- `AutoEmailOPACUser <#AutoEmailOPACUser>`__ preference is set to
+ :ref:`AutoEmailOPACUser <autoemailopacuser-label>` preference is set to
'Send'
- ACQCLAIM (Acquisition Claim)
- This notice is used if two criteria are met:
1. The
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
is set to 'Allow'
2. The patron has requested to receive this notice
- *Get there:*\ OPAC > Login > my messaging
- *Get there:*\ Staff Client > Patron Record >
- `Notices <#patnotices>`__
+ :ref:`Notices`
- CHECKOUT
- This notice is used if two criteria are met:
1. The
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
is set to 'Allow'
2. The patron has requested to receive this notice
- *Get there:*\ OPAC > Login > my messaging
- *Get there:*\ Staff Client > Patron Record >
- `Notices <#patnotices>`__
+ :ref:`Notices`
- DUE
- This notice is used if two criteria are met:
1. The
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
is set to 'Allow'
2. The patron has requested to receive this notice
- *Get there:*\ OPAC > Login > my messaging
- *Get there:*\ Staff Client > Patron Record >
- `Notices <#patnotices>`__
+ :ref:`Notices`
- DUEDGST
- This notice is used if two criteria are met:
1. The
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
is set to 'Allow'
2. The patron has requested to receive this notice as a digest
- *Get there:*\ OPAC > Login > my messaging
- *Get there:*\ Staff Client > Patron Record >
- `Notices <#patnotices>`__
+ :ref:`Notices`
- HOLD (Hold Available for Pickup)
- This notice is used if two criteria are met:
1. The
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
is set to 'Allow'
2. The patron has requested to receive this notice
- *Get there:*\ OPAC > Login > my messaging
- *Get there:*\ Staff Client > Patron Record >
- `Notices <#patnotices>`__
+ :ref:`Notices`
- When this notice references the branches table it is referring to
the pickup branch information.
placed)
- This notice requires the
- `emailLibrarianWhenHoldIsPlaced <#emailLibrarianWhenHoldIsPlaced>`__
+ :ref:`emailLibrarianWhenHoldIsPlaced`
system preference to be set to 'Enable'
- When this notice references the branches table it is referring to
are expiring soon.
- Requires that you have the
- `MembershipExpiryDaysNotice <#MembershipExpiryDaysNotice>`__ set
- and the `related cron job <#patronexpirycron>`__ set.
+ :ref:`MembershipExpiryDaysNotice` set
+ and the :ref:`related cron job <notify-patrons-of-expiration-label>` set.
- ODUE (Overdue Notice)
- See a `Sample Overdue Notice <#samplenotice>`__
- - Requires that you set `Overdue Notice/Status
- Triggers <#noticetriggers>`__
+ - Requires that you set :ref:`Overdue Notice/Status
+ Triggers <overdue-notice/status-triggers-label>`
- PREDUE
- This notice is used if two criteria are met:
1. The
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
is set to 'Allow'
2. The patron has requested to receive this notice
- *Get there:*\ OPAC > Login > my messaging
- *Get there:*\ Staff Client > Patron Record >
- `Notices <#patnotices>`__
+ :ref:`Notices`
- PREDUEDGST
- This notice is used if two criteria are met:
1. The
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
is set to 'Allow'
2. The patron has requested to receive this notice as a digest
- *Get there:*\ OPAC > Login > my messaging
- *Get there:*\ Staff Client > Patron Record >
- `Notices <#patnotices>`__
+ :ref:`Notices`
- RENEWAL
- This notice is used if three criteria are met:
1. The
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__
+ :ref:`EnhancedMessagingPreferences`
is set to 'Allow'
- 2. The `RenewalSendNotice <#RenewalSendNotice>`__ preference is
+ 2. The :ref:`RenewalSendNotice` preference is
set to 'Send'
3. The patron has requested to receive the checkout notice
- *Get there:*\ OPAC > Login > my messaging
- *Get there:*\ Staff Client > Patron Record >
- `Notices <#patnotices>`__
+ :ref:`Notices`
- RLIST (Routing List)
- Used in the serials module to notify patrons/staff of new issues
of a serial
- - *Get there:* More > Serials > `New
- Subscription <#newsubscription>`__
+ - *Get there:* More > Serials > :ref:`New
+ Subscription <add-a-subscription-label>`
- You have the option to select the 'Routing List' notice when
creating a new subscription (Choose from the 'Patron notification'
shared list.
- Requires that you set
- `OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
+ :ref:`OpacAllowSharingPrivateLists`
to 'Allow'
- SHARE\_INVITE
list with them.
- Requires that you set
- `OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
+ :ref:`OpacAllowSharingPrivateLists`
to 'Allow'
- TO\_PROCESS
moved to the fund they manage
- Requires the
- `notice\_unprocessed\_suggestions <#emailsuggestfund>`__ cron job
+ :ref:`notice\_unprocessed\_suggestions <email-suggestions-to-process-label>` cron job
There are also a set of predefined slips (or receipts) listed on this
page. All of these slips can be customized by altering their text via
the Notices & Slips tool and their style using the
-`SlipCSS <#SlipCSS>`__ preference to define a stylesheet. Here is what
+:ref:`SlipCSS` preference to define a stylesheet. Here is what
those slips are used for:
- ISSUEQSLIP
- The transfer slip is printed when you confirm a transfer from one
branch to another in your system
-`Overdue Notice/Status Triggers <#noticetriggers>`__
+.. _overdue-notice/status-triggers-label:
+
+Overdue Notice/Status Triggers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Overdue
Notice/Status Triggers
In order to send the overdue notices that you defined using the
-`Notices <#notices>`__ tool, you need to first set the triggers to have
+:ref:`Notices <notices-&-slips-label>` tool, you need to first set the triggers to have
these messages.
**Important**
In order to have overdue notices sent to your patrons, you need to
- `set that patron category <#addingpatroncat>`__ to require overdue
+ :ref:`set that patron category <adding-a-patron-category-label>` to require overdue
notices.
**Important**
Depending on the value of your
- `OverdueNoticeCalendar <#OverdueNoticeCalendar>`__ preference the
+ :ref:`OverdueNoticeCalendar` preference the
delay may or may not include days the library is closed based on the
- `holiday calendar <#calholidays>`__.
+ :ref:`holiday calendar <calendar-label>`.
The Overdue Notice/Status Triggers tool gives the librarian the power to
send up to three notices to each patron type notifying them of overdue
- If you choose to restrict a patron in this way you can also have
Koha automatically remove that restriction with the
- `AutoRemoveOverduesRestrictions <#AutoRemoveOverduesRestrictions>`__
+ :ref:`AutoRemoveOverduesRestrictions`
preference.
- Next you can choose the delivery method for the overdue notice. You
- can choose from Email, Phone (if you are using the `iTiva Talking
- Tech service <#TalkingTechItivaPhoneNotification>`__), Print and SMS
- (if you have set your `SMSSendDriver <#SMSSendDriver>`__).
+ can choose from Email, Phone (if you are using the :ref:`iTiva Talking
+ Tech service <talkingtechitivaphonenotification-label>`), Print and SMS
+ (if you have set your :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>`).
- **Note**
- See a `Sample Overdue Notice <#samplenotice>`__
-`Patron Card Creator <#patroncardcreator>`__
+.. _patron-card-creator-label:
+
+Patron Card Creator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patron Card Creator
- Export (as PDF) single or multiple patron cards from within a batch
-`Layouts <#cardlayouts>`__
+.. _layouts-label:
+
+Layouts
^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Patron Card Creator > Manage > Layouts
Up to three lines of text, the patron's number in barcode
representation and up to two images can be printed on to the card.
-`Add a Layout <#addcardlayout>`__
+.. _add-a-layout-label:
+
+Add a Layout
'''''''''''''''''''''''''''''''''
If you have no layouts defined, you will add a new layout by clicking
- Finally you can choose up to two images to print on the card.
- - One can be the `patron image <#uploadpatronimages>`__ which you
+ - One can be the :ref:`patron image <upload-patron-images-label>` which you
can resize to meet your needs.
- The other image can be something like a library logo or symbol
- that you uploaded using the '`Manage
- Images <#managecardimages>`__' module of the Patron Card Creator
+ that you uploaded using the ':ref:`Manage
+ Images <manage-images-label>`' module of the Patron Card Creator
Tool.
**Important**
Manage Layouts
|image263|
-`Templates <#patrontemplate>`__
+.. _templates-label:
+
+Templates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Patron Card Creator > Manage > Card
usually be found on the vendor's website or can be measured from a
sample sheet.
-`Add a Template <#addcardtemplate>`__
+.. _add-a-template-label:
+
+Add a Template
'''''''''''''''''''''''''''''''''''''
To add a new template click on the 'New template' button at the top of
adjustments for your printer/template combination.
- After finding and documenting any anomalies in the printed
- document, then you can `create a profile <#addcardprofile>`__ and
+ document, then you can :ref:`create a profile <add-a-profile-label>` and
assign it to the template.
- **Important**
Manage Templates
|image267|
-`Profiles <#patronprofile>`__
+.. _profiles-label:
+
+Profiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Patron Card Creator > Manage > Profiles
A profile is a set of "adjustments" applied to a given
-`template <#patrontemplate>`__ just prior to printing which compensates
+:ref:`template <templates-label>` just prior to printing which compensates
for anomalies unique and peculiar to a given printer. 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 card, you need to set up a
If your cards are printing just the way you want, you will not need a
profile.
-`Add a Profile <#addcardprofile>`__
+.. _add-a-profile-label:
+
+Add a Profile
'''''''''''''''''''''''''''''''''''
To add a new profile, you want to click on the 'Profiles' button at the
desk'
- Template will be filled in once you have chosen which template to
- apply the profile to on the `template edit form <#addcardtemplate>`__
+ apply the profile to on the :ref:`template edit form <add-a-template-label>`
- The Units pull down is used to define what measurement scale you're
going to be using for your profile.
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.
-`Batches <#patroncardbatches>`__
+.. _batches-label:
+
+Batches
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Patron Card Creator > Manage > Card
A batch is a collection of patrons for whom you want to generate cards.
-`Add a Batch <#addcardbatch>`__
+.. _add-a-batch-label:
+
+Add a Batch
'''''''''''''''''''''''''''''''
To add a new batch, you want to click on the 'New batches' button at the
rescale the PDF (e.g do not fit to paper size) otherwise the printer
will not be able to print to the right place per your templates.
-`Manage Images <#managecardimages>`__
+.. _manage-images-label:
+
+Manage Images
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Patron Card Creator > Manage > Images
Images uploaded using this tool will appear on the menu when creating
-`patron card layouts <#cardlayouts>`__. You are limited in how many
+:ref:`patron card layouts <layouts-label>`. You are limited in how many
images you can upload (not counting patron images) by the
-`ImageLimit <#ImageLimit>`__ system preference.
+:ref:`ImageLimit` system preference.
**Important**
To delete one or multiple of these images, click the checkbox to the
right of each image you want to delete and click the 'Delete' button.
-`Patrons (anonymize, bulk-delete) <#anonpatrons>`__
+.. _patrons-(anonymize,-bulk-delete)-label:
+
+Patrons (anonymize, bulk-delete)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Patrons
**Important**
The anonymization will fail quietly if
- `AnonymousPatron <#AnonymousPatron>`__ preference does not contain a
+ :ref:`AnonymousPatron` preference does not contain a
valid value.
Patron Anonymize/Bulk Delete Tool
- have accounts that will expire before a specific date
- - are in a specific `patron category <#patcats>`__
+ - are in a specific :ref:`patron category <patron-categories-label>`
- - are in a `patron list <#patronlists>`__
+ - are in a :ref:`patron list <patron-lists-label>`
- Click 'Next'
Completed Process
|image279|
-`Batch patron modification <#batchpatronmod>`__
+.. _batch-patron-modification-label:
+
+Batch patron modification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Batch patron
modification
With this tool you can make edits to a batch of patron records. Simply
-load in a file of cardnumbers (one per line), choose from a `list of
-patrons <#patronlists>`__ or scan patron card numbers in to the box
+load in a file of cardnumbers (one per line), choose from a :ref:`list of
+patrons <patron-lists-label>` or scan patron card numbers in to the box
provided.
Batch patron modification
Once you have made the changes you want, you can click 'Save' and Koha
will present you with the changed patron records.
-`Tag Moderation <#tagsmoderation>`__
+.. _tag-moderation-label:
+
+Tag Moderation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Tags
-Depending on your `tagging system preferences <#taggingprefs>`__,
+Depending on your :ref:`tagging system preferences <tagging-label>`,
librarians may need to approve tags before they are published on the
OPAC. This is done via the Tag Moderation Tool. If there are tags
awaiting moderation they will be listed on the main staff dashboard
|image286|
To check terms against the approved and rejected lists (and possibly
-against `the dictionary <#TagsExternalDictionary>`__ you have assigned
+against :ref:`the dictionary <tagsexternaldictionary-label>` you have assigned
for tag moderation) simply enter the term into the search box on the
bottom right of the screen to see the status of the term
Tag filters
|image288|
-`Upload Patron Images <#uploadpatronimages>`__
+.. _upload-patron-images-label:
+
+Upload Patron Images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Patrons and Circulation > Upload Patron
Images
-Patron images can be uploaded in bulk if you are `allowing patron
-images <#patronimages>`__ to be attached to patron records. These images
-can also be used when creating `patron cards <#patroncardcreator>`__.
+Patron images can be uploaded in bulk if you are :ref:`allowing patron
+images <patronimages-label>` to be attached to patron records. These images
+can also be used when creating :ref:`patron cards <patron-card-creator-label>`.
- Create a txt file and title it "DATALINK.TXT" or "IDLINK.TXT"
is recommended that the image be 200x300 pixels, but smaller images
will work as well.
-`Rotating Collections <#rotatingcollections>`__
+.. _rotating-collections-label:
+
+Rotating Collections
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Rotating Collections
**Important**
- The `AutomaticItemReturn <#AutomaticItemReturn>`__ system preference
+ The :ref:`AutomaticItemReturn` system preference
must be set to "Don't automatically transfer items to their home
library when they are returned" for Rotating Collections to function
properly.
quickly removing a number of items at a time by scanning their
barcodes.
-`Transfer a Rotating Collection <#transferrotatingcollection>`__
+.. _transfer-a-rotating-collection-label:
+
+Transfer a Rotating Collection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Transferring a collection will:
Rotating Collection Item Notification
|image292|
-`Catalog <#catalogtools>`__
+.. _catalog-label:
+
+Catalog
---------------------------
-`Batch item modification <#batchmodifyitems>`__
+.. _batch-item-modification-label:
+
+Batch item modification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Batch item modification
From the tool you can choose to upload a file of barcodes or item ids,
or you can scan items one by one into the box below the upload tool. You
can also decide the items edited should be populated with the default
-values you have defined in your `default
-framework <#marcbibframeworks>`__.
+values you have defined in your :ref:`default
+framework <marc-bibliographic-frameworks-label>`.
Once you have your file uploaded or the barcodes listed you can click
'Continue.'
Edit items in a batch
|image297|
-`Batch item deletion <#batchdeleteitems>`__
+.. _batch-item-deletion-label:
+
+Batch item deletion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Batch item deletion
Batch Deletion Confirmation
|image302|
-`Batch record deletion <#batchrecorddelete>`__
+.. _batch-record-deletion-label:
+
+Batch record deletion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This tool will take a batch of record numbers for either bibliographic
Check the records you want to delete and click the 'Delete selected
records' button to finish the process.
-`Batch Record Modification <#batchrecordmod>`__
+.. _batch-record-modification-label:
+
+Batch Record Modification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Batch record modification
This tool will allow you to edit batches of bibliographic and/or
-authority records using `MARC Modification
-Templates <#marcmodtemplates>`__. Before visiting this tool you will
+authority records using :ref:`MARC Modification
+Templates <marc-modification-templates-label>`. Before visiting this tool you will
want to set up at least one MARC modification template.
Batch record modification
Once you're sure everything is the way you want you can click the
'Modify selected records' button and your records will be modified.
-`Automatic item modifications by age <#autoitemagemod>`__
+.. _automatic-item-modifications-by-age-label:
+
+Automatic item modifications by age
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Automatic item modifications by
**Important**
- The settings in this tool will be acted upon by the `corresponding
- cron job <#autoitemupdatecron>`__
+ The settings in this tool will be acted upon by the :ref:`corresponding
+ cron job <automatic-item-update-label>`
If you haven't created any rules you will see the option to 'Add rules'
on the Tool page. Click this button to create rules.Automatic item
List of rules
|image307|
-`Export Data (MARC & Authorities) <#exportbibs>`__
+.. _export-data-(marc-&-authorities)-label:
+
+Export Data (MARC & Authorities)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Export Data
records to fellow libraries, organizations or services; or simply for
backup purposes.
-`Export Bibliographic Records <#exportmarc>`__
+.. _export-bibliographic-records-label:
+
+Export Bibliographic Records
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
At the top of the screen you need to pick what data you're exporting. If
- **Important**
This limit will use the type you have defined in the
- `item-level\_itypes <#item-level_itypes>`__ preference.
+ :ref:`item-level\_itypes <item-level\_itypes-label>` preference.
If you have the item-level\_itypes preference set to
'specific item' and you have no items attached to a bib
record it will not be exported. To get all bib records
- Click 'Export bibliographic records'
-`Export Authority Records <#exportauthority>`__
+.. _export-authority-records-label:
+
+Export Authority Records
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
At the top of the screen you need to pick what data you're exporting. If
- Click 'Export authority records'
-`Inventory/Stocktaking <#inventory>`__
+.. _inventory/stocktaking-label:
+
+Inventory/Stocktaking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Inventory/Stocktaking
Choose the text file and the date you want to mark all items as seen and
then scroll to the very bottom and click 'Submit.'
-`Label Creator <#labelcreator>`__
+.. _label-creator-label:
+
+Label Creator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Label Creator
- XML - Included as an alternate export format
-`Templates <#labeltemplates>`__
+.. _templates-label:
+
+Templates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Label Creator > Manage > Label templates
a Koha, this information may be on the packaging, and if not it can
usually be found on the vendor's website.
-`Add a Template <#addlabeltemplate>`__
+.. _add-a-template-label:
+
+Add a Template
''''''''''''''''''''''''''''''''''''''
To add a new template, you want to click on the 'New' button at the top
you can easily define a profile that is right for your
printer/template combination.
- - After finding any anomalies in the printed document, `create a
- profile <#addlabelprofile>`__ and assign it to the template.
+ - After finding any anomalies in the printed document, :ref:`create a
+ profile <add-a-profile-label>` and assign it to the template.
After saving, your templates will appear on the 'Manage' area under
'Label templates'.
List of label templates
|image321|
-`Profiles <#labelprofiles>`__
+.. _profiles-label:
+
+Profiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Label Creator > Manage > Printer Profiles
A profile is a set of "adjustments" applied to a given
-`template <#addlabeltemplate>`__ just prior to printing which
+:ref:`template <add-a-template-label>` 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
If your labels are printing just the way you want, you will not need a
profile.
-`Add a Profile <#addlabelprofile>`__
+.. _add-a-profile-label:
+
+Add a Profile
''''''''''''''''''''''''''''''''''''
To add a new profile, you want to click on the 'New' button at the top
number in printer name or you can call it 'the printer on my desk'
- Template will be filled in once you have chosen which template to
- apply the profile to on the `template edit
- form <#addlabeltemplate>`__
+ apply the profile to on the :ref:`template edit
+ form <add-a-template-label>`
- The Units pull down is used to define what measurement scale you're
going to be using for your profile.
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.
-`Layouts <#labellayouts>`__
+.. _layouts-label:
+
+Layouts
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Label Creator > Manage > Layouts
A layout is used to define the fields you want to appear on your labels.
-`Add a Layout <#addlabellayout>`__
+.. _add-a-layout-label:
+
+Add a Layout
''''''''''''''''''''''''''''''''''
To add a new layout, you want to click on the 'New' button at the top of
After saving, your layouts will appear on the 'Manage Layouts' page.
-`Batches <#labelbatches>`__
+.. _batches-label:
+
+Batches
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- *Get there:* More > Tools > Label Creator > Manage > Label batches
this tool you can search for the item records you would like to print
out labels for.
-`Add a Batch <#addlabelbatch>`__
+.. _add-a-batch-label:
+
+Add a Batch
''''''''''''''''''''''''''''''''
Batches can be created in one of two ways. The first is to click the
-'Create Label Batch' link on the '`Staged MARC
-Management <#managestaged>`__' page:
+'Create Label Batch' link on the ':ref:`Staged MARC
+Management <staged-marc-record-management-label>`' page:
Create Label Batch Link on Staged Records List
|image329|
After saving your file, simply print to the blank labels you have in
your library.
-`Quick Spine Label Creator <#quicklabelcreator>`__
+.. _quick-spine-label-creator-label:
+
+Quick Spine Label Creator
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Quick Spine Label Creator
prints a spine label in the first spot on the label sheet.
- Define the fields you want to print on the spine label in the
- `SpineLabelFormat <#SpineLabelFormat>`__ system preference
+ :ref:`SpineLabelFormat` system preference
- Format your label printing by editing spinelabel.css found in
koha-tmpl/intranet-tmpl/prog/en/css/
Quick Spine Label Creator
|image337|
-`MARC modification templates <#marcmodtemplates>`__
+.. _marc-modification-templates-label:
+
+MARC modification templates
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The MARC Modification Templates system gives Koha users the power to
|image342|
Once your template is saved you will be able to pick it when using the
-`Stage MARC Records for Import <#stagemarc>`__ tool.
+:ref:`Stage MARC Records for Import` tool.
Choose template
|image343|
-`Stage MARC Records for Import <#stagemarc>`__
+.. _stage-marc-records-for-import-label:
+
+Stage MARC Records for Import
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Stage MARC records for import
|image345|
- Enter 'Comments about this file' to identify your upload when
- going to the '`Manage Staged MARC Records <#managestaged>`__' tool
+ going to the ':ref:`Manage Staged MARC Records <staged-marc-record-management-label>`' tool
- Tell Koha which type of file this is, bibliographic or authority
Chracter encoding
|image347|
- - Choose if you would like to use a `MARC Modification
- Template <#marcmodtemplates>`__ to alter the data you're about to
+ - Choose if you would like to use a :ref:`MARC Modification
+ Template <marc-modification-templates-label>` to alter the data you're about to
import
Choose modification template
Look for matches
|image349|
- - You can set up `record matching rules <#recordmatchingrules>`__
+ - You can set up :ref:`record matching rules <record-matching-rules-label>`
through the administration area
Matching rules
- When using the ISBN matching rule Koha will find only exact
matches. If you find that the ISBN match is not working to
your satisfaction you can change the
- `AggressiveMatchOnISBN <#AggressiveMatchOnISBN>`__
+ :ref:`AggressiveMatchOnISBN`
preference to 'Do' and then run your import again.
- Next choose what to do with matching records if they are found
MARC Import Confirmation
|image352|
-- To complete the process continue to the `Manage Staged MARC Records
- Tool <#managestaged>`__
+- To complete the process continue to the :ref:`Manage Staged MARC Records
+ Tool <staged-marc-record-management-label>`
-`Staged MARC Record Management <#managestaged>`__
+.. _staged-marc-record-management-label:
+
+Staged MARC Record Management
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Staged MARC Record Management
-Once you have `staged <#stagemarc>`__ your records for import you can
+Once you have :ref:`staged <stage-marc-records-for-import-label>` your records for import you can
complete the import using this tool.
List of Staged MARC Records
- Accept the deletion and the records will be removed from the
reservoir and the status will be changed to 'cleaned'
-`Upload Local Cover Image <#uploadlocalimages>`__
+.. _upload-local-cover-image-label:
+
+Upload Local Cover Image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Catalog > Upload Local Cover Image
This tool will allow you to upload cover images for the materials in
your catalog. To access this tool, staff will need the
-`upload\_local\_cover\_images permission <#toolspermissions>`__. In
+:ref:`upload\_local\_cover\_images permission <granular-tools-permissions-label>`. In
order for images to show in the staff client and/or OPAC you will need
-to set your `LocalCoverImages <#LocalCoverImages>`__ and/or
-`OPACLocalCoverImages <#OPACLocalCoverImages>`__ preferences to
+to set your :ref:`LocalCoverImages` and/or
+:ref:`OPACLocalCoverImages` preferences to
'Display.' Images can be uploaded in batches or one by one.
**Note**
as next to the title and on the search results.
If you would like to remove a cover image you can click 'Delete image'
-below the image if you have the `upload\_local\_cover\_images
-permission <#toolspermissions>`__.
+below the image if you have the :ref:`upload\_local\_cover\_images
+permission <granular-tools-permissions-label>`.
-`Additional Tools <#additionaltools>`__
+.. _additional-tools-label:
+
+Additional Tools
---------------------------------------
-`Calendar <#calholidays>`__
+.. _calendar-label:
+
+Calendar
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Additional Tools > Calendar
the proper system preferences:
- *Get there:*\ More > Administration > Global System Preferences >
- Circulation > `useDaysMode <#useDaysMode>`__
+ Circulation > :ref:`useDaysMode`
- Choose the method for calculating due date - either include days
the library is closed in the calculation or don't include them.
- *Get there:* More > Administration > Global System Preferences >
- Circulation > `finescalendar <#finesCalendar>`__
+ Circulation > :ref:`finescalendar <finescalendar-label>`
- This will check the holiday calendar before charging fines
Calendar & Holidays Tools
|image369|
-`Adding Events <#addevents>`__
+.. _adding-events-label:
+
+Adding Events
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Before adding events, choose the library you would like to apply the
Calendar Summary
|image372|
-`Editing Events <#editevents>`__
+.. _editing-events-label:
+
+Editing Events
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To edit events
- All actions require that you click 'Save' before the change
will be made.
-`Additional Help <#calendarhelp>`__
+.. _additional-help-label:
+
+Additional Help
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When adding or editing events you can get additional help by clicking on
Additional Calendar Help Buttons
|image375|
-`CSV Profiles <#csvprofiles>`__
+.. _csv-profiles-label:
+
+CSV Profiles
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Additional Tools > CSV Profiles
CSV Profiles are created to define how you would like your cart or list
to export.
-`Add CSV Profiles <#addcsvprofile>`__
+.. _add-csv-profiles-label:
+
+Add CSV Profiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a CSV Profile
Confirmation of new CSV profile
|image380|
-`Modify CSV Profiles <#editcsvprofile>`__
+.. _modify-csv-profiles-label:
+
+Modify CSV Profiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once you have created at least one CSV Profile an 'Edit profile' tab
Delete an existing CSV Profile
|image383|
-`Using CSV Profiles <#usecsvprofiles>`__
+.. _using-csv-profiles-label:
+
+Using CSV Profiles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your CSV Profiles will appear on the export list or cart menu under the
CSV Profiles on Download Menu in the Staff Client
|image384|
-`Log Viewer <#logviewer>`__
+.. _log-viewer-label:
+
+Log Viewer
~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Additional Tools > Log Viewer
-Actions within the Koha system are tracked in log files. Your `system
-preferences <#logs>`__ can be changed to prevent the logging of
+Actions within the Koha system are tracked in log files. Your :ref:`system
+preferences <logs-label>` can be changed to prevent the logging of
different actions. These logs can be viewed using the Log Viewer Tool.
Log Viewer
like this
|image386|
-`News <#newstool>`__
+.. _news-label:
+
+News
~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Additional Tools > News
- After filling in all of the fields, click 'Submit'
- News in the OPAC will appear above the
- `OpacMainUserBlock <#OpacMainUserBlock>`__
+ :ref:`OpacMainUserBlock`
News in the OPAC
|image389|
|image391|
- Depending on your choice for the
- `NewsAuthorDisplay <#NewsAuthorDisplay>`__ preference you will also
+ :ref:`NewsAuthorDisplay` preference you will also
see the person who created the news item (this uses the logged in
person)
-`Task Scheduler <#taskscheduler>`__
+.. _task-scheduler-label:
+
+Task Scheduler
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Additional Tools > Task Scheduler
Saved Reports List
|image394|
-`Troubleshooting <#taskscedtroubleshoot>`__
+.. _troubleshooting-label:
+
+Troubleshooting
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Task scheduler will not work if the user the web server runs as doesn't
blank, then every user can use it. Talk to your system admin about
adding the user to the right place to make the task scheduler work.
-`Quote of the Day (QOTD) Editor <#QOTDEditor>`__
+.. _quote-of-the-day-(qotd)-editor-label:
+
+Quote of the Day (QOTD) Editor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Additional Tools > Edit quotes for QOTD
This tool will allow you to add and edit quotes to show on the OPAC if
you're using the Quote of the Day (QOTD) feature.
-To turn this feature on set the `QuoteOfTheDay <#QuoteOfTheDay>`__
+To turn this feature on set the :ref:`QuoteOfTheDay`
preference to 'Enable and add at least one quote via the Quote of the
Day Editor. Once these steps are complete you will see your quotes above
-the `OpacMainUserBlock <#OpacMainUserBlock>`__ in the OPAC:
+the :ref:`OpacMainUserBlock` in the OPAC:
Quote in the OPAC
|image395|
-`Add a Quote <#addquote>`__
+.. _add-a-quote-label:
+
+Add a Quote
^^^^^^^^^^^^^^^^^^^^^^^^^^^
To add a quote:
You may cancel the addition of a new quote any time prior to saving
it simply by pressing the <Esc> key on your keyboard.
-`Edit/Delete a Quote <#editquote>`__
+.. _edit/delete-a-quote-label:
+
+Edit/Delete a Quote
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once the current quote pool has been loaded into the editing table, you
- After confirming the deletion, the list will update and the quote(s)
will no longer appear.
-`Import Quotes <#importquote>`__
+.. _import-quotes-label:
+
+Import Quotes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you'd like you can import a batch of quotes as a CSV file. Your file
Save quotes button
|image406|
-`Upload <#uploadtool>`__
+.. _upload-label:
+
+Upload
~~~~~~~~~~~~~~~~~~~~~~~~
- *Get there:* More > Tools > Additional Tools > Upload
This tool will allow you to upload files to your Koha system for
-selection from the `Cataloging form <#uploadbibfile>`__.
+selection from the :ref:`Cataloging form <attaching-files-to-records-label>`.
-`Upload Files <#uploadfiles>`__
+.. _upload-files-label:
+
+Upload Files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When you first visit the Upload tool you might see a warning about
missing a category.Upload to temprorary
-Categories are defined in the `authorized value <#authorizedvalues>`__
+Categories are defined in the :ref:`authorized value <authorized-values-label>`
in the UPLOAD category. If you do not have upload categories then your
files will be temporary and will be deleted the next time the server is
rebooted. Once you have a value in the UPLOAD authorized value category
will be able to download this file via the OPAC. Once your file is
uploaded you will be presented with a confirmation.Upload confirmation
-`Search Files <#searchuploads>`__
+.. _search-files-label:
+
+Search Files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All uploaded files are searchable from below the upload form. Using the
Patrons
=======
-Before importing and/or adding patrons be sure to set up your `patron
-categories <#patcats>`__.
+Before importing and/or adding patrons be sure to set up your :ref:`patron
+categories <patron-categories-label>`.
-`Add a new patron <#addnewpatron>`__
+.. _add-a-new-patron-label:
+
+Add a new patron
------------------------------------
Patrons are added by going to the 'Patrons' module.
|image407|
- The fields that appear on the patron add form can be controlled by
- editing the `BorrowerUnwantedField <#BorrowerUnwantedField>`__ system
+ editing the :ref:`BorrowerUnwantedField` system
preference.
- First enter the identifying information regarding your patron
|image408|
- Required fields are defined in the
- `BorrowerMandatoryField <#BorrowerMandatoryField>`__ system
+ :ref:`BorrowerMandatoryField` system
preference
- Salutation is populated by the
- `BorrowersTitles <#BorrowersTitles>`__ system preference
+ :ref:`BorrowersTitles` system preference
- **Note**
If you'd like to prevent full names from printing on
- `slips <#notices>`__ and you're not using the Initials or
+ :ref:`slips <notices-&-slips-label>` and you're not using the Initials or
Other name fields for anything else, you can use them for
shortened versions of the name to then be printed on the slip.
last name in the fields available
- The relationships are set using the
- `borrowerRelationship <#borrowerRelationship>`__ system preference
+ :ref:`borrowerRelationship` system preference
- If this patron is a professional, you will be asked to attach the
patron to an organizational patron
|image413|
- The card number field is automatically calculated if you have the
- `autoMemberNum <#autoMemberNum>`__ system preference set that way
+ :ref:`autoMemberNum` system preference set that way
- **Note**
- The registration date will automatically be filled in with today's
date
- - If your patron cards expire (based on your `patron category
- settings <#patcats>`__) the Expiry date will automatically be
+ - If your patron cards expire (based on your :ref:`patron category
+ settings <patron-categories-label>`) the Expiry date will automatically be
calculated
- The OPAC Note is a note for the patron - it will appear in the
OPAC and for staff to log in to the staff client.
- Staff will only be able to use this log in info to log in to
- the staff client if they have the `necessary
- permissions <#patronpermissions>`__.
+ the staff client if they have the :ref:`necessary
+ permissions <patron-permissions-label>`.
-- If you have set `additional patron
- attributes <#patronattributetypes>`__ up, these will appear next
+- If you have set :ref:`additional patron
+ attributes <patron-attribute-types-label>` up, these will appear next
Additional Patron Attributes
|image416|
- Finally, if you have
- `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ set
+ :ref:`EnhancedMessagingPreferences` set
to 'allow,' you can choose the messaging preferences for this patron.
Patron Messaging Settings
- **Important**
- These preferences will override any you set via the `patron
- categories <#addingpatroncat>`__
+ These preferences will override any you set via the :ref:`patron
+ categories <adding-a-patron-category-label>`
- **Important**
Patron age warning
|image419|
-`Add a Staff Patron <#addstaffpatron>`__
+.. _add-a-staff-patron-label:
+
+Add a Staff Patron
----------------------------------------
All staff members must be entered into Koha as patrons of the 'Staff'
-type. Follow the steps in `Add a Patron <#addnewpatron>`__ to add a
+type. Follow the steps in :ref:`Add a Patron <add-a-new-patron-label>` to add a
staff member. To give the staff member permissions to access the staff
-client, follow the steps in `Patron Permissions <#patronpermissions>`__
+client, follow the steps in :ref:`Patron Permissions`
**Important**
Remember to assign your staff secure usernames and passwords since
these will be used to log into the staff client.
-`Add a Statistical Patron <#addstatspatron>`__
+.. _add-a-statistical-patron-label:
+
+Add a Statistical Patron
----------------------------------------------
One way to track use of in house items is to "check out" the materials
to a statistical patron. The "check out" process doesn’t check the book
out, but instead tracks an in house use of the item. To use this method
-for tracking in house use you first will need a `patron
-category <#patcats>`__ set up for your Statistical patron.
+for tracking in house use you first will need a :ref:`patron
+category <patron-categories-label>` set up for your Statistical patron.
In House Patron Category
|image420|
New In House Patron
|image421|
-Next, follow the steps put forth in the '`Add a new
-Patron <#addnewpatron>`__' section of this manual. Since this patron is
+Next, follow the steps put forth in the ':ref:`Add a new
+Patron <add-a-new-patron-label>`' section of this manual. Since this patron is
not a real person, simply fill in the required fields, the correct
library and nothing else.
To learn about other methods of tracking in house use visit the
-`Tracking inhouse use <#trackinhouse>`__ section of this manual.
+:ref:`Tracking inhouse use <tracking-in-house-use-label>` section of this manual.
-`Duplicate a Patron <#duplicatepatron>`__
+.. _duplicate-a-patron-label:
+
+Duplicate a Patron
-----------------------------------------
Sometimes when you're adding a new family to your system you don't want
Newly created patron
|image424|
-`Add Patron Images <#addpatronimages>`__
+.. _add-patron-images-label:
+
+Add Patron Images
----------------------------------------
If you would like you can add patron images to help identify patrons. To
enable this feature you must first set the
-`patronimages <#patronimages>`__ preference to 'Allow'.
+:ref:`patronimages` preference to 'Allow'.
If the preference is set to 'Allow' you will see a placeholder image
under the patron's name and box to upload a patron image below the basic
is recommended that the image be 200x300 pixels, but smaller images
will work as well.
-`Editing Patrons <#editpatrons>`__
+.. _editing-patrons-label:
+
+Editing Patrons
----------------------------------
Patrons in Koha can be edited using one of many edit buttons.
|image430|
- This form will not appear if you have the
- `patronimages <#patronimages>`__ system preference to not allow
+ :ref:`patronimages` system preference to not allow
patron images
- - To add patron images in bulk, use the `Upload Patron
- Images <#uploadpatronimages>`__ Tool
+ - To add patron images in bulk, use the :ref:`Upload Patron
+ Images <upload-patron-images-label>` Tool
- Patrons can also be blocked from checking items out by setting Patron
Flags
- **Note**
- This flag can automatically be set with the `Overdue/Notice
- Status Triggers <#noticetriggers>`__
+ This flag can automatically be set with the :ref:`Overdue/Notice
+ Status Triggers <overdue-notice/status-triggers-label>`
- If you enter in a date and/or note related to the restriction you
will see that in the restricted message as well
|image435|
- Children patrons do not become adults automatically in Koha unless
- you have `Juvenile to Adult cron job <#j2acron>`__ running. To
+ you have :ref:`Juvenile to Adult cron job <update-child-to-adult-patron-type-label>` running. To
upgrade a child patron to and adult patron category manually go to
the 'More' menu and choose 'Update Child to Adult Patron'
Choose Adult Category to Update To
|image437|
-`Managing Patron Self Edits <#mangepatronedits>`__
+.. _managing-patron-self-edits-label:
+
+Managing Patron Self Edits
--------------------------------------------------
If you are allowing patrons to edit their accounts via the OPAC with the
-`OPACPatronDetails <#OPACPatronDetails>`__ preference then you will need
+:ref:`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
'Patron details' links to the right of the buttons. This will open in a
new tab.
-`Patron Permissions <#patronpermissions>`__
+.. _patron-permissions-label:
+
+Patron Permissions
-------------------------------------------
Patron Permissions are used to allow staff members access to the staff
must have (at the very least) 'catalogue' permissions which allow
them to view the staff interface.
-`Setting Patron Permissions <#setpatronperms>`__
+.. _setting-patron-permissions-label:
+
+Setting Patron Permissions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-To set patron permissions, you must first `have a patron of the 'Staff'
-type <#addstaffpatron>`__ open
+To set patron permissions, you must first :ref:`have a patron of the 'Staff'
+type <add-a-staff-patron-label>` open
- On the patron record click More and choose Set Permissions to alter
patron permissions
Patron Permissions
|image441|
-`Patron Permissions Defined <#patronpermsdefined>`__
+.. _patron-permissions-defined-label:
+
+Patron Permissions Defined
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- superlibrarian
- Check out and check in items
- - This section can be expanded (`Learn more <#circpermissions>`__)
+ - This section can be expanded (:ref:`Learn more <granular-circulate-permissions-label>`)
- catalogue
- Manage Koha system systems (Administration panel)
- - This section can be expanded (`Learn
- more <#parameterpermissions>`__)
+ - This section can be expanded (:ref:`Learn
+ more <granular-parameters-permissions-label>`)
- borrowers
- Place and modify holds for patrons
- - This section can be expanded (`Learn
- more <#reservepermissions>`__)
+ - This section can be expanded (:ref:`Learn
+ more <granular-holds-permissions-label>`)
- editcatalogue
- Edit Catalog (Modify bibliographic/holdings data)
- - This section can be expanded (`Learn more <#catpermissions>`__)
+ - This section can be expanded (:ref:`Learn more <granular-cataloging-permissions-label>`)
- updatecharges
- Manage patrons fines and fees
- - This section can be expanded (`Learn
- more <#updatechargespermissions>`__)
+ - This section can be expanded (:ref:`Learn
+ more <granular-fines-and-charges-permissions-label>`)
- acquisition
- Acquisition and/or suggestion management
- - This section can be expanded (`Learn more <#acqpermissions>`__)
+ - This section can be expanded (:ref:`Learn more <granular-acquisitions-permissions-label>`)
- management
- Use all tools
- - This section can be expanded (`Learn more <#toolspermissions>`__)
+ - This section can be expanded (:ref:`Learn more <granular-tools-permissions-label>`)
- editauthorities
- Manage serial subscriptions
- - This section can be expanded (`Learn more <#serpermissions>`__)
+ - This section can be expanded (:ref:`Learn more <granular-serials-permissions-label>`)
- reports
- Reports found on the Circulation page are not controlled by this
permission
- - This section can be expanded (`Learn more <#reportpermissions>`__)
+ - This section can be expanded (:ref:`Learn more <granular-reports-permissions-label>`)
- staffaccess
- Koha plugins
- - This section can be expanded (`Learn more <#pluginpermissions>`__)
+ - This section can be expanded (:ref:`Learn more <granular-plugins-permissions-label>`)
- lists
a staff member permission to delete public lists that they
have not created.
- - This section can be expanded (`Learn more <#listspermissions>`__)
+ - This section can be expanded (:ref:`Learn more <granular-lists-permissions-label>`)
+
+.. _granular-circulate-permissions-label:
-`Granular Circulate Permissions <#circpermissions>`__
+Granular Circulate Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'circulate' permissions they have the ability to
- Requires that the staff member also has
circulate\_remaining\_permissions
-`Granular Parameters Permissions <#parameterpermissions>`__
+.. _granular-parameters-permissions-label:
+
+Granular Parameters Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'parameters' permissions they have the ability
- Manage circulation rules
- - The ability to access the `Circulation and fines
- rules <#circfinerules>`__ in the administration area
+ - The ability to access the :ref:`Circulation and fines
+ rules <circulation-and-fine-rules-label>` in the administration area
- parameters\_remaining\_permissions
- The ability to access all areas in Administration (other than the
Circulation and fine rules)
-`Granular Holds Permissions <#reservepermissions>`__
+.. _granular-holds-permissions-label:
+
+Granular Holds Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'reserveforothers' permissions they have the
- Place holds for patrons
-`Granular Cataloging Permissions <#catpermissions>`__
+.. _granular-cataloging-permissions-label:
+
+Granular Cataloging Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'editcatalogue' permissions they have the
- Edit items
- - Ability to make `edits to item/holdings
- records <#editingitems>`__, but not bibliographic records
+ - Ability to make :ref:`edits to item/holdings
+ records <editing-items-label>`, but not bibliographic records
- edit\_items\_restricted
- Limit item modification to subfields defined in the
- `SubfieldsToAllowForRestrictedEditing <#SubfieldsToAllowForRestrictedEditing>`__
+ :ref:`SubfieldsToAllowForRestrictedEditing`
preference
- **Note**
- Fast cataloging
- - The ability to catalog using only the `Fast Add
- Framework <#fastaddcat>`__ found on the
+ - The ability to catalog using only the :ref:`Fast Add
+ Framework <fast-add-cataloging-label>` found on the
`Circulation <#circulation>`__ page
-`Granular Fines and Charges Permissions <#updatechargespermissions>`__
+.. _granular-fines-and-charges-permissions-label:
+
+Granular Fines and Charges Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If a staff member has 'updatecharges' permission they have the ability
- Write off fines and fees
-`Granular Acquisitions Permissions <#acqpermissions>`__
+.. _granular-acquisitions-permissions-label:
+
+Granular Acquisitions Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'acquisition' permissions they have the ability
- Manage vendors
-`Granular Serials Permissions <#serpermissions>`__
+.. _granular-serials-permissions-label:
+
+Granular Serials Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'serials' permissions they have the ability to
- check\_expiration
- - Check the `expiration of a serial <#serialexpiration>`__
+ - Check the :ref:`expiration of a serial <check-serial-expiration-label>`
- claim\_serials
- - Claim missing serials via the `Claims section <#serialclaims>`__
+ - Claim missing serials via the :ref:`Claims section <claim-late-serials-label>`
- create\_subscription
- - Create `a new subscription <#newsubscription>`__
+ - Create :ref:`a new subscription <add-a-subscription-label>`
- delete\_subscription
- Routing
- - Manage `routing lists <#routinglist>`__
+ - Manage :ref:`routing lists <create-a-routing-list-label>`
- superserials
- Manage subscriptions from any branch (only applies when
- `IndependantBranches <#IndependentBranches>`__ is used)
+ :ref:`IndependantBranches <independentbranches-label>` is used)
+
+.. _granular-tools-permissions-label:
-`Granular Tools Permissions <#toolspermissions>`__
+Granular Tools Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'tools' permissions they have the ability to
- Upload patron images in batch or one at a time
- - Access to the `Image Upload Tool <#uploadpatronimages>`__
+ - Access to the :ref:`Image Upload Tool <upload-patron-images-label>`
- delete\_anonymize\_patrons
- Delete old borrowers and anonymize circulation/reading history
(deletes borrower reading history)
- - Access to the `Anonymize Patron Tool <#anonpatrons>`__
+ - Access to the :ref:`Anonymize Patron Tool <patrons-(anonymize,-bulk-delete)-label>`
- edit\_calendar
- Define days when the library is closed
- - Access to the `Calendar/Holidays Tool <#calholidays>`__
+ - Access to the :ref:`Calendar/Holidays Tool <calendar-label>`
- edit\_news
- Write news for the OPAC and staff interfaces
- - Access to the `News Tool <#newstool>`__
+ - Access to the :ref:`News Tool <news-label>`
- edit\_notice\_status\_triggers
- Set notice/status triggers for overdue items
- - Access to the `Overdue Notice Status/Triggers
- Tool <#noticetriggers>`__
+ - Access to the :ref:`Overdue Notice Status/Triggers
+ Tool <overdue-notice/status-triggers-label>`
- edit\_notices
- Define notices
- - Access to the `Notices Tool <#notices>`__
+ - Access to the :ref:`Notices Tool <notices-&-slips-label>`
- export\_catalog
- Export bibliographic, authorities and holdings data
- - Access to the `Export Data Tool <#exportbibs>`__
+ - Access to the :ref:`Export Data Tool <export-data-(marc-&-authorities)-label>`
- import\_patrons
- Import patron data
- - Access to the `Import Patrons Tool <#patronimport>`__
+ - Access to the :ref:`Import Patrons Tool <patron-import-label>`
- inventory
- Perform inventory (stocktaking) of your catalog
- - Access to the `Inventory Tool <#inventory>`__
+ - Access to the :ref:`Inventory Tool <inventory/stocktaking-label>`
- items\_batchdel
- Perform batch deletion of items
- - Access to the `Batch Item Deletion Tool <#batchdeleteitems>`__
+ - Access to the :ref:`Batch Item Deletion Tool <batch-item-deletion-label>`
- items\_batchmod
- Perform batch modification of items
- - Access to the `Batch Item Modification Tool <#batchmodifyitems>`__
+ - Access to the :ref:`Batch Item Modification Tool <batch-item-modification-label>`
- items\_batchmod\_restricted
- - Limit `batch item modification <#batchmodifyitems>`__ to subfields
+ - Limit :ref:`batch item modification <batch-item-modification-label>` to subfields
defined in the
- `SubfieldsToAllowForRestrictedBatchmod <#SubfieldsToAllowForRestrictedBatchmod>`__
+ :ref:`SubfieldsToAllowForRestrictedBatchmod`
preference
- **Note**
- Create printable labels and barcodes from catalog and patron data
- - Access to the `Label Creator <#labelcreator>`__ and `Quick Label
- Creator <#quicklabelcreator>`__ Tools
+ - Access to the :ref:`Label Creator` and :ref:`Quick Label
+ Creator <quick-spine-label-creator-label>` Tools
- manage\_csv\_profiles
- Manage CSV export profiles
- - Access to the `CSV Profiles Tool <#csvprofiles>`__
+ - Access to the :ref:`CSV Profiles Tool <csv-profiles-label>`
- manage\_staged\_marc
- Manage staged MARC records, including completing and reversing
imports
- - Access to the `Manage Staged MARC Records Tool <#managestaged>`__
+ - Access to the :ref:`Manage Staged MARC Records Tool <staged-marc-record-management-label>`
- moderate\_comments
- Moderate patron comments
- - Access to the `Comments Tool <#comments>`__
+ - Access to the :ref:`Comments Tool <comments-label>`
- moderate\_tags
- Moderate patron tags
- - Access to the `Tags Tool <#tagsmoderation>`__
+ - Access to the :ref:`Tags Tool <tag-moderation-label>`
- records\_batchdel
- Perform batch deletion of records (bibliographic or authority)
- - Access to the `Batch Record Deletion Tool <#batchrecorddelete>`__
+ - Access to the :ref:`Batch Record Deletion Tool <batch-record-deletion-label>`
- rotating\_collections
- Manage rotating collections
- - Access to the `Rotating Collections Tool <#rotatingcollections>`__
+ - Access to the :ref:`Rotating Collections Tool <rotating-collections-label>`
- schedule\_tasks
- Schedule tasks to run
- - Access to the `Task Scheduler Tool <#taskscheduler>`__
+ - Access to the :ref:`Task Scheduler Tool <task-scheduler-label>`
- stage\_marc\_import
- Stage MARC records into the reservoir
- - Access to the `Stage MARC Records Tool <#stagemarc>`__
+ - Access to the :ref:`Stage MARC Records Tool <stage-marc-records-for-import-label>`
- upload\_general\_files
- Upload any file
- - Access to upload files via the `Upload Tool <#uploadtool>`__
+ - Access to upload files via the :ref:`Upload Tool <upload-label>`
- upload\_local\_cover\_images
- Upload local cover images
- - Access to the `Upload Local Cover Image
- Tool <#uploadlocalimages>`__ as well as permission to add and
+ - Access to the :ref:`Upload Local Cover Image
+ Tool <upload-local-cover-image-label>` as well as permission to add and
delete local cover images from the bib detail page
- upload\_manage
- Manage uploaded files
- - Access to uploaded files via the `Upload Tool <#uploadtool>`__
+ - Access to uploaded files via the :ref:`Upload Tool <upload-label>`
**Note**
- Browse the system logs
- - Access to the `Log Viewer Tool <#logviewer>`__
+ - Access to the :ref:`Log Viewer Tool <log-viewer-label>`
+
+.. _granular-reports-permissions-label:
-`Granular Reports Permissions <#reportpermissions>`__
+Granular Reports Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'reports' permissions they have the ability to
- The ability to run but not create or edit SQL reports
-`Granular Plugins Permissions <#pluginpermissions>`__
+.. _granular-plugins-permissions-label:
+
+Granular Plugins Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the staff member has 'plugins' permissions they have the ability to
- The ability to use tool plugins
-`Granular Lists Permissions <#listspermissions>`__
+.. _granular-lists-permissions-label:
+
+Granular Lists Permissions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
All staff members have permission to access lists. This section only
- Delete public lists
-`Patron Information <#patroninformation>`__
+.. _patron-information-label:
+
+Patron Information
-------------------------------------------
When viewing a patron record you have the option to view information
- *Get there:* Patrons > Browse or search for patron > Click patron
name
-`Check Out <#patcheckout>`__
+.. _check-out-label:
+
+Check Out
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-For instruction on checking items out, view the `Checking
-Out <#checkingout>`__ section of this manual.
+For instruction on checking items out, view the :ref:`Checking
+Out <check-out-(issuing)-label>` section of this manual.
Staff members can access their own check out screen by clicking their
username in the top right of the staff client and choosing 'My
checkouts'My checkouts
-`Details <#patrondetails>`__
+.. _details-label:
+
+Details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Staff members can access their own account details by clicking their
Guarantees listed on the Guarantor's profile
|image444|
-`Circulation Summary <#patcircsummary>`__
+.. _circulation-summary-label:
+
+Circulation Summary
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Below the patron's information on the details screen is a tabbed display
Add restriction
|image449|
-`Fines <#patronfines>`__
+.. _fines-label:
+
+Fines
~~~~~~~~~~~~~~~~~~~~~~~~
The patron's complete accounting history will appear on the Fines tab.
- Note: any notes about this charge/payment
- If you're allowing patrons to pay fines via the OPAC with PayPal
- (`EnablePayPalOpacPayments <#EnablePayPalOpacPayments>`__) you
+ (:ref:`EnablePayPalOpacPayments <enablepaypalopacpayments-&-paypalsandboxmode-label>`) you
will see a Note that says 'PayPal' for items paid this wayPayPal
Fines
hide all completed transaction and above that you can use the search box
to find a specific charge or payment.
-`Charging Fines/Fees <#chargefines>`__
+.. _charging-fines/fees-label:
+
+Charging Fines/Fees
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Most fees and fines will be charged automatically if the `fines cron
-job <#finescronjob>`__ is running:
+Most fees and fines will be charged automatically if the :ref:`fines cron
+job <fines-label>` is running:
-- Fines will be charged based on your `Circulation & Fines
- Rules <#circfinerules>`__
+- Fines will be charged based on your :ref:`Circulation & Fines
+ Rules <circulation-and-fine-rules-label>`
-- Hold fees will be charged based on the rules you set in the `Patron
- Types & Categories <#patcats>`__ administration area
+- Hold fees will be charged based on the rules you set in the :ref:`Patron
+ Types & Categories <patron-categories-label>` administration area
-- Rental fees will be charged based on the settings in your `Item
- Types <#itemtypeadmin>`__ administration area
+- Rental fees will be charged based on the settings in your :ref:`Item
+ Types <item-types-label>` administration area
- Marking an item 'Lost' via the cataloging module will automatically
charge the patron the replacement cost for that item
-`Pay/Reverse Fines <#payfines>`__
+.. _pay/reverse-fines-label:
+
+Pay/Reverse Fines
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Each line item can be paid in full (or written off) using the 'Pay
Reversed Payment
|image458|
-`Creating Manual Invoices <#manualinvoice>`__
+.. _creating-manual-invoices-label:
+
+Creating Manual Invoices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For fees that are not automatically charged, librarians can create a
- In the amount field, do not enter currency symbols, only numbers and
decimals
-`Creating Manual Credits <#manualcredit>`__
+.. _creating-manual-credits-label:
+
+Creating Manual Credits
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Manual credits can be used to pay off parts of fines, or to forgive a
- In the amount field, do not enter currency symbols, only numbers and
decimals
-`Printing Invoices <#printinglineitems>`__
+.. _printing-invoices-label:
+
+Printing Invoices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To the right of each account line there is a print link. Clicking that
Sample Invoice
|image461|
-`Routing Lists <#patronroutingtab>`__
+.. _routing-lists-label:
+
+Routing Lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A list of all of the serial routing lists the patron belongs to will be
Patron's routing lists
|image463|
-`Circulation History <#circhistory>`__
+.. _circulation-history-label:
+
+Circulation History
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The circulation history tab will appear if you have set the
-`intranetreadinghistory <#intranetreadinghistory>`__ preference to allow
-it to appear. If you have the `OPACPrivacy <#OPACPrivacy>`__ system
+:ref:`intranetreadinghistory` preference to allow
+it to appear. If you have the :ref:`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.
This will generate a text file with one barcode per line.
-`Modification Log <#patmodlog>`__
+.. _modification-log-label:
+
+Modification Log
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you have set your `BorrowersLog <#BorrowersLog>`__ to track changes
+If you have set your :ref:`BorrowersLog` to track changes
to patron records, then this tab will appear. The Modification Log will
show when changes were made to the patron record. If you also have
-turned on the `IssueLog <#IssueLog>`__ and `ReturnLog <#ReturnLog>`__
+turned on the :ref:`IssueLog` and :ref:`ReturnLog`
you will see checkins and outs on this screen as well.
Changes to Patron
- The Object field lists the borrowernumber that is being modified (in
the example above, it was my changing my own record)
-`Notices <#patnotices>`__
+.. _notices-label:
+
+Notices
~~~~~~~~~~~~~~~~~~~~~~~~~
The `patron's messaging preferences <#setpatronmessaging>`__ are set
-when `adding <#addnewpatron>`__ or `editing <#editpatrons>`__ the
+when :ref:`adding <add-a-new-patron-label>` or :ref:`editing <editing-patrons-label>` the
patron. This tab will show the messages that have been sent and those
that are queued to be sent:
Resend notice
|image469|
-`Statistics <#patronstatstab>`__
+.. _statistics-label:
+
+Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Depending on what you set for the values of your
-`StatisticsFields <#StatisticsFields>`__ system preference, you can see
+:ref:`StatisticsFields` system preference, you can see
statistics for one patron's circulation actions.
Patron's Statistics
|image470|
-`Files <#patronfiles>`__
+.. _files-label:
+
+Files
~~~~~~~~~~~~~~~~~~~~~~~~
-If you set the `EnableBorrowerFiles <#EnableBorrowerFiles>`__ preference
+If you set the :ref:`EnableBorrowerFiles` preference
to 'Do' the Files tab will be visible on the patron information page.
Patron Files Tab
List of files on the patron record
|image473|
-`Purchase Suggestions <#patronsuggestions>`__
+.. _purchase-suggestions-label:
+
+Purchase Suggestions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If the patron has made any purchase suggestions you will see a purchase
status, you can also create a purchase suggestion on the patron's behalf
by clicking the 'New purchase suggestion' button at the top.
-Learn more about `Purchase suggestions <#purchasesuggest>`__ in the
+Learn more about :ref:`Purchase suggestions <purchase-suggestions-label>` in the
`Acquisitions <#acqmodule>`__ chapter of this manual.
-`Patron discharges <#patrondischarge>`__
+.. _patron-discharges-label:
+
+Patron discharges
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 <#useDischarge>`__
+patron record you need to set the :ref:`useDischarge`
system preference to 'Allow'.
**Note**
Academic libraries often require that you have a clear record at the
library before you can graduate.
-Patrons can `request discharges via the OPAC <#opacdischarge>`__. Any
+Patrons can :ref:`request discharges via the OPAC <ask-for-a-discharge-label>`. Any
pending discharges will be listed below the menu buttons on the main
staff client pagePending discharges
**Note**
- You can style the PDF using the `NoticeCSS <#NoticeCSS>`__
+ You can style the PDF using the :ref:`NoticeCSS`
preference.
The patron will have a restriction added to their accountDischarge
And a history of discharges will be added to the 'Discharge'
tabDischarge history
-`Patron Search <#patronsearch>`__
+.. _patron-search-label:
+
+Patron Search
---------------------------------
Clicking on the link to the Patron module will bring you to a
- Date of birth
- Birth dates should be entered using the format set forth in the
- `dateformat <#dateformat>`__ preference.
+ :ref:`dateformat` preference.
- Sort field 1
which is linked from the top left of every page or from the center of
the main page.
-Before circulating your collection you will want to set your `Global
-System Preferences <#globalsysprefs>`__, `Basic
-Parameters <#basicparams>`__ and `Patrons & Circulation
-Rules <#patscirc>`__.
+Before circulating your collection you will want to set your :ref:`Global
+System Preferences <global-system-preferences-label>`, :ref:`Basic
+Parameters <basic-parameters-label>` and :ref:`Patrons & Circulation
+Rules <patrons-&-circulation-label>`.
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:
Mac users use the OPTION button in place of ALT
-`Check Out (Issuing) <#checkingout>`__
+.. _check-out-(issuing)-label:
+
+Check Out (Issuing)
--------------------------------------
To begin the checkout process you must enter the patron barcode or part
Check out tab on a patron record
|image483|
-- If you have enabled `batch checkouts <#batchcheckoutprefs>`__ then
+- If you have enabled :ref:`batch checkouts <batch-checkout-label>` then
click the batch check out option on the patron recordBatch checkout
- Check out option on the quick search bar on the circulation page
Check out tab on quick search bar
|image484|
-`Checking Items Out <#checkitemout>`__
+.. _checking-items-out-label:
+
+Checking Items Out
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To check an item out to a patron, first search for that patron using one
making it so that the 'Check Out' button is automatically clicked
- If the barcode is not found you will be prompted to use fast
- cataloging to add the item. Learn more about `fast
- cataloging <#fastaddcat>`__ later in this manual.
+ cataloging to add the item. Learn more about :ref:`fast
+ cataloging <fast-add-cataloging-label>` later in this manual.
- If you have
- `itemBarcodeFallbackSearch <#itemBarcodeFallbackSearch>`__ set to
+ :ref:`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).
the default due date for the item.
- This option will only appear if you have set the
- `SpecifyDueDate <#SpecifyDueDate>`__ system preference to allow staff
+ :ref:`SpecifyDueDate` system preference to allow staff
to override the due date
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 <#autorenewcron>`__ is running and there are no
+:ref:`appropriate cron job <automatic-renewal-label>` is running and there are no
holds on the item.
Next is an option to no decrease the loan length based on holds. This
-overrides the `decreaseLoanHighHolds <#decreaseLoanHighHolds>`__
+overrides the :ref:`decreaseLoanHighHolds <decreaseloanhighholds,-decreaseloanhighholdsduration,-decreaseloanhighholdsvalue,-decreaseloanhighholdscontrol,-and-decreaseloanhighholdsignorestatuses-label>`
preference.
-If you're allowing the `checkout of items on site <#OnSiteCheckouts>`__
+If you're allowing the :ref:`checkout of items on site <onsitecheckouts-label>`
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 after clicking the 'Checkout settings' link to expand
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 <#SuspendHoldsIntranet>`__ preference set to
+:ref:`SuspendHoldsIntranet` preference set to
'allow.'
**Note**
If you have your
- `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ preference
+ :ref:`AutoResumeSuspendedHolds` preference
set to "Don't allow" then you will not have the option to put an end
date on the hold suspension
Circulation information on holdings tab
|image493|
-`Printing Receipts <#printcircreceipt>`__
+.. _printing-receipts-label:
+
+Printing Receipts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once you have checked out all of the items for the patron you can print
them a receipt by choosing one of two methods.
-If you have the `CircAutoPrintQuickSlip <#CircAutoPrintQuickSlip>`__
+If you have the :ref:`CircAutoPrintQuickSlip`
preference set to 'open a print quick 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
lists all items that are overdue.
What prints on the slips can be customized by altering the slip
-templates under the `Notices & Slips <#notices>`__ tool.
+templates under the :ref:`Notices & Slips` tool.
-`Clear Patron Information <#clearpatroninfo>`__
+.. _clear-patron-information-label:
+
+Clear Patron Information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When you're done checking an item out if you have the
-`DisplayClearScreenButton <#DisplayClearScreenButton>`__ preference set
+:ref:`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.
Clear Screen Button
|image495|
-If you have the `CircAutoPrintQuickSlip <#CircAutoPrintQuickSlip>`__
+If you have the :ref:`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.
-`Batch Checkouts <#batchcheckout>`__
+.. _batch-checkouts-label:
+
+Batch Checkouts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you would like to perform a batch check out you can do so by turning
-on the `BatchCheckouts <#BatchCheckouts>`__ system preference and
+on the :ref:`BatchCheckouts` system preference and
assigning the proper patron categories via the
-`BatchCheckoutsValidCategories <#BatchCheckoutsValidCategories>`__
+:ref:`BatchCheckoutsValidCategories`
preference. This will allow you to use an RFID pad that reads multiple
barcodes or perform a batch check out for training internal use.Batch
checkouts
Batch local use
|image497|
-`Check Out Messages <#checkoutmsg>`__
+.. _check-out-messages-label:
+
+Check Out Messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you check out an item that has multiple pieces and you have cataloged
|image499|
- You can set the amount at which patron checkouts are blocked with
- the `noissuescharge <#noissuescharge>`__ system preference
+ the :ref:`noissuescharge` system preference
- Patron has a restriction on their account
|image500|
- This can be set by the librarian editing a patron record and
- adding a `restriction <#patronflags>`__ or by the `Overdue/Notice
- Status Triggers <#noticetriggers>`__
+ adding a `restriction <#patronflags>`__ or by the :ref:`Overdue/Notice
+ Status Triggers <overdue-notice/status-triggers-label>`
- If the staff member has the right permission they can override the
restriction temporarily
- This can be set by the librarian editing a patron record and
adding a `flag <#patronflags>`__
-`Check Out Warnings <#checkoutwarn>`__
+.. _check-out-warnings-label:
+
+Check Out Warnings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sometimes checkouts will trigger warning messages that will appear in a
|image509|
- Patron has too many things checked out and
- `AllowTooManyOverride <#AllowTooManyOverride>`__ is set to 'Allow'
+ :ref:`AllowTooManyOverride` is set to 'Allow'
Too many checkouts
|image510|
- Patron has too many things checked out and
- `AllowTooManyOverride <#AllowTooManyOverride>`__ is set to "Don't
+ :ref:`AllowTooManyOverride` is set to "Don't
allow"
Too many checkouts
|image512|
- This can be overridden with the
- `AllowRenewalLimitOverride <#AllowRenewalLimitOverride>`__ system
+ :ref:`AllowRenewalLimitOverride` system
preference
- Barcode not found
Barcode not found
|image513|
- - Learn more about `fast cataloging <#fastaddcat>`__ later in this
+ - Learn more about :ref:`fast cataloging <fast-add-cataloging-label>` later in this
manual.
- Item being checked out is marked as 'lost'
- - Depending on the value in your `IssueLostItem <#IssueLostItem>`__
+ - Depending on the value in your :ref:`IssueLostItem`
preference, you may just see a warning
Warning that item is lost
|image516|
- Item being checked out meets the
- `decreaseLoanHighHolds <#decreaseLoanHighHolds>`__ system preference
+ :ref:`decreaseLoanHighHolds <decreaseloanhighholds,-decreaseloanhighholdsduration,-decreaseloanhighholdsvalue,-decreaseloanhighholdscontrol,-and-decreaseloanhighholdsignorestatuses-label>` system preference
criteria
Too many holds
|image517|
-`Renewing <#circrenew>`__
+.. _renewing-label:
+
+Renewing
-------------------------
Checked out items can be renewed (checked out for another period of
-time) based on your `circulation rules <#circfinerules>`__ and `renewal
-preferences <#RenewalPeriodBase>`__.
+time) based on your :ref:`circulation rules <circulation-and-fine-rules-label>` and :ref:`renewal
+preferences <renewalperiodbase-label>`.
-If `you allow it <#OpacRenewalAllowed>`__, patrons can renew their own
+If :ref:`you allow it <opacrenewalallowed-label>`, patrons can renew their own
items via the OPAC, but sometimes you'll need to help them by renewing
their items via the staff client.
Sometimes renewals will be blocked based on your circulation rules, to
override this block you must have your
-`AllowRenewalLimitOverride <#AllowRenewalLimitOverride>`__ preference
+:ref:`AllowRenewalLimitOverride` preference
set to 'Allow'. If you allow renewal limit overrides, you will see a
checkbox at the bottom left of the circulation summary. Check that box
and then choose the items you would like to renew.
Item not checked out
|image525|
-`Check In (Returning) <#checkingin>`__
+.. _check-in-(returning)-label:
+
+Check In (Returning)
--------------------------------------
Checking in items can be performed from various different locations
Check in link on Circulation Module
|image529|
-`Checking Items In <#checkitemin>`__
+.. _checking-items-in-label:
+
+Checking Items In
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To check an item in scan the barcode for the item into the box provided.
scanning items. This will effectively roll back the returned date to the
last date the library was open.
-- This requires that you have your closings added to the `Holidays &
- Calendar Tool <#calholidays>`__
+- This requires that you have your closings added to the :ref:`Holidays &
+ Calendar Tool <calendar-label>`
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.
-If you have the `SpecifyReturnDate <#SpecifyReturnDate>`__ preference
+If you have the :ref:`SpecifyReturnDate` preference
set to 'Allow' you will be able to arbitrarily set the return date from
below the check in box.Specify check in date
-`Check In Messages <#checkinmsg>`__
+.. _check-in-messages-label:
+
+Check In Messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are several messages that can appear when checking items in:
status as Available (it will not cancel the hold)
- If you have the system showing you fines at the time of checkin
- (`FineNotifyAtCheckin <#FineNotifyAtCheckin>`__) you will see a
+ (:ref:`FineNotifyAtCheckin`) you will see a
message telling you about the fine and providing you a link to the
payment page for that patron
FineNotifyAtCheckin
|image539|
-`Circulation Messages <#circmessages>`__
+.. _circulation-messages-label:
+
+Circulation Messages
----------------------------------------
Circulation messages are short messages that librarians can leave for
their patrons or their colleagues that will appear at the time of
circulation.
-`Setting up Messages <#setcircmsg>`__
+.. _setting-up-messages-label:
+
+Setting up Messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Circulation messages are set up as `Authorized
-Values <#authorizedvalues>`__. To add or edit Circulation Messages you
+Circulation messages are set up as :ref:`Authorized
+Values <authorized-values-label>`. To add or edit Circulation Messages you
want to work with the `BOR\_NOTES <#bornotes>`__ value.
BOR\_NOTES Authorized Values
message field can hold more than that. Enter 80 characters in the
'Description' field and then type the rest on the patron record.
-`Adding a Message <#addcircmsg>`__
+.. _adding-a-message-label:
+
+Adding a Message
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When on the patron's check out tab you will see a link to 'Add a new
A message for the patron will also show to the library staff.
-`Viewing Messages <#viewcircmsg>`__
+.. _viewing-messages-label:
+
+Viewing Messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Circulation messages meant for the staff and/or the patron will appear
Circulation Message in OPAC
|image544|
-`Holds <#holds>`__
+.. _holds-label:
+
+Holds
------------------
Koha allows patrons to put things on hold. A 'Hold' is a way to reserve
-an item. Depending on your `circulation and fine
-rules <#circfinerules>`__ and `hold preference <#circholdspolicy>`__
+an item. Depending on your :ref:`circulation and fine
+rules <circulation-and-fine-rules-label>` and :ref:`hold preference <holds-policy-label>`
settings patrons will be able to place items on hold for pickup at the
library at a later date/time.
-`Placing Holds in Staff Client <#holdsinstaff>`__
+.. _placing-holds-in-staff-client-label:
+
+Placing Holds in Staff Client
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are several ways to place holds from the staff client. The most
- Choose the library where the patron will pick up the item
- If you have the
- `AllowHoldItemTypeSelection <#AllowHoldItemTypeSelection>`__
+ :ref:`AllowHoldItemTypeSelection`
preference set to 'Allow' and the record had more than one item type
attached you will see an option to choose to limit the hold to a
specific item typeAllowHoldItemTypeSelection
enter that in the 'Hold starts on date' field
- This option will only appear if the
- `AllowHoldDateInFuture <#AllowHoldDateInFuture>`__ system
+ :ref:`AllowHoldDateInFuture` system
preference is set to 'Allow'
- If the patron has specified that they don't want the item after a
expiration date for the hold in the 'Hold expires on date'
- To have expired holds cancelled automatically you will need to have
- the `Expired Holds <#expiredholdscron>`__ cron job set to run on a
+ the :ref:`Expired Holds` cron job set to run on a
regular basis.
- Next choose if you want to place a hold on the next available item or
Forget Search to Hold Option
|image553|
-`Managing Holds <#manageholds>`__
+.. _managing-holds-label:
+
+Managing Holds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Holds can be altered and cancelled from the Holds tab found on the left
**Note**
If you have your
- `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ preference
+ :ref:`AutoResumeSuspendedHolds` preference
set to "Don't allow" then you will not have the option to put an end
date on the hold suspension
**Note**
- Depending on how you have your `HidePatronName <#HidePatronName>`__
+ Depending on how you have your :ref:`HidePatronName`
system preference set the list may show card numbers instead of
names in the Patron column like in the image above.
|image557|
If a patron asks to have their hold suspended and you have the
-`SuspendHoldsIntranet <#SuspendHoldsIntranet>`__ system preference set
+:ref:`SuspendHoldsIntranet` system preference set
to 'allow' you can do so by clicking the Suspend button to far right. If
the patron gives you a date for the items to become unsuspended you can
enter that in the date box and click the 'Update hold(s)' button to save
Cancel Holds
|image559|
-`Receiving Holds <#receiveholds>`__
+.. _receiving-holds-label:
+
+Receiving Holds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-When items that are on hold are `checked in <#checkingin>`__ or
-`out <#checkingout>`__ the system will remind the circulation librarian
+When items that are on hold are :ref:`checked in <check-in-(returning)-label>` or
+:ref:`out <check-out-(issuing)-label>` the system will remind the circulation librarian
that the item is on hold and offer them options for managing the hold.
When you check in an item that has a hold on it the system will ask you
From here you can check the item out to the patron at the desk and
cancel the hold for the patron.
-`Transfers <#transfers>`__
+.. _transfers-label:
+
+Transfers
--------------------------
If you work in a multi-branch system you can transfer items from one
- The item shows the same 'Home Library' but has updated the
'Current Location' to note where it resides at this time
-`Set Library <#setlibrary>`__
+.. _set-library-label:
+
+Set Library
-----------------------------
By default you will enter the staff client as if you are at your home
Once you have saved your changes you new library will appear in the top
right.
-`Fast Add Cataloging <#fastaddcat>`__
+.. _fast-add-cataloging-label:
+
+Fast Add Cataloging
-------------------------------------
Sometimes circulation librarians need to quickly add a record to the
Checked out item
|image576|
-`Circulation Reports <#circreports>`__
+.. _circulation-reports-label:
+
+Circulation Reports
--------------------------------------
Most reports can be found via the Reports module, but some of the more
- *Get there*: Circulation > Circulation reports
-`Holds Queue <#holdsqueue>`__
+.. _holds-queue-label:
+
+Holds Queue
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will show you all of the holds at your library.
Sample Holds Queue
|image577|
-To generate this report, you must have the `Build Holds Queue cron
-job <#buildholdscron>`__ running. This cron job is a script that should
+To generate this report, you must have the :ref:`Build Holds Queue cron
+job <holds-queue-label>` 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.
It's behavior is controlled by the system preferences
-`StaticHoldsQueueWeight <#holdqueueweight>`__ and
-`RandomizeHoldsQueueWeight <#holdqueueweight>`__.
+:ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>` and
+:ref:`RandomizeHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
If you do not want all of your libraries to participate in the on-shelf
holds fulfillment process, you should list the libraries that \*do\*
RandomizeHoldsQueueWeight, causing the script to request hold
fulfillment not randomly, but by alphabetical order.
-`Holds to pull <#holdspull>`__
+.. _holds-to-pull-label:
+
+Holds to pull
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will show you all of the items that have holds on them that
Refine Holds to Pull Report
|image579|
-`Holds awaiting pickup <#holdspickup>`__
+.. _holds-awaiting-pickup-label:
+
+Holds awaiting pickup
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will show all of the holds that are waiting for patrons to
|image580|
Items that have been on the hold shelf longer than you normally allow
-(based on the `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__
+(based on the :ref:`ReservesMaxPickUpDelay`
preference value) will appear on the 'Holds Over' tab, they will not
-automatically be cancelled unless you have set the `cron
-job <#expiredholdscron>`__ to do that for you, but you can cancel all
+automatically be cancelled unless you have set the :ref:`cron
+job <expired-holds-label>` to do that for you, but you can cancel all
holds using the button at the top of the list.
Items waiting on the hold shelf too long
|image581|
-`Hold ratios <#holdratios>`__
+.. _hold-ratios-label:
+
+Hold ratios
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Hold ratios help with collection development. Using this report you will
Hold Ratios
|image582|
-`Transfers to receive <#transferstoreceive>`__
+.. _transfers-to-receive-label:
+
+Transfers to receive
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will list all of the items that Koha thinks are in transit
An item is considered late based on the number of days you have
entered in the
- `TransfersMaxDaysWarning <#TransfersMaxDaysWarning>`__ system
+ :ref:`TransfersMaxDaysWarning` system
preference.
-`Article Requests <#articlerequests>`__
+.. _article-requests-label:
+
+Article Requests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once the article request has been placed, staff will see new requests at the
This removes the article request from the processing tab.
-`Overdues <#overduesreport>`__
+.. _overdues-label:
+
+Overdues
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Important**
Large libraries can choose to filter the report before it runs by
setting the
- `FilterBeforeOverdueReport <#FilterBeforeOverdueReport>`__ system
+ :ref:`FilterBeforeOverdueReport` system
preference to 'Require'.
This report will list all items that are overdue at your library.
switches this from a report of overdues to a report of checkouts. It
will show all titles checked out regardless of due date.
-`Overdues with fines <#overduesfines>`__
+.. _overdues-with-fines-label:
+
+Overdues with fines
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will show you any overdues at your library that have accrued
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 branch. To see
-overdues with fines at other branches you will have to `change your
-branch <#setlibrary>`__ or log in at that branch.
+overdues with fines at other branches you will have to :ref:`change your
+branch <set-library-label>` or log in at that branch.
**Important**
- If you do not charge fines and/or don't have the `fines cron
- job <#finescronjob>`__ running you will see no data on this report.
+ If you do not charge fines and/or don't have the :ref:`fines cron
+ job <fines-label>` running you will see no data on this report.
-`Pending on-site checkouts <#pendingonsite>`__
+.. _pending-on-site-checkouts-label:
+
+Pending on-site checkouts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you are using the on site checkouts functionality
-(`OnSiteCheckouts <#OnSiteCheckouts>`__) then you'll have a report to
+(:ref:`OnSiteCheckouts`) then you'll have a report to
view all items that are currently checked out on site.Pending onsite
checkouts
This will list the due date (overdues in red), who has the item, item
information and what library the item is at.
-`Tracking In house Use <#trackinhouse>`__
+.. _tracking-in-house-use-label:
+
+Tracking In house Use
-----------------------------------------
Many libraries track the use of items within the library.
use of items in the library by patrons without them having to check
them out. On site use is the use of items on site that must first be
checked out. To learn more about on site usage please review the
- `OnSiteCheckouts <#OnSiteCheckouts>`__ preference.
+ :ref:`OnSiteCheckouts` preference.
Tracking the use of items in the library without checking them out can
be done in Koha one of two ways. The first is to create one or more
-`Statistical Patrons <#addstatspatron>`__. When collecting items that
+:ref:`Statistical Patrons <add-a-statistical-patron-label>`. When collecting items that
have been used within the library, you will want to check them out to
your statistical patron:
to keep accurate statistics for item use.
The other way to record local use of items is to set your
-`RecordLocalUseOnReturn <#RecordLocalUseOnReturn>`__ preference to
+:ref:`RecordLocalUseOnReturn` preference to
'Record.' Then whenever you check an item in that is not checked out and
not on hold a local use will be recorded.
**Note**
- If you have `RecordLocalUseOnReturn <#RecordLocalUseOnReturn>`__ set
+ If you have :ref:`RecordLocalUseOnReturn` set
to 'Record' you can still use your statistical patrons to record
local use as well.
-`In Processing / Book Cart Locations <#processinglocations>`__
+.. _in-processing-/-book-cart-locations-label:
+
+In Processing / Book Cart Locations
--------------------------------------------------------------
Koha allows for handling temporary locations like the processing center
and/or book carts throughout the library. For this feature to work you
-must first make sure you have `authorized values <#authorizedvalues>`__
+must first make sure you have :ref:`authorized values <authorized-values-label>`
set in the `LOC <#shelvelocvals>`__ category for PROC (Processing
Center) and CART (Book Cart).
|image590|
Next you need to set the
-`NewItemsDefaultLocation <#NewItemsDefaultLocation>`__ system preference
+:ref:`NewItemsDefaultLocation` system preference
to PROC. This will set the new items to the Processing Center as their
default location.
When creating items you enter in their desired final shelving location
and Koha will temporarily change that to PROC. If
-`InProcessingToShelvingCart <#InProcessingToShelvingCart>`__ is set to
+:ref:`InProcessingToShelvingCart` is set to
"Don't move" then when an item with a location of PROC is checked in it
will either automatically update the item to use the permanent location.
-If `InProcessingToShelvingCart <#InProcessingToShelvingCart>`__ is set
+If :ref:`InProcessingToShelvingCart` is set
to "Move" then when an item is checked in the location is changed from
PROC to CART.
-A `cron job <#proccartcron>`__ is then set to run at specified intervals
+A :ref:`cron job <in-processing/book-cart-label>` is then set to run at specified intervals
to age items from CART to the permanent shelving location. (For example,
an hourly cron entry of cart\_to\_shelf.pl --hours 3 where --hours is
the amount of time an item should spend on the cart before aging to its
- **Note**
- If the `ReturnToShelvingCart <#ReturnToShelvingCart>`__ system
+ If the :ref:`ReturnToShelvingCart` system
preference is set to "Move", any newly checked-in item is also
automatically put into the shelving cart, to be covered by the
same script run.
If items on the shelving cart are checked out, the cart location
will be cleared.
-`Self Checkout <#selfcheckout>`__
+.. _self-checkout-label:
+
+Self Checkout
---------------------------------
Koha comes with a very basic self checkout module. To enable this module
-you need to set the `WebBasedSelfCheck <#WebBasedSelfCheck>`__
+you need to set the :ref:`WebBasedSelfCheck`
preference to 'Enable.' To use this module you have to log in as a
-`staff member <#addstaffpatron>`__ with `circulation
-permissions <#patronpermissions>`__.
+:ref:`staff member <add-a-staff-patron-label>` with :ref:`circulation
+permissions <patron-permissions-label>`.
**Note**
- Create a `staff patron <#addstaffpatron>`__ specifically for this
+ Create a :ref:`staff patron <add-a-staff-patron-label>` specifically for this
action so that you don't leave a real staff client logged into a
computer all day
There is no link to the Self Checkout module, but a simple addition to
-the `IntranetUserJS <#intranetuserjs>`__ system preference can add one.
+the :ref:`IntranetUserJS` system preference can add one.
::
http://YOUR\_KOHA\_OPAC\_URL/cgi-bin/koha/sco/sco-main.pl
When on the self checkout page depending on your value in the
-`SelfCheckoutByLogin <#SelfCheckoutByLogin>`__ preference you will be
+:ref:`SelfCheckoutByLogin` preference you will be
asked to enter you cardnumber
Self Checkout Patron Card Number
Self Checkout Error Message
|image597|
-`Offline Circulation Utilities <#offlinecirc>`__
+.. _offline-circulation-utilities-label:
+
+Offline Circulation Utilities
------------------------------------------------
Koha allows for you to continue circulation actions while offline by
using any one of three utilities.
-`Offline Circulation in Koha <#kohaofflinecirc>`__
+.. _offline-circulation-in-koha-label:
+
+Offline Circulation in Koha
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If the `AllowOfflineCirculation <#AllowOfflineCirculation>`__ preference
+If the :ref:`AllowOfflineCirculation` preference
is set to 'Enable' the library staff can continue to perform circulation
actions within Koha when the system is offline. You will want to visit
http://your-koha-staff-client-url/cgi-bin/koha/circ/offline.pl at least
browser and user setting, is limited to 2.5MB or 5MB per domain.
This means that larger systems will not be able to synchronize their
data and are recommended to use either the
- `Firefox <#firefoxofflinecirc>`__ or
- `Windows <#windowsofflinecirc>`__ application for offline
+ :ref:`Firefox <firefox-plugin-label>` or
+ :ref:`Windows <offline-circ-tool-for-windows-label>` application for offline
circulation.
-`Setup <#kohaofflinesetup>`__
+.. _setup-label:
+
+Setup
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Before the first time the system goes offline go to Circulation and
browser and user setting, is limited to 2.5MB or 5MB per domain.
This means that larger systems will not be able to synchronize their
data and are recommended to use either the
- `Firefox <#firefoxofflinecirc>`__ or
- `Windows <#windowsofflinecirc>`__ application for offline
+ :ref:`Firefox <firefox-plugin-label>` or
+ :ref:`Windows <offline-circ-tool-for-windows-label>` application for offline
circulation.
This will allow you download a local copy of your patrons and
synced to the right of each data set.Synced offline dataThis should be
done regularly in preparation for any unexpected connection losses.
-`Circulating <#kohaofflinecirculating>`__
+.. _circulating-label:
+
+Circulating
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When your system goes offline visit the Offline Circulation page
Offline checkouts
|image603|
-`Koha Offline Uploading <#kohaofflineupload>`__
+.. _koha-offline-uploading-label:
+
+Koha Offline Uploading
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once the system is back online visit the Synchronize page on the Offline
Offline Circulation Summary
|image607|
-`Firefox Plugin <#firefoxofflinecirc>`__
+.. _firefox-plugin-label:
+
+Firefox Plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There is an offline circulation tool that you can add to your Firefox
Koha Offline Circulation Tool Warning
|image620|
-`Offline Circ Tool for Windows <#windowsofflinecirc>`__
+.. _offline-circ-tool-for-windows-label:
+
+Offline Circ Tool for Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Offline Circulation Utility can be downloaded at:
https://github.com/bywatersolutions/koha-offline-circulation/releases
To generate a borrowers.db file for loading in to the Windows tool you
-will need to run the `file generator via a cron
-job <#offlinecirccron>`__.
+will need to run the :ref:`file generator via a cron
+job <generate-patron-file-for-offline-circulation-label>`.
+
+.. _upload-offline-circ-file-label:
-`Upload Offline Circ File <#uploadofflinecirc>`__
+Upload Offline Circ File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The `offline circulation tool for Windows <#windowsofflinecirc>`__ will
+The :ref:`offline circulation tool for Windows <offline-circ-tool-for-windows-label>` will
generate a KOC file that you can upload into Koha once your system comes
back up.
- *Get there:* More > Cataloging
-`Bibliographic Records <#catbibs>`__
+.. _bibliographic-records-label:
+
+Bibliographic Records
------------------------------------
In Koha the bibliographic record contains the main information related
are supported in Koha). Once this information is saved, :ref:`Item Records`
can be attached.
-`Adding Records <#addbibrec>`__
+.. _adding-records-label:
+
+Adding Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Records can be added to Koha via original or copy cataloging. You can
advanced editor
- Enable the
- `EnableAdvancedCatalogingEditor <#EnableAdvancedCatalogingEditor>`__
+ :ref:`EnableAdvancedCatalogingEditor`
preference
- Click the 'Advanced editor' buttonAdvanced editor button
If no results are found, try searching for fewer fields,
not all Z39.50 targets can search all of the fields above.
- - Search targets can be altered by using the `Z39.50
- Admin <#z3950admin>`__ area.
+ - Search targets can be altered by using the :ref:`Z39.50
+ Admin <z39.50/sru-servers-label>` area.
- From the results you can view the MARC or Card view for the
records or choose to Import them into Koha
Try another search
|image631|
-`Basic Editor Cataloging <#basicatalog>`__
+.. _basic-editor-cataloging-label:
+
+Basic Editor Cataloging
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In the basic editor once you've opened a blank framework or imported a
|image632|
- If you would rather not see the MARC tag numbers you can change the
- value in your `hide\_marc <#hide_marc>`__ system preference or each
+ value in your :ref:`hide\_marc <hide\_marc-label>` system preference or each
user can check the box next to 'Show tags' found under 'Settings'.
- To expand a collapsed tag click on the tag description
documentation links' note found under 'Settings'
- Sometimes fields may not be editable due to the value in your
- `BiblioAddsAuthorities <#BiblioAddsAuthorities>`__ system preference.
+ :ref:`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.
Duplicate Record Warning
|image641|
-`Advanced Editor Cataloging <#advancededitor>`__
+.. _advanced-editor-cataloging-label:
+
+Advanced Editor Cataloging
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In order to use the Advanced cataloging editor you need to enable the
-`EnableAdvancedCatalogingEditor <#EnableAdvancedCatalogingEditor>`__
+:ref:`EnableAdvancedCatalogingEditor`
preference.
**Important**
Advanced Z39.50 results
|image645|
-`Advanced Cataloging Keyboard Shortcuts <#advancedkeyshortcuts>`__
+.. _advanced-cataloging-keyboard-shortcuts-label:
+
+Advanced Cataloging Keyboard Shortcuts
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
The following keyboard shortcuts can be used in the advanced cataloging
| Shift-Tab | Move to previous position |
+----------------+--------------------------------+
-`Macros in Advanced Cataloging <#macroscataloging>`__
+.. _macros-in-advanced-cataloging-label:
+
+Macros in Advanced Cataloging
'''''''''''''''''''''''''''''''''''''''''''''''''''''
To record a new macro:
- Deletes the first ‡b subfield on the first 245 to ‡b
-`Adding Analytic Records <#cataloganalytics>`__
+.. _adding-analytic-records-label:
+
+Adding Analytic Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Libraries sometimes make journal articles and articles within monographs
about Analytics in Chapter 13 of AACR2.
If you would like to catalog analytic records there are two options. One
-is to use the `Easy Analytics <#catalogeasyanalytics>`__ funtion; the
-other is the `Analytics Enhanced Workflow <#catalogenhanceanalytics>`__.
+is to use the :ref:`Easy Analytics` funtion; the
+other is the :ref:`Analytics Enhanced Workflow`.
-`Easy Analytics <#catalogeasyanalytics>`__
+.. _easy-analytics-label:
+
+Easy Analytics
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The Easy Analytics feature makes linking analytic records together
easier. The first thing you need to do is set the
-`EasyAnalyticalRecords <#EasyAnalyticalRecords>`__ preference to
-'Display' and the `UseControlNumber <#UseControlNumber>`__ preference to
+:ref:`EasyAnalyticalRecords` preference to
+'Display' and the :ref:`UseControlNumber` preference to
'Don't use.'
-After cataloging your analytic record (see `Adding
-Records <#addbibrec>`__ for more on creating records) click 'Edit' from
+After cataloging your analytic record (see :ref:`Adding
+Records <adding-records-label>` for more on creating records) click 'Edit' from
the normal view and choose to 'Link to Host Item'
Link to Host Item
Host Record
|image652|
-`Analytics Enhanced Workflow <#catalogenhanceanalytics>`__
+.. _analytics-enhanced-workflow-label:
+
+Analytics Enhanced Workflow
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To use the Enhanced Workflow method of adding analytics, the first thing
you need to do is set the
-`EasyAnalyticalRecords <#EasyAnalyticalRecords>`__ preference to 'Don't
-display' and the `UseControlNumber <#UseControlNumber>`__ preference to
+:ref:`EasyAnalyticalRecords` preference to 'Don't
+display' and the :ref:`UseControlNumber` preference to
'Use.'
-After cataloging your original record (see `Adding
-Records <#addbibrec>`__ for more on creating records) click 'New' from
+After cataloging your original record (see :ref:`Adding
+Records <adding-records-label>` for more on creating records) click 'New' from
the normal view and choose to 'New child record.'
New child record
Host Record
|image657|
-`Editing Analytics <#analyticediting>`__
+.. _editing-analytics-label:
+
+Editing Analytics
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have linked an analytic record incorrectly you can remove that
- Clicking 'Delink' will remove the 773 field and the link between the
analytic and the host.
-`Editing Records <#editbibrec>`__
+.. _editing-records-label:
+
+Editing Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To edit a record you can click 'Edit Biblio' from the search results on
at the top left of the editor.
You can also use the edit menu to add your own custom cover image if you
-have either `OPACLocalCoverImages <#OPACLocalCoverImages>`__ and/or
-`LocalCoverImages <#LocalCoverImages>`__ set to 'Display' by choosing
+have either :ref:`OPACLocalCoverImages` and/or
+:ref:`LocalCoverImages` set to 'Display' by choosing
'Upload Image' from the menu.
Upload Image
|image663|
-Choosing to 'Upload Image' will take you to the `Upload Local Cover
-Image Tool <#uploadlocalimages>`__.
+Choosing to 'Upload Image' will take you to the :ref:`Upload Local Cover
+Image Tool <upload-local-cover-image-label>`.
+
+.. _duplicating-records-label:
-`Duplicating Records <#dupbibrec>`__
+Duplicating Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Sometimes a copy of the record you need to catalog can't be found via
New Duplicate Record
|image665|
-`Attaching files to Records <#uploadbibfile>`__
+.. _attaching-files-to-records-label:
+
+Attaching files to Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you would like to upload files to Koha you can do so with a few
Koha > System Information. If there is an error you will see it
there.Upload Path Warning
-- You will want to be sure that your `OPACBaseURL <#OPACBaseURL>`__
+- You will want to be sure that your :ref:`OPACBaseURL`
system preference is set appropriately
- You will want to add the upload.pl plugin to the 856$u subfield in
- one (or multiple) of your `frameworks <#editsubfields>`__
+ one (or multiple) of your :ref:`frameworks <edit-framework-subfields-label>`
Once you are all set up you can continue with cataloging as regular. You
will see a plugin icon next to the 856$u that will open up the upload
Once the file is chosen it will appear as a link in the MARC record and
on the detail display.
-`Merging Records <#mergebibs>`__
+.. _merging-records-label:
+
+Merging Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To merge bibliographic records together you will want to go to the
|image670|
If you enter fields you will see those on the confirmation page (you can
-set defaults with the `MergeReportFields <#MergeReportFields>`__
+set defaults with the :ref:`MergeReportFields`
preference)
Merge report
**Note**
- If you would like you can also use the `Lists <#lists>`__ tool for
- merging records together. `Learn more here <#mergebibrecs>`__.
+ If you would like you can also use the :ref:`Lists` tool for
+ merging records together. :ref:`Learn more here <merging-bibliographic-records-via-lists-label>`.
+
+.. _deleting-records-label:
-`Deleting Records <#deleterecord>`__
+Deleting Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To delete a bibliographic record simply choose the 'Edit' button and
Record with items still attached
|image673|
-`Item Records <#catitems>`__
+.. _item-records-label:
+
+Item Records
----------------------------
In Koha each bibliographic record can have one or more items attached.
These items are sometimes referred to as holdings. Each item includes
information to the physical copy the library has.
-`Adding Items <#addingitems>`__
+.. _adding-items-label:
+
+Adding Items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After saving a new bibliographic record, you will be redirected to a
- y - Koha item type
To make sure that these values are filled in you can mark them as
-mandatory in the `framework <#marcbibframeworks>`__ you're using and
+mandatory in the :ref:`framework <marc-bibliographic-frameworks-label>` 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.
- **Note**
To make item subfields required in a framework you'll want to
- edit the 952 field in the `framework
- editor <#marcbibframeworks>`__.
+ edit the 952 field in the :ref:`framework
+ editor <marc-bibliographic-frameworks-label>`.
Below the add form there are 3 buttons for adding the item
|image680|
If you have
-`SpineLabelShowPrintOnBibDetails <#SpineLabelShowPrintOnBibDetails>`__
+:ref:`SpineLabelShowPrintOnBibDetails`
set to 'Display' then there will also be a link to print a quick spine
label next to each item.
Filter holdings
|image682|
-`Editing Items <#editingitems>`__
+.. _editing-items-label:
+
+Editing Items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Items can be edited in several ways.
Edit items in a batch
|image687|
- This will open up the `batch item modification
- tool <#batchmodifyitems>`__ where you can edit all of the items on
+ This will open up the :ref:`batch item modification
+ tool <batch-item-modification-label>` where you can edit all of the items on
this record as a batch.
- You can also enable
- `StaffDetailItemSelection <#StaffDetailItemSelection>`__ to have
+ :ref:`StaffDetailItemSelection` to have
checkboxes appear to the left of each item on the detail display. You
can then check off the items you would like to edit and click 'Modify
selected items' at the top of the list.
- There is also a link to Edit items from the search results in the
staff clientEdit item on the search results
-- Finally you can use the `Batch Item
- Modification <#batchmodifyitems>`__ tool
+- Finally you can use the :ref:`Batch Item
+ Modification <batch-item-modification-label>` tool
+
+.. _quick-item-status-updates-label:
-`Quick Item Status Updates <#itemquickedit>`__
+Quick Item Status Updates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Often circulation staff need to change the status of an item to Lost or
Edit Damaged Status
|image691|
-`Duplicating Items <#duplicateitem>`__
+.. _duplicating-items-label:
+
+Duplicating Items
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can easily duplicate each item by clicking the 'Action' button the
From here you can choose to 'Duplicate' the item and this will populate
the form with the values from the item you chose.
-`Item Information <#iteminfo>`__
+.. _item-information-label:
+
+Item Information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To the left of every bibliographic record there is a tab to view the
If the Order or Accession date is linked, clicking it will bring you to
the acquisitions information for that item.
-`Moving Items <#moveitemrec>`__
+.. _moving-items-label:
+
+Moving Items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Items can be moved from one bibliographic record to another using the
'Select'
If you want to move all items to a new record creating only one
-bibliographic record you can use the `Merge Records
-tool <#mergebibrecs>`__ instead.
+bibliographic record you can use the :ref:`Merge Records
+tool <merging-bibliographic-records-via-lists-label>` instead.
-`Deleting Items <#deleteitems>`__
+.. _deleting-items-label:
+
+Deleting Items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are many ways to delete item records. If you only need to delete
the 'Edit menu' and it will remove all items from the record.
You can also enable
-`StaffDetailItemSelection <#StaffDetailItemSelection>`__ to have
+:ref:`StaffDetailItemSelection` to have
checkboxes appear to the left of each item on the detail display. You
can then check off the items you would like to delete and click 'Delete
selected items' at the top of the list.
Deleting selected items
|image699|
-Finally you can use the `batch delete tool <#batchdeleteitems>`__ to
+Finally you can use the :ref:`batch delete tool <batch-item-deletion-label>` to
delete a batch of items.
-`Item Specific Circulation History <#itemcirchistory>`__
+.. _item-specific-circulation-history-label:
+
+Item Specific Circulation History
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Each bibliographic record keeps a circulation history (with or without
Item Specific Circulation History
|image701|
-`Authorities <#catauthorities>`__
+.. _authorities-label:
+
+Authorities
---------------------------------
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.
-`Adding Authorities <#addauthorities>`__
+.. _adding-authorities-label:
+
+Adding Authorities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To add a new authority record you can either choose the authority type
Imported Authority
|image708|
-`Searching Authorities <#searchauthorities>`__
+.. _searching-authorities-label:
+
+Searching Authorities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
From the authorities page you can search for existing terms and the
From the results you will see the authority record, how many
bibliographic records it is attached to, an 'Actions' menu that includes
-the ability to `edit <#editauthorities>`__, `merge <#authoritymerge>`__
-and `delete <#editauthorities>`__ (if there are no bibliographic records
+the ability to :ref:`edit <editing-authorities-label>`, :ref:`merge <merging-authorities-label>`
+and :ref:`delete <editing-authorities-label>` (if there are no bibliographic records
attached).
Authority Search Results
See Also in Authorities
|image712|
-`Editing Authorities <#editauthorities>`__
+.. _editing-authorities-label:
+
+Editing Authorities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Authorities can be edited by clicking on the authority summary from the
all of the bib records linked to the authority with the new authority
record's data. If dontmerge is set to "Don't" then Koha won't edit bib
records when changes are made to authorities, rather, this is done later
-by the `merge\_authority.pl cronjob <#mergeauthcron>`__.
+by the :ref:`merge\_authority.pl cronjob <update-authorities-label>`.
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
search results and as a button that appears after clicking on the
summary of the authority record.
-`Merging Authorities <#authoritymerge>`__
+.. _merging-authorities-label:
+
+Merging Authorities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have duplicate authority records you can merge them together by
Merged authority
|image718|
-`Cataloging Guides <#catguides>`__
+.. _cataloging-guides-label:
+
+Cataloging Guides
----------------------------------
-`Bibliographic Record Cataloging Cheat Sheet <#bibcatcheatsheet>`__
+.. _bibliographic-record-cataloging-cheat-sheet-label:
+
+Bibliographic Record Cataloging Cheat Sheet
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 001 | CONTROL NUMBER | Accession number. | Enter the accession number written inside the item here. For articles and items which do not have accession numbers, leave blank. |
+-------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 003 | CONTROL NUMBER IDENTIFIER | Your MARC Organizational Code | Click in this field to fill it in (will auto fill if you have your `MARCOrgCode <#MARCOrgCode>`__ preference set). |
+| 003 | CONTROL NUMBER IDENTIFIER | Your MARC Organizational Code | Click in this field to fill it in (will auto fill if you have your :ref:`MARCOrgCode` preference set). |
+-------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 005 | D & T LATEST TRANSACTION | Current date and time. | Click in this field to fill it in. |
+-------+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Table: Cataloging Guide
-`Item/Holdings Record Cataloging Guide <#itemcatguide>`__
+.. _item/holdings-record-cataloging-guide-label:
+
+Item/Holdings Record Cataloging Guide
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This table represents the default embedded holdings data in Koha. This
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| MARC21 Tag/subfield | Data Element | Description | Notes |
+=======================+=====================================================+==================================================================================+==========================================================================================================================================================================================================================================================================+
-| 952$0 | Withdrawn status | Default values: | Coded value, matching `Authorized Value <#authorizedvalues>`__ category ('WITHDRAWN' in default installation) |
+| 952$0 | Withdrawn status | Default values: | Coded value, matching :ref:`Authorized Value <authorized-values-label>` category ('WITHDRAWN' in default installation) |
| | | | |
| | | - 0 = Not withdrawn | |
| | | | |
| | | - 1 = Withdrawn | |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$1 | Lost status | Default values: | It's possible to configure OPAC so that lost items don't display with the `hidelostitems <#hidelostitems>`__ system preference. |
+| 952$1 | Lost status | Default values: | It's possible to configure OPAC so that lost items don't display with the :ref:`hidelostitems` system preference. |
| | | | |
-| | | - 0 = Available | Coded value, matching `Authorized Value <#authorizedvalues>`__ category ('LOST' in default installation) |
+| | | - 0 = Available | Coded value, matching :ref:`Authorized Value <authorized-values-label>` category ('LOST' in default installation) |
| | | | |
| | | - 1 = Lost | |
| | | | |
| | | | |
| | | - 5 = Missing in Hold Queue | |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$2 | Classification | Classification scheme that defines filing rules used for sorting call numbers. | A choice of `classification sources <#classificationsources>`__ as they are defined in administration. If no classification scheme is entered, the system will use the value entered in the `DefaultClassificationSource <#DefaultClassificationSource>`__ preference. |
+| 952$2 | Classification | Classification scheme that defines filing rules used for sorting call numbers. | A choice of :ref:`classification sources <classification-sources-label>` as they are defined in administration. If no classification scheme is entered, the system will use the value entered in the :ref:`DefaultClassificationSource` preference. |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 952$3 | Materials specified | Specific issues of serials or multi-part items. | Displayed when items are checked out and in to tell the staff how many pieces the item has. Copy/volume data is stored in 952$h and $t for display in Normal views. |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$4 | Damaged status | Default values: | Coded value, matching `Authorized Value <#authorizedvalues>`__ category ('DAMAGE' in default installation) |
+| 952$4 | Damaged status | Default values: | Coded value, matching :ref:`Authorized Value <authorized-values-label>` category ('DAMAGE' in default installation) |
| | | | |
| | | - 0 = Not damaged | |
| | | | |
| | | - 1 = Damaged | |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$5 | Use restrictions | Default values: | Coded value, matching `Authorized Value <#authorizedvalues>`__ category ('RESTRICT' in default installation). This value has no effect on circulation. |
+| 952$5 | Use restrictions | Default values: | Coded value, matching :ref:`Authorized Value <authorized-values-label>` category ('RESTRICT' in default installation). This value has no effect on circulation. |
| | | | |
| | | - 0 = No use restrictions | |
| | | | |
| | | - 1 = Restricted Access | |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$7 | Not for loan | Default values: | Coded value, matching `Authorized Value <#authorizedvalues>`__ category ('NOT\_LOAN' in default installation). Negative number values can still be placed on hold. |
+| 952$7 | Not for loan | Default values: | Coded value, matching :ref:`Authorized Value <authorized-values-label>` category ('NOT\_LOAN' in default installation). Negative number values can still be placed on hold. |
| | | | |
| | | - -1 = Ordered | |
| | | | |
| | | | |
| | | - 2 = Staff Collection | |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$8 | Collection code | Coded value | Coded value, matching `Authorized Value <#authorizedvalues>`__ category ('CCODE' in default installation) |
+| 952$8 | Collection code | Coded value | Coded value, matching :ref:`Authorized Value <authorized-values-label>` category ('CCODE' in default installation) |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 952$9 | Item number | System-generated item number. | Does not display in the item record. |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$a | Owning Library \*\* | Branch code | **Required**. Code must be defined in `Libraries, Branches and Groups <#libsgroups>`__ |
+| 952$a | Owning Library \*\* | Branch code | **Required**. Code must be defined in :ref:`Libraries, Branches and Groups <libraries-&-groups-label>` |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$b | Holding library \*\* (usually the same as 952$a ) | Branch code | **Required**. Code must be defined in `Libraries, Branches and Groups <#libsgroups>`__ |
+| 952$b | Holding library \*\* (usually the same as 952$a ) | Branch code | **Required**. Code must be defined in :ref:`Libraries, Branches and Groups <libraries-&-groups-label>` |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$c | Shelving location code | | Coded value, matching `Authorized Value <#authorizedvalues>`__ category ('LOC' in default installation) |
+| 952$c | Shelving location code | | Coded value, matching :ref:`Authorized Value <authorized-values-label>` category ('LOC' in default installation) |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 952$d | Date acquired | YYYY-MM-DD | Date formats in the 952 subfields are required to be in the system internal format for data loading and subsequent item editing: YYYY-MM-DD |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 952$h | Serial enumeration | | Filled in automatically by Serials if the issue is received there. |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$o | Koha full call number | | Can be filled in automatically based on the `itemcallnumber <#itemcallnumber>`__ system preference. |
+| 952$o | Koha full call number | | Can be filled in automatically based on the :ref:`itemcallnumber` system preference. |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 952$p | Barcode \* | Max 20 characters | |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 952$x | Nonpublic note | | This is a note field for notes that will not appear in the OPAC. Right now this note does not appear anywhere but in the item edit screen in the staff client. |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 952$y | Koha item type \*\* | Coded value, required field for circulation | **Required**. Coded value, must be defined in `Item types <#itemtypeadmin>`__ |
+| 952$y | Koha item type \*\* | Coded value, required field for circulation | **Required**. Coded value, must be defined in :ref:`Item types <item-types-label>` |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 952$z | Public note | | |
+-----------------------+-----------------------------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
\*\* - required by Koha
-`Handling On Order Items and Holds <#onorderitemholds>`__
+.. _handling-on-order-items-and-holds-label:
+
+Handling On Order Items and Holds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you tend to import your MARC records when you have ordered the book
- Choose where to save your file
Now you want to go into your Koha system and follow the instructions for
-`importing MARC records <#stagemarc>`__.
+:ref:`importing MARC records <stage-marc-records-for-import-label>`.
Once the item has come in, you will need to go to the item record and
individually change the item to have the correct barcode, and manually
to 'reserve' and assign different circulation rules to these items while
they are being used for a specific course.
-`Course Reserves Setup <#coursesetup>`__
+.. _course-reserves-setup-label:
+
+Course Reserves Setup
----------------------------------------
Before using Course Reserves you will need to do some set up.
First you will need to enable course reserves by setting the
-`UseCourseReserves <#UseCourseReserves>`__ preference to 'Use'.
+:ref:`UseCourseReserves` preference to 'Use'.
-Next you will need to have all of your course instructors `added as
-patrons <#addnewpatron>`__.
+Next you will need to have all of your course instructors :ref:`added as
+patrons <add-a-new-patron-label>`.
-Next you will want to add a couple of new `authorized
-values <#newauthval>`__ for Departments and Terms.
+Next you will want to add a couple of new :ref:`authorized
+values <add-new-authorized-value-label>` for Departments and Terms.
-You may also want to create new `item types <#additemtype>`__,
+You may also want to create new :ref:`item types <adding-item-types-label>`,
`collection codes <#ccode>`__ and/or `shelving
locations <#shelvelocvals>`__ 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 <#circfinerules>`__ are right for your
+your :ref:`circulation and fine rules <circulation-and-fine-rules-label>` are right for your
new item types (whether they be hourly or daily loans).
-`Adding Courses <#addingcourses>`__
+.. _adding-courses-label:
+
+Adding Courses
-----------------------------------
Once you have completed your set up for Course Reserves you can start
Courses
|image730|
-`Adding Reserve Materials <#addreserves>`__
+.. _adding-reserve-materials-label:
+
+Adding Reserve Materials
-------------------------------------------
Before adding reserve materials you will need at least one course to add
Course with reserves
|image734|
-`Course Reserves in the OPAC <#opaccoursereserves>`__
+.. _course-reserves-in-the-opac-label:
+
+Course Reserves in the OPAC
-----------------------------------------------------
Once you have enabled Course Reserves and added courses you will see a
staff client page. The Serials module in Koha is used for keeping track
of journals, newspapers and other items that come on a regular schedule.
As with all modules, make sure you go through the related
-`Implementation Checklist <#impserials>`__ before using the Serials
+:ref:`Implementation Checklist <serials-configuration-label>` before using the Serials
module.
- *Get there:* More > Serials
-`Manage Serial Frequencies <#serialfreq>`__
+.. _manage-serial-frequencies-label:
+
+Manage Serial Frequencies
-------------------------------------------
Koha keeps a record of publication frequencies for easy management and
New frequency
|image739|
-`Manage Serial Numbering Patterns <#serialpatterns>`__
+.. _manage-serial-numbering-patterns-label:
+
+Manage Serial Numbering Patterns
------------------------------------------------------
Everytime you create a new numbering pattern in serials you can save it
New number pattern
|image741|
-`Custom Subscription Fields <#serialfields>`__
+.. _custom-subscription-fields-label:
+
+Custom Subscription Fields
----------------------------------------------
This module will allow you to add custom fields to your serial
and when you search subscriptions (if you chose to make it
'searchable')Searchable field
-`Add a subscription <#newsubscription>`__
+.. _add-a-subscription-label:
+
+Add a subscription
-----------------------------------------
Subscriptions can be added by clicking the 'New' button on any
patrons who subscribe to updates on this serial via the OPAC.
- For this option to appear you need to make sure that you have a
- Routing List notice set up in the `Notices Tool <#notices>`__
+ Routing List notice set up in the :ref:`Notices Tool <notices-&-slips-label>`
- 'Location' is for the shelving location
and the OPAC
- If no values are entered in these fields, they will use the
- `OPACSerialIssueDisplayCount <#OPACSerialIssueDisplayCount>`__ and
- `StaffSerialIssueDisplayCount <#StaffSerialIssueDisplayCount>`__
+ :ref:`OPACSerialIssueDisplayCount` and
+ :ref:`StaffSerialIssueDisplayCount`
system preference values
Once that data is filled in you can click 'Next' to enter the prediction
- There are several pre-defined options for the 'Frequency' of
publication all of which are visible alongside your own custom
- frequencies by visiting '`Manage frequencies <#serialfreq>`__'
+ frequencies by visiting ':ref:`Manage frequencies <manage-serial-frequencies-label>`'
- Without periodicy: some very specific (usually high level science
journals) don't have a true periodicity. When you subscribe to the
- 'Numbering pattern' will help you determine how the numbers are
printed for each issue. Patterns entered here are saved and editable
- at any time by visiting '`Manage numbering
- patterns <#serialpatterns>`__'
+ at any time by visiting ':ref:`Manage numbering
+ patterns <manage-serial-numbering-patterns-label>`'
- Start with the numbering on the issue you have in hand, the
numbering that matches the date you entered in the 'First issue
Prediction pattern
|image749|
-- If you have added a `custom subscription field <#serialfields>`__, it
+- If you have added a :ref:`custom subscription field <custom-subscription-fields-label>`, it
will be editable above the buttons at the bottom of the screenShow
field
Click 'Save Subscription' to save the information you have entered.
`Find sample serial examples in the appendix <#sampleserialsapp>`__.
-`Receive Issues <#receiveissues>`__
+.. _receive-issues-label:
+
+Receive Issues
-----------------------------------
Issues can be marked as received from several locations. To find a
received.
- If you have decided to have an item record created for each issue an
- `item add form <#addingitems>`__ will appear after choosing 'Arrived'
+ :ref:`item add form <adding-items-label>` will appear after choosing 'Arrived'
Serial item record
|image755|
displayed: "v.69 no.3 (Mar. 2015) suppl."
- If you have decided to have an item record created for each issue an
- `item add form <#addingitems>`__ will appear for your supplement and
+ :ref:`item add form <adding-items-label>` will appear for your supplement and
for the issue itself
- Once you have entered your info you can click 'Save'
the 'Edit' box to the right of each issue and edit the status on
multiple issues at once.
-`Create a Routing List <#routinglist>`__
+.. _create-a-routing-list-label:
+
+Create a Routing List
----------------------------------------
A routing list is a list of people who receive the serial before it goes
to the shelf. To enable routing lists you want to set your
-`RoutingSerials <#RoutingSerials>`__ preference to 'Add'.
+:ref:`RoutingSerials` preference to 'Add'.
When on the subscription page you will see a link to the left that reads
'Create Routing List' or 'Edit Routing List'
Preview Routing List
|image761|
-If `RoutingListAddReserves <#RoutingListAddReserves>`__ is set to on
+If :ref:`RoutingListAddReserves` is set to on
then patrons listed in the routing list will automatically be added to
the holds list for the issue.
To see a list of all of the routing lists a specific patron is on visit
-the `Routing Lists tab <#patronroutingtab>`__ on their patron record.
+the :ref:`Routing Lists tab <routing-lists-label>` on their patron record.
+
+.. _subscriptions-in-staff-client-label:
-`Subscriptions in Staff Client <#serialsubinstaff>`__
+Subscriptions in Staff Client
-----------------------------------------------------
Subscription information will appear on bibliographic records under the
Acquisitions information for subscription
|image764|
-`Subscriptions in OPAC <#serialsubinopac>`__
+.. _subscriptions-in-opac-label:
+
+Subscriptions in OPAC
--------------------------------------------
When viewing the subscription in the OPAC there will be several options.
Under this tab will appear the number of issues you chose when setting
up the subscription or in your
-`OPACSerialIssueDisplayCount <#OPACSerialIssueDisplayCount>`__ system
+:ref:`OPACSerialIssueDisplayCount` system
preference. Clicking the 'More details' link will provide you with
additional information about the serial history. You can set the default
view of a serial in the OPAC with the
-`SubscriptionHistory <#SubscriptionHistory>`__ system preference.
+:ref:`SubscriptionHistory` system preference.
There are two views, compact and full. The compact serial subscription
will show basic information regarding the subscription
From this compact display patrons can subscribe to be notified of new
issues as they are released by clicking the 'Subscribe to email
notifications of new issues' button. For this link to appear you will
-want to have chosen to notify patrons `on the
-subscription <#newsubscription>`__ itself.
+want to have chosen to notify patrons :ref:`on the
+subscription <add-a-subscription-label>` itself.
Subscribe link in the OPAC
|image767|
Full Serial View
|image768|
-`Claim Late Serials <#serialclaims>`__
+.. _claim-late-serials-label:
+
+Claim Late Serials
--------------------------------------
Koha can send email messages to your serial vendors if you have late
choosing the notice template to use and clicking the 'Send notification'
button.
-`Check Serial Expiration <#serialexpiration>`__
+.. _check-serial-expiration-label:
+
+Check Serial Expiration
-----------------------------------------------
When adding serials you enter a subscription length, using the check
Serial Expiration Search Results
|image774|
-`Renewing Serials <#serialrenew>`__
+.. _renewing-serials-label:
+
+Renewing Serials
-----------------------------------
If your serial subscription has expired you won't be able to receive
- Finally enter any notes you might have about this renewal.
-`Searching Serials <#serialsearch>`__
+.. _searching-serials-label:
+
+Searching Serials
-------------------------------------
Once in the Serials module there is basic search box at the top that you
- *Get there:* More > Acquisitions
-`Setup <#acqsetup>`__
+.. _setup-label:
+
+Setup
---------------------
Before using the Acquisitions Module you will want to make sure that you
have completed all of the set up.
-First, set your `Acquisitions System Preferences <#acqprefs>`__ and
-`Acquisitions Administration <#acqadmin>`__ to match your library's
-workflow. Before setting your `EDI Accounts <#ediaccounts>`__ and
-`Library EANs <#libraryeans>`__ you will need to have `entered your
-vendors <#addacqvendor>`__.
+First, set your :ref:`Acquisitions System Preferences <acquisitions-label>` and
+:ref:`Acquisitions Administration <acquisitions-label>` to match your library's
+workflow. Before setting your :ref:`EDI Accounts` and
+:ref:`Library EANs` you will need to have :ref:`entered your
+vendors <add-a-vendor-label>`.
On the main acquisitions page you will see your library's funds listed.
#funds_total {display:none;}
- to the `IntranetUserCSS <#IntranetUserCSS>`__ preference.
+ to the :ref:`IntranetUserCSS` preference.
To see all active funds you can click the checkbox next to 'Show active
and inactive' above the funds table.
Breakdown of orders against the FIC Fund
|image782|
-Learn more in the `Budget/Fund Tracking <#fundtracking>`__ section of
+Learn more in the :ref:`Budget/Fund Tracking` section of
this manual.
-`Vendors <#acqvendors>`__
+.. _vendors-label:
+
+Vendors
-------------------------
Before any orders can be places you must first enter at least one
vendor.
-`Add a Vendor <#addacqvendor>`__
+.. _add-a-vendor-label:
+
+Add a Vendor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To add a vendor click the 'New Vendor' button on the Acquisitions page
- For List Prices and Invoice Prices choose the currency
- - Currencies are assigned in the `Currencies & Exchange
- Rates <#currexchangeadmin>`__ admin area
+ - Currencies are assigned in the :ref:`Currencies & Exchange
+ Rates <currencies-and-exchange-rates-label>` admin area
- If your library is charged tax mark your Tax Number as registered
- Notes are for internal use
-`View/Edit a Vendor <#editacqvendor>`__
+.. _view/edit-a-vendor-label:
+
+View/Edit a Vendor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To view a vendor's information page you must search for the vendor from
Receive shipment button
|image789|
-`Vendor Contracts <#vendorcontracts>`__
+.. _vendor-contracts-label:
+
+Vendor Contracts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can define contracts (with a start and end date) and attach them to
much you spent on a specific contract with a vendor. In some places,
contracts are set up with a minimum and maximum yearly amount.
-`Add a Contract <#addvendorcontract>`__
+.. _add-a-contract-label:
+
+Add a Contract
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
At the top of a Vendor Information Page, you will see a 'New Contract'
Contract Pull Down on New Basket Form
|image793|
-`Managing Suggestions <#managesuggest>`__
+.. _managing-suggestions-label:
+
+Managing Suggestions
-----------------------------------------
Purchase suggestions can be generated in one of two ways. You can create
-suggestions via the staff client either for the library or `on the
-patron's behalf <#patronsuggestions>`__ from their record. Depending on
-your settings in the `suggestion <#suggestionspref>`__ system
+suggestions via the staff client either for the library or :ref:`on the
+patron's behalf <purchase-suggestions-label>` from their record. Depending on
+your settings in the :ref:`suggestion` system
preference, patrons may also be able to make purchase suggestions via
the OPAC. When a suggestion is waiting for library review, it will
appear on the Acquisitions home page under the vendor search.
You can also assign this suggestion to a fund. Edit suggestion fund
-This edit can trigger a notice (defined in the `Notices &
-Slips <#notices>`__ tool with the `TO\_PROCESS <#toprocessnotice>`__
+This edit can trigger a notice (defined in the :ref:`Notices &
+Slips <notices-&-slips-label>` tool with the `TO\_PROCESS <#toprocessnotice>`__
notice) to the fund owner that there is a suggestion ready for them to
-manage if you have turned on the `cron job to generate these
-notices <#emailsuggestfund>`__.
+manage if you have turned on the :ref:`cron job to generate these
+notices <email-suggestions-to-process-label>`.
Once you have clicked 'Submit' the suggestion will be moved to the
matching tab. The status will also be updated on the patron's account in
-the OPAC and an `email notice <#notices>`__ will be sent to the patron
+the OPAC and an :ref:`email notice <notices-&-slips-label>` will be sent to the patron
using the template that matches the status you have chosen.
Purchase suggestions in the OPAC
|image804|
-`Placing Orders <#placingacqorder>`__
+.. _placing-orders-label:
+
+Placing Orders
-------------------------------------
To place an order you must first search for the vendor or bookseller you
**Important**
If you are planning on using EDIFACT to submit your order you will
- need to first set up your library's `EDI Accounts <#ediaccounts>`__
- and `EANs <#libraryeans>`__.
+ need to first set up your library's :ref:`EDI Accounts`
+ and :ref:`EANs <library-eans-label>`.
+
+.. _create-a-basket-label:
-`Create a basket <#createacqbasket>`__
+Create a basket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
- If you're ordering standing items (items which arrive regularly) then
you will want to check the 'Orders are standing' box for this basket
-If you have `added contracts <#addvendorcontract>`__ to the vendor
+If you have :ref:`added contracts <add-a-contract-label>` to the vendor
you're ordering from, you will also have an option to choose which
contract you're ordering these items under.
listed under 'Catalog details.'
- If you allow patrons to make purchase suggestions (learn more in the
- `Managing Suggestions <#managesuggest>`__ section of this manual),
+ :ref:`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.
- 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 <#opacmysuggestions>`__' page
+ patron's ':ref:`My purchase suggestions <my-purchase-suggestions-label>`' page
in the OPAC.
- If you're using the `Serials <#serials>`__ module you can link your
New order from Z39.50 Search
|image821|
-- The next option for ordering is to order from a staged record (`learn
- more about staging records <#stagemarc>`__).
+- The next option for ordering is to order from a staged record (:ref:`learn
+ more about staging records <stage-marc-records-for-import-label>`).
**Note**
- 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 <#MarcFieldsToOrder>`__
+ settings in the :ref:`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.Add orders from staged file
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 <#notices>`__
+that notification can be edited in the :ref:`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.
patrons under the 'Patrons' sectionPatrons
After bringing in the bib information (for all import methods except for
-the staged file), if your `AcqCreateItem <#AcqCreateItem>`__ system
+the staged file), if your :ref:`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.
You cannot edit the quantity manually, you must click 'Add'
below the item form to add as many items as you're ordering.
-- The list of funds is populated by the `funds <#funds>`__ you have
+- The list of funds is populated by the :ref:`funds <funds-label>` you have
assigned in the Acquisitions Administration area.
- The currency pull down will have the
- `currencies <#currexchangeadmin>`__ you set up in the `Acquisitions
- Administration <#acqadmin>`__ area.
+ :ref:`currencies <currencies-and-exchange-rates-label>` you set up in the :ref:`Acquisitions
+ Administration <acquisitions-label>` area.
- The vendor price is the price before any taxes or discounts are
applied.
you enter this, hit tab and Koha will populate the rest of the cost
fields below.
-- If you added Planning Values when `creating the
- Fund <#addbudgetfund>`__, those values will appear in the two
+- If you added Planning Values when :ref:`creating the
+ Fund <add-a-fund-label>`, those values will appear in the two
Planning Value fields.
Once you have filled in all of the fields click 'Save' to add the item
**Important**
- You must close the basket to be able to `receive
- items <#receiveacqorder>`__ when they arrive. Only items in closed
+ You must close the basket to be able to :ref:`receive
+ items <receiving-orders-label>` when they arrive. Only items in closed
baskets will show as ready to receive.
-If you have your `BasketConfirmations <#BasketConfirmations>`__
+If you have your :ref:`BasketConfirmations`
preference set to show a confirmation, you will be asked if you are sure
about closing the basket.
Once your order is entered you can search for it through acquisitions or
view the information on the biblio detail page in the staff client (if
-the `AcquisitionDetails <#AcquisitionDetails>`__ preference is set to
+the :ref:`AcquisitionDetails` preference is set to
'Display).Acquisitions details
-`Create a basket group <#acqbasketgroup>`__
+.. _create-a-basket-group-label:
+
+Create a basket group
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A basket group is simply a group of baskets. In some libraries, you have
bulk. That said, it is possible to have one basket in a basket group if
that's the workflow used in your library.
-`Printing baskets <#printacqbasket>`__
+.. _printing-baskets-label:
+
+Printing baskets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When you are finished adding items to your basket, click 'Close this
Order found on PDF
|image838|
-`Receiving Orders <#receiveacqorder>`__
+.. _receiving-orders-label:
+
+Receiving Orders
---------------------------------------
**Important**
- You must close the basket to be able to `receive
- items <#receiveacqorder>`__ when they arrive. Only items in closed
+ You must close the basket to be able to :ref:`receive
+ items <receiving-orders-label>` when they arrive. Only items in closed
baskets will show as ready to receive.
Orders can be received from the vendor information page
One item marked (rcvd) in basket
|image850|
-`Invoices <#acqinvoices>`__
+.. _invoices-label:
+
+Invoices
---------------------------
When orders are received invoices are generated. Invoices can be
|image853|
If you're allowing the uploading of acquisitions files with the
-`AcqEnableFiles <#AcqEnableFiles>`__ preference you will see the option
+:ref:`AcqEnableFiles` preference you will see the option
to manage invoice files next to the link to 'Go to receipt
page'AcqEnableFiles
in the fields provided and click 'Merge'. The two invoices will become
one.
-`Claims & Late Orders <#acqclaims>`__
+.. _claims-&-late-orders-label:
+
+Claims & Late Orders
-------------------------------------
If you have entered in an email address for the vendors in your system
entered on the vendor record.
If you would rather use a different acquisition claim letter (other than
-the default) you can `create that in the notices module <#addnotices>`__
+the default) you can :ref:`create that in the notices module <adding-notices-&-slips-label>`
and choose it from the menu above the list of late items.
Choose a Claim Letter
|image859|
-`Acquisition Searches <#acqsearch>`__
+.. _acquisition-searches-label:
+
+Acquisition Searches
-------------------------------------
At the top of the various Acquisition pages there is a quick search box
Full Order Search
|image865|
-`Budget/Fund Tracking <#fundtracking>`__
+.. _budget/fund-tracking-label:
+
+Budget/Fund Tracking
----------------------------------------
On the main acquisitions page there will be a table showing you all of
Titles Spent
|image867|
-`EDI Process <#ediprocess>`__
+.. _edi-process-label:
+
+EDI Process
-----------------------------
Previous sections explain all ordering options, this section pulls out
Koha uses the EDIFACT standard not the X12 standard for electronic
ordering.
-`EDI Questions for Vendors <#ediquestions>`__
+.. _edi-questions-for-vendors-label:
+
+EDI Questions for Vendors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You will want to gather the following information from your vendors
before beginning the set up process in Koha.
**EDI Accounts:** *This is the basic connection information for your
-vendor. This will be used to fill in the `EDI Accounts <#ediaccounts>`__
+vendor. This will be used to fill in the :ref:`EDI Accounts`
section.*
- **Vendor:** The name of the vendor
- **Account description(s):** (the summary of what this number is for)
**EANs:** *Each library using EDIfact needs to specify a buyer
-identifier know as a SAN or EAN. This will fill in the `Library
-EANs <#libraryeans>`__ setting.*
+identifier know as a SAN or EAN. This will fill in the :ref:`Library
+EANs <library-eans-label>` setting.*
- **Library**
(92) Assigned by buyer
**MARC Order Fields or Grid Ordering:** *These values will fill in the
-`MarcFieldsToOrder <#MarcFieldsToOrder>`__ preference.*
+:ref:`MarcFieldsToOrder` preference.*
- **price:** MARC21 field that contains the item price
- **sort2:** MARC21 field that will populate custom field sort2
-`EDI Setup <#edisetup>`__
+.. _edi-setup-label:
+
+EDI Setup
~~~~~~~~~~~~~~~~~~~~~~~~~
Before you begin ordering using EDI you will want to take the following
steps:
-- Ask your vendor/bookseller/jobber for `connection
- information <#ediquestions>`__
+- Ask your vendor/bookseller/jobber for :ref:`connection
+ information <edi-questions-for-vendors-label>`
- It might also be beneficial to ask for a few sample EDIFACT files
from the vendor
-- Share with your vendor/bookseller/jobber your `library
- codes <#libsgroups>`__, `item type codes <#itemtypeadmin>`__, `fund
- codes <#funds>`__, and any other codes or `authorized
- values <#authorizedvalues>`__ they might need for creating your MARC
+- Share with your vendor/bookseller/jobber your :ref:`library
+ codes <libraries-&-groups-label>`, :ref:`item type codes <item-types-label>`, :ref:`fund
+ codes <funds-label>`, and any other codes or :ref:`authorized
+ values <authorized-values-label>` they might need for creating your MARC
order records
- Communicate with your support provider or the community about whether
vendors here:
https://github.com/bywatersolutions/koha-plugin-edifact-enhanced
-- `Enter the vendor/bookseller/jobber <#addacqvendor>`__ in
+- :ref:`Enter the vendor/bookseller/jobber <add-a-vendor-label>` in
Acquisitions
-- Review your `Acquisitions system preferences <#acqprefs>`__
+- Review your :ref:`Acquisitions system preferences <acquisitions-label>`
- - Be sure to fill in the `MarcFieldsToOrder <#MarcFieldsToOrder>`__
+ - Be sure to fill in the :ref:`MarcFieldsToOrder`
preference with values for order files
-- Enter your `EDI Accounts <#ediaccounts>`__
+- Enter your :ref:`EDI Accounts`
+
+- Enter your :ref:`Library EANs`
-- Enter your `Library EANs <#libraryeans>`__
+- Turn on the :ref:`EDI Cron <edi-message-processing-label>` so that it can process files
-- Turn on the `EDI Cron <#edicron>`__ so that it can process files
+.. _edi-ordering-label:
-`EDI Ordering <#ediordering>`__
+EDI Ordering
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The first step in ordering using EDI happens on the book vendor's
and/or "MARC order." Once you have this MARC file downloaded to your
computer you will want to log in to Koha and continue the process there.
-Visit the `Stage MARC Records for Import <#stagemarc>`__ tool and upload
+Visit the :ref:`Stage MARC Records for Import` tool and upload
your file. Once presented with the confirmation screen proceed to
Acquisitions.
-In Acquisitions `create a basket <#createacqbasket>`__ for the vendor
+In Acquisitions :ref:`create a basket <create-a-basket-label>` for the vendor
you ordered from. From the basket, choose to `order from a staged
file <#orderfromstagedfile>`__ and click 'Order' next to the file you
downloaded from your vendor and staged in Koha.
From the confirmation screen you will see all of the data in the MARC
file related to your order. If you are not seeing fields such as fund
-and quanity filled in then be sure to confirm that your
-`MarcFieldsToOrder <#MarcFieldsToOrder>`__ preference is set right.
+and quantity filled in then be sure to confirm that your
+:ref:`MarcFieldsToOrder` preference is set right.
Once you have added all of the items to the basket you can click the
'Create EDIFACT order' button.
EDIFACT Order
-This will generate a pending file in the `EDIFACT
-Messages <#edifactmsg>`__ in Koha. The pending files will be processed
-by the `EDI Cron Job <#edicron>`__ and sent to your vendor.
+This will generate a pending file in the :ref:`EDIFACT
+Messages <edifact-messages-label>` in Koha. The pending files will be processed
+by the :ref:`EDI Cron Job <edi-message-processing-label>` and sent to your vendor.
-`EDI Invoicing <#ediinvoice>`__
+.. _edi-invoicing-label:
+
+EDI Invoicing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When the book vendor is done processing your files they will send an
-invoice via EDI as well. The `EDI Cron Job <#edicron>`__ will grab
+invoice via EDI as well. The :ref:`EDI Cron Job <edi-message-processing-label>` will grab
invoices and mark items found in the invoice as received and update your
funds without any need for manual intervention.
-`EDIFACT Messages <#edifactmsg>`__
+.. _edifact-messages-label:
+
+EDIFACT Messages
----------------------------------
A log of all messages sent and received via EDIFACT can be found under
- *Get there:* More > Lists
-`Lists <#lists>`__
+.. _lists-label:
+
+Lists
------------------
-`Create a List <#createlist>`__
+.. _create-a-list-label:
+
+Create a List
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A list can be created by visiting the Lists page and clicking 'New List'
Once the list is saved it will accessible from the Lists page and from
the 'Add to' menu at the top of the search results.
-`Add to a List <#addtolist>`__
+.. _add-to-a-list-label:
+
+Add to a List
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To add titles to an existing list click on the list name from the page
Add to List
|image874|
-`Viewing Lists <#viewlist>`__
+.. _viewing-lists-label:
+
+Viewing Lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To see the contents of a list, visit the Lists page on the staff client
- 'Edit' will allow you to edit the description and permissions for
this list
-- 'Send list' will send the list to the email address you enter (`view
- sample List email <#examplelistemail>`__)
+- 'Send list' will send the list to the email address you enter (:ref:`view
+ sample List email <example-email-from-list-label>`)
- 'Download list' will allow you to download the cart using one of 3
- default formats or your `CSV Profiles <#csvprofiles>`__
+ default formats or your :ref:`CSV Profiles`
- 'Print list' will present you with a printable version of the list
Using the filters at the top of each column you can find specific items
in your list.
-`Merging Bibliographic Records Via Lists <#mergebibrecs>`__
+.. _merging-bibliographic-records-via-lists-label:
+
+Merging Bibliographic Records Via Lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
One way to merge together duplicate bibliographic records is to add them
|image877|
Once you have selected the records to merge together the process is the
-same as if you had chosen to `merge via cataloging <#mergebibs>`__.
+same as if you had chosen to :ref:`merge via cataloging <merging-records-label>`.
+
+.. _cart-label:
-`Cart <#cart>`__
+Cart
----------------
The cart is a temporary holding place for items in the OPAC and/or staff
be printed or emailed to yourself or a patron.
If you would like to enable the cart in the staff client, you need to
-set the `intranetbookbag <#intranetbookbag>`__ system preference to
+set the :ref:`intranetbookbag` system preference to
'Show.' To add things to the cart, search the catalog and select the
items you would like added to your cart and choose 'Cart' from the 'Add
to' menu
- 'More details' will show more information about the items in the cart
-- 'Send' will send the list to the email address you enter (`view
- sample Cart email <#examplecartemail>`__)
+- 'Send' will send the list to the email address you enter (:ref:`view
+ sample Cart email <example-email-from-cart-label>`)
- 'Download' will allow you to download the cart using one of 3 default
- formats or your `CSV Profiles <#csvprofiles>`__
+ formats or your :ref:`CSV Profiles`
- 'Print' will present you with a printable version of the cart
- *Get there:* More > Reports
-`Custom Reports <#customreports>`__
+.. _custom-reports-label:
+
+Custom Reports
-----------------------------------
Koha's data is stored in a MySQL database which means that librarians
can generate nearly any report they would like by either using the
-`Guided Reports Wizard <#quidedreportwizard>`__ or writing their own
-`SQL query <#reportfromsql>`__.
+:ref:`Guided Reports Wizard <guided-report-wizard-label>` or writing their own
+:ref:`SQL query <report-from-sql-label>`.
+
+.. _add-custom-report-label:
-`Add Custom Report <#customreport>`__
+Add Custom Report
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Guided Report Wizard <#quidedreportwizard>`__
+.. _guided-report-wizard-label:
+
+Guided Report Wizard
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The guided report wizard will walk you through a six step process to
your results using the filter menu on the left or use the tabs to find
reports based on your custom groups.
-`Report from SQL <#reportfromsql>`__
+.. _report-from-sql-label:
+
+Report from SQL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In addition to the report wizard, you have the option to write your own
Once everything is entered click the 'Save Report' button and you'll be
presented with options to run it. Once a report is saved you do not have
to recreate it you can simply find it on the Saved Reports page and
-`run <#runcustomreport>`__ or `edit <#editcustomreports>`__ it.
+:ref:`run <running-custom-reports-label>` or :ref:`edit <edit-custom-reports-label>` it.
-`Duplicate Report <#duplicatereport>`__
+.. _duplicate-report-label:
+
+Duplicate Report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Reports can also be added by duplicating an existing report. Visit the
your new report. That will populate the new report form with the
existing SQL for easy editing and resaving.
-`Edit Custom Reports <#editcustomreports>`__
+.. _edit-custom-reports-label:
+
+Edit Custom Reports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Every report can be edited from the reports lists. To see the list of
Edit SQL Form
|image898|
-`Running Custom Reports <#runcustomreport>`__
+.. _running-custom-reports-label:
+
+Running Custom Reports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once custom reports are saved to Koha, you can run them by going to the
A Comma Separated Text file is a CSV file and it can be opened by
any spreadsheet application.
-`Statistics Reports <#statsreports>`__
+.. _statistics-reports-label:
+
+Statistics Reports
--------------------------------------
Statistic reports will show you counts and sums. These reports are all
about numbers and statistics, for reports that return more detailed
-data, use the `Guided Report Wizard <#quidedreportwizard>`__. These
+data, use the :ref:`Guided Report Wizard`. These
reports are limited in what data they can look at, so it's often
-recommended to use `custom reports <#customreports>`__ for official end
+recommended to use :ref:`custom reports <custom-reports-label>` for official end
of the year statistics.
-`Acquisitions Statistics <#acqstats>`__
+.. _acquisitions-statistics-label:
+
+Acquisitions Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
These reports are limited in what data they can look at, so it's
- often recommended to use `custom reports <#customreports>`__ for
+ often recommended to use :ref:`custom reports <custom-reports-label>` for
official end of the year statistics.
Using the form provided, choose which value you would like to appear in
Acquisitions statistics with totals
|image905|
-`Patron Statistics <#patstats>`__
+.. _patron-statistics-label:
+
+Patron Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
These reports are limited in what data they can look at, so it's
- often recommended to use `custom reports <#customreports>`__ for
+ often recommended to use :ref:`custom reports <custom-reports-label>` for
official end of the year statistics.
Using the form provided, choose which value you would like to appear in
results table. You can also choose to export to a file that you can
manipulate to your needs.
-`Catalog Statistics <#catstats>`__
+.. _catalog-statistics-label:
+
+Catalog Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
These reports are limited in what data they can look at, so it's
- often recommended to use `custom reports <#customreports>`__ for
+ often recommended to use :ref:`custom reports <custom-reports-label>` for
official end of the year statistics.
Using the form provided, choose which value you would like to appear in
You can also choose to export to a file that you can manipulate to your
needs.
-`Circulation Statistics <#circstats>`__
+.. _circulation-statistics-label:
+
+Circulation Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
These reports are limited in what data they can look at, so it's
- often recommended to use `custom reports <#customreports>`__ for
+ often recommended to use :ref:`custom reports <custom-reports-label>` for
official end of the year statistics.
Using the form provided, choose which value you would like to appear in
- For a single day, an example would be: 11/15/2009 to 11/16/2009
to find what circulated on the 15th
-`Tracking in house use <#inhouseuse>`__
+.. _tracking-in-house-use-label:
+
+Tracking in house use
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Using the Circulation statistics reporting wizard you can run reports on
In House Use Stats
|image912|
-`Serials Statistics <#serialstats>`__
+.. _serials-statistics-label:
+
+Serials Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
These reports are limited in what data they can look at, so it's
- often recommended to use `custom reports <#customreports>`__ for
+ often recommended to use :ref:`custom reports <custom-reports-label>` for
official end of the year statistics.
Using the form provided, choose how you would like to list the serials
You can also choose to export to a file that you can manipulate to your
needs.
-`Holds Statistics <#holdstats>`__
+.. _holds-statistics-label:
+
+Holds Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Note**
These reports are limited in what data they can look at, so it's
- often recommended to use `custom reports <#customreports>`__ for
+ often recommended to use :ref:`custom reports <custom-reports-label>` for
official end of the year statistics.
Using the form provided you can see statistics for holds placed, filled,
You can also choose to export to a file that you can manipulate to your
needs.
-`Patrons with the most checkouts <#mostcheckouts>`__
+.. _patrons-with-the-most-checkouts-label:
+
+Patrons with the most checkouts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will simply list the patrons who have the most checkouts.
You can also choose to export to a file that you can manipulate to your
needs.
-`Most Circulated Items <#mostcirculated>`__
+.. _most-circulated-items-label:
+
+Most Circulated Items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will simply list the items that have the been checked out
You can also choose to export to a file that you can manipulate to your
needs.
-`Patrons with no checkouts <#patnocheckouts>`__
+.. _patrons-with-no-checkouts-label:
+
+Patrons with no checkouts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will list for you the patrons in your system who haven't
You can also choose to export to a file that you can manipulate to your
needs.
-`Items with no checkouts <#itemnocheckouts>`__
+.. _items-with-no-checkouts-label:
+
+Items with no checkouts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will list items in your collection that have never been
You can also choose to export to a file that you can manipulate to your
needs.
-`Catalog by Item Type <#catbyitem>`__
+.. _catalog-by-item-type-label:
+
+Catalog by Item Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will list the total number of items of each item type per
You can also choose to export to a file that you can manipulate to your
needs.
-`Lost Items <#lostreport>`__
+.. _lost-items-label:
+
+Lost Items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will allow you to generate a list of items that have been
Lost Items Report
|image927|
-`Average Loan Time <#avloantime>`__
+.. _average-loan-time-label:
+
+Average Loan Time
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This report will list the average time items are out on loan based on
You can also choose to export to a file that you can manipulate to your
needs.
-`Report Dictionary <#reportdic>`__
+.. _report-dictionary-label:
+
+Report Dictionary
----------------------------------
The report dictionary is a way to pre-define common filters you'd like
This chapter assumes that you have the following preferences set as
follows:
-- `opacthemes <#opacthemes>`__ = bootstrap
+- :ref:`opacthemes` = bootstrap
-- `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ = default
+- :ref:`OPACXSLTResultsDisplay` = default
-- `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ = default
+- :ref:`OPACXSLTDetailsDisplay` = default
-- `DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__ = show
+- :ref:`DisplayOPACiconsXSLT` = show
-- `TagsEnabled <#TagsEnabled>`__ = Allow
+- :ref:`TagsEnabled` = Allow
-- `TagsInputOnDetail <#TagsInputOnDetail>`__ =Allow
+- :ref:`TagsInputOnDetail` =Allow
-- `TagsInputOnList <#TagsInputOnList>`__ = Allow
+- :ref:`TagsInputOnList` = Allow
-- `reviewson <#reviewson>`__ = Allow
+- :ref:`reviewson` = Allow
-- `ShowReviewer <#ShowReviewer>`__ = Allow
+- :ref:`ShowReviewer` = Allow
-- `ShowReviewerPhoto <#ShowReviewerPhoto>`__ =Allow
+- :ref:`ShowReviewerPhoto` =Allow
-- `OPACFRBRizeEditions <#OPACFRBRizeEditions>`__ = Show
+- :ref:`OPACFRBRizeEditions` = Show
-- `OPACAmazonCoverImages <#OPACAmazonCoverImages>`__ = Show
+- :ref:`OPACAmazonCoverImages` = Show
-- `XISBN <#XISBN>`__ = Use
+- :ref:`XISBN` = Use
-- `OPACSearchForTitleIn <#OPACSearchForTitleIn>`__ = Default set of
+- :ref:`OPACSearchForTitleIn` = Default set of
links
-- `OPACShowCheckoutName <#OPACShowCheckoutName>`__ = Don't show
+- :ref:`OPACShowCheckoutName` = Don't show
-- `RequestOnOpac <#RequestOnOpac>`__ = Allow
+- :ref:`RequestOnOpac` = Allow
-- `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ = Allow
+- :ref:`AutoResumeSuspendedHolds` = Allow
-- `OpacBrowseResults <#OpacBrowseResults>`__ = Enable
+- :ref:`OpacBrowseResults` = Enable
-- `SuspendHoldsOpac <#SuspendHoldsOpac>`__ = Allow
+- :ref:`SuspendHoldsOpac` = Allow
-- `OPACShowBarcode <#OPACShowBarcode>`__ = Don't show
+- :ref:`OPACShowBarcode` = Don't show
-- `OpacSeparateHoldings <#OpacSeparateHoldings>`__ = Don't separate
+- :ref:`OpacSeparateHoldings <opacseparateholdings-&-opacseparateholdingsbranch-label>` = Don't separate
-- `OpacSeparateHoldingsBranch <#OpacSeparateHoldings>`__ = home library
+- :ref:`OpacSeparateHoldingsBranch <opacseparateholdings-&-opacseparateholdingsbranch-label>` = home library
-- `DisplayLibraryFacets <#DisplayLibraryFacets>`__ = holding library
+- :ref:`DisplayLibraryFacets` = holding library
If your system preferences are set differently your displays may differ.
-`Search Results <#opacsearchresults>`__
+.. _search-results-label:
+
+Search Results
---------------------------------------
To search the OPAC you can either choose to enter your search words in
For more on searching check the '`Searching <#searching>`__' chapter in
this manual.
-`Results Overview <#opacresultsoverview>`__
+.. _results-overview-label:
+
+Results Overview
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
After performing a search the number of results found for your search
|image938|
By default your search results will be sorted based on your
-`OPACdefaultSortField and OPACdefaultSortOrder <#opacdefaultsort>`__
+:ref:`OPACdefaultSortField and OPACdefaultSortOrder`
system preference values. To change this you can choose another sorting
method from the pull down on the right.
with the item types or collection codes you have applied to your
records, this data is all pulled from your fixed fields. This can be
turned on or off with the
-`DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__ system preference.
+:ref:`DisplayOPACiconsXSLT` system preference.
Leader Visualization
|image940|
Holdings Information
|image941|
-If you have turned on `Enhanced Content <#enhancedcontent>`__
+If you have turned on :ref:`Enhanced Content`
preferences you may have book jackets on your search results.
Book Jacket on Results
|image942|
-If you have set your `Did you mean? <#didyoumean>`__ options you will
+If you have set your :ref:`Did you mean? <did-you-mean?-label>` options you will
see a yellow bar across the top of your results will other related
searches.
edit your advanced search blow the list of results pages.Return to the
last advanced search
-`Filters <#opacfilter>`__
+.. _filters-label:
+
+Filters
~~~~~~~~~~~~~~~~~~~~~~~~~
To filter your results click on the links below the 'Refine Your Search'
|image944|
Depending on your setting for the
-`DisplayLibraryFacets <#DisplayLibraryFacets>`__ system preference you
+:ref:`DisplayLibraryFacets` system preference you
will see filters for your home, holding or both libraries.Library Facet
After clicking a facet you can remove that filter from your results by
clicking the small 'x' that appears to the right of the facet.Remove
library facet
-`Search RSS Feeds <#searchrss>`__
+.. _search-rss-feeds-label:
+
+Search RSS Feeds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You will be able to subscribe to your search results as an RSS feed by
Subscribing to search results as RSS feeds will allow you to see when a
new item is added to the catalog in your area of interest.
-`Bibliographic Record <#opacbibrec>`__
+.. _bibliographic-record-label:
+
+Bibliographic Record
--------------------------------------
When you click on a title from the search results, you're brought to the
Authority link
|image948|
-If you have your `DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__
+If you have your :ref:`DisplayOPACiconsXSLT`
preference set to 'show' you will see a material type that is determined
by values in your fixed fields (learn more in the `XSLT Item
Types <#XSLTiTypes>`__ Appendix).
|image961|
Clicking 'More Searches' will show the list of libraries you entered in
-your `OPACSearchForTitleIn <#OPACSearchForTitleIn>`__ preference
+your :ref:`OPACSearchForTitleIn` preference
More Searches
|image962|
Under the 'Save Record' label you will find a series of file formats you
can save the record as. This list can be customized by altering the
-`OpacExportOptions <#OpacExportOptions>`__ system preference.
+:ref:`OpacExportOptions` system preference.
Save Record
|image963|
Record Views
|image964|
-`Lists & Cart <#opaclistscart>`__
+.. _lists-&-cart-label:
+
+Lists & Cart
---------------------------------
A cart is a temporary holding place for records you're interested in
check the `Lists in the Staff Client <#stafflists>`__ chapter of this
manual.
-`Lists <#opaclists>`__
+.. _lists-label:
+
+Lists
~~~~~~~~~~~~~~~~~~~~~~
Patrons can manage their own private lists by visiting the 'my lists'
Lists Management
|image965|
-`Creating Lists <#opacaddlists>`__
+.. _creating-lists-label:
+
+Creating Lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lists can also be created by choosing the 'New List' option in the 'Add
**Important**
If you aren't allowing patrons to create public lists with the
- `OpacAllowPublicListCreation <#OpacAllowPublicListCreation>`__
+ :ref:`OpacAllowPublicListCreation`
preference then patrons will only be able to create private lists.
Create a new private list
- anyone to remove other contributed entries
-`Adding titles to Lists <#opacaddtolists>`__
+.. _adding-titles-to-lists-label:
+
+Adding titles to Lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Titles can be added to lists from the search results and/or from the
add and then choose the list you want to add the titles to from the 'Add
too' pull down at the top of the screen.
-`Viewing Lists Contents <#listscontent>`__
+.. _viewing-lists-contents-label:
+
+Viewing Lists Contents
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To view the contents of a list, click on the list name under the Lists
choose the format you'd like to download the list in
- To email the list contents to someone, click the 'Send List' link and
- enter in your email details in the form that pops up (`view a sample
- Lists email <#examplelistemail>`__)
+ enter in your email details in the form that pops up (:ref:`view a sample
+ Lists email <example-email-from-list-label>`)
Email List Contents
|image972|
- To print the contents of your list out click the 'Print List' link
-`Managing Lists <#opacmanagelists>`__
+.. _managing-lists-label:
+
+Managing Lists
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once the list is saved patrons can begin adding items to it. From the
the right of the list you'd like to delete.
If the library is allowing you to share private lists with the
-`OpacAllowSharingPrivateLists <#OpacAllowSharingPrivateLists>`__
+:ref:`OpacAllowSharingPrivateLists`
preference then you will see the 'Share' link on your list of lists and
the 'Share list' link at the top of each individual list. Clicking this
will ask you to enter the email address of a patron.Share list
and will send a message to that patron.
-`Cart <#opaccart>`__
+.. _cart-label:
+
+Cart
~~~~~~~~~~~~~~~~~~~~
-`Adding titles to the Cart <#opacaddtocart>`__
+.. _adding-titles-to-the-cart-label:
+
+Adding titles to the Cart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Titles can be added to the cart from the search results and/or from the
From the results you will see which items are in your cart and will be
able to remove those items by clicking '(remove)'.Item in your cart
-`Managing the Cart <#manageopaccart>`__
+.. _managing-the-cart-label:
+
+Managing the Cart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once you have titles in your cart you can manage the contents by
address. This is handy if you want to send the resources you found at
the library to your home email account to refer to later or to send to a
patron researching a specific topic. Clicking this link will open up a
-new window that asks for the email address and message to send. `View a
-sample Cart email <#examplecartemail>`__.
+new window that asks for the email address and message to send. :ref:`View a
+sample Cart email <example-email-from-cart-label>`.
Email Cart
|image980|
your cart email function from being used for spamming.
In addition to sending your cart you can download the contents of your
-cart in several pre-defined formats or using a `CSV
-Profile <#csvprofiles>`__ that you defined in the Tools module.
+cart in several pre-defined formats or using a :ref:`CSV
+Profile <csv-profiles-label>` that you defined in the Tools module.
Download Cart
|image981|
'Tag'). All of these operations follow the same procedure as they do
when performing them in the OPAC.
-`Placing Holds <#opacplacehold>`__
+.. _placing-holds-label:
+
+Placing Holds
----------------------------------
Patrons can place holds on items via the OPAC if they're logged in and
-you have the `RequestOnOpac <#RequestOnOpac>`__ preference set to
+you have the :ref:`RequestOnOpac` preference set to
'Allow'. If the item can be placed on hold the option to place it on
hold will appear in several different places.
- The priority shows where in the holds queue this hold will fall
- If allowed by your
- `OPACAllowUserToChooseBranch <#OPACAllowUserToChooseBranch>`__
+ :ref:`OPACAllowUserToChooseBranch`
preference the patron can choose where they'd like to pick up their
hold
Place Hold Form with More Options
- If you have the
- `AllowHoldItemTypeSelection <#AllowHoldItemTypeSelection>`__
+ :ref:`AllowHoldItemTypeSelection`
preference set to 'Allow' and the record had more than one item
type attached you will see an option to choose to limit the hold
to a specific item typeAllowHoldItemTypeSelection
- If allowed by your
- `OPACAllowHoldDateInFuture <#OPACAllowHoldDateInFuture>`__
+ :ref:`OPACAllowHoldDateInFuture`
preference, the 'Hold Starts on Date' column will show. This field
allows the patron to have their hold start on a future date.
- **Important**
- Expired holds are removed by the `Expired Holds Cron
- Job <#expiredholdscron>`__, this is not an automatic process
+ Expired holds are removed by the :ref:`Expired Holds Cron
+ Job <expired-holds-label>`, this is not an automatic process
and must be set up by your system administrator
-- If allowed by the `OpacHoldNotes <#OpacHoldNotes>`__ preference then
+- If allowed by the :ref:`OpacHoldNotes` preference then
patrons can leave notes about their holds for the library by clicking
the 'Edit notes' button
|image986|
- Depending on the rules you set regarding item specific holds in your
- `circulation and fines rules <#circfinerules>`__ the patron will be
+ :ref:`circulation and fines rules <circulation-and-fine-rules-label>` the patron will be
allowed to choose whether to place the hold on the next available
copy and/or a specific copy
After clicking the Place Hold button the patron will be brought to their
account page where they'll see all of the items they have on hold.
-`Enhanced Content <#opacenhancedcontent>`__
+.. _enhanced-content-label:
+
+Enhanced Content
-------------------------------------------
-`Tagging <#opactagging>`__
+.. _tagging-label:
+
+Tagging
~~~~~~~~~~~~~~~~~~~~~~~~~~
-Depending on your settings for the `TagsEnabled <#TagsEnabled>`__,
-`TagsInputOnList <#TagsInputOnList>`__ and
-`TagsInputOnDetail <#TagsInputOnDetail>`__ preferences you may be able
+Depending on your settings for the :ref:`TagsEnabled`,
+:ref:`TagsInputOnList` and
+:ref:`TagsInputOnDetail` preferences you may be able
to add tags to bibliographic records from the search results and/or
bibliographic records. If you are allowing patrons to add tags from the
search results screen you will see an input box below each result and a
Add Tags to Multiple Items
|image990|
-`Comments <#opaccomments>`__
+.. _comments-label:
+
+Comments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Patrons can leave comments in the OPAC if you have the
-`reviewson <#reviewson>`__ preference set to allow this. Each
+:ref:`reviewson` preference set to allow this. Each
bibliographic record has a comments tab below the bibliographic
information.
Once the comment is approved the patron will see the number of comments
on the 'Comments' tab and their comment labeled amongst the other
comments. If you have set your
-`ShowReviewerPhoto <#ShowReviewerPhoto>`__ preference to 'Show' then
+:ref:`ShowReviewerPhoto` preference to 'Show' then
you'll see the patron's photo pulled from the
`Libravatar <https://www.libravatar.org>`__ library.
|image994|
Other patrons will see the comment with the name of the patron who left
-the comment (unless you have set the `ShowReviewer <#ShowReviewer>`__
+the comment (unless you have set the :ref:`ShowReviewer`
preference to not show patron names).
Comment by other patron
|image995|
-If you have your `OpacShowRecentComments <#OpacShowRecentComments>`__
+If you have your :ref:`OpacShowRecentComments`
set to show then you'll see the approved comments on that page.
Recent Comments List
From this page patrons can subscribe to the recent comments using RSS if
they would like.
-`Zotero <#zotero>`__
+.. _zotero-label:
+
+Zotero
~~~~~~~~~~~~~~~~~~~~
Zotero is a Firefox add on that allows for the saving and generating of
Title in the Zotero Library
|image998|
-`Custom RSS Feeds <#customrss>`__
+.. _custom-rss-feeds-label:
+
+Custom RSS Feeds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Using misc/cronjobs/rss/rss.pl you can generate an RSS feed for any SQL
To use custom RSS feeds you need to turn on the rss.pl cron job.
-`OPAC Self Registration <#selfregistration>`__
+.. _opac-self-registration-label:
+
+OPAC Self Registration
----------------------------------------------
If you allow it, patrons can register for their own accounts via the
OPAC. If you have the
-`PatronSelfRegistration <#PatronSelfRegistration>`__ preference set to
+:ref:`PatronSelfRegistration` preference set to
'Allow' then patrons will see a link to register below the log in box on
the right of the main OPAC page.
When the patron clicks the 'Register here' link they will be brough to a
registration page. The options on the registration page can be conrolled
by editing the
-`PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
+:ref:`PatronSelfRegistrationBorrowerMandatoryField`
and the
-`PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
+:ref:`PatronSelfRegistrationBorrowerUnwantedField`
preferences.
Registration form
Once the patron has confirmed submitted their registration they will
either be sent an email to confirm their account (if you have the
-`PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
+:ref:`PatronSelfRegistrationVerifyByEmail`
preference to require this) or presented with their new username and
password.
one by the library, but will have access to all OPAC functionality
immediately. For this reason it is recommended that you:
-- set up a provisional `patron category <#addingpatroncat>`__ for self
+- set up a provisional :ref:`patron category <adding-a-patron-category-label>` for self
registered patrons (such as 'Self Registered) instead of using an
existing patron category and set that value in the
- `PatronSelfRegistrationDefaultCategory <#PatronSelfRegistrationDefaultCategory>`__
+ :ref:`PatronSelfRegistrationDefaultCategory`
preference
- give this patron category minimal circulation privileges in the
- `Circulation and Fine Rules <#circfinerules>`__ (such as allowing a
+ :ref:`Circulation and Fine Rules` (such as allowing a
couple holds, but no check outs)
That way patrons will either have to come in to the library to verify
more appropriate (be it an adult, resident, non resident, student, etc)
and add a cardnumber/barcode.
-`My Account <#opacmyaccount>`__
+.. _my-account-label:
+
+My Account
-------------------------------
From the OPAC patrons can log in and access their account if you have
-set the `opacuserlogin <#opacuserlogin>`__ preference to 'Allow'. Once
+set the :ref:`opacuserlogin` preference to 'Allow'. Once
logged in patrons are brought to their account summary. If you would
like to get to your account in the OPAC, you can click on your name in
the top right of any page in the OPAC.
-`Resetting your password <#resetpwopac>`__
+.. _resetting-your-password-label:
+
+Resetting your password
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you have the `OpacResetPassword <#OpacResetPassword>`__ set to allow
+If you have the :ref:`OpacResetPassword` set to allow
patrons to reset their password they can click 'Forgot your password?'
link found under the log in box to reset their passwords.
The system will then email the patron instructions for resetting their
password.Reset password confirmation
-`My Summary <#opacmysummary>`__
+.. _my-summary-label:
+
+My Summary
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
My Summary
From the 'my summary' tab, patrons will see all of the items they have
checked out with the overdue items highlighted in red. If you have
-`OpacRenewalAllowed <#OpacRenewalAllowed>`__ set to 'Allow' then your
+:ref:`OpacRenewalAllowed` set to 'Allow' then your
patrons will be able to renew their books right from the OPAC. If you
-have HTML entered in the `OPACMySummaryHTML <#OPACMySummaryHTML>`__
+have HTML entered in the :ref:`OPACMySummaryHTML`
preference then you will see that to the right of the 'Fines' column.
Checked out tab with OPACMySummaryHTML set
|image1004|
If your patrons would like to see the items barcodes on their list of
-checked out items you can set up a `patron
-attribute <#patronattributetypes>`__ with the value of SHOW\_BCODE and
-`authorized value <#authorizedvalues>`__ of YES\_NO.
+checked out items you can set up a :ref:`patron
+attribute <patron-attribute-types-label>` with the value of SHOW\_BCODE and
+:ref:`authorized value <authorized-values-label>` of YES\_NO.
Add SHOW\_BCODE patron attribute
|image1005|
-Then on the `patron's record set the value <#editpatrons>`__ for
+Then on the :ref:`patron's record set the value <editing-patrons-label>` for
SHOW\_BCODE to yes.
Setting value for SHOW\_BCODE on patron record
Barcode number on checkout list in OPAC
|image1007|
-If their guarantee has allowed it via `their
-privacy <#opacmyprivacy>`__, when the guarantor logs in they will see a
+If their guarantee has allowed it via :ref:`their
+privacy <my-privacy-label>`, when the guarantor logs in they will see a
tab labeled "Relatives' checkouts" on their summary tab.Relatives'
checkouts
on the total will take them to the 'my fines' tab where they will see a
complete breakdown of their fines and bills. If you don't charge fines
at your library you can turn the display of these tabs off by setting
-the `OPACFinesTab <#OPACFinesTab>`__ preference to 'Don't Allow.'
+the :ref:`OPACFinesTab` preference to 'Don't Allow.'
Patron Fines
|image1009|
|image1010|
Patrons can cancel or suspend (depending on the value of your
-`SuspendHoldsOpac <#SuspendHoldsOpac>`__ system preference) their own
+:ref:`SuspendHoldsOpac` system preference) their own
holds if they are not in transit or already waiting for them. When they
click 'Suspend' they will be presented with the option to choose a date
for their hold to resume.Suspend until
**Note**
If you have your
- `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ preference
+ :ref:`AutoResumeSuspendedHolds` preference
set to "Don't allow" then you will not have the option to put an end
date on the hold suspension
-`Patron Flags <#opacmyaccount-flags>`__
+.. _patron-flags-label:
+
+Patron Flags
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have `flagged your patron's account <#patronflags>`__ they may
- **Note**
this error message will not include a link to the update form
- if you have `OPACPatronDetails <#OPACPatronDetails>`__ set to
+ if you have :ref:`OPACPatronDetails` set to
'Don't allow'
- Patron marked restricted
Patron restricted
|image1013|
-`My Fines <#opacmyfines>`__
+.. _my-fines-label:
+
+My Fines
~~~~~~~~~~~~~~~~~~~~~~~~~~~
If your library charges fines the next tab on the left is 'my fines.'
|image1014|
If you are allowing patrons to pay their fines using PayPal with the
-`EnablePayPalOpacPayments <#EnablePayPalOpacPayments>`__ preference
+:ref:`EnablePayPalOpacPayments <enablepaypalopacpayments-&-paypalsandboxmode-label>` preference
there will be checkboxes to the left of each fine with an outstanding
amount.Fines with checkboxes
And you will see that the fine was paid using PayPal on the staff
side.Staff side fines
-`My Details <#opacmydetails>`__
+.. _my-details-label:
+
+My Details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you have your `OPACPatronDetails <#OPACPatronDetails>`__ preference
+If you have your :ref:`OPACPatronDetails` preference
set to 'Allow', your patrons will see a form filled in with their
contacting information by clicking on the 'my personal details' tab. You
can control what fields patrons see and can modify via the OPAC by
setting the
-`PatronSelfRegistrationBorrowerMandatoryField <#PatronSelfRegistrationBorrowerMandatoryField>`__
-`PatronSelfRegistrationBorrowerUnwantedField <#PatronSelfRegistrationBorrowerUnwantedField>`__
+:ref:`PatronSelfRegistrationBorrowerMandatoryField`
+:ref:`PatronSelfRegistrationBorrowerUnwantedField`
preferences.
Patron's personal details
Patron requests waiting review
|image1017|
-If the `OPACPatronDetails <#OPACPatronDetails>`__ preference is set to
+If the :ref:`OPACPatronDetails` preference is set to
'Don't allow' then patrons will simply see their details and a message
stating that they should contact the library for changes.
Patron's personal details with no edits
|image1018|
-`My Tags <#opacmytags>`__
+.. _my-tags-label:
+
+My Tags
~~~~~~~~~~~~~~~~~~~~~~~~~
-If your library has `TagsEnabled <#TagsEnabled>`__ set to 'Allowed' then
+If your library has :ref:`TagsEnabled` set to 'Allowed' then
the next tab on the left will be 'my tags.' This tab will show patrons
all of the tags in the system as a cloud and then all of the tags they
have applied in a list format. From here patrons have the ability to
Patron's tags
|image1019|
-`Change My Password <#opacmypassword>`__
+.. _change-my-password-label:
+
+Change My Password
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Next, if you have `OpacPasswordChange <#OpacPasswordChange>`__ set to
+Next, if you have :ref:`OpacPasswordChange` set to
'Allow' the next tab will be 'change my password,' where patrons can
change their password for logging into the OPAC. Patrons will be
presented with a standard form asking them to enter their old password
Change my password
|image1020|
-`My Search History <#opacmysearchistory>`__
+.. _my-search-history-label:
+
+My Search History
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you have your `EnableOpacSearchHistory <#EnableOpacSearchHistory>`__
+If you have your :ref:`EnableOpacSearchHistory`
preference set to 'Allow' then your patrons can access their search
history via the 'my search history' tab.
Search history link at the top right of the OPAC
|image1022|
-`My Reading History <#opacmyhistory>`__
+.. _my-reading-history-label:
+
+My Reading History
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Depending on your library's setting for
-`opacreadinghistory <#opacreadinghistory>`__ your patrons may see the
+:ref:`opacreadinghistory` your patrons may see the
'my reading history' tab next. This will show the patron their entire
reading history unless they have asked the library to not keep that
information via the 'my privacy' tab which will appear if you have the
-`OPACPrivacy <#OPACPrivacy>`__ preference set to 'Allow.'
+:ref:`OPACPrivacy` preference set to 'Allow.'
Patron reading history
|image1023|
If you have HTML entered in the
-`OPACMySummaryHTML <#OPACMySummaryHTML>`__ preference then you will see
+:ref:`OPACMySummaryHTML` preference then you will see
that to the right of the 'Date' column.
-`My Privacy <#opacmyprivacy>`__
+.. _my-privacy-label:
+
+My Privacy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'my privacy' tab will appear if you have both the
-`opacreadinghistory <#opacreadinghistory>`__ and the
-`OPACPrivacy <#OPACPrivacy>`__ preferences set to 'Allow.' This tab will
+:ref:`opacreadinghistory` and the
+:ref:`OPACPrivacy` preferences set to 'Allow.' This tab will
allow the patrons to decide how the library keeps their circulation
history data.
- Never: Delete my reading history immediately. This will delete all
record of the item that was checked-out upon check-in.
-Depending on the patron's suggestions the contents of the '`my reading
-history <#opacmyhistory>`__' tab and the '`Circulation
-History <#circhistory>`__' tab in the staff client may change.
+Depending on the patron's suggestions the contents of the ':ref:`my reading
+history <my-reading-history-label>`' tab and the ':ref:`Circulation
+History <circulation-history-label>`' tab in the staff client may change.
Regardless of the patron's choice they can delete their reading history
in bulk at any time by clicking the 'Immediate deletion' button.
**Important**
In order for the patron to be able to delete their reading history
- you must have the `AnonymousPatron <#AnonymousPatron>`__ preference
+ you must have the :ref:`AnonymousPatron` preference
set.
If you're allowing guarantees to grand permission to their guarantors to
view their current checkouts with the
-`AllowPatronToSetCheckoutsVisibilityForGuarantor <#AllowPatronToSetCheckoutsVisibilityForGuarantor>`__
+:ref:`AllowPatronToSetCheckoutsVisibilityForGuarantor`
preference they will see that option on this
screen.AllowPatronToSetCheckoutsVisibilityForGuarantor
When the guarantor logs in they will see a tab labeled "Relatives'
checkouts" on their summary tab.Relatives' checkouts
-`My Purchase Suggestions <#opacmysuggestions>`__
+.. _my-purchase-suggestions-label:
+
+My Purchase Suggestions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If your library allows patrons to make purchase suggestions the next tab
will show all suggestions that the patron made to the library and their
statuses. To disable this tab and the suggestion functionality set the
-`suggestion <#suggestionspref>`__ preference to 'Don't allow.'
+:ref:`suggestion` preference to 'Don't allow.'
Patron purchase suggestions
|image1026|
-If you have `OPACViewOthersSuggestions <#OPACViewOthersSuggestions>`__
+If you have :ref:`OPACViewOthersSuggestions`
set to 'Show' then patrons will be able to search suggestions from the
top of this list.
-`My Messaging <#opacmymsgs>`__
+.. _my-messaging-label:
+
+My Messaging
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If your library has the
-`EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ and the
-`EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__
+:ref:`EnhancedMessagingPreferences` and the
+:ref:`EnhancedMessagingPreferencesOPAC`
preferences set to 'Allow' then your patrons will be able to choose
which messages they receive from the library (with the exception of
overdue notices which the library controls).
|image1027|
If you use an outside driver for sending text messages set with the
-`SMSSendDriver <#SMSSendDriver>`__ preference, you will see an
+:ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference, you will see an
additional column to receive these messages as SMS (or text messages)
and a field for a cell (or SMS) number.
|image1028|
If you are using the Email protocol for sending text messages set with
-the `SMSSendDriver <#SMSSendDriver>`__ preference, you will see an
+the :ref:`SMSSendDriver <smssenddriver,-smssendusername,-and-smssendpassword-label>` preference, you will see an
additional column to receive these messages as SMS (or text messages), a
-field for a cell (or SMS) number, and a pull down listing `cellular
-providers entered in administration <#smsadmin>`__.
+field for a cell (or SMS) number, and a pull down listing :ref:`cellular
+providers entered in administration <sms-cellular-providers-label>`.
SMSSendDriver in the OPAC
|image1029|
-If you are using the `Itiva Talking
-Tech <#TalkingTechItivaPhoneNotification>`__ service you will see an
+If you are using the :ref:`Itiva Talking
+Tech <talkingtechitivaphonenotification-label>` service you will see an
additional column to receive these messages via Phone.Phone messaging
preferences in the OPAC
'Digest only?' if you would like to receive a digest of the
messages.
-`My Lists <#opacmylists>`__
+.. _my-lists-label:
+
+My Lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Finally, if your library has the `virtualshelves <#virtualshelves>`__
+Finally, if your library has the :ref:`virtualshelves`
set to 'Allow' then the last tab will by 'my lists.' From here your
patrons can review public lists and create or edit their own private
lists.
Patron lists
|image1030|
-`Ask for a Discharge <#opacdischarge>`__
+.. _ask-for-a-discharge-label:
+
+Ask for a Discharge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you have enabled the `useDischarge <#useDischarge>`__ preference then
+If you have enabled the :ref:`useDischarge` preference then
patrons will be able to request a discharge via the OPAC.Discharge tab
From here patrons can request a discharge
Discharge confirmation
|image1032|
-`Purchase Suggestions <#purchasesuggest>`__
+.. _purchase-suggestions-label:
+
+Purchase Suggestions
-------------------------------------------
-If your library has the `suggestion <#suggestionspref>`__ preference set
+If your library has the :ref:`suggestion` preference set
to 'Allow' then patrons will have the option to make purchase
suggestions in several areas in the OPAC.
If you are allowing everyone to see the purchase suggestions made by
others with the
-`OPACViewOthersSuggestions <#OPACViewOthersSuggestions>`__ preference,
+:ref:`OPACViewOthersSuggestions` preference,
then there will be a link at the top of your OPAC under the search box.
Purchase Suggestions Link on Search Box
Purchase Suggestion Link from Search Results
|image1034|
-And there will be a link on the patron's `My Purchase
-Suggestions <#opacmysuggestions>`__ tab.
+And there will be a link on the patron's :ref:`My Purchase
+Suggestions <my-purchase-suggestions-label>` tab.
Purchase Suggestion from My Purchase Suggestions Tab
|image1035|
- From the form on the 'Title' is required by the library.
- The Item type list can be edited by editing the SUGGEST\_FORMAT
- `authorized value <#authorizedvalues>`__.
+ :ref:`authorized value <authorized-values-label>`.
- If you would like the 'Reason for suggestion' menu shown in the
screenshot above to appear on your suggestions list you need to add
- an `authorized value <#authorizedvalues>`__ category titled
+ an :ref:`authorized value <authorized-values-label>` category titled
'OPAC\_SUG' and include reasons as values in that list.
- If you would like the patron to be able to choose which branch they
are making a suggestion for you need to set the
- `AllowPurchaseSuggestionBranchChoice <#AllowPurchaseSuggestionBranchChoice>`__
+ :ref:`AllowPurchaseSuggestionBranchChoice`
preference to 'Allow'
Once the form is submitted the data will be saved to the
-`Acquisitions <#managesuggest>`__ module for the librarians to manage.
+:ref:`Acquisitions <managing-suggestions-label>` module for the librarians to manage.
Searching
=========
-`Advanced Search Prefixes <#searchprefixes>`__
+.. _advanced-search-prefixes-label:
+
+Advanced Search Prefixes
----------------------------------------------
The following prefixes can be added to search terms in the keyword
- levels lex:510
-`Guide to Searching <#searchguide>`__
+.. _guide-to-searching-label:
+
+Guide to Searching
-------------------------------------
This brief guide will explain a chart that shows a sample of how a
to the bibliographic data and does not address authority database
indexing.
-`Indexing and Searching Description <#searchguide-indexing>`__
+.. _indexing-and-searching-description-label:
+
+Indexing and Searching Description
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Koha's databases are indexed by the Zebra open-source software. The
The indexing described in this document is the set used by
SouthEastern University. Your local indexing may vary.
-`Indexing Configuration <#searchguide-indexconfig>`__
+.. _indexing-configuration-label:
+
+Indexing Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are three configuration files that Koha uses while indexing.
yr,pubdate, acqdate, ln, pl, ab, nt, rtype, mc-rtype, mus, au, su-na,
kw, pb, ctype, and an.
-The `Koha Indexing Chart <#kohasearchindexes>`__ summarizes the contents
+The :ref:`Koha Indexing Chart <koha-search-indexes-label>` summarizes the contents
of all three of these files in a more readable format. The first two
columns labeled Z39.50 attribute and Z39.50 name matches the Z39.50
bib-1 attributes file. The third column labeled MARC tags indexed is
commonly used for limiting. The fixed field attributes currently
represent the BK codes. Other format codes, if needed, could be defined.
-`Basic Searching <#searchguide-basics>`__
+.. _basic-searching-label:
+
+Basic Searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The search box that library staff and library patrons will see most
No results found
|image1041|
-`Advanced Searching <#searchguide-advanced>`__
+.. _advanced-searching-label:
+
+Advanced Searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When you can't find the most appropriate material with a general search,
and simple way to use the Boolean operators in your search. Note that
this display depends on a system preference setting. This option can be
found on the Administration > System Preferences > Searching page. The
-option called `expandedSearchOption <#expandedSearchOption>`__ must be
+option called :ref:`expandedSearchOption` must be
set to 'show' to see the following display.
Advanced Search Options
search terms. The 'not' operator excludes records with the term that
follows the operator.
-Note: If you leave this `expandedSearchOption <#expandedSearchOption>`__
+Note: If you leave this :ref:`expandedSearchOption`
set to 'don't show', this is the display you will see:
Fewer Search Options
author, by title, by call number, by dates, or by popularity (which uses
the information on total issues found in the items table). If you would
prefer a different default sort, you can set
-`defaultSortField <#defaultSortField>`__ to one of the other choices in
+:ref:`defaultSortField <defaultsortfield-&-defaultsortorder-label>` to one of the other choices in
Administration > System Preferences > Searching.
-`Item Searching <#searchguide-itemsearch>`__
+.. _item-searching-label:
+
+Item Searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you are looking for specific items you can use the item search engine
are printed to the screen you will have the option to narrow your search
further using filters at the top.Item search results
-`Common Command Language Searching <#searchguide-ccl>`__
+.. _common-command-language-searching-label:
+
+Common Command Language Searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Koha uses the Common Command Language (CCL) (ISO 8777) as its internal
operators, and limiters used are identical to those used in the
graphical interface.
-`Indexes <#searchguide-indexes>`__
+.. _indexes-label:
+
+Indexes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The CCL standard itself doesn't specify a particular set of qualifiers
Table: Attributes
-Refer to the `Koha Indexing Chart <#kohasearchindexes>`__ for the MARC21
+Refer to the :ref:`Koha Indexing Chart <koha-search-indexes-label>` for the MARC21
tags mapped to each Bib-1 Attribute and index combination.
-`Audience Examples <#search-audexamp>`__
+.. _audience-examples-label:
+
+Audience Examples
''''''''''''''''''''''''''''''''''''''''
- aud:a Preschool
- aud:j Juvenile
-`Contents Examples <#search-contentsexamp>`__
+.. _contents-examples-label:
+
+Contents Examples
'''''''''''''''''''''''''''''''''''''''''''''
- fic:1 Fiction
- mus:I Non musical record
-`Search Syntax <#searchguide-syntax>`__
+.. _search-syntax-label:
+
+Search Syntax
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In the persistent search box, single words generally retrieve large
syntax of the CCL is the actual limiter. They are reproduced here just
in case you would like to use these limiters.
-`Koha Search Indexes <#kohasearchindexes>`__
+.. _koha-search-indexes-label:
+
+Koha Search Indexes
--------------------------------------------
By default, not all fields are indexed in the Zebra search engine, but
The plugin system needs to be turned on by a system administrator.
-`Set up <#pluginsetup>`__
+.. _set-up-label:
+
+Set up
-------------------------
To set up the Koha plugin system you must first make some changes to
- Restart your webserver
Once set up is complete you will need to alter your
-`UseKohaPlugins <#UseKohaPlugins>`__ system preference. On the Tools
+:ref:`UseKohaPlugins` system preference. On the Tools
page you will see the Tools Plugins and on the Reports page you will see
the Reports Plugins.
Search History
==============
-If you have your `EnableSearchHistory <#EnableSearchHistory>`__
+If you have your :ref:`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'.
- *Get there:* More > About Koha
-`Server Information <#aboutserver>`__
+.. _server-information-label:
+
+Server Information
-------------------------------------
Under the 'Server Information' tab you will find information about the
Server Information on Koha
|image1065|
-`Perl Modules <#aboutserverperl>`__
+.. _perl-modules-label:
+
+Perl Modules
-----------------------------------
In order to take advantage of all of the functionalities of Koha, you
missing completely and items highlighted in yellow simply need to be
upgraded.
-`System Information <#aboutsystem>`__
+.. _system-information-label:
+
+System Information
-------------------------------------
This tab will provide you with warnings if you are using system
The following guide will walk you through the areas of Koha you need to
look at in order to prepare to start using the system.
-`Data Migration <#imp-migration>`__
+.. _data-migration-label:
+
+Data Migration
-----------------------------------
Before you can start using Koha you'll need to have some data. This can
bit for importing into Koha.
- Create a list of libraries and enter their info and codes into
- `Libraries & Groups <#libsgroups>`__
+ :ref:`Libraries & Groups`
-- Define your list of `Item Types <#itemtypeadmin>`__
+- Define your list of :ref:`Item Types`
- Define your patron categories and enter the categories and their
- codes into `Patron Categories <#patcats>`__
+ codes into :ref:`Patron Categories`
- Enter any additional patron information fields you use in your
- library in the `Patron Attributes <#patronattributetypes>`__
+ library in the :ref:`Patron Attributes <patron-attribute-types-label>`
- Requires that you first set the
- `ExtendedPatronAttributes <#ExtendedPatronAttributes>`__ system
+ :ref:`ExtendedPatronAttributes` system
preference if you have custom fields
-- Define all of your `Authorized Values <#authorizedvalues>`__
+- Define all of your :ref:`Authorized Values`
- `Collection codes <#ccode>`__
- Plus any others that are needed in your library
-- Optionally define `City/State/Postal Code <#citytowns>`__ combos
+- Optionally define :ref:`City/State/Postal Code <cities-and-towns-label>` combos
-- `Map your bibliographic data <#kohamarcmapping>`__ from your legacy
+- :ref:`Map your bibliographic data <koha-to-marc-mapping-label>` from your legacy
system to Koha fields and migrate (remembering to use the collection,
shelving, item type and library codes you entered in the above
setting areas)
-- `Map your patron data <#patronimport>`__ from your legacy system to
+- :ref:`Map your patron data <patron-import-label>` from your legacy system to
the Koha fields and migrate (remembering to use the patron and
library codes you defined above)
- If holds are migrated, check to see they are accurate in catalog
and patron record
-`Admin Configuration <#impadmin>`__
+.. _admin-configuration-label:
+
+Admin Configuration
-----------------------------------
Most of these preferences won't need to be changed to use your Koha
system, but there are a few that you might want to customize.
- If your library uses CAS Authentication, you'll want to set the
- various `CAS system preferences <#casauthentication>`__
+ various :ref:`CAS system preferences <cas-authentication-label>`
- Administration System Preferences
- - `KohaAdminEmailAddress <#KohaAdminEmailAddress>`__ : This is the
+ - :ref:`KohaAdminEmailAddress` : This is the
email address that will be used by the system in 'from' lines and
to send errors to if there is no email set for the branch
- - `noItemTypeImages <#noItemTypeImages>`__ : Decide if you want to
+ - :ref:`noItemTypeImages` : Decide if you want to
show item type icons in the staff client and opac
- - `delimiter <#delimiter>`__ : This value will be put in between
+ - :ref:`delimiter` : This value will be put in between
fields when exporting data from Koha
- - `virtualshelves <#virtualshelves>`__ : Decide if you want the
+ - :ref:`virtualshelves` : Decide if you want the
staff and/or patrons to use lists in Koha
- - `AutoLocation <#AutoLocation>`__ : Require staff to log in to the
+ - :ref:`AutoLocation` : Require staff to log in to the
staff client from a specific IP range
- - `IndependentBranches <#IndependentBranches>`__ : Prevent
+ - :ref:`IndependentBranches` : Prevent
librarians from editing content that belongs to other branches
-- Go through the `Log System Preferences <#logs>`__ and decide which
+- Go through the :ref:`Log System Preferences <logs-label>` and decide which
actions you want to keep track of in the logs
- Decide if you'd like to share your library's information with the
- Koha community by setting the `Sharing system
- preferences <#heaprefs>`__.
+ Koha community by setting the :ref:`Sharing system
+ preferences <share-anonymous-usage-statistics-label>`.
- Decide what `cron jobs <#cronjobsch>`__ you need to run and when.
- If you're using the long overdue cron job be sure to set your
- `DefaultLongOverdueChargeValue <#DefaultLongOverdueChargeValue>`__,
- `DefaultLongOverdueLostValue <#DefaultLongOverdueLostValue>`__ &
- `DefaultLongOverdueDays <#DefaultLongOverdueLostValue>`__
+ :ref:`DefaultLongOverdueChargeValue`,
+ :ref:`DefaultLongOverdueLostValue <defaultlongoverduelostvalue-&-defaultlongoverduedays-label>` &
+ :ref:`DefaultLongOverdueDays <defaultlongoverduelostvalue-&-defaultlongoverduedays-label>`
preferences.
-`Localization Configuration <#implocal>`__
+.. _localization-configuration-label:
+
+Localization Configuration
------------------------------------------
Koha is used worldwide and so you need to make sure you set your
- Localization/Internationalization System Preferences
- - `dateformat <#dateformat>`__ : Decide how dates are displayed
+ - :ref:`dateformat` : Decide how dates are displayed
throughout Koha
- - `opaclanguagesdisplay <#opaclanguagesdisplay>`__ : Decide if
+ - :ref:`opaclanguagesdisplay` : Decide if
patrons can choose what language the OPAC appears in
- - `opaclanguages <#opaclanguages>`__ : Decide which languages the
+ - :ref:`opaclanguages` : Decide which languages the
patrons can choose from
- - `language <#languagepref>`__ : Decide which languages appear in
+ - :ref:`language` : Decide which languages appear in
the staff client
- - `CalendarFirstDayOfWeek <#CalendarFirstDayOfWeek>`__ : Define your
+ - :ref:`CalendarFirstDayOfWeek` : Define your
first day of the week
-`Circulation Configuration <#impcirc>`__
+.. _circulation-configuration-label:
+
+Circulation Configuration
----------------------------------------
Before you start circulating your collection you'll need to set up your
rules and preferences for circulation.
-- Define your `Circulation/Fine rules <#circfinerules>`__
+- Define your :ref:`Circulation/Fine rules <circulation-and-fine-rules-label>`
-- Enter the `days your library is closed <#calholidays>`__ for fines
+- Enter the :ref:`days your library is closed <calendar-label>` for fines
and due date calculations
- Circulation System Preferences
- - `CircControl <#CircControl>`__ : Define whether circ rules are
+ - :ref:`CircControl` : Define whether circ rules are
based on item's location, patron's location or transaction
location
- - `useDaysMode <#useDaysMode>`__ : Define how due dates are
+ - :ref:`useDaysMode` : Define how due dates are
calculated
- - `finesCalendar <#finesCalendar>`__ : Define how fines are
+ - :ref:`finesCalendar` : Define how fines are
calculated (for every late date or only for days the library is
open)
- - `SpecifyDueDate <#SpecifyDueDate>`__ : Decide if staff are allowed
+ - :ref:`SpecifyDueDate` : Decide if staff are allowed
to override due dates on checkout
- - `SpecifyReturnDate <#SpecifyReturnDate>`__ : Decide if you want to
+ - :ref:`SpecifyReturnDate` : Decide if you want to
let the staff specify an arbitrary return date on checkin
- - `itemBarcodeFallbackSearch <#itemBarcodeFallbackSearch>`__ :
+ - :ref:`itemBarcodeFallbackSearch` :
Decide if you want staff to be able to checkout using a keyword
search (title, call number, etc)
- - `AutomaticItemReturn <#AutomaticItemReturn>`__ : Decide if items
+ - :ref:`AutomaticItemReturn` : Decide if items
are sent back to the owning branch when checked in
- - `todaysIssuesDefaultSortOrder <#todaysIssuesDefaultSortOrder>`__ :
+ - :ref:`todaysIssuesDefaultSortOrder` :
Decide how items checked out today display on the patron record
- - `previousIssuesDefaultSortOrder <#previousIssuesDefaultSortOrder>`__
+ - :ref:`previousIssuesDefaultSortOrder`
: Decide how items checked out prior to today display on the
patron record
- - `noissuescharge <#noissuescharge>`__ : Define the maximum amount a
+ - :ref:`noissuescharge` : Define the maximum amount a
patron can owe before checkouts are blocked
- - `ReturnBeforeExpiry <#ReturnBeforeExpiry>`__ : Decide if patrons
+ - :ref:`ReturnBeforeExpiry` : Decide if patrons
need to return items before their accounts expire
- - `AllowHoldsOnDamagedItems <#AllowHoldsOnDamagedItems>`__ : Decide
+ - :ref:`AllowHoldsOnDamagedItems` : Decide
if patrons can place holds on items that are marked as damaged
- - `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__ : Decide
+ - :ref:`AllowHoldPolicyOverride` : Decide
if you want the staff to be able to override the setting for
the above at checkout
- - `maxreserves <#maxreserves>`__ : Decide how many items a patron
+ - :ref:`maxreserves` : Decide how many items a patron
can have on hold at once
- - `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__ : Decide
+ - :ref:`AllowHoldPolicyOverride` : Decide
if you want the staff to be able to override the setting for
the above at checkout
- - `maxoutstanding <#maxoutstanding>`__ : Define the maximum amount a
+ - :ref:`maxoutstanding` : Define the maximum amount a
patron can owe before holds are blocked
- - `AllowHoldPolicyOverride <#AllowHoldPolicyOverride>`__ : Decide
+ - :ref:`AllowHoldPolicyOverride` : Decide
if you want the staff to be able to override the setting for
the above at checkout
- - `ReservesMaxPickUpDelay <#ReservesMaxPickUpDelay>`__ : Define the
+ - :ref:`ReservesMaxPickUpDelay` : Define the
number of days before a hold expires
- - `WebBasedSelfCheck <#WebBasedSelfCheck>`__ : Decide if you want to
+ - :ref:`WebBasedSelfCheck` : Decide if you want to
use the built in web-based self-checkout system
- - `AutoSelfCheckAllowed <#AutoSelfCheckAllowed>`__ : Decide if
+ - :ref:`AutoSelfCheckAllowed <autoselfcheckallowed,-autoselfcheckid-&-autoselfcheckpass-label>` : Decide if
the self-checkout system requires login
- - `ShowPatronImageInWebBasedSelfCheck <#ShowPatronImageInWebBasedSelfCheck>`__
+ - :ref:`ShowPatronImageInWebBasedSelfCheck`
: Decide if you want patron images to show on the self checkout
screen
- - `AllowNotForLoanOverride <#AllowNotForLoanOverride>`__ : Decide if
+ - :ref:`AllowNotForLoanOverride` : Decide if
you want the staff to be able to checkout items marked as 'not for
loan'
- - `AllowRenewalLimitOverride <#AllowRenewalLimitOverride>`__ :
+ - :ref:`AllowRenewalLimitOverride` :
Decide if you want staff to override the limit put on renewals
- - `AllowFineOverride <#AllowFineOverride>`__ : Decide if you want
+ - :ref:`AllowFineOverride` : Decide if you want
staff to be able to override fine limits
- - `AllowTooManyOverride <#AllowTooManyOverride>`__ : Descide if you
+ - :ref:`AllowTooManyOverride` : Descide if you
want staff to be able to check out more than the limit to a patron
- - `RenewalPeriodBase <#RenewalPeriodBase>`__ : Decide what date
+ - :ref:`RenewalPeriodBase` : Decide what date
renewals are based on
- - `finesMode <#finesMode>`__ : Switch to 'Calculate and Charge'
+ - :ref:`finesMode` : Switch to 'Calculate and Charge'
before go live if you charge fines
- `OverdueNoticeBcc <#OverdueNoticeBcc>`__ : If you want to receive
a copy of every overdue notice sent out, enter your email address
here
- - `emailLibrarianWhenHoldIsPlaced <#emailLibrarianWhenHoldIsPlaced>`__
+ - :ref:`emailLibrarianWhenHoldIsPlaced`
: Decide if you want an email every time a hold is placed
- - `ReservesControlBranch <#ReservesControlBranch>`__ : Decide which
+ - :ref:`ReservesControlBranch` : Decide which
branch's hold rules are considered first
- - `soundon <#AudioAlerts>`__ : Decide if you want to have sounds on
+ - :ref:`soundon <audioalerts-label>` : Decide if you want to have sounds on
for circulation actions
- - `FilterBeforeOverdueReport <#FilterBeforeOverdueReport>`__ : If
+ - :ref:`FilterBeforeOverdueReport` : If
you have a large amount of overdues, you might want to turn this
preference on so as to allow you to filter before results appear
- - `DisplayClearScreenButton <#DisplayClearScreenButton>`__ : If you
+ - :ref:`DisplayClearScreenButton` : If you
have a lot of staff members sharing one circ computer you might
want to enable this so that staff can clear the screen in between
checkouts to protect patron's privacy
- - `CircAutoPrintQuickSlip <#CircAutoPrintQuickSlip>`__ : Decide how
+ - :ref:`CircAutoPrintQuickSlip` : Decide how
you want Koha to react if you scan in a blank barcode on the
checkout screen
- - `SuspendHoldsIntranet <#SuspendHoldsIntranet>`__ and/or
- `SuspendHoldsOpac <#SuspendHoldsOpac>`__ : Decide if you want
+ - :ref:`SuspendHoldsIntranet` and/or
+ :ref:`SuspendHoldsOpac` : Decide if you want
patrons and/or staff to be able to suspend holds
- - `AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ : If
+ - :ref:`AutoResumeSuspendedHolds` : If
you allow holds to be suspended decide if you want them to
automatically resume on the date entered by the staff and/or
patron
- - `OnSiteCheckouts <#OnSiteCheckouts>`__ : Decide if you want to
+ - :ref:`OnSiteCheckouts` : Decide if you want to
allow items to be checked out for use within the library
- - `RecordLocalUseOnReturn <#RecordLocalUseOnReturn>`__ : Set this to
+ - :ref:`RecordLocalUseOnReturn` : Set this to
record local use of items when you check them in
-- Customize your `Notices & Slips <#notices>`__
+- Customize your :ref:`Notices & Slips`
-- Define your `Overdue Notice Triggers <#noticetriggers>`__
+- Define your :ref:`Overdue Notice Triggers <overdue-notice/status-triggers-label>`
-- Set up your `cron jobs <#cronjobs>`__
+- Set up your :ref:`cron jobs <cron-jobs-label>`
- - Populate `your holds queue <#buildholdscron>`__ (every 1-4 hours)
+ - Populate :ref:`your holds queue <holds-queue-label>` (every 1-4 hours)
- - Decide `when holds expire <#expiredholdscron>`__ (daily)
+ - Decide :ref:`when holds expire <expired-holds-label>` (daily)
- - `Calculate fines due <#finescronjob>`__ (daily)
+ - :ref:`Calculate fines due <fines-label>` (daily)
- Fines on hourly loans will calculate when you check the items
in
- - `Mark long overdue items as lost <#longoverduecron>`__ (daily)
+ - :ref:`Mark long overdue items as lost <long-overdues-label>` (daily)
- - Decide when the system `sends out messages <#msgqueuecron>`__ (1-4
+ - Decide when the system :ref:`sends out messages <message-queue-label>` (1-4
hours)
- - Decide when the system `queues overdue
- notices <#overduenoticecron>`__ (daily)
+ - Decide when the system :ref:`queues overdue
+ notices <overdue-notice-label>` (daily)
- - Set up `hold notices that didn't send for
- printing <#printholdcron>`__ (daily after overdues and message
+ - Set up :ref:`hold notices that didn't send for
+ printing <print-hold-notices-label>` (daily after overdues and message
queue)
- - Decide when the system `queues the advanced notice of items
- due <#advnoticecron>`__ (daily)
+ - Decide when the system :ref:`queues the advanced notice of items
+ due <advanced-notice-label>` (daily)
+
+ - Find holds that need to be :ref:`resumed and remove
+ suspension <unsuspend-holds-label>` (daily)
- - Find holds that need to be `resumed and remove
- suspension <#unsuspendholdcron>`__ (daily)
+ - If you're allowing automatic renewal of items :ref:`set them to
+ renew <automatic-renewal-label>` (nightly)
- - If you're allowing automatic renewal of items `set them to
- renew <#autorenewcron>`__ (nightly)
+.. _patron-configuration-label:
-`Patron Configuration <#imppratrons>`__
+Patron Configuration
---------------------------------------
You have already imported patron data from your old system, but there
are plenty of options available to you regarding patrons and their
accounts.
-- Enter your `staff members as patrons <#addstaffpatron>`__
+- Enter your :ref:`staff members as patrons <add-a-staff-patron-label>`
- - Define `staff members access permissions <#patronpermissions>`__
+ - Define :ref:`staff members access permissions <patron-permissions-label>`
- Patron System Preferences
- - `autoMemberNum <#autoMemberNum>`__ : Decide if the patrons
+ - :ref:`autoMemberNum` : Decide if the patrons
barcodes are auto-generated or if you enter them yourself
- - `MaxFine <#MaxFine>`__ : Determine the maximum amount that people
+ - :ref:`MaxFine` : Determine the maximum amount that people
can owe in fines
- - `NotifyBorrowerDeparture <#NotifyBorrowerDeparture>`__ : Decide
+ - :ref:`NotifyBorrowerDeparture` : Decide
when to warn staff that the patron account is about to expire
- - `intranetreadinghistory <#intranetreadinghistory>`__ : Decide if
+ - :ref:`intranetreadinghistory` : Decide if
the staff can see the patron's reading/checkout history
- - `BorrowerMandatoryField <#BorrowerMandatoryField>`__ : List fields
+ - :ref:`BorrowerMandatoryField` : List fields
that you want to appear as mandatory on the patron add/edit form
- - `BorrowersTitles <#BorrowersTitles>`__ : Add or change the titles
+ - :ref:`BorrowersTitles` : Add or change the titles
for your patrons
- - `borrowerRelationship <#borrowerRelationship>`__ : Add or change
+ - :ref:`borrowerRelationship` : Add or change
borrower relationships (child to adult and professional to
organization)
- - `AutoEmailPrimaryAddress <#AutoEmailPrimaryAddress>`__ : Determine
+ - :ref:`AutoEmailPrimaryAddress` : Determine
if the patrons get an email confirming the creation of their
account
- - `EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ :
+ - :ref:`EnhancedMessagingPreferences` :
Decide if staff can choose from a series of notices (other than
overdues) for patrons
- - `EnhancedMessagingPreferencesOPAC <#EnhancedMessagingPreferencesOPAC>`__:
+ - :ref:`EnhancedMessagingPreferencesOPAC`:
Decide if patrons can choose from a series of notices (other than
ovedues) for themselves
- - `patronimages <#patronimages>`__ : Decide if you want to save
+ - :ref:`patronimages` : Decide if you want to save
patron images in your system
- - `ExtendedPatronAttributes <#ExtendedPatronAttributes>`__ : Decide
+ - :ref:`ExtendedPatronAttributes` : Decide
if you want to enable custom patron fields
- - `minPasswordLength <#minPasswordLength>`__ : Enter the minimum
+ - :ref:`minPasswordLength` : Enter the minimum
number of characters you want passwords to have
- - `BorrowerUnwantedField <#BorrowerUnwantedField>`__ : Decide what
+ - :ref:`BorrowerUnwantedField` : Decide what
fields your library doesn't need to see on the patron entry form
-- Set up your `cron jobs <#cronjobs>`__
+- Set up your :ref:`cron jobs <cron-jobs-label>`
- - Decide if you would like `children to automatically be come
- adults <#j2acron>`__
+ - Decide if you would like :ref:`children to automatically be come
+ adults <update-child-to-adult-patron-type-label>`
-`Cataloging Configuration <#impcatalog>`__
+.. _cataloging-configuration-label:
+
+Cataloging Configuration
------------------------------------------
Before you start cataloging in Koha you'll want to set up your
preferences and other rules.
-- Define your cataloging templates aka `MARC Bibliographic
- Frameworks <#marcbibframeworks>`__
+- Define your cataloging templates aka :ref:`MARC Bibliographic
+ Frameworks <marc-bibliographic-frameworks-label>`
- - Run the `MARC Bibliographic Framework
- Test <#marcbibframeworkstest>`__ to be sure your changes are valid
+ - Run the :ref:`MARC Bibliographic Framework
+ Test <marc-bibliographic-framework-test-label>` to be sure your changes are valid
-- Define any `authorized values <#authorizedvalues>`__ you might want
+- Define any :ref:`authorized values <authorized-values-label>` you might want
to use in cataloging
-- Set up `custom classification sources <#classificationsources>`__ (if
+- Set up :ref:`custom classification sources <classification-sources-label>` (if
you use something other than the defaults)
-- Set up `MARC matching rules <#recordmatchingrules>`__ for importing
+- Set up :ref:`MARC matching rules <record-matching-rules-label>` for importing
records from mrc files or Z39.50
-- Set up `Koha to Keyword mapping <#keywordmapping>`__ for deciding how
+- Set up :ref:`Koha to Keyword mapping <keywords-to-marc-mapping-label>` for deciding how
to display marc fields to the screen (still in beta - only one field)
-- Set up the `Z39.50 targets <#z3950admin>`__ you want to search for
+- Set up the :ref:`Z39.50 targets <z39.50/sru-servers-label>` you want to search for
cataloging (and acquisitions)
- Cataloging System Preferences
- - `URLLinkText <#URLLinkText>`__ : Enter text to display when 856
+ - :ref:`URLLinkText` : Enter text to display when 856
fields do not have pre-defined labels
- - `hide\_marc <#hide_marc>`__ : If you are unfamiliar with MARC you
+ - :ref:`hide\_marc <hide\_marc-label>` : If you are unfamiliar with MARC you
can have the MARC fields number hidden
- - `LabelMARCView <#LabelMARCView>`__ : Choose how you want duplicate
+ - :ref:`LabelMARCView` : Choose how you want duplicate
fields to appear on the editor
- - `DefaultClassificationSource <#DefaultClassificationSource>`__ :
+ - :ref:`DefaultClassificationSource` :
Choose which classification source is the default in your library
- - `advancedMARCeditor <#advancedMARCeditor>`__ : Decide if you need
+ - :ref:`advancedMARCeditor` : Decide if you need
labels to appear on your MARC editor
- - `marcflavour <#marcflavour>`__ : Choose your MARC format
+ - :ref:`marcflavour` : Choose your MARC format
- - `itemcallnumber <#itemcallnumber>`__ : Enter which field and
+ - :ref:`itemcallnumber` : Enter which field and
subfields to look into for the call number
- - `MARCOrgCode <#MARCOrgCode>`__ : Enter your MARC Organizational
+ - :ref:`MARCOrgCode` : Enter your MARC Organizational
Code (not the same as your OCLC number)
- - `autoBarcode <#autoBarcode>`__ : Decide if Koha generates item
+ - :ref:`autoBarcode` : Decide if Koha generates item
barcodes for you
- - `OpacSuppression <#OpacSuppression>`__ : Decide if you want to
+ - :ref:`OpacSuppression <opacsuppression,-opacsuppressionbyiprange,-opacsuppressionredirect,-and-opacsuppressionmessage-label>` : Decide if you want to
hide items marked as suppressed from the OPAC search results
-- Set up your `cron jobs <#cronjobs>`__
+- Set up your :ref:`cron jobs <cron-jobs-label>`
+
+ - Decide when the system :ref:`checks URLs in catalog
+ records <check-urls-label>` to see if they are still valid
- - Decide when the system `checks URLs in catalog
- records <#checkurlcron>`__ to see if they are still valid
+.. _authorities-configuration-label:
-`Authorities Configuration <#impauthorities>`__
+Authorities Configuration
-----------------------------------------------
Koha has the ability to keep track of your authority records and how
they're linked to your bibliographic records. Before using authorities
you should configure several preferences.
-- Set `Authority Frameworks <#authoritiesadmin>`__ aka templates
+- Set :ref:`Authority Frameworks <authority-types-label>` aka templates
- Authority System Preferences
- - `BiblioAddsAuthorities <#BiblioAddsAuthorities>`__ : Decide if
+ - :ref:`BiblioAddsAuthorities` : Decide if
Koha creates authorities when cataloging
- `dontmerge <#dontmerge>`__ : Decide if updates to authorities
trigger updates to the bibliographic records that link to them
- - `AutoCreateAuthorities <#AutoCreateAuthorities>`__ : Decide when
+ - :ref:`AutoCreateAuthorities` : Decide when
authorities are created
- - `LinkerModule <#LinkerModule>`__ : Decide which match the
+ - :ref:`LinkerModule` : Decide which match the
authority linker should use
- - `LinkerOptions <#LinkerOptions>`__ : Decide if you want authority
+ - :ref:`LinkerOptions` : Decide if you want authority
linking to be broader or more specific
- - `CatalogModuleRelink <#CatalogModuleRelink>`__ : Decide if you
+ - :ref:`CatalogModuleRelink` : Decide if you
want to enable authority linking while cataloging
-- Set up your `cron jobs <#cronjobs>`__
+- Set up your :ref:`cron jobs <cron-jobs-label>`
- - Choose when the system looks for authorities updates to `merge
- changes into bibliographic records <#mergeauthcron>`__
+ - Choose when the system looks for authorities updates to :ref:`merge
+ changes into bibliographic records <update-authorities-label>`
-`Searching Configuration <#impsearching>`__
+.. _searching-configuration-label:
+
+Searching Configuration
-------------------------------------------
There are several system preferences related to searching, it is not
always recommended to make too many changes to these preferences since
they are set to get you the most relevant results. If you would like to
-change the default way that Koha handles searching, view the `Searching
-system preferences <#searchingprefs>`__ tab.
+change the default way that Koha handles searching, view the :ref:`Searching
+system preferences <searching-label>` tab.
-- Set up your `cron jobs <#cronjobs>`__
+- Set up your :ref:`cron jobs <cron-jobs-label>`
- - Decide how often your `system rebuilds the search
- index <#rebuildsearchcron>`__ (4-10 min)
+ - Decide how often your :ref:`system rebuilds the search
+ index <rebuild-index-label>` (4-10 min)
- Searching System Preferences
- - `AdvancedSearchTypes <#AdvancedSearchTypes>`__ : Decide which
+ - :ref:`AdvancedSearchTypes` : Decide which
authorized value fields you want patrons and staff to be able to
limit their advanced searches by
- - `AdvancedSearchLanguages <#AdvancedSearchLanguages>`__ : Decide
+ - :ref:`AdvancedSearchLanguages` : Decide
which languages you want people to be able to limit to via the
search engine
- - `UseAuthoritiesForTracings <#UseAuthoritiesForTracings>`__ :
+ - :ref:`UseAuthoritiesForTracings` :
Decide how you want Koha to handle subject searches in the OPAC
- - `TraceCompleteSubfields <#TraceCompleteSubfields>`__ : Decide
+ - :ref:`TraceCompleteSubfields` : Decide
how you want Koha to handle subject searches in the OPAC
- - `TraceSubjectSubdivisions <#TraceSubjectSubdivisions>`__ :
+ - :ref:`TraceSubjectSubdivisions` :
Decide how you want Koha to handle subject searches in the OPAC
- - `displayFacetCount <#displayFacetCount>`__ : Decide whether to
+ - :ref:`displayFacetCount` : Decide whether to
show facet counts on search results
-`OPAC Configuration <#impopac>`__
+.. _opac-configuration-label:
+
+OPAC Configuration
---------------------------------
There are a lot of ways you can customize your OPAC in Koha.
- OPAC System preferences
- - `OPACBaseURL <#OPACBaseURL>`__ : Enter your library's url
+ - :ref:`OPACBaseURL` : Enter your library's url
- - `opacuserlogin <#opacuserlogin>`__ : Decide if you want to allow
+ - :ref:`opacuserlogin` : Decide if you want to allow
patrons to login to the OPAC to access customized functionality
(searching will be allowed without logging in)
- - `RequestOnOpac <#RequestOnOpac>`__ : Decide if patrons can
+ - :ref:`RequestOnOpac` : Decide if patrons can
place holds via the OPAC
- - `OpacPasswordChange <#OpacPasswordChange>`__ : Decide if
+ - :ref:`OpacPasswordChange` : Decide if
patrons can change their password (don't allow this if you're
using LDAP)
- - `OpacRenewalAllowed <#OpacRenewalAllowed>`__ : Decide if
+ - :ref:`OpacRenewalAllowed` : Decide if
patrons can renew their checked out items via the OPAC
- - `opacreadinghistory <#opacreadinghistory>`__ : Decide if
+ - :ref:`opacreadinghistory` : Decide if
patrons can view their reading/checkout history via the OPAC
- - `reviewson <#reviewson>`__ : Decide if you want to allow
+ - :ref:`reviewson` : Decide if you want to allow
patrons to comment on bib records via the OPAC
- - `OpacStarRatings <#OpacStarRatings>`__ : Decide if patrons can
+ - :ref:`OpacStarRatings` : Decide if patrons can
leave star ratings
- - `virtualshelves <#virtualshelves>`__ : Decide if you want
+ - :ref:`virtualshelves` : Decide if you want
patrons to be able to create Lists
- - `OpacAllowPublicListCreation <#OpacAllowPublicListCreation>`__
+ - :ref:`OpacAllowPublicListCreation`
: If patrons can create lists then decide if they are allowed
to create public lists
- - `suggestion <#suggestionspref>`__ : Decide if you want patrons
+ - :ref:`suggestion` : Decide if you want patrons
to be able to submit purchase suggestions
- - `OPACViewOthersSuggestions <#OPACViewOthersSuggestions>`__ :
+ - :ref:`OPACViewOthersSuggestions` :
Decide if you want patrons to be able to see purchase
suggestions made by other patrons
- - `opacbookbag <#opacbookbag>`__ : Decide if patrons can save items
+ - :ref:`opacbookbag` : Decide if patrons can save items
into their cart
- - `AnonSuggestions <#AnonSuggestions>`__ : Decide if you want non
+ - :ref:`AnonSuggestions` : Decide if you want non
logged in users to be able to make purchase suggestions
- - `LibraryName <#LibraryName>`__ : Enter your library name for
+ - :ref:`LibraryName` : Enter your library name for
display in the <title> tag and on the top of the OPAC
- - `opaccredits <#opaccredits>`__ : Enter HTML to appear at the
+ - :ref:`opaccredits` : Enter HTML to appear at the
bottom of every page in the OPAC
- - `OpacMainUserBlock <#OpacMainUserBlock>`__ : Enter HTML that will
+ - :ref:`OpacMainUserBlock` : Enter HTML that will
appear in the center of the main OPAC page
- - `OpacNav <#OpacNav>`__ : Enter HTML that will appear to the left
+ - :ref:`OpacNav` : Enter HTML that will appear to the left
on the main OPAC page
- - `OpacNavBottom <#OpacNavBottom>`__ : Enter HTML that will appear
+ - :ref:`OpacNavBottom` : Enter HTML that will appear
below OpacNav
- - `OpacNavRight <#OpacNavRight>`__ : Enter HTML that will appear
+ - :ref:`OpacNavRight` : Enter HTML that will appear
below the login box on the right
- - `opacheader <#opacheader>`__ : Enter the HTML that will appear
+ - :ref:`opacheader` : Enter the HTML that will appear
above the search box on the OPAC
- - `OPACNoResultsFound <#OPACNoResultsFound>`__ : Enter the HTML that
+ - :ref:`OPACNoResultsFound` : Enter the HTML that
will appear when no results are found
- - `OPACResultsSidebar <#OPACResultsSidebar>`__ : Enter the HTML that
+ - :ref:`OPACResultsSidebar` : Enter the HTML that
will appear below the facets on your search results
- - `OPACMySummaryHTML <#OPACMySummaryHTML>`__ : Enter the HTML that
+ - :ref:`OPACMySummaryHTML` : Enter the HTML that
will appear in the far right of the circulation summary in the
OPAC
- Customize your stylesheets:
- - `OPACUserCSS <#OPACUserCSS>`__ : Enter any additional fields
+ - :ref:`OPACUserCSS` : Enter any additional fields
you want to define styles for
- - `opaclayoutstylesheet <#opaclayoutstylesheet>`__ : Point to a
+ - :ref:`opaclayoutstylesheet` : Point to a
CSS file on your Koha server
- - `OpacHighlightedWords <#OpacHighlightedWords>`__ : Decide if you
+ - :ref:`OpacHighlightedWords <opachighlightedwords-&-nothighlightedwords-label>` : Decide if you
want search terms to be highlighted on the search results
- - `hidelostitems <#hidelostitems>`__ : Decide if you want to show
+ - :ref:`hidelostitems` : Decide if you want to show
patrons items you have marked as lost
- - `BiblioDefaultView <#BiblioDefaultView>`__ : Decide what view is
+ - :ref:`BiblioDefaultView` : Decide what view is
the default for bib records on the OPAC
- - `OPACShelfBrowser <#OPACShelfBrowser>`__ : Decide if you want to
+ - :ref:`OPACShelfBrowser` : Decide if you want to
enable the shelf browse functionality
- - `OPACURLOpenInNewWindow <#OPACURLOpenInNewWindow>`__ : Decide if
+ - :ref:`OPACURLOpenInNewWindow` : Decide if
URLs clicked in the OPAC are opened in a new window
- - `SearchMyLibraryFirst <#SearchMyLibraryFirst>`__ : If you have a
+ - :ref:`SearchMyLibraryFirst` : If you have a
multi-branch system decide if you want patrons to search their
library first
- - `OpacAuthorities <#OpacAuthorities>`__ : Decide if you want
+ - :ref:`OpacAuthorities` : Decide if you want
patrons to be able to search your authority file
- - `OpacBrowser <#OpacBrowser>`__ : Decide if you want patrons to
+ - :ref:`OpacBrowser` : Decide if you want patrons to
browse your authority file (French libraries only)
- - `OPACSearchForTitleIn <#OPACSearchForTitleIn>`__ : Choose which
+ - :ref:`OPACSearchForTitleIn` : Choose which
libraries you want patrons to be able to re-run their search in
- - `OpacAddMastheadLibraryPulldown <#OpacAddMastheadLibraryPulldown>`__
+ - :ref:`OpacAddMastheadLibraryPulldown`
: If you're a multi-branch system you can add a pull down to the
search bar for patrons to search which library to search
- - `EnableOpacSearchHistory <#EnableOpacSearchHistory>`__ : Decide if
+ - :ref:`EnableOpacSearchHistory` : Decide if
you want the system to keep a search history
-- Set up your `cron jobs <#cronjobs>`__
+- Set up your :ref:`cron jobs <cron-jobs-label>`
- - If you have the `OpacBrowser <#OpacBrowser>`__ preference set
- decide `when you want the contents to
- rebuild <#authbrowsercron>`__ (French libraries only)
+ - If you have the :ref:`OpacBrowser` preference set
+ decide :ref:`when you want the contents to
+ rebuild <authorities-browser-label>` (French libraries only)
- - If you have `custom RSS feeds <#customrss>`__, decide when you
- want the `feed to be populated <#customrssfeedcron>`__
+ - If you have :ref:`custom RSS feeds <custom-rss-feeds-label>`, decide when you
+ want the :ref:`feed to be populated <rss-feeds-label>`
-`Editable OPAC Regions <#editableopac>`__
+.. _editable-opac-regions-label:
+
+Editable OPAC Regions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Using the OPAC system preferences you can customize various regions, the
OPAC Editable Regions
|image1068|
-`Enhanced Content Configuration <#impenhanced>`__
+.. _enhanced-content-configuration-label:
+
+Enhanced Content Configuration
-------------------------------------------------
Koha allows you to pull in content from outside sources to enhance your
bib records. All of this content can be toggled on and off using the
enhanced content system preferences.
-- `FRBR/Editions <#frbrenhancedprefs>`__
+- :ref:`FRBR/Editions <all-label>`
- If you would like to have your OPAC and/or staff client show an
'Editions' tab on the bib record, you want to enable one or the
other FRBR preferences and then either one or both of the ISBN
services (XISBN and ThingISBN).
-- `Amazon <#amazonprefs>`__ : This service is free and just requires
+- :ref:`Amazon` : This service is free and just requires
that you visit http://aws.amazon.com to sign up
- Using the Amazon preferences you can choose to show cover images
from Amazon.
-- `Babelthèque <#Babelthequeprefs>`__
+- :ref:`Babelthèque`
- This is a pay service. Contact Babelthèque to learn how to enable
this content in the OPAC.
-- `Baker and Taylor <#btcontentprefs>`__
+- :ref:`Baker and Taylor <baker-&-taylor-label>`
- This is a pay service from Baker & Taylor. Contact Baker & Taylor
for the information to enter into these preferences.
-- `HTML5 Media <#html5>`__
+- :ref:`HTML5 Media`
- This allows libraries to embed streaming media in their catalog
-- `Google <#googleprefs>`__
+- :ref:`Google`
- This service is free and does not require registration, simply
enable GoogleJackets and you're set to go.
-- `I Deam Books <#IDreamLibraries>`__
+- :ref:`I Deam Books <idreamlibraries-label>`
- This is a free service that compiles reviews for popular titles
from many different sources.
-- `LibraryThing <#librarythingprefs>`__
+- :ref:`LibraryThing`
- With the exception of ThingISBN, you will need to contact
LibraryThing for the information to enter into these preferences
- Enabling ThingISBN will help to populate the editions tab on the
bib record display if you have enabled FRBR.
-- `Novelist <#novelistselect>`__
+- :ref:`Novelist <novelist-select-label>`
- This is a pay service from Ebsco. Contact Ebsco for the
information to enter into these preferences
-- `OCLC <#oclcprefs>`__
+- :ref:`OCLC`
- XISBN is used to populate the editions tab on the bib record
display if you have enabled FRBR. This service is free for up to
999 queries a day.
-- `Open Library <#OpenLibraryPrefs>`__
+- :ref:`Open Library`
- Open Library project is an open system that you can pull cover
images (and in the future additional content) from
-- `Overdrive <#overdriveprefs>`__
+- :ref:`Overdrive`
- This is a pay service that libraries can subscribe to for ebook
content. If the library subscribes to Overdrive they can integrate
that content in to Koha for free.
-- `Syndetics <#Syndeticsprefs>`__
+- :ref:`Syndetics`
- This is a pay service from Syndetics to add content for your bib
records. Contact Syndetics for the information to enter into these
preferences.
-- `Tagging <#taggingprefs>`__
+- :ref:`Tagging`
- Choose whether or not you want to allow patrons to add tags to
records in Koha.
-`Acquisitions Configuration <#impacq>`__
+.. _acquisitions-configuration-label:
+
+Acquisitions Configuration
----------------------------------------
When using acquisitions in Koha you first need to define some defaults.
-- Set up your `funds & budgets <#budgetplanning>`__
+- Set up your :ref:`funds & budgets <budgets-label>`
-- Choose your `default currency <#currexchangeadmin>`__ and enter
+- Choose your :ref:`default currency <currencies-and-exchange-rates-label>` and enter
others if you order from multiple countries
-- Enter in your `vendor information <#acqvendors>`__
+- Enter in your :ref:`vendor information <vendors-label>`
-- Create an `Framework with the code ACQ <#marcbibframeworks>`__ (if
+- Create an :ref:`Framework with the code ACQ <marc-bibliographic-frameworks-label>` (if
you're going to enter item records at the time of ordering or
receiving)
- Acquisitions System preferences
- - `AcqCreateItem <#AcqCreateItem>`__ : Decide if an item record is
+ - :ref:`AcqCreateItem` : Decide if an item record is
created during acquisition
- - `CurrencyFormat <#CurrencyFormat>`__ : Decide how you want
+ - :ref:`CurrencyFormat` : Decide how you want
monetary amounts to display
- - `gist <#gist>`__ : Enter your sales tax (if you are billed for
+ - :ref:`gist` : Enter your sales tax (if you are billed for
tax)
- - `OrderPdfFormat <#OrderPdfFormat>`__ : Decide what format you want
+ - :ref:`OrderPdfFormat` : Decide what format you want
your print orders to use
-`Serials Configuration <#impserials>`__
+.. _serials-configuration-label:
+
+Serials Configuration
---------------------------------------
When you use serials there are a few options you can set before hand.
- Serials System Preferences
- - `RenewSerialAddsSuggestion <#RenewSerialAddsSuggestion>`__ :
+ - :ref:`RenewSerialAddsSuggestion` :
Decide if you want renewing serials to add a suggestion for easy
purchasing
- - `RoutingSerials <#RoutingSerials>`__ : Decide if you want to route
+ - :ref:`RoutingSerials` : Decide if you want to route
serials around your library
- - `RoutingListAddReserves <#RoutingListAddReserves>`__ : Decide if
+ - :ref:`RoutingListAddReserves` : Decide if
holds are placed on serials when there is a routing list in place
- Cataloging System Preferences
- - `StaffSerialIssueDisplayCount <#StaffSerialIssueDisplayCount>`__ :
+ - :ref:`StaffSerialIssueDisplayCount` :
Decide how many of the most recent issues to display in the staff
client
- - `OPACSerialIssueDisplayCount <#OPACSerialIssueDisplayCount>`__ :
+ - :ref:`OPACSerialIssueDisplayCount` :
Decide how many of the most recent issues to display in the OPAC
- - `SubscriptionHistory <#SubscriptionHistory>`__ : Decide how you
+ - :ref:`SubscriptionHistory` : Decide how you
want the subscription information to display in the OPAC
-`Planning for Go-Live <#impgolive>`__
+.. _planning-for-go-live-label:
+
+Planning for Go-Live
-------------------------------------
Once you have all of your settings ready, you need to prepare for making
SOPAC2 Installation
===================
-`Introduction <#sopacintro>`__
+.. _introduction-label:
+
+Introduction
------------------------------
This is an installation guide for SOPAC2 and its Koha connector. It has
3.0.x. It does not cover the installation of Koha and Drupal, only
SOPAC, its dependencies and the connector.
-`Installation of Locum and Insurge <#sopacinstall>`__
+.. _installation-of-locum-and-insurge-label:
+
+Installation of Locum and Insurge
-----------------------------------------------------
Locum and Insurge are the two libraries used primarily by SOPAC. They
the ILS via the connector. Both libraries use a different database from
that of Drupal.
-`Dependencies <#sopacdepend>`__
+.. _dependencies-label:
+
+Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are no packages for Debian MDB2 yet, you can install it via pear:
# pear install MDB2
# pear install MDB2#mysql
-`Download <#sopacdownload>`__
+.. _download-label:
+
+Download
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Download the Locum and Insurge libraries from SVN:
# svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
# svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge
-`Creation of the Database <#sopaccreatedb>`__
+.. _creation-of-the-database-label:
+
+Creation of the Database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
mysql> flush privileges;
mysql> exit
-`Sync DSN <#sopacdsn>`__
+.. _sync-dsn-label:
+
+Sync DSN
~~~~~~~~~~~~~~~~~~~~~~~~
This file will provide the connection information to a DB libraries:
<?php
$dsn = 'mysql://scas_user:scas_pass@localhost/scas';
-`Installation of Insurge <#sopacinstallinsurge>`__
+.. _installation-of-insurge-label:
+
+Installation of Insurge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you customize the name of the database, remember to edit the sql
group_id = ""
group_key = ""
-`Installation of Locum <#sopacinstallocum>`__
+.. _installation-of-locum-label:
+
+Installation of Locum
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The same procedure applies to Locum
The rest depends on your Koha configuration.
-`Installation of Koha Connector <#sopackoha>`__
+.. _installation-of-koha-connector-label:
+
+Installation of Koha Connector
-----------------------------------------------
Download the Koha connector using SVN:
# cd /usr/local/lib/locum/connectors/
# svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x
-`Harvest Records <#sopacharvest>`__
+.. _harvest-records-label:
+
+Harvest Records
-----------------------------------
Now that the connector is in place, we will be able to launch
# chmod +x /usr/local/lib/locum/tools/harvest.php
$ /usr/local/lib/locum/tools/harvest.php
-`Installation of Sphinx <#sopacphinx>`__
+.. _installation-of-sphinx-label:
+
+Installation of Sphinx
----------------------------------------
Sphinx is the indexer for the database used by Locum and Insurge.
-`Dependencies <#sphinxdepend>`__
+.. _dependencies-label:
+
+Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There is no Debian package for Sphinx so you'll have to compile the
# apt-get install g++ make libmysql++-dev
-`Download and Compile <#sphinxdownload>`__
+.. _download-and-compile-label:
+
+Download and Compile
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
# cp api/sphinxapi.php /usr/local/sphinx/lib/
$ rm -R sphinx-0.9.8*
-`Creation of User and Group <#sphinxuser>`__
+.. _creation-of-user-and-group-label:
+
+Creation of User and Group
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Creating a Sphinx user and change the owner:
# mkdir /usr/local/sphinx/var/run
# chown -R sphinx.sphinx /usr/local/sphinx/var
-`The Sphinx daemon <#demonsphinx>`__
+.. _the-sphinx-daemon-label:
+
+The Sphinx daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Download:
# update-rc.d sphinx defaults
-`Configuration <#sphinxconfig>`__
+.. _configuration-label:
+
+Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copy the configuration file supplied with the source of Sphinx before
# sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf
-`Indexing documents <#sphinxindexing>`__
+.. _indexing-documents-label:
+
+Indexing documents
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Indexing is necessary if you want to use the search features of SOPAC.
$ /usr/local/sphinx/bin/indexer --all --rotate
-`Installation of SOPAC2 <#installsopac>`__
+.. _installation-of-sopac2-label:
+
+Installation of SOPAC2
------------------------------------------
Now to the SOPAC software itself:
-`Download <#downloadsopac>`__
+.. _download-label:
+
+Download
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Download from SVN:
$ cd modules/
$ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac
-`Installation <#sopacinstallation>`__
+.. _installation-label:
+
+Installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In Drupal's administration settings, activate the module. Also, enable
The Drupal menu should now list these entries.
-`Configuration <#configsopac>`__
+.. _configuration-label:
+
+Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Then go into the settings of SOPAC.
SOPAC2 Installation
===================
-`Introduction <#sopacintro>`__
+.. _introduction-label:
+
+Introduction
------------------------------
This is an installation guide for SOPAC2 and its Koha connector. It has
3.0.x. It does not cover the installation of Koha and Drupal, only
SOPAC, its dependencies and the connector.
-`Installation of Locum and Insurge <#sopacinstall>`__
+.. _installation-of-locum-and-insurge-label:
+
+Installation of Locum and Insurge
-----------------------------------------------------
Locum and Insurge are the two libraries used primarily by SOPAC. They
the ILS via the connector. Both libraries use a different database from
that of Drupal.
-`Dependencies <#sopacdepend>`__
+.. _dependencies-label:
+
+Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are no packages for Debian MDB2 yet, you can install it via pear:
# pear install MDB2
# pear install MDB2#mysql
-`Download <#sopacdownload>`__
+.. _download-label:
+
+Download
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Download the Locum and Insurge libraries from SVN:
# svn co http://dobby.darienlibrary.org/svn/locum/trunk/ locum
# svn co http://dobby.darienlibrary.org/svn/insurge/trunk/ insurge
-`Creation of the Database <#sopaccreatedb>`__
+.. _creation-of-the-database-label:
+
+Creation of the Database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
mysql> flush privileges;
mysql> exit
-`Sync DSN <#sopacdsn>`__
+.. _sync-dsn-label:
+
+Sync DSN
~~~~~~~~~~~~~~~~~~~~~~~~
This file will provide the connection information to a DB libraries:
<?php
$dsn = 'mysql://scas_user:scas_pass@localhost/scas';
-`Installation of Insurge <#sopacinstallinsurge>`__
+.. _installation-of-insurge-label:
+
+Installation of Insurge
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you customize the name of the database, remember to edit the sql
group_id = ""
group_key = ""
-`Installation of Locum <#sopacinstallocum>`__
+.. _installation-of-locum-label:
+
+Installation of Locum
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The same procedure applies to Locum
The rest depends on your Koha configuration.
-`Installation of Koha Connector <#sopackoha>`__
+.. _installation-of-koha-connector-label:
+
+Installation of Koha Connector
-----------------------------------------------
Download the Koha connector using SVN:
# cd /usr/local/lib/locum/connectors/
# svn co http://dobby.darienlibrary.org/svn/connectors/koha/ locum_koha_30x
-`Harvest Records <#sopacharvest>`__
+.. _harvest-records-label:
+
+Harvest Records
-----------------------------------
Now that the connector is in place, we will be able to launch
# chmod +x /usr/local/lib/locum/tools/harvest.php
$ /usr/local/lib/locum/tools/harvest.php
-`Installation of Sphinx <#sopacphinx>`__
+.. _installation-of-sphinx-label:
+
+Installation of Sphinx
----------------------------------------
Sphinx is the indexer for the database used by Locum and Insurge.
-`Dependencies <#sphinxdepend>`__
+.. _dependencies-label:
+
+Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There is no Debian package for Sphinx so you'll have to compile the
# apt-get install g++ make libmysql++-dev
-`Download and Compile <#sphinxdownload>`__
+.. _download-and-compile-label:
+
+Download and Compile
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
# cp api/sphinxapi.php /usr/local/sphinx/lib/
$ rm -R sphinx-0.9.8*
-`Creation of User and Group <#sphinxuser>`__
+.. _creation-of-user-and-group-label:
+
+Creation of User and Group
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Creating a Sphinx user and change the owner:
# mkdir /usr/local/sphinx/var/run
# chown -R sphinx.sphinx /usr/local/sphinx/var
-`The Sphinx daemon <#demonsphinx>`__
+.. _the-sphinx-daemon-label:
+
+The Sphinx daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Download:
# update-rc.d sphinx defaults
-`Configuration <#sphinxconfig>`__
+.. _configuration-label:
+
+Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Copy the configuration file supplied with the source of Sphinx before
# sed 's/scas/MY_DB/g' /usr/local/sphinx/etc/sphinx.conf > tmpfile; mv tmpfile /usr/local/sphinx/etc/sphinx.conf
-`Indexing documents <#sphinxindexing>`__
+.. _indexing-documents-label:
+
+Indexing documents
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Indexing is necessary if you want to use the search features of SOPAC.
$ /usr/local/sphinx/bin/indexer --all --rotate
-`Installation of SOPAC2 <#installsopac>`__
+.. _installation-of-sopac2-label:
+
+Installation of SOPAC2
------------------------------------------
Now to the SOPAC software itself:
-`Download <#downloadsopac>`__
+.. _download-label:
+
+Download
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Download from SVN:
$ cd modules/
$ svn co http://dobby.darienlibrary.org/svn/sopac/trunk/ sopac
-`Installation <#sopacinstallation>`__
+.. _installation-label:
+
+Installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In Drupal's administration settings, activate the module. Also, enable
The Drupal menu should now list these entries.
-`Configuration <#configsopac>`__
+.. _configuration-label:
+
+Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Then go into the settings of SOPAC.
you can enable (search engine indexing, overdue notice generation, data
cleanup and more), this chapter will explain those for you.
-`Cron Jobs <#cronjobs>`__
+.. _cron-jobs-label:
+
+Cron Jobs
-------------------------
The locations below assume a dev install which puts the crons in misc/,
if you have a standard install you may want to look in bin/ for these
files if you cannot find them in misc/
-`Search <#searchcron>`__
+.. _search-label:
+
+Search
~~~~~~~~~~~~~~~~~~~~~~~~
-`Rebuild Index <#rebuildsearchcron>`__
+.. _rebuild-index-label:
+
+Rebuild Index
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/migration\_tools/rebuild\_zebra.pl
Frequency suggestion: every x minutes, (between 5-15 minutes) depending
on performance needs
-`Circulation <#circcron>`__
+.. _circulation-label:
+
+Circulation
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Holds Queue <#buildholdscron>`__
+.. _holds-queue-label:
+
+Holds Queue
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/holds/build\_holds\_queue.pl
Does: Updates holds queue report
-Required by: `Holds Queue Report <#holdsqueue>`__
+Required by: :ref:`Holds Queue Report <holds-queue-label>`
Frequency suggestion: every 1-4 hours
library should be responsible for fulfilling a given hold request.
It's behavior is controlled by the system preferences
- `StaticHoldsQueueWeight <#holdqueueweight>`__ and
- `RandomizeHoldsQueueWeight <#holdqueueweight>`__.
+ :ref:`StaticHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>` and
+ :ref:`RandomizeHoldsQueueWeight <staticholdsqueueweight,-holdsqueueskipclosed-&-randomizeholdsqueueweight-label>`.
If you do not want all of your libraries to participate in the
on-shelf holds fulfillment process, you should list the the libraries
RandomizeHoldsQueueWeight, causing the script to request hold
fulfillment not randomly, but by alphabetical order.
-`Perl Documentation <#buildholdscronperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
''''''''''''''''''''''''''''''''''''''''''''
**GetBibsWithPendingHoldRequests**
Query system preferences to get ordered list of branches to use to fill
hold requests.
-`Expired Holds <#expiredholdscron>`__
+.. _expired-holds-label:
+
+Expired Holds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/holds/cancel\_expired\_holds.pl
Does: By default, this cron job will only automatically cancel holds
where the user has set an expiration date. If the library is using the
-`ExpireReservesMaxPickUpDelay <#ExpireReservesMaxPickUpDelay>`__ and
-`ExpireReservesMaxPickUpDelayCharge <#ExpireReservesMaxPickUpDelayCharge>`__
+:ref:`ExpireReservesMaxPickUpDelay` and
+:ref:`ExpireReservesMaxPickUpDelayCharge`
preferences then this script will also cancel holds that have been
sitting on the hold shelf for too long and will (if the library does)
charge the patron for not picking up the hold.
Frequency suggestion: daily
-`Unsuspend Holds <#unsuspendholdcron>`__
+.. _unsuspend-holds-label:
+
+Unsuspend Holds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/holds/auto\_unsuspend\_holds.pl
Does: This script checks to find holds that should no longer be
suspended and removes the suspension if the
-`AutoResumeSuspendedHolds <#AutoResumeSuspendedHolds>`__ preference is
+:ref:`AutoResumeSuspendedHolds` preference is
set to 'allow'. This puts the patron back in to the queue where they
were when the hold was suspended.
Frequency suggestion: daily
-`Fines <#finescronjob>`__
+.. _fines-label:
+
+Fines
^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/fines.pl
Does: Calculates and posts fines to patron accounts.
-Required by: `finesMode <#finesMode>`__ system preference
+Required by: :ref:`finesMode` system preference
Frequency suggestion: nightly
-`Long Overdues <#longoverduecron>`__
+.. _long-overdues-label:
+
+Long Overdues
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/longoverdue.pl
Staff can control some of the parameters for the longoverdue cron
job with the
- `DefaultLongOverdueLostValue <#DefaultLongOverdueLostValue>`__ and
- `DefaultLongOverdueChargeValue <#DefaultLongOverdueChargeValue>`__
+ :ref:`DefaultLongOverdueLostValue <defaultlongoverduelostvalue-&-defaultlongoverduedays-label>` and
+ :ref:`DefaultLongOverdueChargeValue`
preferences.
-`Perl Documentation <#longoverduecronperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
'''''''''''''''''''''''''''''''''''''''''''''
**NAME**
When an item is marked lost, remove it from the borrowers issued items.
-`Track total checkouts <#updateissuescron>`__
+.. _track-total-checkouts-label:
+
+Track total checkouts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/update\_totalissues.pl
Frequency suggestion: nightly
-`Perl Documentation <#updateissuesperldoc>`__
+.. _perl-documentation-label:
+
+Perl Documentation
'''''''''''''''''''''''''''''''''''''''''''''
**NAME**
Jared Camins-Esakov <jcamins AT cpbibliography DOT com>
-`Generate Patron File for Offline Circulation <#offlinecirccron>`__
+.. _generate-patron-file-for-offline-circulation-label:
+
+Generate Patron File for Offline Circulation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/create\_koc\_db.pl
-Does: Generates the borrowers.db file for use with the `Koha Offline
-Circulation <#windowsofflinecirc>`__ tool
+Does: Generates the borrowers.db file for use with the :ref:`Koha Offline
+Circulation <offline-circ-tool-for-windows-label>` tool
Frequency suggestion: weekly
-`Automatic renewal <#autorenewcron>`__
+.. _automatic-renewal-label:
+
+Automatic renewal
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/automatic\_renewals.pl
Does: Will automatically renew items if you're allowing automatic
-renewal with your `circulation and fine rules <#circfinerules>`__.
+renewal with your :ref:`circulation and fine rules <circulation-and-fine-rules-label>`.
Frequency suggestion: nightly
-`Perl Documentation <#autorenewcronperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
'''''''''''''''''''''''''''''''''''''''''''
**NAME**
No options.
-`Patrons <#patroncrons>`__
+.. _patrons-label:
+
+Patrons
~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Unverified Registrations <#deleteexpiredregistrationcron>`__
+.. _unverified-registrations-label:
+
+Unverified Registrations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/delete\_expired\_opac\_registrations.pl
Does: Deletes patron registrations that were submitted via the OPAC but
not reviewed by the library within the number of days entered in the
-`PatronSelfRegistrationExpireTemporaryAccountsDelay <#PatronSelfRegistrationExpireTemporaryAccountsDelay>`__
+:ref:`PatronSelfRegistrationExpireTemporaryAccountsDelay`
preference.
Frequency suggestion: nightly
-`Unconfirmed Registrations <#deleteunverifiedcron>`__
+.. _unconfirmed-registrations-label:
+
+Unconfirmed Registrations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/delete\_unverified\_opac\_registrations.pl
but not confirmed via email within 24 hours. This is only necessary if
you are requiring patrons to confirm their registrations via email with
the
-`PatronSelfRegistrationVerifyByEmail <#PatronSelfRegistrationVerifyByEmail>`__
+:ref:`PatronSelfRegistrationVerifyByEmail`
preference.
Frequency suggestion: hourly
-`Anonymize Patron Data <#anonymizecron>`__
+.. _anonymize-patron-data-label:
+
+Anonymize Patron Data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/batch\_anonymise.pl
from circulation history so that the stats are kept, but the patron
information is removed for privacy reasons.
-`Update Child to Adult Patron Type <#j2acron>`__
+.. _update-child-to-adult-patron-type-label:
+
+Update Child to Adult Patron Type
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/j2a.pl
Frequency suggestion: nightly
-`Perl Documentation <#j2aperldoc>`__
+.. _perl-documentation-label:
+
+Perl Documentation
''''''''''''''''''''''''''''''''''''
**NAME**
branches, shows all messages, and reports the patrons who would be
affected. Takes no action on the database.
-`Notices <#noticescron>`__
+.. _notices-label:
+
+Notices
~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Message Queue <#msgqueuecron>`__
+.. _message-queue-label:
+
+Message Queue
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/process\_message\_queue.pl
Does: processes the message queue to send the check out, check in and
hold filled emails and SMS message to users and sends outgoing emails to
patrons. requires
-`EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ to be
+:ref:`EnhancedMessagingPreferences` to be
on
Frequency suggestion: 1-4 hours
**Important**
Item due and Advanced due notices are controlled by the
- `advance\_notices cron <#advnoticecron>`__.
+ :ref:`advance\_notices cron <advanced-notice-label>`.
-`Advanced Notice <#advnoticecron>`__
+.. _advanced-notice-label:
+
+Advanced Notice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/advance\_notices.pl
Does: prepares "pre-due" notices and "item due" notices for patrons who
request them prepares notices for patrons for items just due or coming
due soon. requires
-`EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ to be
+:ref:`EnhancedMessagingPreferences` to be
on
Frequency suggestion: nightly
**Note**
This script does not actually send the notices. It queues them in
- the `message queue <#msgqueuecron>`__ for later
+ the :ref:`message queue <message-queue-label>` for later
+
+.. _perl-documentation-label:
-`Perl Documentation <#advnoticecronperl>`__
+Perl Documentation
'''''''''''''''''''''''''''''''''''''''''''
**NAME**
parse\_letter
-`Overdue Notice <#overduenoticecron>`__
+.. _overdue-notice-label:
+
+Overdue Notice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/overdue\_notices.pl
**Note**
This script does not actually send the notices. It queues them in
- the `message queue <#msgqueuecron>`__ for later or generates the
+ the :ref:`message queue <message-queue-label>` for later or generates the
HTML for later printing
-`Perl Documentation <#overduenoticecronperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
'''''''''''''''''''''''''''''''''''''''''''''''
**NAME**
outputformat
-`Print Hold Notices <#printholdcron>`__
+.. _print-hold-notices-label:
+
+Print Hold Notices
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/gather\_print\_notices.pl
Frequency suggestion: nightly
-`Talking Tech <#talkingtechcrons>`__
+.. _talking-tech-label:
+
+Talking Tech
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To learn more about setting up this third party product view the
`Talking Tech Appendix <#talkingtechappendix>`__.
-`Sending Notices File <#talkingtechsendcron>`__
+.. _sending-notices-file-label:
+
+Sending Notices File
'''''''''''''''''''''''''''''''''''''''''''''''
Script path: misc/cronjobs/thirdparty/TalkingTech\_itiva\_outbound.pl
Tech i-tiva phone notification system.
Required by:
-`TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
+:ref:`TalkingTechItivaPhoneNotification`
Frequency suggestion: nightly
-`Perl Documentation <#talkingsendcronperl>`__
+:ref:`Perl Documentation`
**USAGE**
library specific settings, such as prompts, to those notices. This field
can be blank if all messages are from a single library.
-`Receiving Notices File <#talkingtechreceivecron>`__
+.. _receiving-notices-file-label:
+
+Receiving Notices File
''''''''''''''''''''''''''''''''''''''''''''''''''''
Script path: misc/cronjobs/thirdparty/TalkingTech\_itiva\_inbound.pl
phone notification system.
Required by:
-`TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
+:ref:`TalkingTechItivaPhoneNotification`
Frequency suggestion: nightly
-`Perl Documentation <#talkingreceivecronperl>`__
+:ref:`Perl Documentation`
**USAGE**
REQUIRED. Path to incoming results file.
-`Notify Patrons of Expiration <#patronexpirycron>`__
+.. _notify-patrons-of-expiration-label:
+
+Notify Patrons of Expiration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/membership\_expiry.pl
Does: Sends messages to warn patrons of their card expiration to the
-`messaage queue <#msgqueuecron>`__ cron.
+:ref:`messaage queue <message-queue-label>` cron.
-Requires: `MembershipExpiryDaysNotice <#MembershipExpiryDaysNotice>`__
+Requires: :ref:`MembershipExpiryDaysNotice`
Frequency: nightly
-`In Processing/Book Cart <#proccartcron>`__
+.. _in-processing/book-cart-label:
+
+In Processing/Book Cart
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Script path: misc/cronjobs/cart\_to\_shelf.pl
Does: Updates all items with a location of CART to the item's permanent
location.
-Required by: `NewItemsDefaultLocation <#NewItemsDefaultLocation>`__,
-`InProcessingToShelvingCart <#InProcessingToShelvingCart>`__, &
-`ReturnToShelvingCart <#ReturnToShelvingCart>`__ system preferences
+Required by: :ref:`NewItemsDefaultLocation`,
+:ref:`InProcessingToShelvingCart`, &
+:ref:`ReturnToShelvingCart` system preferences
Frequency suggestion: hourly
-`Perl Documentation <#proccartcronperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**NAME**
original shelving location after X hours. Execute without options for
help.
-`Catalog <#catalogcron>`__
+.. _catalog-label:
+
+Catalog
~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Check URLs <#checkurlcron>`__
+.. _check-urls-label:
+
+Check URLs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/check-url.pl
Learn more: http://wiki.koha-community.org/wiki/Check-url_enhancements
-`Perl Documentation <#checkurlcronperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
''''''''''''''''''''''''''''''''''''''''''
**NAME**
Print this help page.
-`Update Authorities <#mergeauthcron>`__
+.. _update-authorities-label:
+
+Update Authorities
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/migration\_tools/merge\_authority.pl
Frequency suggestion: nightly
-`Serials Update <#serialscron>`__
+.. _serials-update-label:
+
+Serials Update
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/serialsUpdate.pl
Frequency suggestion: nightly
-`Automatic item update <#autoitemupdatecron>`__
+.. _automatic-item-update-label:
+
+Automatic item update
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/automatic\_item\_modification\_by\_age.pl
Does: updates items based on the list of rules set forth in the
-`Automatic item modifications by age <#autoitemagemod>`__ tool
+:ref:`Automatic item modifications by age` tool
-Required by: `Automatic item modifications by age <#autoitemagemod>`__
+Required by: :ref:`Automatic item modifications by age`
Frequency suggestions: nightly
-`Perl Documentation <#autoitemupdatecrondoc>`__
+.. _perl-documentation-label:
+
+Perl Documentation
'''''''''''''''''''''''''''''''''''''''''''''''
**NAME**
You should have received a copy of the GNU General Public License along
with Koha; if not, see <http://www.gnu.org/licenses>.
-`OPAC <#opaccrons>`__
+.. _opac-label:
+
+OPAC
~~~~~~~~~~~~~~~~~~~~~
-`RSS Feeds <#customrssfeedcron>`__
+.. _rss-feeds-label:
+
+RSS Feeds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/rss/rss.pl
Does: Produces an RSS XML document for any SQL query (not used for
-search results RSS feed). `Learn more <#customrss>`__.
+search results RSS feed). :ref:`Learn more <custom-rss-feeds-label>`.
Frequency suggestion: hourly
-`Authorities Browser <#authbrowsercron>`__
+.. _authorities-browser-label:
+
+Authorities Browser
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/build\_browser\_and\_cloud.pl
Does: Generate content for authorities browse in OPAC
-Required by: `OpacBrowser <#OpacBrowser>`__ system preference
+Required by: :ref:`OpacBrowser` system preference
**Important**
This preference and cron job should only be used on French systems.
-`Subject/Author Clouds <#keywordclouds>`__
+.. _subject/author-clouds-label:
+
+Subject/Author Clouds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/cloud-kw.pl
Frequency: This is the type of script you can run once a month or so,
the content generated isn't going to change very much over time.
-`Perl Documentation <#keywordcloudsperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
'''''''''''''''''''''''''''''''''''''''''''
**NAME**
Now terms are outputted in the lexical order. They could be sorted by
their weight.
-`System Administration <#systemcron>`__
+.. _system-administration-label:
+
+System Administration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Clean up Database <#cleandbcron>`__
+.. _clean-up-database-label:
+
+Clean up Database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/cleanup\_database.pl
purge patrons restrictions expired since more than DAYS days. Defaults
to 30 days if no days specified.
-`Share Usage Stats <#usagecron>`__
+.. _share-usage-stats-label:
+
+Share Usage Stats
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/share\_usage\_with\_koha\_community.pl
-Does: If you're sharing information via the `UsageStats <#UsageStats>`__
+Does: If you're sharing information via the :ref:`UsageStats`
feature this will send your info to the `Hea
website <http://hea.koha-community.org/>`__.
Frequency: monthly
-`Perl Documentation <#usagecronperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
'''''''''''''''''''''''''''''''''''''''
**NAME**
share\_usage\_with\_koha\_community.pl [-h\|--help] [-v\|--verbose]
-If the `UsageStats <#UsageStats>`__ system preference is set, you can
+If the :ref:`UsageStats` system preference is set, you can
launch this script to share your usage data anonymously with the Koha
community.
collect some system preference values.
If you want to tell us who you are, you can fill the
-`UsageStatsLibraryName <#UsageStatsLibraryName>`__ system preference
+:ref:`UsageStatsLibraryName` system preference
with your library name,
-`UsageStatsLibraryUrl <#UsageStatsLibraryUrl>`__,
-`UsageStatsLibraryType <#UsageStatsLibraryType>`__ and/or
-`UsageStatsCountry <#UsageStatsCountry>`__.
+:ref:`UsageStatsLibraryUrl`,
+:ref:`UsageStatsLibraryType` and/or
+:ref:`UsageStatsCountry`.
All these data will be analyzed on the http://hea.koha-community.org
Koha community website.
with Koha; if not, write to the Free Software Foundation, Inc., 51
Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-`Acquisitions <#acqcrons>`__
+.. _acquisitions-label:
+
+Acquisitions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Clean up old suggestions <#cleansuggcron>`__
+.. _clean-up-old-suggestions-label:
+
+Clean up old suggestions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/purge\_suggestions.pl
Does: Removes old (defined by you) suggestions from the suggestion
management area.
-`Email suggestions to process <#emailsuggestfund>`__
+.. _email-suggestions-to-process-label:
+
+Email suggestions to process
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/notice\_unprocessed\_suggestions.pl
Does: Generates a notice to the fund owner that there are suggestions in
need of processing
-`Perl Documentation <#emailsuggestfundperl>`__
+.. _perl-documentation-label:
+
+Perl Documentation
''''''''''''''''''''''''''''''''''''''''''''''
**NAME**
-v\|--verbose Verbose mode.
-`EDI Message Processing <#edicron>`__
+.. _edi-message-processing-label:
+
+EDI Message Processing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Script path: misc/cronjobs/edi\_cron.pl
Frequency: Every 15 minutes
-`Deprecated scripts <#deprecatedcrons>`__
+.. _deprecated-scripts-label:
+
+Deprecated scripts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
These should not be run without modification:
Web Services
============
-`OAI-PMH <#OAI-PMHservice>`__
+.. _oai-pmh-label:
+
+OAI-PMH
-----------------------------
For the Open Archives Initiative-Protocol for Metadata Harvesting
Learn more about OAI-PMH at: http://www.openarchives.org/pmh/
-To enable OAI-PMH in Koha edit the `OAI-PMH <#OAI-PMH>`__ preference.
+To enable OAI-PMH in Koha edit the :ref:`OAI-PMH` preference.
Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl to
see your file.
-`Sample OAI Conf File <#oaiconfsample>`__
+.. _sample-oai-conf-file-label:
+
+Sample OAI Conf File
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
xsl_file:
/usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl
-`REST services <#Rest-services>`__
+.. _rest-services-label:
+
+REST services
----------------------------------
Koha can now be requested by REST http requests. BibLibre wrotes an
Using the SRU server
====================
-`Using the SRU server <#usingsru>`__
+.. _using-the-sru-server-label:
+
+Using the SRU server
------------------------------------
Koha implements the Search/Retrieve via URL (SRU) protocol. More
http://www.loc.gov/standards/sru/. The version implemented is version
1.1.
-`Explain <#sru_explain>`__
+.. _explain-label:
+
+Explain
~~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to have information about the implementation of SRU on a
</index>
-`Search <#sru_search>`__
+.. _search-label:
+
+Search
~~~~~~~~~~~~~~~~~~~~~~~~
This url :
gives more details about the search operations and in particular the
list of optional parameters for searching.
-`More details about Search <#sru_search_more_details>`__
+.. _more-details-about-search-label:
+
+More details about Search
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The "operation" key can take two values: scan or searchRetrieve.
http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
first
-`Retrieve <#sru_retrieve>`__
+.. _retrieve-label:
+
+Retrieve
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
My search for
System Preference Defaults
==========================
-`ISBD Defaults <#isbddefaults>`__
+.. _isbd-defaults-label:
+
+ISBD Defaults
---------------------------------
-Default values for the `ISBD <#isbdpref>`__ preference.
+Default values for the :ref:`ISBD` preference.
-`MARC Default <#isbddefault>`__
+.. _marc-default-label:
+
+MARC Default
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#100\|\|{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{ 110d
#088\|<br/><br/><label>Report. No.: </label>\|{ 088a }\|
-`UNIMARC Default <#unimarcdefault>`__
+.. _unimarc-default-label:
+
+UNIMARC Default
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#200\|<h2>Title : \|{200a}{. 200c}{ : 200e}{200d}{. 200h}{. 200i}\|</h2>
{995y}</td><td>{995e} </td><td>
{995o}</td><td>{995f}</td></tr>\|</table>
-`OPACISBD Defaults <#opacisbddefaults>`__
+.. _opacisbd-defaults-label:
+
+OPACISBD Defaults
-----------------------------------------
-Default values for the `OPACISBD <#OPACISBD>`__ preference.
+Default values for the :ref:`OPACISBD` preference.
+
+.. _marc-label:
-`MARC <#opacisbdmarcdefault>`__
+MARC
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#100\|\|{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{ 110d
The following instructions are for specific receipt printers, but can
probably be used to help with setup of other brands as well.
-`For Epson TM-T88III (3) & TM-T88IV (4) Printers <#epsonprinters>`__
+.. _for-epson-tm-t88iii-(3)-&-tm-t88iv-(4)-printers-label:
+
+For Epson TM-T88III (3) & TM-T88IV (4) Printers
--------------------------------------------------------------------
-`In the Print Driver <#epsonprintdriver>`__
+.. _in-the-print-driver-label:
+
+In the Print Driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For these instructions, we are using version 5,0,3,0 of the Epson
- OK your way out of there.
-`In Firefox <#epsonfirefox>`__
+.. _in-firefox-label:
+
+In Firefox
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Under File > Page Setup:
Setting the print.always\_print\_silent setting in about:config
DISABLES the ability to choose a printer in Firefox.
-`For Epson TM-T88II (2) Printers <#epson2>`__
+.. _for-epson-tm-t88ii-(2)-printers-label:
+
+For Epson TM-T88II (2) Printers
---------------------------------------------
Register at the `EpsonExpert Technical Resource Center
drivers; go to Technical Resources, then choose the printer model from
the Printers drop-down list.
-`In Firefox <#epson2firefox>`__
+.. _in-firefox-label:
+
+In Firefox
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Under File > Page Setup:
Setting the print.always\_print\_silent setting in about:config
DISABLES the ability to choose a printer in Firefox.
-`For Star SP542 Printers <#starprinter>`__
+.. _for-star-sp542-printers-label:
+
+For Star SP542 Printers
------------------------------------------
-`Installing the Printer <#installstarprinter>`__
+.. _installing-the-printer-label:
+
+Installing the Printer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
While the following comments are based on the Star SP542 receipt
**Windows 7** users should refer to this page:
http://www.starmicronics.com/supports/win7.aspx.
-`Configuring Firefox to Print to Receipt Printer <#firefoxreceipt>`__
+.. _configuring-firefox-to-print-to-receipt-printer-label:
+
+Configuring Firefox to Print to Receipt Printer
---------------------------------------------------------------------
- Open File > Page Setup
Notice & Slips Guides
=====================
-`Field Guide for Notices & Slips <#noticesfieldguide>`__
+.. _field-guide-for-notices-&-slips-label:
+
+Field Guide for Notices & Slips
--------------------------------------------------------
This guide will break down the notices and slips information in 3 ways.
Sample Serials
==============
-`Reader's Digest (0034-0375) <#readersdigestsample>`__
+.. _reader's-digest-(0034-0375)-label:
+
+Reader's Digest (0034-0375)
------------------------------------------------------
- Published 12 times a year (monthly)
Sample Reader's Digest Subscription
|image1069|
-`People Weekly (1076-0091) <#peoplesample>`__
+.. _people-weekly-(1076-0091)-label:
+
+People Weekly (1076-0091)
---------------------------------------------
- Published weekly
in week 51, which we have to define the enumeration for, then the next
predicted issue will be the following year's first week.
-`Et-Mol <#hebrewserialsample>`__
+.. _et-mol-label:
+
+Et-Mol
--------------------------------
This journal is published with the following rules:
Sample for this Hebrew Journal
|image1070|
-`Backpacker (0277-867X) <#backpackerserial>`__
+.. _backpacker-(0277-867x)-label:
+
+Backpacker (0277-867X)
----------------------------------------------
Published 9 times a year irregularly. The issues continues while the
v. 42, no. 4, iss. 312
-`Keats-Shelley Journal (0453-4387) <#keatsserial>`__
+.. _keats-shelley-journal-(0453-4387)-label:
+
+Keats-Shelley Journal (0453-4387)
----------------------------------------------------
This journal is published once per year in July. The numbering follows
Serial planning
|image1072|
-`Computers in Libraries (1041-7915) <#cilserial>`__
+.. _computers-in-libraries-(1041-7915)-label:
+
+Computers in Libraries (1041-7915)
---------------------------------------------------
Computers in Libraries is published ten times per year (monthly with
Sample List & Cart Emails
=========================
-`Example Email from List <#examplelistemail>`__
+.. _example-email-from-list-label:
+
+Example Email from List
-----------------------------------------------
Below is an example of an email from a list in Koha.
East Branch (813/.54)
South Branch FIC (FIC Bro) TVSN5000451333
-`Example Email from Cart <#examplecartemail>`__
+.. _example-email-from-cart-label:
+
+Example Email from Cart
-----------------------------------------------
Below is a sample of what an email from the Cart in Koha will look like:
Using Koha as a Content Management System (CMS)
===============================================
-`Setup <#kohacmssetup>`__
+.. _setup-label:
+
+Setup
-------------------------
These are instructions for taking a default install of Koha and allowing
To learn more visit the Koha wiki page on this topic:
http://wiki.koha-community.org/wiki/Koha_as_a_CMS
-`Editing the pages template <#kohacmstmpl>`__
+.. _editing-the-pages-template-label:
+
+Editing the pages template
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The file to create / edit for the pages template will depend on your
-`opacthemes <#opacthemes>`__ system preference setting
+:ref:`opacthemes` system preference setting
+
+.. _editing-'bootstrap'-theme-template-(current)-label:
-`Editing 'bootstrap' theme template (current) <#kohacmstmplboot>`__
+Editing 'bootstrap' theme template (current)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Copy
[% END %]
-`Troubleshooting <#kohacmstrouble>`__
+.. _troubleshooting-label:
+
+Troubleshooting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have problems check file permissions on pages.pl and pages.tmpl.
They should have the same user and group as other Koha files like
opac-main.pl.
-`Bonus Points <#kohacmsbonus>`__
+.. _bonus-points-label:
+
+Bonus Points
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Instead of using the address
Then restart Apache.
-`Usage <#kohacmsusage>`__
+.. _usage-label:
+
+Usage
-------------------------
After setting up Koha as a CMS you can create new pages following these
instructions:
-`Adding Pages <#kohacmspages>`__
+.. _adding-pages-label:
+
+Adding Pages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To add a new page you need to add a system preference under Local Use.
Settings for the new preference
|image1077|
-`Viewing your page <#kohacmsview>`__
+.. _viewing-your-page-label:
+
+Viewing your page
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can view your new page at
http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is the
part you entered after 'page\_' in the Variable field.
-`Example <#kohacmsexpage>`__
+.. _example-label:
+
+Example
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This process can be used to create recommended reading lists within
Edit original preference to add new page
|image1080|
-`Live Examples <#examplecms>`__
+.. _live-examples-label:
+
+Live Examples
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- The Crawford Library at Dallas Christian College is using this method
Resetting the database may be useful if you install Koha with the sample
data, and then wish to use real data without reinstalling the software.
-`Delete sample data from Tables <#deletetables>`__
+.. _delete-sample-data-from-tables-label:
+
+Delete sample data from Tables
--------------------------------------------------
Use your preferred MySQL client to
tables. For instructions follow this thread:
https://lists.katipo.co.nz/pipermail/koha/2013-July/036853.html.
-`Reset the Zebra Index <#resetzebra>`__
+.. _reset-the-zebra-index-label:
+
+Reset the Zebra Index
---------------------------------------
Run the following commands to reset the authorities and biblios Zebra
Important Links
===============
-`Koha Related <#koharelatedlinks>`__
+.. _koha-related-label:
+
+Koha Related
------------------------------------
- Report Koha Bugs - http://bugs.koha-community.org
- Koha Shared Links - http://groups.diigo.com/group/everything-koha
-`Circulation Related <#circrelatedlinks>`__
+.. _circulation-related-label:
+
+Circulation Related
-------------------------------------------
- Koha Desktop Offline Circulation:
- Koha Firefox Offline Circulation:
https://addons.mozilla.org/en-US/firefox/addon/koct/
-`Cataloging Related <#catalogrelatedlinks>`__
+.. _cataloging-related-label:
+
+Cataloging Related
---------------------------------------------
- Koha MARC Tutorials - http://www.pakban.net/brooke/
- Z39.50 Bib-1 Attribute -
http://www.loc.gov/z3950/agency/defns/bib1.html
-`Enhanced Content Related <#enhancedcontentlinks>`__
+.. _enhanced-content-related-label:
+
+Enhanced Content Related
----------------------------------------------------
- Amazon Associates -
- LibraryThing for Libraries - http://www.librarything.com/forlibraries
-`Design Related <#opaclinks>`__
+.. _design-related-label:
+
+Design Related
-------------------------------
- JQuery Library - http://wiki.koha-community.org/wiki/JQuery_Library
- Owen Leonard's Koha Blog - http://www.myacpl.org/koha
-`Reports Related <#reportlinks>`__
+.. _reports-related-label:
+
+Reports Related
----------------------------------
- SQL Reports Library -
- Sample reports from NEKLS -
http://www.nexpresslibrary.org/training/reports-training/
-`Installation Guides <#installlinks>`__
+.. _installation-guides-label:
+
+Installation Guides
---------------------------------------
- Installing Koha 3 on Ubuntu -
- Koha 3.2 on Debian Squeeze -
http://wiki.koha-community.org/wiki/Koha_3.2_on_Debian_Squeeze
-`Misc <#misclinks>`__
+.. _misc-label:
+
+Misc
---------------------
- Zotero - http://zotero.org
====================
When you have any of the XSLT system preferences
-(`OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__,
-`OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__,
-`XSLTDetailsDisplay <#XSLTDetailsDisplay>`__, and/or
-`XSLTResultsDisplay <#XSLTResultsDisplay>`__) along with the
-`DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__ and
-`DisplayIconsXSLT <#DisplayIconsXSLT>`__ preferences turned on you will
+(:ref:`OPACXSLTDetailsDisplay`,
+:ref:`OPACXSLTResultsDisplay`,
+:ref:`XSLTDetailsDisplay`, and/or
+:ref:`XSLTResultsDisplay`) along with the
+:ref:`DisplayOPACiconsXSLT` and
+:ref:`DisplayIconsXSLT` preferences turned on you will
see item type icons on the related screen.
**Important**
These images are coming from values found in your leader, if your
leader is not cataloged properly it might be best to turn off the
- `DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__ preference (which
+ :ref:`DisplayOPACiconsXSLT` preference (which
can be done while leaving the other XSLT preferences turned on).
Book image
**Important**
Many of the actions described in this chapter can be done in Koha
- using `Marc Modification Templates <#marcmodtemplates>`__, but this
+ using :ref:`Marc Modification Templates <marc-modification-templates-label>`, but this
section is here for those who are used to MarcEdit.
-`Adding a prefix to call numbers <#marceditprefix>`__
+.. _adding-a-prefix-to-call-numbers-label:
+
+Adding a prefix to call numbers
-----------------------------------------------------
When bringing data into Koha, you may want to first clean it up. One
text string, add ^b[string to replace] to the Field Data textbox
and the data to be appended in the Replace With textbox.
-`Importing Excel data into Koha <#marceditexcel>`__
+.. _importing-excel-data-into-koha-label:
+
+Importing Excel data into Koha
---------------------------------------------------
Suppose you have records of your library in excel data sheet format and
Follow the given steps to import your excel records into Koha
-`Converting from Excel format into .mrk format <#convertexcel>`__
+.. _converting-from-excel-format-into-.mrk-format-label:
+
+Converting from Excel format into .mrk format
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
First, we will convert excel format into .mrk format. For this we will
Click Close and we have created a .mrk file from .xls file in this step.
You can view the file by double clicking on it.
-`Convert .mrk file to .mrc <#convertmrk>`__
+.. _convert-.mrk-file-to-.mrc-label:
+
+Convert .mrk file to .mrc
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We will convert .mrk file that we have created in the above step into
Click Close and now we have raw Marc records with us (.mrc file).
-`Import .mrc into Koha <#importmrc>`__
+.. _import-.mrc-into-koha-label:
+
+Import .mrc into Koha
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
More information on importing records into Koha can be found in the
-'`Stage MARC Records for Import <#stagemarc>`__' section of this manual.
+':ref:`Stage MARC Records for Import`' section of this manual.
Finally we will import above created .mrc file into Koha.
libraries can subscribe to. Learn more here:
http://www.talkingtech.com/solutions/library.
-`Installation and Setup Instructions <#talkingtechinstall>`__
+.. _installation-and-setup-instructions-label:
+
+Installation and Setup Instructions
-------------------------------------------------------------
Be sure you've run
messaging transport preferences)
To use,
-`TalkingTechItivaPhoneNotification <#TalkingTechItivaPhoneNotification>`__
+:ref:`TalkingTechItivaPhoneNotification`
syspref must be turned on.
If you wish to process PREOVERDUE or RESERVES messages, you'll need the
-`EnhancedMessagingPreferences <#EnhancedMessagingPreferences>`__ system
+:ref:`EnhancedMessagingPreferences` system
preference turned on, and patrons to have filled in a preference for
receiving these notices by phone.
For OVERDUE messages, overdue notice triggers must be configured under
-Koha -> Tools -> `Overdue Notice Triggers <#noticetriggers>`__. Either
+Koha -> Tools -> :ref:`Overdue Notice Triggers <overdue-notice/status-triggers-label>`. Either
branch-specific triggers or the default level triggers may be used
(script will select whichever is appropriate).
-`Sending Notices File <#talkingtechsend>`__
+.. _sending-notices-file-label:
+
+Sending Notices File
-------------------------------------------
-1. Add the `TalkingTech\_itiva\_outbound.pl <#talkingtechsendcron>`__
+1. Add the :ref:`TalkingTech\_itiva\_outbound.pl <sending-notices-file-label>`
script to your crontab
2. Add an FTP/SFTP or other transport method to send the output file to
Run TalkingTech\_itiva\_outbound.pl --help for more information
-`Receiving Results File <#talkingtechreceive>`__
+.. _receiving-results-file-label:
+
+Receiving Results File
------------------------------------------------
1. Add an FTP/SFTP or other transport method to send the Results file to
a known directory on your Koha server
-2. Add the `TalkingTech\_itiva\_inbound.pl <#talkingtechreceivecron>`__
+2. Add the :ref:`TalkingTech\_itiva\_inbound.pl <receiving-notices-file-label>`
script to your crontab, aimed at that directory
3. If you wish, archive the results file in another directory after
will help you set up the OCLC Connexion Gateway, if you have a system
administrator you will want to consult with them on this process.
-`Setting up OCLC service on Koha <#oclckohasetup>`__
+.. _setting-up-oclc-service-on-koha-label:
+
+Setting up OCLC service on Koha
----------------------------------------------------
First, you'll need to create a file somewhere on your system with
When choosing an 'import\_mode' if you use "direct" then the staged
record will be immediately imported into Koha, and should be searchable
after your indexes catch up. If you choose "stage", then the record
-will be placed in a staged batch for you to later go the `Manage Staged
-MARC Records <#managestaged>`__ tool to finish the import.
+will be placed in a staged batch for you to later go the :ref:`Manage Staged
+MARC Records <staged-marc-record-management-label>` tool to finish the import.
If you import multiple records, they'll be in the same batch, until that
batch is imported, then a new batch will be created.
/location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf
-`Setting up your OCLC desktop client <#oclcdesktopsetup>`__
+.. _setting-up-your-oclc-desktop-client-label:
+
+Setting up your OCLC desktop client
-----------------------------------------------------------
**Note**
- Enter the following information:
- "Host Name:" Your catalog’s appropriate IP address (from your
- `config file above <#oclckohasetup>`__)
+ :ref:`config file above <setting-up-oclc-service-on-koha-label>`)
- "Port:" Your catalog's appropriate port number (from your
- `config file above <#oclckohasetup>`__)
+ :ref:`config file above <setting-up-oclc-service-on-koha-label>`)
- "Login ID:" The cataloger's Koha login
including its biblio number, and a URL that you can copy into your web
browser to jump straight to the record.
-`Using the OCLC Connexion Gateway <#oclcgateway>`__
+.. _using-the-oclc-connexion-gateway-label:
+
+Using the OCLC Connexion Gateway
---------------------------------------------------
Records can be exported from Connexion either in a batch or one by one.
-`Exporting records one by one <#oclconeexport>`__
+.. _exporting-records-one-by-one-label:
+
+Exporting records one by one
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To export bibliographic records one by one, be sure your "Batch" options
If the record was overlaid, you will see a message to that effect in the
"OCLC Gateway Export Status" windowOverlay confirmation
-`Exporting records in a batch <#oclcbatchexport>`__
+.. _exporting-records-in-a-batch-label:
+
+Exporting records in a batch
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To export bibliographic records in a batch, be sure your "Batch" options
completed. Then you may or may not see the Connexion Client export
report (depending on your Client options for that).
-`Items in OCLC <#oclcitems>`__
+.. _items-in-oclc-label:
+
+Items in OCLC
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you'd like to create your item records in OCLC you can do so by
addding a 952 for each item to the bib record you're cataloging. The
-`Item/Holdings Cataloging Guide <#itemcatguide>`__ will break down what
+:ref:`Item/Holdings Cataloging Guide <item/holdings-record-cataloging-guide-label>` will break down what
subfields you can use in the 952, but at the minimum you want to have
subfield 2, a, b, and y on your items.
- The subfield 2 holds the classification code. This can be ddc for
Dewey or lcc for Library of Congress or z for Custom. Other
- classification sources can be found in the `Classification
- Sources <#classificationsources>`__ area in administration
+ classification sources can be found in the :ref:`Classification
+ Sources <classification-sources-label>` area in administration
- Subfield a is your home library and needs to be the code for your
home library, not the library name. You can find these codes in the
- `Libraries & Groups <#libsgroups>`__ administration area.
+ :ref:`Libraries & Groups` administration area.
- Subfield b is your holding library and needs to be the code for your
holding library, not the library name. You can find these codes in
- the `Libraries & Groups <#libsgroups>`__ administration area.
+ the :ref:`Libraries & Groups` administration area.
- Subfield y is your item type code. It needs to be the code, not the
- item type name. You can find these codes in the `Item
- Types <#itemtypeadmin>`__ administration area.
+ item type name. You can find these codes in the :ref:`Item
+ Types <item-types-label>` administration area.
952 \\\\$2ddc$aMAIN$bMAIN$yBOOK
In addition to these required fields you can enter any other subfield
you'd like. Most libraries will enter a call number in subfield o and a
-barcode in subfield p as well. Review the `Item/Holdings Cataloging
-Guide <#itemcatguide>`__ for a full list of subfields and values.
+barcode in subfield p as well. Review the :ref:`Item/Holdings Cataloging
+Guide <item/holdings-record-cataloging-guide-label>` for a full list of subfields and values.
FAQs
====
-`Display <#displayfaq>`__
+.. _display-label:
+
+Display
-------------------------
-`Custom Item Type/Authorized Value Icons <#customicons>`__
+.. _custom-item-type/authorized-value-icons-label:
+
+Custom Item Type/Authorized Value Icons
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question:** Can I have my own set of item type images (or authorized
Remember to put the icons in both places (on the OPAC and the
intranet).
-`Customizing Koha Images <#customkohaimages>`__
+.. _customizing-koha-images-label:
+
+Customizing Koha Images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Can I customize the images in the OPAC?
you can alter to meet your needs. The originals can be found in the
misc/interface\_customization/ directory.
-`OPAC Display Fields <#opacdisplayfaq>`__
+.. _opac-display-fields-label:
+
+OPAC Display Fields
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What MARC fields print to the different OPAC screens in
**Answer**: The XSLT preference must be set as follows for the following
fields to show
-- `OPACXSLTResultsDisplay <#OPACXSLTResultsDisplay>`__ = using XSLT
+- :ref:`OPACXSLTResultsDisplay` = using XSLT
stylesheets
-- `OPACXSLTDetailsDisplay <#OPACXSLTDetailsDisplay>`__ = using XSLT
+- :ref:`OPACXSLTDetailsDisplay` = using XSLT
stylesheets
-- `DisplayOPACiconsXSLT <#DisplayOPACiconsXSLT>`__ = show
+- :ref:`DisplayOPACiconsXSLT` = show
The OPAC Results page shows:
- plus all of the 5xx fields in the Notes tab at the bottom
-`Subtitle Display on Bib Records <#displaysubtitle>`__
+.. _subtitle-display-on-bib-records-label:
+
+Subtitle Display on Bib Records
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: How do I get the subtitle to display on the detail pages
for my bib records?
-**Answer**: Subtitle display now depends on there being a `keyword
-mapping <#keywordmapping>`__ for the MARC field in question. Adding a
+**Answer**: Subtitle display now depends on there being a :ref:`keyword
+mapping <keywords-to-marc-mapping-label>` for the MARC field in question. Adding a
mapping for "subtitle" -> "245b" for an item's framework results in
display of the subtitle in OPAC and staff client search and detail pages
(although not in all instances where subtitles might be displayed, e.g.
the Cart).
-`Show patrons the barcodes of items they have checked out <#opacbarcodesfaq>`__
+.. _show-patrons-the-barcodes-of-items-they-have-checked-out-label:
+
+Show patrons the barcodes of items they have checked out
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Can patrons see the barcodes for the items they have
**Answer**: Not by default, but with a few edits to the patron record
you can make a barcode column appear on the patron's check out summary
-in the OPAC. You can set up a `patron
-attribute <#patronattributetypes>`__ with the value of SHOW\_BCODE and
-`authorized value <#authorizedvalues>`__ of YES\_NO to make this happen.
+in the OPAC. You can set up a :ref:`patron
+attribute <patron-attribute-types-label>` with the value of SHOW\_BCODE and
+:ref:`authorized value <authorized-values-label>` of YES\_NO to make this happen.
Add SHOW\_BCODE patron attribute
|image1112|
-Then on the `patron's record set the value <#editpatrons>`__ for
+Then on the :ref:`patron's record set the value <editing-patrons-label>` for
SHOW\_BCODE to yes.
Setting value for SHOW\_BCODE on patron record
Clicking on the 'Overdue' tab will show only the items that are overdue.
-`Circulation/Notices <#circfaq>`__
+.. _circulation/notices-label:
+
+Circulation/Notices
----------------------------------
-`Book drop Date <#dropboxfaq>`__
+.. _book-drop-date-label:
+
+Book drop Date
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: How is the book drop date is determined? Is it the last
the 4 closed days. The only way to change the effective checkin date in
book drop mode is to modify the calendar.
-`Holds to Pull and Holds Queue <#holdsreportsfaq>`__
+.. _holds-to-pull-and-holds-queue-label:
+
+Holds to Pull and Holds Queue
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-**Question**: What is the difference between the `Holds
-Queue <#holdsqueue>`__ and `Holds to Pull <#holdspull>`__?
+**Question**: What is the difference between the :ref:`Holds
+Queue <holds-queue-label>` and :ref:`Holds to Pull <holds-to-pull-label>`?
**Answer**: The holds to pull report gives a simple list of what holds
need to be filled with available items. It should only be used in Koha
installations where there is only one library.
The holds queue tries to do the same thing, but in a 'smarter' way. This
-allows it to split up the list by library, consult the `transport cost
-matrix <#transportcostmatrix>`__ and refresh regularly to provide
+allows it to split up the list by library, consult the :ref:`transport cost
+matrix <transport-cost-matrix-label>` and refresh regularly to provide
different pull lists to each library.
-`Duplicate Overdue Notices <#dupoverduefaq>`__
+.. _duplicate-overdue-notices-label:
+
+Duplicate Overdue Notices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Why are patrons getting two overdue notices?
the notification will be generated twice. A quick fix is to discard
"default rule" for instance.
-`Printing Overdue Notices <#printoverduefaq>`__
+.. _printing-overdue-notices-label:
+
+Printing Overdue Notices
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Can I print overdue notices for patrons without email
addresses on file?
-**Answer**: Yes. The `overdue notice cron job <#overduenoticecron>`__
+**Answer**: Yes. The :ref:`overdue notice cron job <overdue-notice-label>`
has a setting to generate the overdue notices as HTML for printing. An
example of this usage would be:
the form. The script has code that wraps around the notice file to tell
the HTML to obey the formatting, and to do a page break between notices.
That's so that when staff print it out, they get one per page. We had to
-add an extra syspref (`PrintNoticesMaxLines <#PrintNoticesMaxLines>`__)
+add an extra syspref (:ref:`PrintNoticesMaxLines`)
to specify page length because our client allows a \_lot\_ of checkouts
which meant some notices were running onto multiple pages. That syspref
says to truncate the print notice at that page length and put in a
The cron entry is gather\_print\_notices.pl /tmp/noticedir
-`Unable to Renew Items <#renewfaq>`__
+.. _unable-to-renew-items-label:
+
+Unable to Renew Items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: We're trying to renew some items for our patron. One of
the override renewal limit, it just returns a little message that says
"renewal failed". Any idea what's going on here?
-**Answer**: At the very least you will need to set an absolute `default
-circulation rule <#circfinerules>`__. This rule should be set for the
+**Answer**: At the very least you will need to set an absolute :ref:`default
+circulation rule <circulation-and-fine-rules-label>`. This rule should be set for the
default itemtype, default branchcode and default patron category. That
will catch anyone who doesn't match a specific rule. Patrons who do not
match a specific rule will get blocked from placing holds or renewing
items, since there was no baseline number of holds or renewals to
utilize.
-`Unable to Place Holds <#holdsfaq>`__
+.. _unable-to-place-holds-label:
+
+Unable to Place Holds
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Why can't I place holds when I have all of the preferences
branch, default item and default patron category then you may see
patrons getting blocked from placing holds.
-`Keyboard Shortcuts <#keyboardshort>`__
+.. _keyboard-shortcuts-label:
+
+Keyboard Shortcuts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Do I have to use my mouse to access the checkout, checkin
Mac users use the OPTION button in place of ALT
-`SMS Notices/Messages <#smsnoticefaq>`__
+.. _sms-notices/messages-label:
+
+SMS Notices/Messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: I want Koha to send notices via SMS, what do I need to do?
- Unicel Technologies Pvt Ltd (`unicel.in <http://unicel.in>`__)
-`Cataloging <#catfaq>`__
+.. _cataloging-label:
+
+Cataloging
------------------------
-`Authority Fields <#authorityfaq>`__
+.. _authority-fields-label:
+
+Authority Fields
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question:**\ Why can't I edit 1xx, 6xx, or 7xx fields in my catalog
record?
**Answer:** These fields are authority controlled and you probably have
-the `BiblioAddsAuthorities <#BiblioAddsAuthorities>`__ set to "Don't
+the :ref:`BiblioAddsAuthorities` set to "Don't
allow". When it is set to "Don't allow" these fields will be locked and
require you to search for an existing authority record to populate the
field with. To allow typing in these authority fields set
-`BiblioAddsAuthorities <#BiblioAddsAuthorities>`__ to 'Allow'.
+:ref:`BiblioAddsAuthorities` to 'Allow'.
**Note**
Fields affected by this preference show a lock in the field
|image1115|
-`Koha to MARC Mapping <#kohamarcfaq>`__
+.. _koha-to-marc-mapping-label:
+
+Koha to MARC Mapping
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What's the relationship between 'Koha to MARC Mapping' and
the two modules 'overwrite' each other in order to prevent conflicts
from existing in Koha).
-`Number of Items Per Bib Record <#itemsperbibfaq>`__
+.. _number-of-items-per-bib-record-label:
+
+Number of Items Per Bib Record
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Is there a limit on the number of items I can attach to a
standard, which breaks indexing for that record. I've found this occurs
somewhere between 600 and 1000 items on a 'normal' bibliographic record.
-`Analytics <#analyticsfaq>`__
+.. _analytics-label:
+
+Analytics
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: I am using the
-`EasyAnalyticalRecords <#EasyAnalyticalRecords>`__ feature, but my links
+:ref:`EasyAnalyticalRecords` feature, but my links
in the OPAC and Staff Client to 'Show Analytics' are not working.
**Answer**: If you plan on using
-`EasyAnalyticalRecords <#EasyAnalyticalRecords>`__ you will want to make
-sure to set your `UseControlNumber <#UseControlNumber>`__ preference to
+:ref:`EasyAnalyticalRecords` you will want to make
+sure to set your :ref:`UseControlNumber` preference to
"Don't use," this will prevent broken links.
-`Acquisitions <#acqfaq>`__
+.. _acquisitions-label:
+
+Acquisitions
--------------------------
-`Planning Categories <#planningcatfaq>`__
+.. _planning-categories-label:
+
+Planning Categories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What is a planning category?
acquired, at the end of the year, you'll be able to compare the goals
set, with what's been achieved.
-`Serials <#serialsfaq>`__
+.. _serials-label:
+
+Serials
-------------------------
-`Advanced Patterns <#advancedpatternfaq>`__
+.. _advanced-patterns-label:
+
+Advanced Patterns
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What is the 'inner counter' on the advanced serials
year, even if they are not received with Koha. If you begin with first
issue of the year write nothing or 0.
-`Reports <#reportsfaq>`__
+.. _reports-label:
+
+Reports
-------------------------
-`Define Codes Stored in DB <#accounttypefaq>`__
+.. _define-codes-stored-in-db-label:
+
+Define Codes Stored in DB
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Fines Table <#finescodefaq>`__
+.. _fines-table-label:
+
+Fines Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question:** What do the codes in the accounttype field in the
- W = Writeoff
-`Statistics Table <#statscodefaq>`__
+.. _statistics-table-label:
+
+Statistics Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question:**\ What are the possible codes for the type field in the
- The XXX stores different types of fee credits, so a query to catch
them all would include a clause like "type LIKE 'Credit%'"
-`Reserves Table <#rescodefaq>`__
+.. _reserves-table-label:
+
+Reserves Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the found field in the
- F = Finished: the reserve has been completed, and is done
-`Reports Dictionary Table <#reportdicfaq>`__
+.. _reports-dictionary-table-label:
+
+Reports Dictionary Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the area field in the
- 5 = Accounts
-`Messages Table <#msgtablefaq>`__
+.. _messages-table-label:
+
+Messages Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the message\_type field in
- B = For Patrons/Borrowers
-`Serial Table <#serialtablefaq>`__
+.. _serial-table-label:
+
+Serial Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the status field in the
- 44 = Missing (lost)
-`Borrowers Table <#borrowerprivacyvalues>`__
+.. _borrowers-table-label:
+
+Borrowers Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes for the privacy field in the
- 2 = Never
-`Messaging Preferences <#messpreffaq>`__
+.. _messaging-preferences-label:
+
+Messaging Preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What are the possible codes in the message\_attribute\_id
- 5 = item check in
-`Runtime Parameters <#runtimefaq>`__
+.. _runtime-parameters-label:
+
+Runtime Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Is there a way to filter my custom SQL reports before they
Branch pull down
|image1117|
-`Results Limited <#reportlimitfaq>`__
+.. _results-limited-label:
+
+Results Limited
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: When I download my report it's limited to 10,000 results,
entered in Koha. To get around this you want to add 'LIMIT 100000' to
the end of your SQL statement (or any other number above 10,000.
-`Searching <#searchfaq>`__
+.. _searching-label:
+
+Searching
--------------------------
-`Advanced Search <#advancedsearchfaq>`__
+.. _advanced-search-label:
+
+Advanced Search
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Scan Indexes <#scanindexfaq>`__
+.. _scan-indexes-label:
+
+Scan Indexes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: What does 'scan indexes' on the advanced search page mean?
It works only for one index at once, and only with no limit in Location
(All libraries needed)
-`Searching for Terms that Start With a Character <#searchstartswith>`__
+.. _searching-for-terms-that-start-with-a-character-label:
+
+Searching for Terms that Start With a Character
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: How do I search for all titles that start with the letter
- example: ti,first-in-subfield=C
-`Wildcard Searching <#wildcardsearchfaq>`__
+.. _wildcard-searching-label:
+
+Wildcard Searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**:What is the difference between a keyword search using the
The bottom line in searching with wildcards: '\*' is more exact while
'%' searches for like terms.
-`Title Searching <#titlesearchingfaq>`__
+.. _title-searching-label:
+
+Title Searching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Why does my Zebra title search for 'Help' not turn up 'The
common words, will always struggle a bit; it can't evaluate relevance
well, because you've not given it enough input.
-`Enhanced Content <#enhancedcontentfaq>`__
+.. _enhanced-content-label:
+
+Enhanced Content
------------------------------------------
-`FRBRizing Content <#frbrfaq>`__
+.. _frbrizing-content-label:
+
+FRBRizing Content
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question:**\ At our public library we are running a Koha installation
to be normalized. You could therefore use the script
misc/batchupdateISBNs.pl (it removes all the - in your local ISBNs)
-`Amazon <#amzfaq>`__
+.. _amazon-label:
+
+Amazon
~~~~~~~~~~~~~~~~~~~~
-`All Amazon Content <#amazonfaq>`__
+.. _all-amazon-content-label:
+
+All Amazon Content
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: I have all of the Amazon preferences turned on and have
On Debian the the command is *date -s "2010-06-30 17:21"* (with the
proper date and time for your timezone).
-`System Administration <#systemfaq>`__
+.. _system-administration-label:
+
+System Administration
--------------------------------------
-`Errors in Zebra Cron <#zebracronfaq>`__
+.. _errors-in-zebra-cron-label:
+
+Errors in Zebra Cron
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: I am noticing some errors in the
worked and were the default, I think it would help folks to avoid a
great deal of the problems that come up with zebra.
-`Making Z39.50 Target Public <#publicztarget>`__
+.. _making-z39.50-target-public-label:
+
+Making Z39.50 Target Public
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Could someone tell me the exact steps I need to take to
Then restart zebasrv and connect on the port specified (9999).
-`Shelving Location Authorized Values <#authvalfaq>`__
+.. _shelving-location-authorized-values-label:
+
+Shelving Location Authorized Values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: When editing an item, the new shelving location I created
value displays as null in the item editor (or MARC editor) instead of
the value the library meant it to be.
-`Why do I need Authorized Values? <#whyauthvals>`__
+.. _why-do-i-need-authorized-values?-label:
+
+Why do I need Authorized Values?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Why would I want to define authorized values for MARC
types and branch codes, and you can link these authorized values to
MARC subfields when you set up your MARC tag structure.
-`How do I clean up the sessions table? <#sessionstblfaq>`__
+.. _how-do-i-clean-up-the-sessions-table?-label:
+
+How do I clean up the sessions table?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: Is there a periodic job that can be run to cull old
sessions from the table? We don't want to backup all the useless session
data every night.
-**Answer**: You can run `cleanup database cron job <#cleandbcron>`__.
+**Answer**: You can run :ref:`cleanup database cron job <clean-up-database-label>`.
Or just before doing a backup command (mysqldump), you can truncate
session table:
mysql -u<kohauser -p<password <koha-db-name -e 'TRUNCATE TABLE sessions'
-`Hardware <#hardwarefaq>`__
+.. _hardware-label:
+
+Hardware
---------------------------
-`Barcode Scanners <#barcodefaq>`__
+.. _barcode-scanners-label:
+
+Barcode Scanners
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Question**: What barcode scanners have been known to work with Koha?
held like a pen. Think about the staff working with the hardware before
choosing, as a button in the wrong place can be very awkward to use.
-`Printers <#printersfaq>`__
+.. _printers-label:
+
+Printers
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-`Printers used by Koha libraries <#kohaprinters>`__
+.. _printers-used-by-koha-libraries-label:
+
+Printers used by Koha libraries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- POS-X receipt printer
- 1x1 labels using a Dymolabelwriter printer
-`Braille Support <#braillefaq>`__
+.. _braille-support-label:
+
+Braille Support
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Question**: Are there any braille embosser or printer which has
**Answer**: You may want to look into BRLTTY
(http://www.emptech.info/product_details.php?ID=1232).
-`Additional Support <#hardwaresupport>`__
+.. _additional-support-label:
+
+Additional Support
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/
Extending Koha
==============
-`Amazon lookup script for Koha libraries <#amzlookup>`__
+.. _amazon-lookup-script-for-koha-libraries-label:
+
+Amazon lookup script for Koha libraries
--------------------------------------------------------
We order most of our materials from Amazon, so I've been looking for a
order, on hold, etc.), ... just search the UserScripts site for Amazon +
library. For a later date!
-`Keyword Clouds <#extendkeywordclouds>`__
+.. _keyword-clouds-label:
+
+Keyword Clouds
-----------------------------------------
In addition to the traditional tag cloud available in Koha, there is a
way to generate clouds for popular subjects within Koha.
-The `Author/Subject Cloud cron job <#keywordclouds>`__ is used to help
+The :ref:`Author/Subject Cloud cron job <subject/author-clouds-label>` is used to help
with this process. This cron job sends its output to files.
- /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
all kind of subjects, classifications, etc. And since it works on zebra
indexes, it is quick, even on large DBs. Tags clouds are sent to files.
It's up to library webmaster to deal with those files in order to
-include them in `OPACMainUserBlock <#OpacMainUserBlock>`__, or include
+include them in :ref:`OPACMainUserBlock <opacmainuserblock-label>`, or include
them into their library CMS.
Some libraries even send the file into a Samba shared folder where
webmaster take them, eventually clean them a little bit before
integrating them into navigation widgets or pages.
-`Newest Titles Pulldown <#newtitlesoption>`__
+.. _newest-titles-pulldown-label:
+
+Newest Titles Pulldown
---------------------------------------------
Often we want to add a way for our patrons to do searches for the newest
OPAC <http://catalog.farmingtonlibraries.org>`__ has a few examples of
this on the left.
-`Cataloging and Searching by Color <#colorsearch>`__
+.. _cataloging-and-searching-by-color-label:
+
+Cataloging and Searching by Color
----------------------------------------------------
One of the icon sets installed in Koha includes a series of colors. This
lib_opac, imageurl) values ('CCODE','ffffff','White','','colors/ffffff.png');
If you would like to choose the colors manually you can do that via the
-`Authorized Values <#authorizedvalues>`__ administration area.
+:ref:`Authorized Values` administration area.
Colors for CCODE
|image1118|
-Next you'll want to `update the frameworks <#marcbibframeworks>`__ so
+Next you'll want to :ref:`update the frameworks <marc-bibliographic-frameworks-label>` so
that the 952$8 (if you're using collection code) label to says Color.
Once you have that in place you can start to catalog items by color.
Finally you'll want to add the following JQuery to your preferences so
that it will relabel 'Collection' to 'Color'
-`IntranetUserJS <#intranetuserjs>`__
+:ref:`IntranetUserJS`
::
$("#holdings th:contains('Collection')").text("Color");
});
-`OPACUserJS <#opacuserjs>`__
+:ref:`OPACUserJS`
::
This appendix will include tips for integrating Koha in to your library
website.
-`Koha search on your site <#embedsearch>`__
+.. _koha-search-on-your-site-label:
+
+Koha search on your site
-------------------------------------------
Often you'll want to add a Koha search box to your library website. To
projects / kohadocs.git / commitdiff