docs/opac/new_skin_customizations.adoc

   1 Creating a New Skin: the Bare Minimum
   2 =====================================
   3
   4 When you adopt the TPAC as your catalog, you must create a new skin. This
   5 involves a combination of overriding template files and setting Apache
   6 directives to control the look and feel of your customized TPAC.
   7
   8 Apache directives
   9 -----------------
  10 There are a few Apache directives and environment variables of note for
  11 customizing TPAC behavior. These directives should generally live within a
  12 `<vhost>` section of your Apache configuration.
  13
  14 * `OILSWebDefaultLocale` specifies which locale to display when a user lands
  15    on a page in the TPAC and has not chosen a different locale from the TPAC
  16    locale picker. The following example shows the `fr_ca` locale being added
  17    to the locale picker and being set as the default locale:
  18 +
  19 ------------------------------------------------------------------------------
  20 PerlAddVar OILSWebLocale "fr_ca"
  21 PerlAddVar OILSWebLocale "/openils/var/data/locale/opac/fr-CA.po"
  22 PerlAddVar OILSWebDefaultLocale "fr-CA"
  23 ------------------------------------------------------------------------------
  24 +
  25 * `physical_loc` is an Apache environment variable that sets the default
  26   physical location, used for setting search scopes and determining the order
  27   in which copies should be sorted. The following example demonstrates the
  28   default physical location being set to library ID 104:
  29 +
  30 ------------------------------------------------------------------------------
  31 SetEnv physical_loc 104
  32 ------------------------------------------------------------------------------
  33
  34 Customizing templates
  35 ---------------------
  36 When you install Evergreen, the TPAC templates include many placeholder images,
  37 text, and links. You should override most of these to provide your users with a
  38 custom experience that matches your library.  Following is a list of templates
  39 that include placeholder images, text, or links that you should override.
  40
  41 NOTE: All paths are relative to `/openils/var/templates/opac`
  42
  43 [[configtt2]]
  44
  45 * `parts/config.tt2`: contains many configuration settings that affect the
  46   behavior of the TPAC, including:
  47   ** hiding the *Place Hold* button for available items
  48   ** enabling RefWorks support for citation management
  49   ** adding OpenURL resolution for electronic resources
  50   ** enabling Google Analytics tracking for your TPAC
  51   ** displaying the "Forgot your password?" prompt
  52   ** controlling the size of cover art on the record details page
  53   ** defining which facets to display, and in which order
  54   ** controlling basic and advanced search options
  55   ** controlling if the "Show More Details" button is visible or activated by default in OPAC search results
  56   ** hiding phone notification options (useful for libraries that do not do phone notifications)
  57   ** disallowing password or e-mail changes (useful for libraries that use centralized authentication or single sign-on systems)
  58   ** displaying a maintenance message in the public catalog and KPAC (this is controlled by the _ctx.maintenance_message_ variable)
  59   ** displaying previews of books when available from Google Books.  This is controlled by the _ctx.google_books_preview_ variable, which is set to 0 by default to protect the privacy of users who might not want to share their browsing behavior with Google.
  60   ** disabling the "Group Formats and Editions" search. This is controlled by
  61 setting the metarecords.disabled variable to 1.
  62   ** setting the default search to a 'Group Formats and Editions' search. This
  63 is done by setting the search.metarecord_default variable to 1.
  64 * `parts/footer.tt2` and `parts/topnav_links.tt2`: contains customizable
  65   links. Defaults like 'Link 1' will not mean much to your users!
  66 * `parts/homesearch.tt2`: holds the large Evergreen logo on the home page
  67   of the TPAC. Substitute your library's logo, or if you are adventurous,
  68   create a "most recently added items" carousel... and then share your
  69   customization with the Evergreen community.
  70 * `parts/topnav_logo.tt2`: holds the small Evergreen logo that appears on the
  71   top left of every page in the TPAC. You will also want to remove or change
  72   the target of the link that wraps the logo and leads to the
  73   http://evergreen-ils.org[Evergreen site].
  74 * `parts/login/form.tt2`: contains some assumptions about terminology and
  75   examples that you might prefer to change to be more consistent with your own
  76   site's existing practices. For example, you may not use 'PIN' at your library
  77   because you want to encourage users to use a password that is more secure than
  78   a four-digit number.
  79 * `parts/login/help.tt2`: contains links that point to http://example.com,
  80   images with text on them (which is not an acceptable practice for
  81   accessibility reasons), and promises of answers to frequently asked questions
  82   that might not exist at your site.
  83 * `parts/login/password_hint.tt2`: contains a hint about your users' password
  84   on first login that is misleading if your library does not set the initial
  85   password for an account to the last four digits of the phone number associated
  86   with the account.
  87 * `parts/myopac/main_refund_policy.tt2`: describes the policy for refunds for
  88   your library.
  89 * `parts/myopac/prefs_hints.tt2`: suggests that users should have a valid email
  90   on file so they can receive courtesy and overdue notices. If your library
  91   does not send out email notices, you should edit this to avoid misleading your
  92   users.
  93 * `parts/css/fonts.tt2`: defines the font sizes for the TPAC in terms of one
  94   base font size, and all other sizes derived from that in percentages. The
  95   default is 12 pixels, but http://goo.gl/WfNkE[some design sites] strongly
  96   suggest a base font size of 16 pixels. Perhaps you want to try '1em' as a
  97   base to respect your users' preferences. You only need to change one number
  98   in this file if you want to experiment with different options for your users.
  99 * `parts/css/colors.tt2`: chances are your library's official colors do not
 100   match Evergreen's wall of dark green. This file defines the colors in use in
 101   the standard Evergreen template. In theory you should be able to change just
 102   a few colors and everything will work, but in practice you will need to
 103   experiment to avoid light-gray-on-white low-contrast combinations.
 104
 105 The following are templates that are less frequently overridden, but some libraries benefit from the added customization options.
 106
 107 * `parts/advanced/numeric.tt2`: defines the search options of the Advanced Search > Numeric search. If you wanted to add a bib call number search option, which is different from the item copy call number; you would add the following code to `numeric.tt2`.
 108 +
 109 ------------------------------------------------------------------------------
 110 <option value="identifier|bibcn">[% l('Bib Call Number') %]</option>
 111 ------------------------------------------------------------------------------
 112