Bug #3073: Documentation missing for serialization section of configuration file - Saxon - Saxonica Developer Community

Actions

Send by e-mail Copy link

Bug #3073

closed

Documentation missing for serialization section of configuration file

Added by Michael Kay over 7 years ago. Updated almost 7 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Debbie Lockett

Category:

Documentation

Sprint/Milestone:

Start date:

2016-12-15

Due date:

% Done:

100%

Estimated time:

Legacy ID:

Applies to branch:

9.7

Fix Committed on Branch:

9.7, trunk

Fixed in Maintenance Release:

9.7.0.15

Platforms:

Description

There appears to be no user documentation for the serialization section of the configuration file.

(I've added a skeleton section to configuration.xml but it links to a file featureKeys/ConfigFileDoc-serialization.xml which needs to be generated from the configuration file schema).

Actions

Copy link

Updated by Debbie Lockett over 7 years ago

Status changed from New to In Progress

Documentation for configuration file serialization element attributes extracted from config.xsd schema and added to tools/featureKeys/AdditionalFeatures.xml. This is the master source (along with tools/featureKeys/FeatureKeys.xml) used by ToConfigFileDoc.xsl to generate the documentation pages for the configuration file elements.

I have also added a read.txt to tools/featureKeys, to explain this, and the other transforms to do with feature keys and the configuration file.

Documentation updated online (HTML and XML versions), and on 9.7 archive.

Source updated in tools/featureKeys and userdoc/saxon9/src, on 9.7 and 9.8 branches.

Actions

Copy link

Updated by Debbie Lockett over 7 years ago

Status changed from In Progress to Resolved

Updated the configuration file schemas (config.xsd and annotatedConfig.xsd) with a couple of missing serialization attributes, to match the documentation, on 9.7 and 9.8 branches.

Relatedly, I have also done some reorganisation, to try to eliminate duplication. These configuration file schemas are now just in the samples directory (i.e. removed from tools/featureKeys). Generation of annotatedConfig.xsd in samples-common build updated accordingly (for 9.7 and 9.8).

Actions

Copy link

Updated by Debbie Lockett over 7 years ago

Status changed from Resolved to In Progress

Todo: also add serialisation parameters in the Saxon namespace (see saxon-attributes.xsd) to the documentation for the serialization element.

Actions

Copy link

Updated by Debbie Lockett over 7 years ago

Added "additional attributes" for serialization element in configuration file documentation, with link to 'Saxon extensions'/'Additional serialization parameters' for details.

Committed on 9.7 and 9.8 branches.

Not yet updated online.

Actions

Copy link