- Tei-council - lists.tei-c.org

release minutes
by Scholger, Martina (martina.scholger＠uni-graz.at) 29 Jan '19

29 Jan '19

Dear all, in case we need to take some notes during the release process, here is a document. It also contains the draft of the email for the TEI-L. https://docs.google.com/document/d/1fTrCQrC8tRTZWLGScXKb0R_brwhOoRA6uta4c1h… Martina

1 0

release branch
by Mylonas, Elli 29 Jan '19

29 Jan '19

Dear TEI Council: I am about to create the release branch for the release that Syd suggests several code names. I am unilaterally selecting the name "Raven" because Providence has a strong Edgar Allan Poe connection. Please do not commit any further changes, unless they are to the release notes or unless you communicate first with the release technicians or the chair. Release technicians are Hugh Cayless and myself. Thank you! --elli

6 14

Release Branch for release "The Raven" has been created
by Mylonas, Elli 25 Jan '19

25 Jan '19

Jenkins Maintainers please add built of the release branch "release-3.5.0" Thank you! --elli

1 0

Re: [Tei-council] first draft release notes
by James Cummings 25 Jan '19

25 Jan '19

Re: html:* passthrough. Sure, but I know SPQR used it for things locally in Oxford as well. But you could probably remove without side-effect. I doubt many other people are using them. (Though, how would we know?) re: highlighting github lines in a link. Cool isn't it. ;-) It is the way we should talk about code when discussing where some error is, by URI that references the lines (of a particular revision even better for historical completeness) Re: nuking ref I'm assuming you mean only the ones wrapped around gi? As there are some (pointing to things like classes etc) that we do need, obviously. Let me know if I can help, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Tei-council <tei-council-bounces(a)lists.tei-c.org> on behalf of Syd Bauman <s.bauman(a)northeastern.edu> Sent: 25 January 2019 19:45:16 To: TEI Council Subject: Re: [Tei-council] first draft release notes > That is the standard way that those profiles work, ... Yes, indeed. I was just listing 'em as that's the set of files I looked through. > The HTML is just a pass through for those doing readme files that > have some html embedded. Ummm ... OK. But of the 35 readme-*.xml files we have in P5/RelaseNotes/, not one has a single non-TEI element. > The makefile I was referring to was the P5 one at: > https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com… Wow. Thanks. (Not so much for the Makefile pointer, but for the cool demo of highlighting lines in GitHub source!) > You are right that grabbing version is a problem, but you've > omitted the _real_ problem which is that xslt is run over every xml > file in the directory. So you can't pass it the current version. > Instead, you would need to get it from the filename itself. Oh, good point! > Note, if doing this that it would have to be > tei:gi[not(ancestor::tei:ref)] or something, right? (Since there > are readme files that already have the refs around them. ;-) Sure, but my plan was to just nuke those <ref> elements. (After all, there are only 35 files ...) > Just thinking out loud, Thanks for doing so. I will get on that v. important version number bit in a few mins. Also need to add code for <att> and <ident>, which also occur inside <ref> in our collection of readmes. _______________________________________________ Tei-council mailing list Tei-council(a)lists.tei-c.org http://lists.lists.tei-c.org/mailman/listinfo/tei-council

1 0

Re: [Tei-council] first draft release notes
by James Cummings 25 Jan '19

25 Jan '19

Hi Syd, That is the standard way that those profiles work, by importing html.xsl (which of course imports all the common and html xslt), isn't it? The HTML is just a pass through for those doing readme files that have some html embedded. The makefile I was referring to was the P5 one at: https://github.com/TEIC/TEI/blob/dev/P5/Makefile#L271-L273 But that was just how I was figured out which XSLT profile is being called for the release notes. You are right that grabbing version is a problem, but you've omitted the _real_ problem which is that xslt is run over every xml file in the directory. So you can't pass it the current version. Instead, you would need to get it from the filename itself. So we'd have to get it from the filename. We should be able to do something like: <xsl:variable name="filename" select="(tokenize($document-uri,'/'))[last()]"/> to get the filename and then remove the version number from that. Note, if doing this that it would have to be tei:gi[not(ancestor::tei:ref)] or something, right? (Since there are readme files that already have the refs around them. ;-) Just thinking out loud, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Tei-council <tei-council-bounces(a)lists.tei-c.org> on behalf of Syd Bauman <s.bauman(a)northeastern.edu> Sent: 25 January 2019 17:36:38 To: TEI Council Subject: Re: [Tei-council] first draft release notes Boy, I never looked at it before, but profiles/readme/html/to.xsl looks like a very weird animal. It has templates that match the HTML namespace and ones that match the TEI namespace. That file imports html/html.xsl, which itself imports: common/verbatim.xsl, html/html_param.xsl, and common/common.xsl, which itself imports: common/common_param.xsl, common/common_core.xsl, common/common_textstructure.xsl, common/common_header.xsl, common/common_linking.xsl, common/common_msdescription.xsl, common/common_figures.xsl, common/common_textcrit.xsl, common/common_gaiji.xsl, common/i18n.xsl, and common/functions.xsl I've just looked through all of those (quickly), and none seem to have a template that matches <gi> explicitly. So I think it's probably quite reasonable to just tuck it in here. How would the code in to.xsl get the version number (to point to the Vault)? A parameter? Read P5/VERSION (in which case it needs to be updated before this is run)? > Not sure it does work automatically, one would think that it would > follow the same thing that happens with the Guidelines but looking > back through some earlier ones I'm not sure it does. > > Looking at the makefile which calls the ant script, I think that > the release notes are generated using the 'readme' profile of the > stylesheets. So: > > https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com… > > If we put a template in to handle tei:gi in that stylesheet that > would probably do it. (Anyone else see a problem with that?) > > And yes, I think release notes should always point to the Vault of > that version of the the Guidelines because if they point to the > live site then by next version they might be out of date. _______________________________________________ Tei-council mailing list Tei-council(a)lists.tei-c.org http://lists.lists.tei-c.org/mailman/listinfo/tei-council

2 1

Re: [Tei-council] first draft release notes
by James Cummings 25 Jan '19

25 Jan '19

Hi Martina, Not sure it does work automatically, one would think that it would follow the same thing that happens with the Guidelines but looking back through some earlier ones I'm not sure it does. Looking at the makefile which calls the ant script, I think that the release notes are generated using the 'readme' profile of the stylesheets. So: https://github.com/TEIC/Stylesheets/blob/dev/profiles/readme/html/to.xsl If we put a template in to handle tei:gi in that stylesheet that would probably do it. (Anyone else see a problem with that?) And yes, I think release notes should always point to the Vault of that version of the the Guidelines because if they point to the live site then by next version they might be out of date. Many thanks, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Scholger, Martina (martina.scholger(a)uni-graz.at) <martina.scholger(a)uni-graz.at> Sent: 24 January 2019 21:38:27 To: James Cummings; TEI Council Subject: AW: first draft release notes Hi James, That would be convenient! But I can’t find an example where this works – do you have one? I have seen that in some older versions the links point to the Vault. Should we change that? Best wishes, Martina Von: James Cummings <James.Cummings(a)newcastle.ac.uk> Gesendet: Donnerstag, 24. Januar 2019 18:07 An: Scholger, Martina (martina.scholger(a)uni-graz.at) <martina.scholger(a)uni-graz.at>; TEI Council <tei-council(a)lists.tei-c.org> Betreff: Re: first draft release notes I notice in the Release Notes that we seem to be putting both <ref> and <gi> around element names? This only seems to have started in the last few releases where before we just put <gi> and the magic of the build process turned this into a link in the release notes. Can someone confirm/deny whether we need to do this or not? If we do it seems like we should change the script rather than the encoding. Many thanks, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk<mailto:James.Cummings@newcastle.ac.uk> Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Tei-council <tei-council-bounces(a)lists.tei-c.org<mailto:tei-council-bounces@lists.tei-c.org>> on behalf of Scholger, Martina (martina.scholger(a)uni-graz.at<mailto:martina.scholger@uni-graz.at>) <martina.scholger(a)uni-graz.at<mailto:martina.scholger@uni-graz.at>> Sent: 23 January 2019 23:41:16 To: TEI Council Subject: [Tei-council] first draft release notes Dear all, I made a first draft of the release notes: https://github.com/TEIC/TEI/blob/dev/P5/ReleaseNotes/readme-3.5.0.xml. There are still some TEI issues missing (from #1479 to #1645), which I will add tomorrow. For the Stylesheets release notes: should we add them to the same document? Martina

2 2

Re: [Tei-council] first draft release notes
by James Cummings 24 Jan '19

24 Jan '19

I notice in the Release Notes that we seem to be putting both <ref> and <gi> around element names? This only seems to have started in the last few releases where before we just put <gi> and the magic of the build process turned this into a link in the release notes. Can someone confirm/deny whether we need to do this or not? If we do it seems like we should change the script rather than the encoding. Many thanks, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Tei-council <tei-council-bounces(a)lists.tei-c.org> on behalf of Scholger, Martina (martina.scholger(a)uni-graz.at) <martina.scholger(a)uni-graz.at> Sent: 23 January 2019 23:41:16 To: TEI Council Subject: [Tei-council] first draft release notes Dear all, I made a first draft of the release notes: https://github.com/TEIC/TEI/blob/dev/P5/ReleaseNotes/readme-3.5.0.xml. There are still some TEI issues missing (from #1479 to #1645), which I will add tomorrow. For the Stylesheets release notes: should we add them to the same document? Martina

2 1

first draft release notes
by Scholger, Martina (martina.scholger＠uni-graz.at) 24 Jan '19

24 Jan '19

Dear all, I made a first draft of the release notes: https://github.com/TEIC/TEI/blob/dev/P5/ReleaseNotes/readme-3.5.0.xml. There are still some TEI issues missing (from #1479 to #1645), which I will add tomorrow. For the Stylesheets release notes: should we add them to the same document? Martina

4 8

Re: [Tei-council] first draft release notes
by James Cummings 24 Jan '19

24 Jan '19

I notice in the Release Notes that we seem to be putting both <ref> and <gi> around element names? This only seems to have started in the last few releases where before we just put <gi> and the magic of the build process turned this into a link in the release notes. Can someone confirm/deny whether we need to do this or not? If we do it seems like we should change the script rather than the encoding. Many thanks, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Tei-council <tei-council-bounces(a)lists.tei-c.org> on behalf of Scholger, Martina (martina.scholger(a)uni-graz.at) <martina.scholger(a)uni-graz.at> Sent: 23 January 2019 23:41:16 To: TEI Council Subject: [Tei-council] first draft release notes Dear all, I made a first draft of the release notes: https://github.com/TEIC/TEI/blob/dev/P5/ReleaseNotes/readme-3.5.0.xml. There are still some TEI issues missing (from #1479 to #1645), which I will add tomorrow. For the Stylesheets release notes: should we add them to the same document? Martina

1 0

Refridge
by Scholger, Martina (martina.scholger＠uni-graz.at) 23 Jan '19

23 Jan '19

Dear all, this is a reminder that we are in the middle of the "refridge phase". This means that it is fine to fix typos and do small changes in prose, but please don't change the schema any more. Freeze is on Thursday, Elli will do the release branch on Friday. Best wishes, Martina Mag. Dr.phil. Martina Scholger Zentrum für Informationsmodellierung - Austrian Centre for Digital Humanities Elisabethstraße 59/III 8010 Graz Austria martina.scholger(a)uni-graz.at<mailto:martina.scholger@uni-graz.at> https://informationsmodellierung.uni-graz.at<https://informationsmodellierung.uni-graz.at/> | https://gams.uni.graz.at<https://gams.uni.graz.at/> Institut für Dokumentologie und Editorik e.V. | https://i-d-e.de<https://i-d-e.de/> Chair of the TEI Technical Council | http://tei-c.org

1 0

Re: [Tei-council] cancel Stylesheets meeting?
by James Cummings 21 Jan '19

21 Jan '19

Hi, I can be there if people want. Otherwise, happy to open a chat and just work on tickets. ;-) Many thanks, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Tei-council <tei-council-bounces(a)lists.tei-c.org> on behalf of Syd Bauman <s.bauman(a)northeastern.edu> Sent: 18 January 2019 21:36:59 To: TEI Council; Lou Burnard; Martin Holmes Subject: [Tei-council] cancel Stylesheets meeting? For various reasons it looks like Martin, Elisa, and myself are the only ones who will make the Stylesheets meeting this coming Mon 21 Jan 19 at 14:00Z. (James? Maybe you will be there?) Thus perhaps we should cancel this one, especially since Mon is the last day to work on tickets (other than typos) before release. _______________________________________________ Tei-council mailing list Tei-council(a)lists.tei-c.org http://lists.lists.tei-c.org/mailman/listinfo/tei-council

3 3

cancel Stylesheets meeting?
by Syd Bauman 18 Jan '19

18 Jan '19

For various reasons it looks like Martin, Elisa, and myself are the only ones who will make the Stylesheets meeting this coming Mon 21 Jan 19 at 14:00Z. (James? Maybe you will be there?) Thus perhaps we should cancel this one, especially since Mon is the last day to work on tickets (other than typos) before release.

1 0

Call in 20 minutes
by Scholger, Martina (martina.scholger＠uni-graz.at) 18 Jan '19

18 Jan '19

Dear all, Our call starts in 20 minutes. https://docs.google.com/document/d/1n84gm-VcqR-UjBV1mDyd-l5PN-cgKYM2CD5QPAh…<https://docs.google.com/document/d/1n84gm-VcqR-UjBV1mDyd-l5PN-cgKYM2CD5QPAh…> Best wishes, Martina

1 0

tei:object updates
by James Cummings 17 Jan '19

17 Jan '19

Hi TEI Council, Minor changes: As you know I'm finishing off the tei:object element introduction and I've made a number of requested changes. I modified objIdentifier to objectIdentifier, added some more prose including a note in the prose of the Guidelines saying: "Please note: The object<https://jenkins.tei-c.org/job/TEIP5-dev/lastSuccessfulBuild/artifact/P5/rel…> element is a recent addition to the TEI Guidelines and as such may be more prone to further revision as its use develops. This may be particularly evident where its contents borrowed from msDesc<https://jenkins.tei-c.org/job/TEIP5-dev/lastSuccessfulBuild/artifact/P5/rel…> have yet to be generalized from their use in the context of manuscript descriptions." (I've made a note to myself to remove this at a later date.) Perhaps I should also put it as a remark on the object element specification page. Lots of minor changes: One of the legacy problems about basing object descriptions on (and as a more general form of) manuscript description is that numerous of the descendants of object specify in their descriptions that they are specifically to do with manuscripts. Often quite unnecessarily so. This is *already* out of date because with elements like typeDesc and typeNote we explicitly recommend the use of msDesc for objects which are not manuscripts (but early printed books, clay tablets, etc.). To solve this problem I've gone through all of the elements instantiated by the manuscript description chapter and rephrased any manuscript-specific terminology in the most minimal way possible. In almost all the cases this involved merely inserting 'or other object' after the word 'manuscript'. In some cases the description already said 'manuscript or manuscript part' and I changed this to 'manuscript, manuscript part, or other object'. Generally the changes were fairly simple, for example with the 'institution' element I changed it from: === <desc versionDate="2007-04-26" xml:lang="en">contains the name of an organization such as a university or library, with which a manuscript is identified, generally its holding institution.</desc> === to: === <desc versionDate="2019-01-17" xml:lang="en">contains the name of an organization such as a university or library, with which a manuscript or other object is identified, generally its holding institution.</desc> === A list of all of the changes as a single commit is at: https://github.com/TEIC/TEI/commit/41e7ce9ff35fd584eb3b314398a223987a04f5b0 if anyone wishes to check through them. In some cases (such as institution above) it might be better if instead of a phrase like 'manuscript or other object' or indeed 'manuscript, manuscript part, or other object' we just changed it to 'object'. i.e. above "contains the name of an organization such as a university or library, with which an object is identified, generally its holding institution". The reason I've not done this at the moment is to maintain the transparency of the legacy of these elements originating from the manuscript description module. (And indeed, one does not get these elements inside object unless that module is loaded -- which is fine to me.) Dimensions: On a related but slightly different issue, while going through the elements instantiated by the manuscript description module I reminded myself that dimensions, dim, height, width, and depth are all instantiated by this module even though I believe they are used by people not doing manuscript descriptions. I believe it might be worth revisiting their descriptions and consider moving them to the core module or similar at some point. One of the things that I noticed is that the descriptions of height, width, and depth are specific to text-bearing objects. So without change, for example, I could not provide the height, width, depth of an object that has not got any text on it. The descriptions are: === <depth> contains a measurement measured across the spine of a book or codex, or (for other text-bearing objects) perpendicular to the measurement given by the width element. <height> contains a measurement measured along the axis at right angles to the bottom of the written surface, i.e. parallel to the spine for a codex or book. <width> contains a measurement measured along the axis parallel to the bottom of the written surface, i.e. perpendicular to the spine of a book or codex. === I'm happy to put in an issue about this but potential generalising rewording might be: === <depth> contains a measurement from the front to the back of an object, perpendicular to the measurement given by the <width> element. <height> contains a measurement measured along the axis at a right angle to the bottom of the object. <width> contains a measurement of an object along the axis parallel to its bottom, e.g. perpendicular to the spine of a book or codex. === I'll stick this last bit in an issue. Many thanks, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University

1 0

Travel to and Accommodation in DC
by Raffaele Viglianti 17 Jan '19

17 Jan '19

Dear Council, As you start planning for your trip to DC in May, I thought I would send over some recommendations. Here is a map summarizing the information below: https://goo.gl/bqEA4k You have writing access to add hotels / AirBnBs you find if you so wish. Here is a google doc with the same text as below: https://goo.gl/nDzGq9 Both are in our TEI Council shared folder on Google Drive. *Airports*See if you are able to arrive to and leave from National Airport (DCA). You may find good flights via NYC or other East Coast cities, but no direct international flights except Canada. This airport is very close to downtown and very easy to reach by public transport or by a very affordable ride with a rideshare app. The main international airports are Dulles airport (IAD) and Baltimore-Washington (BWI). IAD has shared shuttle services (e.g. https://www.supershuttle.com/) as the metro to the airport is still under construction. BWI has shared shuttles and a train to Union Station. It also has a bus to the nearest DC metro station (Greenbelt), cash only https://www.bwiairport.com/to-from-bwi/transportation/transit/wmata. *Accommodation* DC hotels can be expensive. I would recommend to keep an eye out for deals. AirBnB is a more affordable alternative, where I see options under USD$100 per night. I recommend booking soon. Given that we'll spend most of our time at the Folger, I would recommend staying in these areas. *Walking distance*: Eastern Market, Capitol HIll, H Street Corridor, Union Station *Easy metro or bus access* (see below): Penn Quarter, Chinatown, Mt Vernon Sq/Convention center, NoMa, Southwest Waterfront, Navy Yard *Travel within the city* The DC area transport authority is called WMATA. The metro is frequent but will be packed downtown at peak times (if the government is open, lol). Buses are frequent, reliable and go everywhere. Find routes and a trip planner here: https://www.wmata.com/ . Google Maps is fairly reliable too as it uses their API. I strongly recommend purchasing a SmartTrip card at the dedicated machines in metro stations. They cost $10 with $8 credit. A bus ride will be around $2, while metro rides start at $2 and will cost more based on distance traveled. NB If your card credit goes negative after a metro ride, you will have to top up the card in order to exit the station. *Food* There will be plenty of lunch options around Folger at a 5-10 minute walk. For dinner, if we want to stick together, we'll likely hang around Eastern market (10min walk), H street (25min walk), or Chinatown (30min walk) depending on where people's hotels are, etc. I would love to have you all over at my place in the Columbia Heights neighborhood for dinner one evening. It's easily accessible via metro or bus. I'm not sure what would be the best evening for that, though. Suggestions welcome! Hope this helps and I look forward to having you in DC! Let me know if you have questions. Raff

1 0

Next call: January 18
by Scholger, Martina (martina.scholger＠uni-graz.at) 15 Jan '19

15 Jan '19

Dear all, this is the agenda for our next call on Friday, January 18 (16:00-17:30 EST, 21-22:30 GMT, 22:00-23:30 CET) https://docs.google.com/document/d/1n84gm-VcqR-UjBV1mDyd-l5PN-cgKYM2CD5QPAh… Please add topics / issues to the agenda. @Hugh: can we use this meet link again: https://meet.google.com/rnm-hjax-dgg ? Best wishes, Martina

1 0

unihanProp element #1805
by Scholger, Martina (martina.scholger＠uni-graz.at) 14 Jan '19

14 Jan '19

Dear Council, Last week we (SB, RV, HC, MS) had a productive call with Martin Holmes and Duncan Paterson on issue #1805 (https://github.com/TEIC/TEI/issues/1805) the new <uniHan> element. These are the full minutes (https://docs.google.com/document/d/1JsEaZU1H7EJMwXJmNgRLjOZoJOg6AHzMcDM41zb…) and here is the summary of our proposal (please correct me if I forgot something): We have all agreed that the introduction of a new element is a good idea. But we then came to the conclusion to better call it <unihanProp>. In the course of this, we would suggest to introduce two more elements, <localProp> and <unicodeProp>. The three elements should be child elements of <char> and <glyph> and have @name and @value (instead of the property name in <localName>/<unicodeName> and <value>). Consequently, this would necessitate to deprecate <charProp>. * Phase 0: Create att.gaijiProperties with @name and @value, to be used by <unicodeProp>, <localProp>, and <unihanProp>. * Phase 1: add the new <unicodeProp>, <unihanProp>, and <localProp> elements with closed valList for unicodeProp/@name and unihanProp/@name, along with prose changes. * NOTE: The entry for "charProp" in the content models of <char> and <glyph> becomes instead " ( charProp* | ( unicodeProp | unihanProp | localProp )* )", and a) <charProp> is deprecated (for some years), and b) the three new elements are members of a new class that has a required @name (which used to be the content) and a maybe required @value (which used to be the sibling <value>). * Phase 2: Test the more aggressive validation of all @values based on @name and regexes from TR 38. If it's not too onerous to run and to maintain, integrate it. * Phase 3: Update prose and specs for <unicodeName> and <localName> to deprecate the old mechanisms and recommend the new attributes. * Phase 4: Write scripts to pull values from Unicode documents as part of the TEI build process to validate @name and @value. This is the current mechanism: <charProp> <localName>daikanwa</localName> <value>36</value> </charProp> And this would be the new one: <char> ... <localName property="daikanawa" value="36" /> ... </char> And here a <unihanProp> example: <char> ... <unihanProp property="kRSUnicode" value="r1"/> ... </charProp> Please let us know what you think of our proposal soon. As soon as we give Duncan the green light, he will work on the implementation. Just for clarification: this will not go into the January release. Best wishes, Martina

1 0

GitHub & CI server questions
by Syd Bauman 07 Jan '19

07 Jan '19

1) Is there a continuous integration server (Jenkins or otherwise) that has picked up the new sydb-radd Stylesheets branch and is building with it? 2) Anyone know what the little orange dot or red X after a commit is on GitHub? Here [1] is a small (thus low quality) screenshot of [2], which no longer has the orange dot, that shows what I'm asking about. I'm mildly suspicious that these might be related questions. [1] https://bauman.zapto.org/~syd/temp/4TEICouncil/screenshot_for_GitHub_questi… [2] https://github.com/TEIC/Stylesheets/commits/sydb-radd/odds/odd2odd.xsl

2 2

<specGrpRef> processing
by Syd Bauman 07 Jan '19

07 Jan '19

I don't get it. Can someone explain to me what the template for <specGrpRef> in odds/odd2odd.xsl is doing around line 489 (dev branch)? It looks like the structure is: <choose> <when test="LOCAL POINTER"> <apply-templates select="CHILDREN OF THAT WHICH IS POINTED TO"/> </when> <otherwise> <for-each select="THAT WHICH IS POINTED TO">  <choose> <when test="child::specGrp"> ???? <apply-templates select="child::specGrp/child::*"/> </when> <otherwise> <apply-templates select="child::*"/> </otherwise> </choose> </for-each> </otherwise> <choose> I find this bizarre, but I may be missing something here. A specGrpRef/@target is supposed to point to a <specGrp>. A <specGrp>, of course, can contain children <specGrp>s (not that any of ours do that). So it looks to me like ... ... given the following somewhere in file A.xml <specGrp xml:id="sciencyStuff"> <elementRef key="measureGrp"/> <elementRef key="measure"/> <specGrp xml:id="detailedScienceStuff"> <elementRef key="unit"/> <elementRef key="num"/> </specGrp> </specGrp> ... and the following in file B.xml <specGrpRef target="A.xml#sciencyStuff"/> then odd2odd.xsl will only process 'unit' and 'num', not 'measureGrp' and 'measure', for which I can see absolutely no reason. Am I going nuts, here? Was there a period in ODD history when a <specGrpRef> would point to the *parent* of the desired <specGrp>, not to the <specGrp> itself?

1 0

Re: [Tei-council] Stylesheets: rub out tei: prefix?
by James Cummings 04 Jan '19

04 Jan '19

Hi all, I simultaneously agree that explicitness is good and tend to use xpath-default-namespace all the time myself. I also remember learning from Sebastian that you *always* check namespaces first when something goes wrong. ;-) But since ODDs are always written in TEI (even non-TEI ODDs), it makes sense to me to use default namespace for TEI. I'd vote 4. Many thanks, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Tei-council <tei-council-bounces(a)lists.tei-c.org> on behalf of Lou Burnard <lou(a)OX.AC.UK> Sent: 04 January 2019 15:07:27 To: Raffaele Viglianti; Elisa Beshero-Bondar Cc: Peter Stadler; Lou Burnard; TEI Council; Martin Holmes Subject: Re: [Tei-council] Stylesheets: rub out tei: prefix? FWIW, I agree with Raffaele and Peter in preferring the explicitness and clarity of a prefix. Sebastian always used to say that whenever a stylesheet didn't behave as expected, it was a namespace problem. But if Syd is producing a new version, clearly he has the right to make whatever cosmetic changes he is more comfortable with. Might be a good idea to keep the old version around for a while though, just to check nothing has been broken by such changes, if I may state the obvious. On 04/01/2019 11:44, Raffaele Viglianti wrote: I always use prefixes. I think it helps with clarity and feels more rigorous/consistent. So my preference would be 5. Raff On Fri, Jan 4, 2019, 5:09 AM Elisa Beshero-Bondar <ebbondar(a)gmail.com<mailto:ebbondar@gmail.com> wrote: By the way, I think there’s a way to do it in pure Schematron, but I am not sure (have to check) if it can be done in the ODD context. If I remember right for pure Schematron at least, the question is whether you have to set the prefix on the Schematron elements or the TEI ones. Elisa Sent from my iPhone > On Jan 4, 2019, at 5:05 AM, Elisa Beshero-Bondar <ebbondar(a)gmail.com<mailto:ebbondar@gmail.com>> wrote: > > Having worked with setting default namespaces rather a lot in various contexts (XSLT, XQuery, Schematron, I vote enthusiastically for 1). This really just amounts to a change that reduces verbosity, as Syd indicates, but also reflects the default centrality of the TEI in the Stylesheets anyway. And it is a pain to have to remember the default prefix all the time when we gave to edit. > > Elisa > > Sent from my iPhone > >> On Jan 4, 2019, at 3:54 AM, Peter Stadler <pstadler(a)mail.uni-paderborn.de<mailto:pstadler@mail.uni-paderborn.de>> wrote: >> >> I honestly prefer the verbosity of 5) — and I don’t think these XPath expressions can be significantly simplified nor compressed by removing those namespace prefixes. >> But just to make double sure: This is just a (proposed) cosmetic change due to your personal preference, right? This wouldn’t be bad thing, though, and I think you deserve to do it your way since you are the ODD one :) >> >> Cheers >> Peter >> >>> Am 04.01.2019 um 02:18 schrieb Syd Bauman <s.bauman(a)northeastern.edu<mailto:s.bauman@northeastern.edu>>: >>> >>> The current odd2odd.xsl (like most of the stylesheets) uses the >>> explicitly bound namespace prefix "tei:" in XPaths. I am inclined to >>> use @xpath-default-namespace and get rid of them. I think our XPaths >>> are often already long enough to wrap around even a wide screen >>> twice, and things like "ancestor::tei:teiHeader" are just harder to >>> read. >>> >>> Please vote (fast): >>> 1) I very much want to get rid of the "tei:" prefix in XPaths >>> 2) I prefer to get rid of them, but don't care much >>> 3) Makes no difference to me, mate >>> 4) I prefer to keep them, but don't care much >>> 5) I very much want to keep the "tei: prefix in XPaths >>> >>> In case you're curious, there are approximately >>> 517 tei: >>> 38 rng: >>> 15 xs: >>> 5 a: >>> 4 xml: >>> 2 sch: >>> prefixes in odd2odd.xsl. (Looking only in attr values.) >>> _______________________________________________ >>> Tei-council mailing list >>> Tei-council(a)lists.tei-c.org<mailto:Tei-council@lists.tei-c.org> >>> http://lists.lists.tei-c.org/mailman/listinfo/tei-council >> >> _______________________________________________ >> Tei-council mailing list >> Tei-council(a)lists.tei-c.org<mailto:Tei-council@lists.tei-c.org> >> http://lists.lists.tei-c.org/mailman/listinfo/tei-council _______________________________________________ Tei-council mailing list Tei-council(a)lists.tei-c.org<mailto:Tei-council@lists.tei-c.org> http://lists.lists.tei-c.org/mailman/listinfo/tei-council

5 6

Stylesheets: rub out tei: prefix?
by Syd Bauman 04 Jan '19

04 Jan '19

The current odd2odd.xsl (like most of the stylesheets) uses the explicitly bound namespace prefix "tei:" in XPaths. I am inclined to use @xpath-default-namespace and get rid of them. I think our XPaths are often already long enough to wrap around even a wide screen twice, and things like "ancestor::tei:teiHeader" are just harder to read. Please vote (fast): 1) I very much want to get rid of the "tei:" prefix in XPaths 2) I prefer to get rid of them, but don't care much 3) Makes no difference to me, mate 4) I prefer to keep them, but don't care much 5) I very much want to keep the "tei: prefix in XPaths In case you're curious, there are approximately 517 tei: 38 rng: 15 xs: 5 a: 4 xml: 2 sch: prefixes in odd2odd.xsl. (Looking only in attr values.)

6 6

Release timeline
by Scholger, Martina (martina.scholger＠uni-graz.at) 03 Jan '19

03 Jan '19

Dear Council, I hope you had some relaxing holidays and I wish you a happy new year! Thankfully, Elli and Hugh agreed to postpone the release date to January 29. This will give us a bit more time to finish some open issues. This is our suggested timeline: Refridge: Jan 17 (Thursday) - no major changes to the schema should be done after that; minor changes (wording, typos, examples, etc.) are fine. Freeze: Jan 23 (Wednesday) - no more changes can be done in the dev branch Create release branch: Jan 24 (Thursday) - after that, only minor changes (typos) can be done in the release branch Release: Jan 29 (Tuesday) I added the dates to the Google calendar. Our next Council call is between refridge and freeze, on January 18. Best wishes, Martina

1 0

starting rub-a-dub-dub
by Syd Bauman 03 Jan '19

03 Jan '19

Exactly 1 year to the day after abandoning the project, I am restarting it. Yay! New branch for this work will be called sydb-radd. First question: is there any difference between the 'master' and 'release-3.4.0' branches of TEI? Any significant difference? And, perhaps more importantly, how would I go about asking `git` that question? (Why, you ask? Because in order to test the Stylesheets they need to be building against some version of TEI P5. I'd like to use a local version so I don't have to wait the extra second or so it takes to download it every time I test the Stylesheets. Besides, it would be nice to know definitively which version I am testing against.)

1 0

Re: [Tei-council] rub-a-dub revisited
by James Cummings 30 Dec '18

30 Dec '18

With apologies to Syd, I've only got around to reading this now. It seems a good description to me. I'd add that before he stopped working on the Stylesheets Sebastian did recognise that although he'd moved it to be XSLT2 technically much of the way it worked was still with XSLT1 constructs. The one I discussed most with him was the interminable call-templates constructions that could be simplified significantly with functions. (And even where the same depths of constructs, it would be clearer.) Many thanks for all your hard work, James -- Dr James Cummings, James.Cummings(a)newcastle.ac.uk Senior Lecturer in Late-Medieval Literature and Digital Humanities School of English, Newcastle University ________________________________ From: Tei-council <tei-council-bounces(a)lists.tei-c.org> on behalf of Syd Bauman <s.bauman(a)northeastern.edu> Sent: 24 December 2018 17:17:42 To: TEI Council Cc: Lou Burnard; Martin Holmes Subject: [Tei-council] rub-a-dub revisited Vanessa, and everyone -- I was tasked with writing up an explanation of the rub-a-dub revisited project, primarily for Vanessa, but for all, really. So here goes. background ---------- [Note -- this is intended to be a "get your head around this issue" sort of history, not a detailed highly accurate accounting. Lou and James probably know a lot more about the early history than I.] The TEI Consortium, through the TEI Council, maintains a set of stylesheets called (unimaginatively) "the stylesheets" or (not much better) "the TEI stylesheets". They were originally started (back in early 2000s?), I think, as two separate projects. The first was to have a workflow with which the TEI Guidelines, written in TEI/ODD, could be converted to HTML and print (PDF), and later ePUB, etc. The second was to provide a stylesheet for producing some semblance of readable output (HTML or PDF) from TEI Lite. It quickly became clear that these two projects had a *lot* in common, and so they were merged. And, in fact, the code base for TEI P4 and TEI P5 also had a lot in common, and they were merged, too. (We no longer support P4, though.) The main, almost sole, programmer behind this effort was the amazing Sebastian Rahtz. Sebastian was a brilliant, talented, and frighteningly fast XSLT programmer. An archaeologist by training, and an expert in the TeX and LaTeX typesetting systems, Sebastian never had any formal training in CS, at least none he would confess to me. Sebastian did not believe in internal documentation (e.g., comments) and did not care about indentation or consistency of namespace prefixes (the latter two, I suspect, because he was so brilliant he parsed XML on the fly in his head :-). He wrote these stylesheets over many years, adding features (often only a few hours after a request was made) in a somewhat willy-nilly fashion. Oh, and he started this project in XSLT1, converting to XSLT2 years later. situation --------- Due to brain cancer Sebastian stopped contributing to the stylesheets in late 2015 and died in early 2016. So now we (the Council) are left with a wonderfully powerful, modularized, parameterized, flexible set of stylesheets that are ridiculously difficult to maintain. Roughly 6 months after the gut-wrenching loss of our dear friend and colleague, the TEI Council established a group of interested parties to co-operatively educate ourselves as to how these stylesheets worked. All of TEI Council plus anyone who had ever contributed to the Stylesheets repo was invited. This group (chaired by me) has evolved from a self-education group to a Stylesheets-fixing group over time. The only people still on it are Martin Holmes, Lou Burnard, and various members of Council. One of the first things this group did was map out how the Stylesheets actually work. Some of that knowledge is represented in https://wiki.tei-c.org/index.php/Mapping_ODD_processing. desires ------- Martin and I have a (somewhat aspirational, but somewhat realistic) plan to re-write the ODD portion of the Stylesheets from scratch. That is, we would like to write a completely new code base (in XSLT 3.0) for processing the source of P5 into the P5 outputs (in PDF via XSLFO, as opposed to via LaTeX; HTML5; ePUB; etc.), and for processing customization ODDs into schemas and documentation. We do not want to rewrite the rest of the Stylesheets, i.e. those parts that transform generic TEI Lite into useful output, and do various other conversions. (These same stylesheets are the backbone of OxGarage.) However, that would take a long time, and in the meantime we still have a nearly unmaintainable mess. cleaning up -------- -- I have often been frustrated reading Sebastian's code. I am not nearly as brilliant as he was, so I like having helpful comments along the way, proper indentation, some consistent method of variable and function names, etc. I also find long-winded XSLT 1.0 constructs where a short bit of XSLT 2.0 can do the same thing quite frustrating. So every time I dive into the stylesheets, I think "this really has to be cleaned up". But usually I don't want to do any actual cleaning, in order to keep the delta between the code base before and after whatever fix I am applying as small as possible, to make it easier to double-check that it hasn't introduced new errors. There are some people a lot smarter than I who say that it is always better to clean up a code base than re-write it from scratch. One of them wrote a lovely blog post about it. See https://www.joelonsoftware.com/2002/01/23/rub-a-dub-dub/ While I am sure there are computer scientists who disagree, it is a quite compelling article. rub-a-dub 1 --------- - So I convinced Martin that we should take a crack at cleaning the Stylesheets first (it wasn't hard). I then convinced Council of the same thing (not much harder). In late 2017 Council explicitly charged me with performing a clean up operation (called "rub a dub" or "rub a dub dub" based on what Joel called it in his blog) on a single, large, part of the Stylesheets: the odd2odd program. I spent my winter break exactly a year ago working my tail off for hours on end cleaning up code in ways that should not change the output. Pretty much every time I saved the file, I kicked off a test process to make sure the output came out the same. And it did! Every time. It wasn't until I was well over halfway through rubbing and dubbing that I discovered that, due to a misunderstanding between me & Martin (no blame on Martin, I just mistook what he said), the test procedure I was using was not actually testing odd2odd! I had been comparing the wrong output files, so of course they were the same every time. Sigh. In fact, while I blissfully thought I was doing such a great job, I had in fact mucked up the output almost beyond recognition. Sigh. rub-a-dub 2 --------- - So Martin and I redoubled our efforts on getting ODD testing in the Test2 system to work properly, and are almost finished with that. (Martin presented the Test2 system at our last Stylesheets group meeting.) Once that is done (my current goal is before I leave for a conference in Texas on Wed 09 Jan), I will attack rub-a-dub of odd2odd again, probably shortly after I get back from Texas. The over-arching goal will be to end up with a version of odd2odd that does the same thing, but is *much* easier to maintain. Some of the ancillary files (like common_functions) will likely need to be changed somewhat, too. By "the same thing" I mean "have essentially the same XML tree as output". I don't care about the incidentals of serialization, and may well sprinkle the output with comments if it seems to help. The point is I intend to try to explicitly avoid "improving" the processor as I go along. The detailed tasks I expect to work on to make it more maintainable are somewhat flexible, likely to change as I go along. But the following are the kinds of things I mean: * Reasonable indentation * Adding internal documentation * Re-factoring XSLT 1.0 constructs into XSLT 2.0 * Collapsing equivalent functions, modes, and templates where appropriate. (There are several cases where the Stylesheets have 2 or even 3 versions of what appear to be almost the same function, mode, or template.) * Changing names of functions, modes, templates, and variables in order to approach consistency * Re-factor logic to avoid double negatives where reasonable This, of course, will all be carried out in a separate branch, so as not to interfere with normal bug-fixing and the late Jan release. _______________________________________________ Tei-council mailing list Tei-council(a)lists.tei-c.org http://lists.lists.tei-c.org/mailman/listinfo/tei-council

1 0

rub-a-dub revisited
by Syd Bauman 24 Dec '18

24 Dec '18

Vanessa, and everyone -- I was tasked with writing up an explanation of the rub-a-dub revisited project, primarily for Vanessa, but for all, really. So here goes. background ---------- [Note -- this is intended to be a "get your head around this issue" sort of history, not a detailed highly accurate accounting. Lou and James probably know a lot more about the early history than I.] The TEI Consortium, through the TEI Council, maintains a set of stylesheets called (unimaginatively) "the stylesheets" or (not much better) "the TEI stylesheets". They were originally started (back in early 2000s?), I think, as two separate projects. The first was to have a workflow with which the TEI Guidelines, written in TEI/ODD, could be converted to HTML and print (PDF), and later ePUB, etc. The second was to provide a stylesheet for producing some semblance of readable output (HTML or PDF) from TEI Lite. It quickly became clear that these two projects had a *lot* in common, and so they were merged. And, in fact, the code base for TEI P4 and TEI P5 also had a lot in common, and they were merged, too. (We no longer support P4, though.) The main, almost sole, programmer behind this effort was the amazing Sebastian Rahtz. Sebastian was a brilliant, talented, and frighteningly fast XSLT programmer. An archaeologist by training, and an expert in the TeX and LaTeX typesetting systems, Sebastian never had any formal training in CS, at least none he would confess to me. Sebastian did not believe in internal documentation (e.g., comments) and did not care about indentation or consistency of namespace prefixes (the latter two, I suspect, because he was so brilliant he parsed XML on the fly in his head :-). He wrote these stylesheets over many years, adding features (often only a few hours after a request was made) in a somewhat willy-nilly fashion. Oh, and he started this project in XSLT1, converting to XSLT2 years later. situation --------- Due to brain cancer Sebastian stopped contributing to the stylesheets in late 2015 and died in early 2016. So now we (the Council) are left with a wonderfully powerful, modularized, parameterized, flexible set of stylesheets that are ridiculously difficult to maintain. Roughly 6 months after the gut-wrenching loss of our dear friend and colleague, the TEI Council established a group of interested parties to co-operatively educate ourselves as to how these stylesheets worked. All of TEI Council plus anyone who had ever contributed to the Stylesheets repo was invited. This group (chaired by me) has evolved from a self-education group to a Stylesheets-fixing group over time. The only people still on it are Martin Holmes, Lou Burnard, and various members of Council. One of the first things this group did was map out how the Stylesheets actually work. Some of that knowledge is represented in https://wiki.tei-c.org/index.php/Mapping_ODD_processing. desires ------- Martin and I have a (somewhat aspirational, but somewhat realistic) plan to re-write the ODD portion of the Stylesheets from scratch. That is, we would like to write a completely new code base (in XSLT 3.0) for processing the source of P5 into the P5 outputs (in PDF via XSLFO, as opposed to via LaTeX; HTML5; ePUB; etc.), and for processing customization ODDs into schemas and documentation. We do not want to rewrite the rest of the Stylesheets, i.e. those parts that transform generic TEI Lite into useful output, and do various other conversions. (These same stylesheets are the backbone of OxGarage.) However, that would take a long time, and in the meantime we still have a nearly unmaintainable mess. cleaning up -------- -- I have often been frustrated reading Sebastian's code. I am not nearly as brilliant as he was, so I like having helpful comments along the way, proper indentation, some consistent method of variable and function names, etc. I also find long-winded XSLT 1.0 constructs where a short bit of XSLT 2.0 can do the same thing quite frustrating. So every time I dive into the stylesheets, I think "this really has to be cleaned up". But usually I don't want to do any actual cleaning, in order to keep the delta between the code base before and after whatever fix I am applying as small as possible, to make it easier to double-check that it hasn't introduced new errors. There are some people a lot smarter than I who say that it is always better to clean up a code base than re-write it from scratch. One of them wrote a lovely blog post about it. See https://www.joelonsoftware.com/2002/01/23/rub-a-dub-dub/ While I am sure there are computer scientists who disagree, it is a quite compelling article. rub-a-dub 1 --------- - So I convinced Martin that we should take a crack at cleaning the Stylesheets first (it wasn't hard). I then convinced Council of the same thing (not much harder). In late 2017 Council explicitly charged me with performing a clean up operation (called "rub a dub" or "rub a dub dub" based on what Joel called it in his blog) on a single, large, part of the Stylesheets: the odd2odd program. I spent my winter break exactly a year ago working my tail off for hours on end cleaning up code in ways that should not change the output. Pretty much every time I saved the file, I kicked off a test process to make sure the output came out the same. And it did! Every time. It wasn't until I was well over halfway through rubbing and dubbing that I discovered that, due to a misunderstanding between me & Martin (no blame on Martin, I just mistook what he said), the test procedure I was using was not actually testing odd2odd! I had been comparing the wrong output files, so of course they were the same every time. Sigh. In fact, while I blissfully thought I was doing such a great job, I had in fact mucked up the output almost beyond recognition. Sigh. rub-a-dub 2 --------- - So Martin and I redoubled our efforts on getting ODD testing in the Test2 system to work properly, and are almost finished with that. (Martin presented the Test2 system at our last Stylesheets group meeting.) Once that is done (my current goal is before I leave for a conference in Texas on Wed 09 Jan), I will attack rub-a-dub of odd2odd again, probably shortly after I get back from Texas. The over-arching goal will be to end up with a version of odd2odd that does the same thing, but is *much* easier to maintain. Some of the ancillary files (like common_functions) will likely need to be changed somewhat, too. By "the same thing" I mean "have essentially the same XML tree as output". I don't care about the incidentals of serialization, and may well sprinkle the output with comments if it seems to help. The point is I intend to try to explicitly avoid "improving" the processor as I go along. The detailed tasks I expect to work on to make it more maintainable are somewhat flexible, likely to change as I go along. But the following are the kinds of things I mean: * Reasonable indentation * Adding internal documentation * Re-factoring XSLT 1.0 constructs into XSLT 2.0 * Collapsing equivalent functions, modes, and templates where appropriate. (There are several cases where the Stylesheets have 2 or even 3 versions of what appear to be almost the same function, mode, or template.) * Changing names of functions, modes, templates, and variables in order to approach consistency * Re-factor logic to avoid double negatives where reasonable This, of course, will all be carried out in a separate branch, so as not to interfere with normal bug-fixing and the late Jan release.

1 0