Text-Editing Guide

Our process for adding publication content and data into Quire via text editor

  • Convert Word files into Markdown using Pandoc
  • Open project in text editor
  • Delete starter content
  • Complete the publication.yaml
  • Create an outline with placeholder Markdown (.md) files and landing pages in the content folder
  • Create a Table of Contents in your Quire project
  • Cut-and-paste the converted Mardown into the placeholder pages
  • Format YAML at the top of each Markdown file
  • Add publication data as (.yaml) files in the data folder (this includes figures.yaml, objects.yaml, references.yaml, etc.)
  • Add images to project (use a git submodule if working in a public repository to protect third part assets)
  • Format image and table callouts and internal links between pages as hyperlinks
  • Insert figure images using the figure shortcode
  • Use Regular Expression (or RegEx) to find and replace double curly quotes for author date citations (and any other pop-ups).