@thegetty/quire-cli 0.20.3 → 0.20.4

package/bin/themes/default/layouts/partials/page-abstract.html

@@ -0,0 +1,7 @@
+<section class="section quire-page__abstract">
+  <div class="container">
+    <div class="content">
+      {{ .Params.abstract | markdownify }}
+    </div>
+  </div>
+</section>

package/bin/themes/default/layouts/partials/page-bibliography.html

@@ -0,0 +1,59 @@
+{{/*  Duplicates part of the code from q-cite.html in order to add
+      references to the page-level bibliography list */}}
+{{/* ---------------------------------------------------------------------- */}}
+{{- range .Params.references -}}
+
+  {{- $id := . -}}
+  {{- $full := "" -}}
+  {{- $short := "" -}}
+  {{- $alphaOrder := "" -}}
+
+  {{- range $.Site.Data.references.entries -}}
+      {{- if eq .id $id -}}
+
+          {{- $full = .full -}}
+
+          {{ if .short }}
+            {{- $short = .short -}}
+          {{ else }}
+            {{- $short = .id -}}
+          {{ end }}
+
+          {{ if .sort }}
+            {{- $alphaOrder = .sort -}}
+          {{ else }}
+            {{- $alphaOrder = .full -}}
+          {{ end }}
+
+      {{- end -}}
+  {{- end -}}
+
+  {{- $alphaOrder := $alphaOrder | truncate 400 | urlize -}}
+  {{- $.Page.Scratch.SetInMap "entry" "0" $short -}}
+  {{- $.Page.Scratch.SetInMap "entry" "1" $full -}}
+  {{- $entry := ($.Page.Scratch.GetSortedMapValues "entry") -}}
+  {{- $.Page.Scratch.SetInMap "cited" $alphaOrder $entry -}}
+  {{- $.Page.Scratch.Delete "entry" -}}
+
+{{- end -}}
+
+{{- if ($.Scratch.GetSortedMapValues "cited") }}
+<div class="quire-page__content__references backmatter">
+    {{ with .Site.Params.biblioHeading }}<h2 id="{{ urlize . }}">{{ . }}</h2>{{ end }}
+    {{- if eq .Site.Params.displayBiblioShort true }}
+    <dl>
+        {{- range ($.Scratch.GetSortedMapValues "cited") }}
+        {{/* the id is in a span because Pandoc otherwise strips them out from dt and dd for EPUBs for some reason */}}
+        <dt><span id="{{ urlize (index . 0) }}">{{ markdownify (index . 0) }}</span></dt>
+        <dd>{{ markdownify (index . 1)}}</dd>
+        {{- end }}
+    </dl>
+    {{- else }}
+    <ul>
+        {{- range ($.Scratch.GetSortedMapValues "cited") }}
+        <li id="{{ urlize (index . 0) }}">{{ markdownify (index . 1)}}</li>
+        {{- end }}
+    </ul>
+    {{- end }}
+</div>
+{{- end -}}

package/bin/themes/default/layouts/partials/page-class.html

@@ -0,0 +1,9 @@
+quire-page{{ with .Params.class -}}
+{{- $classlist := split . " " -}}
+{{- range $classlist }} quire-page--{{ . }}{{ end -}}
+{{- end -}}
+
+{{- range first 1 (where .Site.Pages "Params.class" "in" "page-one") -}}
+   {{- $.Scratch.Set "pageOneWeight" .Weight -}}
+{{- end -}}
+{{- if lt .Weight ($.Scratch.Get "pageOneWeight") }} quire-page--frontmatter{{ end -}}

package/bin/themes/default/layouts/partials/page-contributor.html

@@ -0,0 +1,48 @@
+{{/*
+
+  A partial to add contributors to page headers. Checks value of '
+  contributorByline set in config.yml and contributor_byline set in the page 
+  YAML to determine if the contributors should be added, and in what form.
+
+*/}}
+
+{{/* Define the list type */}}
+{{/* ---------------------------------------------------------------------- */}}
+{{- if eq .Params.contributor_byline "name" -}}
+  {{ $.Scratch.Set "listType" "list" }}
+{{- else if eq .Params.contributor_byline "name-title" -}} 
+  {{ $.Scratch.Set "listType" "list-plus" }}
+{{- else -}}
+  {{ $globalByline := $.Site.Params.contributorByline }}
+  {{- if eq $globalByline "name" -}}
+    {{ $.Scratch.Set "listType" "list" }}
+  {{- else if eq $globalByline "name-title" -}}
+    {{ $.Scratch.Set "listType" "list-plus" }}
+  {{- else -}}
+    {{ $.Scratch.Set "listType" "list-plus" }}
+  {{- end -}}
+{{- end -}}
+
+{{/* Check global setting, do nothing if set to false w/ no page override */}}
+{{/* ---------------------------------------------------------------------- */}}
+{{- if or (and (eq .Site.Params.contributorByline false) (eq .Params.contributor_byline false)) (and (eq .Site.Params.contributorByline false) (eq .Params.contributor_byline nil )) -}}
+
+{{- else -}} 
+  
+  {{/* Add contributor if contributor_byline is not false */}}
+  {{/* -------------------------------------------------------------------- */}}
+  {{- if ne .Params.contributor_byline false -}}
+  {{- if isset .Params "contributor_as_it_appears" -}}
+    <div class="quire-page__header__contributor">
+      <p class="quire-contributor">{{ markdownify .Params.contributor_as_it_appears }}<p>
+    </div>
+  {{- else -}}
+  {{- with .Params.contributor -}}
+    <div class="quire-page__header__contributor">
+      {{ partial "contributor-list.html" (dict "range" . "contributorType" "all" "listType" ($.Scratch.Get "listType") "Site" $.Site) }}
+    </div>
+  {{- end -}}
+  {{- end -}}
+  {{- end -}}
+
+{{- end -}}

package/bin/themes/default/layouts/partials/page-header.html

@@ -0,0 +1,22 @@
+{{- if isset $.Site.Params "imagedir" }}
+{{ $.Scratch.Set "imageDir" $.Site.Params.imageDir }}
+{{ else }}
+{{ $.Scratch.Set "imageDir" "" }}
+{{ end -}}
+<section class="{{ if or (eq .Title "title page") (eq .Title "half title page") }} is-screen-only {{ end }} quire-page__header hero">
+  <div class="hero-body">
+    {{/* Page Title */}}
+    <h1 class="quire-page__header__title" id="{{ .Title | urlize }}">
+      {{- with .Params.label }}<span class="label">{{ . }}<span class="visually-hidden">{{ $.Site.Params.pageLabelDivider }}</span></span>{{ end -}}
+      {{- partial "page-title.html" . | markdownify -}}
+    </h1>
+    {{/* Contributors, if any */}}
+    {{ partial "page-contributor.html" . }}  
+  </div>
+</section>
+
+{{- if .Params.image -}}
+{{- $imgPath := printf "%s/%s" ($.Scratch.Get "imageDir") .Params.image -}}
+  <section class="{{ if or (eq .Title "title page") (eq .Title "half title page") }} is-screen-only {{ end }} quire-page__header hero__image" style="background-image: url('{{ $imgPath | relURL }}');">
+  </section>
+{{- end -}}

package/bin/themes/default/layouts/partials/page-title.html

@@ -0,0 +1,9 @@
+{{/*
+
+  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.html
+
+*/}}
+{{- $endPunctuation := findRE "[!|?]$" .Page.Params.title -}}
+{{ .Page.Params.title }}{{ with .Page.Params.subtitle }}{{ if $endPunctuation }} {{ else }}: {{ end }}{{ . }}{{ end }}

package/bin/themes/default/layouts/partials/page-tombstone.html

@@ -0,0 +1,36 @@
+{{/* Entry tombstone data */}}
+{{ range .Params.object }}
+  <section class="quire-entry__tombstone">
+    <div class="container">
+      <table class="table is-fullwidth">
+        <tbody>
+        {{ if .id }}
+          {{ $.Scratch.Set "id" .id }}
+          {{ range $.Site.Data.objects.object_display_order }}
+            {{ $.Scratch.Set "key" . }}
+            {{ range where $.Site.Data.objects.object_list "id" "eq" ($.Scratch.Get "id") }}
+              {{ range $key, $value := . }}
+              {{ if and (eq $key ($.Scratch.Get "key")) (ne $value nil) }}
+                <tr><td>{{ $key | humanize | title }}</td><td>{{ markdownify $value }}</td></tr>
+              {{ end }}
+              {{ end }}
+            {{ end }}
+          {{ end }}
+        {{ else }}
+          {{ range $key, $value :=  . }}
+          <tr><td>{{ $key | humanize | title }}</td><td>{{ markdownify $value }}</td></tr>
+          {{ end }}
+        {{ end }}
+        </tbody>
+      </table>
+      {{ if .id }}
+        {{ range where $.Site.Data.objects.object_list "id" "eq" .id }}
+          {{ if .link }}
+          <a href="{{ .link | relURL }}" target="_blank" class="button">{{ $.Site.Params.entryPageObjectLinkText }} {{- partial "icon.html" (dict "type" "link" "description" "") -}}</a>
+          {{ end }}
+        {{ end }}
+      {{ else }}
+      {{ end }}
+    </div>
+  </section>
+{{ end }}

package/bin/themes/default/layouts/partials/pdf-info.html

@@ -0,0 +1,20 @@
+{{/* Adds info to use in PrinceXML running page footers ------ */}}
+
+{{/* Get the Section’s landing page title if one exists */}}
+{{/* ---------------------------------------------------------------------- */}}
+{{- if .Section -}}
+  {{- range where $.Site.Pages "Section" .Section -}}
+    {{- if eq .Slug "." -}}
+        {{ $.Scratch.Set "sectionTitle" .Title }}
+    {{- end -}}
+  {{- end -}}
+{{- end -}}
+
+{{/* Add info to page in hidden DIV */}}
+{{/* ---------------------------------------------------------------------- */}}
+<div style="display: none">
+  <span class="pdf-page-title">
+    {{ with .Params.label }}{{ . }}{{ $.Site.Params.pageLabelDivider }}{{ end }}{{ if .Params.short_title }}{{ .Params.short_title | markdownify }}{{ else }}{{ .Title | markdownify | truncate 35 }}{{ end }}</span>
+  <span class="pdf-page-section">{{ if ne ($.Scratch.Get "sectionTitle") "" }}{{ $.Scratch.Get "sectionTitle" }}{{ else }}{{ .Section | humanize }}{{ end }}</span>
+</div>
+{{- $.Scratch.Delete "sectionTitle" -}}

package/bin/themes/default/layouts/partials/pdf-title-pages.html

@@ -0,0 +1,39 @@
+{{/*
+    half title page and title page page layout for PDF output only
+*/}}
+
+{{- if eq .site.Params.pdf true }}
+<div class="fullPageBreak"></div>
+<div class="half-title-page">
+  {{ if .site.Data.publication.title }}
+  <span class="title-htp">
+    {{ .site.Data.publication.title }}
+  </span>
+  {{ end }}
+</div>
+<div class="fullPageBreak"></div>
+<div class="title-page">
+  {{ if .site.Data.publication.title }}
+  <span class="title-tp">
+    {{ .site.Data.publication.title }}
+  </span><br />
+  {{ end }}
+  {{ if .site.Data.publication.subtitle }}
+  <span class="sub-title">
+    {{ .site.Data.publication.subtitle }}
+  </span><br />
+  {{ end }}
+  <span class="contributor">
+    {{ if .site.Data.publication.contributor_as_it_appears }}
+      {{ .site.Data.publication.contributor_as_it_appears | markdownify }}
+    {{ else }}
+      {{ partial "contributor-list.html" (dict "range" .site.Data.publication.contributor "contributorType" "primary" "listType" "string" "Site" .site) }}
+    {{ end }}
+  </span><br />
+  <span class="publisher">
+    {{ range .site.Data.publication.publisher }}
+    {{ if .name }}{{ .name }}{{ end }}{{ if and (.name) (.location) }}, {{ end }}{{ if .location }}{{ .location }}{{ end }}
+    {{ end }}
+  </span>
+</div>
+{{ end -}}

package/bin/themes/default/layouts/partials/scripts.html

@@ -0,0 +1,5 @@
+{{- $js := "js/application.js" | relURL -}}
+{{- $jsCustom := "js/custom.js" | relURL -}}
+<script type="text/javascript"> var figureModal ={{ .figureModal }}</script>
+<script src="{{ $js }}"></script>
+<script src="{{ $jsCustom }}"></script>

package/bin/themes/default/layouts/partials/search.html

@@ -0,0 +1,52 @@
+{{- if isset $.Site.Params "imagedir" }}
+{{ $.Scratch.Set "imageDir" $.Site.Params.imageDir }}
+{{ else }}
+{{ $.Scratch.Set "imageDir" "" }}
+{{ end -}}
+{{- $imgDir := $.Scratch.Get "imageDir" -}}
+
+<div id="js-search"
+     class="quire-search"
+     aria-expanded="false"
+     data-search-index='{{ ref . "/search-index.md" }}'>
+  <div class="quire-search__close-button">
+    <button class="button is-medium" onclick="toggleSearch()">
+      {{- partial "icon.html" (dict "type" "close" "description" "Close search window") -}}
+    </button>
+  </div>
+
+  <div class="quire-search__inner" aria-label="search results">
+    <section class="hero">
+      <div class="hero-body">
+        <div class="container">
+          <div class='input-bar'>
+            <input id="js-search-input"
+                 class="input is-large"
+                 name="search"
+                 type="text"
+                 placeholder="Search this publication" 
+                 value=""
+                 oninput="search()" />
+            <span>
+              {{- partial "icon.html" (dict "type" "search" "description" "Search") -}}
+            </span>
+          </div>
+
+          <ul id="js-search-results-list"
+              class="quire-search__inner__list">
+          </ul>
+        </div>
+      </div>
+    </section>
+    </div>
+  </div>
+
+  <template id="js-search-results-template">
+    <li class="quire-search__inner__list-item">
+      <a class="js-search-results-item" href="">
+        <h2 class="title"><span class="js-search-results-item-title"></span></h2>
+      </a>
+        <p><span class="js-search-results-item-type"></span> | <span class="js-search-results-item-length"></span> words</p>
+    </li>
+  </template>
+</div>

package/bin/themes/default/layouts/partials/site-title.html

@@ -0,0 +1,9 @@
+{{/*
+
+  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.html
+
+*/}}
+{{- $endPunctuation := findRE "[!|?]$" .Site.Data.publication.title -}}
+{{ .Site.Data.publication.title }}{{ with .Site.Data.publication.subtitle }}{{ if $endPunctuation }} {{ else }}: {{ end }}{{ . }}{{ end }}{{ with .Site.Data.publication.reading_line }} ({{ . }}){{ end }}

package/bin/themes/default/layouts/partials/tests/check-node-modules.html

@@ -0,0 +1,9 @@
+{{ $themeDependencies := "themes/default/node_modules" }}
+
+{{ if fileExists $themeDependencies }}
+
+{{ else }}
+
+  {{ errorf "%q is missing! \n\nQUIRE FIX --> Run `quire install`. Running `quire install` will install missing theme node_modules dependencies. It only needs to be run once for this project. It is necessary when cloning/copying an existing Quire project from another source rather than starting it with `quire new`.\n"  $themeDependencies }}
+
+{{ end }}

package/bin/themes/default/layouts/partials/tests/check-page-one-class.html

@@ -0,0 +1,21 @@
+{{ $pages := .Site.Pages }}
+{{ $pages = where $pages ".Type" "!=" "data" }}
+{{ $pageClassOne := slice }}
+
+{{ range $pages }}
+
+  {{ if in .Params.class "page-one" }}
+
+    {{ $pageClassOne = $pageClassOne | append .Path }}
+
+  {{ end }}
+
+{{ end }}
+
+{{ if gt $pageClassOne 1 }}
+
+  {{ $pageList := delimit $pageClassOne ", " }}
+
+  {{ errorf "More than one page with `class: page-one`! \n\nQUIRE FIX --> Remove `class: page-one` from all but one of these Markdown files: %s. Using `class: page-one` in the YAML of a page sets sets that page to be numbered as page 1 in the PDF output of your project. Pages before `page-one` will be numbered with lowercase Roman numerals (i, ii, iii, ix, etc.).\n" $pageList }}
+
+{{ end }}

package/bin/themes/default/layouts/partials/tests/check-page-weights.html

@@ -0,0 +1,49 @@
+{{ $pages := .Site.Pages }}
+{{ $pages = where $pages ".Type" "!=" "data" }}
+
+{{ $pageWeights := "" }}
+{{ $duplicatePageWeight := slice }}
+{{ $otherPageWeight := slice }}
+{{ $noPageWeight := slice }}
+
+{{ range $pages }}
+
+  {{ if .Weight }}
+
+    {{ if in (string $pageWeights) (string .Weight) }}
+
+      {{ $duplicatePageWeight = $duplicatePageWeight | append .Weight }}
+
+    {{ else }}
+
+      {{ $pageWeights = delimit (slice $pageWeights .Weight) ", " }}
+
+    {{ end }}
+
+  {{ else }}
+
+    {{ $noPageWeight = $noPageWeight | append .Path }}
+
+  {{ end }}
+
+{{ end }}
+
+{{ if gt $noPageWeight 0 }}
+
+  {{ $noPageWeightList := delimit $noPageWeight ", " }}
+
+  {{ errorf "One or more Markdown files with no page weight! \n\nQUIRE FIX --> Assign a unique weight that is greater than zero (0) to these Markdown files: %s. Having a valid weight on each page ensures your project pages are ordered correctly.\n" $noPageWeightList }}
+
+{{ end }}
+
+{{ if gt $duplicatePageWeight 0 }}
+
+  {{ $allDupes := slice }}
+  {{ range where $pages "Weight" "in" $duplicatePageWeight }}
+    {{ $allDupes = $allDupes | append .Path }}
+  {{ end }}
+  {{ $allDupesList := delimit $allDupes ", " }}
+
+  {{ errorf "Some Markdown files have duplicate page weights! \n\nQUIRE FIX --> Assign a unique weight to these Markdown files: %s. Having a unique weight ensures your project pages are ordered correctly.\n"   $allDupesList }}
+
+{{ end }}

package/bin/themes/default/layouts/partials/tests/run.html

@@ -0,0 +1,13 @@
+{{ if ne .Site.Params.runTests false }}
+
+  {{ partial "tests/check-node-modules.html" . }}
+
+  {{ partial "tests/check-page-weights.html" . }}
+
+  {{ partial "tests/check-page-one-class.html" . }}
+
+{{ else }}
+
+  {{ warnf "\n\nQuire tests are currently disabled. To enable them, set the `runTests` parameter to true in your projects’s config.yml file." }}
+
+{{ end }}

package/bin/themes/default/layouts/partials/twitter-card.html

@@ -0,0 +1,23 @@
+{{ if ne .Type "essay" -}}
+  <!-- Books and Integrated Book Parts/Chapters -->
+  <meta name="twitter:card" content="summary_large_image">
+  <meta name="twitter:site" content="{{ .Site.BaseURL }}">
+  <meta name="twitter:title" content="{{ partial "site-title.html" . }}">
+  <meta name="twitter:description" content="{{ if .Site.Data.publication.description.one_line }}{{ .Site.Data.publication.description.one_line }}{{ else }}{{ with .Site.Data.publication.description.full }}{{ . | truncate 160 }}{{ end }}{{ end }}">
+  <meta name="twitter:image" content="{{ with .Site.Data.publication.promo_image }}{{ $.Site.BaseURL }}{{ $.Site.Params.imageDir }}{{ . }}{{ end }}">
+{{ else -}}
+  <!-- Standalone Essays/Articles w/i Books  -->
+  <meta name="twitter:card" content="summary_large_image">
+  <meta name="twitter:site" content="{{ .Permalink }}">
+  <meta name="twitter:title" content="{{ partial "page-title.html" . }}">
+  {{ if .Page.Params.abstract -}}
+  <meta name="twitter:description" content="{{ .Page.Params.abstract | truncate 160 }}">
+  {{ else -}}
+  <meta name="twitter:description" content="{{ if .Site.Data.publication.description.one_line }}{{ .Site.Data.publication.description.one_line }}{{ else }}{{ with .Site.Data.publication.description.full }}{{ . | truncate 160 }}{{ end }}{{ end }}">
+  {{ end -}}
+  {{ if .Page.Params.cover -}}
+  <meta property="twitter:image" content="{{ .Site.BaseURL }}{{ .Site.Params.imageDir }}{{ .Site.Params.figureSubDir }}{{ .Page.Params.cover }}" />
+  {{ else -}}
+  <meta property="twitter:image" content="{{ with .Site.Data.publication.promo_image }}{{ $.Site.BaseURL }}{{ $.Site.Params.imageDir }}{{ . }}{{ end }}" />
+  {{ end -}}
+  {{ end -}}

package/bin/themes/default/layouts/shortcodes/q-bibliography.html

@@ -0,0 +1,61 @@
+{{/*
+
+  This shortcode generates a bibliography from the entries in the project's
+  `references.yml` file.
+
+  By default, the bibliography will be sorted by each entry’s `full` value.
+  However, this can be overridden by including a `sort` value on any
+  individual entries that you want sorted otherwise.
+
+  Also, in `config.yml` the `displayBiblioShort` property can be set to "true"
+  to display both the short and the full bibliography values in the output.
+  Without this property set, the bibliography will not include the short form.
+
+*/}}
+
+{{- range $.Site.Data.references.entries -}}
+
+  {{- $bibFull := .full -}}
+
+  {{- $bibShort := "" -}}
+  {{ if .short }}
+    {{- $bibShort = .short -}}
+  {{ else }}
+    {{- $bibShort = .id -}}
+  {{ end }}
+
+  {{- $bibSort := "" -}}
+  {{ if .sort }}
+    {{- $bibSort = .sort -}}
+  {{ else }}
+    {{- $bibSort = .full -}}
+  {{ end }}
+  {{- $bibSort = $bibSort | truncate 400 | urlize -}} 
+
+  {{- $.Page.Scratch.SetInMap "ref" "0" $bibShort -}}
+  {{- $.Page.Scratch.SetInMap "ref" "1" $bibFull -}}
+  {{- $ref := ($.Page.Scratch.GetSortedMapValues "ref") -}}
+  {{- $.Page.Scratch.SetInMap "biblio" $bibSort $ref -}}
+  {{- $.Page.Scratch.Delete "ref" -}}
+
+{{- end -}}
+
+{{- if ($.Page.Scratch.GetSortedMapValues "biblio") }}
+<div class="quire-page__content__references">
+    {{- if eq .Site.Params.displayBiblioShort true }}
+    <dl>
+        {{- range ($.Page.Scratch.GetSortedMapValues "biblio") -}}
+        {{/* the id is in a span because Pandoc otherwise strips them out from dt and dd for EPUBs for some reason */}}
+        <dt><span id="{{ urlize (index . 0) }}">{{ markdownify (index . 0) }}</span></dt>
+        <dd>{{ markdownify (index . 1)}}</dd>
+        {{- end }}
+    </dl>
+    {{- else }}
+    <ul>
+        {{- range ($.Page.Scratch.GetSortedMapValues "biblio") }}
+        <li id="{{ urlize (index . 0) }}">{{ markdownify (index . 1)}}</li>
+        {{- end }}
+    </ul>
+    {{- end }}
+</div>
+{{- end -}}

package/bin/themes/default/layouts/shortcodes/q-cite.html

@@ -0,0 +1,79 @@
+{{/*
+
+  This shortcode adds a linked Author Date citation reference to the text, and a
+  hover pop-up with the full citation text. It also adds the citation to a map
+  of cited works, which can then be output as a page-level bibliography on essay
+  and entry type pages. Example:
+
+  {{< q-cite "Faure 1909" "54" >}}
+
+  The first positional parameter is a short form citation that should match one
+  in `references.yml`. The second, optional parameter is a page reference. The
+  above sample would output as: Faure 1909, 54.
+  
+  A third optional parameter allows you to customize the text to appear in the 
+  link if not the short form of the citation. The following sample would appear 
+  simply as: 1909, 54.
+  
+  {{< q-cite "Faure 1909" "54" "1909" >}}
+  
+  In using this third parameter, you still need to have the second parameter 
+  even if it’s empty. The following sample would appear simply as: 1909.
+  
+  {{< q-cite "Faure 1909" "" "1909" >}}
+
+  The text element between the author date reference and the page can be changed
+  with the `citationPageLocationDivider` property in `config.yml`.
+
+*/}}
+
+{{- $errorMissingValue := dict "shortcode" "q-cite" "message" "1, 2 or 3 values must be supplied with this shortcode. The first is required and should match a short reference in the project’s `references.yml` file, the second is optional, and should be a page number or range of page numbers, the third is optional and should be the text to appear in the link if not the full short form of the reference" "example" "{{< q-cite &#34;Faure 1909&#34; &#34;304&#34; &#34;1909&#34; >}}" -}}
+
+{{- $errorMissingReference := dict "shortcode" "q-cite" "message" "The id supplied doesn’t match one in the project’s `references.yml` file" "example" "{{< q-cite &#34;Faure 1909&#34; >}}<br /><br />id: &#34;Faure 1909&#34;" -}}
+
+{{- if gt (len .Params) 3 -}}
+
+  {{- partial "error-message.html" $errorMissingValue -}}
+
+{{- else -}}
+
+  {{- $id := .Get 0 -}}
+  {{- $full := "" -}}
+  {{- $short := "" -}}
+  {{- $alphaOrder := "" -}}
+
+  {{- range $.Site.Data.references.entries -}}
+    {{- if eq .id $id -}}
+    
+        {{- $full = .full -}}
+        
+        {{- if .short -}}
+          {{- $short = .short -}}
+        {{- else -}}
+          {{- $short = .id -}}
+        {{- end -}}
+        
+        {{- if .sort -}}
+          {{- $alphaOrder = .sort -}}
+        {{- else -}}
+          {{- $alphaOrder = .full -}}
+        {{- end -}}
+        {{- $alphaOrder = $alphaOrder | truncate 100 | urlize -}}
+        
+    {{- end -}}
+  {{- end -}}
+
+  {{- if eq $full "" -}}
+
+    {{- partial "error-message.html" $errorMissingReference -}}
+
+  {{- else -}}
+
+    {{- $.Page.Scratch.SetInMap "entry" "0" $short -}}
+    {{- $.Page.Scratch.SetInMap "entry" "1" $full -}}
+    {{- $entry := ($.Page.Scratch.GetSortedMapValues "entry") -}}
+    {{- $.Page.Scratch.SetInMap "cited" $alphaOrder $entry -}}
+    <span class="quire-citation expandable">{{ if ne .Site.Params.citationPopupStyle "icon" }}<span class="quire-citation__button" role="button" tabindex="0" aria-expanded="false">{{ end }}{{- if eq (len .Params) 3 }}{{- .Get 2 -}}{{ else }}{{- markdownify $short -}}{{ end }}{{- if eq (len .Params) 2 }}{{ $.Site.Params.citationPageLocationDivider }}{{ .Get 1 }}{{ end -}}{{ if eq .Site.Params.citationPopupStyle "icon" }}<button class="quire-citation__button material-icons md-18 material-control-point" aria-expanded="false">control_point</button>{{ end }}{{ if ne .Site.Params.citationPopupStyle "icon" }}</span>{{ end }}<span hidden class="quire-citation__content"><span class="visually-hidden">Citation: </span>{{- markdownify $full -}}</span></span>
+  {{- end -}}
+
+{{- end -}}

package/bin/themes/default/layouts/shortcodes/q-class.html

@@ -0,0 +1,3 @@
+<div class="{{ with .Get 0 }}{{ . }}{{ end }}">
+  {{ .Inner | markdownify }}
+</div>