Project

Profile

Help

Bug #3073

closed

Documentation missing for serialization section of configuration file

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

Status:
Closed
Priority:
Normal
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:
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 #1

Updated by Debbie Lockett over 5 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 #2

Updated by Debbie Lockett over 5 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 #3

Updated by Debbie Lockett over 5 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 #4

Updated by Debbie Lockett over 5 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 #5

Updated by Debbie Lockett over 5 years ago

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

9.7 documentation online now updated (XML and HTML versions).

Actions #6

Updated by O'Neil Delpratt over 5 years ago

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

Bug fix applied to the Saxon 9.7.0.15 maintenance release

Actions #7

Updated by O'Neil Delpratt almost 5 years ago

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

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