d2cb957f9e0645ea879494038004acab231bb46f
[Evergreen.git] / docs / admin_initial_setup / designing_your_catalog.txt
1 Designing your catalog
2 ======================
3
4 When people want to find things in your Evergreen system, they will check the
5 catalog. In Evergreen, the catalog is made available through a web interface,
6 called the _OPAC_ (Online Public Access Catalog). In the latest versions of the
7 Evergreen system, the OPAC is built on a set of programming modules called the
8 Template Toolkit. You will see the OPAC sometimes referred to as the _TPAC_.
9
10 In this chapter, we'll show you how to customize the OPAC, change it from its
11 default configuration, and make it your own.
12
13 Configuring and customizing the public interface
14 ------------------------------------------------
15
16 The public interface is referred to as the TPAC or Template Toolkit (TT) within
17 the Evergreen community. The template toolkit system allows you to customize the
18 look and feel of your OPAC by editing the template pages (.tt2) files as well as
19 the associated style sheets.   
20
21 Locating the default template files
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23
24 The default URL for the TPAC on a default Evergreen system is
25 _http://localhost/eg/opac/home_ (adjust _localhost_ to match your hostname or IP
26 address).
27
28 The default template file is installed in _/openils/var/templates/opac_.
29
30 You should generally avoid touching the installed default template files, unless
31 you are contributing changes for Evergreen to adopt as a new default. Even then,
32 while you are developing your changes, consider using template overrides rather
33 than touching the installed templates until you are ready to commit the changes
34 to a branch. See below for information on template overrides.
35
36 Mapping templates to URLs
37 ~~~~~~~~~~~~~~~~~~~~~~~~~
38
39 The mapping for templates to URLs is straightforward. Following are a few
40 examples, where _<templates>_ is a placeholder for one or more directories that
41 will be searched for a match:
42
43 * _http://localhost/eg/opac/home => /openils/var/<templates>/opac/home.tt2_
44 * _http://localhost/eg/opac/advanced =>
45 /openils/var/<templates>/opac/advanced.tt2_
46 * _http://localhost/eg/opac/results => 
47 /openils/var/<templates>/opac/results.tt2_
48
49 The template files themselves can process, be wrapped by, or include other
50 template files. For example, the _home.tt2_ template currently involves a number
51 of other template files to generate a single HTML file.
52
53 Example Template Toolkit file: _opac/home.tt2_.
54 ----
55 [%  PROCESS "opac/parts/header.tt2";
56     WRAPPER "opac/parts/base.tt2";
57     INCLUDE "opac/parts/topnav.tt2";
58     ctx.page_title = l("Home") %]
59     <div id="search-wrapper">
60       [% INCLUDE "opac/parts/searchbar.tt2" %]
61     </div>
62     <div id="content-wrapper">
63         <div id="main-content-home">
64              <div class="common-full-pad"></div>
65              [% INCLUDE "opac/parts/homesearch.tt2" %]
66              <div class="common-full-pad"></div>
67         </div>
68      </div>
69 [% END %]
70 ----
71 Note that file references are relative to the top of the template directory.
72
73 How to override template files
74 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75
76 Overrides for template files or TPAC pages go in a directory that parallels the
77 structure of the default templates directory. The overrides then get pulled in
78 via the Apache configuration.
79
80 The following example demonstrates how to create a file that overrides the
81 default "Advanced search page" (_advanced.tt2_) by adding a new 
82 _templates_custom_ directory and editing the new file in that directory.
83
84 ----
85 bash$ mkdir -p /openils/var/templates_custom/opac
86 bash$ cp /openils/var/templates/opac/advanced.tt2 \
87          /openils/var/templates_custom/opac/.
88 bash$ vim /openils/var/templates_custom/opac/advanced.tt2
89 ----
90
91 Configuring the custom templates directory in Apache's eg.conf
92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
93
94 You now need to teach Apache about the new custom template directory. Edit
95 _/etc/apache2/sites-available/eg.conf_ and add the following _<Location /eg>_
96 element to each of the _<VirtualHost>_ elements in which you want to include the
97 overrides. The default Evergreen configuration includes a VirtualHost directive
98 for port 80 (HTTP) and another one for port 443 (HTTPS); you probably want to
99 edit both, unless you want the HTTP user experience to be different from the
100 HTTPS user experience.
101
102 ----
103 <VirtualHost *:80>
104     # <snip>
105
106     # - absorb the shared virtual host settings
107     Include eg_vhost.conf
108     <Location /eg>
109         PerlAddVar OILSWebTemplatePath "/openils/var/templates_custom"
110     </Location>
111
112     # <snip>
113 </VirtualHost>
114 ----
115
116 Finally, reload the Apache configuration to pick up the changes. You should now
117 be able to see your change at _http://localhost/eg/opac/advanced_ where
118 _localhost_ is the hostname of your Evergreen server.
119
120 Adjusting colors for your public interface
121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122
123 You may adjust the colors of your public interface by editing the _colors.tt2_
124 file. The location of this file is in 
125 _/openils/var/templates/opac/parts/css/colors.tt2_. When you customize the
126 colors of your public interface, remember to create a custom file in your custom
127 template folder and edit the custom file and not the file located in you default
128 template.    
129
130 Adjusting fonts in your public interface
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132
133 Font sizes can be changed in the _colors.tt2_ file located in
134 _/openils/var/templates/opac/parts/css/_. Again, create and edit a custom
135 template version and not the file in the default template.
136
137 Other aspects of fonts such as the default font family can be adjusted in
138 _/openils/var/templates/opac/css/style.css.tt2_. 
139
140 Media file locations in the public interface
141 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
142 The media files (mostly PNG images) used by the default TPAC templates are stored
143 in the repository in _Open-ILS/web/images/_ and installed in
144 _/openils/var/web/images/_.
145
146 Changing some text in the public interface
147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
148
149 Out of the box, TPAC includes a number of placeholder text and links. For
150 example, there is a set of links cleverly named Link 1, Link 2, and so on in the
151 header and footer of every page in TPAC. Here is how to customize that for a 
152 _custom templates_ skin.
153
154 To begin with, find the page(s) that contain the text in question. The simplest
155 way to do that is with the grep -s command. In the following example, search for
156 files that contain the text "Link 1":
157
158 ----
159 bash$ grep -r "Link 1" /openils/var/templates/opac
160 /openils/var/templates/opac/parts/topnav_links.tt2
161 4:            <a href="http://example.com">[% l('Link 1') %]</a>
162 ----
163
164
165 Next, copy the file into our overrides directory and edit it with vim.
166
167 Copying the links file into the overrides directory.
168
169 ----
170 bash$ cp /openils/var/templates/opac/parts/topnav_links.tt2 \
171 /openils/var/templates_custom/opac/parts/topnav_links.tt2
172 bash$ vim /openils/var/templates_custom/opac/parts/topnav_links.tt2
173 ----
174
175 Finally, edit the link text in _opac/parts/header.tt2_. Content of the
176 _opac/parts/header.tt2_ file.
177
178 ----
179 <div id="gold-links-holder">
180     <div id="gold-links">
181         <div id="header-links">
182             <a href="http://example.com">[% l('Link 1') %]</a>
183             <a href="http://example.com">[% l('Link 2') %]</a>
184             <a href="http://example.com">[% l('Link 3') %]</a>
185             <a href="http://example.com">[% l('Link 4') %]</a>
186             <a href="http://example.com">[% l('Link 5') %]</a>
187         </div>
188     </div>
189 </div>
190 ----
191
192 For the most part, the page looks like regular HTML, but note the `[%_(" ")%]`
193 that surrounds the text of each link. The `[% ... %]` signifies a TT block,
194 which can contain one or more TT processing instructions. `l(" ... ");` is a
195 function that marks text for localization (translation); a separate process can
196 subsequently extract localized text as GNU gettext-formatted PO (Portable
197 Object) files.
198
199 As Evergreen supports multiple languages, any customization to Evergreen's
200 default text must use the localization function. Also, note that the
201 localization function supports placeholders such as `[_1]`, `[_2]` in the text;
202 these are replaced by the contents of variables passed as extra arguments to the
203 `l()` function.
204
205 Once the link and link text has been edited to your satisfaction, load the page
206 in a Web browser and see the live changes immediately.
207
208 Adding and removing MARC fields from the record details display page
209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
210
211 It is possible to add and remove the MARC fields and subfields displayed in the
212 record details page.  In order to add MARC fields to be displayed on the details
213 page of a record, you will need to map the MARC code to variables in the
214 _/openils/var/templates/opac/parts/misc_util.tt2 file_.
215
216 For example, to map the template variable _args.pubdates_ to the date of
217 publication MARC field 260, subfield c, add these lines to _misc_util.tt2_:
218
219 ----
220 args.pubdates = [];
221 FOR sub IN xml.findnodes('//*[@tag="260"]/*[@code="c"]');
222     args.pubdates.push(sub.textContent);
223 END;
224 args.pubdate = (args.pubdates.size) ? args.pubdates.0 : ''
225 ----
226
227 You will then need to edit the 
228 _/openils/var/templates/opac/parts/record/summary.tt2_ file in  order to get the
229 template variable for the MARC field to display.
230
231 For example, to display the date of publication code you created in the
232 _misc_util.tt2_ file, add these lines:
233
234 ----
235 [% IF attrs.pubdate; %]
236     <span itemprop="datePublished">[% attrs.pubdate | html; %]</span>
237 [% END; %]
238 ----
239
240 You can add any MARC field to your record details page. Moreover, this approach
241 can also be used to display MARC fields in other pages, such as your results
242 page.
243
244 Setting the default physical location for your library environment
245 ------------------------------------------------------------------
246
247 _physical_loc_ is an Apache environment variable that sets the default physical
248 location, used for setting search scopes and determining the order in which
249 copies should be sorted. This variable is set in
250 _/etc/apache2/sites-available/eg.conf_. The following example demonstrates the
251 default physical location being set to library ID 104:
252
253 ----
254 SetEnv physical_loc 104
255 ----
256
257 Setting a default language and adding optional languages
258 --------------------------------------------------------
259
260 _OILSWebLocale_ adds support for a specific language. Add this variable to the
261 Virtual Host section in _/etc/apache2/sites-available/eg.conf_.
262
263 _OILSWebDefaultLocale_ specifies which locale to display when a user lands on a
264 page in TPAC and has not chosen a different locale from the TPAC locale picker.
265 The following example shows the _fr_ca_ locale being added to the locale picker
266 and being set as the default locale:
267
268 ----
269 PerlAddVar OILSWebLocale "fr_ca"
270 PerlAddVar OILSWebLocale "/openils/var/data/locale/opac/fr-CA.po"
271 PerlAddVar OILSWebDefaultLocale "fr-CA"
272 ----
273
274 Below is a table of the currently supported languages packaged with Evergreen:
275
276 [options="header"]
277 |================================================================
278 |Language| Code| PO file
279 |Czech| cs_cz| /openils/var/data/locale/opac/cs-CZ.po
280 |English - Canada| en_ca| /openils/var/data/locale/opac/en-CA.po
281 |English - Great Britain| en_gb| /openils/var/data/locale/opac/en-GB.po
282 |*English - United States| en_us| not applicable
283 |French - Canada| fr_ca| /openils/var/data/locale/opac/fr-CA.po
284 |Portuguese - Brazil| pt_br| /openils/var/data/locale/opac/pt_BR.po
285 |Russian| ru_ru| /openils/var/data/locale/opac/ru_RU.po
286 |=================================================================
287 *American English is built into Evergreen so you do not need to set up this
288 language and there are no PO files. 
289
290 Editing the formats select box options in the search interface.
291 ---------------------------------------------------------------
292
293 You may wish to remove, rename or organize the options in the formats select
294 box. This can be accomplished from the staff client.
295
296 . From the staff client, navigate to *Admin > Server Administration > Marc Coded
297 Value Maps* 
298 . Select _Type_ from the *Record Attribute Type* select box.
299 . Double click on the format type you wish to edit.
300
301 To change the label for the type, enter a value in the *Search Label* field.
302
303 To  move the option to a top list separated by a dashed line from the others,
304 check the *Is Simple Selector* check box.
305
306 To hide the type so that it does not appear in the search interface, uncheck the
307 *OPAC Visible* checkbox.
308
309 Changes will be immediate.
310
311 Adding and removing search fields in advanced search
312 -----------------------------------------------------
313
314 It is possible to add and remove search fields on the advanced search page by
315 editing the _opac/parts/config.tt2_ file in your template directory. Look for
316 this section of the file:
317
318 ----
319 search.adv_config = [
320     {adv_label => l("Item Type"), adv_attr => ["mattype", "item_type"]},
321     {adv_label => l("Item Form"), adv_attr => "item_form"},
322     {adv_label => l("Language"),  adv_attr => "item_lang"},
323     {adv_label => l("Audience"),  adv_attr => ["audience_group", "audience"], adv_break => 1},
324     {adv_label => l("Video Format"), adv_attr => "vr_format"},
325     {adv_label => l("Bib Level"), adv_attr => "bib_level"},
326     {adv_label => l("Literary Form"), adv_attr => "lit_form", adv_break => 1},
327     {adv_label => l("Search Library"), adv_special => "lib_selector"},
328     {adv_label => l("Publication Year"), adv_special => "pub_year"},
329     {adv_label => l("Sort Results"), adv_special => "sort_selector"},
330 ];
331 ----
332
333 For example, if you delete the line:
334
335 ----
336 {adv_label => l("Language"),  adv_attr => "item_lang"},
337 ----
338
339 the language field will no longer appear on your advanced search page. Changes
340 will appear immediately after you save your changes.
341
342 You can also add fields based on Search Facet Groups that you create in the
343 staff client's Local Administration menu. This can be helpful if you want to
344 simplify your patrons' experience by presenting them with only certain
345 limiters (e.g. the most commonly used languages in your area).  To do this,
346
347 . Click *Admin -> Local Administration -> Search Facet Groups*.
348 . Click *New*.
349 . Enter descriptive values into the code and label fields.  The owner needs to
350 be set to your consortium.
351 . Once the Facet Group is created, click on the blue hyperlinked code value.
352 . Click the *New* button to create the necessary values for your field.
353 . Go to the _opac/parts/config.tt2_ file, and add a line like the following,
354 where *Our Library's Field* is the name you'd like to be displayed next to
355 your field, and *facet_group_code* is the code you've added using the staff
356 client.
357 +
358 ----
359  {adv_label => l("Our Library's Field"), adv_filter => "facet_group_code"},
360 ----
361
362 Changing the display of facets and facet groups
363 -----------------------------------------------
364
365 Facets can be reordered on the search results page by editing the
366 _opac/parts/config.tt2_ file in your template directory.  
367
368 Edit the following section of _config.tt2_, changing the order of the facet
369 categories according to your needs:
370
371 ----
372
373 facet.display = [
374     {facet_class => 'author',  facet_order => ['personal', 'corporate']},
375     {facet_class => 'subject', facet_order => ['topic']},
376     {facet_class => 'series',  facet_order => ['seriestitle']},
377     {facet_class => 'subject', facet_order => ['name', 'geographic']}
378 ];
379
380 ----
381
382 You may also change the default number of facets appearing under each category
383 by editing the _facet.default_display_count_ value in _config.tt2_. The default 
384 value is 5.
385
386 Change Date Format in Patron Account View
387 -----------------------------------------
388 Libraries with same-day circulations may want their patrons to be able to view
389 the due *time* as well as due date when they log in to their OPAC account.  To
390 accomplish this, go to _opac/myopac/circs.tt2_.  Find the line that reads:
391
392 ----
393 [% date.format(due_date, DATE_FORMAT) %]
394 ----
395
396 Replace it with:
397
398 ----
399 [% date.format(due_date, '%D %I:%M %p') %]
400 ----
401
402
403 Including External Content in Your Public Interface
404 ---------------------------------------------------
405
406 The public interface allows you to include external services and content in your
407 public interface. These can include book cover images, user reviews, table of
408 contents, summaries, author notes, annotations, user suggestions, series
409 information among other services. Some of these services are free while others
410 require a subscription.    
411
412 The following are some of the external content services which you can configure
413 in Evergreen.
414
415 OpenLibrary
416 ~~~~~~~~~~~
417
418 The default install of Evergreen includes OpenLibrary book covers. The settings
419 for this are controlled by the <added_content> section of
420 _/openils/conf/opensrf.xml_. Here are the key elements of this configuration:
421
422 ----
423 <module>OpenILS::WWW::AddedContent::OpenLibrary</module>
424 ----
425
426 This section calls the OpenLibrary perl module. If you wish to link to a
427 different book cover service other than OpenLibrary, you must refer to the
428 location of the corresponding Perl module. You will also need to change other
429 settings accordingly.
430
431 ----
432 <timeout>1</timeout>
433 ----
434
435 Max number of seconds to wait for an added content request to return data. Data 
436 not returned within the timeout is considered a failure.
437 ----
438 <retry_timeout>600</retry_timeout>
439 ----
440
441 This setting is the amount of time to wait before we try again.
442
443 ----
444 <max_errors>15</max_errors>
445 ----
446
447 Maximum number of consecutive lookup errors a given process can have before
448 added content lookups are disabled for everyone. To adjust the site of the cover
449 image on the record details page edit the config.tt2 file and change the value
450 of the record.summary.jacket_size. The default value is "medium" and the
451 available options are "small", "medium" and "large."   
452
453 ChiliFresh
454 ~~~~~~~~~~
455
456 ChiliFresh is a subscription-based service which allows book covers, reviews and
457 social interaction of patrons to appear in your catalog. To activate ChiliFresh,
458 you will need to open the Apache configuration file _/etc/apache2/eg_vhost.conf_
459 and edit several lines:
460
461 . Uncomment (remove the "#" at the beginning of the line) and add your ChiliFresh
462 account number:
463
464 ----
465 #SetEnv OILS_CHILIFRESH_ACCOUNT
466 ----
467
468 . Uncomment this line and add your ChiliFresh Profile:
469
470 ----
471 #SetEnv OILS_CHILIFRESH_PROFILE
472 ----
473
474 Uncomment the line indicating the location of the Evergreen JavaScript for
475 ChiliFresh:
476
477 ----
478 #SetEnv OILS_CHILIFRESH_URL http://chilifresh.com/on-site /js/evergreen.js
479 ----
480
481 . Uncomment the line indicating the secure URL for the Evergreen JavaScript :
482
483 ----
484 #SetEnv OILS_CHILIFRESH_HTTPS_URL https://secure.chilifresh.com/on-site/js/evergreen.js
485 ----
486
487 [id="_content_cafe"]
488 Content Café
489 ~~~~~~~~~~~~
490
491 Content Café is a subscription-based service that can add  jacket images,
492 reviews, summaries, tables of contents and book details to your records.
493
494 In order to activate Content Café, edit the _/openils/conf/opensrf.xml_ file and
495 change the _<module>_ element to point to the ContentCafe Perl Module:
496
497 ----
498 <module>OpenILS::WWW::AddedContent::ContentCafe</module>
499 ----
500
501 To adjust settings for Content Café, edit a couple of fields with the
502 _<ContentCafe>_ Section of _/openils/conf/opensrf.xml_.
503
504 Edit the _userid_ and _password_ elements to match the user id and password for
505 your Content Café account.
506
507 Change the _return_behavior_on_no_jacket_image_ to set the behavior of your
508 service when an image is not available for an item. By default this value is set
509 to T which will result in a small image with the text "No Image Available" in
510 place of a book cover. If you set this value to 1 a 1X1 blank image will be in
511 place of a book cover. 
512
513 Obalkyknih.cz
514 ~~~~~~~~~~~~~
515
516 Setting up Obalkyknih.cz account
517 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
518
519 If your library wishes to use added content provided by Obalkyknih.cz, a service based in the Czech Republic, you have to http://obalkyknih.cz/signup[create an Obalkyknih.cz account].
520 Please note that the interface is only available in Czech. After logging in your Obalkyknih.cz account, you have to add your IP address and Evergreen server address to your account settings.
521 (In case each library uses an address of its own, all of these addresses have to be added.) 
522
523 Enabling Obalkyknih.cz in Evergreen
524 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
525
526 Set obalkyknih_cz.enabled to true in '/openils/var/templates/opac/parts/config.tt2':
527
528 [source,perl]
529 ----
530 obalkyknih_cz.enabled = 'true';
531 ----
532
533 Enable added content from Obalkyknih.cz in '/openils/conf/opensrf.xml' configuration file (and – at the same time – disable added content from Open Library, i.e., Evergreen's default added content provider):
534
535 [source,xml]
536 ----
537 <!-- <module>OpenILS::WWW::AddedContent::OpenLibrary</module> -->
538 <module>OpenILS::WWW::AddedContent::ObalkyKnih</module>
539 ----
540
541 Using default settings for Obalkyknih.cz means all types of added content from Obalkyknih.cz are visible in your online catalog.
542 If the module is enabled, book covers are always displayed. Other types of added content (summaries, ratings or tables of contents) can be: 
543
544 * switched off using _false_ option,
545 * switched on again using _true_ option.
546
547 The following types of added content are used: 
548
549 * summary (or annotation)
550 * tocPDF (table of contents available as image)
551 * tocText (table of contents available as text)
552 * review (user reviews)
553
554 An example of how to switch off summaries: 
555
556 [source,xml]
557 ----
558 <summary>false</summary>
559 ----
560
561
562 Google Analytics
563 ~~~~~~~~~~~~~~~~
564
565 Google Analytics is a free service to collect statistics for your Evergreen
566 site. Statistic tracking is disabled by default through the Evergreen 
567 client software when library staff use your site within the client, but active 
568 when anyone uses the site without the client. This was a preventive measure to 
569 reduce the potential risks for leaking patron information. In order to use Google 
570 Analytics you will first need to set up the service from the Google Analytics 
571 website at http://www.google.com/analytics/. To activate Google Analytics you 
572 will need to edit _config.tt2_ in your template. To enable the service set 
573 the value of google_analytics.enabled to true and change the value of 
574 _google_analytics.code_ to be the code in your Google Analytics account.
575
576 NoveList
577 ~~~~~~~~
578
579 Novelist is a subscription-based service providing reviews and recommendation
580 for books in you catalog. To activate your Novelist service in Evergreen, open
581 the Apache configuration file _/etc/apache2/eg_vhost.conf_ and edit the line:
582
583 ----
584 #SetEnv OILS_NOVELIST_URL
585 ----
586
587 You should use the URL provided by NoveList.
588
589 RefWorks
590 ~~~~~~~~
591
592 RefWorks is a subscription-based online bibliographic management tool. If you
593 have a RefWorks subscription, you can activate RefWorks in Evergreen by editing
594 the _config.tt2_ file located in your template directory. You will need to set
595 the _ctx.refworks.enabled_ value to _true_. You may also set the RefWorks URL by
596 changing the _ctx.refworks.url_ setting on the same file. 
597
598 SFX OpenURL Resolver
599 ~~~~~~~~~~~~~~~~~~~~
600
601 An OpenURL resolver allows you to find electronic resources and pull them into
602 your catalog based on the ISBN or ISSN of the item. In order to use the SFX
603 OpenURL resolver, you will need to subscribe to the Ex Libris SFX service.  To
604 activate the service in Evergreen edit the _config.tt2_ file in your template.
605 Enable the resolver by changing the value of _openurl.enabled_ to _true_ and
606 change the _openurl.baseurl_ setting to point to the URL of your OpenURL
607 resolver. 
608
609 Syndetic Solutions
610 ~~~~~~~~~~~~~~~~~~
611
612 Syndetic Solutions is a subscription service providing book covers and other
613 data for items in your catalog. In order to activate Syndetic, edit the
614 _/openils/conf/opensrf.xml_ file and change the _<module>_ element to point to
615 the Syndetic Perl Module:
616
617 ----
618 <module>OpenILS::WWW::AddedContent::Syndetic</module>
619 ----
620
621 You will also need to edit the  _<userid>_ element to be the user id provided to
622 you by Syndetic.
623
624 Then, you will need to uncomment and edit the _<base_url>_ element so that it
625 points to the Syndetic service:
626
627 ----
628 <base_url>http://syndetics.com/index.aspx</base_url>
629 ----
630
631 For changes to be activated for your public interface you will need to restart
632 Evergreen and Apache.
633
634
635 Clear External/Added Content Cache
636 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
637
638 On the catalog’s record summary page, there is a link for staff that will forcibly clear 
639 the cache of the Added Content for that record. This is helpful for when the Added Content 
640 retrieved the wrong cover jacket art, summary, etc. and caches the wrong result.
641
642 image::media/clear-added-content-cache-1.png[Clear Cache Link]
643
644 Once clicked, there is a pop up that will display what was cleared from the cache. 
645
646 image::media/clear-added-content-cache-2.jpg[Example Popup]
647
648 You will need to reload the record in the staff client to obtain the new images from your 
649 Added Content Supplier.
650
651
652 Configure a Custom Image for Missing Images
653 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
654
655 You can configure a "no image" image other than the standard 1-pixel
656 blank image.  The example eg_vhost.conf file provides examples in the
657 comments.  Note: Evergreen does not provide default images for these.
658
659
660 Including Locally Hosted Content in Your Public Interface
661 ---------------------------------------------------------
662
663 It is also possible to show added content that has been generated locally 
664 by placing the content in a specific spot on the web server.  It is 
665 possible to have local book jackets, reviews, TOC, excerpts or annotations.
666
667 File Location and Format
668 ~~~~~~~~~~~~~~~~~~~~~~~~
669
670 By default the files will need to be placed in directories under 
671 */openils/var/web/opac/extras/ac/* on the server(s) that run Apache.
672
673 The files need to be in specific folders depending on the format of the 
674 added content.  Local Content can only be looked up based on the 
675 record ID at this time.
676
677 .URL Format:
678 \http://catalog/opac/extras/ac/*\{type}/\{format}/r/\{recordid}*
679
680  * *type* is one of *jacket*, *reviews*, *toc*, *excerpt* or *anotes*.
681   * *format* is type dependent:
682     - for jacket, one of small, medium or large
683     - others, one of html, xml or json ... html is the default for non-image added content
684   * *recordid* is the bibliographic record id (bre.id).
685
686 Example
687 ~~~~~~~
688
689 If you have some equipment that you are circulating such as a 
690 laptop or eBook reader and you want to add an image of the equipment 
691 that will show up in the catalog.
692
693 [NOTE]
694 =============
695 If you are adding jacket art for a traditional type of media 
696 (book, CD, DVD) consider adding the jacket art to the http://openlibrary.org 
697 project instead of hosting it locally.  This would allow other 
698 libraries to benefit from your work.
699 =============
700
701 Make note of the Record ID of the bib record.  You can find this by 
702 looking at the URL of the bib in the catalog.  
703 http://catalog/eg/opac/record/*123*, 123 is the record ID.  
704 These images will only show up for one specific record.
705
706 Create 3 different sized versions of the image in png or jpg format.
707
708  * *Small* - 80px x 80px - named _123-s.jpg_ or _123-s.png_ - This is displayed in the browse display.
709  * *Medium* - 240px x 240px - named _123-m.jpg_ or _123-m.png_ - This is displayed on the summary page.
710  * *Large* - 400px x 399px - named _123-l.jpg_ or _123-l.png_ - This is displayed if the summary page image is clicked on.
711
712 [NOTE] 
713 The image dimensions are up to you, use what looks good in your catalog.
714  
715 Next, upload the images to the evergreen server(s) that run apache, 
716 and move/rename the files to the following locations/name.  
717 You will need to create directories that are missing.
718  
719  * Small - Move the file *123-s.jpg* to */openils/var/web/opac/extras/ac/jacket/small/r/123*
720  * Medium - Move the file *123-m.jpg* to */openils/var/web/opac/extras/ac/jacket/medum/r/123*.
721  * Large - Move the file *123-l.jpg* to */openils/var/web/opac/extras/ac/jacket/large/r/123*.
722
723 [NOTE]
724 The system doesn't need the file extension to know what kind of file it is.
725  
726 Reload the bib record summary in the web catalog and your new image will display.
727
728 Sitemap generator
729 -----------------
730 A http://www.sitemaps.org[sitemap] directs search engines to the pages of
731 interest in a web site so that the search engines can intelligently crawl
732 your site. In the case of Evergreen, the primary pages of interest are the
733 bibliographic record detail pages.
734
735 The sitemap generator script creates sitemaps that adhere to the
736 http://sitemaps.org specification, including:
737
738 * limiting the number of URLs per sitemap file to no more than 50,000 URLs;
739 * providing the date that the bibliographic record was last edited, so
740   that once a search engine has crawled all of your sites' record detail pages,
741   it only has to reindex those pages that are new or have changed since the last
742   crawl;
743 * generating a sitemap index file that points to each of the sitemap files.
744
745 Running the sitemap generator
746 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
747 The `sitemap_generator` script must be invoked with the following argument:
748
749 * `--lib-hostname`: specifies the hostname for the catalog (for example,
750   `--lib-hostname https://catalog.example.com`); all URLs will be generated
751   appended to this hostname
752
753 Therefore, the following arguments are useful for generating multiple sitemaps
754 per Evergreen instance:
755
756 * `--lib-shortname`: limit the list of record URLs to those which have copies
757   owned by the designated library or any of its children;
758 * `--prefix`: provides a prefix for the sitemap index file names
759
760 Other options enable you to override the OpenSRF configuration file and the
761 database connection credentials, but the default settings are generally fine.
762
763 Note that on very large Evergreen instances, sitemaps can consume hundreds of
764 megabytes of disk space, so ensure that your Evergreen instance has enough room
765 before running the script.
766
767 Scheduling
768 ~~~~~~~~~~
769 To enable search engines to maintain a fresh index of your bibliographic
770 records, you may want to include the script in your cron jobs on a nightly or
771 weekly basis.
772
773 Sitemap files are generated in the same directory from which the script is
774 invoked, so a cron entry will look something like:
775
776 ------------------------------------------------------------------------
777 12 2 * * * cd /openils/var/web && /openils/bin/sitemap_generator
778 ------------------------------------------------------------------------
779
780 Troubleshooting TPAC errors
781 ---------------------------
782
783 If there is a problem such as a TT syntax error, it generally shows up as an
784 ugly server failure page. If you check the Apache error logs, you will probably
785 find some solid clues about the reason for the failure. For example, in the
786 following example, the error message identifies the file in which the problem
787 occurred as well as the relevant line numbers.
788
789 Example error message in Apache error logs:
790
791 ----
792 bash# grep "template error" /var/log/apache2/error_log
793 [Tue Dec 06 02:12:09 2011] [warn] [client 127.0.0.1] egweb: template error:
794  file error - parse error - opac/parts/record/summary.tt2 line 112-121:
795   unexpected token (!=)\n  [% last_cn = 0;\n        FOR copy_info IN
796   ctx.copies;\n            callnum = copy_info.call_number_label;\n
797 ----
798