Difference between revisions of "TrainingMaterialsFall2021"

From Digital Scholarship Group
Jump to navigation Jump to search
(Created page with "== Before meeting == '''Read:''' *Julia Flanders, Syd Bauman, and Sarah Connell “Text Encoding Fundamentals with TEI” (Sarah will email to you) *[http://www.wwp.northea...")
 
Line 30: Line 30:
 
* Questions?  
 
* Questions?  
 
* Additional discussion on [https://www.wwp.neu.edu/outreach/seminars/_current/presentations/xml_intro/xml_newIntro_15.xhtml XML validity]
 
* Additional discussion on [https://www.wwp.neu.edu/outreach/seminars/_current/presentations/xml_intro/xml_newIntro_15.xhtml XML validity]
−
* Sample [https://bauman.zapto.org/~syd/temp/WWP/letter6.txt letter to encode] and [https://bauman.zapto.org/~syd/temp/WWP/letter7.txt another]
 
−
* The [https://bauman.zapto.org/~syd/temp/WWP/letter.rnc schema URL]
 
 
*[http://www.wwp.northeastern.edu/outreach/seminars/_current/handouts/oxygenCribSheet.xhtml Basics of Using Oxygen] See also [https://github.com/NEU-DSG/wwp-public-code-share/blob/master/docs/oxygen-cheat-sheet.md Oxygen Cheat Sheet]
 
*[http://www.wwp.northeastern.edu/outreach/seminars/_current/handouts/oxygenCribSheet.xhtml Basics of Using Oxygen] See also [https://github.com/NEU-DSG/wwp-public-code-share/blob/master/docs/oxygen-cheat-sheet.md Oxygen Cheat Sheet]
 
**Clearing your working space
 
**Clearing your working space
 +
**Turn of check ID/IDREF
 +
**Turn off default attributes
 
**Opening a new TEI file
 
**Opening a new TEI file
 
**Inserting tags
 
**Inserting tags
Line 41: Line 41:
 
**Adding comments
 
**Adding comments
 
**Letting Oxygen help you work!
 
**Letting Oxygen help you work!
−
**Setting up for homework
+
*Setting up for homework
−
***Getting the textbase
+
**Getting the textbase
−
***Opening the letter files and associating the schema
+
**Opening the letter files and associating the schema
 
*[http://www.wwp.neu.edu/outreach/seminars/_current/presentations/basic_encoding/basic_encoding_00.xhtml Basics of Prose Markup part one]
 
*[http://www.wwp.neu.edu/outreach/seminars/_current/presentations/basic_encoding/basic_encoding_00.xhtml Basics of Prose Markup part one]
−
**[Tutorial version https://wwp.northeastern.edu/outreach/seminars/_current/presentations/basic_encoding/basic_encoding_tutorial_00.xhtml]
+
**[https://wwp.northeastern.edu/outreach/seminars/_current/presentations/basic_encoding/basic_encoding_tutorial_00.xhtml Tutorial version]
−
 
 
  
 
=== Homework ===
 
=== Homework ===
Line 68: Line 67:
  
  
−
== Session 3:  Sept 22 10–11:30 or 1–2:30 ==
+
== Session 3:  October 14 9–10:30am or October 15 2:30–4pm ==
 
=== Topics ===
 
=== Topics ===
−
*[http://www.wwp.northeastern.edu/research/publications/documentation/training/document_analysis.html Document Analysis]
+
*Question about the homework or about downloading the textbase?
−
*[http://www.wwp.neu.edu/research/publications/documentation/internal/ Using the Internal Documentation]
+
*Quick tour of the WWP files
−
*[http://www.wwp.neu.edu/outreach/seminars/_current/presentations/basic_encoding/basic_encoding_00.xhtml Basics of Prose Markup continued]
+
**Accessing WWO through [https://library.northeastern.edu/research/resources/a-to-z-index library databases]
−
 
+
*[http://www.wwp.neu.edu/outreach/seminars/_current/presentations/basic_encoding/basic_encoding_00.xhtml Basics of Prose Markup part two]
 +
**[https://wwp.northeastern.edu/outreach/seminars/_current/presentations/basic_encoding/basic_encoding_tutorial_00.xhtml Tutorial version]
 +
*[http://www.wwp.neu.edu/research/publications/documentation/internal/ Tour of the Internal Documentation]
  
 
=== Hands-on Practice ===
 
=== Hands-on Practice ===
 
*[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/letter_narrative Letters]
 
*[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/letter_narrative Letters]
−
 
 
*[http://www.wwp.neu.edu/research/publications/documentation/training/introduction/exercise_0.html Exercise 0], [https://www.dropbox.com/s/n3x6dgg6rfeswhj/exercise_0.pdf?dl=0 download document]
 
*[http://www.wwp.neu.edu/research/publications/documentation/training/introduction/exercise_0.html Exercise 0], [https://www.dropbox.com/s/n3x6dgg6rfeswhj/exercise_0.pdf?dl=0 download document]
  
 +
=== Homework ===
 +
*Look around the [http://www.wwp.neu.edu/research/publications/documentation/internal/ Internal Documentation]
 +
*Finish Exercise 0 (you don't have to 100% finish typing out the whole thing, but try to sketch in how you would encode everything that seems distinctive—tip: try using comments to mark out the things you are skipping!)
  
−
 
+
== Session 4: October 22 9–10:30am or October 22 12–1:30pm ==
−
== Session 4: Sept 25 9–10:30 or 1:30–3 ==
 
 
=== Topics ===
 
=== Topics ===
−
*Questions about the exercise?
+
*Questions about the exercise; any encoding you'd like to see?
 
*Common Markup
 
*Common Markup
 
**Persons, Places, &c.
 
**Persons, Places, &c.
Line 91: Line 93:
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/name_element <name>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/name_element <name>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/orgName_element <orgName>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/orgName_element <orgName>]
 +
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/title_element <title>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/rs_element <rs>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/rs_element <rs>]
  
Line 101: Line 104:
  
 
=== Homework ===
 
=== Homework ===
 +
*Keep working on exercise 2 (you don't have to 100% finish typing out the whole thing, but try to sketch in how you would encode everything that seems distinctive—tip: try using comments to mark out the things you are skipping!)
 
*Review the materials in [[Getting started with encoding]]
 
*Review the materials in [[Getting started with encoding]]
  
  
−
== Session 5: Sept 29 10–11:30 or 1–2:30 ==
+
== Session 5: October 22 3:30–5pm or October 27 2–3:30pm ==
 
=== Topics ===
 
=== Topics ===
−
*Questions about the exercise?
+
*Questions about the exercise; any encoding you'd like to see?
−
 
 
−
*Scheduling another session
 
−
 
 
−
*Text selection from the [https://docs.google.com/spreadsheets/d/1f_VnBkmOjTZeXF8fi2_hhvFJMn98a_UEWxYjZQKx-jo/edit#gid=0 Aquifer] (Green texts are priorities, yellow are also possible, put your name next to a text to claim it, look up EEBO and ECCO texts by starting at the [https://library.northeastern.edu/research/resources/a-to-z-index library's list of databases])
 
  
 
*Special Characters  
 
*Special Characters  
 +
**What is Unicode?
 +
**Numeric Character References
 +
**Adding Unicode to Mac keyboards
 
**[[Unicode Quick Guide]]
 
**[[Unicode Quick Guide]]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/typography_narrative Typography & Special Characters]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/typography_narrative Typography & Special Characters]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/hyphenation_narrative Hard and Soft Hyphens]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/hyphenation_narrative Hard and Soft Hyphens]
 +
 +
*Page Breaks & Metawork
 +
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/pagenumber_narrative Page Numbers]
 +
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/milestone_element <milestone>]
 +
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/pb_element <pb>]
 +
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/mw_element Metawork]
 +
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/signatures_narrative Signatures]
 +
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/boundaries_narrative Boundaries Between Elements]
  
 
*Drama
 
*Drama
Line 125: Line 136:
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/lg_element <lg>]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/lg_element <lg>]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/verse_narrative Encoding Verse]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/verse_narrative Encoding Verse]
−
 
−
*Page Breaks & Metawork
 
−
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/pagenumber_narrative Page Numbers]
 
−
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/milestone_element <milestone>]
 
−
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/pb_element <pb>]
 
−
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/mw_element Metawork]
 
−
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/boundaries_narrative Boundaries Between Elements]
 
−
 
−
*Rendition, part 1
 
−
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/rendition_narrative Rendition Ladders]
 
−
**[http://www.wwp.northeastern.edu/research/publications/documentation/training/rendition.html Outline of Keywords & Arguments]
 
  
 
===Homework===
 
===Homework===
−
*[http://www.wwp.neu.edu/research/publications/documentation/training/introduction/exercise_5.html Exercise 5]: Add rendition to previous exercises (if you want to; you could also wait until after the Friday session)
+
*Read the WWP's notes on [https://www.wwp.northeastern.edu/research/publications/documentation/training/document_analysis.html] document analysis
 +
*Begin looking at the potential texts in the [https://docs.google.com/spreadsheets/d/1f_VnBkmOjTZeXF8fi2_hhvFJMn98a_UEWxYjZQKx-jo/edit#gid=0 Aquifer] (Make note of the status, not all texts are currently up for encoding; put your name next to a text to claim it; look up EEBO and ECCO texts by starting at the [https://library.northeastern.edu/research/resources/a-to-z-index library's list of databases])
  
−
== Session 6: Oct 2 9–10:30 or 1:30–3 ==
+
== Session 6: October 28 9–10:3pam or October 29 9:30–11am ==
 
=== Topics ===
 
=== Topics ===
−
*Rendition, part 2
+
 
 +
*Text selection from the [https://docs.google.com/spreadsheets/d/1f_VnBkmOjTZeXF8fi2_hhvFJMn98a_UEWxYjZQKx-jo/edit#gid=0 Aquifer] and notes on “tadpoles”
 +
*Rendition
 
**Elements for marking changes in rendition
 
**Elements for marking changes in rendition
−
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/emph_element <emph>]
 
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/hi_element <hi>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/hi_element <hi>]
 
***[https://wwp.northeastern.edu/research/publications/documentation/internal/#!/entry/mcr_element <mcr>]
 
***[https://wwp.northeastern.edu/research/publications/documentation/internal/#!/entry/mcr_element <mcr>]
Line 150: Line 152:
 
**[http://www.wwp.northeastern.edu/research/publications/documentation/training/rendition.html Outline of Keywords & Arguments]
 
**[http://www.wwp.northeastern.edu/research/publications/documentation/training/rendition.html Outline of Keywords & Arguments]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/delimiter_narrative Delimiters]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/delimiter_narrative Delimiters]
 +
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/break_narrative Default break behavior]
 
**To see a template for setting up renditional defaults, open tagsDecl.xml in under_construction
 
**To see a template for setting up renditional defaults, open tagsDecl.xml in under_construction
  
Line 159: Line 162:
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/note_element <note>]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/note_element <note>]
  
−
== Session 7: Oct 6 10–11:30 or 1–2:30 ==
+
=== Homework ===
−
*Questions and follow-up on anything
+
*[http://www.wwp.neu.edu/research/publications/documentation/training/introduction/exercise_5.html Exercise 5]: Add rendition to previous exercises (if you want to; you could also wait until after the Friday session)
 +
 
 +
 
 +
== Session 7: November 5 12:30–2pm or November 5 3:30–5pm ==
 +
*Questions on anything so far?
  
−
*Quick note on default break behavior and linking dialogue; note also that we are updating the documentation on renditional defaults, so for now you should follow what is in the template
+
*Subversion
 +
**[http://www.wwp.northeastern.edu/research/publications/documentation/training/subversion.html Version Control and Using Subversion]
 +
**There is also an outline of the basic processes for using Subversion in encoding in [[Getting started with encoding]]
 +
 
 +
*Change logs
  
 
*Supplied, Missing, & Unclear Text
 
*Supplied, Missing, & Unclear Text
 +
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/unclear_element <unclear>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/supplied_element <supplied>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/supplied_element <supplied>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/gap_element <gap>]
 
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/gap_element <gap>]
−
***[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/unclear_element <unclear>]
 
  
 
*Corrections
 
*Corrections
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/sic_element <sic>]
 
**[http://www.wwp.neu.edu/research/publications/documentation/internal/#!/entry/sic_element <sic>]
−
 
−
*Subversion
 
−
**[http://www.wwp.northeastern.edu/research/publications/documentation/training/subversion.html Version Control and Using Subversion]
 
−
**There is also an outline of the basic processes for using Subversion in encoding in [[Getting started with encoding]]
 
  
 
*[https://wwp-test.northeastern.edu/dsg/wiki/Getting_started_with_encoding Workflow]
 
*[https://wwp-test.northeastern.edu/dsg/wiki/Getting_started_with_encoding Workflow]
 
**Trello
 
**Trello
−
**Change Logs
+
**Slack
 
**Listserv
 
**Listserv
 
**Wiki
 
**Wiki

Revision as of 13:19, 21 December 2021

Before meeting

Read:

  • Julia Flanders, Syd Bauman, and Sarah Connell “Text Encoding Fundamentals with TEI” (Sarah will email to you)

Optional readings:

October 6 1:30–3pm or October 8 12–1:30pm

Topics

  • Intro to the WWP
  • Logistics and training process notes
    • Make sure to attend one instance of each session
    • There are office hours you can attend if you have questions or if you need to miss a session
  • Why are we here and what are we doing?
    • Training will start with some foundational concepts of encoding, then move on to the specifics of how the WWP approaches things
    • Some of this might feel abstract at first, but the end goal is that everyone will know how to take early women's documents and create digital models of them with XML and the Text Encoding Initiative markup language
    • To do that, you first need to understand what XML is!
  • Intro to XML

Session 2: October 8 3:30–5pm or October 13 2–3:30pm

Topics

Homework

  • Before our next session, please make sure that you have downloaded Oxygen, following the instructions and using the key from Sarah's email
  • Practice encoding with the samples:
  • To create a new “letter” XML document (in order to start the above homework):
    • In oXygen, start the process to create a new XML document:
    • ⌘-N (or CTL-N on Windows or Linux)
      • Select (but do not double-click on) “XML Document” — typing “xml” in the filter box usually makes this pretty easy to find
      • Do NOT double click on it, click on the “Create” button, or press ENTER (which is the same); rather …
      • Click the “Customize” button (which is on the bottom row)
      • The “New” dialog box will change dramatically; don’t panic
      • The first field you can fill in is the “Schema URL” field.
      • Copy the URL that points to the schema (in this case it should end in “.rnc”), and paste it into the “Schema URL” field.
      • The “Root Element” field should now say “letter”.
      • Now go ahead and click the “Create” button


Session 3: October 14 9–10:30am or October 15 2:30–4pm

Topics

Hands-on Practice

Homework

  • Look around the Internal Documentation
  • Finish Exercise 0 (you don't have to 100% finish typing out the whole thing, but try to sketch in how you would encode everything that seems distinctive—tip: try using comments to mark out the things you are skipping!)

Session 4: October 22 9–10:30am or October 22 12–1:30pm

Topics

Hands-on Practice

Homework

  • Keep working on exercise 2 (you don't have to 100% finish typing out the whole thing, but try to sketch in how you would encode everything that seems distinctive—tip: try using comments to mark out the things you are skipping!)
  • Review the materials in Getting started with encoding


Session 5: October 22 3:30–5pm or October 27 2–3:30pm

Topics

  • Questions about the exercise; any encoding you'd like to see?

Homework

  • Read the WWP's notes on [1] document analysis
  • Begin looking at the potential texts in the Aquifer (Make note of the status, not all texts are currently up for encoding; put your name next to a text to claim it; look up EEBO and ECCO texts by starting at the library's list of databases)

Session 6: October 28 9–10:3pam or October 29 9:30–11am

Topics

Homework

  • Exercise 5: Add rendition to previous exercises (if you want to; you could also wait until after the Friday session)


Session 7: November 5 12:30–2pm or November 5 3:30–5pm

  • Questions on anything so far?
  • Change logs
  • Workflow
    • Trello
    • Slack
    • Listserv
    • Wiki
    • Office Texts

Follow up

Exercises

Further reading

Text Selection

  • Choose your first text for encoding and claim it in the aquifer
Retrieved from "https://dsg.northeastern.edu/wiki/index.php?title=TrainingMaterialsFall2021&oldid=3841"