TEI Work with Affiliated Projects Document Number: TEI SCP2 April 23, 1991 (18:35:10) Draft April 23, 1991 (18:35:10) ABSTRACT This document describes specific proposals for implementing the coop- eration between the Text Encoding Initiative and Affiliated Projects which is described in general terms in document TEI SCP1 "Cooperation with Affiliated Projects". The specific tasks expected of affiliated projects and of TEI consultants are listed. 1 1 OBJECTIVES APs fall into two types: those with existing schemes, who would be converting to a TEI format, and those who are effectively starting from scratch. From those who are converting, we hope to receive: * information (in the form of examples) about how they *currently* encode their material for local processing * information about how they would/will convert that format to a TEI conformant one, so as to identify shortcomings and possible exten- sions. This includes the mechanism (software, hand conversion, etc.) and a description of that mechanism, with enough detail to enable an understanding of the nature and complexity of the conver- sion task. * a demonstration of the conversion, with meaningfully large samples of data. For those who are starting from scratch, we hope for: * meaningfully large samples of data encoded in the TEI format. The TEI format is two-fold: that which has been specified already, in the current draft of the Guidelines, and that which is under devel- opment. We need (1) testing of what has been developed and (2) input into the development of additional tags. From both groups we want input concerning their problems with the exist- ing TEI guidelines and their needs for additional tags and mechanisms. We also want information on any supporting software they may use or develop. To each group, the TEI hopes to be able to provide: * assistance in interpreting the guidelines and in finding suitable solutions to markup problems * help in developing solutions to practical problems of transduction and data capture * an introduction to the use of SGML software and the TEI DTDs in the form of a TEI workshop 2 2 SPECIFICS 1. Each affiliated project is asked to provide, as soon as practica- ble (immediately if possible) the name and contact details for the person they wish to liaise with us from within their organisation (the "Project Representative"). 2. As soon as we can, the TEI will allocate each project a TEI con- tact person (the "TEI consultant"). 3. The TEI consultant will contact the Project Representative immedi- ately and arrange for the following to be sent to the TEI within a month (N.B. in some cases this request has already been made by the editors): * a copy of their current encoding manual or other documentation of their current encoding practices, sufficiently detailed for someone to write a pilot conversion program, together with some sample data (if we don't already have it). * a completed TEI User Response and Comment Form. 4. The Project Representative will be placed on the mailing list of relevant WGs and TEI commitees. Any person named by the Project Representative may attend relevant TEI workshops, committee meet- ings, or work group meetings, on behalf of the Affiliated Project; no TEI travel subsidy is available for such attendance. 5. The Project Representative and TEI Consultant will attend (at TEI expense) a TEI workshop for the affiliated projects,(1) at which they will review the current draft of the TEI Guidelines and available SGML tools and prepare: * a short example of (not less than 5, not more than 30 Kb) of text from their project, encoded in a TEI conformant manner * a brief initial report containing - summary of any problems encountered - definition of the transduction algorithm (if any) or data- capture mechanisms (if any) used - recommendations for how conversion and data capture should proceed within the project 6. The Consultant will retain contact with the project and will act as its primary channel to TEI, answering any specific questions, resolving and recording any minor problems which may arise, through 1 November 1991 at least. By that date the project and consultant together should have completed: * a serious sample of converted text (not less than 100 Kb) * a more detailed final report containing - summary of remaining problems - full definition of the transductions performed or data capture mechanisms devised - source of DTDs and any software developed for the Affili- ated Project During this period, site visits may be desirable to enable the project and the consultant to work intensively together. Such visits, if desirable, must be funded by the affiliated project. (Special cases should be put to the editors.) 7. Upon receipt of a satisfactory major sample and final report, the TEI will pay an honorarium to the consultant. The TEI Consultant has to be able to do quite a lot of technical work. On the basis of the above description, he or she has to: * Provide the AP with an assessment of their existing encoding scheme, showing what needs to change for TEI conformance, and how; specify and, if necessary, write software to do any auto- matic conversion possible (clearly subject to financial lim- its, resources available in the project etc.) * report back to us on any problems encountered; help AP draft feedback report; assess success of AP in applying conversions to serious body of text, identify remaining problems, etc. Summary of Consultant's Commitments 1. agree to consult for at least one (preferably at least two) affil- iated projects 2. attend and help run a TEI workshop for affiliated projects: two days with the editors and other consultants, followed by a two-day public TEI workshop, followed by three days of work by consultants and affiliated projects. 3. During workshop, help affiliated projects produce a 5-30 Kb sample of TEI-conformant text 4. After the workshop, provide email and phone consulting for the projects on interpretation of the TEI guidelines and on problems of implementation. Expected problems include: use of transduc- tion tools, development of data entry methods, use of SGML soft- ware, interpretation of obscure TEI tags, help defining extensions to the TEI DTDs. Editors and committee and WG heads will help with interpretation, but consultants should do rest alone. 5. By 1 November 1991, help the AP produce a 100-500 Kb sample of TEI-conformant text and a report (5-20 pp.?) describing how it was done. 6. Upon receipt of satisfactory large sample and report, editors will authorize payment of a $750 honorarium (per project) to the con- sultant. Summary of Affiliated Project's Commitments 1. attend a TEI workshop for affiliated projects: two days of public TEI workshop, followed by three days of work with consultants and other affiliated projects. 2. During workshop, produce (with help of consultant) a 5-30 Kb sam- ple of TEI-conformant text 3. After the workshop, continue to work with TEI encoding of data, keeping TEI consultant informed of progress and problems. 4. By 1 November 1991, produce (with consultant's assistance) a 100-500 Kb sample of TEI-conformant text and a report (5-20 pp.?) describing how it was done. ------------------------- (1) These workshops are currently scheduled for July 1-5 in Oxford (June 29-July 5 for consultants) and July 22-26 (July 20-26 for consult- ants) in Providence R.I. Draft April 23, 1991 (18:35:10)