Child pages
  • VWWP Wireframes Documentation - Part 2
Skip to end of metadata
Go to start of metadata

Release Coverage

The documentation here in covers the following releases/functionality:

  • Genre access (release scheduled)
    • Results facet (not as a search filter)
    • (question) Display as line item in results / my selections
    • Display in "Document Information" in text views
    • (warning) Browse by genre (problem with representing hierarchy) 
  • Display of additional metadata fields due to richer encoding (unscheduled but relatively minor improvment)
    • title (do we include 245c) or designate as "contributor" field
    • (question) Display as line item in results / my selections
    • Display in "Document Information" in text views
  • (question) Add author name next to titles (unscheduled)
  • Integration of critical intros (future release not yet specified)
  • Integration of scholarly annotation (future release)
  • Integration of timeline (future release)

Assumptions

  • Legacy indexing and new encoding indexing need to be combined; the xpaths will differ

Overview

The VWWP phase 2 is motivated by the integration of the newly encoded texts by English graduate students (from DH course, L501). The metadata for this new round of encoding is slightly different (documented via xpaths below) and will impact indexing for the new content. The text markup is more robust, but this development phase will not be leveraging much of this deeper markup for discovery or textual processing (maybe phase 3?). Two major features that the new texts have moving forward have: page images and related critical materials.

The JIRA instance for this project documents all the features in greater detail.

Wireframes

Note: Wrieframes are likely out of synch with certain design implementations already in place but still aer useful in illustrating functionality covered in this documentation.

  • Select wireframes were modified to reflect new, phase 2 functionality (bundle, PDF)
  • Graffles (bundle, zip)
  • Select wireframes also invididually linked below

Fields to Index for Metadata + Full Text Search (aka Keyword Search)

Note: The original files rely on the biblFull structure where the new files rely on biblStruct. The metadata is also mapped from the original MARC source so the elements may need to be compiled or concatenated like in the case of title.

XPath for New TEI Files Metadata

Author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author 

If author has a pseudonym, look for:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/name[@type = 'pseudonym']>

Title 

If filing title present, index:

/TEI/teiHeader/fileDesc/titleStmt/title[@type = 'filing'] 

Otherwise, index and concatenate for display (245b may or may not be present):

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245a']
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245b'] 
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245c'] 

An example of this display, would be:

  • Snap-dragons a tale of Christmas eve, and Old Father Christmas : an old fashioned tale of the young days of a grumpy old godfather by Juliana Horatia Ewing ; illustrated by Gordon Browne ; engraved and printed by Edmund Evans
    • Snap-dragons (marc245a)
    • a tale ... (marc245b)
    • by Juliana Horatia ... (marc245c, stmt of resposibility)

Publication Information

Note: Sometimes there are more than one publisher and pub place

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/pubPlace
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/publisher
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date

Subjects

Note: One, some or none of these may be present

/TEI/teiHeader/profileDesc/textClass/keywords[@scheme = 'lcsh']/list/item
/TEI/teiHeader/profileDesc/textClass/keywords[@scheme = 'victbib']/list/item

Genre

Note: Sometimes there are more than one genre term assigned

/TEI/teiHeader/profileDesc/textClass/keywords[@scheme = 'mla']/list/item

XPath for Full Text

/TEI/text

Home

  • See Home Wireframe
    • Update to wireframe shows the site navigation with genre browse.
    • The "Reference" page, imagined as the place for the VWWP timeline, is not longer relevant.  Once we are ready to add the timeline, we need to find a better spot for it.

Searching such as in the persistent keyword search box needs to index both the metadata as documented in phase 1 indexing requirements and phase 2 (herein).


Search

Note: Genre will not be part of the search fielded options or limiters (despite the search screen wireframe)

Fielded and persistent keyword search box needs to index both the metadata as documented in part 1 indexing requirements and part 2 (herein).

Fielded Search Options for New TEI Files

Keyword

Author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author 

If author has a pseudonym, look for:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/name[@type = 'pseudonym']>

Title

If filing title present, index:

/TEI/teiHeader/fileDesc/titleStmt/title[@type = 'filing'] 

Otherwise, index and concatenate for display (245b may or may not be present):

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245a']
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245b'] 
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245c'] 

Publisher

Note: Sometimes there are more than one publisher and pub place

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/publisher

Date Range Option

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date

Genre

Note: Sometimes there are more than one genre term assigned

/TEI/teiHeader/profileDesc/textClass/keywords[@scheme = 'mla']/list/item

Browse

Browse by Author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author 

If author has a pseudonym, look for:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/name[@type = 'pseudonym']>

(warning) Browse by Title

  • See Browse by Title Wireframe
    Note: Wireframe updated to reflect the addition of the author name in brackets after the title and to indicate a problem with the
    245c marc metadata that is technically part of the title (thought it's a statement of responsibility and lists attribution).

If filing title present, index:

/TEI/teiHeader/fileDesc/titleStmt/title[@type = 'filing'] 

Otherwise, index and concatenate for display (245b may or may not be present):

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245a']
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245b'] 
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245c'] (I think we should AX this component in the browse list; I have attempted to accomodate it in the results view)

Browse by Publication Year

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date

(warning) Browse by Genre

Note: The MLA genre headings are actually organized in a hierarchical fashion in our Terminology Service (TS), but they are flatly represented in the TEI structure. Perhaps the IDs assigned to the headings from the TS can help construct the hierarchy. We need to further explore what the implications are of displaying a flat browse list versus a hierarchical. For instance, an A-Z flat list will not group "Poetry" with "Dramatic Poetry" or "Epic Poetry." Not sure if we need to resolve this or not.

To see what this hierarchy looks like, download the MLA spreadsheet that is used by the TS.

Note: Sometimes there are more than one genre term assigned

/TEI/teiHeader/profileDesc/textClass/keywords[@scheme = 'mla']/list/item

Results

  • See Results Wireframe
    Wireframe updated to reflect genre facet, addition of genre in the results display and a new field called "contributor" to acocmodate the 245c metadata, but that needs some discussion. 
  • Ignore Page Image and PD integration as wireframed since we have a solution already in place
  • Ignore critical introductions for now

Link to Critical Introductions

Note: Until the PURL syntax is established for the intros, the TEI header currently references just the filename.

When texts have a critical introduction, you will know by the following bit of markup in the TEI Header:

/TEI/teiHeader/fileDesc/notesStmt/note[@type = 'relatedItem']/bibl/title[@type = 'Filename or PURL']

Sort

Author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author 

If author has a pseudonym, look for:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/name[@type = 'pseudonym']

Title

If filing title present, index:

/TEI/teiHeader/fileDesc/titleStmt/title[@type = 'filing'] 

Otherwise:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245a']
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245b'] 
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245c'] 

Publication Year

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date

Fielded Results Display

Title

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245a']
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245b'] 

Author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author 

If author has a pseudonym, look for and display in brackets like the site currently does:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/name[@type = 'pseudonym']>

(warning) Contributor

Note: To be discussed further

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245c'] 

Publication Year

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date

Source

Sometimes there are more than one publisher and pub place

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/pubPlace
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/publisher
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/extent

(warning) Genre

Note: Sometimes there are more than one genre term assigned

/TEI/teiHeader/profileDesc/textClass/keywords[@scheme = 'mla']/list/item

Facets

Publication Year

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date

Author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author 

If author has a pseudonym, look for and display in brackets like the site currently does:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/name[@type = 'pseudonym']>

Publisher

Sometimes there are more than one publisher

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/publisher

Genre

Note: Issues concerning hierarchy pending; Sometimes there are more than one genre term assigned

/TEI/teiHeader/profileDesc/textClass/keywords[@scheme = 'mla']/list/item

(warning) My Selection (formerly known as Bookbag)

  • (question) Genre and contributor in the results display

 


Full Text View of Text

Text Heading

Title

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245a']
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245b'] 

Author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author 

If author has a pseudonym, look for and display in brackets like the site currently does:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/name[@type = 'pseudonym']>

Metadata Display

Title

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245a']
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245b'] 

Author

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author 

If author has a pseudonym, look for and display in brackets like the site currently does:

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/author/name[@type = 'pseudonym']>

Contributor

To be discussed further

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/title[@type = 'marc245c'] 

Publication Year

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/date

Source

Sometimes there are more than one publisher and pub place

/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/pubPlace
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/imprint/publisher
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/extent

Genre

/TEI/teiHeader/profileDesc/textClass/keywords[@scheme = 'mla']/list/item

Critical Introduction

Note: Provide link to Critical Introductions from main text area (and Doc Info).  Part of next release. Preview for critical intros is looking to default at titlePage and this element is non-existent in these texts.

 Note: Until the PURL syntax is established for the intros, the TEI header currently references just the filename.

/TEI/teiHeader/fileDesc/notesStmt/note[@type = 'relatedItem']/bibl/title[@type = 'Filename or PURL']

Download PDF

  • Link to PURL

Download XML

  • Link to PURL

Full Text View Introductions

  • See Full Text View with Metadata Expanded Wireframe
    This new wireframes displays how the introductions should display and link to the source text. These intros are born-digital so we do not have PDFs which means we'll need to maintain the "printer-friendly view" for these like we do the legacy texts.These files are pending PURL assignments and are currently stored in Xubmit in the VWWP_ongoing repository. For more information about their general structure and format, consult VWWP Critical Introductions and Bios Encoding Guidelines.

Intros are currently referenced from the source text by their filename (e.g., VAB####_intro.xml) until the PURLs are established.

Text Heading

Title

/TEI/teiHeader/fileDesc/sourceDesc/bibl/title

Author

/TEI/teiHeader/fileDesc/sourceDesc/bibl/author

Metadata Display

Title

/TEI/teiHeader/fileDesc/sourceDesc/bibl/title

Author

/TEI/teiHeader/fileDesc/sourceDesc/bibl/author

Date

/TEI/teiHeader/fileDesc/sourceDesc/bibl/date

Download XML

  • Link to PURL

Link to Source Text

  • Linked title of source text (PURL)

Text Display for Full Text View

I have begun documenting changes required here: VWWP Full Text Display Styling Cheat Sheet. Julie is ready to work on many of these changes – those that a) impact Brevier and b) VWWP seriously enough. I will flesh out the details on the few other issues pending in the coming week as I make updates and changes to the VWWP TEI P5 Encoding Guidelines.

No special styling requirements are anticipated for the critical introductions, but testing against the updated VWWP XSL will need to confirm this.

  • Display issues are surfacing as part of quality review of newly encoded texts.  These issues will be entered as JIRA tasks for Julie.
  • No labels