Merge pull request #217 from performant-software/develop

Develop into master

Author: dleadbetter

README.md

@@ -0,0 +1,38 @@
+# Search detail filtering
+
+You can filter what is shown in the detail pane when clicking an item in the search view. This is accomplished by adding a result_filtering object to the search block in the config.json file in the content directory.
+
+- To filter native fields add the name of the native field to the exclude array:
+
+```
+"exclude":["name"]
+```
+
+- To filter user-defined fields add the GUID of the field to the exclude array:
+
+```
+"exclude":["name", "2f400af6-ee3f-42e4-8321-7b92c5a7cd23"]
+```
+
+- To filter one-to-many relationships (*Currently the only defined one-to-many relationship is `place_layers` in the `Place` model.*) add the relationship name to the exclude array
+
+```
+"exclude":["name", "2f400af6-ee3f-42e4-8321-7b92c5a7cd23", "place_layers"]
+```
+
+- To filter related records add the related record type to the exclude array.
+
+The following related records can be excluded:
+
+- relatedEvents
+- relatedInstances
+- relatedItems
+- relatedOrganizations
+- relatedManifest
+- relatedPlaces
+- relatedTaxonomies
+- relatedWorks
+
+```
+"exclude":["name", "2f400af6-ee3f-42e4-8321-7b92c5a7cd23", "place_layers", "relatedOrganizations"]
+```

docs/configuration-schema.md

@@ -4,11 +4,11 @@
 
 Goto Realm > Users
 
-![](./docs/users.png)
+![](users.png)
 
 Select `Add user`
 
-![](./docs/create-user.png)
+![](create-user.png)
 
 Create a new user with both username and email set to the email address of the SSO user.
 
@@ -22,18 +22,18 @@ Create the user by pressing `Create`
 
 Goto Realm > Users
 
-![](./docs/users.png)
+![](users.png)
 
 Select `Add user`
 
-![](./docs/create-user.png)
+![](create-user.png)
 
 Create a new user with both username and email set to the email address of the SSO user.
 
 Toggle `Email verified` to `Yes`
 
 Create a temporary password for the user
 
-![](./docs/password.png)
+![](password.png)
 
 When the user first logs in they will be required to change it.