#45 express release info in html

done
5(medium)
2014-07-22
2006-04-28
Tom Elliott
No

The cover page, and perhaps each subordinate page, in
the html transform of the guidelines should prominently
express the associated release rubric and date, so as
to facilitate citation and update.

Discussion

  • Elli Mylonas
    Elli Mylonas
    2014-05-29

    • status: open --> accepted
    • Group: --> Next_Release_(example)
    • Priority: 5 --> 1(low)
     
  • Elli Mylonas
    Elli Mylonas
    2014-05-29

    This is a good idea, but requires work on xslt and also on the xml because we don't have version/date info easily available. The date that appears now is the date of transform and upload.
    SVN used to have the variables for this. XML should have commit info, and web page should have the release info.

     
  • BODARD Gabriel
    BODARD Gabriel
    2014-05-29

    I'll track down the @version attribute used in the TEI Guidelines for this purpose, and add that to driver.xml. It's then a relatively simple XSLT question to add this to the web pages, so I'll suggest doing that too. (Open question about what "dev" pages should say?)

     
  • BODARD Gabriel
    BODARD Gabriel
    2014-05-29

    • assigned_to: BODARD Gabriel
    • Priority: 1(low) --> 5(medium)
     
  • BODARD Gabriel
    BODARD Gabriel
    2014-05-29

    @version on <TEI> should read "P5", rather than the EpiDoc version.

    Perhaps the @source on <schemaSpec> in the EpiDoc ODD should have a value such as "epidoc:8.18" (by analogy with "tei:1.5.1" recommended at http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-att.readFrom.html). Not sure what the implementation/validation implacations of that are. I suspect the xslt expects something other that what will actually be here.

    So maybe then, the answer is something bespoke like @n on the <TEI> of the Guidelines (i.e. in driver.xml)? What do others think? (Perhaps to be discussed on Markup.)

    What I'd like to see is the ability to:

    1. on release, tag the guidelines as "8.18 stable" so that the HTML pages all say so;
    2. after release, tag the guidelines "post-8.18 dev" to that the dev HTML pages are transparent about what they are too. (Once we have this implemented, we need to put it in the release process document as well.)
     
    Last edit: BODARD Gabriel 2014-05-29
  • BODARD Gabriel
    BODARD Gabriel
    2014-06-26

    GB will implement a bespoke solution in the driver and epidoc gl XSLT, and run past group for approval.

     
  • BODARD Gabriel
    BODARD Gabriel
    2014-07-22

    Implemented at [r2213].

    I have added a <seg type="version"> in the title of driver.xml, and written an override to the template named "stdfooter" in the TEI stylesheets to display this in the footer. There may be some discussion needed on exactly how we should (a) encode, and (b) display this information, but for now it works so I'm closing the ticket.

     

    Related

    Commit: [r2213]

  • BODARD Gabriel
    BODARD Gabriel
    2014-07-22

    • status: accepted --> done