Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

makegraphicsanttask needs at least documentation, if not improvement #495

Open
sydb opened this issue Mar 23, 2021 · 3 comments
Open

makegraphicsanttask needs at least documentation, if not improvement #495

sydb opened this issue Mar 23, 2021 · 3 comments
Assignees
Labels
status: Go Council has decided the ticket should proceed.

Comments

@sydb
Copy link
Member

sydb commented Mar 23, 2021

While looking at #477, @dmj’s improved processing of @facs when generating ant copy-the-graphics tasks, a few things occurred to me:

  1. I, for one, had almost no idea what the culprit program (tools/makegraphicsanttask.xsl) is for, who would call it when and why. Reading the code it looks like it reads in a TEI file and writes out an ANT project. But I should not have to read the source … where is this thing documented? (Or at least if I do read the source, the header comment should tell me.)
  2. It (tools/makegraphicsanttask.xsl) only processes @facs attributes that are on <pb> elements. Since I do not know who is calling this program or why, I cannot say whether that is right or wrong, but it is certainly suspicious.
  3. It seems to mess up if an image file is listed as just an absolute path reference, e.g. <pb facs="/tmp/path/to/page2.png"/> (the resulting copy/@file is empty).
  4. It seems to mess up even worse if there is whitespace around an absolute path reference, e.g. <pb facs=" /tmp/path/to/page4.png"/>.
  5. It does not seem to handle multiple values.
@sydb sydb changed the title makegraphicsaznttask needs at least documentation, if not improvement makegraphicsanttask needs at least documentation, if not improvement Mar 23, 2021
@JanelleJenstad JanelleJenstad added status: invalid Not actually a bug; or perhaps an enhancement that most people wouldn't want resp: StylesheetsGroup Issue is suitable for the group-learning approach taken in the Stylesheets Coop Working Group. status: Go Council has decided the ticket should proceed. and removed resp: StylesheetsGroup Issue is suitable for the group-learning approach taken in the Stylesheets Coop Working Group. status: invalid Not actually a bug; or perhaps an enhancement that most people wouldn't want labels Apr 20, 2021
@JanelleJenstad
Copy link
Contributor

This is set to status: Go to figure out what this program is for and who calls it. Until we know what it's for, we can't fix it. @MegJBrown Pls discuss with @sydb at your next standing mtg.

@martindholmes
Copy link
Contributor

The process is called twice from teianttasks.xml, once from buildodt and once from builddocx.

peterstadler added a commit that referenced this issue Dec 2, 2021
Stylesheets group looked at #495 and changed two little things
* reorder attributes to make it more readable (source->target)
* use `$F` instead of `@url`: this addresses the issue with the broken absolute path references for `@facs` attributes

Co-Authored-By: Syd Bauman <sydb@users.noreply.github.com>
Co-Authored-By: Elisa Beshero-Bondar <ebeshero@users.noreply.github.com>
Co-Authored-By: Martina Scholger <martina.scholger@uni-graz.at>
Co-Authored-By: MegJBrown <8483387+MegJBrown@users.noreply.github.com>
Co-Authored-By: Raffaele Viglianti <144770+raffazizzi@users.noreply.github.com>
Co-Authored-By: Hugh A. Cayless <philomousos@gmail.com>
@martinascholger
Copy link
Member

It seems that at least the documentation is missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: Go Council has decided the ticket should proceed.
Projects
None yet
Development

No branches or pull requests

5 participants