-
Notifications
You must be signed in to change notification settings - Fork 71
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
Conversation
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
|
||
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Feedback incorporated. |
@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. |
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
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?
OAI-DC Metadata Format/Metadata Mappings
andCreating additional metadata formats
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