Templates (always start with a template; lots of important boilerplate markup that is required and not described below) Logs |
Critical and biographical introductions authored by students will accompany the source literary texts selected as part of a course, practicum or internship. The introductions are submitted as two seprate files:
Those essays are typically not encoded by the authors. They will be encoded by Digital Library Program / Libraries staff throughout the year.
Encoding guidelines for the introductions are documented herein with relevant bits linking out to the official VWWP TEI P5 Encoding Guidelines so not to duplicate information.
{align:right}[return to top|#top]{align} |
Below are detailed steps for setting up your encoding environment and tracking problems or questions encountered along the way.
At the end of your encoding session, you should upload your XML/TEI file so that we can maintain a backed-up version. Your file needs to
validate against the schema before you can upload. To do this:
You will want to validate often while encoding. This will help you uncover encoding errors early on in the process as opposed to letting errors compound, making troubleshooting more challenging.
Schema validation should be frequent and on-going.
This project uses a schema customized from TEI P5, which makes sure the XML document is well-structured and valid. Your Oxygen editor automatically knows this information. The Oxygen editor will show you a green box towards the top-right of the editor if the file is valid or a red box if the file is invalid.
To validate an XML/TEI file already open in the Oxygen editor:
If the file is valid, you will see:
If the file is invalid, you will see:
Once you fix the errors, re-validate the document. All documents must be valid to the schema at the end of an encoding session.
If you encounter a problem or a question during encoding, please document the problem/question at: VWWP Encoding Problems. Angela Courtney and Michelle Dalmau will monitor this page for feedback.
{align:right}[return to top|#top]{align} |
Encoding the critical introductions should be relatively straight forward, but since not all final versions have been submitted at the time of drafting these encoding guidelines you will surely run into peculiarities that need to be documented. Please don't ignore these. Instead post the issues you encounter on the VWWP Encoding Problems page.
The introductions are essays that may contain inline bibliographic references, references to the source literary text, footnotes or endnotes and lots of biographical information. For now we won't be encoding the biographical information. When ever possible, these guidelines will link to existing encoding information so not to duplicate information. Only encoding practices that are unique to these introductions will be captured here.
Adhere to the following:
Page breaks WILL NOT be encoded since these documents are born-digital.
{align:right}[return to top|#top]{align} |
Every XML file contains a basic TEI Header with boilerplate information already completed. You will complete/update the information represented by a dollar-sign variable unless the value is in an attribute (e.g., $Encoder's First and Last Name). Make sure dollar signs are removed!
Some of the information you need to capture about the source text will require consultation with the VWWP Texts Log for Contextual Information or the VWWP Website for the legacy texts.
The Log and/or the VWWP Web site will tell you the VAB# that you will need to complete in various parts of the Header and the title of the source text. For bios, it is just as important to check the encoding log as it is the web site to make sure all texts are identified and referenced accordingly in the TEI Headers for the Bios.
The following TEI Header information will need to be completed (see example header below):
For authors, editors and encoders affiliated with Indiana University, we will use their IU network ID as the @xml:id in the <name> element.
For example: mdalmau
For authors, editors and encoders NOT affiliated with Indiana University, we use their first and last names as the @xml:id in the <name> element.
For example: chris_hokanson
<!--Example of responsibility statement in fileDesc-->
<respStmt>
<resp>Edited By</resp>
<!--Name of professor or instructor who provided editorial feedback
and editors of the project after QC-->
<name xml:id="chris_hokanson">Hokanson, Chris</name>
</respStmt>
<!--Example of attribution fileDesc and sourceDesc-->
<sourceDesc>
<bibl>
<title type="biography">Lady Jane</title>
<author>Jane Doe</author>
<affiliation>Judson College</affiliation>
<!--4 digit year the intro was authored and submitted in final form-->
<date>2012</date>
</bibl>
</sourceDesc>
|
In the sourceDesc, the title of the essay has an @type attribute with one of the following values:
The appropriate value is mandatory.
Introductions should only point to one source text, however, biographies could point to multiple texts written by the same author. Links to the source texts are handled similarly. In the case of biographies, when multiple texts are available online, you would repeat the <bibl> element.
You will need to reference the VWWP Texts Log for Contextual Information to track the monographs/authors. You should also check the web site, in the case of biographies, to make sure you link all the books that are part of the online corpus for the author.
<notesStmt>
<note type="relatedItem" subtype="source_text">
<listBibl>
<bibl>
<!--Reference the persistent URL for the source text. The PURL pattern
is always: http://purl.dlib.indiana.edu/iudl/vwwp/ + VAB# -->
<title level="m" ref="http://purl.dlib.indiana.edu/iudl/vwwp/VAB1828"> Going West: or, Homes
for the Homeless : A Novel</title>
</bibl>
<!--Repeat bibl if multiple books by same author is in the collection-->
<!--<bibl></bibl>-->
</listBibl>
</note>
</notesStmt>
|
{align:right}[return to top|#top]{align} |
In addition to consulting the global encoding approaches such as rendition values, notes, etc., you will more than likely follow the Prose guidelines for these critical introductions.
Documented below are aspects of the text that will need special markup. You may encounter additional aspects that are not covered in the guidelines. Please document these in the VWWP Encoding Problems page.
The essays will generally be structured as follows:
|
Please note that NOT every essay contains this structure. You may encounter other chunks of content. The schema provides a set of div type values. If none of those match any new or different chunk of content you encounter, please document the nature of the "chunk" on the VWWP Encoding Problems page.
Every "sectioned" chunk of text (headings are usually an indicator of this) should reference an appropriate division type. The entire contents will be contained within a <div type="essay">.
Every division should have a <head>. If the author did not supply a title, create a supplied title and assign the section a logical heading. For example:
You will see references to the source VWWP text, in either full or short title form. These references should be encoded within a <bibl> <title> tags with a "ref" attribute that contains the PURL to the source text:
<p>
The author of
<bibl>
<title level="m" ref="http://purl.dlib.indiana.edu/iudl/vwwp/VAB1828">Going West</title></bibl>,
the formidably energetic journalist and
writer Matilda Greathouse Alexander, was born in Posey County,
Indiana, on June 14, 1842 to George W. Greathouse and Martha
Greathouse (née Hausman). She was the youngest of four children
and the third daughter born to the Alexanders. Less then a year after
Matilda’s birth, George Greathouse died. Martha Greathouse remarried
an Absalom Rodenberger, bearing him two more daughters, Matilda’s
half-sisters.
</p>
|
The VWWP corpus often contains more than one text by the same author so it is important that when you come across another text written by the author in questions, you check the following to determine whether you can a PURL reference to the title:
Please note that this paragraph contains lots of rich biographical information that we won't be encoded at this time.
You will see references to other published works (by the author or otherwise) in a less structured format (narrative-style in paragraph). We will want to capture these citations using a <bibl> tag when at all possible. For example:
<p>Today, only two of her novels apparently survive in print or microfilm:
<bibl>
<title level="m" ref="http://purl.dlib.indiana.edu/iudl/vwwp/VAB1828">Going West,
or, Homes for the Homeless</title>, published in <date>1881</date></bibl>,
and <bibl><title>Worth Wins</title>, published in <date>1882</date></bibl>.
The title-pages of these novels list her
other works: <bibl><title level="m">Here and Hereafter</title></bibl>,
<bibl><title>The Widow’s Life</title></bibl> ...</p>
|
If the bibliographic information is too interspersed with explanatory text, then just capture the main bibliographic element like title. For example, a title may be mentioned followed by lots of information before a publication date is mentioned. The title and date are too far removed to place a <bibl> around the whole chunk. Instead, just use <bibl> <title> and ignore the date.
When citing an article, you may encounter any number of bibliographic information, but author name and page numbers are most common:
<bibl>(<author>Avery</author> <biblScope type="pp">18</biblScope>)</bibl> |
<biblScope> is used with the "type" attribute for the following elements of a citation:
Please note that these inline citations can occur within the main part of the essay or as part of foot or end notes. Regardless of where they appear, they should be encoded using <bibl>.
Titles can, and should when possible, be differentiated with the use of the "level" attribute:
<title level="m" ref="http://purl.dlib.indiana.edu/iudl/vwwp/VAB1828">Going West,
or, Homes for the Homeless</title>
|
The TEI provides the following values for "level:"
If you aren't sure of the type of title, refrain from using @level.
Please note that titles do not require a special rend attribute unless a level is unknown and the source text italicizes a title. Based on the @level, we know whether to display the title in quotes or italicized.
Most if not all of these essays will have a section for Works Cited or Bibliographies. These should be contained within a division of type="bibliography" and be encoded as documented in the Back Matter#bibliography section of the VWWP guidelines.
Encode titles with "level" attributes when possible (see above). Also encode all elements of a bibliographic citation including:
Note that some bibliographies may be annotated. If so, use the <note> element to capture this information within a <bibl>.
{align:right}[return to top|#top]{align} |
Once the essays have been encoded, the editors of the VWWP project should:
The encoder should email Michelle Dalmau and Angela Courtney once they have uploaded the final version of the encoding to Xubmit.
{align:right}[return to top|#top]{align} |