Skip to content

Workflows and Script Sequencing for Editors

Jump to bottom Edit New page
Bridget Almas edited this page Oct 28, 2015 · 11 revisions

###Note: these steps assume a basic understanding TEI XML and how to edit it. If this poses for a problem for you, please see TEI by Example, the TEI Guidelines, and download a trial version of the Oxygen XML Editor to try to figure it out.

See Also Workflow Diagram

#####0. Please set up a Github account. Please see Github Workflows and Etiquette for more on what this means and how to go about it.

#####1. Want to work with a Perseus text?

-if YES, see Finding Data to figure out if the text you're looking for is already in Github, and if so where, or if you need to request it's migration. If it's not yet on Github, proceed to step 2. If it is available on Github, proceed to step 3.

-if NOT, if you want to use a text you independently marked up, or a text that isn't currently part of the Perseus Digital Library or Open Philology collection, first enter a Github issue requesting a CTS URN for your text. If you're not sure whether or not your text is already part of Perseus/Open Philology please see the page on Finding Data. Assuming the text isn't yet part of the colletion, please provide as much information as possible about your text in the Github issue you create. When a namespace and CTS URN have been assigned, proceed to step 4.

#####2. Determine whether your text is under copyright. Then, submit an issue that describes your understanding of its current copyright status, and requests its upload as soon as possible. Once it's uploaded, proceed to step 3.

#####3. Follow the instructions listed on Github Workflows and Etiquette to fork and clone the repository containing your text, in order to make it available for editing on your local Desktop. Proceed to step 4.

#####4. Check if the text is already CTS/EpiDoc compliant, and if not, edit it to CTS/EpiDoc compliance.

To test if the text is already CTS/EpiDoc compliant, see the pages on Testing Data and Tracking Data. You can also eyeball it to get a rough sense--is the EpiDoc rng declared at the top, and is the XML valid? If so, there's a good chance that it's already EpiDoc compliant. Are all the units that you want to cite enclosed in closed, hierarchically nested XML elements? If so, there's a good chance it's already CTS compliant.

For more on what EpiDoc compliance entails, see the page on EpiDoc conversions.

For an entry point into the process of CTS conversion, see the page on CTS Compliance, Basic (and Abstract) Markup Requirements.

A few notes:

Before beginning, we recommend skimming this wiki to familiarize yourself with the issues you may need to address; please feel free to use this wiki and the scripts in the repository as a resource as you work. If you encounter any problems, feel free to ask.

Whether you tackle the CTS or EpiDoc conversion first is up to you.

#####5. Once you've taken your text as far towards CTS/EpiDoc compliance as you find possible, track your changes, and enter any issues for unresolved problems that aren't already documented in the tracking files.

#####6. Assuming you've made substantive changes, such as a conversion to CTS or EpiDoc compliance, assign a new URN to the edition/translation and rename the file after this URN.

#####7. Commit, push to Github and send PerseusDL/canonical a pull request for your changes.

Note: Please be patient, it can take some time to make sure your text is valid and accept your pull request!

#####8. If you wrote any scripts or programs to help you with your work, please add them to the tei conversion tools repository.

#####9. If you want to use this text in a particular Perseus service, please head to the page on Scholar or Student Wanting to Make Text Ready for Annotation, and begin at step #2.

#####10. Feel free to independently test your text in the Perseus CTS environment.

#####11. Thanks for contributing!

Workflow Diagram

Got questions that aren't answered on any of these pages or their links? See Questions and Decisions, Asking and Reaching.

Add a custom sidebar
Clone this wiki locally