Updated conversion tables

Kareadita · Mar 9, 2024 · d8bfb0b · d8bfb0b
1 parent d21de6d
commit d8bfb0b
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 5 deletions.
diff --git a/pages/guides/metadata/comics.mdx b/pages/guides/metadata/comics.mdx
@@ -17,11 +17,10 @@ The XML schema of this file can be found in the [Anansi Project webpage](https:/
 | [`LocalizedSeries`](/guides/metadata/comics#non-standard-tags)                                 | →  | Localized Name                                                                 |
 | `Series` or [`SeriesSort`](/guides/metadata/comics#non-standard-tags)                          | →  | Name                                                                           |
 | `Number`                                                                                       | →  | Issue/Chapter number                                                           |
-| [`Count`](/guides/metadata/comics#count)                                                       | →  | Publication Status               |
+| [`Count`](/guides/metadata/comics#count)                                                       | →  | Publication Status                                                             |
 | `Volume`                                                                                       | →  | Volume                                                                         |
 | `Summary`                                                                                      | →  | Summary                                                                        |
-| `Writer`                                                                                       | →  | Writers                                                                        |
-| `Publisher`                                                                                    | →  | Publisher                                                                      |
+| `Publisher`, `Imprint`                                                                         | →  | Publisher, Imprint                                                                      |
 | `Year`, `Month`, `Day`                                                                         | →  | Release Date ([Release Year](/guides/metadata/comics#release-year) for series) |
 | `Summary`                                                                                      | →  | Series Summary from first issue/chapter Issue/Chapter Summary                  |
 | `Writer`, `Penciller`, `Inker`, `Colorist`, `Letterer`, `Cover Artist`, `Editor`, `Translator` | →  | Writer, Penciller, Inker, Colorist, Letterer, Cover Artist, Editor, Translator |

diff --git a/pages/guides/metadata/epubs.mdx b/pages/guides/metadata/epubs.mdx
@@ -2,3 +2,67 @@ EPUB files do not have a ComicInfo.xml, but they do have some limited metadata i
 See the table above to know what tags do kavita read from the OPF file
 
 ! **Note:** OPF metadata files must be **inside** the `.epub` file, or it won't be read.  
+
+
+## OPF
+
+### Conversion table
+
+| In OPF                                                                                         | Is | Equivalent In Kavita                                                           |
+|------------------------------------------------------------------------------------------------|----|--------------------------------------------------------------------------------|
+| `dc:title` (this can be overridden by `calibre:series` or `belongs-to-collection` meta)        | →  | Chapter Title                                                                  |
+| `calibre:series`                                                                               | →  | Name                                                                           |
+| `calibre:series_index`                                                                         | →  | Volume                                                                         |
+| `dc:description`                                                                               | →  | Summary                                                                        |
+| `dc:publisher`                                                                                 | →  | Publisher                                                                      |
+| `Year`, `Month`, `Day`                                                                         | →  | Release Date ([Release Year](/guides/metadata/comics#release-year) for series) |
+| `Summary`                                                                                      | →  | Series Summary from first issue/chapter Issue/Chapter Summary                  |
+| `dc:creator`,                                                                                  | →  | Writer                                                                         |
+| `dc:subject`                                                                                   | →  | Genres                                                                         |
+| `dc:language`                                                                                  | →  | Language (Kavita will only take the first)                                     |
+| `dc:identifier opf:scheme="isbn`                                                               | →  | ISBN                                                                           |
+
+
+### Expanding People Metadata
+In an epub (Kavita v0.7.3+), you can expand on people with not just author and publisher mappings, but can support the following:
+* art/artist
+* aut/author
+* pbl/publisher
+* trl/translator
+* edt/editor
+* ill/illustrator
+* clr/colorist
+
+In order to achieve this, you must refine the existing `dc:creator` tag with a `meta` tag. Both must exist otherwise the creator will be treated just as an author. See below, we are going to define that there is an editor:
+```
+<dc:creator id="id-1">Miya Kazuki</dc:creator>
+<meta refines="#id-1" property="role" scheme="marc:relators">editor</meta>
+```
+### Reading Lists and Collections
+For libraries that are allowed to manage collections and reading lists (and Kavita v0.7.3+), Kavita can utilize epub metadata fields for this.
+
+In the following example, we have just a single title here and the meta tag to refine this title and indicate that it is used for a collection. With just this, Kavita will generate a `Collection` tag.
+```
+<dc:title id="t1">A Dictionary of Modern English Usage</dc:title>
+<meta refines="#t1" property="title-type">collection</meta>
+```
+
+If you add an additional tag of `display-seq` then Kavita will treat the collection as a reading list and generate the reading list with the following order. Note that if you have conflicts, Kavita will automatically reorder, so order may be skewed. 
+```
+<meta refined="#t1" property="display-seq">1</meta>
+```
+
+### Grouping Series
+Some books belong together, like in the example, Harry Potter. Sure, we can have each book as it's own series, but sometimes it's better to group them under one series. The ideal way to perform this grouping is by using `calibre:series` and `calibre:series_index` or `belongs-to-collection` and `group-position` for Epub 3.2 files. In the following, we can have our 2 harry potter books grouped together as one single Harry Potter Series (I am using Epub 2 for the first and Epub 3+ for the second):
+
+```
+<dc:title id="id">Harry Potter and the Philosopher's Stone</dc:title>
+<meta name="calibre:series">Harry Potter</meta>
+<meta name="calibre:series_index">1</meta>
+```
+
+```
+<dc:title id="id">Harry Potter and the Chamber of Secrets</dc:title>
+<meta property="belongs-to-collection" id="id-5">Harry Potter</meta>
+<meta refines="#id-5" property="group-position">2</meta>
+```
diff --git a/pages/guides/metadata/general.mdx b/pages/guides/metadata/general.mdx
@@ -1,9 +1,9 @@
 # General Metadata Information
 Kavita uses metadata to parse Series Name, Volumes, Chapters, Special Status, etc... 
 
-Kavita reads metadata from within your .cb* archives (cbz, cbr, cb7, cbt) and epubs. If your archives contain a comicinfo.xml at the root, or if your epub contains an embedded .opf file, it will override any parsed information from the filename
+Kavita reads metadata from within your .cb* archives (cbz, cbr, cb7, cbt) and epubs. If your archives contain a comicinfo.xml at the root, or if your epub contains an embedded .opf file, it will override any parsed information from the filename.
 
-You can find multiple tools to add metadata under [External Tools](/guides/external-tools/mangamanager)
+You can find multiple tools to add metadata under [External Tools](/guides/external-tools/mangamanager).
 
 ### Metadata Tag Conversion
 Below is an example showing how common tags are used in Kavita. More complete documentation can be found in their respective pages.