The Compound Solution Pack allows you to define Parent-Child relationships between Islandora objects. Users can easily navigate between a parent's child objects as though they are an "ordered set". Parent objects may have the Compound Object content model, or (optionally) any content model. "Child" objects may have any content model. The parent-child relationship is recorded as a (configurable) predicate in the RELS-EXT datastream of the child objects, along with an ordering which uses a predicate unique to the parent object.
Navigation is provided through one of two blocks which must be placed in a region under Structure > Blocks.
Objects can be added, removed, and reordered from the parent object's Manage > Compound tab.
Example use cases:
Parent object: Postcard (the compound object, using the Compound content model)
Child object: Scan of postcard front (large image object) - Order 1 of 2
Child object: Scan of postcard back (large image object) - Order 2 of 2
Parent object: Slides of a presentation (PDF content model)
This module requires the following modules/libraries:
This module has the following as optional requirements for certain features:
For Solr search integration, including optional Solr backend:
For lazy-loading with the JAIL (Jquery Asynchronous Image Loader) Display:
Install as usual, see this for further information.
First, enable one of the following blocks to allow navigation between members of a compound object.
Navigation between members of a compound object requires one of the following two blocks to be placed:
If using the lazy loading option, the JAIL library must be present within sites/all/libraries/JAIL, and the "Use alternative autoloading display for compounds" configuration toggle must be enabled (see below).
Module options can be set at Administration » Islandora » Solution pack configuration » Compound Object Solution Pack (admin/islandora/solution_pack_config/compound_object).
Unchecked: all objects can have child objects.
If all objects can have child objects, then:
|
Checked: When the first child is added or changed through removal/reordering, the thumbnail of the first child will be attached to the parent as a TN datastream.
This will overwrite any existing thumbnail on the parent, and if the first child does not have a TN datastream, then the parent's TN datastream (if it exists) will be purged. This will occur even if the parent is not a Compound CModel object, which may be a bug: |
Unchecked: No thumbnail is generated and a system default thumbnail will display
Note: By default, objects of type Compound CModel do not have thumbnail datastreams. |
Unchecked: Child objects and parent objects will be displayed in the Islandora search.
This option will hide child objects in user searches, but may also hide child objects in other places in the interface if Solr is being used to provide back-end functionality. See improvement ticket: When enabled, if you would like the Compound object set to be discoverable via Solr, then all metadata relating to the parent/children must be present in the parent object's datastreams. However, if the parent has the Compound CModel, the user will only ever be able to see the metadata of the children. Thus, repository managers may need to maintain metadata in two places. |
Unchecked: On the page of a Compound CModel object with children, remain "on" the parent object (per the URL) but display the first child's content and metadata (default).
This can cause confusion about which object is currently being viewed. When unchecked, the user sees the first child's metadata and content, but the Manage tab, and any contextual blocks, views, or anything else controlled by the Context module, understands the user to be on the parent's page. However, the redirect option will also hinder administrators attempting to navigate to the parent. Hence, links to "Manage parent" are provided to authorized users in the compound navigation blocks. |
Designate a parent object - either by creating an object of type Compound CModel, or (with the appropriate configuration option enabled) an existing object.
If using a non-Compound object as the parent, then it will appear as the "first child" in the Compound Navigation block (JAIL or regular). |
If the option to do so is enabled, this will cause the parent object's thumbnail to be replaced by the TN of the first child.
To reorder objects, go to the parent object's Manage tab, select "Compound", and use the "Reorder" list. If you do reorder the child objects, be sure to click "Save changes" in the "Reorder" fieldset.
Child objects can be removed from parent objects from the parent object Manage >Compound tab. This removes the association from the RELS-EXT metadata and if the child has no other parent compound or collection objects, will delete the child object as well.
As of 7.x-1.12, deleting a parent compound object will also delete the child objects if they have no other parents (either compound parents or collection parents). |
If the parent object has the Compound content model, then its default view will present the "landing page" (content and metadata) of its first child object. If the parent object uses another content model, then it will display its own content and metadata.
There are two block options for displaying compound objects within Islandora. The default "Islandora Compound Object Navigation" block will provide navigation controls and loading of all objects related to the parent compound. The other option "Islandora Compound Object JAIL Display," is a block using the JAIL library which allows for "lazy loading" of images. This allows the block to load images only when they are needed, which will greatly increase performance on compound objects with many children. See the "Configuration" section for more information about the two display options.
The "Islandora Compound Object Navigation" block can be themed. Use the hook: theme_islandora_compound_prev_next()
.
Previous versions of this module (Islandora 7.x-1.2 and earlier) had a different predicate in the RELS-EXT to associate child objects with parent objects. To update to the new compound object predicate, run the drush command `update_rels_predicate` from the command line. This will update the predicates of existing Compound CModel objects from `isPartOf` to `isConstituentOf`. This command accepts no arguments.
The Compound Solution Pack comes with the following Content Models:
A parent object created using the Compound Solution Pack's compoundCModel will have the following datastreams:
RELS-EXT | Default Fedora relationship metadata |
MODS | MODS record, created at time of ingest |
DC | Dublin Core record |
TN | Thumbnail image, created at time of ingest |
The Compound Solution Pack comes with the "Compound Object MODS form" for editing the MODS datastream (admin/islandora/xmlform).
<rdf:RDF xmlns:rdf=" http://www.w3.org/1999/02/22-rdf-syntax-ns# " xmlns:fedora="info:fedora/fedora-system:def/relations-external#" xmlns:fedora-model="info:fedora/fedora-system:def/model#" xmlns:islandora=" http://islandora.ca/ontology/relsext# "> <rdf:Description rdf:about="info:fedora/islandora:3"> <fedora:isMemberOfCollection rdf:resource="info:fedora/islandora:compound_collection"></fedora:isMemberOfCollection> <fedora-model:hasModel rdf:resource="info:fedora/islandora:compoundCModel"></fedora-model:hasModel> </rdf:Description> </rdf:RDF> |
<rdf:RDF xmlns:fedora="info:fedora/fedora-system:def/relations-external#" xmlns:fedora-model="info:fedora/fedora-system:def/model#" xmlns:islandora=" http://islandora.ca/ontology/relsext# " xmlns:rdf=" http://www.w3.org/1999/02/22-rdf-syntax-ns# "> <rdf:Description rdf:about="info:fedora/islandora:2"> <fedora:isMemberOfCollection rdf:resource="info:fedora/islandora:sp_large_image_collection"></fedora:isMemberOfCollection> <fedora-model:hasModel rdf:resource="info:fedora/islandora:sp_large_image_cmodel"></fedora-model:hasModel> <fedora:isConstituentOf rdf:resource="info:fedora/islandora:3"></fedora:isConstituentOf> <islandora:isSequenceNumberOfislandora_3>1</islandora:isSequenceNumberOfislandora_3> </rdf:Description> </rdf:RDF> |
Having problems or solved a problem? Check out the Islandora google groups for a solution.