Skip to content

Commit

Permalink
Document the new Representative Image field. (#2321)
Browse files Browse the repository at this point in the history
* Document the new Representative Image field.

* Update starter-site-metadata-configuration.md

* Update docs/user-documentation/starter-site-metadata-configuration.md
  • Loading branch information
rosiel authored Jun 13, 2024
1 parent e21fa44 commit 26807e1
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/user-documentation/starter-site-metadata-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,66 @@ Further information on the metadata configuration can be found in a Google Sprea
</td>
</tr>
</table>
<table>
<tr>
<td colspan="2" >
<h3>Representative Image</h3>
</td>
</tr>
<tr>
<td colspan="2" >Optionally, use this field to link to a Media that will be used as the node's thumbnail. This will be displayed when the DGI Image Discovery module is used. This field takes precedence over the node's "Islandora thumbnail" (i.e. a related media with the "Thumbnail" media use term). See the module's <a href="https://github.com/discoverygarden/dgi_image_discovery">README</a> for the full scope of how images are "discovered". This is a good way to assign a "default" icon for many nodes that don't have actual thumbnail images, as this field allows you to re-use Media, which you can't do with normal Islandora media.
</td>
</tr>
<tr>
<td>
Machine Name
</td>
<td>field_representative_image
</td>
</tr>
<tr>
<td>
Drupal Field Type
</td>
<td>Entity reference (Media)
</td>
</tr>
<tr>
<td>
Required?
</td>
<td>no <em>(will default to using the Islandora thumbnail if no value is entered)</em>
</td>
</tr>
<tr>
<td>
Repeatable
</td>
<td>no
</td>
</tr>
<tr>
<td>
Create Referenced Entities
</td>
<td>yes <em>(you can upload files to create and link to a new Media)</em>
</td>
</tr>
<tr>
<td>
Facet
</td>
<td>none
</td>
</tr>
<tr>
<td>
Alternatives
</td>
<td>This field is itself an alternative to the "normal" Islandora thumbnail, and does not need to be used if the Islandora thumbnail suffices.
</td>
</tr>
</table>

## Other Title(s)

Expand Down

0 comments on commit 26807e1

Please sign in to comment.