diff --git a/README.md b/README.md index c8a1c6a..57de872 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,30 @@ The [Quire Eleventy package](https://github.com/thegetty/quire/tree/main/packages/11ty) contains configuration and modules for the [Eleventy static site generator](https://11ty.dev). This package is published to npm as [`@thegetty/quire-11ty`](https://www.npmjs.com/package/@thegetty/quire-11ty) and installed by the [`@thegetty/quire-cli`](https://www.npmjs.com/package/@thegetty/quire-cli) to build [Quire](https://quire.getty.edu) projects. -### New and Customized Template Files +## Creating a PDF Version + +1. Run `quire build` + +2. In `_site/pdf.html`, find and replace the ones instance of `` with `` to ensure page numbering for "Thing" section page is correct. + +2. If the PDF will be sent to digital printer, run the following command to ensure color profiles are correct: + + ``` + magick mogrify -profile bin/adobe-rgb-1998.icm _site/iiif/**/print-image.jpg + ``` + +3. With PrinceXML 14.2 installed, run `quire pdf --lib prince` + +Note: We were originally planning on using Paged.js to output this project, however, it is outputting rich black text, which increases print cost and lowers print quality. Also, this important bit of CSS, which adds commas to the things in the List of Owners, wasn't working in Paged.js whereas it does in Prince. And Prince offers some other layout benefits we'll be able to take advantage of. + +```css +#owners-list li .quire-citation + .quire-citation::before { content: ", "; } +``` + +## New and Customized Template Files + +**_includes/components/copyright/licensing.js** +Updated licensing language **_includes/components/icons.js** Added custom search icon @@ -22,7 +45,7 @@ Added three dropdown selects for the thing grid Altered to show current page title instead of homepage link, as well as a link to the contents ("Things") page **_includes/components/page-header.js** -Added a list of 'owners' +Added a list of 'owners' and an html element for the PDF footers **_includes/components/table-of-contents/item/list.js** Output the list item for 'thing' pages with an image @@ -33,16 +56,12 @@ Altered getCurrentFigureId() to work with .q-figure__modal-link class anywhere **_layouts/cover.liquid** Accepts an array of images stacked on top of one another, and add adds visually-hidden class to the main title texts +**_layouts/splash.liquid** +Added an html element for the PDF footers + **_layouts/thing.liquid** Copied essay.liquid, except that it adds owners to the pageHeader and a `.thing-info` grid to display type, theme, and material. -**_plugins/filters/lowerCase.js** -**_plugins/filters/index.js** -Added new filter to convert string to lower case, for use in Liquid tempates - -**_plugins/shortcodes/figureGroup.js** -Added optional group figure caption, and optional class, and simplify output to remove rows - **_plugins/shortcodes/index.js** Registered the new `abbr` and `thing` shortcodes @@ -57,7 +76,3 @@ Refactored logic to handle oxford commas correctly; and added handling to displa **_plugins/shortcodes/figureRef.js** Refactored to accept comma-separated array, and to output with .q-figure__modal-link class - -**_plugins/transforms/outputs/pdf/layout.html** -**_plugins/transforms/outputs/pdf/write.js** -Added wrapping elements with classes necessary for styling \ No newline at end of file diff --git a/_includes/components/copyright/licensing.js b/_includes/components/copyright/licensing.js index e0c6cdf..634fee0 100644 --- a/_includes/components/copyright/licensing.js +++ b/_includes/components/copyright/licensing.js @@ -1,3 +1,8 @@ +// +// CUSTOMIZED FILE +// Updated the image exclusions language, line 27 +// Moved print/pdf statement to new location +// const { oneLine } = require('~lib/common-tags') module.exports = function(eleventyConfig) { @@ -11,6 +16,7 @@ module.exports = function(eleventyConfig) { const licenseName = license.url ? `${license.name}` : license.name + const licensePrintStatement = `To view a copy of this license, visit ${license.url}. ` if (license.scope == 'some-exceptions') { licenseText += ` @@ -18,19 +24,16 @@ module.exports = function(eleventyConfig) { ` } else if (license.scope === 'text-only') { licenseText += ` - The text of this work is licensed under a ${licenseName}. Unless otherwise indicated, all illustrations are excluded from the ${licenseAbbreviation} license. + The text of this work is licensed under a ${licenseName}. ${licensePrintStatement}All images are reproduced with the permission of the rights holders acknowledged in captions and are expressly excluded from the ${licenseAbbreviation} license covering the rest of this publication. These images may not be reproduced, copied, transmitted, or manipulated without consent from the owners, who reserve all rights. ` } else { licenseText += ` - This work is licensed under a ${licenseName}. + This work is licensed under a ${licenseName}. ${licensePrintStatement} ` } return oneLine` ${licenseText} - - To view a copy of this license visit ${license.url}. - ` } } diff --git a/_includes/components/page-header.js b/_includes/components/page-header.js index 6a07803..d2d52a1 100644 --- a/_includes/components/page-header.js +++ b/_includes/components/page-header.js @@ -68,10 +68,10 @@ module.exports = function(eleventyConfig) { : owner.first_name + ' ' + owner.last_name const years = owner.years - ? owner.years + ? ` (${owner.years})` : '' - ownersList.push(html`