Bug #3108


Configuration file documentation and schema improvements

Added by Debbie Lockett over 5 years ago. Updated almost 5 years ago.

Start date:
Due date:
% Done:


Estimated time:
Legacy ID:
Applies to branch:
Fix Committed on Branch:
9.7, trunk
Fixed in Maintenance Release:


Opening this bug to record general improvements to do with the configuration file.

While working on two current bugs regarding specific issues with the configuration file documentation and the schema ( and, a number of other minor issues have arisen. This bug will be used to document the various changes made to resolve these.

Actions #1

Updated by Debbie Lockett over 5 years ago

  1. Improve consistency checks between FeatureKeys.xml and configuration file schema config.xsd:

The stylesheet FeatureKeysToSchema.xsl which is used to generate the annotated schema annotatedConfig.xsd includes a check that all attributes defined in the schema are defined in FeatureKeys.xml. Add the converse check: that all features defined in FeatureKeys.xml that should be defined in the schema, are defined there. i.e. Apart from a defined exceptions list of the features which can not be set from a configuration file (e.g. the feature CONFIGURATION_FILE), if some feature defined in FeatureKeys.xml is not defined in the schema, then a warning is produced.

  1. Using the solution to 1, add xslt/@enableAssertions (9.7 and 9.8) and xslt/@resultDocumentThreads (in 9.8, but not 9.7) to schema:

    • update FeatureKeys.xml and config.xsd (9.7 and 9.8)

    • update on 9.8 branch

  2. Other minor corrections in FeatureKeys.xml and AdditionalFeatures.xml for configuration file documentation:

    • e.g. correct xslt/@enableAssertions values info

    • improve some formatting

    • Java class name correction for resources/extensionFunction (IntegratedFunction -> ExtensionFunctionDefinition)

Actions #2

Updated by Debbie Lockett over 5 years ago

  1. Improve build scripts for generating samples download and documentation:

Add touches in documentation/gen-doc target to force update for configuration file documentation.

Add touch in samples-common target to force regeneration of annotatedConfig.xsd.

Actions #3

Updated by Debbie Lockett over 5 years ago

  • Status changed from New to In Progress
  • Fix Committed on Branch 9.7, 9.8 added

All fixes as described above committed on 9.7 (except as noted) and 9.8 branches. Documentation updated online as required.

Actions #4

Updated by Debbie Lockett about 5 years ago

  • Status changed from In Progress to Resolved

Marking this bug as resolved now. Work for 9.7 is complete. Further work for the 9.8 versions is required (to get things up-to-date), but that is development work and will be done in due course (with assistance from the changes made and described above).

There has been one further related change recently: Validation tests for the sample configuration files against the schemas have been added to our samples testing ANT script: see test-cmd-config in the testing-j build file. Added for 9.7 and 9.8.

Actions #5

Updated by O'Neil Delpratt about 5 years ago

  • Status changed from Resolved to Closed
  • % Done changed from 0 to 100
  • Fixed in Maintenance Release added

Bug fix applied in the Saxon maintenance release.

Actions #6

Updated by O'Neil Delpratt almost 5 years ago

  • Fix Committed on Branch trunk added
  • Fix Committed on Branch deleted (9.8)
Actions #7

Updated by O'Neil Delpratt almost 5 years ago

  • Applies to branch deleted (9.8)

Please register to edit this issue

Also available in: Atom PDF