starred/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-05-30 23:40:40 +02:00
Code Issues 1.0k Packages Projects Releases 10 Wiki Activity

[Enhancement]: Allow ebooks to be marked as a supplement #1058

New Issue
Closed
opened 2026-04-24 23:30:32 +02:00 by adam · 9 comments
adam commented 2026-04-24 23:30:32 +02:00
Owner
Copy Link
Copy Source

Originally created by @divyang-joshi on GitHub (Apr 11, 2023).

Describe the feature/enhancement

ATM, for a library item with an ebook attached to it, you'll simply see "Read". There's 2 problems:

  1. Sometimes audiobooks come with supplementary material in the format of ebooks. This is not the same thing as the actual ebook version of it.
  2. Users will assume "Read" implies reading the actual ebook version of the audiobook.

Proposal:

Add a library wide setting to mark ebooks as supplements. For now, that will simply change the text from "Read" to "Supplement".

This reduces confusion for something like my use case where I'll have a different library for the ebooks vs audiobooks.

I'm new to Vue so going to explore a bit before opening a PR (and of course see if there's better ideas). Here's what I have so far:

Screenshot 2023-04-10 at 11 08 51 PM Screenshot 2023-04-10 at 11 10 19 PM
Originally created by @divyang-joshi on GitHub (Apr 11, 2023). ### Describe the feature/enhancement ATM, for a library item with an ebook attached to it, you'll simply see "Read". There's 2 problems: 1. Sometimes audiobooks come with supplementary material in the format of ebooks. This is not the same thing as the actual ebook version of it. 2. Users will assume "Read" implies reading the actual ebook version of the audiobook. Proposal: Add a library wide setting to mark ebooks as supplements. For now, that will simply change the text from "Read" to "Supplement". This reduces confusion for something like my use case where I'll have a different library for the ebooks vs audiobooks. I'm new to Vue so going to explore a bit before opening a PR (and of course see if there's better ideas). Here's what I have so far: <img width="717" alt="Screenshot 2023-04-10 at 11 08 51 PM" src="https://user-images.githubusercontent.com/4261609/231046146-257f1ec9-eb99-4cdc-8c8e-b0292c05ef9e.png"> <img width="557" alt="Screenshot 2023-04-10 at 11 10 19 PM" src="https://user-images.githubusercontent.com/4261609/231046355-de7c9949-da30-4056-9add-418755112c6b.png">
adam added the enhancement label 2026-04-24 23:30:32 +02:00
adam closed this issue 2026-04-24 23:30:32 +02:00
adam commented 2026-04-24 23:30:33 +02:00
Author
Owner
Copy Link
Copy Source

@advplyr commented on GitHub (Apr 11, 2023):

What about if we have an ebook that has supplementary material?
What about if we have multiple files that are supplementary?

One thing I had a while back was a read button in the library files table so you could have multiple ebook files and be able to read them.
image

Maybe we have some way to mark an ebook as supplementary?

There is another feature request open that comes down to the user doesn't want ebooks to show at all. If we had a library setting like "Audiobooks only" then we automatically treat any extra ebook files as supplementary. This would solve both cases.

Just throwing some thoughts out there

@advplyr commented on GitHub (Apr 11, 2023): What about if we have an ebook that has supplementary material? What about if we have multiple files that are supplementary? One thing I had a while back was a read button in the library files table so you could have multiple ebook files and be able to read them. ![image](https://user-images.githubusercontent.com/67830747/231199080-7a033bc3-d37d-4dd5-977b-9fe301d2db85.png) Maybe we have some way to mark an ebook as supplementary? There is another feature request open that comes down to the user doesn't want ebooks to show at all. If we had a library setting like "Audiobooks only" then we automatically treat any extra ebook files as supplementary. This would solve both cases. Just throwing some thoughts out there
adam commented 2026-04-24 23:30:36 +02:00
Author
Owner
Copy Link
Copy Source

@divyang-joshi commented on GitHub (Apr 11, 2023):

What about if we have an ebook that has supplementary material?

Yea, I considered that, and it took me down the path you described right after -- mark each individual file as supplementary. Problem is it becomes tricky since I wasn't sure how to consider something as a "main item". How do we update the UI to differentiate reading the main thing vs supp. Or what happens if some mp3 is tagged is supplement but in reality its a chapter. How does file scanning get affected by this. Etc. Lots of questions 😅

Don't have answers since I'm still in the process of understanding the source code, and don't want to blindly do something. Could limit it to just epub, pdf, mobi, etc first as well, and not worry about some of those questions above. I can definitely see this as an improvement to make in the future.

What about if we have multiple files that are supplementary?

How do we currently handle multiple files (say on an audiobook item)? From a quick look it seems it picks the first file from the list and shows that reader. So regardless of the changes here, wouldn't we need to add better support for multiple files (like your idea around read button on the files table) first? I see that as a different feature 🤷🏽‍♂️ One that could affect what is done here when complete though.

There is another feature request open that comes down to the user doesn't want ebooks to show at all. If we had a library setting like "Audiobooks only" then we automatically treat any extra ebook files as supplementary. This would solve both cases.

Hmm, so assuming we don't want a new type (instead of just "book"), I'm guessing you mean if there's no audio tracks, hide the item everywhere (including under home and series)? Yea, I could look into that. Can you link me the issue if you have it handy?

I'm curious if there's a need for hiding, but not marking attached as supplements. For example if I only want to show the item if the audiobook has been added, but the attached ebook is the text version of that book. This way one could start adding their ebooks while they wait on the audiobook.

@divyang-joshi commented on GitHub (Apr 11, 2023): > What about if we have an ebook that has supplementary material? Yea, I considered that, and it took me down the path you described right after -- mark each individual file as supplementary. Problem is it becomes tricky since I wasn't sure how to consider something as a "main item". How do we update the UI to differentiate reading the main thing vs supp. Or what happens if some mp3 is tagged is supplement but in reality its a chapter. How does file scanning get affected by this. Etc. Lots of questions 😅 Don't have answers since I'm still in the process of understanding the source code, and don't want to blindly do something. Could limit it to just epub, pdf, mobi, etc first as well, and not worry about some of those questions above. I can definitely see this as an improvement to make in the future. > What about if we have multiple files that are supplementary? How do we currently handle multiple files (say on an audiobook item)? From a quick look it seems it picks the first file from the list and shows that reader. So regardless of the changes here, wouldn't we need to add better support for multiple files (like your idea around read button on the files table) first? I see that as a different feature 🤷🏽‍♂️ One that could affect what is done here when complete though. > There is another feature request open that comes down to the user doesn't want ebooks to show at all. If we had a library setting like "Audiobooks only" then we automatically treat any extra ebook files as supplementary. This would solve both cases. Hmm, so assuming we don't want a new type (instead of just "book"), I'm guessing you mean if there's no audio tracks, hide the item everywhere (including under home and series)? Yea, I could look into that. Can you link me the issue if you have it handy? I'm curious if there's a need for hiding, but not marking attached as supplements. For example if I only want to show the item if the audiobook has been added, but the attached ebook is the text version of that book. This way one could start adding their ebooks while they wait on the audiobook.
adam commented 2026-04-24 23:30:38 +02:00
Author
Owner
Copy Link
Copy Source

@advplyr commented on GitHub (Apr 12, 2023):

If there are multiple ebook files found then it will take the first one and create an EbookFile which gets stored on the Book object.

All the other ebook files just remain in the library files array on the LibraryItem. Basically any ebook file that is not an EbookFile attached to the book would be supplementary, if that makes sense. So, I don't think we would actually need a flag for it to be supplementary or not.

The ebook file that was actually created as an ebook could be marked as supplementary by just removing it from the Book. In that case maybe we would allow you to set an ebook file as the actual ebook if there isn't one already. That would solve the case where Abs marked the wrong ebook file as the ebook.

As I was typing this I realized it probably wouldn't make much sense so I think I'll have to put something together to show what I mean.

@advplyr commented on GitHub (Apr 12, 2023): If there are multiple ebook files found then it will take the first one and create an `EbookFile` which gets stored on the `Book` object. All the other ebook files just remain in the library files array on the `LibraryItem`. Basically any ebook file that is not an `EbookFile` attached to the book would be supplementary, if that makes sense. So, I don't think we would actually need a flag for it to be supplementary or not. The ebook file that was actually created as an ebook could be marked as supplementary by just removing it from the `Book`. In that case maybe we would allow you to set an ebook file as the actual ebook if there isn't one already. That would solve the case where Abs marked the wrong ebook file as the ebook. As I was typing this I realized it probably wouldn't make much sense so I think I'll have to put something together to show what I mean.
adam commented 2026-04-24 23:30:41 +02:00
Author
Owner
Copy Link
Copy Source

@divyang-joshi commented on GitHub (Apr 12, 2023):

Ah, I see. I think I'm getting the gist of it. I'll wait on working on this in the meantime then. Will continue to play with the code in the meantime to get a better understanding. Thanks :) Worst case, the change I had is simple and we can always fallback on that.

@divyang-joshi commented on GitHub (Apr 12, 2023): Ah, I see. I think I'm getting the gist of it. I'll wait on working on this in the meantime then. Will continue to play with the code in the meantime to get a better understanding. Thanks :) Worst case, the change I had is simple and we can always fallback on that.
adam commented 2026-04-24 23:30:42 +02:00
Author
Owner
Copy Link
Copy Source

@KK4BitsPerSecond commented on GitHub (May 18, 2023):

Support for supplements in the audiobook library would be nice.

I have many audiobooks that came with PDFs of things like world maps and illustrations that I would love if I could access from the book in the audiobook library.

@KK4BitsPerSecond commented on GitHub (May 18, 2023): Support for supplements in the audiobook library would be nice. I have many audiobooks that came with PDFs of things like world maps and illustrations that I would love if I could access from the book in the audiobook library.
adam commented 2026-04-24 23:30:42 +02:00
Author
Owner
Copy Link
Copy Source

@advplyr commented on GitHub (Jun 11, 2023):

Added in v2.2.23

There was a lot here so I put it in a guide https://www.audiobookshelf.org/guides/ebooks

@advplyr commented on GitHub (Jun 11, 2023): Added in [v2.2.23](https://github.com/advplyr/audiobookshelf/releases/tag/v2.2.23) There was a lot here so I put it in a guide https://www.audiobookshelf.org/guides/ebooks
adam commented 2026-04-24 23:30:43 +02:00
Author
Owner
Copy Link
Copy Source

@skyzuma commented on GitHub (Jun 11, 2023):

perfect option !

the "problem" is, the entire book (audio / eBook)will display on deck but i can only play the audiobook (play button) ... maybe if is possible make 2 decks ? 1 for audiobook if played and 1 for eBook if read? or make playbutton twice (if played) like play audio book (play button) / read book (read button)?

edit: if i look into the book i see only one progress and i cant see for what the progress stands for

edit1: maybe its possible and logical make the progres info under the relevant button? if i played the audiobook > progress under the play button and if i read the book make progress info under the read button ... idk how it works in the mobile app ...

edit2: if i add an ebook (only), abs in reading the foldername (ebook) as title in the edit modal instead of the epub filename and the first part of the ebook file for the author ...

i managed my ebook in an seperate folder:

abook

  • author
    • series
      • Volume
        • files
      • ebook
        • files

edit2.1 ... ok, that was my fault (?) ... if an audiobook is there and i add an ebook, abs will add this without any problems (any name) ... but if i add an ebook without an audiobook (i have only the ebook and the audiobook comes later or its not available) i need to name the ebook like the dokumenation "Vol X - Volumename" > so now abs can read it correctly in the edit modal ...

edit:3: delete an ebook (any) > abs will delete this from the system ... not like the standard: delete from abs / delete from system too ... there is no choise ...

@skyzuma commented on GitHub (Jun 11, 2023): perfect option ! the "problem" is, the entire book (audio / eBook)will display on deck but i can only play the audiobook (play button) ... maybe if is possible make 2 decks ? 1 for audiobook if played and 1 for eBook if read? or make playbutton twice (if played) like play audio book (play button) / read book (read button)? edit: if i look into the book i see only **one** progress and i cant see for what the progress stands for edit1: maybe its possible and logical make the progres info under the relevant button? if i played the audiobook > progress under the play button and if i read the book make progress info under the read button ... idk how it works in the mobile app ... edit2: if i add an ebook (only), abs in reading the foldername (ebook) as title in the edit modal instead of the epub filename and the first part of the ebook file for the author ... i managed my ebook in an seperate folder: abook - author - - series - - - Volume - - - - files - - - ebook - - - - files edit2.1 ... ok, that was my fault (?) ... if an audiobook is there and i add an ebook, abs will add this without any problems (any name) ... but if i add an ebook without an audiobook (i have only the ebook and the audiobook comes later or its not available) i need to name the ebook like the dokumenation "Vol X - Volumename" > so now abs can read it correctly in the edit modal ... edit:3: delete an ebook (any) > abs will delete this from the system ... not like the standard: delete from abs / delete from system too ... there is no choise ...
adam commented 2026-04-24 23:30:44 +02:00
Author
Owner
Copy Link
Copy Source

@skyzuma commented on GitHub (Jun 15, 2023):

idk how github handle (re)edits and give every edit an notification or only once on its create ... have u read all the edits ? @advplyr

@skyzuma commented on GitHub (Jun 15, 2023): idk how github handle (re)edits and give every edit an notification or only once on its create ... have u read all the edits ? @advplyr
adam commented 2026-04-24 23:30:45 +02:00
Author
Owner
Copy Link
Copy Source

@advplyr commented on GitHub (Jun 15, 2023):

Yes you can't just remove the ebook from Abs only. If you want to remove the ebook then manually move it out of the audiobook folder.

@advplyr commented on GitHub (Jun 15, 2023): Yes you can't just remove the ebook from Abs only. If you want to remove the ebook then manually move it out of the audiobook folder.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
authentication
backlog
bug
chapter editor
config-issue
ebooks
encoding/embedding
enhancement
help wanted
listening sessions & progress
planned
possible plugin
progress sync
pull-request
Mirrored from GitHub Pull Request
 sorting/filtering/searching
unable to reproduce
upload
users & permissions
waiting
No Label enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#1058
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?