1 .. include:: images.rst
9 -----------------------------
11 For the Open Archives Initiative-Protocol for Metadata Harvesting
12 (OAI-PMH) there are two groups of 'participants': Data Providers and
13 Service Providers. Data Providers (open archives, repositories) provide
14 free access to metadata, and may, but do not necessarily, offer free
15 access to full texts or other resources. OAI-PMH provides an easy to
16 implement, low barrier solution for Data Providers. Service Providers
17 use the OAI interfaces of the Data Providers to harvest and store
18 metadata. Note that this means that there are no live search requests to
19 the Data Providers; rather, services are based on the harvested data via
22 Koha at present can only act as a Data Provider. It can not harvest from
23 other repositories. The biggest stumbling block to having Koha harvest
24 from other repositories is that MARC is the only metadata format that
25 Koha indexes natively. Visit
26 http://www.oaforum.org/tutorial/english/page3.htm for diagrams of how
29 Learn more about OAI-PMH at: http://www.openarchives.org/pmh/
31 To enable OAI-PMH in Koha edit the :ref:`OAI-PMH` preference.
32 Once enabled you can visit http://YOURKOHACATALOG/cgi-bin/koha/oai.pl to
35 .. _sample-oai-conf-file-label:
38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45 metadataNamespace: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs
46 schema: http://veryspecial.tamil.fr/vs/format-pivot/1.1/vs.xsd
47 xsl_file: /usr/local/koha/xslt/vs.xsl
49 metadataPrefix: marxml
50 metadataNamespace: http://www.loc.gov/MARC21/slim
51 http://www.loc.gov/standards/marcxml/schema/MARC21slim
52 schema: http://www.loc.gov/MARC21/slim
53 http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
55 metadataPrefix: oai_dc
56 metadataNamespace: http://www.openarchives.org/OAI/2.0/oai_dc/
57 schema: http://www.openarchives.org/OAI/2.0/oai_dc.xsd
59 /usr/local/koha/koha-tmpl/intranet-tmpl/xslt/UNIMARCslim2OAIDC.xsl
61 .. _rest-services-label:
64 ----------------------------------
66 Koha can now be requested by REST http requests. BibLibre wrotes an
67 external module to adds more possibilities than ILS-DI can provide.There
68 is no authentication process, but authorized ips are listed in the
69 config file. Services have been tested in 3.10, 3.12 and 3.14 koha
70 versions. You can find more information about it into README file and
71 opac/rest.pl documentation on http://git.biblibre.com. If you want to
72 add features, send us a patch at dev\_patches AT biblibre DOT com.
74 Services provided in 1.4 version are:
79 GET user/byid/:borrowernumber/holds
80 GET user/:user_name/holds
81 GET user/byid/:borrowernumber/issues
82 GET user/:user_name/issues
83 GET user/:user_name/issues_history
84 GET user/byid/:borrowernumber/issues_history
89 GET biblio/:biblionumber/items
90 GET biblio/:biblionumber/holdable
91 GET biblio/:biblionumber/items_holdable_status
92 GET item/:itemnumber/holdable
93 PUT auth/change_password
95 GET /suggestions/:suggestionid
97 PUT /suggestions/:suggestionid
98 DELETE /suggestions/:suggestionid
104 .. _using-the-sru-server-label:
107 ------------------------------------
109 Koha implements the Search/Retrieve via URL (SRU) protocol. More
110 information about the protocol itself can be found at
111 http://www.loc.gov/standards/sru/. The version implemented is version
117 ~~~~~~~~~~~~~~~~~~~~~~~~~~
119 If you want to have information about the implementation of SRU on a
120 given server, you should have access to the Explain file using a request
121 to the server without any parameter. Like
122 <http://myserver.com:9999/biblios/>. The response from the server is an
123 XML file that should look like the following and will give you
124 information about the default settings of the SRU server.
129 <zs:version>1.1</zs:version>
131 <zs:recordSchema>http://explain.z3950.org/dtd/2.0/</zs:recordSchema>
132 <zs:recordPacking>xml</zs:recordPacking>
134 <explain xml:base="zebradb/explain-biblios.xml">
136 try stylesheet url: http://./?stylesheet=docpath/sru2.xsl
138 <serverInfo protocol="SRW/SRU/Z39.50">
139 <host>biblibre</host>
141 <database>biblios</database>
144 <title lang="en" primary="true">Koha 3 Bibliographic SRU/SRW/Z39.50 server</title>
145 <description lang="en" primary="true">Koha 3 Bibliographic Server</description>
147 <sru>http://biblibre:9999</sru>
151 <set name="cql" identifier="info:srw/cql-context-set/1/cql-v1.1">
152 <title>CQL Standard Set</title>
154 <index search="true" scan="true" sort="false">
155 <title lang="en">CQL Server Choice</title>
157 <name set="cql">serverChoice</name>
160 <attr type="1" set="bib1">text</attr>
163 <index search="true" scan="true" sort="false">
164 <title lang="en">CQL All</title>
166 <name set="cql">all</name>
169 <attr type="1" set="bib1">text</attr>
172 <!-- Record ID index -->
173 <index search="true" scan="true" sort="false">
174 <title lang="en">Record ID</title>
176 <name set="rec">id</name>
179 <attr type="1" set="bib1">rec:id</attr>
180 <attr type="4" set="bib1">3</attr>
188 ~~~~~~~~~~~~~~~~~~~~~~~~
191 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs
192 is composed of the following elements:
194 - base url of the SRU server : http://myserver.com:9999/biblios?
196 - search part with the 3 required parameters : version, operation and
197 query. The parameters within the search part should be of the
198 key=value form, and can be combined with the & character.
200 One can add optional parameters to the query, for instance
201 maximumRecords indicating the maximum number of records to be returned
203 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=reefs&maximumRecords=5
204 will only get the first 5 results results from the server.
206 http://www.loc.gov/standards/sru/sru1-1archive/search-retrieve-operation.html
207 gives more details about the search operations and in particular the
208 list of optional parameters for searching.
210 .. _more-details-about-search-label:
212 More details about Search
213 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
215 The "operation" key can take two values: scan or searchRetrieve.
217 If operation=searchRetrieve, then the search key should be query. As in
218 : operation=searchRetrieve&query=reefs
220 If operation=scan, then the search key should be scanClause. As in :
221 operation=scan&scanClause=reefs
223 etc/zebradb/biblios/etc/bib1.att defines Zebra/3950 indexes that exist
224 on your system. For instance you'll see that we have indexes for Subject
225 and for Title: att 21 Subject and att 4 Title respectively.
227 In the pqf.properties file located under etc/zebradb/pqf.properties I
228 see that an access point already uses my Subject index (index.dc.subject
229 = 1=21) while another uses my Title index (index.dc.title = 1=4) I know
230 this is my Subject index because as I've seen just before in my bib1.att
231 file, it's called with =1=21 in Z3950: so index.dc.subject = 1=21
232 correctly points to my Subject index. And Title was called with 1=4 so
233 index.dc.title = 1=4 correctly points to my Title index. I can now
234 construct my query just like I would in a search box, just preceding it
235 with the "query" key: query=Subject=reefs and Title=coral searches
236 "reefs" in the subject and "coral" in the title. The full url would be
237 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
238 and Title=coral If I want to limit the result set to just 5 records, I
240 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Subject=reefs
241 and Title=coral&maximumRecords=5
243 I can also play with truncate, relations, etc. Those are also defined in
244 my pqf.properties file. I can see for instance the position properties
249 position.first = 3=1 6=1
251 position.any = 3=3 6=1
252 # "any position in field"
255 So as an example if I want "coral" to be at the beginning of the title,
256 I can do this query :
257 http://myserver.com:9999/biblios?version=1.1&operation=searchRetrieve&query=Title=coral
263 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
266 http://univ\_lyon3.biblibre.com:9999/biblios?version=1.1&operation=searchRetrieve&query=coral
267 reefs&maximumRecords=1 retrieves just on record. The response looks like
272 <zs:searchRetrieveResponse>
273 <zs:version>1.1</zs:version>
274 <zs:numberOfRecords>1</zs:numberOfRecords>
277 <zs:recordPacking>xml</zs:recordPacking>
279 <record xsi:schemaLocation="http://www.loc.gov/MARC21/slim http://www.loc.gov/ standards/marcxml/schema/MARC21slim.xsd">
280 <leader> cam a22 4500</leader>
281 <datafield tag="010" ind1=" " ind2=" ">
282 <subfield code="a">2-603-01193-6</subfield>
283 <subfield code="b">rel.</subfield>
284 <subfield code="d">159 F</subfield>
286 <datafield tag="020" ind1=" " ind2=" ">
287 <subfield code="a">FR</subfield>
288 <subfield code="b">00065351</subfield>
290 <datafield tag="101" ind1="1" ind2=" ">
291 <subfield code="c">ita</subfield>
293 <datafield tag="105" ind1=" " ind2=" ">
294 <subfield code="a">a z 00|y|</subfield>
296 <datafield tag="106" ind1=" " ind2=" ">
297 <subfield code="a">r</subfield>
299 <datafield tag="100" ind1=" " ind2=" ">
300 <subfield code="a">20091130 frey50 </subfield>
302 <datafield tag="200" ind1="1" ind2=" ">
303 <subfield code="a">Guide des récifs coralliens / A Guide to Coral Reefs</subfield>
304 <subfield code="b">Texte imprimé</subfield>
305 <subfield code="e">la faune sous-marine des coraux</subfield>
306 <subfield code="f">A. et A. Ferrari</subfield>
308 <datafield tag="210" ind1=" " ind2=" ">
309 <subfield code="a">Lausanne</subfield>
310 <subfield code="a">Paris</subfield>
311 <subfield code="c">Delachaux et Niestlé</subfield>
312 <subfield code="d">cop. 2000</subfield>
313 <subfield code="e">impr. en Espagne</subfield>
315 <datafield tag="215" ind1=" " ind2=" ">
316 <subfield code="a">287 p.</subfield>
317 <subfield code="c">ill. en coul., couv. ill. en coul.</subfield>
318 <subfield code="d">20 cm</subfield>
323 <localnumber>2</localnumber>
324 <filename>/tmp/nw10BJv9Pk/upd_biblio/exported_records</filename>
328 <zs:recordPosition>1</zs:recordPosition>
331 </zs:searchRetrieveResponse>
335 New titles slider for OPAC
336 ==========================
338 Often times libraries will want to add a flowing widget with new
339 materials at the library to their main public catalog page. To do this
340 you can use a widget from any number of services (usually for a cost) or
341 you can `enable plugins <#pluginsystem>`__ in Koha and use the `Cover
343 plugin <http://git.bywatersolutions.com/koha-plugins.git/shortlog/refs/heads/cover_flow>`__
344 which is based on the
345 `Flipster <https://github.com/drien/jquery-flipster>`__, a responsive
346 jQuery coverflow plugin.
348 Once the plugin is installed, the steps to get your coverflow to show up
351 First, you need to create one or more public reports for your coverflow
352 widget or widgets to be based on. This is how the plugin knows what the
353 content of your widget should contain. Each report needs only three
354 columns; title, biblionumber, and isbn. It is important that you have a
355 good and valid isbn, as that is the datum used to actually fetch the
356 cover. In the iteration of the plugin, we are using Amazon cover images,
357 but I believe in the end I will make the cover image fetcher
358 configurable so we can use any data source for cover image fetching.
360 Second, we need to configure the plugin. The plugin configuration is a
361 single text area that uses YAML ( actually, it’s JSON, whcih is a subset
362 of YAML ) to store the configuration options. In this example it looks
372 In this example, we are telling the plugin to use the report with id 42,
373 and use it to create a coverflow widget to replace the HTML element with
374 the id “coverflow”. The options list is passed directly to Flipster, so
375 any options supported by Flipster can be set from the plugin
376 configuration! In fact, in addition to the traditional coverflow,
377 Flipster has a “carousel” mode which is a much more compact version of
378 the coverflow. You can also configure which cover the widget will start
379 on, among other options.
381 At the time the plugins options are saved or updated, the plugin will
382 then generate some minified JavaScript code that is automatically stored
383 in the Koha system preference OPACUserJS. Here is an example of the
388 /* JS for Koha CoverFlow Plugin
389 This JS was added automatically by installing the CoverFlow plugin
390 Please do not modify */$(document).ready(function(){$.getScript("/plugin/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/jquery-flipster/src/js/jquery.flipster.min.js",function(data,textStatus,jqxhr){$("head").append("<link id='flipster-css' href='/plugin/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/jquery-flipster/src/css/jquery.flipster.min.css' type='text/css' rel='stylesheet' />");$('#coverflow').load("/coverflow.pl?id=42",function(){var opt={'items':'.item','minfactor':15,'distribution':1.5,'scalethreshold':0,'staticbelowthreshold':false,'titleclass':'itemTitle','selectedclass':'selectedItem','scrollactive':true,'step':{'limit':4,'width':10,'scale':true}};$('#coverflow').flipster({style:'coverflow',});});});});
391 /* End of JS for Koha CoverFlow Plugin */
393 Why do this? For speed! Rather than regenerating this code each and
394 every time the page loads, we can generate it once, and use it over and
397 If you inspect the code closely, you’ll notice it references a script
398 “coverflow.pl”. This is a script that is included with the coverflow
399 plugin. Since we need to access this from the OPAC ( and we don’t want
400 to set off any XSS attack alarms ), we need to modify the web server
401 configuration for the public catalog and add the followup to it:
405 ScriptAlias /coverflow.pl "/var/lib/koha/mykoha/plugins/Koha/Plugin/Com/ByWaterSolutions/CoverFlow/coverflow.pl"
407 This line gives us access to the coverflow.pl script from the OPAC. This
408 script retrieves the report data and passes it back to the public
409 catalog for creating the coverflow widget. Koha::Cache is supported in
410 order to make the widget load as quickly as possible!
412 The final step is to put your selector element somewhere in your public
413 catalog. In this example, I put the following in the system preference
418 <span id="coverflow">Loading...</span>
420 Once that is in place, you need only refresh your OPAC page, and there
421 you have it, your very own catalog coverflow widget! Not only do these
422 coverflows look great on a computer screen, but they look great on
423 mobile platforms as well, and are even touch responsive!
427 System Preference Defaults
428 ==========================
430 .. _isbd-defaults-label:
433 ---------------------------------
435 Default values for the :ref:`ISBD` preference.
437 .. _marc-default-label:
440 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
442 #100\|\|{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{ 110d
443 }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h }{ 130k
444 }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{ 130t
447 #245\|\|{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{ 245s }{
450 #246\|\|{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p }{ 246h
453 #242\|\|{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }\|
459 #250\| - \|{ 250a }{ 250b }\|
463 #255\|, \|{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{ 255f }{ 255g }\|
469 #258\|, \|{ 258a }{ 258b }\|
471 #260\| - \|{ 260a }{ 260b }{ 260c }\|
473 #300\| - \|{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g }\|
475 #306\| - \|{ 306a }\|
477 #307\| - \|{ 307a }{ 307b }\|
479 #310\| - \|{ 310a }{ 310b }\|
481 #321\| - \|{ 321a }{ 321b }\|
483 #340\| - \|{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f }{
486 #342\| - \|{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g }{
487 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{ 342p }{
488 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }\|
490 #343\| - \|{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g }{
493 #351\| - \|{ 3513 }{ 351a }{ 351b }{ 351c }\|
495 #352\| - \|{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g }{
498 #362\| - \|{ 362a }{ 351z }\|
500 #440\| - \|{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }\|.
502 #490\| - \|{ 490a }{ 490v }{ 490x }\|.
504 #800\| - \|{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g }{
505 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{ 800q }{
506 800r }{ 800s }{ 800t }{ 800u }{ 800v }\|.
508 #810\| - \|{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g }{
509 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{ 810s }{
510 810t }{ 810u }{ 810v }\|.
512 #811\| - \|{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h }{
513 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{ 811v
516 #830\| - \|{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l }{
517 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v }\|.
519 #500\|<br/><br/>\|{ 5003 }{ 500a }\|
521 #501\|<br/><br/>\|{ 501a }\|
523 #502\|<br/><br/>\|{ 502a }\|
525 #504\|<br/><br/>\|{ 504a }\|
527 #505\|<br/><br/>\|{ 505a }{ 505t }{ 505r }{ 505g }{ 505u }\|
529 #506\|<br/><br/>\|{ 5063 }{ 506a }{ 506b }{ 506c }{ 506d }{ 506u }\|
531 #507\|<br/><br/>\|{ 507a }{ 507b }\|
533 #508\|<br/><br/>\|{ 508a }{ 508a }\|
535 #510\|<br/><br/>\|{ 5103 }{ 510a }{ 510x }{ 510c }{ 510b }\|
537 #511\|<br/><br/>\|{ 511a }\|
539 #513\|<br/><br/>\|{ 513a }{513b }\|
541 #514\|<br/><br/>\|{ 514z }{ 514a }{ 514b }{ 514c }{ 514d }{ 514e }{ 514f
542 }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m }{ 514u }\|
544 #515\|<br/><br/>\|{ 515a }\|
546 #516\|<br/><br/>\|{ 516a }\|
548 #518\|<br/><br/>\|{ 5183 }{ 518a }\|
550 #520\|<br/><br/>\|{ 5203 }{ 520a }{ 520b }{ 520u }\|
552 #521\|<br/><br/>\|{ 5213 }{ 521a }{ 521b }\|
554 #522\|<br/><br/>\|{ 522a }\|
556 #524\|<br/><br/>\|{ 524a }\|
558 #525\|<br/><br/>\|{ 525a }\|
560 #526\|<br/><br/>\|{\\n510i }{\\n510a }{ 510b }{ 510c }{ 510d }{\\n510x
563 #530\|<br/><br/>\|{\\n5063 }{\\n506a }{ 506b }{ 506c }{ 506d }{\\n506u
566 #533\|<br/><br/>\|{\\n5333 }{\\n533a }{\\n533b }{\\n533c }{\\n533d
567 }{\\n533e }{\\n533f }{\\n533m }{\\n533n }\|
569 #534\|<br/><br/>\|{\\n533p }{\\n533a }{\\n533b }{\\n533c }{\\n533d
570 }{\\n533e }{\\n533f }{\\n533m }{\\n533n }{\\n533t }{\\n533x }{\\n533z
573 #535\|<br/><br/>\|{\\n5353 }{\\n535a }{\\n535b }{\\n535c }{\\n535d }\|
575 #538\|<br/><br/>\|{\\n5383 }{\\n538a }{\\n538i }{\\n538u }\|
577 #540\|<br/><br/>\|{\\n5403 }{\\n540a }{ 540b }{ 540c }{ 540d }{\\n520u
580 #544\|<br/><br/>\|{\\n5443 }{\\n544a }{\\n544b }{\\n544c }{\\n544d
581 }{\\n544e }{\\n544n }\|
583 #545\|<br/><br/>\|{\\n545a }{ 545b }{\\n545u }\|
585 #546\|<br/><br/>\|{\\n5463 }{\\n546a }{ 546b }\|
587 #547\|<br/><br/>\|{\\n547a }\|
589 #550\|<br/><br/>\|{ 550a }\|
591 #552\|<br/><br/>\|{ 552z }{ 552a }{ 552b }{ 552c }{ 552d }{ 552e }{ 552f
592 }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l }{ 552m }{ 552n }{ 562o
595 #555\|<br/><br/>\|{ 5553 }{ 555a }{ 555b }{ 555c }{ 555d }{ 555u }\|
597 #556\|<br/><br/>\|{ 556a }{ 506z }\|
599 #563\|<br/><br/>\|{ 5633 }{ 563a }{ 563u }\|
601 #565\|<br/><br/>\|{ 5653 }{ 565a }{ 565b }{ 565c }{ 565d }{ 565e }\|
603 #567\|<br/><br/>\|{ 567a }\|
605 #580\|<br/><br/>\|{ 580a }\|
607 #581\|<br/><br/>\|{ 5633 }{ 581a }{ 581z }\|
609 #584\|<br/><br/>\|{ 5843 }{ 584a }{ 584b }\|
611 #585\|<br/><br/>\|{ 5853 }{ 585a }\|
613 #586\|<br/><br/>\|{ 5863 }{ 586a }\|
615 #020\|<br/><br/><label>ISBN: </label>\|{ 020a }{ 020c }\|
617 #022\|<br/><br/><label>ISSN: </label>\|{ 022a }\|
619 #222\| = \|{ 222a }{ 222b }\|
621 #210\| = \|{ 210a }{ 210b }\|
623 #024\|<br/><br/><label>Standard No.: </label>\|{ 024a }{ 024c }{ 024d }{
626 #027\|<br/><br/><label>Standard Tech. Report. No.: </label>\|{ 027a }\|
628 #028\|<br/><br/><label>Publisher. No.: </label>\|{ 028a }{ 028b }\|
630 #013\|<br/><br/><label>Patent No.: </label>\|{ 013a }{ 013b }{ 013c }{
631 013d }{ 013e }{ 013f }\|
633 #030\|<br/><br/><label>CODEN: </label>\|{ 030a }\|
635 #037\|<br/><br/><label>Source: </label>\|{ 037a }{ 037b }{ 037c }{ 037f
638 #010\|<br/><br/><label>LCCN: </label>\|{ 010a }\|
640 #015\|<br/><br/><label>Nat. Bib. No.: </label>\|{ 015a }{ 0152 }\|
642 #016\|<br/><br/><label>Nat. Bib. Agency Control No.: </label>\|{ 016a }{
645 #600\|<br/><br/><label>Subjects--Personal Names: </label>\|{\\n6003
646 }{\\n600a}{ 600b }{ 600c }{ 600d }{ 600e }{ 600f }{ 600g }{ 600h
647 }{--600k}{ 600l }{ 600m }{ 600n }{ 600o }{--600p}{ 600r }{ 600s }{ 600t
648 }{ 600u }{--600x}{--600z}{--600y}{--600v}\|
650 #610\|<br/><br/><label>Subjects--Corporate Names: </label>\|{\\n6103
651 }{\\n610a}{ 610b }{ 610c }{ 610d }{ 610e }{ 610f }{ 610g }{ 610h
652 }{--610k}{ 610l }{ 610m }{ 610n }{ 610o }{--610p}{ 610r }{ 610s }{ 610t
653 }{ 610u }{--610x}{--610z}{--610y}{--610v}\|
655 #611\|<br/><br/><label>Subjects--Meeting Names: </label>\|{\\n6113
656 }{\\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f }{ 611g }{ 611h
657 }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{ 611r }{ 611s }{ 611t
658 }{ 611u }{--611x}{--611z}{--611y}{--611v}\|
660 #630\|<br/><br/><label>Subjects--Uniform Titles: </label>\|{\\n630a}{
661 630b }{ 630c }{ 630d }{ 630e }{ 630f }{ 630g }{ 630h }{--630k }{ 630l }{
662 630m }{ 630n }{ 630o }{--630p}{ 630r }{ 630s }{ 630t
663 }{--630x}{--630z}{--630y}{--630v}\|
665 #648\|<br/><br/><label>Subjects--Chronological Terms: </label>\|{\\n6483
666 }{\\n648a }{--648x}{--648z}{--648y}{--648v}\|
668 #650\|<br/><br/><label>Subjects--Topical Terms: </label>\|{\\n6503
669 }{\\n650a}{ 650b }{ 650c }{ 650d }{ 650e
670 }{--650x}{--650z}{--650y}{--650v}\|
672 #651\|<br/><br/><label>Subjects--Geographic Terms: </label>\|{\\n6513
673 }{\\n651a}{ 651b }{ 651c }{ 651d }{ 651e
674 }{--651x}{--651z}{--651y}{--651v}\|
676 #653\|<br/><br/><label>Subjects--Index Terms: </label>\|{ 653a }\|
678 #654\|<br/><br/><label>Subjects--Facted Index Terms: </label>\|{\\n6543
679 }{\\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}\|
681 #655\|<br/><br/><label>Index Terms--Genre/Form: </label>\|{\\n6553
682 }{\\n655a}{--655b}{--655x }{--655z}{--655y}{--655v}\|
684 #656\|<br/><br/><label>Index Terms--Occupation: </label>\|{\\n6563
685 }{\\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}\|
687 #657\|<br/><br/><label>Index Terms--Function: </label>\|{\\n6573
688 }{\\n657a}{--657x}{--657z}{--657y}{--657v}\|
690 #658\|<br/><br/><label>Index Terms--Curriculum Objective:
691 </label>\|{\\n658a}{--658b}{--658c}{--658d}{--658v}\|
693 #050\|<br/><br/><label>LC Class. No.: </label>\|{ 050a }{ / 050b }\|
695 #082\|<br/><br/><label>Dewey Class. No.: </label>\|{ 082a }{ / 082b }\|
697 #080\|<br/><br/><label>Universal Decimal Class. No.: </label>\|{ 080a }{
700 #070\|<br/><br/><label>National Agricultural Library Call No.:
701 </label>\|{ 070a }{ / 070b }\|
703 #060\|<br/><br/><label>National Library of Medicine Call No.:
704 </label>\|{ 060a }{ / 060b }\|
706 #074\|<br/><br/><label>GPO Item No.: </label>\|{ 074a }\|
708 #086\|<br/><br/><label>Gov. Doc. Class. No.: </label>\|{ 086a }\|
710 #088\|<br/><br/><label>Report. No.: </label>\|{ 088a }\|
712 .. _unimarc-default-label:
715 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
717 #200\|<h2>Title : \|{200a}{. 200c}{ : 200e}{200d}{. 200h}{. 200i}\|</h2>
719 #461\|<label class="ipt">A part of : </label>\|<a
720 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search{&q=461t&idx=ti}">{461t}</a>{N∞
721 461h} {v. 461v}{(461d)}<br/>\|
723 #200b\|<label class="ipt">Material Designation : </label>\| {200b
726 #101a\|<label class="ipt">Language(s): </label>\|<a
727 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search{&q=101a&idx=ln}">{101a}</a>\|<br/>
729 #200f\|<label class="ipt">Authors : </label>\|<a
730 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search{&q=200f&idx=au}">{200f
733 #200g\|<label class="ipt">Co-authors : </label>\|<a
734 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search{&q=200g&idx=au}">{200g
737 #210a\|<br/><label class="ipt">Place of pubblication : </label>\|<a
738 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search&idx=pl&q={210a}">{210a}</a>\|<br/>
740 #210c\|<label class="ipt">Publisher : </label>\|<a
741 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search&idx=pb&q={210c}">{210c
744 #210d\|<label class="ipt">Date of pubblication : </label>\|{
747 #215\|<label class="ipt">Description : </label>\|{215a}{ : 215c}{ ;
748 215d}{ + 215e}\|<br/>
750 #225a\|<label class="ipt">Series :</label>\|<a
751 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search{&q=225a&idx=se}">{225a
754 #225\|\|{ = 225d}{ : 225e}{. 225h}{. 225i}{ / 225f}{, 225x}{ ;
757 #686\|<label>Classification : </label>\|{ 686a }\|<br/>
759 #608\|<label>Form, Genre : </label>\|<a
760 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search&idx=su&q={608a}"><img
761 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
762 title="Search on {608a}">{ 608a}</a>\|<br/><br/>
764 #200\|\|<label class="ipt">Subjects : </label><br/>\|<ul>
766 #600\|<label class="ipt">Person(s) </label><br/> \|<li><a
767 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search&idx=su&q={600a}"><img
768 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
769 title="Search on {600a}">{ 600a}</a></li>\|<br/>
771 #601\|<label class="ipt">Organisation(s) </label><br/>\|<li><a
772 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search&idx=su&q={601a}"><img
773 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
774 title="Search on {601a}">{ 601a}</a></li>\|<br/>
776 #606\|<label class="ipt">Term(s) </label><br/>\|<li><a
777 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search&idx=su&q={606a}"><img
778 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
779 title="Search on {606a}">{ 606a}</a></li>\|<br/>
781 #607\|<label class="ipt">Place(s) </label><br/>\|<li><a
782 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search&idx=su&q={607a}"><img
783 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
784 title="Search on {607a}">{ 607a}</a></li>\|<br/>
786 #610\|<label>Keywords</label><br/>\|<li><a
787 href="/cgi-bin/koha/catalogue/search.pl?op=do\_search&idx=su&q={610a}"><img
788 border="0" src="/opac-tmpl/css/en/images/filefind.png" height="15"
789 title="Search on {610a}">{ 610a}</a></li>\|
793 #856\|<label class="ipt">Electronic resource : </label>\|<a
794 href="{856u}">click here</a> to go to the external resource<br/>
796 #010\|<label class="ipt">ISBN : </label>\|{010a ;}\|<br/>
798 #011\|<label class="ipt">ISSN : </label>\|{011a ;}\|<br/>
800 #200\|\|<label class="ipt">Notes : </label>\|<br/><ul>
802 #300\|\|<li>{300a}</li>\|
804 #307\|\|<li>{307a}</li>\|
806 #310\|\|<li>{310a}</li>\|
808 #326\|\|<li>{326a}</li>\|
810 #327\|\|<li>{327a}</li>\|
812 #333\|<li>Public : \|{333a}</li>\|
816 #330\|\|<label class="ipt">Abstract : </label>\|<br/>
818 #330\|\|{330a}\|<br/>
820 #200\|\|<br/><h2>Items</h2>\|
822 #200\|<table>\|<th>Call number</th><th>Copy
823 note</th><th>Fonds</th><th>Genre detail</th><th>Circulation
824 type</th><th>Barcode</th>\|
826 #995\|\|<tr><td> {995k}</td><td> {995u}</td><td>
827 {995y}</td><td>{995e} </td><td>
828 {995o}</td><td>{995f}</td></tr>\|</table>
830 .. _opacisbd-defaults-label:
833 -----------------------------------------
835 Default values for the :ref:`OPACISBD` preference.
840 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
842 #100\|\|{ 100a }{ 100b }{ 100c }{ 100d }{ 110a }{ 110b }{ 110c }{ 110d
843 }{ 110e }{ 110f }{ 110g }{ 130a }{ 130d }{ 130f }{ 130g }{ 130h }{ 130k
844 }{ 130l }{ 130m }{ 130n }{ 130o }{ 130p }{ 130r }{ 130s }{ 130t
847 #245\|\|{ 245a }{ 245b }{245f }{ 245g }{ 245k }{ 245n }{ 245p }{ 245s }{
850 #246\|\|{ : 246i }{ 246a }{ 246b }{ 246f }{ 246g }{ 246n }{ 246p }{ 246h
853 #242\|\|{ = 242a }{ 242b }{ 242n }{ 242p }{ 242h }\|
859 #250\| - \|{ 250a }{ 250b }\|
861 #254\|, \|{ 254a }\| #255\|, \|{ 255a }{ 255b }{ 255c }{ 255d }{ 255e }{
862 255f }{ 255g }\| #256\|, \|{ 256a }\|
866 #258\|, \|{ 258a }{ 258b }\|
868 #260\| - \|{ 260a }{ 260b }{ 260c }\|
870 #300\| - \|{ 300a }{ 300b }{ 300c }{ 300d }{ 300e }{ 300f }{ 300g }\|
872 #306\| - \|{ 306a }\| #307\| - \|{ 307a }{ 307b }\|
874 #310\| - \|{ 310a }{ 310b }\|
876 #321\| - \|{ 321a }{ 321b }\|
878 #340\| - \|{ 3403 }{ 340a }{ 340b }{ 340c }{ 340d }{ 340e }{ 340f }{
881 #342\| - \|{ 342a }{ 342b }{ 342c }{ 342d }{ 342e }{ 342f }{ 342g }{
882 342h }{ 342i }{ 342j }{ 342k }{ 342l }{ 342m }{ 342n }{ 342o }{ 342p }{
883 342q }{ 342r }{ 342s }{ 342t }{ 342u }{ 342v }{ 342w }\|
885 #343\| - \|{ 343a }{ 343b }{ 343c }{ 343d }{ 343e }{ 343f }{ 343g }{
888 #351\| - \|{ 3513 }{ 351a }{ 351b }{ 351c }\|
890 #352\| - \|{ 352a }{ 352b }{ 352c }{ 352d }{ 352e }{ 352f }{ 352g }{
893 #362\| - \|{ 362a }{ 351z }\|
895 #440\| - \|{ 440a }{ 440n }{ 440p }{ 440v }{ 440x }\|. #490\| - \|{ 490a
898 #800\| - \|{ 800a }{ 800b }{ 800c }{ 800d }{ 800e }{ 800f }{ 800g }{
899 800h }{ 800j }{ 800k }{ 800l }{ 800m }{ 800n }{ 800o }{ 800p }{ 800q }{
900 800r }{ 800s }{ 800t }{ 800u }{ 800v }\|.
902 #810\| - \|{ 810a }{ 810b }{ 810c }{ 810d }{ 810e }{ 810f }{ 810g }{
903 810h }{ 810k }{ 810l }{ 810m }{ 810n }{ 810o }{ 810p }{ 810r }{ 810s }{
904 810t }{ 810u }{ 810v }\|.
906 #811\| - \|{ 811a }{ 811c }{ 811d }{ 811e }{ 811f }{ 811g }{ 811h }{
907 811k }{ 811l }{ 811n }{ 811p }{ 811q }{ 811s }{ 811t }{ 811u }{ 811v
910 #830\| - \|{ 830a }{ 830d }{ 830f }{ 830g }{ 830h }{ 830k }{ 830l }{
911 830m }{ 830n }{ 830o }{ 830p }{ 830r }{ 830s }{ 830t }{ 830v }\|.
913 #500\|<br/><br/>\|{ 5003 }{ 500a }\|
915 #501\|<br/><br/>\|{ 501a }\|
917 #502\|<br/><br/>\|{ 502a }\|
919 #504\|<br/><br/>\|{ 504a }\|
921 #505\|<br/><br/>\|{ 505a }{ 505t }{ 505r }{ 505g }{ 505u }\|
923 #506\|<br/><br/>\|{ 5063 }{ 506a }{ 506b }{ 506c }{ 506d }{ 506u }\|
925 #507\|<br/><br/>\|{ 507a }{ 507b }\| #508\|<br/><br/>\|{ 508a }{ 508a
928 #510\|<br/><br/>\|{ 5103 }{ 510a }{ 510x }{ 510c }{ 510b }\|
930 #511\|<br/><br/>\|{ 511a }\|
932 #513\|<br/><br/>\|{ 513a }{513b }\|
934 #514\|<br/><br/>\|{ 514z }{ 514a }{ 514b }{ 514c }{ 514d }{ 514e }{ 514f
935 }{ 514g }{ 514h }{ 514i }{ 514j }{ 514k }{ 514m }{ 514u }\|
937 #515\|<br/><br/>\|{ 515a }\|
939 #516\|<br/><br/>\|{ 516a }\|
941 #518\|<br/><br/>\|{ 5183 }{ 518a }\|
943 #520\|<br/><br/>\|{ 5203 }{ 520a }{ 520b }{ 520u }\|
945 #521\|<br/><br/>\|{ 5213 }{ 521a }{ 521b }\|
947 #522\|<br/><br/>\|{ 522a }\|
949 #524\|<br/><br/>\|{ 524a }\|
951 #525\|<br/><br/>\|{ 525a }\|
953 #526\|<br/><br/>\|{\\n510i }{\\n510a }{ 510b }{ 510c }{ 510d }{\\n510x
956 #530\|<br/><br/>\|{\\n5063 }{\\n506a }{ 506b }{ 506c }{ 506d }{\\n506u
959 #533\|<br/><br/>\|{\\n5333 }{\\n533a }{\\n533b }{\\n533c }{\\n533d
960 }{\\n533e }{\\n533f }{\\n533m }{\\n533n }\|
962 #534\|<br/><br/>\|{\\n533p }{\\n533a }{\\n533b }{\\n533c }{\\n533d
963 }{\\n533e }{\\n533f }{\\n533m }{\\n533n }{\\n533t }{\\n533x }{\\n533z
966 #535\|<br/><br/>\|{\\n5353 }{\\n535a }{\\n535b }{\\n535c }{\\n535d }\|
968 #538\|<br/><br/>\|{\\n5383 }{\\n538a }{\\n538i }{\\n538u }\|
970 #540\|<br/><br/>\|{\\n5403 }{\\n540a }{ 540b }{ 540c }{ 540d }{\\n520u
973 #544\|<br/><br/>\|{\\n5443 }{\\n544a }{\\n544b }{\\n544c }{\\n544d
974 }{\\n544e }{\\n544n }\|
976 #545\|<br/><br/>\|{\\n545a }{ 545b }{\\n545u }\|
977 #546\|<br/><br/>\|{\\n5463 }{\\n546a }{ 546b }\|
979 #547\|<br/><br/>\|{\\n547a }\| #550\|<br/><br/>\|{ 550a }\|
981 #552\|<br/><br/>\|{ 552z }{ 552a }{ 552b }{ 552c }{ 552d }{ 552e }{ 552f
982 }{ 552g }{ 552h }{ 552i }{ 552j }{ 552k }{ 552l }{ 552m }{ 552n }{ 562o
985 #555\|<br/><br/>\|{ 5553 }{ 555a }{ 555b }{ 555c }{ 555d }{ 555u }\|
987 #556\|<br/><br/>\|{ 556a }{ 506z }\| #563\|<br/><br/>\|{ 5633 }{ 563a }{
990 #565\|<br/><br/>\|{ 5653 }{ 565a }{ 565b }{ 565c }{ 565d }{ 565e }\|
992 #567\|<br/><br/>\|{ 567a }\|
994 #580\|<br/><br/>\|{ 580a }\|
996 #581\|<br/><br/>\|{ 5633 }{ 581a }{ 581z }\|
998 #584\|<br/><br/>\|{ 5843 }{ 584a }{ 584b }\|
1000 #585\|<br/><br/>\|{ 5853 }{ 585a }\|
1002 #586\|<br/><br/>\|{ 5863 }{ 586a }\|
1004 #020\|<br/><br/><label>ISBN: </label>\|{ 020a }{ 020c }\|
1006 #022\|<br/><br/><label>ISSN: </label>\|{ 022a }\|
1008 #222\| = \|{ 222a }{ 222b }\|
1010 #210\| = \|{ 210a }{ 210b }\|
1012 #024\|<br/><br/><label>Standard No.: </label>\|{ 024a }{ 024c }{ 024d }{
1015 #027\|<br/><br/><label>Standard Tech. Report. No.: </label>\|{ 027a }\|
1017 #028\|<br/><br/><label>Publisher. No.: </label>\|{ 028a }{ 028b }\|
1019 #013\|<br/><br/><label>Patent No.: </label>\|{ 013a }{ 013b }{ 013c }{
1020 013d }{ 013e }{ 013f }\|
1022 #030\|<br/><br/><label>CODEN: </label>\|{ 030a }\|
1024 #037\|<br/><br/><label>Source: </label>\|{ 037a }{ 037b }{ 037c }{ 037f
1027 #010\|<br/><br/><label>LCCN: </label>\|{ 010a }\|
1029 #015\|<br/><br/><label>Nat. Bib. No.: </label>\|{ 015a }{ 0152 }\|
1031 #016\|<br/><br/><label>Nat. Bib. Agency Control No.: </label>\|{ 016a }{
1034 #600\|<br/><br/><label>Subjects--Personal Names: </label>\|{\\n6003
1035 }{\\n600a}{ 600b }{ 600c }{ 600d }{ 600e }{ 600f }{ 600g }{ 600h
1036 }{--600k}{ 600l }{ 600m }{ 600n }{ 600o }{--600p}{ 600r }{ 600s }{ 600t
1037 }{ 600u }{--600x}{--600z}{--600y}{--600v}\|
1039 #610\|<br/><br/><label>Subjects--Corporate Names: </label>\|{\\n6103
1040 }{\\n610a}{ 610b }{ 610c }{ 610d }{ 610e }{ 610f }{ 610g }{ 610h
1041 }{--610k}{ 610l }{ 610m }{ 610n }{ 610o }{--610p}{ 610r }{ 610s }{ 610t
1042 }{ 610u }{--610x}{--610z}{--610y}{--610v}\|
1044 #611\|<br/><br/><label>Subjects--Meeting Names: </label>\|{\\n6113
1045 }{\\n611a}{ 611b }{ 611c }{ 611d }{ 611e }{ 611f }{ 611g }{ 611h
1046 }{--611k}{ 611l }{ 611m }{ 611n }{ 611o }{--611p}{ 611r }{ 611s }{ 611t
1047 }{ 611u }{--611x}{--611z}{--611y}{--611v}\|
1049 #630\|<br/><br/><label>Subjects--Uniform Titles: </label>\|{\\n630a}{
1050 630b }{ 630c }{ 630d }{ 630e }{ 630f }{ 630g }{ 630h }{--630k }{ 630l }{
1051 630m }{ 630n }{ 630o }{--630p}{ 630r }{ 630s }{ 630t
1052 }{--630x}{--630z}{--630y}{--630v}\|
1054 #648\|<br/><br/><label>Subjects--Chronological Terms: </label>\|{\\n6483
1055 }{\\n648a }{--648x}{--648z}{--648y}{--648v}\|
1056 #650\|<br/><br/><label>Subjects--Topical Terms: </label>\|{\\n6503
1057 }{\\n650a}{ 650b }{ 650c }{ 650d }{ 650e
1058 }{--650x}{--650z}{--650y}{--650v}\|
1060 #651\|<br/><br/><label>Subjects--Geographic Terms: </label>\|{\\n6513
1061 }{\\n651a}{ 651b }{ 651c }{ 651d }{ 651e
1062 }{--651x}{--651z}{--651y}{--651v}\|
1064 #653\|<br/><br/><label>Subjects--Index Terms: </label>\|{ 653a }\|
1066 #654\|<br/><br/><label>Subjects--Facted Index Terms: </label>\|{\\n6543
1067 }{\\n654a}{--654b}{--654x}{--654z}{--654y}{--654v}\|
1069 #655\|<br/><br/><label>Index Terms--Genre/Form: </label>\|{\\n6553
1070 }{\\n655a}{--655b}{--655x }{--655z}{--655y}{--655v}\|
1072 #656\|<br/><br/><label>Index Terms--Occupation: </label>\|{\\n6563
1073 }{\\n656a}{--656k}{--656x}{--656z}{--656y}{--656v}\|
1075 #657\|<br/><br/><label>Index Terms--Function: </label>\|{\\n6573
1076 }{\\n657a}{--657x}{--657z}{--657y}{--657v}\|
1078 #658\|<br/><br/><label>Index Terms--Curriculum Objective:
1079 </label>\|{\\n658a}{--658b}{--658c}{--658d}{--658v}\|
1081 #050\|<br/><br/><label>LC Class. No.: </label>\|{ 050a }{ / 050b }\|
1083 #082\|<br/><br/><label>Dewey Class. No.: </label>\|{ 082a }{ / 082b }\|
1085 #080\|<br/><br/><label>Universal Decimal Class. No.: </label>\|{ 080a }{
1088 #070\|<br/><br/><label>National Agricultural Library Call No.:
1089 </label>\|{ 070a }{ / 070b }\|
1091 #060\|<br/><br/><label>National Library of Medicine Call No.:
1092 </label>\|{ 060a }{ / 060b }\|
1094 #074\|<br/><br/><label>GPO Item No.: </label>\|{ 074a }\|
1096 #086\|<br/><br/><label>Gov. Doc. Class. No.: </label>\|{ 086a }\|
1098 #088\|<br/><br/><label>Report. No.: </label>\|{ 088a }\|
1100 Configuring Receipt Printers
1101 ============================
1103 The following instructions are for specific receipt printers, but can
1104 probably be used to help with setup of other brands as well.
1106 .. _for-epson-tm-t88iii-(3)-&-tm-t88iv-(4)-printers-label:
1108 For Epson TM-T88III (3) & TM-T88IV (4) Printers
1109 --------------------------------------------------------------------
1111 .. _in-the-print-driver-label:
1114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1116 For these instructions, we are using version 5,0,3,0 of the Epson
1117 TM-T88III print driver; the EPSON TM-T88IV version is ReceiptE4.
1118 Register at the `EpsonExpert Technical Resource Center
1119 website <https://www.epsonexpert.com/login>`__ to gain access to the
1120 drivers; go to Technical Resources, then choose the printer model from
1121 the Printers drop-down list.
1123 Click Start > Printers and Faxes > Right click the receipt printer >
1126 - Advanced Tab, click Printing Defaults button
1128 - Layout Tab: Paper size: Roll Paper 80 x 297mm
1130 - TM-T88III: Layout Tab: Check Reduce Printing and Fit to Printable
1133 - TM-T88IV: Check Reduced Size Print; Click OK on the popup window that
1134 appears. Fit to Printable Width should be automatically selected.
1136 - OK your way out of there.
1138 .. _in-firefox-label:
1141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1143 Under File > Page Setup:
1145 - Shrink to fit page on Format & Options tab
1147 - 0,0,0,0 for Margins on Margins & Header/Footer Tab. This makes the
1148 receipts use all available space on the paper roll.
1150 - Set all Headers/Footers to -blank-. This removes all of the gunk you
1151 might normally find on a print from Firefox, such as the URL, number
1156 Set the default printer settings in Firefox so you don't see a "Print"
1159 - Go to File > Print
1161 - Set the Printer to the receipt printer.
1163 - Click the Advanced (or Properties) button
1165 - Layout Tab: Paper size: Roll Paper 80 x 297mm
1167 - TM-T88III: Layout Tab: Check Reduce Printing and Fit to Printable
1170 - TM-T88IV: Check Reduced Size Print; click OK on the popup window that
1171 appears. Fit to Printable Width should be automatically selected.
1173 - OK your way out, go ahead and print whatever page you are on.
1175 - Type about:config, in the address bar. Click "I'll be careful, I
1176 promise!" on the warning message.
1178 - Type, print.always in Filter.
1180 - Look for print.always\_print\_silent.
1182 - If the preference is there then set the value to true.
1184 - If the preference is not there (and it shouldn't be in most browsers)
1185 you have to add the preference.
1187 - Right click the preference area and select New > Boolean
1189 - Type print.always\_print\_silent in the dialog box and set the
1190 value to True. This sets the print settings in Firefox to always
1191 use the same settings and print without showing a dialog box.
1195 Setting the print.always\_print\_silent setting in about:config
1196 DISABLES the ability to choose a printer in Firefox.
1198 .. _for-epson-tm-t88ii-(2)-printers-label:
1200 For Epson TM-T88II (2) Printers
1201 ---------------------------------------------
1203 Register at the `EpsonExpert Technical Resource Center
1204 website <https://www.epsonexpert.com/login>`__ to gain access to the
1205 drivers; go to Technical Resources, then choose the printer model from
1206 the Printers drop-down list.
1208 .. _in-firefox-label:
1211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1213 Under File > Page Setup:
1215 - Shrink to fit page on Format & Options tab
1217 - 0,0,0,0 for Margins on Margins & Header/Footer Tab. This makes the
1218 receipts use all available space on the paper roll.
1220 - Set all Headers/Footers to -blank-. This removes all of the gunk you
1221 might normally find on a print from Firefox, such as the URL, number
1226 Set the default printer settings in Firefox so you don't see a "Print"
1229 - Go to File > Print
1231 - Set the Printer to the receipt printer.
1233 - Print whatever page you are on.
1235 - Type about:config, in the address bar. Click "I'll be careful, I
1236 promise!" on the warning message.
1238 - Type, print.always in Filter.
1240 - Look for, print.always\_print\_silent.
1242 - If the preference is there then set the value to true.
1244 - If the preference is not there (and it shouldn't be in most browsers)
1245 you have to add the preference.
1247 - Right click the preference area and select New > Boolean
1249 - Type, print.always\_print\_silent in the dialog box and set the
1250 value to True. This sets the print settings in Firefox to always
1251 use the same settings and print without showing a dialog box.
1255 Setting the print.always\_print\_silent setting in about:config
1256 DISABLES the ability to choose a printer in Firefox.
1258 .. _for-star-sp542-printers-label:
1260 For Star SP542 Printers
1261 ------------------------------------------
1263 .. _installing-the-printer-label:
1265 Installing the Printer
1266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1268 While the following comments are based on the Star SP542 receipt
1269 printer, they probably apply to all printers in the SP5xx series.
1271 The Star SP542 receipt printer works well with Koha and **Firefox on
1272 Windows XP SP3**. This printer, with either the parallel or USB
1273 interface, is fairly easy to install and configure. You will need the
1274 following executable file which is available from numerous places on the
1277 linemode\_2k-xp\_20030205.exe
1279 This executable actually does all of the installation; you will not need
1280 to use the Microsoft Windows "Add Printer" program. We recommend that
1281 when installing, the option for the software monitor not be selected; we
1282 have experienced significant pauses and delays in printing with it.
1283 Instead, simply choose to install the receipt printer without the
1286 Additionally, the install program may not put the printer on the correct
1287 port, especially if using the USB interface. This is easily corrected by
1288 going to "Start -> Printers and Faxes -> Properties for the SP542
1289 printer -> Ports", then check the appropriate port.
1291 A reboot may be required, even if not indicated by the installation
1292 software or the operating system.
1294 **Windows 7** users should refer to this page:
1295 http://www.starmicronics.com/supports/win7.aspx.
1297 .. _configuring-firefox-to-print-to-receipt-printer-label:
1299 Configuring Firefox to Print to Receipt Printer
1300 ---------------------------------------------------------------------
1302 - Open File > Page Setup
1304 - Make all the headers and footers blank
1306 - Set the margins to 0 (zero)
1308 - In the address bar of Firefox, type about:config
1310 - Search for print.always\_print\_silent and double click it
1312 - Change it from false to true
1314 - This lets you skip the Print pop up box that comes up, as well as
1315 skipping the step where you have to click OK, automatically
1316 printing the right sized slip.
1318 - If print.always\_print\_silent does not come up
1320 - Right click on a blank area of the preference window
1322 - Select new > Boolean
1324 - Enter "print.always\_print\_silent" as the name (without quotes)
1328 - Select true for the value
1330 - You may also want to check what is listed for print.print\_printer
1332 - You may have to choose Generic/Text Only (or whatever your receipt
1333 printer might be named)
1335 Notice & Slips Guides
1336 =====================
1338 .. _field-guide-for-notices-&-slips-label:
1340 Field Guide for Notices & Slips
1341 --------------------------------------------------------
1343 This guide will break down the notices and slips information in 3 ways.
1344 First it will tell you what file generates the notice, then how you will
1345 present the item info in that notice and finally if the notice can be
1346 branch specific or not.
1348 +---------------------+----------------------------+---------------------------------------+--------------------------+
1349 | Letter Code | Used In | Detail tag | Can be branch specific |
1350 +=====================+============================+=======================================+==========================+
1351 | DUE | advance\_notices.pl | <<items.content>> | No |
1352 +---------------------+----------------------------+---------------------------------------+--------------------------+
1353 | DUEDGST | advance\_notices.pl | <<items.content>> | No |
1354 +---------------------+----------------------------+---------------------------------------+--------------------------+
1355 | PREDUE | advance\_notices.pl | <<items.content>> | No |
1356 +---------------------+----------------------------+---------------------------------------+--------------------------+
1357 | PREDUEDGST | advance\_notices.pl | <<items.content>> | No |
1358 +---------------------+----------------------------+---------------------------------------+--------------------------+
1359 | ODUE\* | overdue\_notices.pl | <<items.content>> or <item> </item> | Yes |
1360 +---------------------+----------------------------+---------------------------------------+--------------------------+
1361 | CHECKOUT | C4/Circulation.pm | N/A | Yes |
1362 +---------------------+----------------------------+---------------------------------------+--------------------------+
1363 | RENEWAL | C4/Circulation.pm | N/A | Yes |
1364 +---------------------+----------------------------+---------------------------------------+--------------------------+
1365 | TRANSFERSLIP | C4/Circulation.pm | N/A | Yes |
1366 +---------------------+----------------------------+---------------------------------------+--------------------------+
1367 | ISSUESLIP | C4/Members.pm | <checkedout> </checkedout> | Yes |
1369 | | | <overdue> </overdue> | |
1371 | | | <news> </news> | |
1372 +---------------------+----------------------------+---------------------------------------+--------------------------+
1373 | ISSUEQSLIP | C4/Members.pm | <checkedout> </checkedout> | Yes |
1374 +---------------------+----------------------------+---------------------------------------+--------------------------+
1375 | HOLDPLACED | C4/Reserves.pm | N/A | Yes |
1376 +---------------------+----------------------------+---------------------------------------+--------------------------+
1377 | HOLD_SLIP | C4/Reserves.pm | N/A | Yes |
1378 +---------------------+----------------------------+---------------------------------------+--------------------------+
1379 | ASKED | C4/Suggestions.pm | N/A | Yes |
1380 +---------------------+----------------------------+---------------------------------------+--------------------------+
1381 | CHECKED | C4/Suggestions.pm | N/A | Yes |
1382 +---------------------+----------------------------+---------------------------------------+--------------------------+
1383 | ACCEPTED | C4/Suggestions.pm | N/A | Yes |
1384 +---------------------+----------------------------+---------------------------------------+--------------------------+
1385 | REJECTED | C4/Suggestions.pm | N/A | Yes |
1386 +---------------------+----------------------------+---------------------------------------+--------------------------+
1387 | OPAC\_REG\_VERIFY | opac/opac-memberentry.pl | N/A | No |
1388 +---------------------+----------------------------+---------------------------------------+--------------------------+
1397 Philadelphia, PA 19107
1399 Dear Nicole Engard (23529000035726),
1401 According to our records, at the time of this notice, you have items
1402 that are overdue. Please return or renew them as soon as possible to
1403 avoid increasing late fines.
1405 If you have registered a password with the library, you may use it with
1406 your library card number to renew online.
1408 If you believe you have returned the items below please call at and
1409 library staff will be happy to help resolve the issue.
1411 The following item(s) are currently overdue:
1413 07/08/2008 Creating drug-free schools and communities : 502326000054
1416 06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.
1418 Sincerely, Library Staff
1423 .. _reader's-digest-(0034-0375)-label:
1425 Reader's Digest (0034-0375)
1426 ------------------------------------------------------
1428 - Published 12 times a year (monthly)
1430 - The Volume number changes every 6 months and the numbers continues on
1431 (requires an advanced pattern).
1435 .. _people-weekly-(1076-0091)-label:
1437 People Weekly (1076-0091)
1438 ---------------------------------------------
1442 - The website says "on Saturday except the first week of August,
1443 Thanksgiving week, the first and last weeks of the year" but this
1444 does not match the pattern for 2007 or 2008
1446 - In the Jul-Dec there are 26 issues
1448 - In the Jan-Jun there are 25 issues (no issue for the first week of
1451 Since the irregularity on the first # 26 does not skip a week, this
1452 would be set up as to roll over on issue 25. The 26th issue in the
1453 second half of the year would have to be received as a supplemental.
1455 The irregularity check will complain that 52 issues were expected, but
1456 25 entered. The current irregularity check can only check that the first
1457 position of the numbering pattern matches the expected issue count of
1458 the periodicity. But we do need to trigger the rollover on the volume,
1459 so we need to define the last two weeks of the year as irregularities.
1460 So we receive 50 issues the first 50 weeks, then one supplemental issue
1461 in week 51, which we have to define the enumeration for, then the next
1462 predicted issue will be the following year's first week.
1467 --------------------------------
1469 This journal is published with the following rules:
1471 - 6 issues a year (every 2 months)
1473 - year changes every 6 issues
1477 - the issue number goes up indefinitely
1479 - starting from issue 215
1481 The planning would look like this:
1485 .. _backpacker-(0277-867x)-label:
1487 Backpacker (0277-867X)
1488 ----------------------------------------------
1490 Published 9 times a year irregularly. The issues continues while the
1491 volume and number rolls over every 9 issues. If you're holding Volume
1492 41, Number 3, Issue 302 in your hand the prediction would look like
1497 And the received issues would number like this:
1499 v. 41, no. 3, iss. 302
1501 v. 41, no. 4, iss. 303
1503 v. 41, no. 5, iss. 304
1505 v. 41, no. 6, iss. 305
1507 v. 41, no. 7, iss. 306
1509 v. 41, no. 8, iss. 307
1511 v. 41, no. 9, iss. 308
1513 v. 42, no. 1, iss. 309
1515 v. 42, no. 2, iss. 310
1517 v. 42, no. 3, iss. 311
1519 v. 42, no. 4, iss. 312
1521 .. _keats-shelley-journal-(0453-4387)-label:
1523 Keats-Shelley Journal (0453-4387)
1524 ----------------------------------------------------
1526 This journal is published once per year in July. The numbering follows
1535 Setup should look like this (if you're starting in July 2014):
1539 .. _computers-in-libraries-(1041-7915)-label:
1541 Computers in Libraries (1041-7915)
1542 ---------------------------------------------------
1544 Computers in Libraries is published ten times per year (monthly with
1545 January/February and July/August combined issues).
1553 Sample List & Cart Emails
1554 =========================
1556 .. _example-email-from-list-label:
1558 Example Email from List
1559 -----------------------------------------------
1561 Below is an example of an email from a list in Koha.
1567 Here is your list called If You Like Jodi Picoult, sent from our online catalog.
1569 Please note that the attached file is a MARC bibliographic records file
1570 which can be imported into a Personal Bibliographic Software like EndNote,
1571 Reference Manager or ProCite.
1572 ---------------------------------------------
1574 Home safe : a novel /
1578 Published by: Random House,, 260 p. ;, 25 cm.
1579 Copyright year: 2009
1581 In the online catalog:
1582 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12113
1584 North Branch FIC (FIC Ber) TVSN500088894O
1585 Main Library FIC (FIC Boh) TVSN5000921548
1586 South Branch FIC (FIC Boh) TVSN500092156A
1587 West Branch FIC (FIC Boh) TVSN5000921559
1589 ---------------------------------------------
1595 Published by: Farrar, Straus, and Giroux,, 402 p. ;, 24 cm.
1596 Copyright year: 2000
1598 In the online catalog:
1599 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=12501
1601 East Branch (813/.54)
1602 South Branch FIC (FIC Bro) TVSN5000451333
1604 .. _example-email-from-cart-label:
1606 Example Email from Cart
1607 -----------------------------------------------
1609 Below is a sample of what an email from the Cart in Koha will look like:
1615 Joaquin D'Planque sent you a cart from our online catalog.
1617 Please note that the attached file is a MARC bibliographic records
1618 file which can be imported into personal bibliographic software like
1619 EndNote, Reference Manager or ProCite.
1621 ---------------------------------------------------------------------
1625 Author(s): Brookfield, Karen. ;
1626 Published by: Knopf : | Distributed by Random House, , 63 p. : ,
1628 Copyright year: 1993
1629 Notes : Includes index.
1633 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=31644
1637 * East Branch (JNF 002 Bro) TVSN500017618A
1639 -----------------------------------------------------------------
1641 2. The 1965 World book year book :
1643 Published by: Field Enterprises Educational Corp., , 628 p. : , 26
1645 Copyright year: 1965
1646 Notes : Includes index. | Spine title: Year book, 1965. | Cover
1647 title: The World book year book, 1965.
1649 http://www.archive.org/details/1965worldbookyea00chic%20%7C%20http://www.openlibrary.org/books/OL24199089M
1652 http://MYCATALOG/cgi-bin/koha/opac-detail.pl?biblionumber=88666
1654 -----------------------------------------------------------------
1656 Using Koha as a Content Management System (CMS)
1657 ===============================================
1662 -------------------------
1664 These are instructions for taking a default install of Koha and allowing
1665 it to function as a little content management system. This will allow a
1666 library to publish an arbitrary number of pages based on a template.
1667 This example uses the template for the main opac page, but you could
1668 just as well use any template you wish with a bit more editing. This may
1669 be appropriate if you have a small library, want to allow librarians to
1670 easily add pages, and do not want to support a complete CMS.
1672 - Copy /usr/share/koha/opac/cgi-bin/opac/opac-main.pl to
1673 /usr/share/koha/opac/cgi-bin/opac/pages.pl (in the same directory)
1675 - Edit pages.pl in an editor
1677 - At approximately line 33 change this code:
1681 template_name => "opac-main.tmpl",
1687 template_name => "pages.tmpl",
1689 - At approximately line 62 after this code:
1694 koha_news => $all_koha_news,
1695 koha_news_count => $koha_news_count,
1696 display_daily_quote => C4::Context->preference('QuoteOfTheDay'),
1697 daily_quote => $quote,
1704 my $page = "page_" . $input->param('p'); # go for "p" value in URL and do the concatenation
1705 my $preference = C4::Context->preference($page); # Go for preference
1706 $template->{VARS}->{'page_test'} = $preference; # pass variable to template pages.tt
1708 - Note pages.pl file must have Webserver user execution permissions,
1709 you can use `chmod <http://en.wikipedia.org/wiki/Chmod>`__ command if
1710 you are actually logged in as such user:
1716 - In the browser go to Home > Administration > System Preferences >
1717 Local Use and add a New Preference called "page\_test"
1721 - Explanation: test page for pages tiny cms
1723 - Variable: page\_test
1725 - Value: Lorem ipsum
1727 - Click the TextArea link (or enter "TextArea" into the input field
1730 - variable options (last field): 80\|50
1732 - In a browser go to http://youraddress/cgi-bin/koha/pages.pl?p=test
1733 The page should come up with the words "Lorem ipsum" in the main
1734 content area of the page. (replace "youraddress" with localhost,
1735 127.0.0.1, or your domain name depending on how you have Apache set
1738 - To add more pages simply create a system preference where the title
1739 begins with "page\_" followed by any arbitrary letters. You can add
1740 any markup you want as the value of the field. Reference the new page
1741 by changing the value of the "p" parameter in the URL.
1743 To learn more visit the Koha wiki page on this topic:
1744 http://wiki.koha-community.org/wiki/Koha_as_a_CMS
1746 .. _editing-the-pages-template-label:
1748 Editing the pages template
1749 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1751 The file to create / edit for the pages template will depend on your
1752 :ref:`opacthemes` system preference setting
1754 .. _editing-'bootstrap'-theme-template-(current)-label:
1756 Editing 'bootstrap' theme template (current)
1757 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1760 /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/opac-main.tt
1762 /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt
1765 /usr/share/koha/opac/htdocs/opac-tmpl/bootstrap/en/modules/pages.tt
1767 - At approximately line 61, change this:
1771 [% IF ( OpacMainUserBlock ) %]<div id="opacmainuserblock">[% OpacMainUserBlock %]</div>[% END %]
1777 [% IF ( page_test ) %]<div id="opacmainuserblock">[% page_test %]</div>[% END %]
1779 Remark: You may wish to disable your News block of these CMS style pages
1780 e.g. when you do not want it displayed on the CMS style pages or where
1781 the News block is long enough that it actually makes the 'page\_test'
1782 include scroll outside the default viewport dimensions. In that case,
1783 remove the following code from your pages.tt template.
1787 [% IF ( koha_news_count ) %]
1789 <table class="table table-bordered">
1790 [% FOREACH koha_new IN koha_news %]
1791 <thead><tr><th>[% koha_new.title %]</th></tr></thead>
1792 <tbody><tr><td><p>[% koha_new.new %]</p>
1793 <p class="newsfooter"><i>(published on [% koha_new.newdate %])</i></p></td></tr></tbody>
1800 .. _troubleshooting-label:
1803 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1805 If you have problems check file permissions on pages.pl and pages.tmpl.
1806 They should have the same user and group as other Koha files like
1809 .. _bonus-points-label:
1812 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1814 Instead of using the address
1815 http://youraddress/cgi-bin/koha/pages.pl?p=test you can shorten it to
1816 http://youraddress/pages.pl?p=test Just open up
1817 /etc/koha/koha-httpd.conf and add the follow at about line 13:
1821 ScriptAlias /pages.pl "/usr/share/koha/opac/cgi-bin/opac/pages.pl"
1823 Then restart Apache.
1828 -------------------------
1830 After setting up Koha as a CMS you can create new pages following these
1833 .. _adding-pages-label:
1836 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1838 To add a new page you need to add a system preference under Local Use.
1840 - Get there: More > Administration > Global System Preferences > Local
1843 - Click 'New Preference'
1845 - Enter in a description in the Explanation field
1847 - Enter a value that starts with 'page\_' in the Variable field
1849 - Enter starting HTML in the Value field
1853 - Set the Variable Type to Textarea
1855 - Set the Variable options to something like 20\|20 for 20 rows and 20
1860 .. _viewing-your-page-label:
1863 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1865 You can view your new page at
1866 http://YOUR-OPAC/cgi-bin/koha/pages.pl?p=PAGENAME where PAGENAME is the
1867 part you entered after 'page\_' in the Variable field.
1872 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1874 This process can be used to create recommended reading lists within
1875 Koha. So once the code changes have been made per the instructions on
1876 'Koha as a CMS' you go through the 'Adding a New Page' instructions
1877 above to great a page for 'Recommended Reading Lists'
1881 Next we need to create pages for our various classes (or categories). To
1882 do this, return to the 'Adding a New Page' section and create a
1883 preference for the first class.
1887 Next you'll want to link your first page to your new second page, go to
1888 the page\_recommend preference and click 'Edit.' Now you want to edit
1889 the HTML to include a link to your newest page:
1893 .. _live-examples-label:
1896 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1898 - The Crawford Library at Dallas Christian College is using this method
1899 for their recommended reading lists: http://opac.dallas.edu/
1901 Resetting the Koha Database
1902 ===========================
1904 These notes on how to reset the database for Koha were derived from the
1905 following email thread:
1906 http://lists.koha-community.org/pipermail/koha-devel/2009-January/008939.html
1907 and http://lists.katipo.co.nz/public/koha/2014-June/039701.html
1909 Resetting the database may be useful if you install Koha with the sample
1910 data, and then wish to use real data without reinstalling the software.
1912 .. _delete-sample-data-from-tables-label:
1914 Delete sample data from Tables
1915 --------------------------------------------------
1917 Use your preferred MySQL client to
1918 `delete <http://dev.mysql.com/doc/refman/5.5/en/delete.html>`__ the
1933 You may need to disable foreign key checks to delete data from same
1934 tables. For instructions follow this thread:
1935 https://lists.katipo.co.nz/pipermail/koha/2013-July/036853.html.
1937 .. _reset-the-zebra-index-label:
1939 Reset the Zebra Index
1940 ---------------------------------------
1942 Run the following commands to reset the authorities and biblios Zebra
1947 $ zebraidx -c /etc/koha/zebradb/zebra-authorities-dom.cfg -g iso2709 -d authorities init
1948 $ zebraidx -c /etc/koha/zebradb/zebra-biblios.cfg -g iso2709 -d biblios init
1950 If you are running a package install then you'll want to run the
1951 following commands to reset the authorities and biblios Zebra indices
1956 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-authorities-dom.cfg -g iso2709 -d authorities init
1957 $ sudo zebraidx -c /etc/koha/sites/YOURLIBRARY/zebra-biblios.cfg -g iso2709 -d biblios init
1959 Replacing YOURLIBRARY with your Koha installation name.
1964 .. _koha-related-label:
1967 ------------------------------------
1969 - Report Koha Bugs - http://bugs.koha-community.org
1971 - Koha Versioning Control - http://git.koha-community.org/
1973 - Database Structure - http://schema.koha-community.org
1975 - Koha Community Statistics - http://hea.koha-community.org
1977 - Koha as a CMS - http://wiki.koha-community.org/wiki/Koha_as_a_CMS
1979 - Kyles's Koha Tools - http://kylehall.info/index.php/projects/koha/
1981 - Koha Bibliography - http://www.zotero.org/groups/koha
1983 - Koha Shared Links - http://groups.diigo.com/group/everything-koha
1985 .. _circulation-related-label:
1988 -------------------------------------------
1990 - Koha Desktop Offline Circulation:
1991 https://github.com/bywatersolutions/koha-offline-circulation/releases
1993 - Koha Firefox Offline Circulation:
1994 https://addons.mozilla.org/en-US/firefox/addon/koct/
1996 .. _cataloging-related-label:
1999 ---------------------------------------------
2001 - Koha MARC Tutorials - http://www.pakban.net/brooke/
2003 - IRSpy Open Z39.50 Server Search - http://irspy.indexdata.com/
2005 - Z39.50 Server List -
2006 http://staff.library.mun.ca/staff/toolbox/z3950hosts.htm
2008 - Open Koha Z39.50 Targets -
2009 http://wiki.koha-community.org/wiki/Koha_Open_Z39.50_Sources
2011 - Library of Congress Authorities - http://authorities.loc.gov/
2013 - MARC Country Codes - http://www.loc.gov/marc/countries/
2015 - Search the MARC Code List for Organizations -
2016 http://www.loc.gov/marc/organizations/org-search.php
2018 - Search for Canadian MARC Codes -
2019 http://www.collectionscanada.gc.ca/illcandir-bin/illsear/l=0/c=1
2021 - Z39.50 Bib-1 Attribute -
2022 http://www.loc.gov/z3950/agency/defns/bib1.html
2024 .. _enhanced-content-related-label:
2026 Enhanced Content Related
2027 ----------------------------------------------------
2029 - Amazon Associates -
2030 `https://affiliate-program.amazon.com <https://affiliate-program.amazon.com/>`__
2032 - Amazon Web Services - http://aws.amazon.com
2034 - WorldCat Affiliate Tools -
2035 http://www.worldcat.org/wcpa/do/AffiliateUserServices?method=initSelfRegister
2037 - XISBN - http://www.worldcat.org/affiliate/webservices/xisbn/app.jsp
2039 - LibraryThing for Libraries - http://www.librarything.com/forlibraries
2041 .. _design-related-label:
2044 -------------------------------
2046 - JQuery Library - http://wiki.koha-community.org/wiki/JQuery_Library
2048 - HTML & CSS Library -
2049 http://wiki.koha-community.org/wiki/HTML_%26_CSS_Library
2051 - Owen Leonard's Koha Blog - http://www.myacpl.org/koha
2053 .. _reports-related-label:
2056 ----------------------------------
2058 - SQL Reports Library -
2059 http://wiki.koha-community.org/wiki/SQL_Reports_Library
2061 - Database Schema - http://schema.koha-community.org
2063 - Sample reports from NEKLS -
2064 http://www.nexpresslibrary.org/training/reports-training/
2066 .. _installation-guides-label:
2069 ---------------------------------------
2071 - Installing Koha 3 on Ubuntu -
2072 http://www.blazingmoon.org/guides/k3-on-u810-1.html
2074 - Koha on Debian installation documentation -
2075 http://openlib.org/home/krichel/courses/lis508/doc/koha_installation_overview.html
2077 - Koha 3.2 on Debian Squeeze -
2078 http://wiki.koha-community.org/wiki/Koha_3.2_on_Debian_Squeeze
2083 ---------------------
2085 - Zotero - http://zotero.org
2087 - SOPAC - `http://thesocialopac.net <http://thesocialopac.net/>`__
2089 Koha XSLT Item Types
2090 ====================
2092 When you have any of the XSLT system preferences
2093 (:ref:`OPACXSLTDetailsDisplay`,
2094 :ref:`OPACXSLTResultsDisplay`,
2095 :ref:`XSLTDetailsDisplay`, and/or
2096 :ref:`XSLTResultsDisplay`) along with the
2097 :ref:`DisplayOPACiconsXSLT` and
2098 :ref:`DisplayIconsXSLT` preferences turned on you will
2099 see item type icons on the related screen.
2103 These images are coming from values found in your leader, if your
2104 leader is not cataloged properly it might be best to turn off the
2105 :ref:`DisplayOPACiconsXSLT` preference (which
2106 can be done while leaving the other XSLT preferences turned on).
2112 - leader6 = a (and one of the leader7 values below)
2126 - Computer File [CF]
2132 - Continuing Resource [CR]
2168 - Visual Material [VM]
2185 Many libraries like to use MarcEdit for modifications or data cleanup.
2186 If you'd like to do this you will need to download it at:
2187 http://marcedit.reeset.net/
2191 Many of the actions described in this chapter can be done in Koha
2192 using :ref:`Marc Modification Templates <marc-modification-templates-label>`, but this
2193 section is here for those who are used to MarcEdit.
2195 .. _adding-a-prefix-to-call-numbers-label:
2197 Adding a prefix to call numbers
2198 -----------------------------------------------------
2200 When bringing data into Koha, you may want to first clean it up. One
2201 common action among Koha users is to add a prefix to the call number.
2207 - Click 'MarcEditor'
2209 - Go to Tools > Edit Subfield Data
2213 - To prepend data the special character is: ^b To simply prepend data
2214 to the beginning of a subfield, add ^b to the Field Data: textbox and
2215 the data to be appended in the Replace
2219 - To prepend data to the beginning of the subfield while replacing a
2220 text string, add ^b[string to replace] to the Field Data textbox
2221 and the data to be appended in the Replace With textbox.
2223 .. _importing-excel-data-into-koha-label:
2225 Importing Excel data into Koha
2226 ---------------------------------------------------
2228 Suppose you have records of your library in excel data sheet format and
2229 want them to import into Koha. But how will you do this? Koha will not
2230 let you import excel records directly. Well here is a very simple
2231 solution for you which will let you import your excel records in Koha
2232 easily. First, we will convert excel file into Marc file and then will
2233 import it into Koha.
2235 Follow the given steps to import your excel records into Koha
2237 .. _converting-from-excel-format-into-.mrk-format-label:
2239 Converting from Excel format into .mrk format
2240 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2242 First, we will convert excel format into .mrk format. For this we will
2243 use MarcEdit. You can download it from http://marcedit.reeset.net/
2245 Now open it and select Add-ins-->Delimited Text Translator.
2249 Click Next when the following window appears.
2253 Browse for your excel file.
2257 Locate your excel file by choosing the format Excel File(\*.xls).
2261 Similarly, fill all the other entries such as Output File, Excel Sheet
2262 Name and check UTF-8 Encoded (if required) and Click Next.
2266 Now you will be prompted for mapping the fields to recognise the fields
2267 by standard marc format.
2269 Suppose for Field 0 that is first column I entered Map to: 022$a( Valid
2270 ISSN for the continuing resource) and then click on Apply.
2276 You can customize Indicators and all other things, for more
2277 information on marc21 format visit the `official library of congress
2278 site <http://www.loc.gov/marc/bibliographic/>`__.
2280 Similarly map all other fields and then Click on Finish.
2284 And then a window will appear indicating that your Marc Text
2285 File(\*.mrk) has been created.
2289 Click Close and we have created a .mrk file from .xls file in this step.
2290 You can view the file by double clicking on it.
2292 .. _convert-.mrk-file-to-.mrc-label:
2294 Convert .mrk file to .mrc
2295 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2297 We will convert .mrk file that we have created in the above step into
2298 raw Marc format that can be directly imported into Koha.
2300 For this again open MarcEdit and Select MARC Tools.
2304 Next Select MarcMaker to convert .mrk file into .mrc format.
2308 Locate your input file and name your output file. Then Click Execute.
2312 And it will show you the Result.
2316 Click Close and now we have raw Marc records with us (.mrc file).
2318 .. _import-.mrc-into-koha-label:
2320 Import .mrc into Koha
2321 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2323 More information on importing records into Koha can be found in the
2324 ':ref:`Stage MARC Records for Import`' section of this manual.
2326 Finally we will import above created .mrc file into Koha.
2328 Click on Tools in your Koha staff client.
2332 Next Click on Stage MARC Records for Import.
2336 After this, choose your previously created .mrc file and click on
2341 You can also add comment about file and finally click on Stage For
2346 When the import is done, you will get a result something like this
2350 Next, click on Manage staged records.
2352 Here you can even change matching rules.
2356 Click on Import this batch into catalog when you are done.
2358 Thats it. After all the records get imported, check Status and it should
2363 You can even undo the Import operation.
2365 And within few minutes, we have imported around 10,000 records in Koha
2370 Talking Tech I-tiva is a third party, proprietary, product that
2371 libraries can subscribe to. Learn more here:
2372 http://www.talkingtech.com/solutions/library.
2374 .. _installation-and-setup-instructions-label:
2376 Installation and Setup Instructions
2377 -------------------------------------------------------------
2380 installer/data/mysql/atomicupdate/Bug-4246-Talking-Tech-itiva-phone-notifications.pl
2381 to install the required data pack (new syspref, notice placeholders and
2382 messaging transport preferences)
2385 :ref:`TalkingTechItivaPhoneNotification`
2386 syspref must be turned on.
2388 If you wish to process PREOVERDUE or RESERVES messages, you'll need the
2389 :ref:`EnhancedMessagingPreferences` system
2390 preference turned on, and patrons to have filled in a preference for
2391 receiving these notices by phone.
2393 For OVERDUE messages, overdue notice triggers must be configured under
2394 Koha -> Tools -> :ref:`Overdue Notice Triggers <overdue-notice/status-triggers-label>`. Either
2395 branch-specific triggers or the default level triggers may be used
2396 (script will select whichever is appropriate).
2398 .. _sending-notices-file-label:
2400 Sending Notices File
2401 -------------------------------------------
2403 1. Add the :ref:`TalkingTech\_itiva\_outbound.pl <sending-notices-file-label>`
2404 script to your crontab
2406 2. Add an FTP/SFTP or other transport method to send the output file to
2409 3. If you wish, archive the sent notices file in another directory after
2412 Run TalkingTech\_itiva\_outbound.pl --help for more information
2414 .. _receiving-results-file-label:
2416 Receiving Results File
2417 ------------------------------------------------
2419 1. Add an FTP/SFTP or other transport method to send the Results file to
2420 a known directory on your Koha server
2422 2. Add the :ref:`TalkingTech\_itiva\_inbound.pl <receiving-notices-file-label>`
2423 script to your crontab, aimed at that directory
2425 3. If you wish, archive the results file in another directory after
2428 Run TalkingTech\_itiva\_inbound.pl --help for more information
2430 Integrating SIP2 with Koha
2431 =============================
2433 SIP2 (Session Initiation Protocol) is a protocol for communication between devices.
2435 In the context of Koha SIP2 is used for communication between Self Check (SC) machines i.e. self checkout machines, and the Automated Circulation System (also known as ACS which in this case is the server running Koha).
2437 SIP2 communications consist of requests and responses.
2439 The self checkout machines are ‘dumb’ and so they send requests to the Koha server which runs logic which determines a particular outcome which is sent as a response message back to the client self checkout machine, and this is then conveyed to the user.
2441 .. warning:: Security notice regarding using SIP2 service:
2442 To ensure that your SIP2 traffic is secure as it passes over the internet you need to make sure that you are using a VPN or stunnel.
2445 ----------------------
2447 If you installed Koha using Debian packages then SIP2 setup is easy, simply follow these steps:
2450 1. In your terminal (in the root Koha directory) write in:
2451 *sudo koha-enable-sip <instancename>*
2454 2. Now you need to configure the SIP2 settings, to do this you need to edit the SIPconfig.xml file which exists in the /etc/koha/sites/<instancename>/ directory.
2455 You will need to edit this file as root because it contains passwords (to do so write ‘sudo’ at the start of your command).
2458 *sudo vi /etc/koha/sites/<instancename>/SIPconfig.xml*
2460 .. note:: Important note: There are three areas of interest in the SIPconfig.xml file that you need to change. These are: service, account and institution.
2466 2.1 Change the port value near the top of the SIPconfig.xml file (identified by the number 1 in the below screen shot), so it has the same IP address as set further down the SIPconfig.xml file identified by 2.
2468 .. note:: Make sure the two port values don’t have the same port number as you cannot have the same port being listened to by two different services. When deciding upon the port number make sure it is a high number (i.e. above 1000) because all ports below 1000 require root permissions.
2476 The account(s) you define in the SIPconfig.xml file are simply account(s) permitted to use the SIP2 service i.e. your defining who can send and receive SIP2 commands.
2478 .. warning:: Account information that you write here must also exist in the Koha database i.e. you need to create a patron in the Koha staff interface with the same username, password (making sure to assign them circulate permissions) as the user account you write into the SIPconfig.xml file.
2480 .. note:: It is highly recommended that you only write in Koha user accounts with circulate permissions.
2482 The reason we want SIP2 users to only have circulate permissions rather than superlibrarian permissions is to reduce the access SIP2 users have to confidential patron data in case the system was compromised.
2484 If the ACS or the SC were compromised then having all SIP2 users only having circulation permissions means that an intruder would only be able to access patron data via the terminal rather than the web interface as well (which would be available with superlibrarian permissions). So it is simply a matter of protecting your users.
2489 **Account value definitions:**
2492 1. Login id: This is the account username. - Modify this accordingly
2493 2. Password: Account password - Modify this accordingly
2494 3. Delimiter: The type of delimiter for account information - Leave as default
2495 4. error-detect - Leave as default
2496 5. Institution: This is the branchcode for the library that the user belongs to. NOTE: This institution needs to be defined further down in the institution area of the SIPconfig.xml file and it must also exist in the Koha database. i.e. you need to create a library with the same branchcode in Koha staff interface.
2497 6. encoding: This is the standard used to encode the account data
2498 7. Terminator: This needs to match the terminator value of the SIP2 server. - Modify this if you know the terminator value of the SIP2 server.
2503 The institution information you define here must match a library created in the Koha staff interface.
2505 .. warning:: You need to make sure all the institutions that accounts are assigned to further up in the SIPconfig.xml file are also defined in the institution area of the same file.
2509 **Institution value definitions:**
2512 1. Institution id: The branchcode of the library. - Modify this accordingly.
2513 Must be the same as created in Koha and the account area.
2515 2. Implementation: Defines the code that will be run. - Leave as default
2517 3. Policy: Policy defines the permitted SIP2 commands allowed from SC’s in this institution.
2518 For example: renewal=”true” means that SC’s at that institution have permission to send renewal item SIP2 commands.
2521 Simply write in the command:
2522 *sudo koha-start-sip <instancename>*
2524 .. note:: Now you have a running SIP2 server.
2529 SIP2 is a communication protocol. The messages sent in SIP2 are either requests or responses. The SC’s send request messages to the ACS which will run some logic and send back the resulting value to the SC as a response message.
2531 The request messages contain arguments, which are data values used by the ACS in its functions to perform the required task such as renewing items.
2535 If you want to manually use/test SIP2 then you will be writing and receiving messages via the Linux terminal.
2537 To be able to send and receive messages with the SIP2 server you need to use telnet to open a SIP2 connection. You need to specify the port number you want telnet to use.
2539 To find this information look at the service area at the top of the SIPconfig.xml file (look for the port number as pointed out by the arrow in the below screenshot).
2544 1. Write into the terminal
2546 *telnet localhost <portnumber>*
2548 e.g. *telnet localhost 8023*
2550 2. Now write in the username and password set in one of the accounts in the SIPconfig.xml file.
2552 3. Now you are connected to the SIP2 server you can start writing and sending request commands. The connection to the SIP2 server does time out fast so if haven’t finished writing and receiving commands simply write in:
2554 *telnet localhost <portnumber>*
2556 to restart the SIP2 connection.
2558 **SIP2 command syntax**
2560 Every SIP2 command has a 2 digit numerical prefix which defines what the command is doing.
2562 e.g. To get information about a patron you start your command with the prefix: 63. The response from the server also has a corresponding numerical prefix.
2564 Below is an example of a SIP2 request message to request patron information (in this example a Koha patron account with the user name ‘joe’, password ‘joes’, and card number ‘y76t5r43’ has been created in the Koha staff interface).
2566 Additionally a library with the branchcode of ‘WEL’ has been created in the Koha staff interface and is also defined in the institution area of the SIPconfig.xml file):
2570 So the format of this SIP2 request message is:
2574 .. note:: The summary value is a 10 character value. If a Y is written in for the summary value then you will be able to get both a summary and more detailed informational output.
2576 The value in the <YYYYMMDD> <HHMMSS> is the current datetime, by leaving a 4 space gap between the YYYYMMDD and HHMMSS this indicates you want to use local time rather than UTC.
2578 .. note:: In this manual letter codes for the various fields are used where possible in describing the SIP2 message fields e.g. AO<institutionid>.
2580 These letter codes can be written in the SIP2 commands into the Linux terminal, but make sure when substituting values in for the fields (values inside the <>) that you do not write in the <> brackets.
2588 This uses the prefix 01 for request messages and 24 for response messages.
2595 .. note:: Card retained is a single character field of either ‘Y’ or ‘N’ which tells the ACS that a card has been retained by the self checkout machine.
2601 .. note:: <patronstatus> is a 14 character long value. The value Y in the string means true. Each position in this string (starting at 0) has a single corresponding value (Y or N) in the string.
2603 e.g. a Y at position 1 (the second value in the string) means that the patrons renewal privileges are denied.
2609 This uses the request message (messages sent to the ACS) prefix of 09 and the response prefix of 10 (sent to the SC).
2615 .. note:: * <no block (Offline)> is a single character field of either ‘Y’ or ‘N’ which indicates if the transaction is being performed offline. As offline transactions are not supported you need to write ‘N’ if you are testing this message out manually.
2617 * <transactiondate> this is a 18 character field with the date is the format: YYYYMMDDZZZZHHMMSS.
2619 ZZZZ is the timezone, if you want to set it to local you need to leave 4 blank spaces, but if you want to set it to the UTC (Coordinated Universal Time) then you need to write in 3 blank spaces and a Z.
2625 .. note:: Alert type could have one of several values:
2633 If an item is resensitized then the value of <resentitize> should be Y otherwise it should be N. Rensensitizing items is done to ensure that if someone tries to steal the item they are detected.
2637 This uses the request message prefix of 11 and the response message prefix of 12.
2638 It has similar syntax to the check-in command, outlined above except the prefixes are different.
2640 **Hold** – May not yet be supported on some systems. This has a request message numerical prefix of 15 and a response message prefix of 16.
2646 .. note:: <holdmode> is a single character value. + means add a hold, - means delete a hold and * means change a hold.
2652 .. note:: * <ok> is a single length value which is either 0 (for hold is not permitted or was not successful) or 1 (for hold is permitted and was successful).
2654 * <available> is a single length value which is either Y or N. Y means the item is currently in the library, whilst N means the item is currently on loan/someone else has created a hold on the item.
2657 **Item information: This uses the request command prefix of 17, and the response command prefix of 18**
2663 .. note:: See the check-in items command (described above) to find out what the <xact_date> value is.
2665 The terminal password is optional.
2671 **Item status update This uses the request message prefix of 19 and the response message prefix of 20**
2677 .. note:: <itemproperties> is not a fixed length value, and you can optionally write in values such as item size and these values will be stored in the Koha database for the item.
2683 .. note:: <itempropertiesok> is a single length character value which is either 0 or 1. 1 identifies that the <itemproperties> value defined in the item status update request message was successfully stored in the Koha database.
2687 This uses the request message prefix 23 and the response message prefix of 24.
2697 .. note:: The value displayed for <patronvalidity> is Y (valid) and N (invalid)
2698 The value in the <YYYYMMDD> < HHMMSS> is the current date/time.
2700 The reason for the gap between the two values is to define that you want to use localtime rather than UTC.
2703 **Patron enable - This is not yet supported. This uses the request message prefix of 25 and the response message prefix of 26**
2705 .. note:: This command undoes the block patron command.
2715 **Renew This uses the request message prefix of 29 and the response message prefix of 30**
2721 .. note:: * <thirdpartyallowed> is a single character value which is either Y or N. If it is Y then third parties can renew items.
2723 * <noblock> is a single character value which is either Y or N. If it is Y then this means that the item was checkin/out when the ACS was offline.
2725 * <nbduedate> is the transaction date of checkin/checkout when the ACS was offline.
2727 * <feeacknowledged> is a single character value which is either Y or N. This indicates if the user accepts the fee associated with the item they are renewing.
2733 .. note:: * <ok> is a single character value which is either 0 or 1. A value of 1 means the item was successfully renewed, 0 means item was not successfully renewed.
2735 * <renewalok> is a single character value which is either Y or N. The logic for the setting of the value of <renewalok> is Y is set when the item is already checkout by the user and so it should be desensitized thereby renewing it, whereas N is set if the item is not already checkout to the patron and so it should not be renewed.
2737 In other words don’t let patrons renew books when they are not currently checked out to them.
2739 * <magneticmedia> is a single character value which is either Y (for yes), N ( for no), or U (for unknown).
2741 * <mediatype> is a three numerical character long value. For a list of the values go to: http://multimedia.3m.com/mws/media/355361O/sip2-protocol.pdf
2746 This uses the request message prefix of 35 and the response message prefix of 36
2756 .. note:: <success_or_failure> is either Y for success or N for failure.
2758 **Fee Paid – May not be implemented yet. This uses a request message prefix of 37 and a response message prefix of 38**
2764 .. note:: * <feetype> is a two numerical character value which is between 01 and 99. To see a list of fee type values go to http://multimedia.3m.com/mws/media/355361O/sip2-protocol.pdf
2766 * <paymenttype> is a two character numerical value between 00 and 99. 00 is cash, 01 is Visa, and 02 is credit card.
2768 * <currencytype> is a 3 alphanumeric character long value identifying the currency the fee paid was in.
2774 .. note:: <paymentaccepted> is a single alphanumeric character long value which is either Y (payment has been accepted) or N (payment has not been accepted).
2777 **Patron information**
2779 This uses the request message prefix of 63 and the response message prefix of 64
2789 .. note:: <valid patron> is Y for valid and N for not valid.
2791 .. note:: <hold itemcount><overdueitemcount><chargeditemscount><fienitemscount><recallitemscount><unavaliableholdscount> are all 4 numerical character long values.
2795 This uses the request message prefix of 65 and the response message prefix of 66.
2805 .. note:: * <renewedcount> is a 4 numerical character long value denoting the number of items that were renewed.
2807 * <unrenewedcount>, has the same format as the <renewedcount> but it denotes the number of items not renewed.
2811 This uses the request message prefix of 93, and the response message prefix of 94.
2817 .. note:: <UIDalgorithm> and <PWDalgorithm> are one character long values indicating the type of algorithm to use to encrypt the loginuserid and loginpassword respectively.
2819 Writing in the value of 0 means these values will not be encrypted.
2822 *941* is a successful login.
2823 *940* is an unsuccessful login
2824 *[connection closed by foreign host.]* is a unsuccessful login
2829 This requests the receiving device to resend its last message.
2831 SC -> ACS resend request is *97*
2833 ACS -> SC resend request is *96*
2836 **Status of the ACS and SC**
2838 This has the request message prefix of 99 and the response message prefix of 98.
2845 .. note:: The status code is one of 3 values.
2847 * 1: SC is out of paper
2848 * 2: SC is shutting down
2849 max print width is a 3 character long value which is the integer number of characters the client can print
2850 Protocol version is a 4 character value in the format x.xx
2856 .. note:: If you get the response message ‘96’ this means that the request message is not valid/understood.
2859 **Troubleshooting SIP2**
2861 Can’t connect to remote host when writing in the command telnet localhost <portnumber>
2863 3 solutions for this issue to try are:
2865 1. Check the portnumber your writing in the above command is the port number written in the SIPconfig.xml file at the location indicated by the number 1.
2866 i.e. in the below example because the portnumber is 6001 the correct command would be:
2867 telnet localhost 6001
2869 2. Check if any userid is written more than once in the SIPconfig.xml file.
2870 The userid (which is simply the username of the Koha user) needs to be unique within the SIPconfig.xml file. If you have the same userid multiple times in your SIPconfig.xml file this will cause the connection to SIP2 to fail before you get a chance to authenticate.
2872 3. Check the account defined in the SIPconfig.xml file also exists in the Koha database with the same username, password and has circulate permissions.
2873 If you have dropped and recreated the Koha database after creating the patron account in the Koha staff interface and the SIPconfig.xml file then that patron account will not exist in the Koha database and so you will need to recreate them in the Koha staff interface.
2877 Further troubleshooting
2878 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2879 To access the SIP2 logs in your Koha home directory navigate to the following directory:
2880 /var/log/koha/<instancename>
2882 Then view the output of the sip-error.log and the sip-output.log files which give more detailed information about the SIP2 error.
2885 * cat sip-output.log
2888 **Useful links on SIP2 commands:**
2890 http://multimedia.3m.com/mws/media/355361O/sip2-protocol.pdf
2894 Integrating LDAP with Koha
2895 ==============================
2896 Setting up LDAP (Lightweight Directory Access Protocol) for Koha allows you to store all user information in a central database which is accessed both by your organisations Koha instance and for users to authenticate on other existing systems.
2898 LDAP is a protocol used for file discovery over networks and network authentication.
2900 LDAP configurations are powerful allowing you to customise how Koha and LDAP interact. LDAP can be configured so that new accounts created in LDAP can be synced down into the Koha database, additionally updates to the LDAP user account are synced down to the Koha database.
2902 However Koha cannot sync data up to the LDAP server, thus the data traffic when using LDAP is only one directional.
2904 Auth_By_Bind is set to 1 where a Microsoft Windows Active Directory system is in use in the LDAP database.
2906 **Before going through the steps to configure LDAP you will need the following
2907 information/actions from the organisation**
2909 * The organisation will need to open a port to allow access to their AD from the server.
2911 * Information on the access to the AD server (IP address/hostname, port, SSL info)
2913 * Information on the configuration of the AD server (relevant OUs, DCs, CN formats relative to usernames)
2915 * Mapping between AD fields and Koha fields, including defaults
2917 * Default values for things not provided by AD (categorycode, branchcode for example)
2919 * To authenticate a user do we bind as them (seems to be common for AD) or do we use an account and login with that and then check? If the latter, we'll need details of how to log in
2921 * Do the existing usernames in Koha match the usernames that we'll be using to look them up in AD? If so, good. If not, how will we deal with duplicate users?
2923 **Steps to set up LDAP with your Koha instance**
2926 1 In Linux terminal navigate to the directory containing the koha-conf.xml file which will either be in:
2927 * /etc/koha/sites/<instance-name>/
2931 2 Open the koha-conf.xml file with root permissions:
2932 sudo vi koha-conf.xml
2934 3 Scroll down to the line containing ‘<useldapserver>0</useldapserver>’ and change it to:
2935 <useldapserver>1</useldapserver>
2937 4 Then in the next line below write in the LDAP configurations below: Note all fields highlighted in yellow need to be replaced with the appropriate values for your organisations LDAP server.
2939 <ldapserver id="<ldapserverid>">
2941 <hostname><hostname></hostname>
2943 <base>dc=<domaincontroller>,dc=<domaincontroller></base>
2945 <user>cn=<nameofuser>, dc=<domaincontroller>,dc=<domaincontroller></user> <!--This is the username of user account with permissions to query the LDAP server -->
2947 <pass><password></pass> <!-- This is password of the user account with permissions to query the LDAP server-->
2949 <replicate><either0or1></replicate> <!-- add new users from LDAP to Koha database -->
2951 <update><either0or1></update> <!-- update existing users in Koha database -->
2953 <auth_by_bind><either0or1></auth_by_bind> <!-- set to 1 to authenticate by binding instead of password comparison, e.g., to use Active Directory -->
2955 <principal_name><principalname></principal_name> <!-- optional, for auth_by_bind: a printf format to make userPrincipalName from koha userid -->
2957 <mapping> <!-- match koha SQL field names to your LDAP record field names-->
2959 <firstname is="givenname"></firstname>
2961 <surname is="sn"></surname>
2963 <address is="postaladdress"></address>
2965 <city is="l">Athens, OH</city> <!-- Athens,OH is the default value for
2966 city of all users logging into Koha -->
2968 <zipcode is="postalcode"></zipcode>
2970 <branchcode is="branch">Central</branchcode>
2972 <userid is="uid"></userid>
2974 <password is="userpassword"></password>
2976 <email is="mail"></email>
2978 <categorycode is="employeetype">EM</categorycode>
2980 <phone is="telephonenumber"></phone>
2986 5 Save and exit the koha-conf.xml file
2988 6 Check the LDAP connection works by writing in:
2990 ldapsearch -H ldaps://host.name -s base -x -w "" -d 1
2993 .. note:: Note about hostname
2994 Hostname can either be a alphanumerical name or it can be the LDAP server IP address (its optional to write port number). By default the ldaps default port number is 636, whilst ldap default port number is 389
2997 .. note:: Note about the replicate and update fields
2998 The replicate LDAP config field for LDAP in the koha-conf.xml file allow the Koha database to be added to with a new borrower account whenever a user logs into Koha (either the staff client or OPAC) with their LDAP username and password (assuming the same username and password does not already exist in the Koha database).
3000 Whereas the update LDAP config field (in the same file allows) allows for user information in the LDAP database to be synced down to the Koha database.
3001 e.g. if someone gets married and their surname changes then the new surname only needs to be updated in the existing LDAP database and that will be synced down to the Koha database automatically if the update configuration is set to 1.
3004 About the mapping fields (the fields highlighted green)
3005 <city is="l">Athens, OH</city>
3007 The left hand column name (highlighted yellow) is the name of the column in the LDAP database.
3009 The column name inside quote marks (highlighted pink) is the name of the column in the Koha database. NOTE: This can be filled with any value if there is no equivalent column name in the Koha database as exists in the LDAP database.
3011 The value highlighted cyan is the default value for the specified Koha and LDAP columns. So in the above example all user records in the Koha and LDAP databases will by default have the city value of ‘Athens, OH’.
3013 Example of the LDAP configurations:
3015 <useldapserver>1</useldapserver><!-- see C4::Auth_with_ldap for extra configs you must add if you want to turn this on -->
3017 <ldapserver id="ldapserver" listenref="ldapserver">
3019 <hostname>ldaps://example.co.au</hostname>
3021 <base>ou=employees,dc=companya,dc=com,dc=au</base>
3023 <user></user> <!-- DN, if not anonymous -->
3025 <pass></pass> <!-- password, if not anonymous -->
3027 <auth_by_bind>1</auth_by_bind>
3029 <replicate>1</replicate> <!-- add new users from LDAP to Koha database -->
3031 <update>0</update> <!-- update existing users in Koha database -->
3033 <principal_name>ou=employees,dc=companya,dc=com,dc=au</principal_name>
3037 <userid is="uid" ></userid>
3039 <cardnumber is="uid" ></cardnumber>
3041 <email is="mail" ></email>
3043 <surname is="sn" ></surname>
3045 <firstname is="givenname" ></firstname>
3047 <categorycode is="1">EM</categorycode>
3049 <branchcode is="1">SYD</branchcode>
3057 The values in the mapping area are not always the same, and it depends on what is in your organisations LDAP database. For example some organisations do not use <userid> instead each user is only identified by the <email> field and so no <userid> is written.
3061 **Troubleshooting LDAP**
3063 The log that LDAP errors are printed to depends on several factors:
3065 If plack is not disabled then LDAP errors are displayed in the plack-error.log file
3066 If plack is disabled then the location that LDAP errors are printed to is either the opac-error.log file (if the user is logging into the OPAC) or the intranet-error.log file (if the user is logging into the staff client)
3067 All of these three log files are accessible in the following directory:
3069 /var/log/koha/<instance>/
3071 OCLC Connexion Gateway
3072 ======================
3074 Koha can be set to work with the OCLC Connextion Gateway. This allows
3075 libraries to use OCLC Connexion as their cataloging tool and simply send
3076 those records to Koha with a single click. The following instructions
3077 will help you set up the OCLC Connexion Gateway, if you have a system
3078 administrator you will want to consult with them on this process.
3080 .. _setting-up-oclc-service-on-koha-label:
3082 Setting up OCLC service on Koha
3083 ----------------------------------------------------
3085 First, you'll need to create a file somewhere on your system with
3086 configuration information. You could put this anywhere that is visible
3087 to the account that will be running the service.
3089 The file contains 11 lines. The first 6 will be about your Koha system:
3093 host: The IP address of your Koha server
3094 port: The port you want to use for the Connexion service. This port must be different from your SIP port, or any other service
3095 koha: The full URL of your staff client
3096 log: The location (full file specification) of your log for the service
3097 user: The default Koha username to use for importing
3098 password: The password that goes with that username
3100 The remaining lines describe how to do the staging:
3104 match: The name of the matching rule from your system to use
3105 overlay_action: "replace", "create_new", or "ignore"-- what to do if there is a match
3106 nomatch_action: "create_new" or "ignore"-- what to do if there is no match
3107 item_action: "always_add","add_only_for_matches","add_only_for_new", or "ignore" -- what to do with embedded 952 item data
3108 import_mode: "direct" or "stage"
3110 A sample file would look like this:
3116 log: /home/koha/koha-dev/var/log/connexion.log
3117 koha: http://kohastaff.myuniversity.edu
3118 user: koha_generic_staff
3121 overlay_action: replace
3122 nomatch_action: create_new
3126 When choosing an 'import\_mode' if you use "direct" then the staged
3127 record will be immediately imported into Koha, and should be searchable
3128 after your indexes catch up. If you choose "stage", then the record
3129 will be placed in a staged batch for you to later go the :ref:`Manage Staged
3130 MARC Records <staged-marc-record-management-label>` tool to finish the import.
3132 If you import multiple records, they'll be in the same batch, until that
3133 batch is imported, then a new batch will be created.
3135 In "direct" mode, each record will be in its' own batch.
3137 To start the service, run the script:
3141 /location/of/connexion/import/daemon/connexion_import_daemon.pl -d -c /location/of/config/file.cnf
3143 .. _setting-up-your-oclc-desktop-client-label:
3145 Setting up your OCLC desktop client
3146 -----------------------------------------------------------
3150 Screenshots are OCLC Connexion Client v.2.50, Koha v.3.12
3152 To set up the OCLC Connexion desktop client to connect to Koha, go to
3153 Tools > Options, then choose the Export tab.
3157 - Click the "Create..." button to set up a new destination, then choose
3158 "OCLC Gateway Export" and click OK.
3160 - Enter the following information:
3162 - "Host Name:" Your catalog’s appropriate IP address (from your
3163 :ref:`config file above <setting-up-oclc-service-on-koha-label>`)
3165 - "Port:" Your catalog's appropriate port number (from your
3166 :ref:`config file above <setting-up-oclc-service-on-koha-label>`)
3168 - "Login ID:" The cataloger's Koha login
3170 - "Password:" The cataloger's Koha password
3172 - "Notify Host Before Disconnect" = checked,
3174 - "Timeout" = 100, "Retries" = 3, "Delay" = 0 (zero),
3176 - "Send Local System Logon ID Password" = checked.
3180 - Select "OK" when finished, and you should see your new "Gateway
3181 Export" option listed (The catalog's IP address and port are blacked
3182 out in the following screenshot)
3184 Gateway Export Added
3186 - Click on "Record Characteristics" and make sure that the
3187 bibliographic records are using MARC21, UTF-8 Unicode, and click OK
3190 Record Characteristics
3192 You should be ready to go! To export a record from OCLC Connexion
3193 Client to Koha, just press F5 while the record is on-screen. The export
3194 dialog will pop up, and you'll see Connexion attempting to talk to Koha.
3195 You should get a message that the record was added or overlaid,
3196 including its biblio number, and a URL that you can copy into your web
3197 browser to jump straight to the record.
3199 .. _using-the-oclc-connexion-gateway-label:
3201 Using the OCLC Connexion Gateway
3202 ---------------------------------------------------
3204 Records can be exported from Connexion either in a batch or one by one.
3206 .. _exporting-records-one-by-one-label:
3208 Exporting records one by one
3209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3211 To export bibliographic records one by one, be sure your "Batch" options
3212 are correct: from the "Tools" menu, select "Options", and select the
3213 "Batch" tab. In the "Perform local actions in batch" area,
3214 "Bibliographic Record Export" should be unchecked
3218 When ready to export, from the "Action" menu, select "Export" or use the
3219 F5 key. You will see a screen similar to the following if the import is
3220 successful and if the record is new to the Catalog; you may copy & paste
3221 the resulting URL into your Koha catalog to see the new record.
3225 If the record was overlaid, you will see a message to that effect in the
3226 "OCLC Gateway Export Status" window
3230 .. _exporting-records-in-a-batch-label:
3232 Exporting records in a batch
3233 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3235 To export bibliographic records in a batch, be sure your "Batch" options
3236 are correct: from the "Tools" menu, select "Options", and select the
3237 "Batch" tab. In the "Perform local actions in batch" area,
3238 "Bibliographic Record Export" should be checkedOCLC
3242 When a record is ready to export, from the "Action" menu, select
3243 "Export" or use the F5 key, and it’s export status will be "ready."
3245 When ready to export the batch, from the "Batch" menu, select "Process
3246 batch" and check the appropriate "Path" and "Export" boxes
3250 The export will begin, and the bib records will be exported & imported
3251 into Koha one by one; you will see "OCLC Gateway Export Status" windows,
3252 as above, showing you the results of each export. That window will stay
3253 there until you select "Close," and then the next record’s export/import
3254 will begin. The process will continue until all records in the batch are
3255 completed. Then you may or may not see the Connexion Client export
3256 report (depending on your Client options for that).
3258 .. _items-in-oclc-label:
3261 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3263 If you'd like to create your item records in OCLC you can do so by
3264 addding a 952 for each item to the bib record you're cataloging. The
3265 :ref:`Item/Holdings Cataloging Guide <item/holdings-record-cataloging-guide-label>` will break down what
3266 subfields you can use in the 952, but at the minimum you want to have
3267 subfield 2, a, b, and y on your items.
3270 \\\\$2CLASSIFICATION$aHOMEBRANCHCODE$bHOLDINGBRANCHCODE$yITEMTYPECODE
3272 - The subfield 2 holds the classification code. This can be ddc for
3273 Dewey or lcc for Library of Congress or z for Custom. Other
3274 classification sources can be found in the :ref:`Classification
3275 Sources <classification-sources-label>` area in administration
3277 - Subfield a is your home library and needs to be the code for your
3278 home library, not the library name. You can find these codes in the
3279 :ref:`Libraries & Groups` administration area.
3281 - Subfield b is your holding library and needs to be the code for your
3282 holding library, not the library name. You can find these codes in
3283 the :ref:`Libraries & Groups` administration area.
3285 - Subfield y is your item type code. It needs to be the code, not the
3286 item type name. You can find these codes in the :ref:`Item
3287 Types <item-types-label>` administration area.
3289 952 \\\\$2ddc$aMAIN$bMAIN$yBOOK
3291 In addition to these required fields you can enter any other subfield
3292 you'd like. Most libraries will enter a call number in subfield o and a
3293 barcode in subfield p as well. Review the :ref:`Item/Holdings Cataloging
3294 Guide <item/holdings-record-cataloging-guide-label>` for a full list of subfields and values.
3302 -------------------------
3304 .. _custom-item-type/authorized-value-icons-label:
3306 Custom Item Type/Authorized Value Icons
3307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3309 **Question:** Can I have my own set of item type images (or authorized
3312 **Answer:**\ Absolutely. To add additional icons to your system you
3313 simply add a new directory to
3314 koha-tmpl/intranet-tmpl/prog/img/itemtypeimg/ and to
3315 koha-tmpl/opac-tmpl/prog/itemtypeimg and put your icons in the new
3316 directory. Your icons will show up in a new tab as soon as they are in
3321 Remember to put the icons in both places (on the OPAC and the
3324 .. _customizing-koha-images-label:
3326 Customizing Koha Images
3327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3329 **Question**: Can I customize the images in the OPAC?
3331 **Answer**: Absolutely. Koha comes with a series of original images that
3332 you can alter to meet your needs. The originals can be found in the
3333 misc/interface\_customization/ directory.
3335 .. _opac-display-fields-label:
3338 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3340 **Question**: What MARC fields print to the different OPAC screens in
3343 **Answer**: The XSLT preference must be set as follows for the following
3346 - :ref:`OPACXSLTResultsDisplay` = using XSLT
3349 - :ref:`OPACXSLTDetailsDisplay` = using XSLT
3352 - :ref:`DisplayOPACiconsXSLT` = show
3354 The OPAC Results page shows:
3370 The OPAC Details page shows:
3412 - plus all of the 5xx fields in the Notes tab at the bottom
3414 .. _subtitle-display-on-bib-records-label:
3416 Subtitle Display on Bib Records
3417 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3419 **Question**: How do I get the subtitle to display on the detail pages
3422 **Answer**: Subtitle display now depends on there being a :ref:`keyword
3423 mapping <keywords-to-marc-mapping-label>` for the MARC field in question. Adding a
3424 mapping for "subtitle" -> "245b" for an item's framework results in
3425 display of the subtitle in OPAC and staff client search and detail pages
3426 (although not in all instances where subtitles might be displayed, e.g.
3429 .. _show-patrons-the-barcodes-of-items-they-have-checked-out-label:
3431 Show patrons the barcodes of items they have checked out
3432 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3434 **Question**: Can patrons see the barcodes for the items they have
3437 **Answer**: Not by default, but with a few edits to the patron record
3438 you can make a barcode column appear on the patron's check out summary
3439 in the OPAC. You can set up a :ref:`patron
3440 attribute <patron-attribute-types-label>` with the value of SHOW\_BCODE and
3441 :ref:`authorized value <authorized-values-label>` of YES\_NO to make this happen.
3445 Then on the :ref:`patron's record set the value <editing-patrons-label>` for
3450 This will add a column to the check out summary in the OPAC that shows
3451 the patrons the barcodes of the items they have checked out.
3455 Clicking on the 'Overdue' tab will show only the items that are overdue.
3457 .. _circulation/notices-label:
3460 ----------------------------------
3462 .. _book-drop-date-label:
3465 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3467 **Question**: How is the book drop date is determined? Is it the last
3468 open date for the checkout branch? Is it today's date minus one? Can the
3469 book drop checkin date be set?
3471 **Answer**: If the library is closed for four days for renovations, for
3472 example, there would be more than one day needed for the book drop date.
3473 You will only have one book drop date and that will be the last day that
3474 the library open (determined by the holiday calendar) because there is
3475 no real way to know what day the books were dropped into the box during
3476 the 4 closed days. The only way to change the effective checkin date in
3477 book drop mode is to modify the calendar.
3479 .. _holds-to-pull-and-holds-queue-label:
3481 Holds to Pull and Holds Queue
3482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3484 **Question**: What is the difference between the :ref:`Holds
3485 Queue <holds-queue-label>` and :ref:`Holds to Pull <holds-to-pull-label>`?
3487 **Answer**: The holds to pull report gives a simple list of what holds
3488 need to be filled with available items. It should only be used in Koha
3489 installations where there is only one library.
3491 The holds queue tries to do the same thing, but in a 'smarter' way. This
3492 allows it to split up the list by library, consult the :ref:`transport cost
3493 matrix <transport-cost-matrix-label>` and refresh regularly to provide
3494 different pull lists to each library.
3496 .. _duplicate-overdue-notices-label:
3498 Duplicate Overdue Notices
3499 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3501 **Question**: Why are patrons getting two overdue notices?
3503 **Answer**: This tool takes all branches in the overdue rules and sent
3504 notifications to them. So, if you have a default rule & a branch rule,
3505 the notification will be generated twice. A quick fix is to discard
3506 "default rule" for instance.
3508 .. _printing-overdue-notices-label:
3510 Printing Overdue Notices
3511 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3513 **Question**: Can I print overdue notices for patrons without email
3516 **Answer**: Yes. The :ref:`overdue notice cron job <overdue-notice-label>`
3517 has a setting to generate the overdue notices as HTML for printing. An
3518 example of this usage would be:
3522 overdue_notices.pl -t -html /tmp/noticedir -itemscontent issuedate,date_due,title,barcode,author
3524 In this example, we wanted to use only certain item fields in our
3525 notices, so we specified itemscontent fields in the cron entry; that's
3526 not a requirement for the feature.
3528 The command line needs to specify a web-accessible directory where the
3529 print notices will go -- they get a filename like
3530 notices-2009-11-24.html (or holdnotices-2009-11-24.html). The overdue
3531 notice itself can be formatted to fit a Z-mailer. Within the notice
3532 file, the text is spaced down or over to where it will print properly on
3533 the form. The script has code that wraps around the notice file to tell
3534 the HTML to obey the formatting, and to do a page break between notices.
3535 That's so that when staff print it out, they get one per page. We had to
3536 add an extra syspref (:ref:`PrintNoticesMaxLines`)
3537 to specify page length because our client allows a \_lot\_ of checkouts
3538 which meant some notices were running onto multiple pages. That syspref
3539 says to truncate the print notice at that page length and put in a
3540 message about go check your OPAC account for the full list.
3542 The print and email overdues use the same notice file. The print notices
3543 for holds are different -- there's a separate HOLD\_PRINT notice file
3544 and the system uses it if there's no email address. Then a nightly cron
3545 job runs to gather those up from the message queue and put them in an
3546 HTML file in the notice directory, as above.
3548 The cron entry is gather\_print\_notices.pl /tmp/noticedir
3550 .. _unable-to-renew-items-label:
3552 Unable to Renew Items
3553 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3555 **Question**: We're trying to renew some items for our patron. One of
3556 the items is on hold and ineligible for renewal, but the other two items
3557 refuse to renew even though they should be eligible. When I try to use
3558 the override renewal limit, it just returns a little message that says
3559 "renewal failed". Any idea what's going on here?
3561 **Answer**: At the very least you will need to set an absolute :ref:`default
3562 circulation rule <circulation-and-fine-rules-label>`. This rule should be set for the
3563 default itemtype, default branchcode and default patron category. That
3564 will catch anyone who doesn't match a specific rule. Patrons who do not
3565 match a specific rule will get blocked from placing holds or renewing
3566 items, since there was no baseline number of holds or renewals to
3569 .. _unable-to-place-holds-label:
3571 Unable to Place Holds
3572 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3574 **Question**: Why can't I place holds when I have all of the preferences
3577 **Answer**: You probably need to set a default circulation rule. At the
3578 very least you will need to set an default circulation rule. This rule
3579 should be set for all item types, all branches and all patron
3580 categories. That will catch all instances that do not match a specific
3581 rule. When checking out if you do not have a rule for the default
3582 branch, default item and default patron category then you may see
3583 patrons getting blocked from placing holds.
3585 .. _keyboard-shortcuts-label:
3588 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3590 **Question**: Do I have to use my mouse to access the checkout, checkin
3591 and cataloging tabs at the top of the circulation pages?
3593 **Answer**: You can jump between the tabs on the quick search box at the
3594 top of the screen by using the following hot keys (if the tab is
3597 - jump to the catalog search with Alt+Q
3599 - jump to the checkout with Alt+U
3601 - this will not work for Mac user
3603 - jump to the checkin with Alt+R
3607 Mac users use the OPTION button in place of ALT
3609 .. _sms-notices/messages-label:
3611 SMS Notices/Messages
3612 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3614 **Question**: I want Koha to send notices via SMS, what do I need to do?
3616 **Answer**: First you need to choose a SMS service to use with Koha.
3617 There is a list available here:
3618 http://search.cpan.org/search?query=sms%3A%3Asend&mode=all Not all SMS
3619 services available to libraries have Perl drivers, so be sure to check
3620 this list to see if the provider you're considering is listed. If not
3621 you want to ask your provider if they have a Perl module, if not you
3622 should consider another service. Some common options in the US (that
3623 have Perl drivers) are:
3625 - AQL (`www.aql.com <http://www.aql.com>`__)
3627 - Wadja (`wadja.com <http://wadja.com>`__)
3629 - Ipipi (`ipipi.com <http://ipipi.com>`__)
3633 - SMSDiscount (`smsdiscount.com <http://smsdiscount.com>`__)
3637 **Question**: What about in India?
3639 **Answer**: India does not yet have too many options here. This is
3640 partly due to the Telecom regulatory authority's (TRAI) stipulations
3641 about transactional SMSes and limits on the number of SMSes that may be
3642 sent / received per users per day. India specific drivers include:
3644 - Unicel Technologies Pvt Ltd (`unicel.in <http://unicel.in>`__)
3646 .. _cataloging-label:
3649 ------------------------
3651 .. _authority-fields-label:
3654 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3656 **Question:**\ Why can't I edit 1xx, 6xx, or 7xx fields in my catalog
3659 **Answer:** These fields are authority controlled and you probably have
3660 the :ref:`BiblioAddsAuthorities` set to "Don't
3661 allow". When it is set to "Don't allow" these fields will be locked and
3662 require you to search for an existing authority record to populate the
3663 field with. To allow typing in these authority fields set
3664 :ref:`BiblioAddsAuthorities` to 'Allow'.
3668 Fields affected by this preference will show a lock symbol in them
3672 .. _koha-to-marc-mapping-label:
3674 Koha to MARC Mapping
3675 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3677 **Question**: What's the relationship between 'Koha to MARC Mapping' and
3678 'MARC Bibliographic Frameworks'?
3680 **Answer**: Mapping can be defined through 'MARC Bibliographic
3681 Frameworks' OR 'Koha to MARC Mapping'. 'Koha to MARC Mapping' is just a
3682 shortcut to speed up linkage. If you change a mapping in one of these
3683 modules, the mapping will change in the other as well. (In other words,
3684 the two modules 'overwrite' each other in order to prevent conflicts
3685 from existing in Koha).
3687 .. _number-of-items-per-bib-record-label:
3689 Number of Items Per Bib Record
3690 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3692 **Question**: Is there a limit on the number of items I can attach to a
3695 **Answer**: There is no explicit limit to the number of items you can
3696 attach to a bibliographic record, but if you attach enough of them, your
3697 MARC record will exceed the maximum file size limit for the ISO 2709
3698 standard, which breaks indexing for that record. I've found this occurs
3699 somewhere between 600 and 1000 items on a 'normal' bibliographic record.
3701 .. _analytics-label:
3704 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3706 **Question**: I am using the
3707 :ref:`EasyAnalyticalRecords` feature, but my links
3708 in the OPAC and Staff Client to 'Show Analytics' are not working.
3710 **Answer**: If you plan on using
3711 :ref:`EasyAnalyticalRecords` you will want to make
3712 sure to set your :ref:`UseControlNumber` preference to
3713 "Don't use," this will prevent broken links.
3715 .. _acquisitions-label:
3718 --------------------------
3720 .. _planning-categories-label:
3723 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3725 **Question**: What is a planning category?
3727 **Answer**: When you plan in advance for the way your budget is going to
3728 be spent, you initially plan for how it's going to be spent over time,
3729 that's the most natural thing to do.
3731 So you plan for $1000 in Jan. $1000 in Feb., $3000 in March, etc. You
3732 can basically do the same thing with a list of values in lieu of the
3735 Say you have a list like this one:
3749 The list is meant to represent when the books acquired where published.
3750 Then you plan for it, saying: we went to spend at list 40% of our
3751 budgets on books published less than a year ago, 10% on books more than
3754 Upon acquiring new material, you'll be able to select, for a given item,
3755 a value from this list in a drop down. Then, after the material has been
3756 acquired, at the end of the year, you'll be able to compare the goals
3757 set, with what's been achieved.
3762 -------------------------
3764 .. _advanced-patterns-label:
3767 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3769 **Question**: What is the 'inner counter' on the advanced serials
3772 **Answer**: I think it is better to give an example to understand this :
3774 Example for a monthly subscription :
3776 - First issue publication date : April 2010
3778 - Numbering : No {X}, year {Y}
3780 - First issue : No 4, year 2010
3782 For the year Y : you will want the year change on January 2011
3784 So, the advanced pattern for Y will be :
3790 - When more than 9999999
3798 Year is going to change after 12 received issues from April 2010, that
3799 is in April 2011 if you don't set inner counter. Set inner counter to 3
3800 will say to Koha : change year after 12-3 = 9 received issues.
3802 Inner counter says to Koha to take into account the first issues of the
3803 year, even if they are not received with Koha. If you begin with first
3804 issue of the year write nothing or 0.
3809 -------------------------
3811 .. _define-codes-stored-in-db-label:
3813 Define Codes Stored in DB
3814 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3816 .. _fines-table-label:
3819 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3821 **Question:** What do the codes in the accounttype field in the
3822 accountlines table stand for?
3826 - A = Account management fee
3834 - FU = Overdue, still acccruing
3838 - LR = Lost item returned/refunded
3848 .. _statistics-table-label:
3851 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3853 **Question:**\ What are the possible codes for the type field in the
3860 - Registers if an item that had been checked out to a statistics
3861 patron (category type = 'X') is returned
3875 - The XXX stores different types of fee credits, so a query to catch
3876 them all would include a clause like "type LIKE 'Credit%'"
3878 .. _reserves-table-label:
3881 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3883 **Question**: What are the possible codes for the found field in the
3884 reserves and old\_reserves tables?
3888 - NULL: means the patron requested the 1st available, and we haven't
3891 - T = Transit: the reserve is linked to an item but is in transit to
3894 - W = Waiting: the reserve is linked to an item, is at the pickup
3895 branch, and is waiting on the hold shelf
3897 - F = Finished: the reserve has been completed, and is done
3899 .. _reports-dictionary-table-label:
3901 Reports Dictionary Table
3902 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3904 **Question**: What are the possible codes for the area field in the
3905 reports\_dictionary table?
3919 .. _messages-table-label:
3922 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3924 **Question**: What are the possible codes for the message\_type field in
3929 - L = For Librarians
3931 - B = For Patrons/Borrowers
3933 .. _serial-table-label:
3936 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3938 **Question**: What are the possible codes for the status field in the
3959 - 41 = Missing (not received)
3961 - 42 = Missing (sold out)
3963 - 43 = Missing (damaged)
3965 - 44 = Missing (lost)
3967 .. _borrowers-table-label:
3970 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3972 **Question**: What are the possible codes for the privacy field in the
3983 .. _messaging-preferences-label:
3985 Messaging Preferences
3986 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3988 **Question**: What are the possible codes in the message\_attribute\_id
3989 field in the borrower\_message\_preferences table?
3993 - 2 = advanced notice
4003 .. _runtime-parameters-label:
4006 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4008 **Question**: Is there a way to filter my custom SQL reports before they
4011 **Answer**: If you feel that your report might be too resource intensive
4012 you might want to consider using runtime parameters to your query.
4013 Runtime parameters basically make a filter appear before the report is
4014 run to save your system resources.
4016 There is a specific syntax that Koha will understand as 'ask for values
4017 when running the report'. The syntax is <<Question to
4018 ask\|authorized\_value>>.
4020 - The << and >> are just delimiters. You must put << at the beginning
4021 and >> at the end of your parameter
4023 - The 'Question to ask' will be displayed on the left of the string to
4026 - The authorized\_value can be omitted if not applicable. If it
4027 contains an authorized value category, or branches or itemtype or
4028 categorycode or biblio\_framework, a list with the Koha authorized
4029 values will be displayed instead of a free field Note that you can
4030 have more than one parameter in a given SQL Note that entering
4031 nothing at run time won't probably work as you expect. It will be
4032 considered as "value empty" not as "ignore this parameter". For
4033 example entering nothing for : "title=<<Enter title>>" will display
4034 results with title='' (no title). If you want to have to have
4035 something not mandatory, use "title like <<Enter title>>" and enter a
4036 % at run time instead of nothing
4040 - SELECT surname,firstname FROM borrowers WHERE branchcode=<<Enter
4041 patrons library\|branches>> AND surname like <<Enter filter for
4042 patron surname (% if none)>>
4044 - SELECT \* FROM items WHERE homebranch = <<Pick your
4045 branch\|branches>> and barcode like <<Partial barcode value here>>
4047 - SELECT title , author FROM biblio WHERE frameworkcode=<<Enter the
4048 frameworkcode\|biblio\_framework>>
4052 To generate a date picker calendar to the right of the field when
4053 running a report you can use the 'date' keyword like this: <<Enter
4060 You have to put "%" in a text box to 'leave it blank'. Otherwise, it
4061 literally looks for "" (empty string) as the value for the field.
4065 In addition to using any authorized value code to generate a
4066 dropdown, you can use the following values as well: Framework codes
4067 (biblio\_framework), Branches (branches), Item Types (itemtypes) and
4068 Patron Categories (categorycode). For example a branch pull down
4069 would be generated like this <<Branch\|branches>>
4073 .. _results-limited-label:
4076 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4078 **Question**: When I download my report it's limited to 10,000 results,
4079 how do I get all of the results to download?
4081 **Answer**: There is a limit of 10,000 records put on SQL statements
4082 entered in Koha. To get around this you want to add 'LIMIT 100000' to
4083 the end of your SQL statement (or any other number above 10,000.
4085 .. _searching-label:
4088 --------------------------
4090 .. _advanced-search-label:
4093 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4095 .. _scan-indexes-label:
4098 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4100 **Question**: What does 'scan indexes' on the advanced search page mean?
4102 **Answer**: When you choose an index, enter a term, click 'scan indexes'
4103 and do the search, Koha displays the searched term and the following
4104 terms found in this index with the number of corresponding records That
4105 is search is not made directly in the catalog, but first in the indexes
4106 It works only for one index at once, and only with no limit in Location
4107 (All libraries needed)
4109 .. _searching-for-terms-that-start-with-a-character-label:
4111 Searching for Terms that Start With a Character
4112 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4114 **Question**: How do I search for all titles that start with the letter
4117 **Answer**: You can choose to search for things that start with a
4118 character or series of characters by using the CCL 'first-in-subfield'
4120 - example: ti,first-in-subfield=C
4122 .. _wildcard-searching-label:
4125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4127 **Question**:What is the difference between a keyword search using the
4128 '\*' (asterisk) versus a keyword search using the '%' (percent)? Both
4129 work in the catalog, but return different sets. Why?
4131 **Answer**: A wildcard is a character (\*,?,%,.) that can be used to
4132 represent one or more characters in a word. Two of the wildcard
4133 characters that can be used in Koha searches are the asterisk ('\*') and
4134 the percent sign ('%'). However, these two characters act differently
4135 when used in searching.
4137 The '\*' is going to force a more exact search of the first few
4138 characters you enter prior to the '\*'. The asterisk will allow for an
4139 infinite number of characters in the search as long as the first few
4140 characters designated by your search remain the same. For example,
4141 searching for authors using the term, Smi\*, will return a list that may
4142 include Smith, Smithers, Smithfield, Smiley, etc depending on the
4143 authors in your database.
4145 The '%' will treat the words you enter in the terms of "is like". So a
4146 search of Smi% will search for words like Smi. This results in a much
4147 more varied results list. For example, a search on Smi% will return a
4148 list containing Smothers, Smith, Smelley, Smithfield and many others
4149 depending on what is your database.
4151 The bottom line in searching with wildcards: '\*' is more exact while
4152 '%' searches for like terms.
4154 .. _title-searching-label:
4157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4159 **Question**: Why does my Zebra title search for 'Help' not turn up 'The
4160 help' in the first pages of results?
4162 **Answer**: When doing a title search, you actually want to search for
4163 the title (i.e., 'the help' rather than just 'help'), and it will bubble
4164 right up to the top. If you're just searching for 'help' then the
4165 relevance ranking is going to affect the results you see.
4167 When it comes to relevance in Zebra, here's what's happening. First, the
4168 search is done. If you search for the title "help", then any title that
4169 has "help" in it comes back. Then from those records, separately, it
4170 does relevance on the \*whole\* record. The more your word appears, the
4171 more relevant, and some MARC tags are worth more points than others. So
4172 a self-help book with 505 notes where "help" appears a \*lot\* will be
4173 at the top, regardless of keyword or title.
4175 But when you add a \*second word\*, that helps it figure things out, as
4176 it's weighing the relevance of both words and the phrase. Because of the
4177 way relevance works, if you search "the help", then "the help" or "the
4178 help I need" are more relevant than "the way to help", because they
4179 appear together in order. Likewise, "help the girl" would be lower
4180 relevance, because it's out of order, and "help for the homeless" would
4181 be lower still, as they're out of order, and apart.
4183 The moral of the story is that single word searches, particularly on
4184 common words, will always struggle a bit; it can't evaluate relevance
4185 well, because you've not given it enough input.
4187 .. _enhanced-content-label:
4190 ------------------------------------------
4192 .. _frbrizing-content-label:
4195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4197 **Question:**\ At our public library we are running a Koha installation
4198 and we've tried to turn on all the nice functionalities in Koha such as
4199 the frbrising tool, but do not get the same result as Nelsonville public
4202 **Answer:**\ In fact, this feature is quite tricky to make that right.
4203 First it looks at XISBN service. And then search in your database for
4204 that ISBN. So both XISBN and your internal ISBN (in biblio table) have
4205 to be normalized. You could therefore use the script
4206 misc/batchupdateISBNs.pl (it removes all the - in your local ISBNs)
4211 ~~~~~~~~~~~~~~~~~~~~
4213 .. _all-amazon-content-label:
4216 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4218 **Question**: I have all of the Amazon preferences turned on and have
4219 entered both of my keys, but none of the content appears in my system,
4222 **Answer**: Amazon's API checks your server time on all requests and if
4223 your server time is not set properly requests will be denied. To resolve
4224 this issue be sure to set your system time appropriately. Once that
4225 change in made Amazon content should appear immediately.
4227 On Debian the the command is *date -s "2010-06-30 17:21"* (with the
4228 proper date and time for your timezone).
4230 .. _system-administration-label:
4232 System Administration
4233 --------------------------------------
4235 .. _errors-in-zebra-cron-label:
4237 Errors in Zebra Cron
4238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4240 **Question**: I am noticing some errors in the
4241 koha-zebradaemon-output.log file. When new records are added it takes a
4242 bit longer to index than we think they should. Running rebuild zebra is
4243 often faster. Zebra ends up indexing and search works, but I am
4244 concerned about the errors. Any ideas?
4246 **Answer**: Rebuild\_zebra.pl -r deletes all of the files in the Zebra
4247 db directories (such as reci-0.mf) and then recreates them. Thus,
4248 permissions will be lost, and the files will be owned by the user who
4249 ran rebuild\_zebra.pl. If one rebuilds the zebra indexes as root, the
4250 daemons, which typically run under the user Koha, will not be able to
4251 update the indexes. Thus, it's important then that the zebra rebuilds
4252 are put in the cronjob file of the user Koha, and not root. Also
4253 important is that other users, such as root, don't manually execute
4256 If one desires that another user be able to execute rebuild\_zebra.pl,
4257 he should be given the permission to execute 'sudo -u Koha
4258 .../rebuild\_zebra.pl,' (if you want to do this, you also have to edit
4259 the sudoers file to pass the PERL5LIB variable with the env\_keep option
4260 as by default sudo strips away almost all environment variables). Or, as
4261 root user, one can use a simple 'su koha' and then the rebuild\_zebra.pl
4264 I've also tried to set the sticky bit on rebuild\_zebra.pl, but for
4265 whatever reason it didn't seem to work due to some problem with the
4266 PERL5LIB variable that I wasn't able to figure. That seems to me the
4267 easiest thing to do, if anybody has any idea how to make it work. If it
4268 worked and were the default, I think it would help folks to avoid a
4269 great deal of the problems that come up with zebra.
4271 .. _making-z39.50-target-public-label:
4273 Making Z39.50 Target Public
4274 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4276 **Question**: Could someone tell me the exact steps I need to take to
4277 configure Zebra to expose my Koha 3 db as a public Z39.50 service?
4279 **Answer**: Edit the KOHA\_CONF file that your Koha is using. Uncomment
4280 the publicserver line like:
4282 <!-- <listen id="publicserver" >tcp:@:9999</listen> -->
4286 <listen id="publicserver" >tcp:@:9999</listen>
4288 Then restart zebasrv and connect on the port specified (9999).
4290 .. _shelving-location-authorized-values-label:
4292 Shelving Location Authorized Values
4293 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4295 **Question**: When editing an item, the new shelving location I created
4296 is not showing up by default in the items where I assigned it to.
4298 **Answer**: This is because you created the new shelving location with a
4299 code value of 0 (zero) Just FYI the system interprets authorized values
4300 of 0 as equaling a null so when you edit a record in cataloging where
4301 the authorized value in a field was assigned where the code was 0, the
4302 value displays as null in the item editor (or MARC editor) instead of
4303 the value the library meant it to be.
4305 .. _why-do-i-need-authorized-values?-label:
4307 Why do I need Authorized Values?
4308 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4310 **Question**: Why would I want to define authorized values for MARC
4313 **Answer**: Authorized Values create a 'controlled vocabulary' for your
4314 staff. As an example, let us assume that your Koha installation is used
4315 by several libraries, and you use MARC 21. You might want to restrict
4316 the 850a MARC subfield to the institution codes for just those
4317 libraries. In that case, you could define an authorized values category
4318 (perhaps called "INST") and enter the institution codes as the
4319 authorized values for that category.
4323 Koha automatically sets up authorized value categories for your item
4324 types and branch codes, and you can link these authorized values to
4325 MARC subfields when you set up your MARC tag structure.
4327 .. _how-do-i-clean-up-the-sessions-table?-label:
4329 How do I clean up the sessions table?
4330 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4332 **Question**: Is there a periodic job that can be run to cull old
4333 sessions from the table? We don't want to backup all the useless session
4336 **Answer**: You can run :ref:`cleanup database cron job <clean-up-database-label>`.
4338 Or just before doing a backup command (mysqldump), you can truncate
4343 mysql -u<kohauser -p<password <koha-db-name -e 'TRUNCATE TABLE sessions'
4348 ---------------------------
4350 .. _barcode-scanners-label:
4353 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4355 **Question**: What barcode scanners have been known to work with Koha?
4357 **Answer**: The simple rule of thumb is, does it act like a keyboard
4358 device?, if so, it will work. (i.e. can you take the scanner, scan a
4359 barcode and have it show up in a text editor, if so, it will work.)
4361 The main points to check are that it connects to your PC conveniently
4362 (can be USB or "keyboard wedge" which means it connects in line with the
4363 keyboard, which is useful with older computers), and that it scans the
4364 barcode type that you are using.
4366 It is a good idea to test some 'used' barcodes if you have any, to see
4367 whether the scanner can read scuffed or slightly wrinkled ones
4368 successfully. Most scanners are capable of reading several barcode types
4369 - there are many, and the specification should list the ones it can
4370 read. You may need to adjust settings slightly, such as prefix and
4371 suffix characters, or whether you want to send an 'enter' character or
4374 One more tip - some can be set 'always on' and may come with a stand,
4375 some have triggers under the handle, some have buttons on top, some are
4376 held like a pen. Think about the staff working with the hardware before
4377 choosing, as a button in the wrong place can be very awkward to use.
4382 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
4384 .. _printers-used-by-koha-libraries-label:
4386 Printers used by Koha libraries
4387 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4389 - POS-X receipt printer
4391 - Star Micronics printer (exact model unknown) with a generic/plain
4394 - Star SP2000 (Nelsonville)
4396 - Star TSP-100 futurePRINT (Geauga)
4398 - "I know there have been a lot of questions on receipt printers so
4399 I thought I'd pass on my findings. We have been testing the Star
4400 TSP-100 futurePRINT. I found this print to be VERY easy to
4401 configure for Koha. I was even able to customize the print job by
4402 adding our system logo (a .gif) to the top of every receipt. Also
4403 with a bitmap created in Paint was able to add a message at the
4404 bottom of each receipt with the contact information, hours and
4405 website for the library that the materials were checked out at."
4407 - Epson TM 88 IIIP thermal receipt printers
4411 - 1x1 labels using a Dymolabelwriter printer
4413 .. _braille-support-label:
4416 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4418 **Question**: Are there any braille embosser or printer which has
4419 inbuilt braille converter and it is accessible with UNIX environment?
4421 **Answer**: You may want to look into BRLTTY
4422 (http://www.emptech.info/product_details.php?ID=1232).
4424 .. _additional-support-label:
4427 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4429 - http://www.nexpresslibrary.org/go-live/configure-your-receipt-printers/
4434 .. _amazon-lookup-script-for-koha-libraries-label:
4436 Amazon lookup script for Koha libraries
4437 --------------------------------------------------------
4439 We order most of our materials from Amazon, so I've been looking for a
4440 convenient way to tell if a book under consideration is in our catalog
4443 Greasemonkey & a custom user script fit the bill nicely:
4445 - https://addons.mozilla.org/en-US/firefox/addon/748
4447 - http://userscripts.org/scripts/show/56847
4451 - Like most scripts, this one was designed to work with Firefox; I
4452 haven't explored getting it to work with other browsers.
4454 - I'm not a JavaScript programmer -- this was adapted from others'
4455 work. Just a few lines would have to be changed to get the script to
4456 work with your catalog.
4458 - It depends on the existence of ISBN for the item in question, so
4459 movies, older books, etc. would not work.
4461 Others have added all sorts of bells & whistles: XISBN lookups to search
4462 for related titles, custom messages based on the status of items (on
4463 order, on hold, etc.), ... just search the UserScripts site for Amazon +
4464 library. For a later date!
4466 .. _keyword-clouds-label:
4469 -----------------------------------------
4471 In addition to the traditional tag cloud available in Koha, there is a
4472 way to generate clouds for popular subjects within Koha.
4474 The :ref:`Author/Subject Cloud cron job <subject/author-clouds-label>` is used to help
4475 with this process. This cron job sends its output to files.
4477 - /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
4479 - /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html
4481 This means that you can produce clouds for authors, collective author,
4482 all kind of subjects, classifications, etc. And since it works on zebra
4483 indexes, it is quick, even on large DBs. Tags clouds are sent to files.
4484 It's up to library webmaster to deal with those files in order to
4485 include them in :ref:`OPACMainUserBlock <opacmainuserblock-label>`, or include
4486 them into their library CMS.
4488 Some libraries even send the file into a Samba shared folder where
4489 webmaster take them, eventually clean them a little bit before
4490 integrating them into navigation widgets or pages.
4492 .. _newest-titles-pulldown-label:
4494 Newest Titles Pulldown
4495 ---------------------------------------------
4497 Often we want to add a way for our patrons to do searches for the newest
4498 items. In this example I'll show you how to create a pull down menu of
4499 the newest items by item type. These tips will work (with a couple
4500 changes) for collection codes or shelving locations as well.
4502 First, it's important to note that every link in Koha is a permanent
4503 link. This means if I do a search for everything of a specific item type
4504 sorted by the acquisitions date and bookmark that URL, whenever I click
4505 it I'll see the newest items of that type on the first few pages of the
4508 I took this knowledge and wrote a form takes this functionality in to
4509 consideration. It basically just does a search of your Koha catalog for
4510 a specific item type and sorts the results by acquisitions date.
4512 The first thing I did was write a MySQL statement to generate a list of
4513 item types for me - why copy and paste when you can use the power of
4518 select concat('<option value=\"mc-itype:', itemtype, '\">',description,'</option>') from itemtypes
4520 The above looks at the itemtypes table and slaps the necessary HTML
4521 around each item type for me. I then exported that to CSV and opened it
4522 in my text editor and added the other parts of the form.
4526 <p><strong>New Items</strong></p>
4527 <p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl">
4528 <input name="idx" value="kw" type="hidden">
4529 <input name="sort_by" value="acqdate_dsc" type="hidden">
4530 <input name="do" value="OK" type="hidden">
4531 <select name="limit" onchange="this.form.submit()">
4532 <option>-- Please choose --</option>
4533 <option value="mc-itype:BOOK">Book</option>
4534 <option value="mc-itype:BOOKCD">Book on CD</option>
4535 <option value="mc-itype:DVD">DVD</option>
4536 <option value="mc-itype:LRG_PRINT">Large print book</option>
4537 <option value="mc-itype:MAGAZINE">Magazine</option>
4538 <option value="mc-itype:NEWSPAPER">Newspaper</option>
4539 <option value="mc-itype:VIDEO">Videocassette</option>
4544 Now, what does all of that mean? The important bits are these:
4546 First the starting of the form.
4550 <p><form name="searchform" method="get" action="/cgi-bin/koha/opac-search.pl">
4552 This tells the browser to take any value selected and put it at the end
4553 of this http://YOURSITE/cgi-bin/koha/opac-search.pl. If you want to
4554 embed this form on your library website (and not on your OPAC) you can
4555 put the full OPAC URL in there.
4557 Next, there is a hidden value that is telling the search to sort by
4558 acquisitions date descending (newest items at the top):
4562 <input name="sort_by" value="acqdate_dsc" type="hidden">
4564 And finally you have an option for each item type you want people to
4569 <option value="mc-itype:BOOK">Book</option>
4571 These options each include the string "mc-itype:" which tells Koha to do
4572 an item type search.
4574 Once you have all of that in place you can copy and paste the form to
4575 somewhere on your OPAC. The `Farmington Public Libraries
4576 OPAC <http://catalog.farmingtonlibraries.org>`__ has a few examples of
4579 .. _cataloging-and-searching-by-color-label:
4581 Cataloging and Searching by Color
4582 ----------------------------------------------------
4584 One of the icon sets installed in Koha includes a series of colors. This
4585 set can be used to catalog and search by color if you'd like. This guide
4586 will walk you use changing collection code to color in Koha so that you
4589 The following SQL could be used to add these colors to the CCODE
4590 authorized value category in a batch. If you wanted to use these colors
4591 for another authorized value you'd have to edit this to use that
4596 insert into authorised_values (category, authorised_value, lib,
4597 lib_opac, imageurl) values ('CCODE','000000','Black','','colors/000000.png');
4598 insert into authorised_values (category, authorised_value, lib,
4599 lib_opac, imageurl) values ('CCODE','66cc66','Bright Green','','colors/66cc66.png');
4600 insert into authorised_values (category, authorised_value, lib,
4601 lib_opac, imageurl) values ('CCODE','99cc33','Olive','','colors/99cc33.png');
4602 insert into authorised_values (category, authorised_value, lib,
4603 lib_opac, imageurl) values ('CCODE','3333cc','Dark Blue','','colors/3333cc.png');
4604 insert into authorised_values (category, authorised_value, lib,
4605 lib_opac, imageurl) values ('CCODE','006600' ,'Dark Green','','colors/006600.png');
4606 insert into authorised_values (category, authorised_value, lib,
4607 lib_opac, imageurl) values ('CCODE','6600cc','Plum','','colors/6600cc.png');
4608 insert into authorised_values (category, authorised_value, lib,
4609 lib_opac, imageurl) values ('CCODE','6666cc','Purple','','colors/6666cc.png');
4610 insert into authorised_values (category, authorised_value, lib,
4611 lib_opac, imageurl) values ('CCODE','9999cc','Light Purple','','colors/9999cc.png');
4612 insert into authorised_values (category, authorised_value, lib,
4613 lib_opac, imageurl) values ('CCODE','660000' ,'Burgundy','','colors/660000.png');
4614 insert into authorised_values (category, authorised_value, lib,
4615 lib_opac, imageurl) values ('CCODE','663333' ,'Brown','','colors/663333.png');
4616 insert into authorised_values (category, authorised_value, lib,
4617 lib_opac, imageurl) values ('CCODE','990000' ,'Red','','colors/990000.png');
4618 insert into authorised_values (category, authorised_value, lib,
4619 lib_opac, imageurl) values ('CCODE','996633' ,'Tan','','colors/996633.png');
4620 insert into authorised_values (category, authorised_value, lib,
4621 lib_opac, imageurl) values ('CCODE','999999' ,'Gray','','colors/999999.png');
4622 insert into authorised_values (category, authorised_value, lib,
4623 lib_opac, imageurl) values ('CCODE','cc66cc','Pink','','colors/cc66cc.png');
4624 insert into authorised_values (category, authorised_value, lib,
4625 lib_opac, imageurl) values ('CCODE','cc99cc','Bubble Gum','','colors/cc99cc.png');
4626 insert into authorised_values (category, authorised_value, lib,
4627 lib_opac, imageurl) values ('CCODE','cc3333' ,'Orange','','colors/cc3333.png');
4628 insert into authorised_values (category, authorised_value, lib,
4629 lib_opac, imageurl) values ('CCODE','cc6666' ,'Peach','','colors/cc6666.png');
4630 insert into authorised_values (category, authorised_value, lib,
4631 lib_opac, imageurl) values ('CCODE','cc9999' ,'Rose','','colors/cc9999.png');
4632 insert into authorised_values (category, authorised_value, lib,
4633 lib_opac, imageurl) values ('CCODE','cccc00' ,'Gold','','colors/cccc00.png');
4634 insert into authorised_values (category, authorised_value, lib,
4635 lib_opac, imageurl) values ('CCODE','ffff33' ,'Yellow','','colors/ffff33.png');
4636 insert into authorised_values (category, authorised_value, lib,
4637 lib_opac, imageurl) values ('CCODE','ffffcc','Cream','','colors/ffffcc.png');
4638 insert into authorised_values (category, authorised_value, lib,
4639 lib_opac, imageurl) values ('CCODE','ffffff','White','','colors/ffffff.png');
4641 If you would like to choose the colors manually you can do that via the
4642 :ref:`Authorized Values` administration area.
4646 Next you'll want to :ref:`update the frameworks <marc-bibliographic-frameworks-label>` so
4647 that the 952$8 (if you're using collection code) label to says Color.
4649 Once you have that in place you can start to catalog items by color.
4651 Finally you'll want to add the following JQuery to your preferences so
4652 that it will relabel 'Collection' to 'Color'
4654 :ref:`IntranetUserJS`
4658 $(document).ready(function(){
4659 $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
4660 $("#holdings th:contains('Collection')").text("Color");
4667 $(document).ready(function(){
4668 $("#advsearch-tab-ccode a:contains('Collection')").text("Color");
4669 $('#item_ccode').text("Color");
4672 Koha and Your Website
4673 =====================
4675 This appendix will include tips for integrating Koha in to your library
4678 .. _koha-search-on-your-site-label:
4680 Koha search on your site
4681 -------------------------------------------
4683 Often you'll want to add a Koha search box to your library website. To
4684 do so, just copy and paste the following code in to your library website
4685 and update the YOURCATALOG bit with your catalog's URL and you're set to
4690 <form name="searchform" method="get" action="http://YOURCATLOG/cgi-bin/koha/opac-search.pl" id="searchform">
4691 <input id="transl1" name="q" type="text"><p>
4692 <select name="idx" id="masthead_search">
4693 <option value="kw">Keyword</option>
4694 <option value="ti">Title</option>
4695 <option value="au">Author</option>
4696 <option value="su">Subject</option>
4697 <option value="nb">ISBN</option>
4698 <option value="se">Series</option>
4699 <option value="callnum">Call Number</option>
4701 <input value="Search" id="searchsubmit" type="submit">
projects / kohadocs.git / blob