search

RJP43 / LiliElbe_EngagedLearners

Lili Elbe Digital Archive practicum - learning markup via an engaged markdown community. Visit our wiki!
http://bit.ly/ELEarners
27 stars 26 forks source link

TEI Header, Prosopography, Schema, and Encoding Guidelines - UPDATES! #35

Closed RJP43 closed 4 years ago

RJP43 commented 5 years ago

:eyes: @zothman @Tatjanawj @JackieAlfarah @Dadelinee @katebarrettmurphy @bcristiana @ElleBromer @alicapati @joaquindavalosponce @Katiegriggs24 @schola0208 @skarrow @kklimek1 @ekupchella @amandallopez @amccann2 @BMiller10 @elenipamboukis @dpedz @wravindran @Samantha9899 @nroyce @kschoen3 @jsteele1 @tinatiehen @anais-turiello @bossa12 @kejcat 👀

Hello Everyone! 👋 This issue has all of the quick links to the files necessary for encoding and proofing!

<teiHeader> Template Update

I wanted to remind all of you that one part of the task "proofing XML" will be making sure the <teiHeader> elements in your XML files match our <teiHeader> template. **Please note I have recently updated the <teiHeader> template (and the teiHeader Lesson); therefore, all of the headers in all of the XML files will need to be adjusted. In particular, the wording for every <respStmt> has changed and these changes need to be reflected in all LEDA XML files.

There are two ways to go about doing this. Either copy the new template <teiHeader> and fill in the information fresh from the teiHeader information spreadsheet (linked below) or adjust the existing <teiHeader> element in your XML file(s) according to the changes made to the template. The <teiHeader> information must be corrected and matching the template before HTML transformation.

RJP43 commented 5 years ago

TEI Header Information Spreadsheet

Here is the link to a spreadsheet with teiHeader information for LEDA supplemental materials - https://docs.google.com/spreadsheets/d/1yrAgk_F5xjuH9PuGPC4IcQKpynV04X9tASpehm_9-vQ/edit?usp=drivesdk. This spreadsheet should only be edited by the project manager, @ProfPLC, and me.

All encoders of supplemental materials and engaged learners correcting <teiHeader> elements should reference the above-linked spreadsheet for teiHeader information because as updates occur we will not be updating the screenshots of the spreadsheet previously found in each text's folder.

RJP43 commented 5 years ago

Referencing LEDA Team Members

As mentioned in the teiHeader Lesson, each person on the project team has a special ID (including you as an encoder). These IDs should be used in the blank ref attribute-values of the teiHeader and as source attribute values in editor/translator comments (as mentioned in the guidelines). IDs are created by taking the first and last initial of the team member's name. Some team members have asked to be identified with three initials. When creating your own ID please be sure not to repeat an ID already in use by another team member. The following is a list of identified team member IDs:

Editors

Digital Editors

Translators

Senior Editorial Assistants, Encoders

Editorial Assistants, Encoders

DH 500 Encoders, Consultants

RJP43 commented 5 years ago

Encoding Guidelines

When correcting XML, after schema association, please refer to our encoding guidelines. Because this file is written in markdown (thus formatted to be viewed best in GitHub) and being updated fairly regularly I recommend you reference the guidelines directly on GitHub and do not keep a copy on your computer that will get quickly outdated if not downloaded/pulled each work session.

RJP43 commented 5 years ago

Prosopography Updates

When adding key IDs to people and places in LEDA XML files please refer to our prosopography index. Because this file is being updated fairly regularly I recommend you reference the prosopography directly on GitHub and do not keep a copy on your computer that will get quickly outdated if not downloaded/pulled each work session. Use ctrl F on Windows and command F on Mac to search the prosopography file for person and place names. If you are looking for a key ID and do not find it in the prosopography please comment in your project team's issue, signaling to me via my handle - @RJP43, so we can determine if that person/place needs to be added to the prosop. or if they simply get marked with the persName/placeName encoding without a key attribute-value pair.

❗️ :eyes: ❗️ Engaged Learners, because you all are working on LEDA Supplemental Materials the people mentioned in your files should be associated with key IDs that match <person> @xml:id attribute-values with the source="historical" attribute-value pair in the LEDA_Prosopography.xml. screenshot of prosopography section indicating historical source attribute-value pairs in green and fictional attribute value-pair in red with an X overtop of the entry

RJP43 commented 5 years ago

Working with the Project Schema

The project schema - LEDA_ODD.rng - is being updated regularly; therefore, it is important that every encoder downloads or pulls (if using the command line/terminal) the schema to their local computer at the start of every work session. When downloading the schema please note the file type must be .rng! If you download the schema and it comes in as a .txt file type your XML will not validate correctly!

RJP43 commented 5 years ago

👀 @zothman @Tatjanawj @JackieAlfarah @Dadelinee @katebarrettmurphy @bcristiana @ElleBromer @alicapati @joaquindavalosponce @Katiegriggs24 @schola0208 @skarrow @kklimek1 @ekupchella @amandallopez @BMiller10 @elenipamboukis @dpedz @wravindran @Samantha9899 @jsteele1 @tinatiehen @anais-turiello @bossa12 @kejcat 👀

Hi everyone! 👋 I hope your second-half of the semester is going well. I wanted to bring all of your attention to this issue. In my above comments on this issue I have given my recommendations for how to best utilize each of the projects "XML proofing files" - the following links take you to each document's respective comment above: the teiHeader template, the teiHeader information spreadsheet, a list of team-member IDs, the encoding guidelines, the prosopography, and the project .rng Schema.

The remainder of this comment contains my recommended LEDA (GitHub/oXygen) workflow to successfully complete XML proofing. Please note: links on filenames will get you directly to the "Raw" output of the file so you can directly download the file. When downloading files you must be aware of where you save your project files (so you can access them in oXygen and re-upload them after proofing) and the file type (i.e. .xml, .txt, .rng) of the files you are downloading/saving. Other links will be to lessons and WIKI pages where I have provided detailed explanations of particular tasks.

Please regularly upload your XML to GitHub, throughout all stages of proofing, and comment progress reports on your team's issue as well as on the tracking hours spreadsheet. Please note that while it is important each Learner remains engaged on GitHub so that I can answer any technical concerns @ProfPLC will be grading Learners primarily on what is recorded on that spreadsheet. Please address all grading related questions to Dr. Caughie via email!

Recommended LEDA Workflow (for XML proofing)

  1. Navigate to the [LiliElbe_EngagedLearners GitHub repo]() and open this issue (#35) and your project-team's issue.
  2. Follow the links in the first comment on your team's issue to the XML file your assigned to work with - For example: HirschfeldChapter.xml. If the link does not take you directly to the "Raw" output of the XML-- on the right side near the top of the file's content click the button marked "Raw". From there copy and paste into a new (EMPTY) XML file or right click and save file. Remember to pay close attention to where you are saving, filenames, and file types! I have detailed in each team issue correct XML filenames, but please reach out on your issue if you are unsure of what to name your files.
  3. Next download, in the same folder as your XML, the LEDA_ODD.rng. When downloading the schema please note the file type must be .rng! If you download the schema and it comes in as a .txt file type your XML will not validate correctly! :eyes: If you are having difficulty with this you need to meet with me or another Engaged Learner!!! Because the schema is being updated regularly you must download the schema fresh to your local computer at the start of EVERY WORK SESSION!
  4. With the XML file open in Oxygen associate the schema to your XML.
  5. Take note of your XML's structural hierarchy. Remember to use oXygen features that help you see the entirety of your file -- we have some tips to using oXygen on our wiki. For example, it might be useful to use the soft-wrap feature in oXygen to avoid horizontal scrolling. Hold ctrl or cmd (on mac) + shift + y to invoke soft-wrap. I recommend closing all internal window views except for your XML and the "Outline" view. If you have accidentally closed the "Outline" view you can re-open it by going to "Window" > "Show View" > "Outline". The errors highlighted by the schema validation will direct your attention to some of the problematic encoding of you XML file; however, you must reference the encoding guidelines to verify your XML has all of the components that make up the basic structural hierarchy of your text type.
  6. In addition to correcting the encoding within the <text> element of your XML you will also need to copy and paste from my "Capturing Metadata" lesson an entirely new <teiHeader>.
  7. Once you have the new <teiHeader> element correctly filled out and the correct text-type structural markup within the <text> element you will need to read through the XML and be sure all of the people and places are encoded (see Prosopography Markup section in the Guidelines) and properly linked to the correct key attribute-value assigned in the xml:id of each person and place in our LEDA_Prosopography.xml. If you are working on a file with a translation you will also need to implement our Translation Segmentation markup.
  8. Finally upload your new XML, verifying you have kept the filename I included in your team's issue, to your text's folder. Instructions to upload to our GitHub repo: navigate to the folder containing the original files for your text. Above the file list, click "Upload files". Drag and drop or browse and select the XML file you'd like to upload. At the bottom of the page, type a short, meaningful commit message explaining where you are in your proofing progress. Below the commit message fields, the default is to add your commit to the current branch. If you're not on the current branch (master), you should select the master branch and click "Commit changes".
  9. Report on your team's issue your progress along the way and feel free to create new issues (following issue #23's format) for any concerns that need special attention.
  10. Once all of your team's XML is ready for HTML-proofing add the "transformation ready" issue label to your team's issue. Detailed instructions for HTML-proofing will be coming soon!