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_.
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.
13 Configuring and customizing the public interface
14 ------------------------------------------------
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.
21 Locating the default template files
22 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
28 The default template file is installed in _/openils/var/templates/opac_.
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.
36 Mapping templates to URLs
37 ~~~~~~~~~~~~~~~~~~~~~~~~~
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:
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_
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.
53 Example Template Toolkit file: _opac/home.tt2_.
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" %]
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>
71 Note that file references are relative to the top of the template directory.
73 How to override template files
74 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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
91 Configuring the custom templates directory in Apache's eg.conf
92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
106 # - absorb the shared virtual host settings
107 Include eg_vhost.conf
109 PerlAddVar OILSWebTemplatePath "/openils/var/templates_custom"
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.
120 Adjusting colors for your public interface
121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
130 Adjusting fonts in your public interface
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
137 Other aspects of fonts such as the default font family can be adjusted in
138 _/openils/var/templates/opac/css/style.css.tt2_.
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/_.
146 Changing some text in the public interface
147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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":
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>
165 Next, copy the file into our overrides directory and edit it with vim.
167 Copying the links file into the overrides directory.
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
175 Finally, edit the link text in _opac/parts/header.tt2_. Content of the
176 _opac/parts/header.tt2_ file.
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>
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
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
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.
208 Adding translations to PO file
209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
211 After you have added custom text in translatable form to a TT2 template, you need to add the custom strings and its translations to the PO file containing the translations. Evergreen PO files are stored in _/openils/var/template/data/locale/_
213 The PO file consists of pairs of the text extracted from the code: Message ID denoted as _msgid_ and message string denoted as _msgstr_. When adding the custom string to PO file:
215 * The line with English expressions must start with _msgid_. The English term must be enclosed in double apostrophes.
216 * The line with translation start with /msgstr/. The translation to local language must be and enclosed in enclosed in double apostrophes.
217 * It is recommended to add a note in which template and on which line the particular string is located. The lines with notes must be marked as comments i.e., start with number sign (#)
223 # ---------------------------------------------------------------------
224 # The lines below contains the custom strings manually added to the catalog
225 # ---------------------------------------------------------------------
227 #: ../../Open-ILS/src/custom_templates/opac/parts/topnav_links.tt2:1
228 msgid "Union Catalog of the Czech Republic"
229 msgstr "Souborný katalog České republiky"
232 #: ../../Open-ILS/src/custom_templates/opac/parts/topnav_links.tt2:1
233 msgid "Uniform Information Gateway "
234 msgstr "Jednotná informačnà brána"
240 It is good practice to save backup copy of the original PO file before changing it.
243 After making changes, restart Apache to make the changes take effect. As root run the command:
246 service apache2 restart
249 Adding and removing MARC fields from the record details display page
250 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
252 It is possible to add and remove the MARC fields and subfields displayed in the
253 record details page. In order to add MARC fields to be displayed on the details
254 page of a record, you will need to map the MARC code to variables in the
255 _/openils/var/templates/opac/parts/misc_util.tt2 file_.
257 For example, to map the template variable _args.pubdates_ to the date of
258 publication MARC field 260, subfield c, add these lines to _misc_util.tt2_:
262 FOR sub IN xml.findnodes('//*[@tag="260"]/*[@code="c"]');
263 args.pubdates.push(sub.textContent);
265 args.pubdate = (args.pubdates.size) ? args.pubdates.0 : ''
268 You will then need to edit the
269 _/openils/var/templates/opac/parts/record/summary.tt2_ file in order to get the
270 template variable for the MARC field to display.
272 For example, to display the date of publication code you created in the
273 _misc_util.tt2_ file, add these lines:
276 [% IF attrs.pubdate; %]
277 <span itemprop="datePublished">[% attrs.pubdate | html; %]</span>
281 You can add any MARC field to your record details page. Moreover, this approach
282 can also be used to display MARC fields in other pages, such as your results
285 Setting the default physical location for your library environment
286 ------------------------------------------------------------------
288 _physical_loc_ is an Apache environment variable that sets the default physical
289 location, used for setting search scopes and determining the order in which
290 copies should be sorted. This variable is set in
291 _/etc/apache2/sites-available/eg.conf_. The following example demonstrates the
292 default physical location being set to library ID 104:
295 SetEnv physical_loc 104
298 Setting a default language and adding optional languages
299 --------------------------------------------------------
301 _OILSWebLocale_ adds support for a specific language. Add this variable to the
302 Virtual Host section in _/etc/apache2/eg_vhost.conf_.
304 _OILSWebDefaultLocale_ specifies which locale to display when a user lands on a
305 page in TPAC and has not chosen a different locale from the TPAC locale picker.
306 The following example shows the _fr_ca_ locale being added to the locale picker
307 and being set as the default locale:
310 PerlAddVar OILSWebLocale "fr_ca"
311 PerlAddVar OILSWebLocale "/openils/var/data/locale/opac/fr-CA.po"
312 PerlAddVar OILSWebDefaultLocale "fr-CA"
315 Below is a table of the currently supported languages packaged with Evergreen:
319 |Language| Code| PO file
320 |Arabic - Jordan| ar_jo | /openils/var/data/locale/opac/ar-JO.po
321 |Armenian| hy_am| /openils/var/data/locale/opac/hy-AM.po
322 |Czech| cs_cz| /openils/var/data/locale/opac/cs-CZ.po
323 |English - Canada| en_ca| /openils/var/data/locale/opac/en-CA.po
324 |English - Great Britain| en_gb| /openils/var/data/locale/opac/en-GB.po
325 |*English - United States| en_us| not applicable
326 |French - Canada| fr_ca| /openils/var/data/locale/opac/fr-CA.po
327 |Portuguese - Brazil| pt_br| /openils/var/data/locale/opac/pt-BR.po
328 |Spanish| es_es| /openils/var/data/locale/opac/es-ES.po
330 *American English is built into Evergreen so you do not need to set up this
331 language and there are no PO files.
333 Updating translations in Evergreen using current translations from Launchpad
334 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
336 Due to Evergreen release workflow/schedule, some language strings may already have been translated in Launchpad,
337 but are not yet packaged with Evergreen. In such cases, it is possible to manually replace the PO file in
338 Evergreen with an up-to-date PO file downloaded from Launchpad.
340 . Visit the Evergreen translation site in https://translations.launchpad.net/evergreen[Launchpad]
341 . Select required language (e.g. _Czech_ or _Spanish_)
342 . Open the _tpac_ template and then select option _Download translation_. Note: to be able to download the translation file you need to be logged in to Launchpad.
343 . Select _PO format_ and submit the _request for download_ button. You can also request for download of all existitng templates and languages at once, see https://translations.launchpad.net/evergreen/master/+export. The download link will be sent You to email address provided.
344 . Download the file and name it according to the language used (e.g., _cs-CZ.po_ for Czech or _es-ES.po_ for Spanish)
345 . Copy the downloaded file to _/openils/var/template/data/locale_. It is a good practice to backup the original PO file before.
346 . Be sure that the desired language is set as default, using the <<_setting_a_default_language_and_adding_optional_languages,Default language>> procedures.
348 Analogously, to update the web staff client translations, download the translation template _webstaff_ and copy it to _openils/var/template/data/locale/staff_.
351 Changes require web server reload to take effect. As root run the command
354 service apache2 restart
358 Editing the formats select box options in the search interface.
359 ---------------------------------------------------------------
361 You may wish to remove, rename or organize the options in the formats select
362 box. This can be accomplished from the staff client.
364 . From the staff client, navigate to *Admin > Server Administration > Marc Coded
366 . Select _Type_ from the *Record Attribute Type* select box.
367 . Double click on the format type you wish to edit.
369 To change the label for the type, enter a value in the *Search Label* field.
371 To move the option to a top list separated by a dashed line from the others,
372 check the *Is Simple Selector* check box.
374 To hide the type so that it does not appear in the search interface, uncheck the
375 *OPAC Visible* checkbox.
377 Changes will be immediate.
379 Adding and removing search fields in advanced search
380 -----------------------------------------------------
382 It is possible to add and remove search fields on the advanced search page by
383 editing the _opac/parts/config.tt2_ file in your template directory. Look for
384 this section of the file:
387 search.adv_config = [
388 {adv_label => l("Item Type"), adv_attr => ["mattype", "item_type"]},
389 {adv_label => l("Item Form"), adv_attr => "item_form"},
390 {adv_label => l("Language"), adv_attr => "item_lang"},
391 {adv_label => l("Audience"), adv_attr => ["audience_group", "audience"], adv_break => 1},
392 {adv_label => l("Video Format"), adv_attr => "vr_format"},
393 {adv_label => l("Bib Level"), adv_attr => "bib_level"},
394 {adv_label => l("Literary Form"), adv_attr => "lit_form", adv_break => 1},
395 {adv_label => l("Search Library"), adv_special => "lib_selector"},
396 {adv_label => l("Publication Year"), adv_special => "pub_year"},
397 {adv_label => l("Sort Results"), adv_special => "sort_selector"},
401 For example, if you delete the line:
404 {adv_label => l("Language"), adv_attr => "item_lang"},
407 the language field will no longer appear on your advanced search page. Changes
408 will appear immediately after you save your changes.
410 You can also add fields based on Search Facet Groups that you create in the
411 staff client's Local Administration menu. This can be helpful if you want to
412 simplify your patrons' experience by presenting them with only certain
413 limiters (e.g. the most commonly used languages in your area). To do this,
415 . Click *Admin -> Local Administration -> Search Facet Groups*.
417 . Enter descriptive values into the code and label fields. The owner needs to
418 be set to your consortium.
419 . Once the Facet Group is created, click on the blue hyperlinked code value.
420 . Click the *New* button to create the necessary values for your field.
421 . Go to the _opac/parts/config.tt2_ file, and add a line like the following,
422 where *Our Library's Field* is the name you'd like to be displayed next to
423 your field, and *facet_group_code* is the code you've added using the staff
427 {adv_label => l("Our Library's Field"), adv_filter => "facet_group_code"},
430 Changing the display of facets and facet groups
431 -----------------------------------------------
433 Facets can be reordered on the search results page by editing the
434 _opac/parts/config.tt2_ file in your template directory.
436 Edit the following section of _config.tt2_, changing the order of the facet
437 categories according to your needs:
442 {facet_class => 'author', facet_order => ['personal', 'corporate']},
443 {facet_class => 'subject', facet_order => ['topic']},
444 {facet_class => 'series', facet_order => ['seriestitle']},
445 {facet_class => 'subject', facet_order => ['name', 'geographic']}
450 You may also change the default number of facets appearing under each category
451 by editing the _facet.default_display_count_ value in _config.tt2_. The default
454 Change Date Format in Patron Account View
455 -----------------------------------------
456 Libraries with same-day circulations may want their patrons to be able to view
457 the due *time* as well as due date when they log in to their OPAC account. To
458 accomplish this, go to _opac/myopac/circs.tt2_. Find the line that reads:
461 [% date.format(due_date, DATE_FORMAT) %]
467 [% date.format(due_date, '%D %I:%M %p') %]
471 Including External Content in Your Public Interface
472 ---------------------------------------------------
474 The public interface allows you to include external services and content in your
475 public interface. These can include book cover images, user reviews, table of
476 contents, summaries, author notes, annotations, user suggestions, series
477 information among other services. Some of these services are free while others
478 require a subscription.
480 The following are some of the external content services which you can configure
486 The default install of Evergreen includes OpenLibrary book covers. The settings
487 for this are controlled by the <added_content> section of
488 _/openils/conf/opensrf.xml_. Here are the key elements of this configuration:
491 <module>OpenILS::WWW::AddedContent::OpenLibrary</module>
494 This section calls the OpenLibrary perl module. If you wish to link to a
495 different book cover service other than OpenLibrary, you must refer to the
496 location of the corresponding Perl module. You will also need to change other
497 settings accordingly.
503 Max number of seconds to wait for an added content request to return data. Data
504 not returned within the timeout is considered a failure.
506 <retry_timeout>600</retry_timeout>
509 This setting is the amount of time to wait before we try again.
512 <max_errors>15</max_errors>
515 Maximum number of consecutive lookup errors a given process can have before
516 added content lookups are disabled for everyone. To adjust the site of the cover
517 image on the record details page edit the config.tt2 file and change the value
518 of the record.summary.jacket_size. The default value is "medium" and the
519 available options are "small", "medium" and "large."
524 ChiliFresh is a subscription-based service which allows book covers, reviews and
525 social interaction of patrons to appear in your catalog. To activate ChiliFresh,
526 you will need to open the Apache configuration file _/etc/apache2/eg_vhost.conf_
527 and edit several lines:
529 . Uncomment (remove the "#" at the beginning of the line) and add your ChiliFresh
533 #SetEnv OILS_CHILIFRESH_ACCOUNT
536 . Uncomment this line and add your ChiliFresh Profile:
539 #SetEnv OILS_CHILIFRESH_PROFILE
542 Uncomment the line indicating the location of the Evergreen JavaScript for
546 #SetEnv OILS_CHILIFRESH_URL http://chilifresh.com/on-site /js/evergreen.js
549 . Uncomment the line indicating the secure URL for the Evergreen JavaScript :
552 #SetEnv OILS_CHILIFRESH_HTTPS_URL https://secure.chilifresh.com/on-site/js/evergreen.js
559 Content Café is a subscription-based service that can add jacket images,
560 reviews, summaries, tables of contents and book details to your records.
562 In order to activate Content Café, edit the _/openils/conf/opensrf.xml_ file and
563 change the _<module>_ element to point to the ContentCafe Perl Module:
566 <module>OpenILS::WWW::AddedContent::ContentCafe</module>
569 To adjust settings for Content Café, edit a couple of fields with the
570 _<ContentCafe>_ Section of _/openils/conf/opensrf.xml_.
572 Edit the _userid_ and _password_ elements to match the user id and password for
573 your Content Café account.
575 Change the _return_behavior_on_no_jacket_image_ to set the behavior of your
576 service when an image is not available for an item. By default this value is set
577 to T which will result in a small image with the text "No Image Available" in
578 place of a book cover. If you set this value to 1 a 1X1 blank image will be in
579 place of a book cover.
584 Setting up Obalkyknih.cz account
585 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
587 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].
588 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.
589 (In case each library uses an address of its own, all of these addresses have to be added.)
591 Enabling Obalkyknih.cz in Evergreen
592 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
594 Set obalkyknih_cz.enabled to true in '/openils/var/templates/opac/parts/config.tt2':
598 obalkyknih_cz.enabled = 'true';
601 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):
605 <!-- <module>OpenILS::WWW::AddedContent::OpenLibrary</module> -->
606 <module>OpenILS::WWW::AddedContent::ObalkyKnih</module>
609 Using default settings for Obalkyknih.cz means all types of added content from Obalkyknih.cz are visible in your online catalog.
610 If the module is enabled, book covers are always displayed. Other types of added content (summaries, ratings or tables of contents) can be:
612 * switched off using _false_ option,
613 * switched on again using _true_ option.
615 The following types of added content are used:
617 * summary (or annotation)
618 * tocPDF (table of contents available as image)
619 * tocText (table of contents available as text)
620 * review (user reviews)
622 An example of how to switch off summaries:
626 <summary>false</summary>
633 Google Analytics is a free service to collect statistics for your Evergreen
634 site. Statistic tracking is disabled by default through the Evergreen
635 client software when library staff use your site within the client, but active
636 when anyone uses the site without the client. This was a preventive measure to
637 reduce the potential risks for leaking patron information. In order to use Google
638 Analytics you will first need to set up the service from the Google Analytics
639 website at http://www.google.com/analytics/. To activate Google Analytics you
640 will need to edit _config.tt2_ in your template. To enable the service set
641 the value of google_analytics.enabled to true and change the value of
642 _google_analytics.code_ to be the code in your Google Analytics account.
647 Novelist is a subscription-based service providing reviews and recommendation
648 for books in you catalog. To activate your Novelist service in Evergreen, open
649 the Apache configuration file _/etc/apache2/eg_vhost.conf_ and edit the line:
652 #SetEnv OILS_NOVELIST_URL
655 You should use the URL provided by NoveList.
660 RefWorks is a subscription-based online bibliographic management tool. If you
661 have a RefWorks subscription, you can activate RefWorks in Evergreen by editing
662 the _config.tt2_ file located in your template directory. You will need to set
663 the _ctx.refworks.enabled_ value to _true_. You may also set the RefWorks URL by
664 changing the _ctx.refworks.url_ setting on the same file.
669 An OpenURL resolver allows you to find electronic resources and pull them into
670 your catalog based on the ISBN or ISSN of the item. In order to use the SFX
671 OpenURL resolver, you will need to subscribe to the Ex Libris SFX service. To
672 activate the service in Evergreen edit the _config.tt2_ file in your template.
673 Enable the resolver by changing the value of _openurl.enabled_ to _true_ and
674 change the _openurl.baseurl_ setting to point to the URL of your OpenURL
680 Syndetic Solutions is a subscription service providing book covers and other
681 data for items in your catalog. In order to activate Syndetic, edit the
682 _/openils/conf/opensrf.xml_ file and change the _<module>_ element to point to
683 the Syndetic Perl Module:
686 <module>OpenILS::WWW::AddedContent::Syndetic</module>
689 You will also need to edit the _<userid>_ element to be the user id provided to
692 Then, you will need to uncomment and edit the _<base_url>_ element so that it
693 points to the Syndetic service:
696 <base_url>http://syndetics.com/index.aspx</base_url>
699 For changes to be activated for your public interface you will need to restart
700 Evergreen and Apache.
703 Clear External/Added Content Cache
704 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
706 On the catalog’s record summary page, there is a link for staff that will forcibly clear
707 the cache of the Added Content for that record. This is helpful for when the Added Content
708 retrieved the wrong cover jacket art, summary, etc. and caches the wrong result.
710 image::media/clear-added-content-cache-1.png[Clear Cache Link]
712 Once clicked, there is a pop up that will display what was cleared from the cache.
714 image::media/clear-added-content-cache-2.jpg[Example Popup]
716 You will need to reload the record in the staff client to obtain the new images from your
717 Added Content Supplier.
720 Configure a Custom Image for Missing Images
721 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
723 You can configure a "no image" image other than the standard 1-pixel
724 blank image. The example eg_vhost.conf file provides examples in the
725 comments. Note: Evergreen does not provide default images for these.
728 Including Locally Hosted Content in Your Public Interface
729 ---------------------------------------------------------
731 It is also possible to show added content that has been generated locally
732 by placing the content in a specific spot on the web server. It is
733 possible to have local book jackets, reviews, TOC, excerpts or annotations.
735 File Location and Format
736 ~~~~~~~~~~~~~~~~~~~~~~~~
738 By default the files will need to be placed in directories under
739 */openils/var/web/opac/extras/ac/* on the server(s) that run Apache.
741 The files need to be in specific folders depending on the format of the
742 added content. Local Content can only be looked up based on the
743 record ID at this time.
746 \http://catalog/opac/extras/ac/*\{type}/\{format}/r/\{recordid}*
748 * *type* is one of *jacket*, *reviews*, *toc*, *excerpt* or *anotes*.
749 * *format* is type dependent:
750 - for jacket, one of small, medium or large
751 - others, one of html, xml or json ... html is the default for non-image added content
752 * *recordid* is the bibliographic record id (bre.id).
757 If you have some equipment that you are circulating such as a
758 laptop or eBook reader and you want to add an image of the equipment
759 that will show up in the catalog.
763 If you are adding jacket art for a traditional type of media
764 (book, CD, DVD) consider adding the jacket art to the http://openlibrary.org
765 project instead of hosting it locally. This would allow other
766 libraries to benefit from your work.
769 Make note of the Record ID of the bib record. You can find this by
770 looking at the URL of the bib in the catalog.
771 http://catalog/eg/opac/record/*123*, 123 is the record ID.
772 These images will only show up for one specific record.
774 Create 3 different sized versions of the image in png or jpg format.
776 * *Small* - 80px x 80px - named _123-s.jpg_ or _123-s.png_ - This is displayed in the browse display.
777 * *Medium* - 240px x 240px - named _123-m.jpg_ or _123-m.png_ - This is displayed on the summary page.
778 * *Large* - 400px x 399px - named _123-l.jpg_ or _123-l.png_ - This is displayed if the summary page image is clicked on.
781 The image dimensions are up to you, use what looks good in your catalog.
783 Next, upload the images to the evergreen server(s) that run apache,
784 and move/rename the files to the following locations/name.
785 You will need to create directories that are missing.
787 * Small - Move the file *123-s.jpg* to */openils/var/web/opac/extras/ac/jacket/small/r/123*
788 * Medium - Move the file *123-m.jpg* to */openils/var/web/opac/extras/ac/jacket/medum/r/123*.
789 * Large - Move the file *123-l.jpg* to */openils/var/web/opac/extras/ac/jacket/large/r/123*.
792 The system doesn't need the file extension to know what kind of file it is.
794 Reload the bib record summary in the web catalog and your new image will display.
798 A http://www.sitemaps.org[sitemap] directs search engines to the pages of
799 interest in a web site so that the search engines can intelligently crawl
800 your site. In the case of Evergreen, the primary pages of interest are the
801 bibliographic record detail pages.
803 The sitemap generator script creates sitemaps that adhere to the
804 http://sitemaps.org specification, including:
806 * limiting the number of URLs per sitemap file to no more than 50,000 URLs;
807 * providing the date that the bibliographic record was last edited, so
808 that once a search engine has crawled all of your sites' record detail pages,
809 it only has to reindex those pages that are new or have changed since the last
811 * generating a sitemap index file that points to each of the sitemap files.
813 Running the sitemap generator
814 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
815 The `sitemap_generator` script must be invoked with the following argument:
817 * `--lib-hostname`: specifies the hostname for the catalog (for example,
818 `--lib-hostname https://catalog.example.com`); all URLs will be generated
819 appended to this hostname
821 Therefore, the following arguments are useful for generating multiple sitemaps
822 per Evergreen instance:
824 * `--lib-shortname`: limit the list of record URLs to those which have copies
825 owned by the designated library or any of its children;
826 * `--prefix`: provides a prefix for the sitemap index file names
828 Other options enable you to override the OpenSRF configuration file and the
829 database connection credentials, but the default settings are generally fine.
831 Note that on very large Evergreen instances, sitemaps can consume hundreds of
832 megabytes of disk space, so ensure that your Evergreen instance has enough room
833 before running the script.
837 To enable search engines to maintain a fresh index of your bibliographic
838 records, you may want to include the script in your cron jobs on a nightly or
841 Sitemap files are generated in the same directory from which the script is
842 invoked, so a cron entry will look something like:
844 ------------------------------------------------------------------------
845 12 2 * * * cd /openils/var/web && /openils/bin/sitemap_generator
846 ------------------------------------------------------------------------
848 Troubleshooting TPAC errors
849 ---------------------------
851 If there is a problem such as a TT syntax error, it generally shows up as an
852 ugly server failure page. If you check the Apache error logs, you will probably
853 find some solid clues about the reason for the failure. For example, in the
854 following example, the error message identifies the file in which the problem
855 occurred as well as the relevant line numbers.
857 Example error message in Apache error logs:
860 bash# grep "template error" /var/log/apache2/error_log
861 [Tue Dec 06 02:12:09 2011] [warn] [client 127.0.0.1] egweb: template error:
862 file error - parse error - opac/parts/record/summary.tt2 line 112-121:
863 unexpected token (!=)\n [% last_cn = 0;\n FOR copy_info IN
864 ctx.copies;\n callnum = copy_info.call_number_label;\n