yaml.md

title	type	weight
YAML	essay	401

Configuration

Location: config.yml

Type: Object

Object Properties	Expected Value	Description
baseURL	url	The base url for your project.
blackfriday	object	Options for Blackfriday, Hugo’s markdown renderer. See below.
canonifyURLs	boolean	Converts all internal links to being in complete cannonical format. Default is false.
footnoteReturnLinkContents	string	Controls the appearance of the link added to the end of footnotes. Default is "↩".
metaDataFormat	"yaml", "toml", "json"	Default is "yaml"
params	object	Additional parameters for Quire. See below.
relativeURLs	boolean	Keeps all internal links relative. Default is true.
theme	url/id	The name of the theme, in the theme directory you’re using. Quire starter kit default is quire-base-theme

See: Additional Hugo configuration options

Black Friday Markdown

Location: blackfriday in config.yml

Type: Object

Object Properties	Expected Value	Description
fractions	boolean	When set to true any numbers separated by a slash are automatically converted to fractions. Default is false. Though even then 1/4, 1/2 and 3/4 are still converted. Recommend always using proper unicode fractions: ¼, ½, ¾, ⅛, ⅜, ⅝, ⅞.

See: Additional Blackfriday markdown configurations options

Quire Parameters

Location: params in config.yml

Type: Object

Object Properties	Expected Value	Description
displayBiblioShort	boolean	When true the short citation form (ie., "Smith 2003") will be displayed with the full form, when creating a bibliography on pages with type: essay, or on other pages with the q-bibliography shortcode. Default is true.
citationPageLocationDivider	string	Default is ", ".
imageDir	string	The project’s main image directory inside the static directory. Default is "/img/".
figureLabels	boolean	Default is true.
figureLabelsTextBefore	string	Default is "Figure "
figureLabelsTextAfter	string	Default is ". "
videoFigureFallbackText	boolean	Default is true.
videoFigureFallbackTextBefore	string	Default is "Watch the video at "
videoFigureFallbackTextAfter	string	Default is "."
menuType	"short", "full"	Default is "short"
searchEnabled	boolean	Default is true
tocType	"short", "full"	Default is "full"

Publication

Location: publication.yml

Type: Object

Object Properties	Expected Value	Description
title	string	The title of your publication.
subtitle	string	The subtitle of your publication.
short_title	string	A short version of your title, primarily for use in navigation elements with limited space.
reading_line	string	An additional title line for your publication.
url	url	The full URL of your final publication.
pub_type	"book", "journal-periodical", "other"	Can be one of three values. Determines how key search-engine metadata is defined.
pub-date	YYYY-MM-DD	The first date your publication will be released
language	2-letter ISO 639-1 language code(s)	Taken from the the list at https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. List multiple languages using a comma-separated list.
identifier	object	See below.
publisher	array	See below.
series_periodical_name	string
series_issue_number	string
contributor	array	See below.
contributor_as_it_appears	string
promo_image	url
description	object	See below.
subject	array	See below.
library_of_congress_cip_data	list
copyright	string
license	object	See below.
resource_link	array	See below.
revision_history	array	See below.
repository_url	url	A public repository of the source code and revision history for the publication.

Publisher

Location: publisher in publication.yml

Type: Array

Item Attributes	Expected Value	Description
name	string	Name of the publisher
location	string	Publisher location, city.
url	url	Publisher homepage.

Description

Location: description in publication.yml

Type: Object

Object Properties	Expected Value	Description
one_line	string
full	string
online	string	The online and pdf_ebook fields allow you to add additional text to the full description that is specific to either the online, or the PDF/EPUB/MOBI editions and will only show up there. For instance, in order to point to special features in one or the other of the formats.
pdf_ebook	string

Subject

Location: subject in publication.yml

Type: Array

Item Attributes	Expected Value	Description
type	"keyword", "bisac", "getty"
name	string
identifier	string

License

Location: license in publication.yml

Type: Object

Object Properties	Expected Value	Description
name	string	Name of the license.
abbreviation		If using a Creative Commons licenses, should match one of the seven available options: "CC0", "CC BY", "CC BY-SA", "CC BY-ND", "CC BY-NC", "CC BY-NC-SA", or "CC BY-NC-ND".
url	url	Link to the license text.
icon	url
scope	"text-only", "full", "some-exceptions"
online_text	string	Markdown okay. Will override the automatically generated license text for the online edition only.
pdf_ebook_text	string	Markdown okay. Will override the automatically generated license text for the PDF and e-book editions only.

Resource Link

Location: resource_link in publication.yml

Type: Array

Item Attributes	Expected Value	Description
name	string	How the link will be named.
type	"other-format", "related-resource", "footer-link"
media_type	string	Taken from the list at https://www.iana.org/assignments/media-types/media-types.xhtml
link_relation	string	Taken from the list at http://www.iana.org/assignments/link-relations/link-relations.xhtml
url	url	URL to web resource or to download.
identifier	object	See below.
file_size_mb	integer	For downloads, file size in megabytes. Often appended to name in the interface, depending on your theme.
icon	url

Revision History

Location: revision_history in publication.yml

Type: Array

Item Attributes	Expected Value	Description
date	YYYY-MM-DD
summary	list

Identifier

Location: identifier in top level of publication.yml, in any .Page.Params., or in any resource_link

Type: Object

Item Attributes	Expected Value	Description
isbn	10- or 13-digit ISBN	For use with pub-type of "book". ISBNs can be purchased indivudally or in packages at http://www.isbn.org/.
issn	8-digit ISSN	For use with pub-type of "journal-periodical". ISSNs can be requested through http://www.issn.org/.
doi	string	Not yet implemented.
uuid	string	Not yet implemented.

Contributor

Location: contributor in publication.yml or in any .Page.Params.

Type: Array

Item Attributes	Expected Value	Description
id
type	"primary", "secondary", "project-team"
first_name
last_name
full_name
file_as
title
affiliation
role
role_code	3-letter role code	Taken from the list at https://www.loc.gov/marc/relators/relaterm.html
url
bio
pic

Figure

Location: figure_list in figures.yml

Type: Array

Item Attributes	Expected Value	Description
id	string	Numbers and lowercase letters only, with no spaces or special characters (001, fig-01a, etc).
src	url	Should be the file name of a JPG, PNG or GIF image (fig01.jpg). Avoid using spaces or special characters, and if it’s in a sub-folder within the main imgdirectory (which is defined by the imageDir parameter in the config.yml file), it should include that sub-folder name as well (comparatives/fig01.jpg).
alt	string	For accessibility, all images should have alternative text descriptions. (Tips on crafting good alt text.) Only ever leave blank if the image is purely decorative.
caption	string	The caption to appear below the figure. Special characters are allowed. Use Markdown for formatting.
credit	string	Follows the caption. Markdown allowed.
media_type	"youtube", "vimeo"	Currently supports video hosted on YouTube or Vimeo. (May eventually expand to HTML5 video, audio, and Soundcloud, and others.) When a media_type is defined, a media_id must be as well. For video, it is also recommended that an image src still be used (presumably being a screenshot from the video) so as to provide a fallback for PDF and EPUB output.
media_id	string	The ID of the video resource on YouTube or Vimeo. For example, in the URLs https://www.youtube.com/watch?v=VYqDpNmnu8I or https://youtu.be/VYqDpNmnu8I, the media_id would be VYqDpNmnu8I; and in https://vimeo.com/221426899 it is 221426899.
aspect_ratio	"standard", "widescreen"	For use with video media_types to properly scale video embeds. When no value is provided, the default is "widescreen".
label_text	string	Used for the q-figure-group shortcode only. A short text label added to the image, usually just under the image depending on your theme. If no text is provided here, a label is automatically generated from the provided id value along with the imageLabelContentBefore and imageLabelContentAfter values defined in your config.yml file.

Bibiliography

Location: entries in references.yml

Type: Array

Item Attributes	Expected Value	Description
short	string	The short form of the citation, ie., Brown 1984.
full	string	The full form of the citation, ie.,

Object

Location: object_list in objects.yml

Type: Array

Attribute	Expected Value	Description
id	string	Required. Used to reference objects from entry pages. Should be numbers and lowercase letters only, with no spaces or special characters (001, fig-01a, etc).
figure	array	A list of one or more images of the object. It is recommended that this list be only of id values corresponding with ids in your project’s figures.yml file.
link	url	A URL link to a page with more/current information on the object. Usually the object in the museum’s online collection pages.
date_start, date_end	integer	Reserved for future use in Quire.
dimension_width, dimension_height, dimension_depth	integer	Reserved for future use in Quire.

Objects also support arbitrary attributes, which might include title, artist, collection, etc. Those added will be output in a table on collection catalogue entry pages. The ordering of the display can be controlled with object_display_order in objects.yml.

See: Guide on Collection Catalogues

Page

Location: Any page in content/

Type: Object

Attribute	Expected Value	Description
number	integer	# for chapter/paper numbering.
title	string
subtitle	string
short_title	string
type	"page"',' "essay", "entry", "cover", "contents", "about", "data", "search"
class
weight	integer
object	array	See above.
contributor	array	See above.
abstract	string
slug
display	"online", "menu", "pdf_ebook", "toc"

The object and contributor attributes above are arrays of one or more items. The details of what YAML values each of those items can have, can be found in the Catalogue Entries and Contributors sections respectively.