Bug 37367

Summary: OAI documentation missing options
Product: Koha Reporter: Tomás Cohen Arazi (tcohen) <tomascohen>
Component: DocumentationAssignee: Bugs List <koha-bugs>
Status: RESOLVED FIXED QA Contact: Testopia <testopia>
Severity: enhancement    
Priority: P5 - low CC: aude.charillon, caroline.cyr-la-rose, philip.orr, tomascohen
Version: unspecified   
Hardware: All   
OS: All   
Change sponsored?: --- Patch complexity: ---
Documentation contact: Caroline Cyr La Rose Documentation submission: https://gitlab.com/koha-community/koha-manual/-/merge_requests/902
Text to go in the release notes:
Version(s) released in:
Circulation function:
Bug Depends on: 26195    
Bug Blocks:    

Description Tomás Cohen Arazi (tcohen) 2024-07-15 18:25:16 UTC 
The OAI documentation is lacking information about the `extended mode` configuration using the `OAI-PMH:ConfFile` syspref.

In my opinion, the following configuration options should be explained in more detail:

* xsl_file (present in the sample config, no explanation)
* include_items (present in the sample config, no explanation)
* expanded_avs (missing from sample config)

This is what I'd say (being a non-native english speaker):

* xsl_file: Path to an XSLT file that will be used for transforming the Koha MARCXML data into the needed structure/format. It can be useful, for example, if you need some specific Dublin Core fields to be generated instead of just the default ones.

* include_items: If set to 1, item information will be included in the response according to the MARC framework's mapping.

* expanded_avs: If set to 1, all coded values will the expanded with descriptions. This includes: library/branch names, item type descriptions, authorized value descriptions and classification source descriptions.

All this options could be used with different metadataPrefix entries, allowing the consumers to request one or the other.