Implement NIST CAXIF as skin of generic

[opoudjis]

Note: not as a new gem inheriting from generic, but as a pure skin of generic—bundling generic with stylesheets and config. If we can't do that, and require gems for each new deployment of an SDO, we will never get scale.

That means they don't get to have a wishlist: it is a bare bones implementation, as much as can be put in by configuration.

"NIST CAXIF: want a new flavour, to publish EXPRESS docs and non-MDA docs"

This hopefully does not make the skin implementation impossible.

[opoudjis]

@ronaldtse Where is the documentation for this org?

[opoudjis]

Using :customize: attribute to specify a local metanorma.yaml file; directories are being treated as relative to the metanorma-generic gem, rather than relative to the metanorma.yaml specified.

The metanorma.yaml file is the skin, and we can go a fair way just with that. The expectation to migrate more functionality to the config file is longstanding and remains overly optimistic; we can add the ordering of sections in the document, which is now a config in arrays in code.

[opoudjis]

@alexeymorozov I would like for this to be your next project. Please get in touch so I can explain a bit more about this. https://www.metanorma.org/builder/topics/simple-adoption/ gives some necessary background.

[alexeymorozov]

As we discussed with Nick, I've tried the customize: attribute and, at least in some way, it works. Here is an example:

1. adoc file
2. a custom config
3. output doc, html and other files

https://github.com/alexeymorozov/nist-caxif

Now I need styling specifications of CAx-IF or an example of a target document.

[alexeymorozov]

@opoudjis @ronaldtse What are our priorities? Do I need to talk to someone in CAx-IF to gather specifications or more information on the requirements?

[ronaldtse]

The documents are now provided here:

• https://github.com/metanorma/mn-samples-mbxif

I'll get some of the documents encoded for sample purposes:

• Encode documents into Metanorma format mn-samples-mbxif#6

[opoudjis]

As part of making metanorma-generic more adaptable: need to add fontist config and output formats to the YAML. Also PDF stylesheet name. As little as possible needs to be in code.

[opoudjis]

@ronaldtse I see you expect something like this:

https://github.com/metanorma/mn-samples-mbxif/blob/main/reference-docs/ewis-if/EWIS_test_suite_v1-0.pdf

to be delivered by a config-only, zero code instance of metanorma-generic.

That is not a reasonable expectation.

[opoudjis]

I am going to compile the first document I find, just to see what happens, using the ISO HTML and PDF stylesheets for rendering, stored in html/, and a local metanorma-generic configuration file. That's going to be bundle exec metanorma compile sources/cae-if/HandbookVolume2_V1.1_CAE-IF/document.adoc, using :customize: ../../../metanorma-config.yml . That's an initial proof of concept that rendering can be done with local rendering assets at all.

[opoudjis]

Need to deal with resolving paths when compiling in a remote directory: customize: ../../../yml is looking for stylesheets at the document root, not the config file root.

Need to configure supported formats: is refusing to process PDF, because it's not in generic.

[opoudjis]

need to make sure that when I reread the YAML file from :customize: , its default values (including formats) are still processed; they had been ignored on reread anyway.

[opoudjis]

Race condition: metanorma compile is extracting formats, before the document is processed so that :customize: can override the formats.

But in fact, the extensions aren't needed until after we compile the Semantic Metanorma XML. We extract them beforehand, to test if there is an illegal extension, and thus abort. But... generating the Semantic XML even if an illegal extension is included is not that big a deal, and could be used in debugging anyway. So will delay that test until after Semantic XML is generated (and thus, :customize: has already been read in).

[opoudjis]

Metanorma compile cannot see the updates being done to the metanorma-generic processor (including its formats); Metanorma accesses processors through Registry, but metanorma-generic does not.

[opoudjis]

... Need config file path to be absolute, working directory and document directory getting confused.

[opoudjis]

After a very VERY long time, we finally have the ability to compile a metanorma-generic file using local config.