docs/RELEASE_NOTES_NEXT/OPAC/carousels.adoc

   1 Carousels
   2 ^^^^^^^^^
   3 This feature fully integrates the creation and management of book carousels
   4 into Evergreen, allowing for the display of book cover images on a library’s
   5 public catalog home page.  Carousels may be animated or static.  They can be
   6 manually maintained by staff or automatically maintained by Evergreen.  Titles
   7 can appear in carousels based on newly cataloged items, recent returns,
   8 popularity, etc.  Titles must have copies that are visible to the public
   9 catalog, be circulating, and holdable to appear in a carousel.  Serial titles
  10 cannot be displayed in carousels.
  11
  12 Administration
  13 ++++++++++++++
  14 This feature introduces the concepts of Carousel Types, Carousels, and Carousel
  15 Library Mappings. The first can be administered in Server Administration
  16 while the latter two can be administerd in Local Administration.
  17
  18 Carousel Types define the attributes of a carousel, such as whether it is
  19 automatically managed and how it is filtered.  A carousel must be associated
  20 with a carousel type to function properly.
  21
  22 There are five stock Carousel Types:
  23
  24   * Newly Cataloged Items - titles appear automatically based on the active date of the title’s copies
  25   * Recently Returned Items - titles appear automatically based on the mostly recently circulated copy’s check-in scan date and time
  26   * Top Circulated Titles - titles appear automatically based on the most circulated copies in the Item Libraries identified in the carousel definition; titles are chosen based on the number of action.circulation rows created during an interval specified in the carousel definition and includes both circulations and renewals
  27   * Newest Items by Shelving Location - titles appear automatically based on the active date and shelving location of the title’s copies
  28   * Manual - titles are added and managed manually by library staff
  29
  30 While additional Carousel Types can be added using the administration
  31 interface, new automatic types currently require additional Perl code
  32 to be recognized.
  33
  34 Carousel definitions allow the operator to specify the type, owner,
  35 name and, for automatically-maintained types, the item libraries and
  36 shelving locations to look for titles to populate the carousels as
  37 well as how far back to look for titles.
  38
  39 Carousel Library Mappings specify the libraries that the carousel
  40 should be displayed out. The visibility of a carousel at a given organizational
  41 unit is not automatically inherited by the descendants of that unit.  The
  42 carousel’s owning organizational unit is automatically added to the list of
  43 display organizational units.
  44
  45 A server-side job, refresh_carousels.srfsh, is available to periodically
  46 refresh the contents of automatic carousels.
  47
  48 Staff Interface
  49 +++++++++++++++
  50 Each carousel has a record bucket associated with it. Library staff can
  51 add titles to a carousel's bucket, and for the manual Carousel Type, that
  52 is the only way to populate the carousel. Records added to an automatic
  53 carousel's bucket will be removed whenever the carousel is next
  54 refreshed.
  55
  56 Public Catalog
  57 ++++++++++++++
  58 A new Template Toolkit macro called “carousels” allows the Evergreen
  59 administrator to inject the contents of one or more carousels into any point in
  60 the OPAC.  The macro will accept the following parameters:
  61
  62   * carousel_id
  63   * dynamic (Boolean, default value false)
  64   * image_size (small, medium, or large)
  65   * width (number of titles to display on a “pane” of the carousel)
  66   * animated (Boolean to specify whether the carousel should automatically cycle through its panes)
  67   * animation_interval (the interval (in seconds) to wait before advancing to the next pane)
  68
  69 If the carousel_id parameter is supplied, the carousel with that ID will be
  70 displayed.  If carousel_id is not supplied, all carousels visible to the public
  71 catalog’s physical_loc organizational unit is displayed.