Git Product home page Git Product logo

bondjimbond / islandora_solution_pack_compound Goto Github PK

View Code? Open in Web Editor NEW

This project forked from islandora/islandora_solution_pack_compound

0.0 1.0 0.0 568 KB

Adds the ability to to create compound objects using objects created with any other Islandora solution pack by enabling a generic parent-child relationships between objects.

License: GNU General Public License v3.0

CSS 4.24% PHP 93.45% JavaScript 2.30%

islandora_solution_pack_compound's Introduction

Compound Object Solution Pack Build Status

Introduction

The Islandora Compound Object Solution Pack enables the creation and management of parent-child relationships between objects, and an interface to navigate between children of the same object. Children have an order within their parent, which can be managed from the parent object.

Requirements

This module requires the following modules/libraries:

Specific features require the following modules/libraries:

  • Islandora Solr Search Module

    • Provides a Solr backend to retrieve children instead of using the resource index
    • Configurable ability to hide child objects from Solr search results
  • JAIL JQuery library

    • For the JAIL Display (lazy-loading) block

Installation

Install as usual, see this for further information.

If using the JAIL display, the JAIL library must be present within sites/all/libraries/JAIL.

Usage

This module provides a "Compound CModel". Objects of this type are shells to hold children. They have no content of their own, and the object page at a Compound CModel object displays the content and metadata of its first child. This module can be configured to allow other objects to have children, in which case, the parent object appears as usual, and the navigation block displays the parent followed by its children.

Compound relationships are managed through the Manage » Compound tab which appears on all objects.

Navigation between objects linked by a Compound relationship requires a block to be placed on the interface in Structure » Blocks. This module provides two options: a standard Islandora Compound Object Navigation block, and the Islandora Compound JAIL Display, which uses a javascript library for lazy-loading (improving performance on compound objects with many children).

compobjblocks_to_configure

Configuration

Options for this module can be set at Administration » Islandora » Solution pack configuration » Compound Object Solution Pack (admin/islandora/solution_pack_config/compound_object). Configuration options are documented further in our Wiki.

New in 7.x-1.12: If the Solr Search Module is enabled, you can use Solr instead of SPARQL to query for Compound membership. Options for this can be configured on the Solr backend tab (admin/islandora/solution_pack_config/compound_object/solr).

Configuration

Theme:

The "Islandora Compound Object Navigation" block can be themed. See theme_islandora_compound_prev_next().

Batch Ingest:

A zip importer for child objects is available as a submodule, and documentation is in its own README.

Drush:

If compound objects were created before 7.x-1.2, they will use the relationship isPartOf instead of isConstituentOf. A drush command, drush update_rels_predicate, can be run from the command line to update these predicates. To use it, temporarily set the Child relationship predicate in the compound solution pack to isPartOf. The script will set it to isConstituentOf when it finishes.

Notes on usage:

  • The script acts on the children of Compound CModel objects; it does not affect compounds where the parent is a different type.
  • If anonymous cannot view Islandora objects, then the drush script must be explicitly run as a user who can.

Documentation

Further documentation for this module is available at our wiki.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

Maintainers/Sponsors

Current maintainers:

Development

If you would like to contribute to this module, please check out CONTRIBUTING.md. In addition, we have helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.

License

GPLv3

islandora_solution_pack_compound's People

Contributors

jordandukart avatar mitchmac avatar adam-vessey avatar ruebot avatar willtp87 avatar nhart avatar manez avatar morgandawe avatar whikloj avatar yqjiang avatar jonathangreen avatar diegopino avatar slangerx avatar rosiel avatar dmoses avatar nmader avatar lucasvanschaik avatar nigelgbanks avatar kayakr avatar bondjimbond avatar cdeanegit avatar mjordan avatar matthewperry avatar ajstanley avatar aulorbe avatar bryjbrown avatar donrichards avatar librarychik avatar jojoves avatar kellibee123 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.