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

[Enhancement]: Add an Example .opf File to the Documentation #54

Open
torchyboy opened this issue Jan 5, 2023 · 3 comments
Open

[Enhancement]: Add an Example .opf File to the Documentation #54

torchyboy opened this issue Jan 5, 2023 · 3 comments
Labels
enhancement New feature or request

Comments

@torchyboy
Copy link

torchyboy commented Jan 5, 2023

Describe the feature/enhancement

Add an example .opf file to the documentation section on Additional Metadata. Proposal attached (includes subtitle and asin elements which will be in the next release.

Note: the app supports multiple series / volumeNumber elements, however, when they are read in from a .opf file each one overwrites the previous.

@torchyboy torchyboy added the enhancement New feature or request label Jan 5, 2023
@advplyr
Copy link
Collaborator

advplyr commented Jan 7, 2023

Is this very large that it needs a zip? Can you put the example OPF text here in the issue?

@torchyboy
Copy link
Author

torchyboy commented Jan 7, 2023

<?xml version='1.0' encoding='utf-8'?>
<ns0:package xmlns:dc='http://purl.org/dc/elements/1.1/' xmlns:ns0='http://www.idpf.org/2007/opf' unique-identifier='BookId' version='2.0'>
  <ns0:metadata xmlns:dc="http://purl.org/dc/elements/1.1/"
          xmlns:opf="http://www.idpf.org/2007/opf">

<!-- Open Packaging Format (opf) File layout for audiobookshelf -->
<!-- author, narrator, genre series, {series/volume number}, and tag can be repeated as desired -->

    <dc:title></dc:title>
    <dc:subtitle></dc:subtitle>
    <dc:description></dc:description>
    <dc:creator opf:role="aut"></dc:creator>      <!-- author -->
    <dc:creator opf:role="nrt"></dc:creator>      <!-- narrator -->
    <dc:publisher></dc:publisher>
    <dc:date></dc:date>                           <!-- publish year -->
    <dc:language>eng</dc:language>
    <dc:subject></dc:subject>                     <!-- genre -->
    <dc:identifier opf:scheme="ISBN"></dc:identifier>
    <dc:identifier opf:scheme="ASIN"></dc:identifier>
    <ns0:meta name="calibre:series" content="" /> <!-- series -->
    <ns0:meta name="calibre:series_index" content="" /> <!-- volumeNumber -->
    <dc:tag></dc:tag>
  </ns0:metadata> 
</ns0:package>

@WirlyWirly
Copy link

Thanks for this example, I was scratching my head looking for one. Works great, definitely worth linking to one in the site documentation 👍

@advplyr advplyr transferred this issue from advplyr/audiobookshelf Oct 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants