From dec0210357656e39d09580f1ac4011d558b051ac Mon Sep 17 00:00:00 2001 From: Rosie Le Faive Date: Mon, 1 Mar 2021 12:50:58 -0400 Subject: [PATCH 1/7] Collections. --- docs/concepts/collection.md | 29 +++++++++++++++++++ .../how-to-create-collection.md} | 21 ++++++++------ mkdocs.yml | 8 ++--- 3 files changed, 45 insertions(+), 13 deletions(-) create mode 100644 docs/concepts/collection.md rename docs/{user-documentation/collections.md => tutorials/how-to-create-collection.md} (79%) diff --git a/docs/concepts/collection.md b/docs/concepts/collection.md new file mode 100644 index 000000000..f00403928 --- /dev/null +++ b/docs/concepts/collection.md @@ -0,0 +1,29 @@ +# Collections + +Collections are groups of related content that can be viewed or managed as a unit. Islandora-specific use cases include: + +- an archival fonds that needs to be grouped together, with internal hierarchy +- various collections of artifacts, grouped for display +- theses and dissertations, which are organized and managed separately from other objects. + +Islandora can: + +- declare items as members of other objects +- after declaring an item "a collection", display a view of its members + +Management of the objects of a collection is not yet readily built in, but such actions as deleting, changing visibility or permissioning on a collection should be possible through Views Bulk Edit and other contrib modules, such as Permissions By Term. + +## Configuration provided by Islandora Defaults +Islandora (Defaults) provides: + +- A membership relationship for members (“children”) to point to their parent collection +- A View (template) to display the members of a collection on the collection’s page +- Batch-editing tools that can be used on collections + +Islandora uses a generic "member of" relationship field to group objects under a "parent" object. This mechanism is shared by Paged Content and by Compound Objects. + +In Islandora Defaults, when content is given the Model of “Collection”, then a Context kicks in (the context is called “Collection”) that causes a view block (the View’s name is Members) to appear on the page. + +## Tutorials + +- [How to create and add a collection]("tutorials/how-to-create-collection.md") diff --git a/docs/user-documentation/collections.md b/docs/tutorials/how-to-create-collection.md similarity index 79% rename from docs/user-documentation/collections.md rename to docs/tutorials/how-to-create-collection.md index 9d27a67ff..b72744b13 100644 --- a/docs/user-documentation/collections.md +++ b/docs/tutorials/how-to-create-collection.md @@ -1,12 +1,15 @@ -Collections are groups of repository content that can be described themselves. Repository content is aggregated in a collection by setting the `field_member_of` -entity reference field to point to a collection. Generally speaking, anything can behave as a collection, and anything with `field_member_of` can be a member of a collection. -However, Islandora provides a "Collection" taxonomy term in the Islandora Models vocabulary that can be used to trigger collection-specific behavior. -For example, a context provided by Islandora Defaults will display a list of child resource node teasers on the resources' display page when this term is applied to the `field_model` field. - -!!! Tip "Collections and Deleting" - Collections and their members are - independent of each other, and removing something from a collection does not delete it. **Similarly, deleting a - collection does not delete its members.** +# How to create and add to a Collection + +This how-to demonstrates creating a collection and adding items to it in Islandora Defaults. For more about collections, see Feature: Collections. + +## Introduction + +In Islandora Defaults, Collections that are tagged as "Collection" under System > Model will show a view of their member objects. A member is any object that is "member_of" that object, and can be added via the "Members" tab. This is the mechanism in Islandora Defaults; individual instances may vary. + +!!! Warning "Collections and Deleting" + Collections and their members are independent of each other, + and removing something from a collection does not delete it. + **Similarly, deleting a collection does not delete its members.** ## Creating a Collection diff --git a/mkdocs.yml b/mkdocs.yml index 0d5636bb9..d74ecb472 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -48,6 +48,7 @@ nav: # what everybody needs to know to understand Islandora and interact with it # Possibly add page/section: How to use this documentation (containing user role definitions) - Concepts: + - 'Collections': 'concepts/collection.md' - 'Component Overview': 'installation/component_overview.md' # moved from "Installation" section; alternatively duplicate a simplified version in the overview section # also see Architecture Diagram in Developer documentation @@ -88,7 +89,9 @@ nav: # explaining why, and let the user decide if they want to look deeper at # what these concepts are. - 'Create a Resource Node': 'tutorials/create-a-resource-node.md' - # procedural, for people learning what islandora is. + # procedural, for people learning what islandora is. + - 'Collections': 'user-documentation/collections.md' + # procedural, repository managers/ curators - 'Video Documentation': 'user-documentation/video-docs.md' # mostly procedural, repository managers @@ -112,9 +115,6 @@ nav: - 'Media': 'user-documentation/media.md' # conceptual and procedural, repository managers # move out procedural description for deleting Media - - 'Collections': 'user-documentation/collections.md' - # conceptual and procedural, repository managers/ curators - # move out procedural description for creating and populating collections - 'Paged Content': 'user-documentation/paged-content.md' # conceptual and procedural, repository managers/ curators # move out procedural description for ordering pages From cda469f525d314dfb999d05e1f1d9714a59eb3cb Mon Sep 17 00:00:00 2001 From: Rosie Le Faive Date: Mon, 1 Mar 2021 12:57:39 -0400 Subject: [PATCH 2/7] More collections. --- docs/concepts/collection.md | 2 +- docs/tutorials/how-to-create-collection.md | 2 +- mkdocs.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/concepts/collection.md b/docs/concepts/collection.md index f00403928..874737151 100644 --- a/docs/concepts/collection.md +++ b/docs/concepts/collection.md @@ -26,4 +26,4 @@ In Islandora Defaults, when content is given the Model of “Collection”, then ## Tutorials -- [How to create and add a collection]("tutorials/how-to-create-collection.md") +- [How to create and add to a collection](../tutorials/how-to-create-collection.md) diff --git a/docs/tutorials/how-to-create-collection.md b/docs/tutorials/how-to-create-collection.md index b72744b13..90fa09184 100644 --- a/docs/tutorials/how-to-create-collection.md +++ b/docs/tutorials/how-to-create-collection.md @@ -1,6 +1,6 @@ # How to create and add to a Collection -This how-to demonstrates creating a collection and adding items to it in Islandora Defaults. For more about collections, see Feature: Collections. +This how-to demonstrates creating a collection and adding items to it in Islandora Defaults. For more about collections, see [Concept: Collection](../concepts/collection.md). ## Introduction diff --git a/mkdocs.yml b/mkdocs.yml index d74ecb472..088ced891 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -90,7 +90,7 @@ nav: # what these concepts are. - 'Create a Resource Node': 'tutorials/create-a-resource-node.md' # procedural, for people learning what islandora is. - - 'Collections': 'user-documentation/collections.md' + - 'Create a Collection': 'tutorials/how-to-create-collection.md' # procedural, repository managers/ curators - 'Video Documentation': 'user-documentation/video-docs.md' # mostly procedural, repository managers From 9bcb3a75bb7ba569a6dcbddb51cec8c3bc85d988 Mon Sep 17 00:00:00 2001 From: Rosie Le Faive Date: Wed, 3 Mar 2021 15:45:02 -0400 Subject: [PATCH 3/7] Reword what we cant do --- docs/concepts/collection.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/concepts/collection.md b/docs/concepts/collection.md index 874737151..27292e08e 100644 --- a/docs/concepts/collection.md +++ b/docs/concepts/collection.md @@ -11,7 +11,8 @@ Islandora can: - declare items as members of other objects - after declaring an item "a collection", display a view of its members -Management of the objects of a collection is not yet readily built in, but such actions as deleting, changing visibility or permissioning on a collection should be possible through Views Bulk Edit and other contrib modules, such as Permissions By Term. +A minimal installation of Islandora (Islandora Core) does not provide pre-configured options to perform management operations on all objects of a collection. Bulk actions such as deleting, changing visibility or adjusting permissions on all objects in a collection can be achieved with the [Views Bulk Edit Drupal module](https://www.drupal.org/project/views_bulk_edit) and other Drupal contrib modules, such as [Permissions By Term](https://www.drupal.org/project/permissions_by_term). The Islandora sandbox comes with pre-configured views for managing groups of objects. + ## Configuration provided by Islandora Defaults Islandora (Defaults) provides: From 739524f96a1270ef8371ce7b52e5f6d82149665a Mon Sep 17 00:00:00 2001 From: Rosie Le Faive Date: Wed, 3 Mar 2021 15:45:43 -0400 Subject: [PATCH 4/7] Remove permissions by term. --- docs/concepts/collection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/collection.md b/docs/concepts/collection.md index 27292e08e..d22d10ce9 100644 --- a/docs/concepts/collection.md +++ b/docs/concepts/collection.md @@ -11,7 +11,7 @@ Islandora can: - declare items as members of other objects - after declaring an item "a collection", display a view of its members -A minimal installation of Islandora (Islandora Core) does not provide pre-configured options to perform management operations on all objects of a collection. Bulk actions such as deleting, changing visibility or adjusting permissions on all objects in a collection can be achieved with the [Views Bulk Edit Drupal module](https://www.drupal.org/project/views_bulk_edit) and other Drupal contrib modules, such as [Permissions By Term](https://www.drupal.org/project/permissions_by_term). The Islandora sandbox comes with pre-configured views for managing groups of objects. +A minimal installation of Islandora (Islandora Core) does not provide pre-configured options to perform management operations on all objects of a collection. Bulk actions such as deleting, changing visibility or adjusting permissions on all objects in a collection can be achieved with the [Views Bulk Edit Drupal module](https://www.drupal.org/project/views_bulk_edit) and other Drupal contrib modules. The Islandora sandbox comes with pre-configured views for managing groups of objects. ## Configuration provided by Islandora Defaults From d698ce4619acd0256d7661dee635eb2dabfa3866 Mon Sep 17 00:00:00 2001 From: Rosie Le Faive Date: Thu, 4 Mar 2021 09:15:57 -0400 Subject: [PATCH 5/7] Update collection.md --- docs/concepts/collection.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/concepts/collection.md b/docs/concepts/collection.md index d22d10ce9..979f05fd4 100644 --- a/docs/concepts/collection.md +++ b/docs/concepts/collection.md @@ -6,25 +6,31 @@ Collections are groups of related content that can be viewed or managed as a uni - various collections of artifacts, grouped for display - theses and dissertations, which are organized and managed separately from other objects. -Islandora can: +Islandora: -- declare items as members of other objects -- after declaring an item "a collection", display a view of its members - -A minimal installation of Islandora (Islandora Core) does not provide pre-configured options to perform management operations on all objects of a collection. Bulk actions such as deleting, changing visibility or adjusting permissions on all objects in a collection can be achieved with the [Views Bulk Edit Drupal module](https://www.drupal.org/project/views_bulk_edit) and other Drupal contrib modules. The Islandora sandbox comes with pre-configured views for managing groups of objects. +- provides a field storage called "Member of" (field_member_of) that can be used to declare items to be members of other resources. +- provides a "Children" tab on resources, which provides a management interface to access the members of a resources. +Islandora on its own does not prescribe any particular content types, so this field storage can be implemented on any node bundle inteneded to represent Islanodra resources. ## Configuration provided by Islandora Defaults Islandora (Defaults) provides: -- A membership relationship for members (“children”) to point to their parent collection -- A View (template) to display the members of a collection on the collection’s page -- Batch-editing tools that can be used on collections +- A content type with the "member_of" field that can be used to add a resource to a collection (or paged content, or compound resource) +- logic (a context) such that if a resource is tagged as a "collection", a view of its members will show on the collection's page. Islandora uses a generic "member of" relationship field to group objects under a "parent" object. This mechanism is shared by Paged Content and by Compound Objects. In Islandora Defaults, when content is given the Model of “Collection”, then a Context kicks in (the context is called “Collection”) that causes a view block (the View’s name is Members) to appear on the page. +Islanodra defaults also provides configuration so that: + + - + +Islandora sandbox provides sample content and demonstration views of collection members, as well as some administrative views using the [Views Bulk Edit Drupal module](https://www.drupal.org/project/views_bulk_edit) to provide tools to manage members of a collection. + + + ## Tutorials - [How to create and add to a collection](../tutorials/how-to-create-collection.md) From eca4b55910468003c307d6a1b1a3d0d02a12301a Mon Sep 17 00:00:00 2001 From: Rosie Le Faive Date: Thu, 4 Mar 2021 09:24:32 -0400 Subject: [PATCH 6/7] Update collection.md --- docs/concepts/collection.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/concepts/collection.md b/docs/concepts/collection.md index 979f05fd4..8a6bb84d5 100644 --- a/docs/concepts/collection.md +++ b/docs/concepts/collection.md @@ -6,31 +6,33 @@ Collections are groups of related content that can be viewed or managed as a uni - various collections of artifacts, grouped for display - theses and dissertations, which are organized and managed separately from other objects. -Islandora: +Islandora provides: -- provides a field storage called "Member of" (field_member_of) that can be used to declare items to be members of other resources. -- provides a "Children" tab on resources, which provides a management interface to access the members of a resources. +- a field storage called "Member of" (field_member_of) that can be used to declare items to be members of other resources. +- a "Children" tab on resources, which provides a management interface to access, re-order, add, or delete the members of a resource. -Islandora on its own does not prescribe any particular content types, so this field storage can be implemented on any node bundle inteneded to represent Islanodra resources. +Islandora on its own does not prescribe any particular content types, so this field storage can be implemented on any node bundle inteneded to represent Islandora resources. Islandora provides a generic "member of" relationship field to group objects under a "parent" object. This mechanism is shared by similar use cases: Paged Content and Compound Objects. + +## Bulk management of members of a collection + +Bulk management of items can be done using the Drupal contrib module [Views Bulk Edit Drupal module](https://www.drupal.org/project/views_bulk_edit). In short, build a view using this views field, and you will be able to perform Drupal Actions on objects. Neither Islanodra nor Islandora Defaults provide out-of-the-box management tools, but the sandbox provides some sample content and views that use Views Bulk Edit. + +For more information see [forthcoming page] Concept: Bulk Edit ## Configuration provided by Islandora Defaults + Islandora (Defaults) provides: -- A content type with the "member_of" field that can be used to add a resource to a collection (or paged content, or compound resource) +- a content type ("Repository Item") that has the "member_of" field, so can be used to add a resource to a collection (or paged content, or compound resource), - logic (a context) such that if a resource is tagged as a "collection", a view of its members will show on the collection's page. -Islandora uses a generic "member of" relationship field to group objects under a "parent" object. This mechanism is shared by Paged Content and by Compound Objects. - -In Islandora Defaults, when content is given the Model of “Collection”, then a Context kicks in (the context is called “Collection”) that causes a view block (the View’s name is Members) to appear on the page. +For more details, see the tutorial on [How to create and add to a collection](../tutorials/how-to-create-collection.md) -Islanodra defaults also provides configuration so that: +## Tutorials - - +- [How to create and add to a collection](../tutorials/how-to-create-collection.md) -Islandora sandbox provides sample content and demonstration views of collection members, as well as some administrative views using the [Views Bulk Edit Drupal module](https://www.drupal.org/project/views_bulk_edit) to provide tools to manage members of a collection. -## Tutorials -- [How to create and add to a collection](../tutorials/how-to-create-collection.md) From 9559019b2d9570cab52496b167b21fbd23250d14 Mon Sep 17 00:00:00 2001 From: Rosie Le Faive Date: Thu, 4 Mar 2021 14:02:00 -0400 Subject: [PATCH 7/7] Update collection.md --- docs/concepts/collection.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/concepts/collection.md b/docs/concepts/collection.md index 8a6bb84d5..687de2fa1 100644 --- a/docs/concepts/collection.md +++ b/docs/concepts/collection.md @@ -23,7 +23,7 @@ For more information see [forthcoming page] Concept: Bulk Edit Islandora (Defaults) provides: -- a content type ("Repository Item") that has the "member_of" field, so can be used to add a resource to a collection (or paged content, or compound resource), +- a content type ("Repository Item") that has the "member_of" field, so that users may add nodes of this type to a collection (or paged content, or compound resource), - logic (a context) such that if a resource is tagged as a "collection", a view of its members will show on the collection's page. For more details, see the tutorial on [How to create and add to a collection](../tutorials/how-to-create-collection.md)