List config in Islandora Defaults. #1721

rosiel · 2020-12-03T20:09:47Z

Purpose / why

Because what Islandora Defaults contains was not yet documented.

What changes were made?

New page, listing all the config entities in Islandora Defaults.

Verification

Spin it up locally, and read through it.

Interested Parties

@dannylamb @Islandora/documentation

Checklist

Pull-request reviewer should ensure the following

Does this PR link to related issues?
Does the proposed documentation align with the Islandora Documentation Style Guide?
Are the changes accurate, useful, free of typos, etc?
Does this PR update the last updated on date on the documentation page?

Person merging should ensure the following

Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
If pages are renamed or removed, have all internal links to those pages been fixed?
If pages are added, have they been linked to or placed in the menu?
Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

docs/reference/islandora_defaults_reference.md

dannylamb · 2021-01-13T14:17:54Z

docs/reference/islandora_defaults_reference.md

+
+|Name  					|Description  		 		|Comments							|
+|---					|---					|---								|
+|Audio (audio)   	| A locally hosted audio file.  	| This is Drupal's built-in Audio media type. Islandora Defaults overwrites the field storage so that it is not actually a locally hosted file. The description is misleading.	|


True, but instead of documenting how it's misleading here, we should update the description as a follow up task so we no longer have to point that out.

Addressed by Islandora/islandora_defaults#45

dannylamb · 2021-01-13T14:18:13Z

docs/reference/islandora_defaults_reference.md

+|---					|---					|---								|
+|Audio (audio)   	| A locally hosted audio file.  	| This is Drupal's built-in Audio media type. Islandora Defaults overwrites the field storage so that it is not actually a locally hosted file. The description is misleading.	|
+|Document (document) 	| An uploaded file or document, such as a PDF.		| This is Drupal's built-in Document media type. Islandora Defaults overwrites the field storage so that it is not actually a locally hosted file. The description is misleading.|
+|File (file)		| Use local files for reusable media.			||


Missing a description here

dannylamb · 2021-01-13T15:44:37Z

docs/reference/islandora_defaults_reference.md

+
+|Name			|Description		|Comments			|
+|---			|---			|---				|
+|Islandora Access (islandora_access)	|Terms used to limit, restrict or coordinate access	| Not sure if they actually do affect access.	|


Instead of Not sure if they actually do affect access., how about Meant to be used with permissions_by_term. The vocabulary is unpopulated by default.

Sounds good.

dannylamb · 2021-01-13T15:46:47Z

docs/reference/islandora_defaults_reference.md

+|Name			|Description		|Comments			|
+|---			|---			|---				|
+|Islandora Access (islandora_access)	|Terms used to limit, restrict or coordinate access	| Not sure if they actually do affect access.	|
+|Islandora Display (islandora_display)	|Terms used to alter how a repository item is viewed. ie. basic image vs large image	| Check if/how this gets populated.|


This is populated by a migration that's run during install. Everything comes from this csv https://github.com/Islandora/islandora/blob/8.x-1.x/migrate/tags.csv:

Sweet. thanks.

dannylamb · 2021-01-14T14:35:33Z

docs/reference/islandora_defaults_reference.md

+|Media			|Image			|Default||
+|Media			|Video			|Default||
+|Taxonomy Term		|Islandora Display	|Default||
+|Taxonomy Term		|Islandora Media Use	|Default|This vocabulary is not defined in this module.|


I'd drop the vocabs that aren't defined in defaults or maybe mention that they are defined by the islandora_core_feature

dannylamb · 2021-01-14T14:38:38Z

docs/reference/islandora_defaults_reference.md

+
+### Form Modes
+
+The following "Default" forms are configured. It is unclear how/if these include Islandora-specific choices such as ordering/grouping or form widget configuration.


These default form modes are minimal changes to Drupal's default form modes. The only significant additions are to show widgets for the Islandora specific fields like field_media_use and field_external_uri.

Ah! thank you!

dannylamb · 2021-01-14T14:39:05Z

docs/reference/islandora_defaults_reference.md

+| Content | Binary         |                                                                      |
+| Content | Open Seadragon |                                                                      |
+| Content | PDFjs          |                                                                      |
+| Content | Teaser         | This seems to be a re-definition of the built-in "Teaser" view mode. |


It totally is. You can use firmer language that 'seems to be'.

OK, so why's it here?

I think we just add the shortened "summary" text of the description to the teaser.

dannylamb · 2021-01-14T14:44:12Z

docs/reference/islandora_defaults_reference.md

+| Media   | PDFjs          |                                                                      |
+
+
+The following display modes are configured. It is unclear how/if the "Default", "Source", and "Teaser" display modes include any Islandora-specific choices such as ordering/grouping or display widget configuration. "Media EVAs (display_media)" is a view provided by the Islandora core feature.


The 'source' display modes present just the file. Probably too much to throw at the user now, but that display mode is what's used by the EVA's to show the file.

"Default" is usually our best guess as to what you want to see. Which at this point is just basically everything with little to no formatting.

dannylamb · 2021-01-14T14:52:22Z

docs/reference/islandora_defaults_reference.md

+
+| Type          | Bundle              | Comments |
+|---------------|---------------------|----------|
+| node          | islandora_object    | Do not hide untranslatable fields.          |


What happens if you hide an untranslatable field?

dannylamb · 2021-01-14T15:08:03Z

docs/reference/islandora_defaults_reference.md

+|-----------------------------------------------------|------------------------------------------------|----------------------------------------------------------------------------------------------|--------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
+| IIIF Manifest (iiif_manifest)                       | Generates IIIF manifests for paged content     | REST Export (/node/%node/book-manifest);<br/>REST Export - Single node (/node/%node/manifest) |                                                        |                                                                                                                                  |
+| Members (members)                                   | Displays members for content.                  | Members (block)                                                                              | Show an unformatted list of published nodes that are "Member of" the current node (from URL), formatted as "Teaser"s, paged to 10 items.                                                      |                                                                                                                                  |
+| OpenSeadragon Media EVAs (openseadragon_media_evas) | Displays media for content as EVA's per model. | Original File;<br/>Preservation Master;<br/>Service File | Show 1 Media that is "Media of" the node (from URL) and having Media Use corresponding to each Display (Original file, etc.). The Media is rendered with display mode OpenSeadragon. See media.\*.open_seadragon under "Display Modes." The description's "per model" should read "per media use". Provides the EVA used in the islandora_object.open_seadragon display mode. The Preservation Master and Service File displays are not used. |


That comment's a mouthful. Maybe say "Provides fields to show files using the Openseadragon viewer. Each Media Use gets its own field, so the user can choose between displaying the Original File or a derivative such as the Service File."?

dannylamb · 2021-01-14T15:08:36Z

docs/reference/islandora_defaults_reference.md

+| IIIF Manifest (iiif_manifest)                       | Generates IIIF manifests for paged content     | REST Export (/node/%node/book-manifest);<br/>REST Export - Single node (/node/%node/manifest) |                                                        |                                                                                                                                  |
+| Members (members)                                   | Displays members for content.                  | Members (block)                                                                              | Show an unformatted list of published nodes that are "Member of" the current node (from URL), formatted as "Teaser"s, paged to 10 items.                                                      |                                                                                                                                  |
+| OpenSeadragon Media EVAs (openseadragon_media_evas) | Displays media for content as EVA's per model. | Original File;<br/>Preservation Master;<br/>Service File | Show 1 Media that is "Media of" the node (from URL) and having Media Use corresponding to each Display (Original file, etc.). The Media is rendered with display mode OpenSeadragon. See media.\*.open_seadragon under "Display Modes." The description's "per model" should read "per media use". Provides the EVA used in the islandora_object.open_seadragon display mode. The Preservation Master and Service File displays are not used. |
+| PDFjs Media EVAs (pdfjs_media_evas)                 | Displays media for content as EVA's per model. |  Original File;<br/>Preservation Master;<br/>Service File | Show 1 Media that is "Media of" the node (from URL) and having Media Use corresponding to each Display (Original file, etc.). The Media is rendered with display mode PDFjs. The description's "per model" should read "per media use". Provides the EVA used in the islandora_object.pdfjs display mode. The Preservation Master and Service File displays are not used. |


As above but for pdfjs

dannylamb · 2021-01-14T15:12:09Z

docs/reference/islandora_defaults_reference.md

+## Actions
+| Name | Plugin | Comments|
+|---|---|---|
+| Audio - Generate a service file from an original file (audio_generate_a_service_file_from_an_original_file) | generate_audio_derivative |use the Homarus queue to generate an "audio" media tagged #ServiceFile from the #OriginalFile with mimetype audio/mpeg, using the libmp3lame codec and audio quality 5, and save in the public filesystem in a folder for the year and month.  |


First word of the comments need to be capitalized.

dannylamb · 2021-01-14T15:14:57Z

docs/reference/islandora_defaults_reference.md

+|resource_types|"Text"|"A resource consisting primarily of words for reading"|http://purl.org/dc/dcmitype/Text|
+
+
+core.base_field_override.node.islandora_object.changed.yml


I dunno about these things. They're just auto-provided by Drupal because we configure these fields settings.

dannylamb · 2021-01-14T15:15:22Z

docs/reference/islandora_defaults_reference.md

+
+## User Roles
+
+The role fedoraadmin (machine name: `fedoraadmin`) is defined.


Maybe add a big warning here that you need this role to put stuff in fedora.

dannylamb · 2021-01-14T15:16:25Z

docs/reference/islandora_defaults_reference.md

+
+## Fields
+
+This is at the end of this document because it's not particularly useful yet - there's so much information it's not clear what needs to be here.


Maybe you don't need to list out every field setting. The new fields are definitely important. The field storage basically covers all the new fields.

dannylamb · 2021-01-14T15:16:51Z

docs/reference/islandora_defaults_reference.md

+- field.storage.media.field_access_terms.yml
+
+
+### Overrides of core fields (?)


Yeah, I dunno either. I probably wouldn't bother with these.

dannylamb · 2021-01-14T15:18:42Z

Whelp, left a brain dump for ya @rosiel. Hopefully some of that's useful.

manez · 2021-02-24T16:18:40Z

Determined in the Feb 23 DIG meeting that this is good to go 👍

List config in Islandora Defaults.

facb371

eldonquijote reviewed Dec 5, 2020

View reviewed changes

docs/reference/islandora_defaults_reference.md Show resolved Hide resolved

eldonquijote reviewed Dec 5, 2020

View reviewed changes

docs/reference/islandora_defaults_reference.md Show resolved Hide resolved

include links to glossary.

dc48110

dannylamb reviewed Jan 13, 2021

View reviewed changes

dannylamb reviewed Jan 14, 2021

View reviewed changes

dannylamb merged commit 585001d into Islandora:main Feb 24, 2021

rosiel deleted the islandora-defaults branch December 10, 2022 19:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

List config in Islandora Defaults. #1721

List config in Islandora Defaults. #1721

rosiel commented Dec 3, 2020 •

edited

Loading

dannylamb Jan 13, 2021

rosiel Jan 25, 2021

dannylamb Jan 13, 2021

dannylamb Jan 13, 2021

rosiel Jan 14, 2021

dannylamb Jan 13, 2021

rosiel Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

rosiel Jan 14, 2021

dannylamb Jan 14, 2021 •

edited

Loading

rosiel Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb Jan 14, 2021

dannylamb commented Jan 14, 2021

manez commented Feb 24, 2021


		### Form Modes

		The following "Default" forms are configured. It is unclear how/if these include Islandora-specific choices such as ordering/grouping or form widget configuration.

		\| Media \| PDFjs \| \|


		The following display modes are configured. It is unclear how/if the "Default", "Source", and "Teaser" display modes include any Islandora-specific choices such as ordering/grouping or display widget configuration. "Media EVAs (display_media)" is a view provided by the Islandora core feature.

		\|resource_types\|"Text"\|"A resource consisting primarily of words for reading"\|http://purl.org/dc/dcmitype/Text\|


		core.base_field_override.node.islandora_object.changed.yml


		## User Roles

		The role fedoraadmin (machine name: `fedoraadmin`) is defined.


		## Fields

		This is at the end of this document because it's not particularly useful yet - there's so much information it's not clear what needs to be here.

		- field.storage.media.field_access_terms.yml


		### Overrides of core fields (?)

List config in Islandora Defaults. #1721

List config in Islandora Defaults. #1721

Conversation

rosiel commented Dec 3, 2020 • edited Loading

Purpose / why

What changes were made?

Verification

Interested Parties

@dannylamb @Islandora/documentation

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dannylamb Jan 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dannylamb commented Jan 14, 2021

manez commented Feb 24, 2021

rosiel commented Dec 3, 2020 •

edited

Loading

dannylamb Jan 14, 2021 •

edited

Loading