Merge pull request #188 from alliomeria/1.3.0

Search Within Collection
esmero · Feb 12, 2024 · 7f23dc3 · 7f23dc3
2 parents ae4a7d9 + 78ce07f
commit 7f23dc3
Show file tree

Hide file tree

Showing 16 changed files with 144 additions and 0 deletions.
diff --git a/docs/images/ADOTypeCollection.png b/docs/images/ADOTypeCollection.png
diff --git a/docs/images/AddFilterCriteria.png b/docs/images/AddFilterCriteria.png
diff --git a/docs/images/AdvancedSettingsExposedFormYes.png b/docs/images/AdvancedSettingsExposedFormYes.png
diff --git a/docs/images/CollectionMembershipView.png b/docs/images/CollectionMembershipView.png
diff --git a/docs/images/ContentTypeCollection.png b/docs/images/ContentTypeCollection.png
diff --git a/docs/images/DemoCollectionTestSearch.png b/docs/images/DemoCollectionTestSearch.png
diff --git a/docs/images/ExposedFormBlockOptions.png b/docs/images/ExposedFormBlockOptions.png
diff --git a/docs/images/ExposedFormBlockSettingsFormTop.png b/docs/images/ExposedFormBlockSettingsFormTop.png
diff --git a/docs/images/ExposedFormCollectionMembershipBlock.png b/docs/images/ExposedFormCollectionMembershipBlock.png
diff --git a/docs/images/ReorderBlocks.png b/docs/images/ReorderBlocks.png
diff --git a/docs/images/ThemeContentRegionDefault.png b/docs/images/ThemeContentRegionDefault.png
diff --git a/docs/images/UpdatedCollectionMembershipView.png b/docs/images/UpdatedCollectionMembershipView.png
diff --git a/docs/images/ViewUnsavedChangesWarning.png b/docs/images/ViewUnsavedChangesWarning.png
diff --git a/docs/search-within-collection.md b/docs/search-within-collection.md
@@ -0,0 +1,141 @@
+---
+title: How to Add a 'Search Within Collection' Block
+tags:
+  - Search
+  - Search Within
+  - Collections
+  - Views
+  - Exposed Forms
+  - Blocks
+---
+
+#  How to Add a 'Search Within Collection' Block
+
+This guide covers how to add a 'Search Within Collection' Exposed Form Block to the default Archipelago Collection Display Page. 
+
+### Preamble + prerequisites 
+
+Before diving into any Search and Solr configuration related changes, we strongly recommend that you read our [Metadata in Archipelago](metadatainarchipelago.md) overview documentation, which provides important context for understanding how the shape of your Archipelago Digital Objects/Collections (ADOs) metadata will inform your Search and Solr options and outcomes. If you don't have the bandwidth to read the (stellar) [Metadata in Archipelago](metadatainarchipelago.md) documentation, we recommend you read through our [in-a-nutshell](/search_solr_index/#in-a-nutshell-json-data-to-strawberry-keyname-providers-to-solr) overview.
+
+## Step 1:  Open the Collection Membership View
+
+Navigate to the Collection Membership view found at:
+
+- `/admin/structure/views/view/collection_membership`
+- Through the `Structure` menu > `Views` > `Collection Membership`
+
+This View is setup to list the member Digital Objects of a Collection and is driven by Solr.
+
+![Collection Membership View](images/CollectionMembershipView.png)
+
+## Step 2. Adjust the View's Advanced tab settings
+
+Open the 'Advanced' tab settings and change the 'Exposed form in block' to *'Yes'*.
+
+![Advanced Settings Exposed Form Yes](images/AdvancedSettingsExposedFormYes.png)
+
+## Step 3. Add the Fulltext Search Filter Criteria for the View
+
+On the left-hand side of the Collection Membership View form, under the 'Filter criteria' section, add and configure the 'Fulltext search' Criteria.
+
+![Add Filter Criteria](images/AddFilterCriteria.png)
+
+At the top of the 'Configure filter criterion: Search: Fulltext search' form that opens:
+
+- Select the option to **'Expose this filter to visitors, to allow them to change it'**.
+
+On the lower section of the form, adust the configuration options as follows:
+
+- Remove any text from 'Label' or 'Description
+- Operator: select/check 'Contains all of these words'
+- Allow multiple selections : leave unchecked
+- Remember the last selection : leave unchecked
+- Filter identifier: leave default of 'search_api_fulltext'
+- Placeholder: enter 'Search within Collection' (or your preferred text)
+- Search field character limit: set to '128'
+- Expose searched fields : leave unchecked
+- Searched fields : leave all unselected, so "If no fields are selected, all available fulltext fields will be searched."
+- Minimum keyword length : set to '1'
+
+Select **'Apply'** and continue to the next Step.
+
+## Step 4. Review/adjust options and Save the Updated View
+
+Review the changes you made to the Collection Membership View. Optionally further adjust the options if desired. For example, you may choose to change the `Submit button text` to 'Search' instead of 'Apply'). If you make any further changes select, **'Apply'** before exiting.
+
+![Exposed Form Block Options](images/ExposedFormBlockOptions.png)
+
+**'Save'** your changes made to the View before proceeding.
+
+Your updated Collection Membership View should look like the following now:
+
+![Updated Collection Membership View](images/UpdatedCollectionMembershipView.png)
+
+## Step 5. Place the Exposed Form Block
+
+Navigate to the Block Layout found at:
+
+- `/admin/structure/block`
+- Through the `Structure` menu > `Block layout`
+
+Select the `Archipelago Base Theme` (or whatever theme you are using):
+
+- `admin/structure/block/list/archipelago_subtheme`
+
+Navigate to the 'Content' section of the theme and select **'Place Block'**.
+
+![Theme Content Region Default](images/ThemeContentRegionDefault.png)
+
+Search for the 'Exposed form: collection_membership-block_1' and select **'Place Block'**.
+
+![Exposed Form Collection Membership Block](images/ExposedFormCollectionMembershipBlock.png)
+
+## Step 6. Configure the Block's Settings:
+
+Configure the different settings for the Block. 
+
+You will need to specify both of the following options under the `Visibility` section:
+
+- ADO Type: specify Collection (and any other Collection types you may also have such as 'Newspaper')
+
+![ADO Type Collection](images/ADOTypeCollection.png)
+
+- Content type: select 'Digital Object Collection'
+
+![Content Type Collection](images/ContentTypeCollection.png)
+
+In the top section of the form, we recommend the following settings:
+
+- Deselect 'Display title'
+- Under `Exposed Form element and component Visibility`, deselect the following:
+    * Show filter components of type select if exposed
+    * Show filter components of type checkbox/options if exposed
+    * Override Submit button Label
+
+![Exposed Form Block Settings Form Top](images/ExposedFormBlockSettingsFormTop.png)
+
+Select **'Save block'** when you are finished configuring the Block's Settings.
+
+## Step 7. Position the Block and Save.
+
+Drag to re-order and position the Exposed Form Block to sit above the Collection Membership block in the `Content` section. This will position the Exposed Form Block above the list of Collection Member Objects on the display pages for Collections.
+
+After you have positioned the blocks, scroll down to the bottom of the `Block layout` page and select **'Save blocks'**.
+
+## Step 8. 
+
+Navigate to a Collection and test out a Search in the search box that is now in place above the 'Objects in this Collection' listing.
+
+In this screenshot, you can see a demonstrative Search for 'map' within one of the Archipelago Demo Collections.
+
+![DemoCollectionTestSearch](images/DemoCollectionTestSearch.png)
+
+#### Additional Considerations
+
+You may also wish to pair this 'Search Within Collection' Exposed Form Block with related Facets (setup on the same corresponding collection membership View). You can find follow the step-by-step instructions in our [Strawberry Key Name Providers, Solr Field, and Facet Configuration documentation](strawberry_key_name_providers.md).
+
+___
+
+Thank you for reading! Please contact us on our [Archipelago Commons Google Group](https://groups.google.com/forum/#!forum/archipelago-commons) with any questions or feedback.
+
+Return to the [Archipelago Documentation main page](index.md).
diff --git a/docs/search_solr_index.md b/docs/search_solr_index.md
@@ -52,6 +52,7 @@ If you don't have the bandwidth to read the (stellar) [Metadata in Archipelago](
 
 * [Strawberry Key Name Providers, Solr Field, and Facet Configuration](strawberry_key_name_providers.md) 
 * [Advanced Search](search_advanced.md)
+* [How to Add a 'Search Within Collection' Block](search-within-collection.md)
 
 ___
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -29,6 +29,7 @@ nav:
         - Start: archipelago-deployment-live-readme.md
         - Github Workflow: archipelago-deployment-live-gitworkflow.md
         - Moving from archipelago-deployment to archipelago-deployment-live: archipelago-deployment-live-moveToLive.md
+        - Upgrading Drupal 9 to Drupal 10 (1.1.0 to 1.3.0): archipelago-deployment-live-UpgradeDrupalD9toD10.md  
         - Upgrading Drupal 8 to Drupal 9 (1.0.0-RC2 to 1.0.0-RC3): archipelago-deployment-live-upgradeFromD8ToD9.md
         - Upgrading from 1.0.0-RC3 to 1.0.0: archipelago-deployment-live-upgradeFromRC3.md
         - Updating Docker Containers: archipelago-deployment-live-updatingContainers.md
@@ -51,6 +52,7 @@ nav:
         - search_solr_index.md
         - Setup through Strawberry Key Name Providers: strawberry_key_name_providers.md
         - Advanced Search: search_advanced.md
+        - Search Within Collections: search-within-collection.md
       - Fragaria Redirects: fragaria.md
     - Content and Metadata Tools:
       - Ingesting Your First Object: firstobject.md
-Original file line number
+Diff line change
@@ Expand Up @@
     * [Strawberry Key Name Providers, Solr Field, and Facet Configuration](strawberry_key_name_providers.md)
     * [Advanced Search](search_advanced.md)
+    * [How to Add a 'Search Within Collection' Block](search-within-collection.md)
     ___
@@ Expand Down @@