Registry kit
Registry kit aids developing extensions for editing data that aligns with ISO 19135-1 register schema.
A common case of structured data is registers, as defined by the ISO 19135-1 standard.
Registry kit defines a model for expressing ISO 19135-1 register data as a collection of YAML files, and simplifies creating Paneron extensions that work with that data.
Note:
Registry kit is currently under active development, and some of its features may be incomplete.
Instead of writing your own repository view component from scratch, with the registry kit you can import its registry view component, and pass it a configuration of register item classes that your register supports.
Registry kit would then handle the general aspects of registers, such as item IDs, statuses, change request flow and more. It would also handle the low-level interaction with repository data, such as reading and reading files. Your extension’s responsibility is thus significantly reduced: right now it’s mostly providing UI components for displaying and editing register item data that is specific to your item classes.
The configuration of register item classes includes the following:
General item metadata
Machine-readable class identifier, which will also serve as the name of the directory item contents reside in
Human-readable item class title, as well as alternative names (if any)
Item class description
Default values for register item data
Item sorter function
Item data validation and sanitization functinos
React components that serve as views of a given register item
Displaying item data
Editing item data
Displaying item in list
For an example of a Paneron extension built with registry kit, see the ISO/TC 211 Geodetic registry extension.
You can use the registry extension template as the starting point.