Difference between revisions of "Talk:Best Practices for TEI in Libraries"

From TEIWiki
Jump to navigation Jump to search
(Review ODDs and schemas derived from them: new info based on emails from Syd)
(removed things completed long ago)
Line 1: Line 1:
The following are revisions to make to the BP before making an official "release".  There is a separate list of [[Future changes to Best Practices for TEI in Libraries]].
+
The following are things to do to the BP before making an official "release".  There is a separate list of [[Future changes to Best Practices for TEI in Libraries]].
  
 
== Review ODDs and schemas derived from them ==
 
== Review ODDs and schemas derived from them ==
Line 6: Line 6:
  
 
For those of you who are not interested in wrestling with command-line `roma`<ref>Last I knew, the web `Roma` will not properly process the new ODD constructs, so cannot be used for these files. Using the command-line `roma` is not all that bad, though. And once you get the hang of it, it is ''much'' faster than using the web. For a complete set of instructions for installing command-line `roma` on Mac OS X (or GNU/Linux), see http://www.wwp.brown.edu/encoding/current/handouts/roma_CLI_MacOS_X.html . Note that (a) there is a known but small cart-before-the-horse problem in these instructions — I don’t remember what it is at the moment or I’d tell you; and (b) that URL will (hopefully) change later this month, but it will probably get re-directed. ([[User:Syd|Syd]]</ref>, there is a snapshot of the HTML documentation and schemas (both closed in RELAX NG and open in ISO Schematron) on the web. There is [http://tei.wwp.brown.edu/~syd/temp/TEI-Library-SIG/BP_files.html an easy-to-use list of the most important files] and [http://tei.wwp.brown.edu/~syd/temp/TEI-Library-SIG/BestPractices/ the entire list of files]. There is a lot of work to be done on these documents. Even after we find & fix errors, we need lots of examples for the tagdocs (examples in the element definitions to override the default ones from P5, many of which aren't valid according to the BP because they contain extra elements, are missing required attributes, etc.).
 
For those of you who are not interested in wrestling with command-line `roma`<ref>Last I knew, the web `Roma` will not properly process the new ODD constructs, so cannot be used for these files. Using the command-line `roma` is not all that bad, though. And once you get the hang of it, it is ''much'' faster than using the web. For a complete set of instructions for installing command-line `roma` on Mac OS X (or GNU/Linux), see http://www.wwp.brown.edu/encoding/current/handouts/roma_CLI_MacOS_X.html . Note that (a) there is a known but small cart-before-the-horse problem in these instructions — I don’t remember what it is at the moment or I’d tell you; and (b) that URL will (hopefully) change later this month, but it will probably get re-directed. ([[User:Syd|Syd]]</ref>, there is a snapshot of the HTML documentation and schemas (both closed in RELAX NG and open in ISO Schematron) on the web. There is [http://tei.wwp.brown.edu/~syd/temp/TEI-Library-SIG/BP_files.html an easy-to-use list of the most important files] and [http://tei.wwp.brown.edu/~syd/temp/TEI-Library-SIG/BestPractices/ the entire list of files]. There is a lot of work to be done on these documents. Even after we find & fix errors, we need lots of examples for the tagdocs (examples in the element definitions to override the default ones from P5, many of which aren't valid according to the BP because they contain extra elements, are missing required attributes, etc.).
 
== Pending Review: Use of any P5 attributes ==
 
 
On the June 2 conference call, the group agreed to create a list of all attributes to include for Level 1-4.
 
 
* [[Best_Practices_for_TEI_in_Libraries#General_Guidelines_for_Attribute_Usage|Prose changed]] now reflects that there are recommended/required attributes in the body of a text
 
** This text will need to be revised again after the attribute list has been generated (2010-09:30: DONE BY KEVIN)
 
** We will probably add an appendix of all attributes identified (DONE BY MICHELLE IN AUGUST)
 
* With the goal of creating an "include" list of attributes, Lisa compiled a list of attributes mentioned in the BP, followed by a list of all the additional attributes include in P5, see [[List of attributes suggested to include in BPG, and those excluded]]
 
* The group will need to review the list for completeness
 
* Syd will constrain the ODDs accordingly
 
* Group will then need to test against real-life files
 
 
== Pending Review: Add history of version 3 to Appendix A ==
 
 
Text is now in the main prose. Could benefit from group review.
 
: I reviewed and think it is good -- I was more out of the loop in 2009, so I am not the best of reviewers. But let this count as my approval! --[[User:Emcaulay|Emcaulay]] 13:29, 20 June 2010 (EDT)
 
 
== Pending Review: Add Tite as Level 3.5 ==
 
 
This was [[Minutes_from_November_14%2C_2009#Harmonizing_TEI_Tite_with_the_Best_Practices:_Is_it_worth_pursuing.3F|strongly recommended by Daniel Pitti]] in Ann Arbor because he felt certain that administrators and funders would be confused about the difference between TEI Tite and the Best Practices ("don't the libraries already have a TEI customization?"); in fact, Kevin has known this same confusion to arise among TEI Council members.  While we have a section of the BP discussion its relationship to Tite, by having a Level 3.5, we can be more explicit about mapping between the two.
 
 
'''Mapping clarification from Kevin:'''  Instead of actually mapping elements, Daniel wanted us to simply proclaim use of Tite as one of a number of appropriate encoding levels for libraries.
 
 
Naturally we will not be able to describe Tite the way we do other levels -- by simply saying "all the elements in the previous levels, plus the following".  Tite uses different element names of all sorts. There's no point in having Syd make an ODD for Tite since one already exists.  So what Kevin envisions here is a sort of "sidebar" about Tite, inserted between Levels 3 and 4 that discusses Tite in a bit more detail than we currently have in the beginning of the BP, with particular discussion of mapping between the two.
 
 
We recently had some discussion about the merits of this, so maybe we won't do it in the end.  But if we do, we'll need a draft of this new sidebar.  Two paragraphs are already written for you (the brief discussion of the relationship between Tite and the BP), and you can pull more information from Tite's discussion of an earlier version of the Best Practices.
 
 
Would someone be willing to write a first draft of all of this?  Two paragraphs are already written for you, and you can pull more information from Tite's discussion of an earlier version of the Best Practices.
 
 
: Can we just use what's written here (rather than link to it) and modify accordingly fpr our level 3.5: http://www.tei-c.org/release/doc/tei-p5-exemplars/html/tei_tite.doc.html#tei-in-lib-bpg.  Didn't Kevin write this anyway?  If not, whose permission do we need?
 
:: I'm pretty sure Perry Trolard wrote this section.  Shouldn't be a problem to use it.  However, we should carefully check all the assertions since things have likely changed since Tite was last revised. (kshawkin)
 
::: Kevin looked over changes made since Perry wrote that text in May 2009.  Don't see any major changes, so it should be fine to link to Appendix A of Tite.  We clarified relation ship between Tite and BP in the prose; adding a Level 3.5 is on hold.
 
 
Add Perry trolard to acks? --[[User:Emcaulay|Emcaulay]] 13:32, 20 June 2010 (EDT)
 
  
 
== Acknowledgments ==
 
== Acknowledgments ==
 
* May need to revise DLF thank you to something more onging if they continue ot provide support (under discussion)
 
* May need to revise DLF thank you to something more onging if they continue ot provide support (under discussion)
 
== examples of each encoding level ==
 
 
We've got one example of Level 1 and one for Level 2 in the [[Best_Practices_for_TEI_in_Libraries#Introduction|Introduction]].  Kevin has asked Matthew Gibson to provide a Level 3 example.  Could we get Level 4 and Level 5 examples?  We're looking for examples of ''texts delivered online'', not necessarily with XML exposed.  The goal is to show what sort of ''functionality you might offer at each level, not perfect encoding''!
 
 
: done (Sept./Oct. 2010)
 

Revision as of 16:48, 3 January 2011

The following are things to do to the BP before making an official "release". There is a separate list of Future changes to Best Practices for TEI in Libraries.

Review ODDs and schemas derived from them

The latest version of the Best Practices for TEI in Libraries document, now derived from source TEI ODD files, is available for review. I have moved all of the content from the wiki page to TEI source files, but there is still a lot of work to be done. Besides just plain copy editing and review of the document and thorough testing of the schemas, the generic TEI stylesheets are not really up to the task of making the documents easily readable. The source is maintained on GitHub. Anyone (in the world) can get a copy of the source files from there at any time. Any one of you that wishes to have write access needs to send Syd your GitHub user name and he’ll add you to the “contributors” list.

For those of you who are not interested in wrestling with command-line `roma`<ref>Last I knew, the web `Roma` will not properly process the new ODD constructs, so cannot be used for these files. Using the command-line `roma` is not all that bad, though. And once you get the hang of it, it is much faster than using the web. For a complete set of instructions for installing command-line `roma` on Mac OS X (or GNU/Linux), see http://www.wwp.brown.edu/encoding/current/handouts/roma_CLI_MacOS_X.html . Note that (a) there is a known but small cart-before-the-horse problem in these instructions — I don’t remember what it is at the moment or I’d tell you; and (b) that URL will (hopefully) change later this month, but it will probably get re-directed. (Syd</ref>, there is a snapshot of the HTML documentation and schemas (both closed in RELAX NG and open in ISO Schematron) on the web. There is an easy-to-use list of the most important files and the entire list of files. There is a lot of work to be done on these documents. Even after we find & fix errors, we need lots of examples for the tagdocs (examples in the element definitions to override the default ones from P5, many of which aren't valid according to the BP because they contain extra elements, are missing required attributes, etc.).

Acknowledgments

  • May need to revise DLF thank you to something more onging if they continue ot provide support (under discussion)