Manuscript Conversion

• [ ] Clone the project repository using GitHub Desktop. Make sure to check the README.md to see if there are any special instructions.
• [ ] Open Terminal, navigate into the project folder, and run npm install. Once that process is done, run quire preview to make sure everything is working properly.
• [ ] Back in GitHub Desktop, create a new branch off the main branch called first-pages. Add another branch based on that one called first-pages-your-name. This latter branch is the one you will do all your work in.
• [ ] Create a new directory in the cloned repository called manuscript. Copy the manuscript Word files from the server and place them in this folder.
• [ ] Convert the Word files into individual Markdown files with Pandoc.
• [ ] Create two separate folders markdown-files and transmittal-files within the manuscript folder and sort the files accordingly.
• [ ] Open the project in your text editor.
• [ ] Complete the publication.yaml to the best of your ability. Much of the information needed here can be pulled from the frontmatter provided in the manuscript and Consonance. It’s also helpful to refer to older Quire publications to help complete this section.
• [ ] Create an outline by either adding new .md files to the content folder or renaming old ones from the starter. Follow the structure of the manuscript’s table of contents. These .md files will serve as placeholders for the converted Markdown content which you will add in a later step.
• [ ] Add or edit basic page YAML at the top of each Markdown file. The title comes the from the manuscript toc. The order value determines how the pages are ordered. It’s advisable to use increments of 10 in case extra pages are added later. You will also include a layout value, which will depend on the content of the page. Additional YAML may need to be added such as short_title, which is included if the main title is too long. Below is a list of the most common page YAML attributes:

---
label:
title:
subtitle:
short_title:
order:
layout:
contributor:
object:
---

• [ ] Make sure the index.md file which serves as the cover page has the following page YAML:

---
title: "Cover"
order: "1"
layout: "cover"
menu: false
toc: false
image: "spiral-overlay.png"
---

• [ ] Add the following Liquid shortcode to the index.md file, below the page YAML:

{{ publication.description.full }}

• [ ] Update the pdf-epub-copyright.md, pdf-epub-half-title.md, and pdf-epub-title.md by looking at the frontmatter and at previous Quire publications. Make sure the page YAML includes the following:

---
title: "Copyright"
layout: "page"
order: "4"
classes:
  - copyright-page
outputs:
  - epub
  - pdf
toc: false
menu: false
---

---
title: "Half Title" 
layout: "base.11ty.js"
classes:
  - half-title-page
order: 2
outputs:
  - epub
  - pdf
toc: false
---

---
title: "Title "
layout: "base.11ty.js"
classes:
  - title-page
order: 3
outputs:
  - pdf
  - epub
toc: false
menu: false
---

• [ ] Make sure there is an about.md file for the online publication. Similar to the pdf-epub-copyright.md file, it’s best to look at older publications when filling out this page. Also, use Liquid shortcodes whenever possible. The about.md file should include the following page YAML (please note, the About page appears at the end of the publication, so add the order value accordingly):

---
title: "About"
layout: "page"
class: "backmatter"
order:
toc: false
outputs:
  - html
---

• [ ] Add the Quire credit line to config.yaml.

quire_credit_line: 'This publication was created using Quire™, a multiformat publishing tool from Getty.'

• [ ] Update the license text in the _includes/components/copyright/licensing.js file and then include the following note at the top of the page noting what change was made:

//
// CUSTOMIZED FILE
// Updated the image exclusions language, line 26
//

• [ ] Add the following text to the README.md under “Customizations” to keep track of changes made to the template.

_includes/components/copyright/licensing.js
Updated licensing language

• [ ] Make sure there is a contents.md file in the contents directory. This will serve as your Table of Contents. The contents of this page is automatically generated. The page YAML for the Table of Contents can include the following, although the presentation value may change based on the publication:

---
layout: "table-of-contents"
title: "Contents"
search: false
presentation: "list"
order: "5"
---

• [ ] Depending on the particular project you are working on, you may also need to include or delete a contributor.md, bibliography.md, or glossary.md file. You will use Liquid shortcodes to pull in this information. An example of a possible shortcode used in a contributor.md file is:

{% contributors context=publicationContributors format='bio' %}

• [ ] Cut-and-paste the converted Markdown content (found in the manuscript/markdown-files/ folder) into the individual .md placeholder pages.
• [ ] Format the footnotes section with
  {% backmatter %}
## Notes
{% endbackmatter %}
• [ ] Scan the Markdown files for any formatting issues or errors that may have been created during the conversion process.
• [ ] In the content/_data/ directory, open the relevant YAML files, delete the old information or comment it out, and add the new data provided in teh manuscript. You will always have a figures.yaml. You may also have an objects.yaml, a glossary.yaml file, or a references.yaml file. Learn more in the Navigating Quire section of this guide.
• [ ] Skim the Markdown text for figure and table callouts and format them properly: [fig. 1](#fig-1). Do the same for any internal links to other parts of the catalogue.
• [ ] Add images to project by running the command git submodule update in Terminal.
• [ ] Insert figure images using the figure shortcode:

{% figure id="X" %}

• [ ] Check with Greg to see if certain images should be grouped or pulled left or right.
• [ ] Use Regular Expression (or RegEx) to converted tagged Markdown into shortcodes. Here is an example of the Regex for creating author date citations:

Find: \$\$(.*?)\$\$
Replace: {% cite '$1' %}

That will reformat the tagged Markdown into the proper citation shortcode:

{% cite "Author XXXX" %}

• [ ] If there are any glossary terms, use the following RegEx:

Find: &(.*?)&
Replace: {% def '$1' %}

• [ ] Check tables for Markdown symbols. Markdown does not work in tables. You will need to apply HTML tags instead. For example, for text within a table to appear italicized it would be written as <em>italics</em> as opposed to *italics*.
• [ ] Check for superscript and subscript characters. Superscript characters will appear surrounded by ^ and subscript charaters will appear surrounded by ~. You can install a plugin to convert the characters accordingly. An alternative to this is applying HTML tags: <sup></sup> creates superscript and <sub></sub> creates subscript but the effect of this is cluttered text.
• [ ] In the final-team-pages phase of the project you will receive the CIP information. Cut and paste the following information in the custom.css file to ensure this infromation is formatted properly:

/* LOC Cataloguing in Publication format */
          .quire-page__content .container .content .cip-data {
            break-inside: avoid;
            page-break-inside: avoid;
          }
          .quire-page__content .container .content .cip-data p {
            margin-bottom: 0;
          }
          .quire-page__content .container .content .cip-data ul {
            margin-left: 0;
            margin-top: 0;
            margin-bottom: .5rem;
          }
          .quire-page__content .container .content .cip-data ul li {
            line-height: 1.6;
            margin: 0;
            padding-left: 1.5em;
            text-indent: -1.5em;
          }
          .quire-page__content .container .content .cip-data ul li::before {
            display: none;
          }
          .quire-page__content .container .content .no-break-container {
            break-inside: avoid;
          }
          

• [ ] Review any lingering questions with Greg before finalizing your work.
• [ ] Create a pull request and request a reviewer.
• [ ] Once your PR is approved, merge your branch into the first-pages branch.