Software for editing manuscripts

Summary

  1. the bash shell (a terminal) to run commands
  2. atom (text editor)
  3. docker, to ru software packages (docker containers) on different host operating systems

Details: terminal

Windows users can run a windows terminal console.

Mac OS X users can use the Terminal app (in Applications/Utilities).

Details: Atom for text editing

In today’s workshop, we will edit tables of data in delimited text files, and diplomatic editions of texts marked up in XML. The plugin architecture of the Atom editor provides excellent support for all of these.

Download and install atom from https://atom.io/. If you are using Mac OS X, open atom and choose from the Atom menu, “Install Shell Commands”. (This step should not be necessary on Windows or Linux operating systems.)

Configuring Atom for scholarly work on manuscripts

Installing atom should have installed the command-line atom package manager apm. Copy and paste the the following commands into a terminal to install all of these packages:

apm install intentions
apm install busy-signal
apm install linter
apm install linter-ui-default
apm install linter-autocomplete-jing
apm install atom-xsltransform
apm install xml-formatter
apm install https://github.com/mfripp/atom-tablr.git
apm install rainbow-csv

Download the file atom-tablr-conf.cson, and copy it to atom’s default location for config files. One way to do that is to use the cp command in your terminal. If the file is named atom-tablr-conf.cson and is in your terminal’s working directory, you can copy it with this command:

cp atom-tablr-conf.cson $HOME/.atom/config.cson

(Gotcha: if your browser renames your file for you when you download – e.g., if it calls it atom-tablr-conf.txt – it, you’ll have to use the name it chose instead of atom-tablr-conf.cson.)

Finally,

  1. add the linter-autocomplete-jing plugin
  2. install this package for automatic validation of documents following the Text Encoding Initiative (TEI) schema

Details: Running scripts

To test and validate our editions, we use scripts written in Scala, a language that runs on the Java Virtual Machine. We use docker to provide an environment containing all of this software.

If you’re running Mac OS:

If you’re running Windows: