diff --git a/src/doc/converters/further_converters.rst b/src/doc/converters/further_converters.rst index 1acf4c02795add8544a0b546f6431c5ae2c209a2..a3c306a2469e14cd9a5d375ecb8c815c8e34b759 100644 --- a/src/doc/converters/further_converters.rst +++ b/src/doc/converters/further_converters.rst @@ -108,7 +108,9 @@ The ROCrateConverter unpacks ro-crate files, and creates one instance of the ``ROCrateEntity`` structure element for each contained object. Currently only zipped ro-crate files are supported. The created ROCrateEntities wrap a ``rocrate.model.entity.Entity`` with a path to the folder the ROCrate data -is saved in, and can then be treated by the :ref:`ROCrateEntityConverter`. +is saved in. They are appended as children and can then be accessed via the +subtree and treated using the :ref:`ROCrateEntityConverter`. + To use the ROCrateConverter, you need to install the LinkAhead crawler with its optional ``rocrate`` dependency. @@ -121,13 +123,17 @@ to the ROCrateConverter and also creates ROCrateEntities for contained objects. ROCrateEntityConverter ---------------------- -The ROCrateEntityConverter unpacks the properties, files and parts of the -``rocrate.model.entity.Entity`` wrapped within a ROCrateEntity. Properties -are converted to a basic element matching their value -(``BooleanElement``, ``IntegerElement``, etc.), each ``rocrate.model.file.File`` -is converted to a crawler File object, and each subpart of the ROCrateEntity is -again converted to a ROCrateEntity. These elements can then again be treated -using this or their respective inbuilt converters. +The ROCrateEntityConverter unpacks the ``rocrate.model.entity.Entity`` wrapped +within a ROCrateEntity, and appends all properties, contained files, and parts +as children. Properties are converted to a basic element matching their value +(``BooleanElement``, ``IntegerElement``, etc.) and can be matched using +match_properties. Each ``rocrate.model.file.File`` is converted to a crawler +File object, which can be matched with SimpleFile. And each subpart of the +ROCrateEntity is also converted to a ROCrateEntity, which can then again be +treated using this converter. + +To match a ROCrateEntity using its entity_type, the match_entity_types keyword +can be used. Example cfood -------------