Generate Modular Documentation for Modular Schemas
Posted: Thu Sep 03, 2020 12:59 am
I am working on a family of schemas that share common elements. To reduce duplication, types that are commonly reused are extracted out to a separate schema that can then be included in multiple schemas. One example is a type for US counties, which has a list of over 3000 enumerations. If this schema is included in another, such as one for addresses, then the documentation for that schema will include all 3k enumerations, which makes it much bigger than necessary.
I would like to either not list facets for types that come from an schema that has been imported, or limit the number shown to just a few values for external types. Documentation for the common schema will be published as a separate document, so the information will still be available. I just don't want it duplicated in the documentation for every schema that uses it.
There are a few settings that are close to what I want but still fall short of the desired result:
One is that facets can be excluded from the documentation, but I still want them to be included for types in the schema being documented, just not included for types that have been imported from another schema.
Another setting is whether to include referenced schemas. Unchecking this makes it so that not all of the definitions from any referenced schemas get included, but ones that are referenced are still included. I would want to exclude all definitions from referenced schemas, even if they are referenced.
I also looked at putting the common types in a separate namespace from the dependent schema. There is a setting for generating separate files based on namespace, but it isn't available for PDF documentation, and I would like to generate a PDF.
Is there some combination of settings that would allow me to accomplish this?
I would like to either not list facets for types that come from an schema that has been imported, or limit the number shown to just a few values for external types. Documentation for the common schema will be published as a separate document, so the information will still be available. I just don't want it duplicated in the documentation for every schema that uses it.
There are a few settings that are close to what I want but still fall short of the desired result:
One is that facets can be excluded from the documentation, but I still want them to be included for types in the schema being documented, just not included for types that have been imported from another schema.
Another setting is whether to include referenced schemas. Unchecking this makes it so that not all of the definitions from any referenced schemas get included, but ones that are referenced are still included. I would want to exclude all definitions from referenced schemas, even if they are referenced.
I also looked at putting the common types in a separate namespace from the dependent schema. There is a setting for generating separate files based on namespace, but it isn't available for PDF documentation, and I would like to generate a PDF.
Is there some combination of settings that would allow me to accomplish this?