@thegetty/quire-cli 1.0.0-pre-release.1 → 1.0.0-pre-release.2

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/link.js

@@ -1,25 +0,0 @@
-const { oneLine } = require('~lib/common-tags')
-
-/**
- * Renders a link
- *
- * @param  {Object} link
- * @property  {String} link_relation The value of the anchor tag 'rel' property
- * @property  {String} media_type The value of the anchor tag 'type' property
- * @property  {String} name The link text
- * @property  {String} url
- * @param  {Array<String>} classes
- * @return {String}                anchor tag
- */
-module.exports = function(eleventyConfig) {
-  const link = eleventyConfig.getFilter('link')
-
-  return function (params) {
-    const { classes = [], link_relation, media_type, name, url } = params
-    return oneLine`
-      <a href="${url}" class="${classes.join(' ')}" target="_blank" rel="${link_relation}" type="${media_type}">
-        ${name}
-      </a>
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/menu/header.js

@@ -1,45 +0,0 @@
-const { html } = require('~lib/common-tags')
-
-/**
- * Publication title block in menu
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  params
- * @property   {String}  currentURL
- * @property   {Array|String}   contributors - publication contributors array or string override
- */
-module.exports = function(eleventyConfig) {
-  const contributors = eleventyConfig.getFilter('contributors')
-  const markdownify = eleventyConfig.getFilter('markdownify')
-  const siteTitle = eleventyConfig.getFilter('siteTitle')
-  const { contributor: publicationContributors, contributor_as_it_appears } = eleventyConfig.globalData.publication
-
-  return function(params) {
-    const { currentURL } = params
-    const isHomePage = currentURL === '/'
-
-    const homePageLinkOpenTag = isHomePage ? '' : `<a class="quire-menu__header__title-link" href="/">`
-    const homePageLinkCloseTag = isHomePage ? '' : `</a>`
-
-    const contributorContent = contributor_as_it_appears || contributors({ context: publicationContributors, format: 'string', type: 'primary' })
-
-    const contributorElement = contributorContent
-      ? `<span class="visually-hidden">Contributors: </span>${contributorContent}`
-      : ''
-
-    return html`
-      <header class="quire-menu__header">
-        ${homePageLinkOpenTag}
-          <h4 class="quire-menu__header__title">
-            <span class="visually-hidden">Site Title: </span>
-            ${siteTitle()}
-          </h4>
-        ${homePageLinkCloseTag}
-
-        <div class="quire-menu__header__contributors">
-          ${contributorElement}
-        </div>
-      </header>
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/menu/index.js

@@ -1,73 +0,0 @@
-const { html } = require('~lib/common-tags')
-
-/**
- * Menu
- * 
- * This controls the global table of contents for the publication, which is
- * available on all pages. For users with Javascript enabled, this menu is hidden
- * by default. Users with JS disabled will alwasy see the menu in its expanded state.
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  params
- */
-module.exports = function(eleventyConfig) {
-  const citation = eleventyConfig.getFilter('citation')
-  const copyright = eleventyConfig.getFilter('copyright')
-  const eleventyNavigation = eleventyConfig.getFilter('eleventyNavigation')
-  const linkList = eleventyConfig.getFilter('linkList')
-  const menuHeader = eleventyConfig.getFilter('menuHeader')
-  const menuList = eleventyConfig.getFilter('menuList')
-  const menuResources = eleventyConfig.getFilter('menuResources')
-
-  const { resource_link: resourceLinks } = eleventyConfig.globalData.publication
-
-  return function(params) {
-    const { collections, pageData } = params
-
-    if (!pageData) return
-
-    const footerLinks = resourceLinks.filter(({ type }) => type === 'footer-link')
-
-    return html`
-      <div
-        class="quire-menu menu"
-        role="banner"
-        id="site-menu__inner"
-      >
-        ${menuHeader({ currentURL: pageData.url })}
-        <nav id="nav" class="quire-menu__list menu-list" role="navigation" aria-label="full">
-          <h3 class="visually-hidden">Table of Contents</h3>
-          ${menuList({ currentURL: pageData.url, navigation: eleventyNavigation(collections.menu) })}
-        </nav>
-
-        ${menuResources()}
-
-        <div class="quire-menu__formats">
-          <h6>Cite this Page</h6>
-          <div class="cite-this">
-            <span class="cite-this__heading">
-              Chicago
-            </span>
-            <span class="cite-this__text">
-            ${citation({ context: 'page', page: pageData, type: 'chicago' })}
-            </span>
-          </div>
-
-          <div class="cite-this">
-            <span class="cite-this__heading">
-              MLA
-            </span>
-            <span class="cite-this__text">
-              ${citation({ context: 'page', page: pageData, type: 'mla' })}
-            </span>
-          </div>
-        </div>
-
-        <footer class="quire-menu__footer" role="contentinfo">
-          ${copyright()}
-          ${linkList({ links: footerLinks, classes: ['menu-list']}) }
-        </footer>
-      </div>
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/menu/item.js

@@ -1,28 +0,0 @@
-/**
- * Renders a menu item
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  params
- * @property      {Object}  data Page data
- * @property      {String}  title Page title
- * @property      {String}  url Page url
- */
-module.exports = function(eleventyConfig) {
-  const pageTitle = eleventyConfig.getFilter('pageTitle')
-
-  return function(params) {
-    const { currentURL, page } = params
-    const { data, url } = page
-    const { label, layout, title } = data
-
-    const titleText = pageTitle({ label, title })
-    /**
-     * Check if item is a reference to a built page or just a heading
-     * @type {Boolean}
-     */
-    const isPage = !!layout
-    return isPage
-      ? `<a href="${url}" class="${currentURL === url ? 'active' : ''}">${titleText}</a>`
-      : titleText
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/menu/list.js

@@ -1,41 +0,0 @@
-const { html } = require('~lib/common-tags')
-
-/**
- * Renders the menu list
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  params
- */
-module.exports = function(eleventyConfig) {
-  const menuItem = eleventyConfig.getFilter('menuItem')
-
-  const { menuType } = eleventyConfig.globalData.config
-
-  return function(params) {
-    const { currentURL, navigation } = params
-
-    const listItem = (page) => {
-      let element = ''
-      if (!page.children || page.children.length === 0) {
-        return `<li class="page-item">${menuItem({ currentURL, page })}</li>`
-      } else {
-        element += `<li class="section-item">${menuItem({ currentURL, page })}`
-        if (menuType !== 'brief') {
-          element += renderList(page.children)
-        }
-        element += '</li>'
-        return element
-      }
-    }
-
-    const renderList = (items) => {
-      return html`
-        <ol>
-          ${items.map(listItem).join('')}
-        </ol>
-      `
-    }
-
-    return renderList(navigation)
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/menu/resources.js

@@ -1,45 +0,0 @@
-const { html } = require('~lib/common-tags')
-
-/**
- * Renders the "Other Formats" and "Resources" sections of the menu
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  params
- */
-module.exports = function(eleventyConfig) {
-  const { resource_link: resourceLinks } = eleventyConfig.globalData.publication
-
-  return function() {
-    if (!Array.isArray(resourceLinks)) return ''
-
-    const linkList = eleventyConfig.getFilter('linkList')
-
-    const otherFormats = resourceLinks.filter(({ type }) => type === 'other-format')
-    const relatedResources = resourceLinks.filter(({ type }) => type === 'related-resource')
-
-    const resourceElement = relatedResources.length
-      ? html`
-        <div class="quire-menu__formats">
-          <h6>Resources</h6>
-          <div role="complementary" aria-label="related resources">
-            ${linkList({ links: relatedResources, classes: ['menu-list'] })}
-          </div>
-        </div>`
-      : ''
-
-    const otherFormatElement = otherFormats.length
-      ? html`
-        <div class="quire-menu__formats">
-          <h6>Other Formats</h6>
-          <div role="complementary" aria-label="downloads">
-            ${linkList({ links: otherFormats, classes: ['menu-list'] })}
-          </div>
-        </div>`
-      : ''
-
-    return html`
-      ${resourceElement}
-      ${otherFormatElement}
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/modal/index.js

@@ -1,30 +0,0 @@
-const { html } = require('~lib/common-tags')
-
-/**
- * Modal Tag
- *
- * @param      {Object}  eleventyConfig
- * @param      {Object}  globalData
- */
-module.exports = function (eleventyConfig, { page }) {
-  const lightboxSlides = eleventyConfig.getFilter('lightboxSlides')
-  const lightboxUI = eleventyConfig.getFilter('lightboxUI')
-
-  return async function (figures=page.figures) {
-    if (!figures) return
-
-    return html`
-      <q-modal>
-        <q-lightbox>
-          ${await lightboxSlides(figures)}
-          ${lightboxUI(figures)}
-        </q-lightbox>
-        <button
-          data-modal-close
-          class="q-modal__close-button"
-          id="close-modal"
-        ></button>
-      </q-modal>
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/navigation.js

@@ -1,169 +0,0 @@
-const truncate = require('~lib/truncate')
-const { html } = require('~lib/common-tags')
-
-/**
- * This controls the various navigation elements (nav, skip-link, menu and
- * search icons, and search results if enabled). It is visible on all pages.
- *
- * A note that while Hugo includes .Next and .Prev variables that can be used
- * to connect to the next and previous pages in the linear order of the site,
- * Quire makes available the option of hiding pages from the linear order in the
- * book in order to have custom pages in other formats (PDF, EPUB, etc.).
- * Because of this, the .Next and .Prev variables are not used here, and instead
- * eligible pages are ranged through and based on weight, the next or previous
- * one in the range is linked to.
- */
-module.exports = function(eleventyConfig) {
-  const eleventyNavigation = eleventyConfig.getFilter('eleventyNavigation')
-  const pageTitle = eleventyConfig.getFilter('pageTitle')
-  const { imageDir } = eleventyConfig.globalData.config.figures
-
-  return function (params) {
-    const { collections, pagination, title } = params
-    const {
-      currentPage,
-      currentPageIndex,
-      nextPage,
-      percentProgress,
-      previousPage
-    } = pagination
-
-    if (!currentPage) return
-    
-    const home = '/'
-    const isHomePage = currentPage.url === home
-
-    const navBarLabel = ({ label, short_title, title }) => {
-      return pageTitle({ label, title: short_title || truncate(title, 34)})
-    }
-
-    const navBarStartButton = () => {
-      if (!isHomePage) return ''
-      const secondPageLink = collections.navigation[1].url
-      return `
-        <li class="quire-navbar-page-controls__item quire-home-page">
-          <a href="${secondPageLink}" rel="next">
-            <span class="visually-hidden">Next Page: </span>
-            <span class="quire-navbar-button play-button">
-              <svg data-outputs-exclude="epub,pdf">
-                <switch>
-                  <use xlink:href="#start-icon"></use>
-                </switch>
-              </svg>
-            </span>
-          </a>
-        </li>
-      `
-    }
-
-    const navBarPreviousButton = () => {
-      if (!previousPage) return ''
-      const { data, url } = previousPage
-      const { label, short_title, title } = data
-      return html`
-        <li class="quire-navbar-page-controls__item quire-previous-page">
-          <a href="${url}" rel="previous">
-            <span class="visually-hidden">Previous Page: </span>
-            <svg class="left-icon" data-outputs-exclude="epub,pdf">
-              <switch>
-                <use xlink:href="#left-arrow-icon"></use>
-              </switch>
-            </svg>
-            ${navBarLabel({ label, short_title, title })}
-          </a>
-        </li>
-      `
-    }
-
-    const navBarHomeButton = () => {
-      if (!previousPage) return ''
-      return html`
-        <li class="quire-navbar-page-controls__item quire-home-page">
-          <a href="${home}" rel="home">
-            <span class="visually-hidden">Home Page: </span>
-            <span class="quire-navbar-button home-button">
-              <svg data-outputs-exclude="epub,pdf">
-                <switch>
-                  <use xlink:href="#home-icon"></use>
-                </switch>
-              </svg>
-            </span>
-          </a>
-        </li>
-      `
-    }
-
-    const navBarNextButton = () => {
-      if (isHomePage || !nextPage) return ''
-      const { data, url } = nextPage
-      const { label, short_title, title } = data
-      return html`
-        <li class="quire-navbar-page-controls__item quire-next-page">
-          <a href="${url}" rel='next'>
-            <span class="visually-hidden">Next Page: </span>
-            ${navBarLabel({ label, short_title, title })}
-            <svg data-outputs-exclude="epub,pdf">
-              <switch>
-                <use xlink:href="#right-arrow-icon"></use>
-              </switch>
-            </svg>
-          </a>
-        </li>
-      `
-    }
-
-    return html`
-      <div class="quire-navbar">
-        <a href="#main" class="quire-navbar-skip-link" tabindex="1">
-          Skip to Main Content
-        </a>
-        <nav class="quire-navbar-controls">
-          <div class="quire-navbar-controls__left">
-            <button
-              class="quire-navbar-button search-button"
-              aria-controls="quire-search"
-              onclick="toggleSearch()"
-            >
-              <svg data-outputs-exclude="epub,pdf">
-                <switch>
-                  <use xlink:href="#search-icon"></use>
-                </switch>
-              </svg>
-              <span class="visually-hidden">Search</span>
-            </button>
-          </div>
-          <div class="quire-navbar-controls__center">
-            <ul class="quire-navbar-page-controls" role="navigation" aria-label="quick">
-              ${navBarStartButton()}
-              ${navBarPreviousButton()}
-              ${navBarHomeButton()}
-              ${navBarNextButton()}
-            </ul>
-          </div>
-          <div class="quire-navbar-controls__right">
-            <button
-              class="quire-navbar-button menu-button"
-              id="quire-controls-menu-button"
-              onclick="toggleMenu()"
-              aria-expanded="true"
-              aria-controls="quire-menu"
-              tabindex="2"
-            >
-              <svg data-outputs-exclude="epub,pdf">
-                <switch>
-                  <use xlink:href="#nav-icon"></use>
-                </switch>
-              </svg>
-              <span class="visually-hidden">Table of Contents</span>
-            </button>
-          </div>
-        </nav>
-        <div class="quire-progress-bar">
-          <div style="width: ${percentProgress}%;">
-            <span>${currentPageIndex + 1}/${collections.navigation.length}</span>
-          </div>
-        </div>
-      </div>
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/page-buttons.js

@@ -1,53 +0,0 @@
-const { html } = require('~lib/common-tags')
-
-/**
- * Renders previous page and next page buttons
- *
- * @param {Object} eleventyConfig
- * 
- * @param {Object} params
- * @param {Object} options
- *
- * @return {String} "previous" and "next" buttons
- */
-module.exports = function(eleventyConfig) {
-  const icon = eleventyConfig.getFilter('icon')
-  const {
-    nextButtonText,
-    previousButtonText
-  } = eleventyConfig.globalData.config.navigation
-
-  return function(params, options={}) {
-    const { pagination } = params
-    const { nextPage, previousPage } = pagination
-
-    const prevPageButton = () => {
-      if (!previousPage) return
-      return html`
-        <li class="quire-nav-button prev">
-          <a href="${previousPage.url}">${icon({ type: 'left-arrow', description: 'Go back a page'})}&nbsp;<span class="nav-title">${nextButtonText}</span></a>
-          <span class="visually-hidden">Previous Page (left keyboard arrow or swipe)</span>
-        </li>
-      `
-    }
-
-    const nextPageButton = () => {
-      if (!nextPage) return
-      return html`
-        <li class="quire-nav-button next">
-          <a href="${nextPage.url}"><span class="nav-title">${previousButtonText}</span>&nbsp;${icon({ type: 'right-arrow', description: 'Go back next page' })}</a>
-            <span class="visually-hidden">Next Page (right keyboard arrow or swipe)</span>
-        </li>
-      `
-    }
-
-    return html`
-      <div class="quire-contents-buttons" data-outputs-exclude="epub,pdf">
-        <ul>
-          ${prevPageButton()}
-          ${nextPageButton()}
-        </ul>
-      </div>
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/page-header.js

@@ -1,69 +0,0 @@
-const { html } = require('~lib/common-tags')
-const path = require('path')
-
-/**
- * Publication page header
- *
- * @param      {Object}  eleventyConfig
- */
-module.exports = function(eleventyConfig) {
-  const contributors = eleventyConfig.getFilter('contributors')
-  const markdownify = eleventyConfig.getFilter('markdownify')
-  const pageTitle = eleventyConfig.getFilter('pageTitle')
-  const slugify = eleventyConfig.getFilter('slugify')
-
-  const { labelDivider } = eleventyConfig.globalData.config.pageTitle
-  const { imageDir } = eleventyConfig.globalData.config.figures
-
-  return function (params) {
-    const {
-      byline_format: bylineFormat,
-      image,
-      label,
-      pageContributors,
-      subtitle,
-      title
-    } = params
-
-    const classes = ['quire-page__header', 'hero']
-
-    if (title == 'title page' || title == 'half title page') {
-      classes.push('is-screen-only')
-    }
-
-    const pageLabel = label
-      ? `<span class="label">${label}<span class="visually-hidden">${labelDivider}</span></span>`
-      : ''
-
-    const imageElement = image
-      ? html`
-          <section
-            class="${classes} hero__image"
-           style="background-image: url('${path.join(imageDir, image)}');"
-          >
-          </section>
-        `
-      : ''
-
-    const contributorsElement = pageContributors
-      ? html`
-          <div class="quire-page__header__contributor">
-            ${contributors({ context: pageContributors, format: bylineFormat })}
-          </div>
-        `
-      : ''
-
-    return html`
-      <section class="${classes}">
-        <div class="hero-body">
-          <h1 class="quire-page__header__title" id="${slugify(title)}">
-            ${pageLabel}
-            ${pageTitle({ title, subtitle })}
-          </h1>
-          ${contributorsElement}
-        </div>
-      </section>
-      ${imageElement}
-    `
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/page-title.js

@@ -1,31 +0,0 @@
-/**
- * Concatenates the page title and subtitle, using a colon, or if the title ends with a ! or ?, no colon is included.
- * See also site-title.js
- * 
- * @param {Object} eleventyConfig
- * @param {Object} params
- * @property {Object} label
- * @property {Object} subtitle
- * @property {Object} title
- *
- * @return {string} `page title: subtitle`
- */
-module.exports = function(eleventyConfig) {
-  const markdownify = eleventyConfig.getFilter('markdownify')
-
-  const { labelDivider } = eleventyConfig.globalData.config.pageTitle
-
-  return function(params) {
-
-    const { label, subtitle, title } = params
-    const separator = title && !title.match(/\?|!/) ? ': ' : ' '
-
-    let pageTitle = subtitle ? [title, subtitle].join(separator) : title
-
-    if (label) {
-      pageTitle = `${[label, pageTitle].join(labelDivider)}`
-    }
-
-    return markdownify(pageTitle)
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/scripts.js

@@ -1,17 +0,0 @@
-const { html } = require('~lib/common-tags')
-
-/**
- * Generate HTML <script> tags for document head
- *
- * Nota bene: is-land bundle must be the first defined when using web-components
- * @see https://www.11ty.dev/docs/plugins/partial-hydration/#installation
- *
- * @param  {EleventyConfig} eleventyConfig
- * @return {String} HTML <script> tags
- */
-module.exports = function(eleventyConfig) {
-  return () => html`
-    <script type="module" src="/is-land.js"></script>
-    <script type="module" src="/_assets/javascript/application/index.js"></script>
-  `
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/site-title.js

@@ -1,19 +0,0 @@
-/**
- * Concatenates the site title and subtitle, using a colon, or if the title ends with a ! or ?, no colon is included.
- * See also page/title.liquid
- *
- * @param  {Object} eleventyConfig
- * 
- * @return  {String} Site title
- */
-module.exports = function(eleventyConfig) {
-  const { publication } = eleventyConfig.globalData
-  const { reading_line: readingLine, subtitle, title } = publication
-  return function() {
-    const separator = '!?'.includes(title.slice(-1)) ? '' : ':'
-    let siteTitle = `${title}`
-    if (subtitle) siteTitle += `${separator} ${subtitle}`
-    if (readingLine) siteTitle += ` (${readingLine})`
-    return siteTitle
-  }
-}

package/src/lib/quire/versions/1.0.0-pre-release.2/_includes/components/table-of-contents/epub.js

@@ -1,15 +0,0 @@
-/**
- * Render `table-of-contents` component with data from collections.epub
- */
-module.exports = function(eleventyConfig) {
-  const tableOfContentsList = eleventyConfig.getFilter('tableOfContentsList')
-  return function(params) {
-    const { collections, currentPageUrl, key, presentation } = params
-    return tableOfContentsList({ 
-      collection: collections.tableOfContentsEpub,
-      currentPageUrl,
-      key,
-      presentation
-    })
-  }
-}