agiorguk / gemini

Resources relating to the UK Gemini metadata profile
5 stars 3 forks source link

2020-15: Schematron documentation omission (Adam Branscomb, Esri UK, April 2020) #5

Open PeterParslow opened 3 years ago

PeterParslow commented 3 years ago

Adam asked about the distinction between the two Schematron rule sets, and this highlighted that there’s nothing in the documentation we provide that describes the difference - except for a one line comment in one of the files.

PeterParslow commented 3 years ago

I have added a couple of bullets to the GitHub page, but we should also put a section in the Schematron technical documentation, and perhaps on the AGI GEMINI web pages.

PeterParslow commented 2 months ago

Related issues:

  1. the link from https://agiorguk.github.io/gemini/1037-uk-gemini-introduction.html labelled "Schematron rules for validating GEMINI records (GitHub link)" goes to the old schematron repository. May as well change it to go directly to: https://github.com/agiorguk/gemini-schematron

which does contain text (in the Readme) that answers this issue.

EXCEPT THAT

  1. the PDF file that (and its editable docx version) seem very dated, explaining in detail how to apply the schematron rules just using XSLT. Given how many XML aware tools have Schematron support built in now, that seems in need of an update.

And also, I suspect that some of the detail in the technical documentation (e.g. examples) doesn't match the current version of the Schematron files.

Finally, the auto-matched PR seems to have nothing to do with this!

So, do we think that the current description of the Readme is sufficient, in which case (if we fix the link to go to the right repository) we can probably close this issue & open a new one about the dated Schematron technical documentation.

archaeogeek commented 1 month ago

@PeterParslow to change link in https://agiorguk.github.io/gemini/1037-uk-gemini-introduction.html to point to new location