Instructions for Using Templates for Treebanking with Students

Custom templates for student treebanking.

  1. Create your own base treebank annotation in your own Persieds workspace
  2. Annotate this document as much or as little as you like, depending upon how much you want already provided for your students.
  3. Specify the editor you want your students to use by adding it as an annotator in the XML of the document (you can edit the XML using the EditXML feature in Perseids)
    1. for Arethusa, add:
      <annotator>
      <short>arethusa</short>
      <name>arethusa</name>
      <address/>
      <uri>http://github.com/latin-language-toolkit/arethusa</uri>
      </annotator>
    2. Alternatively, if you want to ensure Alpheios as the editor, you would add:
      <annotator>
      <short>arethusa</short>
      <name>arethusa</name>
      <address/>
      <uri>http://github.com/alpheios-project/treebank-editor</uri>
      </annotator>
  4. Use the Download Copy button in Persieds (available from the menubar in the Edit or Edit XML views) to get a local copy of your template.
  5. Make edit theĀ  document_id attribute referenced in the sentences in the template so that it matches exactly the URL at which you intended to deploy your template.
  6. Deploy the document at the url identified in the document_id
  7. Login to Perseids
  8. Delete the version of the file you used to create the template (from the Overview screen for the publication, click Delete at the bottom of the screen and follow the prompts).
  9. Click New Treebank Annotation
  10. Click Arethusa
  11. Scroll to bottom of screen
  12. Paste the link to your file in the From URL input
  13. Click Create Link
  14. Enter the language name
  15. Copy the link
  16. Use the link to create your “gold standard” version of the file.
  17. Verify that using the link brings you to the same file in your perseids workspace and doesn’t create a new one (if it does there is a mismatch between filename and document_id attribute values
  18. Annotate your file as desired.
  19. Distribute template link (as created in steps 13-15) to your students
  20. Students can email you (and each other) links to their files in progress before submitting. Using their link and logging in to Perseids under your own account, you will see a Compare button which allows you to compare the linked file to your own.
  21. When students submit to the board, you will automatically get a Compare link for the submitted files when you are viewing your own gold standard file in Perseids if you are a member of the board to which they submit their work.