docs/modules/cataloging/pages/cover_image_upload.adoc

   1 = Cover Image Uploader =
   2 :toc:
   3
   4 As of version 3.9, a staff user with appropriate permissions can upload
   5 a cover image directly within a specific bibliographic record. Uploaded images will override images provided by a third party service like NoveList or Syndetics. Image uploads are
   6 controlled by a permission, a library setting, and a global
   7 flag described at the end of this page.
   8
   9 Acceptable file types are jpg, png, xpm, xbm, gif, and bmp. The formats
  10 gd and gd2 are also supported, but these are unlikely to come up in
  11 everyday use since they are internal formats in the libgd library used
  12 for this feature. All uploaded images are converted to PNG at the time
  13 of upload and scaled to small, medium, and large for various uses within
  14 the OPAC and staff client.
  15
  16 The scaling algorithm will size images to fit the dimension of each
  17 bounding box, while preserving aspect ratio. This means that the largest
  18 dimension of any image will be scaled to match the bounding box. These
  19 are hardcoded but can be adjusted by an administrator as a
  20 customization.
  21
  22 * Small = 55px wide x 91px high
  23 * Medium = 120 px wide x 200 px high
  24 * Large = 475px wide x 787 px high
  25
  26 In stock Evergreen, images associated with a bib record will display in
  27 the following locations:
  28
  29 * In the staff catalog search results list on the left side of the title
  30 * In the staff catalog bib record details page on the upper left side of
  31 the page
  32 * In the OPAC search results list on the left side of the title
  33 * In the OPAC record details search page to the left of the title.
  34
  35 == Uploading a Cover Image ==
  36
  37 From within the staff client, search for & retrieve a bib record. Under
  38 *Other Actions* on the right is an action to *Upload Cover Image*.
  39
  40 image::cover_image_upload/upload_cover_image.png[Upload Cover Image action]
  41
  42 Click the *Upload Cover Image* action to open a modal which will direct
  43 you to select an image and upload it to Evergreen.
  44
  45 image::cover_image_upload/upload_cover_image_modal.png[Upload Cover Image modal]
  46
  47 If there is an error uploading your file, you will be shown error text
  48 in the modal. Error messages include the following:
  49
  50 * Not authenticated. Expired login?
  51 * Not authorized. Check your permissions.
  52 * Not found. Bib record deleted?
  53 * Invalid global compression value. Talk to your system administrator.
  54 * Do not know where to upload files. Talk to your system administrator.
  55 * Can not save uploaded file. Talk to your system administrator.
  56 * File size larger than configured limit. Check your library setting or
  57 try a smaller file.
  58 * Error parsing the image. Is it a common image filetype?
  59 * Error uploading or processing file.
  60
  61 When the upload is complete the bib record will refresh and you will see
  62 the small (thumbnail) version of your image in the upper left of the
  63 record:
  64
  65 image::cover_image_upload/cover_staffcat_view.png[Cover Image in record summary]
  66
  67 To see what the image looks like in the OPAC, you can click the *Patron
  68 View* button. The Patron View button will open the OPAC in a new tab,
  69 displaying the record as it appears to a Patron.
  70
  71 image::cover_image_upload/cover_opac_view.png[Cover Image in OPAC bib record]
  72
  73 Once a new image is uploaded, memcache is flushed (analogous to clicking
  74 “Clear Added Content Cache”). However, modern browsers can be very
  75 sticky with their cache so if a user needs to see the new cover image
  76 immediately, we recommend checking in a different browser.
  77
  78 == Administration
  79
  80 This feature uses a new permission, a new library setting, and a new
  81 global flag.
  82
  83 * *Permission*
  84 ** UPLOAD_COVER_IMAGE - this is not added to any groups by default.
  85 * *Library Setting*
  86 ** _Maximum file size for uploaded cover image files (at time of upload,
  87 prior to rescaling)_ - Accepts an integer value in bytes specifying the
  88 maximum pre-compression file size. If unset, this will default to
  89 10737418240 (approximately 10GB).
  90 * *Global Flag*
  91 ** `opac.cover_upload_compression` - accepts a numeric value from 0 (no
  92 compression) to 9 (most compression). The default is 0. All uploaded
  93 files are converted to png and use this flag.
  94