projectEndings / staticSearch

A codebase to support a pure JSON search engine requiring no backend for any XHTML5 document collection
https://endings.uvic.ca/staticSearch/docs/index.html
Mozilla Public License 2.0
51 stars 22 forks source link

Determine where the schematron rules should live #207

Open joeytakeda opened 2 years ago

joeytakeda commented 2 years ago

It's not clear to me how we should organize the schematron that we want to write, since we have two distinct things (in distinct namespaces) that need to be checked. A few ideas:

  1. The schematron for the configuration file lives in the ODD as <constraintSpec>s in the appropriate places, and we have a separate schematron file (staticSearchCollection.sch) for the HTML documents.
  2. The schematron for the configuration file and the schematron for the document collection both live in the ODD with the document collection checks as a <constraintSpec> as a child of the <schemaSpec>. This would mean that all of the checks would be in the documentation
  3. We do something complicated with multiple <schemaSpec>s in the single ODD—we could, then, conceivably have a full schema for the HTML documents and a schema for the config, both in the documentation.

1 has the advantage of being simplest, but I do think 2 is nice since it'd mean all of the constraints are appropriately documented (and thus any of that documentation would be easily searchable for any release).

martindholmes commented 2 years ago

I like 2 as well. 3 would probably not turn out well. :-)