@thegetty/quire-cli 0.20.2 → 0.20.3

package/bin/themes/default/.scss-lint.yml

@@ -1,239 +0,0 @@
-scss_files: "**/*.scss"
-plugin_directories: ['.scss-linters']
-
-# Default severity of all linters.
-severity: warning
-
-linters:
-  BangFormat:
-    enabled: true
-    space_before_bang: true
-    space_after_bang: false
-
-  BemDepth:
-    enabled: false
-    max_elements: 1
-
-  BorderZero:
-    enabled: true
-    convention: zero # or `none`
-
-  ChainedClasses:
-    enabled: false
-
-  ColorKeyword:
-    enabled: true
-
-  ColorVariable:
-    enabled: true
-
-  Comment:
-    enabled: true
-    style: silent
-
-  DebugStatement:
-    enabled: true
-
-  DeclarationOrder:
-    enabled: false
-
-  DisableLinterReason:
-    enabled: false
-
-  DuplicateProperty:
-    enabled: true
-
-  ElsePlacement:
-    enabled: true
-    style: same_line # or 'new_line'
-
-  EmptyLineBetweenBlocks:
-    enabled: true
-    ignore_single_line_blocks: true
-
-  EmptyRule:
-    enabled: true
-
-  ExtendDirective:
-    enabled: false
-
-  FinalNewline:
-    enabled: true
-    present: true
-
-  HexLength:
-    enabled: true
-    style: short # or 'long'
-
-  HexNotation:
-    enabled: true
-    style: lowercase # or 'uppercase'
-
-  HexValidation:
-    enabled: true
-
-  IdSelector:
-    enabled: true
-
-  ImportantRule:
-    enabled: true
-
-  ImportPath:
-    enabled: true
-    leading_underscore: false
-    filename_extension: false
-
-  Indentation:
-    enabled: true
-    allow_non_nested_indentation: false
-    character: space # or 'tab'
-    width: 2
-
-  LeadingZero:
-    enabled: true
-    style: include_zero # or 'include_zero'
-
-  MergeableSelector:
-    enabled: true
-    force_nesting: true
-
-  NameFormat:
-    enabled: true
-    allow_leading_underscore: true
-    convention: hyphenated_lowercase # or 'camel_case', or 'snake_case', or a regex pattern
-
-  NestingDepth:
-    enabled: true
-    max_depth: 5
-    ignore_parent_selectors: false
-
-  PlaceholderInExtend:
-    enabled: false
-
-  PropertyCount:
-    enabled: false
-    include_nested: false
-    max_properties: 10
-
-  PropertySortOrder:
-    enabled: true
-    ignore_unspecified: false
-    min_properties: 2
-    separate_groups: false
-
-  PropertySpelling:
-    enabled: true
-    extra_properties: []
-    disabled_properties: []
-
-  PropertyUnits:
-    enabled: true
-    global: [
-      'ch', 'em', 'ex', 'rem',                 # Font-relative lengths
-      'cm', 'in', 'mm', 'pc', 'pt', 'px', 'q', # Absolute lengths
-      'vh', 'vw', 'vmin', 'vmax',              # Viewport-percentage lengths
-      'deg', 'grad', 'rad', 'turn',            # Angle
-      'ms', 's',                               # Duration
-      'Hz', 'kHz',                             # Frequency
-      'dpi', 'dpcm', 'dppx',                   # Resolution
-      '%']                                     # Other
-    properties: {}
-
-  PseudoElement:
-    enabled: true
-
-  QualifyingElement:
-    enabled: true
-    allow_element_with_attribute: false
-    allow_element_with_class: false
-    allow_element_with_id: false
-
-  SelectorDepth:
-    enabled: true
-    max_depth: 3
-
-  SelectorFormat:
-    enabled: true
-    convention: hyphenated_BEM # or 'strict_BEM', or 'hyphenated_BEM', or 'snake_case', or 'camel_case', or a regex pattern
-
-  Shorthand:
-    enabled: true
-    allowed_shorthands: [1, 2, 3]
-
-  SingleLinePerProperty:
-    enabled: true
-    allow_single_line_rule_sets: true
-
-  SingleLinePerSelector:
-    enabled: true
-
-  SpaceAfterComma:
-    enabled: true
-    style: one_space # or 'no_space', or 'at_least_one_space'
-
-  SpaceAfterPropertyColon:
-    enabled: true
-    style: one_space # or 'no_space', or 'at_least_one_space', or 'aligned'
-
-  SpaceAfterPropertyName:
-    enabled: true
-
-  SpaceAfterVariableName:
-    enabled: true
-
-  SpaceAroundOperator:
-    enabled: true
-    style: one_space # or 'at_least_one_space', or 'no_space'
-
-  SpaceBeforeBrace:
-    enabled: true
-    style: space # or 'new_line'
-    allow_single_line_padding: false
-
-  SpaceBetweenParens:
-    enabled: true
-    spaces: 0
-
-  StringQuotes:
-    enabled: true
-    style: double_quotes # or double_quotes
-
-  TrailingSemicolon:
-    enabled: true
-
-  TrailingWhitespace:
-    enabled: true
-
-  TrailingZero:
-    enabled: false
-
-  TransitionAll:
-    enabled: false
-
-  UnnecessaryMantissa:
-    enabled: true
-
-  UnnecessaryParentReference:
-    enabled: true
-
-  UrlFormat:
-    enabled: true
-
-  UrlQuotes:
-    enabled: true
-
-  VariableForProperty:
-    enabled: false
-    properties: []
-
-  VendorPrefix:
-    enabled: true
-    identifier_list: base
-    additional_identifiers: []
-    excluded_identifiers: []
-
-  ZeroUnit:
-    enabled: true
-
-  Compass::*:
-    enabled: false

package/bin/themes/default/CHANGELOG.md

@@ -1,73 +0,0 @@
-# Quire Starter Theme Change Log
-
-All notable changes to the `quire-starter-theme` will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
-
-## [Unreleased]
-
-### Added
-
-- Better Chicago/MLA citation handling for different numbers of authors and editors, as well as series titles and numbers
-- Progress bar height variable, default is 2px
-- Better default layouts for cover and splash pages without content
-
-### Changed
-
-- The active page is now marked in the menu with an "active" class at build time, rather than client-side with JS
-- Hide navbar page labels on mobile
-- Made entry image shorter on mobile to increase target area for scrolling page
-- Citation URLs now specified in publication.yml with fallback to baseURL
-- Bibliography heading specified in config.yml rather thank being hard-coded in
-
-### Fixed
-
-- Erroneous closing of figure modal
-- Bad scroll positions on some anchor links
-- Display of contributors in sidebar menu
-- Bad variable for tracking "page one" of publication
-- Spacing on page classes
-- Anchorizing of element IDs for contributors
-- Icon styling for citationPopupStyle: icon
-- Plate images, captions and grid page number positioning in pdf
-
-
-## [0.18.0] - 2020-02-03
-### Added
-+ Cypress testing suite
-+ CircleCI configuration to run Cypress Tests automatically on each pull request
-+ Tests for all major JS functions and elements
-
-### Changed
-* Handling of references for bibliographies. Now use `id` instead of `short`.
-
-### Fixed
-* search.html to fix ref warning
-+ relURL to href and src
-* JS bug fixes
-- Removed use of deprecated Hugo variables in templates
-* logic in footer buttons and home page link
-
-### Security
-* Updated NodeJS/NPM dependencies
-
-## [0.17.0] - 2019-08-01
-### Added
-+ Support for tabled figures
-+ Option to add in custom JavaScript
-
-### Changed
-+ Improved q-contributor shortcode
-+ Improved display of citations from the q-cite shortcode
-+ Improvements to page layouts online and in pdf
-
-### Fixed
-+ Displays image tools and information in fullscreen mode
-
-### Security
-* Updated NodeJS/NPM dependencies
-
-[Unreleased]: https://github.com/gettypubs/quire-starter-theme/compare/v0.18.0...HEAD
-[0.18.0]: https://github.com/gettypubs/quire-starter-theme/compare/v0.17.0...v0.18.0
-[0.17.0]: https://github.com/gettypubs/quire-starter-theme/releases/tag/v0.17.0

package/bin/themes/default/LICENSE.md

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 YOUR_NAME_HERE
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/bin/themes/default/README.md

@@ -1,112 +0,0 @@
-# Quire 
-
-Developed by Getty, Quire is a new, multiformat publishing tool available for immediate access and use. Quire is in a limited beta, © J. Paul Getty Trust, and not yet released as open-source software. For a free license to use Quire, please complete [this form](https://docs.google.com/forms/d/e/1FAIpQLScKOJEq9ivhwizmdazjuhxBII-s-5SUsnerWmyF8VteeeRBhA/viewform).
-
-For information on **installing, updating, and uninstalling Quire (macOS + Windows) and Quire commands** please refer to the [Quire documentation](https://quire.getty.edu/documentation/install-uninstall/). 
-
-## Quire Default Theme
-
-This default theme is a full-featured theme designed to showcase and make use of Quire’s core features out of the box, and is included by default when starting a new Quire project with the `quire new` command. The default theme includes support for a variety of page types: page, contents, cover, essay, entry, and splash. Also included are two sub-themes, "modern" (first three screenshots below) and "classic" (second three screenshots below), which can be controlled with the `$theme` variable as documented below.
-
-![test](source/img/promo-screenshots/modern-cover.png)
-
-![test](source/img/promo-screenshots/modern-contents.png)
-
-![test](source/img/promo-screenshots/modern-essay.png)
-
-![test](source/img/promo-screenshots/classic-essay.png)
-
-![test](source/img/promo-screenshots/classic-catalogue.png)
-
-![test](source/img/promo-screenshots/classic-entry.png)
-
-## Defined Variables
-
-This default theme includes a number of style variables intended to allow for relatively easy customization without having to dig into the stylesheets and CSS markup. They are explained below and can be found and changed in `/source/css/variables.scss` file. Take special note of thee `$theme` variable which can be set to "modern" or "classic", and the `$accent-color` variable which will give your publication a distinct feel in coloring all links, buttons and other navigation elements.
-
-| Variable Type | Variable | Expected Value | Description | 
-| ------------- | -------- | -------------- | ----------- |
-| Primary | $accent-color | color value  | The color of buttons, links and navigation elements |
-| | $content-background-color | color value | Main text area background color |
-| | $secondary-background-color | color value  | Additional background color, only for modern version of the theme |
-| | $theme | "modern", "classic" | Shifts the overall feel and typography of the publication  |
-| | $navbar | "normal", "accent" | Predefined options for your navbar, white or the accent color |
-| Page typography | $quire-base-font-size | unit value | 16px default |
-| | $quire-page-paragraph-style | "line-space", "indent" | Paragraph display styles, either a line space and no indent, or an indent and no line space | 
-| Cover typography | $quire-cover-text-color | color value | |
-| | $quire-cover-text-scale | integer | Use decimal numbers such as .8 or 1.3 to shift the text larger or smaller |
-| Menu colors | $quire-menu-color | color value | |
-| | $quire-menu-text-color | color value | |
-| Image viewer colors (pop-up figure viewer & entry page viewer) | $quire-entry-image-color | color value | The background of the image viewer on entry pages | 
-| | $quire-entry-image-icons-color | color value | | 
-| Highlight color | $quire-hover-color | color value | Used on active links and when hovering over table rows |
-| Print/PDF output | $print-width | unit value | 8.5in default|
-| | $print-height | unit value | 11in default |
-| | $print-bleed | unit value | .125in default | 
-| | $print-base-font-size | unit value | 8.5pt default |
-| | $print-text-color | color value | Specifying a plain black will avoid excessive color printing costs |
-| | $print-splash-color | color value | Background color for full-bleed splash pages | 
-| | $print-entry-image-color | color value | Background color for full-bleed image pages | 
-| | $print-entry-image-display | "all", "first" | Output "all" the images associated with an object on an entry page, or only the "first", main image |
-| Fonts | $quire-primary-font | font name | This theme includes three embedded, open license fonts, (Noto Sans, Noto Serif, and IBM Plex Sans Condensed) and also uses the widely available Times. While other fonts can be specified for use, do so with caution and line spacing, element width and margin can all shift from font to font. |
-| | $quire-headings-font | font name | See above |
-| | $quire-footnotes-font | font name | See above | 
-| | $quire-navigation-font | font name | See above |
-| Navbar | $quire-navbar-color | color value | | 
-| | $quire-navbar-hover-color | color value | | 
-| | $quire-navbar-text-color | color value | | 
-| Cover colors | $quire-cover-color-1 | color value | The cover includes a gradient of two colors, specified here, and a white/transparent wave graphic specified in the cover.md of the content files |
-| | $quire-cover-color-2 | color value | |
-| Layout sizes | $quire-menu-width | unit value | 352px default |
-| | $navbar-height | unit value | 3rem default |
-| | $quire-entry-header-height | unit value | 6rem default, determines the relative height of the entry page image viewer when in horizontal viewing mode | 
-| | $quire-map-height | unit value | 500px default | 
-| | $quire-deepzoom-height | unit value | 500px default |
-
-## Special Classes 
-
-| Class | Description |
-| ----- | ----------- |
-| page-one | For PDF output, should be used on the page/chapter where you want page 1 to start, `class: page-one`, often an Introduction or first essay rather than the Contents pages or other frontmatter |
-| backmatter | Can be applied to Markdown text with the `q-class` shortcode and text will be styled smaller, like the default footnotes style
-| is-pulled-left, is-pulled-right | Can be applied to figures or figure groups with their shortcodes, will make figures roughly half-column width and will float them to the left or right of the text |
-| brief, list, abstract, grid | Can be applied to pages with a `type: contents`, will alter how the contents are displayed |
-| side-by-side, landscape | Can be applied to pages with a `type: entry`, will alter how the image viewer is displayed |
-
-
-## Configuration Parameters
-
-Outside of the theme files themselves, a Quire project will also have a config.yml file which includes a number of parameters the theme relies on. 
-
-| Parameter | Expected Value | Description |
-| --------- | -------------- | ----------- |
-| searchEnabled | boolean | Turn on or off the built-in text search capability for users |
-| licenseIcons | boolean | Whether or not to display Creative Commons license icons |
-| pageLabelDivider | string | ". " default, etermines the text/spacing to be inserted between page .label and page .title |
-| citationPageLocationDivider | string | ", " default, determines the text/spacing to be inserted between the citation and the page number in the q-cite shortcode |
-| displayBiblioShort| boolean | Whether a bibilography generated with the q-cite or q-bibliography shorcodes should display the short form of the reference, along with the long. | 
-| imageDir | string | "img" default, the directory in the `/static/` directory where you put your images |
-| tocType | "full", "short" | "short" will hide all sub-section pages |
-| menuType | "full", "short" |  "short" will hide all sub-section pages |
-| prevPageButtonText | string | "Back" default |
-| nextPageButtonText | string | "Next" default |
-| entryPageSideBySideLayout | boolean | Entry pages can have a side-by-side layout with image on the left and text on the right, this can be controlled by `class: side-by-side` in the page YAML, or globally with this parameter |
-| entryPageObjectLinkText | string | "View in Collection" default |
-| figureLabelLocation | "on-top", "below" | Whether the figure label is "on-top" of the image in the upper left corner, or "below" it with the caption | 
-| figureModal | boolean | If figures should be clickable to open into a full-screen modal window |
-| figureModalIcons | boolean | Whether to display icons with the figure modal links |
-| figureZoom | boolean | Whether figures should zoom or not inside the modal | 
-
-## Development Info
-
-The default theme is paired with the [default starter](https://github.com/thegetty/quire/starters/default) demo content, and is included when running `quire new`.
-
-Consult [the Quire documentation](https://quire.getty.edu/) for more detailed information on publishing with Quire.
-
-### Testing
-
-The testing framework used for the `default-theme` is [Cypress](https://www.cypress.io/). The cypress tests are run for every pull request through circleci. However if you are developing the `default-theme` you can run the tests locally also. This is possible by running `npm install` and then running `npm run test:e2e:local` from the `default-theme`directory.
-
-## License
-
-Copyright © 2021, J Paul Getty Trust.

package/bin/themes/default/archetypes/default.md

@@ -1,2 +0,0 @@
-+++
-+++

package/bin/themes/default/cypress.json

@@ -1,7 +0,0 @@
-{
-"baseUrl": "http://localhost:1313",
-"fileServerFolder": "/",
-"pluginsFile": "tests/e2e/plugins/index.js",
-"chromeWebSecurity": false,
-"video": false
-}

package/bin/themes/default/layouts/_default/baseof.html

@@ -1,43 +0,0 @@
-{{/*
-  Baseof template. All other files inherit from this layout, so edit it with care.
-  The "main" bock has been added below to make it easy to slot in content from
-  different layouts into this template, just wrap your file in {{ define "main" }}
-  / {{ end }} tags.
-*/}}
-
-{{- $js := "js/application.js" | relURL -}}
-{{- $figureModal := .Site.Params.figureModal -}}
-
-{{- partial "tests/run.html" . -}}
-
-<!DOCTYPE html>
-<html lang="{{ .Site.Data.publication.language }}">
-  {{ partial "head.html" . }}
-  <body>
-    {{ partial "icons.html" . }}
-    {{- if eq .Site.Params.licenseIcons true -}}
-      {{ partial "icons-cc.html" . }}
-    {{- end -}}
-    {{- if eq .Site.Params.pdf true -}}
-      {{ partial "pdf-info.html" . }}
-    {{- end -}}
-    <div class="quire no-js" id="container">
-      <div class="quire__secondary remove-from-epub"
-          id="site-menu"
-          aria-expanded="false"
-          role="contentinfo">
-        {{ partial "menu.html" . }}
-      </div>
-
-      <div class="quire__primary" id="{{ with .Section }}{{ . | urlize }}-{{ end }}{{ .File.BaseFileName | lower }}">
-        {{ partial "navbar.html" . }}
-
-        {{ block "main" . }}
-
-        {{ end }}
-      </div>
-      {{ partial "search.html" . }}
-    </div>
-    {{ partial "scripts.html" (dict "context" . "figureModal" $figureModal) }}
-  </body>
-</html>

package/bin/themes/default/layouts/_default/single.html

@@ -1,26 +0,0 @@
-{{/*
-  Single page default template. Normal page content will appear in the
-  .Content outlet below.
-*/}}
-
-{{ define "main" }}
-<article class="{{ partial "page-class.html" . }} quire-page" id="main" role="main">
-  {{ partial "page-header.html" . }}
-  {{ if .Content }}
-  <section class="section quire-page__content" id="content">
-    <div class="container">
-      <div class="content">
-        {{ .Content }}
-        {{ partial "page-bibliography.html" . }}
-      </div>
-    </div>
-  </section>
-  {{ end }}
-  <section class="section quire-page__content">
-    <div class="container">
-      {{ partial "footer-buttons.html" . }}
-    </div>
-  </section>
-</article>
-{{ end }}
-

package/bin/themes/default/layouts/contents/single.html

@@ -1,37 +0,0 @@
-{{/*
-  Table of Contents (TOC) page template. Page content from the markdown will
-  appear in the .Content outlet below. The Table of Contents list will appear
-  below that. It is scoped to show the contents of the full site. Pages can be
-  removed from the TOC indivudally by adding "toc: false" to the page yaml.
-*/}}
-
-{{ define "main" }}
-<div class="{{ partial "page-class.html" . }} quire-contents" id="main" role="main">
-  {{ partial "page-header.html" . }}
-
-  <section class="section quire-page__content" id="content">
-
-    {{- if .Content -}}
-      <div class="container">
-        <div class="content">
-          {{ .Content }}
-        </div>
-      </div>
-    {{- end -}}
-
-    {{ $class := .Params.class }}
-    <div class="container {{ if in $class "grid" }}is-fullhd{{ end }}">
-      <div class="quire-contents-list {{ if in $class "grid" }} grid{{ else if in $class "abstract" }} abstract{{ else if in $class "brief" }} brief{{ else }} list{{ end }}">
-        {{ if .Section }}
-          {{ $scope := .File.Dir }}
-          {{- partial "contents-list/contents-list.html" (dict "site" .Site "contentsScope" $scope "contentsLocation" ".Params.toc" "contentsPage" . ) -}}
-        {{ else }}
-          {{ $scope := "" }}
-          {{- partial "contents-list/contents-list.html" (dict "site" .Site "contentsScope" $scope "contentsLocation" ".Params.toc" "contentsPage" . ) -}}
-        {{ end }}
-      </div>
-      {{ partial "footer-buttons.html" . }}
-    </div>
-  </section>
-</div>
-{{ end }}