Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#188 @docStatus on <edition>

AMBER
closed
Lou Burnard
5
2010-05-06
2009-06-26
James Cummings
No

There has been public demand for a @docStatus on the <edition> element, (TEI-L 2009-06-25+)primarily to be used in the <editionStmt> to indicate the status of the current edition of the document. This is different from change management, as many changes might be made on a document of the same status 'draft', but it might go from 'pending' to 'approved' with no change of text.

Sample values for an enumerated but open list might include some of the following suggestions:

Candidate
Recommendation
Submitted
Approved
Deprecated
Proposed
Cleared
Embargoed
Draft
Frozen
Expired
unfinished
draft
galley
published
withdrawn
expired

datatype might be one of data.enumerated

Examples should possibly include a <date> inside the <edition> noting the date the edition reached that status.

-J

Discussion

  • Lou Burnard
    Lou Burnard
    2009-08-01

    So far as I can judge, this attribute really describes the kind of edition, so why not call it @type? We're not talking about the status of the document so much as the standing of this edition, surely?

     
  • Lou Burnard
    Lou Burnard
    2009-08-20

    • milestone: 871208 --> AMBER
     
  • James Cummings
    James Cummings
    2009-08-20

    I don't think this is the 'type' of edition. But maybe we mean something different by edition. The 'edition' element in typically TEI manner is recursively vague in saying "describes the particularities of one edition of a text". I don't really view (and I don't think the people on TEI-L who actually requested this really view) a 'draft', 'galley', and 'published' (or indeed 'withdrawn' or 'frozen' as different *editions* in themselves but simply different documentation statuses for a single particular edition. (Though I would agree that you can have types of edition as well, and that edition could do with having @type.)

    -J

     
  • Peter Boot
    Peter Boot
    2009-12-07

    Isn't a docstatus something that would apply to the document as a whole? To add this attribute to the edition element seems arbitrary to me. Why not add it to TEI (or text) instead?

     
  • Lou Burnard
    Lou Burnard
    2010-02-09

    council discussed this and agreed that (a) there should be a currentStatus attribute on <revisionDesc> (b) there might be an optional @status on <change> to indicate the status of the document at the time the change described was made (c) clear documentation of how these attributes should be used in a typical workflow should be provided

     
  • Lou Burnard
    Lou Burnard
    2010-05-06

    • status: open --> closed
     
  • Lou Burnard
    Lou Burnard
    2010-05-06

    Added new att.docStatus class, giving @status attribute, and made <change> and <revisionDesc> members of same. Added some remarks about how it should be used, but probably the discussion in HD needs expansion too, pending other revisions to that chapter. At rev #7471