Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add/clarify OAI-PMH documentation #2059

Merged
merged 2 commits into from
Mar 10, 2022
Merged

Add/clarify OAI-PMH documentation #2059

merged 2 commits into from
Mar 10, 2022

Conversation

kspurgin
Copy link
Contributor

@kspurgin kspurgin commented Mar 9, 2022

Purpose / why

Reading the OAI-PMH documentation page yesterday did not answer a couple of questions I had. I asked those questions in Slack. After seeing the answers in Slack, I realized part of the answers were implicit in the existing documentation page, but not really clear if you are coming to this fresh.

What changes were made?

  • Adds two new sections to the OAI-PMH doc page: OAI-DC Metadata Format/Metadata Mappings and Creating additional metadata formats
  • Reorganizes some of the existing documentation content into these two sections, and adds some additional information to them
  • Clarifies that the "OAI Dublin Core (RDF Mapping)" you see in the OAI config is not a separate RDF mapping
  • Adds link to example metadata format plugin

Verification??

These edits are based on responses from @seth-shaw-unlv and @jordandukart in Slack (here and here(thread)

They may wish to verify I have not misrepresented their responses in working them into the documentation page.

Interested Parties

@Islandora/documentation

Checklist

Pull-request reviewer should ensure the following

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?

@seth-shaw-unlv
Copy link
Contributor

The note about creating a profile via the twig templating system predates the metadata map plugins; I would scratch that. I would also move the note about the metatag plugin into the "OAI-DC Metadata Format/Metadata Mappings" section as the RDF and Metatag plugins are both ways of getting defining OAI-DC.

docs/user-documentation/oai.md Outdated Show resolved Hide resolved

The [Drupal rest_oai_pmh module's DefaultMap plugin](https://git.drupalcode.org/project/rest_oai_pmh/-/blob/2.0.x/src/Plugin/OaiMetadataMap/DefaultMap.php) provides a basic model to follow for creating a plugin.

Exact implementation of your plugin will depend on your data model. If your data model uses anything like Typed Relation field types, Paragraphs, or other complex nested entity modeling, you will need to add custom logic to build the values to emit via OAI-PMH for those fields.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure the best way to present / convey this for documentation but a lot of the default rest_oai_pmh conventions expect a very flat render array style of fields to be returned when implementing transformRecord() unless you are really going to go off the beaten path with introducing a custom twig template or build method.

Guess tl;dring the above would be the default processes expect a flat array of fields to be returned?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think anyone with any experience writing any code for Islandora will get the drift. I feel like I even ran into this basic idea writing field display stuff for I7. Tweaked the wording a bit.

@kspurgin
Copy link
Contributor Author

kspurgin commented Mar 9, 2022

Feedback incorporated.

@ysuarez
Copy link
Contributor

ysuarez commented Mar 9, 2022

@kspurgin, speaking on behalf of DIG, are you planning on making changes do this PR, are you waiting for someone to review, or do you need any help from DIG to get this merged into the documentation? Just trying to help. Thanks in advance.

@kspurgin
Copy link
Contributor Author

kspurgin commented Mar 9, 2022

Thanks for checking in, @ysuarez.

I don't plan on making any more changes unless further changes are requested. I believe I incorporated all existing feedback from @seth-shaw-unlv and @jordandukart

Copy link
Contributor

@seth-shaw-unlv seth-shaw-unlv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@eldonquijote eldonquijote merged commit b99261a into Islandora:main Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants