Hi All, Martina, Syd and I met this morning and made changes to the Oxygen plugin build to account for jar file changes in the latest Oxygen release. That seems to have worked, in that the bleeding-edge plugin built successfully on Jenkins, we were able to install it on both Oxygen 24.1 and 25, and it mostly works. The build of the stable plugin, which I ran manually on my Jenkins server, also seems to have been successful, but we haven't tested that. I say mostly because we found two different issues which are not directly related to the plugin, and which were broken in previous versions of it. One is that the ODD-to-PDF build fails with an out-of-memory error when transforming tei_all. It's possible that the Oxygen folks have kept it working in their version of the framework by adding additional memory to the transformation, but I can't see how they're doing that, if they are. Anyway, the same transformation works OK for tei_lite.odd, so I don't think this is a major issue. A more serious problem is that the epub transformation fails because a handful of CSS files are in the wrong place relative to how the transformation runs. If you look at the Makefile in the Stylesheets, you can see that it copies CSS files to a second location where the transformation is expecting to find them (a line added to the file by Sebastian in 2014). However, the framework/plugin does not use the Makefile, so that step never happens, and the build fails. The Oxygen folks have fixed this in their version of the framework by patching our XSLT to point to the files where they actually are. That seems sensible to me, and I think what we actually have is a bug in the Stylesheets, where relative paths are used to point to things and not resolved against a solid location, so running the same transformation in different ways expects to find the same files in two different places. The Makefile solution of making copies of them seems a bit like a hack to me. If you are subscribed to the bleeding-edge plugin, you should get updates, and if you make use of it over the next few days and have any problems, do raise an issue on the oxygen-tei repo. I think it would be prudent to fix the Stylesheets bug before the next TEI / Stylesheets release, because a new "stable" version of the plugin will be released at that time, but the bug has been there for a while so it's not crucial. Cheers, Martin -- ------------------------------------------ Martin Holmes UVic Humanities Computing and Media Centre I acknowledge and respect the lək̓ʷəŋən peoples on whose traditional territory the university stands and the Songhees, Esquimalt and WSÁNEĆ peoples whose historical relationships with the land continue to this day.
Hi Martin and Council, first, many, many thanks for taking care of the Oxygen plugin! Not only this time, but the git history reveals that you’re the main contributor and maintainer of the oxygen plugin for several years now (I’d say at least since 2015!) I wanted to put this out here to a) give credit where credit is due and b) to emphasize the structural dilemma we (the TEI community) are facing – a lot of services, tools, and infrastructure with a Hugh bus factor. I really don’t know what to do with this, but maybe someone on Council has an idea or an interest in diving into the oxygen plugin? Regarding your second Stylesheets issue: I think this is a known bug and documented at https://github.com/TEIC/Stylesheets/issues/555 https://github.com/TEIC/Stylesheets/issues/555. In addition to this, at the Stylesheets Group meeting on 2022-08-26 we even discussed deprecating epub(2) completely in favor of epub3: https://github.com/TEIC/Stylesheets/issues/576 https://github.com/TEIC/Stylesheets/issues/576 The epub3 transformation had this CSS issue as well but it was hacked around in https://github.com/TEIC/Stylesheets/issues/312 https://github.com/TEIC/Stylesheets/issues/312; and https://github.com/TEIC/Stylesheets/pull/394 https://github.com/TEIC/Stylesheets/pull/394 in particular. I think the underlying problem is the copying around of CSS files – as you said – in the Makefile. Yet, I’m a bit hesitant to change this because this will alter our release archive and finally the URLs of the released versions (because the structure of https://tei-c.org/Vault/Stylesheets/current/xml/tei/stylesheet/ https://tei-c.org/Vault/Stylesheets/current/xml/tei/stylesheet/ is different than https://github.com/TEIC/Stylesheets/tree/released https://github.com/TEIC/Stylesheets/tree/released and has been of years – so people and software rely on it) My proposal would be to not do anything for this release (because it’s too late for breaking changes) but strive for the deprecation of epub in favor of epub3 (for the next release). We would need to get in touch with the oxygen people to let them know about it (so they can switch their transformation as well). Best Peter
Am 21.10.2022 um 20:20 schrieb Martin Holmes
: Hi All,
Martina, Syd and I met this morning and made changes to the Oxygen plugin build to account for jar file changes in the latest Oxygen release. That seems to have worked, in that the bleeding-edge plugin built successfully on Jenkins, we were able to install it on both Oxygen 24.1 and 25, and it mostly works. The build of the stable plugin, which I ran manually on my Jenkins server, also seems to have been successful, but we haven't tested that.
I say mostly because we found two different issues which are not directly related to the plugin, and which were broken in previous versions of it.
One is that the ODD-to-PDF build fails with an out-of-memory error when transforming tei_all. It's possible that the Oxygen folks have kept it working in their version of the framework by adding additional memory to the transformation, but I can't see how they're doing that, if they are. Anyway, the same transformation works OK for tei_lite.odd, so I don't think this is a major issue.
A more serious problem is that the epub transformation fails because a handful of CSS files are in the wrong place relative to how the transformation runs. If you look at the Makefile in the Stylesheets, you can see that it copies CSS files to a second location where the transformation is expecting to find them (a line added to the file by Sebastian in 2014). However, the framework/plugin does not use the Makefile, so that step never happens, and the build fails. The Oxygen folks have fixed this in their version of the framework by patching our XSLT to point to the files where they actually are. That seems sensible to me, and I think what we actually have is a bug in the Stylesheets, where relative paths are used to point to things and not resolved against a solid location, so running the same transformation in different ways expects to find the same files in two different places. The Makefile solution of making copies of them seems a bit like a hack to me.
If you are subscribed to the bleeding-edge plugin, you should get updates, and if you make use of it over the next few days and have any problems, do raise an issue on the oxygen-tei repo.
I think it would be prudent to fix the Stylesheets bug before the next TEI / Stylesheets release, because a new "stable" version of the plugin will be released at that time, but the bug has been there for a while so it's not crucial.
Cheers, Martin
-- ------------------------------------------ Martin Holmes UVic Humanities Computing and Media Centre
I acknowledge and respect the lək̓ʷəŋən peoples on whose traditional territory the university stands and the Songhees, Esquimalt and WSÁNEĆ peoples whose historical relationships with the land continue to this day. _______________________________________________ Tei-council mailing list Tei-council@lists.tei-c.org http://lists.lists.tei-c.org/mailman/listinfo/tei-council
Hi Peter, This sounds like the right approach. I think if we can get rid of that instruction to copy CSS files to other folders in the same tree, life would be simpler, but I bet that there are other processes that also expect to find them in the copied-to location, and we just haven't detected problems with those transformations because nobody uses them. I added a comment on the Stylesheets ticket. One thing that puzzles me is why Oxygen's version of the TEI plugin is not on GitHub in their collection of regular repositories: https://github.com/orgs/oxygenxml/repositories If it were, we could be watching it for changes and respond in a more timely way. The "Hugh bus factor" (lovely phrase) is very worrying. I would be very glad to have someone else at least shadowing me on the Oxygen plugin repo, and preferably taking over at some point. Cheers, Martin On 2022-10-24 00:36, Peter Stadler wrote:
Hi Martin and Council,
first, many, many thanks for taking care of the Oxygen plugin! Not only this time, but the git history reveals that you’re the main contributor and maintainer of the oxygen plugin for several years now (I’d say at least since 2015!) I wanted to put this out here to a) give credit where credit is due and b) to emphasize the structural dilemma we (the TEI community) are facing – a lot of services, tools, and infrastructure with a Hugh bus factor. I really don’t know what to do with this, but maybe someone on Council has an idea or an interest in diving into the oxygen plugin?
Regarding your second Stylesheets issue: I think this is a known bug and documented at https://github.com/TEIC/Stylesheets/issues/555 https://github.com/TEIC/Stylesheets/issues/555. In addition to this, at the Stylesheets Group meeting on 2022-08-26 we even discussed deprecating epub(2) completely in favor of epub3: https://github.com/TEIC/Stylesheets/issues/576 https://github.com/TEIC/Stylesheets/issues/576 The epub3 transformation had this CSS issue as well but it was hacked around in https://github.com/TEIC/Stylesheets/issues/312 https://github.com/TEIC/Stylesheets/issues/312; and https://github.com/TEIC/Stylesheets/pull/394 https://github.com/TEIC/Stylesheets/pull/394 in particular. I think the underlying problem is the copying around of CSS files – as you said – in the Makefile. Yet, I’m a bit hesitant to change this because this will alter our release archive and finally the URLs of the released versions (because the structure of https://tei-c.org/Vault/Stylesheets/current/xml/tei/stylesheet/ https://tei-c.org/Vault/Stylesheets/current/xml/tei/stylesheet/ is different than https://github.com/TEIC/Stylesheets/tree/released https://github.com/TEIC/Stylesheets/tree/released and has been of years – so people and software rely on it)
My proposal would be to not do anything for this release (because it’s too late for breaking changes) but strive for the deprecation of epub in favor of epub3 (for the next release). We would need to get in touch with the oxygen people to let them know about it (so they can switch their transformation as well).
Best Peter
Am 21.10.2022 um 20:20 schrieb Martin Holmes
mailto:mholmes@uvic.ca>: Hi All,
Martina, Syd and I met this morning and made changes to the Oxygen plugin build to account for jar file changes in the latest Oxygen release. That seems to have worked, in that the bleeding-edge plugin built successfully on Jenkins, we were able to install it on both Oxygen 24.1 and 25, and it mostly works. The build of the stable plugin, which I ran manually on my Jenkins server, also seems to have been successful, but we haven't tested that.
I say mostly because we found two different issues which are not directly related to the plugin, and which were broken in previous versions of it.
One is that the ODD-to-PDF build fails with an out-of-memory error when transforming tei_all. It's possible that the Oxygen folks have kept it working in their version of the framework by adding additional memory to the transformation, but I can't see how they're doing that, if they are. Anyway, the same transformation works OK for tei_lite.odd, so I don't think this is a major issue.
A more serious problem is that the epub transformation fails because a handful of CSS files are in the wrong place relative to how the transformation runs. If you look at the Makefile in the Stylesheets, you can see that it copies CSS files to a second location where the transformation is expecting to find them (a line added to the file by Sebastian in 2014). However, the framework/plugin does not use the Makefile, so that step never happens, and the build fails. The Oxygen folks have fixed this in their version of the framework by patching our XSLT to point to the files where they actually are. That seems sensible to me, and I think what we actually have is a bug in the Stylesheets, where relative paths are used to point to things and not resolved against a solid location, so running the same transformation in different ways expects to find the same files in two different places. The Makefile solution of making copies of them seems a bit like a hack to me.
If you are subscribed to the bleeding-edge plugin, you should get updates, and if you make use of it over the next few days and have any problems, do raise an issue on the oxygen-tei repo.
I think it would be prudent to fix the Stylesheets bug before the next TEI / Stylesheets release, because a new "stable" version of the plugin will be released at that time, but the bug has been there for a while so it's not crucial.
Cheers, Martin
-- ------------------------------------------ Martin Holmes UVic Humanities Computing and Media Centre
I acknowledge and respect the lək̓ʷəŋən peoples on whose traditional territory the university stands and the Songhees, Esquimalt and WSÁNEĆ peoples whose historical relationships with the land continue to this day. _______________________________________________ Tei-council mailing list Tei-council@lists.tei-c.org mailto:Tei-council@lists.tei-c.org http://lists.lists.tei-c.org/mailman/listinfo/tei-council
-- ------------------------------------------ Martin Holmes UVic Humanities Computing and Media Centre I acknowledge and respect the lək̓ʷəŋən peoples on whose traditional territory the university stands and the Songhees, Esquimalt and WSÁNEĆ peoples whose historical relationships with the land continue to this day.
participants (2)
-
Martin Holmes
-
Peter Stadler