Difference between revisions of "Tips and best practices"

From Digital Scholarship Group
Jump to navigation Jump to search
Line 1: Line 1:
 
'''Research strategies for locating reviews'''
 
'''Research strategies for locating reviews'''
 +
*Check [DPLA http://dp.la/]
 +
*Check [WorldCat worldcat.org]
  
 
'''Encoding strategies'''
 
'''Encoding strategies'''
 
*You can use elements that aren't supplied by the interface, but you should do so according to the [[Principles_for_encoding|project's principles]]; use elements that help with tracking the things we are interested in without adding in elements just because you can
 
*You can use elements that aren't supplied by the interface, but you should do so according to the [[Principles_for_encoding|project's principles]]; use elements that help with tracking the things we are interested in without adding in elements just because you can
 +
*You should use the long-s character (U+017F) but you don't need to worry about most other typographic details
 +
*If you have a reception item that is unclear enough that you can't be confident in encoding it, bring it to a meeting
 +
*If you flag a reception item, fill in a note in both the interface and the tracking spreadsheet explaining why it is flagged; use the flag function for serious issues with items or cases where further discussion is needed before the items can be published
 +
*The interface will give you buttons for the following elements:
 +
**<head>: use for headings
 +
**<p>: paragraph
 +
**<lg>: line group—use to wrap around poems or selections from poems
 +
**<l>: line—use for each individual line of poetry
 +
**<italic>: use for italicized text; can be used in combination with other phrase-level elements as appropriate
 +
**<persName>: names of persons—note that some publishers are also persons, and should be encoded in <persName>
 +
**<placeName>: names of places
 +
**<quote>: use for quoted materials—this element will also display with quotation marks; if you have quotation marks in your text that are not part of a quote, you should type them in
 +
**<title>: use for titles of texts; note that these are often abridged in the reception items—titles need not be exact to be encoded in <title>
 +
 +
*You can also use:
 +
**<note>: use for textual notes supplied by reviewers
 +
**<anchor>: use to mark the place in the reception item that a specific <note> is referring to
 +
**<rs>: use with @type of "properAdjective" for proper adjectives
 +
 +
*You should not use
 +
**<name>
 +
**<said>
 +
**<emph>
 +
**<mcr>
 +
**elements for recording bibliographic information, such as <bibl> or <docImprint>
 +
**elements for page breaks or metawork
  
 
'''Using the interface'''
 
'''Using the interface'''

Revision as of 12:27, 30 June 2015

Research strategies for locating reviews

Encoding strategies

  • You can use elements that aren't supplied by the interface, but you should do so according to the project's principles; use elements that help with tracking the things we are interested in without adding in elements just because you can
  • You should use the long-s character (U+017F) but you don't need to worry about most other typographic details
  • If you have a reception item that is unclear enough that you can't be confident in encoding it, bring it to a meeting
  • If you flag a reception item, fill in a note in both the interface and the tracking spreadsheet explaining why it is flagged; use the flag function for serious issues with items or cases where further discussion is needed before the items can be published
  • The interface will give you buttons for the following elements:
    • <head>: use for headings
    • : paragraph

    • <lg>: line group—use to wrap around poems or selections from poems
    • <l>: line—use for each individual line of poetry
    • <italic>: use for italicized text; can be used in combination with other phrase-level elements as appropriate
    • <persName>: names of persons—note that some publishers are also persons, and should be encoded in <persName>
    • <placeName>: names of places
    • <quote>: use for quoted materials—this element will also display with quotation marks; if you have quotation marks in your text that are not part of a quote, you should type them in
    • <title>: use for titles of texts; note that these are often abridged in the reception items—titles need not be exact to be encoded in <title>
  • You can also use:
    • <note>: use for textual notes supplied by reviewers
    • <anchor>: use to mark the place in the reception item that a specific <note> is referring to
    • <rs>: use with @type of "properAdjective" for proper adjectives
  • You should not use
    • <name>
    • <said>
    • <emph>
    • <mcr>
    • elements for recording bibliographic information, such as <bibl> or <docImprint>
    • elements for page breaks or metawork

Using the interface

  • To use the search box or the "Show records" box, do not hit "Enter"—just click outside the search box and it should work.
  • The same principle applies to showing more than ten records; enter the number you want to display and then click outside the box. 100 is the maximum you can display.
  • You can't go back to browse after you've searched for a record or changed the number of items; instead refresh the entire page.
  • If you're trying to navigate to a specific reception item, change the number of records from 10 to 100, then do a keyword search for the author's last name, hitting "next" as needed to get to the page with the author you're looking for.
  • The colored boxes indicate the format of the reception item; you can mouse over them to see the format