Skip to content

Commit a74b75e

Browse files
authored
Combine books and comics (#1320)
* Add redesign notice * move comic info into books.md * add redirect from comic to books * add some more info * add info about audiobooks * adjust examples * fix spelling * feedback
1 parent 7f64217 commit a74b75e

File tree

3 files changed

+49
-104
lines changed

3 files changed

+49
-104
lines changed

Diff for: docs/general/server/media/books.md

+44-34
Original file line numberDiff line numberDiff line change
@@ -5,51 +5,61 @@ title: Books
55

66
# Books
77

8-
The most common organization scheme for books is separation by Audiobook then by Author.
8+
The bookshelf plugin is required for books libraries.
9+
10+
Books should be organized by type (Audiobooks, Books, Comics), then optionally by Author. Each book should be in their own folder.
911

1012
```txt
1113
Books
1214
├── Audiobooks
1315
│ ├── Author
14-
│ │ ├── Book1.flac
15-
│ │ └── Book2.flac
16-
│ └── Book
17-
│ ├── Chapter1.flac
18-
│ └── Chapter2.flac
19-
└── Books
20-
└── Author
21-
├── Book1.epub
22-
├── Book2.epub
23-
├── Book
24-
│ ├── Book1.epub
25-
│ ├── cover.ext
26-
│ └── metadata.opf
27-
└── Book3.mp3
16+
│ │ ├── Book1
17+
│ │ │ └── Book1.flac
18+
│ │ └── Book2
19+
│ │ └── Book2.mp3
20+
│ └── Book3
21+
│ ├── Book3.aac
22+
│ ├── content.opf
23+
│ └── cover.jpg
24+
├── Books
25+
│ └── Author
26+
│ ├── Book4
27+
│ │ └── Book4.epub
28+
│ ├── Book5
29+
│ │ └── Book5.epub
30+
│ ├── Book6
31+
│ │ ├── Book6.epub
32+
│ │ ├── cover.png
33+
│ │ └── metadata.opf
34+
│ └── Book7
35+
│ └── Book7.pdf
36+
└── Comics
37+
├── Plastic Man (1944)
38+
│ └── Plastic Man #002 (1944).cbz
39+
├── Attack on Titan (2012)
40+
│ └── Attack on Titan #001 (2012).pdf
41+
└── Comic (2008)
42+
├── ComicInfo.xml
43+
└── Comic #001 (2008).cbr
2844
```
2945

30-
File extensions supported include azw, azw3, cb7, cbr, cbt, cbz, epub, mobi, and pdf.
31-
32-
## Local Metadata
33-
34-
In case the book is stored in the epub format, internal metadata can be provided. For every other format, metadata has to be provided externally in a `content.opf` or `metadata.opf` file. When multiple books have been published by the same author, it is recommended to place each book into a seperate folder. This allows to provide local metadata for every book.
35-
36-
Either the `content.opf` or the `metadata.opf` file can tell Jellyfin which file should be used for the books cover. Usually, this is the `cover.ext` file. The abbreviation `ext` stands for extension, e.g. `.png` or `.jpg`.
37-
38-
## Primary
46+
For audiobooks, most common audio extensions are supported. For other books, the following formats are supported: azw, azw3, cb7, cbr, cbt, cbz, epub, mobi, pdf, zip, rar, 7z. Read-along audiobooks are not supported by Jellyfin.
3947

40-
* folder
41-
* poster
42-
* cover
48+
## Metadata
4349

44-
## Banner
50+
Online metadata is not supported for the books library type.
4551

46-
* banner
52+
For media in audio formats, the metadata is read from the embedded tags of the audio files. FLAC files with WebP embedded images or ID3 tags might fail to play on some browsers. Enable the `Always remux flac option` in the settings if you are experiencing this problem.
4753

48-
## Logo
54+
For books in epub format, embedded metadata can be provided, For other formats, the metadata has to be provided in an external `content.opf`, `metadata.opf` or `ComicInfo.xml` file. The ComicInfo (from ComicRack) and ComicBookInfo (from ComicBookLover) formats are supported for `ComicInfo.xml` files.
4955

50-
* logo
56+
Additionally, information about year and issue number can be provided in the file names, as seen in the example above. For comics or magazines with issues across multiple years, the year of the first issue should be used.
5157

52-
## Thumb
58+
The files above can contain info about what images to use for cover images. Alternatively, They can be provided as external image files named in a specific manner, as listed below.
5359

54-
* thumb
55-
* landscape
60+
| Type | Names |
61+
| ------- | --------------------------- |
62+
| Primary | `folder`, `poster`, `cover` |
63+
| Banner | `banner` |
64+
| Logo | `logo` |
65+
| Thumb | `thumb`, `landscape` |

Diff for: docs/general/server/media/comics.md

-70
This file was deleted.

Diff for: redirects.ts

+5
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ const redirects: ClientRedirects.Options['redirects'] = [
4747
{
4848
from: '/docs/general/server/media/internet-radio',
4949
to: '/docs/general/server/live-tv/internet-radio'
50+
},
51+
// Merge comic and books
52+
{
53+
from: '/docs/general/server/media/comics',
54+
to: '/docs/general/server/media/books'
5055
}
5156
];
5257
export default redirects;

0 commit comments

Comments
 (0)