Documentation pages for the supported formats and readers are auto-generated during the build. This page explains how to amend/extend this part of the Bio-Formats documentation.
The supported formats pages are generated as part of the documentation build using maven. The metadata for each format is contained in format-pages.txt and the build generates a reStructuredText file for each format as well as an index page for all supported formats using Velocity.
The format-pages.txt is an INI file where each section corresponds to a particular format given by the section header. Multiple key/values should be defined for each section:
See Ratings legend and definitions. Available choices are: Poor, Fair, Good, Very Good, Outstanding. The metadataRating should be set as follows:
- base metadataRating is the smaller of opennessRating and pixelsRating
- increment metadataRating by 1 if any combination of Instrument.ID plus Image.InstrumentRef, or Channel.EmissionWavelength, or Channel.ExcitationWavelength are supported
- increment metadataRating by 1 if any SPW metadata is supported or pyramid is yes
The summary table listing the extensions for each reader is generated by the build process reading their extensions and descriptions from all Bio-Formats readers (BSD and GPL). A reStructuredText file with a table summary of all file extensions is created.
The metadata pages for each reader are generated by the build process parsing their metadata support from all Bio-Formats readers (BSD and GPL). An intermediate meta-support.txt file is created which is then converted into one reStructuredText page for each reader as well as a metadata summary reStructuredText file using Velocity.