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

Need a little help with the expected structure #2919

Open
Kimbaras opened this issue Apr 26, 2024 · 7 comments
Open

Need a little help with the expected structure #2919

Kimbaras opened this issue Apr 26, 2024 · 7 comments
Labels
support User is needing support on something not working but not confirmed to be a bug

Comments

@Kimbaras
Copy link

What happened?

Not really a "bug" (I think), but could be used to expand the docs?

I believe it's more on the other side of the monitor :D

What did you expect?

A little advice / clarification on how the structure folder / parsing is working.

Kavita Version Number - If you don not see your version number listed, please update Kavita and see if your issue still persists.

0.8.1 - Stable

What operating system is Kavita being hosted from?

None

If the issue is being seen on Desktop, what OS are you running where you see the issue?

None

If the issue is being seen in the UI, what browsers are you seeing the problem on?

No response

If the issue is being seen on Mobile, what OS are you running where you see the issue?

None

If the issue is being seen on the Mobile UI, what browsers are you seeing the problem on?

No response

Relevant log output

No response

Additional Notes

First of all, please excuse me if this is not the best place for such requests (if either prefer this to be a reddit post, on discord or whatever just let me know).

So basically after a couple of days of trying, I need some advice with the expected folder structure as I'm having a little bit of trouble...
For the beginning I'm trying to organize the editions of a tabletop miniature game based on editions (all PDFs files), the current (and wanted) folder structure is:

`
Game (root folder)

First Edition
    Game - Rulebook.pdf
    Game - Book A.pdf
Second Edition
    Game - Rulebook.pdf
    Game - Book A.pdf

`

With this structure (and pointing the Kavita library to "Game (root folder)") I'm getting two series, First Edition and Second Edition (correctly).
Inside each series I get all the books under the "Specials" section / tag.
I wanted to the have books recognized as "books" and not specials, so I tried to rename the files as follow

`
Game (root folder)

First Edition
    Game - Rulebook - vol1.pdf
    Game - Book A - vol2.pdf
Second Edition
    Game - Rulebook - vol1.pdf
    Game - Book A - vol2.pdf

`

But then I loose the two series and I got a series for each book / file.
I'll add few screenshots (sorry for the wall of text / images):

PS: in the first screen "Prima Edizione" means "First Edition", sorry for the Italian

First case described
Game (root folder)
Root-Folder

Books / files with no volume number
books-no-volume

Results in Kavita
result-1
result-2

Second case described
(root folder NOT changed)

Books / files with volume number
books-volumes

Results in Kavita
multiple-series
result-3

So yeah, I don't think I've really understood how Kavita is expeting the files to be named or the folder structure...

Also, side question: on the docs (https://wiki.kavitareader.com/guides/scanner/managefiles) there is a mention on additionals keywords for "Specials", this is related to the names of the files or additionals sections that can be displayed on Kavita UI?

As mentioned, not sure if this is the right place to ask such things, so feel free to point me to the correct place and I'll provide!

Thanks!

@Kimbaras Kimbaras added the needs-triage Needs to be triaged by a developer and assigned a release label Apr 26, 2024
@scare376
Copy link
Collaborator

scare376 commented Apr 26, 2024

so the problem is that kavita doesnt group things based on folder structure. the folder requirements is there to help the scan loop. PDFs rely rather heavy on filename parsing to group things together and only falls back on the folder name if filename parsing fails. You should be able to put the vol marker in the middle instead of the end and it should work (i tested it locally and it worked though it dropped the words betrayal and rulebook)

@Kimbaras
Copy link
Author

so the problem is that kavita doesnt group things based on folder structure. the folder requirements is there to help the scan loop. PDFs rely rather heavy on filename parsing to group things together and only falls back on the folder name if filename parsing fails. You should be able to put the vol marker in the middle instead of the end and it should work (i tested it locally and it worked though it dropped the words betrayal and rulebook)

Can confirm that trick works.
Regarding the dropped words, if I understood the behaviour correctly, there is no way to rename the file from Kavita UI, correct?

Thanks!

@majora2007
Copy link
Member

That is correct. I am investigating and working on improving the PDF parser in this v0.8.x series of releases.

@Kimbaras
Copy link
Author

That is correct. I am investigating and working on improving the PDF parser in this v0.8.x series of releases.

Thanks for the feedback.

At this point, if you could just reply to the last question at the end of my post (which may be a little off-topic for this issue), it would be great.

After this, from my side you may close this one, or if you prefer to keep this open for the future is up to you!

Thanks again!

@majora2007
Copy link
Member

Also, side question: on the docs (https://wiki.kavitareader.com/guides/scanner/managefiles) there is a mention on additionals keywords for "Specials", this is related to the names of the files or additionals sections that can be displayed on Kavita UI?

These are reserved keywords that if found in the filename will cause Kavita to treat it like a special, much like the SP01 marker does. For manga/comics there is a Special tab. For books, unless your books are encoded as Volumes, then you wouldn't see a Special tab.

For comics explicitly there is a different list of what is considered a special:
https://wiki.kavitareader.com/guides/scanner/comic

@majora2007 majora2007 added support User is needing support on something not working but not confirmed to be a bug and removed needs-triage Needs to be triaged by a developer and assigned a release labels Apr 26, 2024
@Kimbaras
Copy link
Author

These are reserved keywords that if found in the filename will cause Kavita to treat it like a special, much like the SP01 marker does. For manga/comics there is a Special tab. For books, unless your books are encoded as Volumes, then you wouldn't see a Special tab.

Uh then there is something not right here...

Please take a look at the fouth image I've posted, the one reading "Prima Edizione" where you can see the "Special" tab with two books in it.
That libray is marked as "Books" in the config.

Based on your comment, that "Specials" tab shouldn't be there... if I did not misuderstand your comment

@majora2007
Copy link
Member

Book library works a bit differently. Books can be encoded as either volumes or specials. PDFs will almost always be specials unless they have explicitly the volume keyword. Epubs can be encoded as volumes if they use the series_index tab or belongs to collection tags.

Hope this helps to clarify.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
support User is needing support on something not working but not confirmed to be a bug
Projects
None yet
Development

No branches or pull requests

3 participants