-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
19 changed files
with
112 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"bookmarks": "Bookmarks", | ||
"filtering": "Filtering", | ||
"readinglists": "Reading Lists", | ||
"relationships": "Relationships", | ||
"librarytypes": "Library Types" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import { Callout } from 'nextra-theme-docs' | ||
|
||
# Bookmarks | ||
|
||
Bookmarks allow you to save individual pages you want to revisit later. They can be accessed from the Bookmarks Library. | ||
|
||
|
||
![bookmark_library](../../../public/guides/features/bookmark_library.png) | ||
|
||
#### Removing Bookmarks | ||
- To remove an individual bookmark, navigate back to the original file (the "View Series" button is useful for this) and remove the bookmark from the page. | ||
- To remove all bookmarks from a series, open the context menu and click "Clear". | ||
|
||
#### Downloading Bookmarks | ||
- Bookmarks can be downloaded from each series' context menu by clicking "Download". | ||
- If you have access to the filesystem, bookmarks can be downloaded from `config/bookmarks/`. The admin can set the location they want to use in the [Media Settings](../admin-settings/media.mdx#bookmarks-directory) tab. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
title: Filtering | ||
--- | ||
|
||
## Metadata Filtering | ||
Kavita has a rich metadata interface which allows you to build complex filters to find exactly what you're looking for. The system allows for you to build a series of statements that AND or OR together with custom sorting and a limit feature for those that have large libraries. | ||
|
||
![new-filtering](../../../public/guides/features/filtering.png) | ||
|
||
### Filter Fields | ||
| Field | Field Type | Description | | ||
| ------ | ----------- |----------- | | ||
| Series Name | String | The Name of the Series | | ||
| Summary | String | The Summary of the Series | | ||
| Path | String | The file path to the highest level of the Series | | ||
| File Path | String | The full file path for any file within the Series (note: this is slower than other fields) | | ||
| Read Time | Number | Number of hours to read the Series | | ||
| Release Year | Number | The Release year of the Series (minimum from all chapters) | | ||
| Read Progress | Number | Decimal percentage of Series that is read by user | | ||
| User Rating | Number | User Rating percentage of Series by user | | ||
| Publication Status | Single/Multi Select | Publication Status of Series (ie Complete, Hiatus, etc) | | ||
| Languages | Single/Multi Select | Language of Series | | ||
| Age Rating | Single/Multi Select | Age Rating of Series | | ||
| People* | Single/Multi Select | Person of some Role that is on the Series | | ||
| Genres | Single/Multi Select | Genre in Series | | ||
| Tags | Single/Multi Select | Tag in Series | | ||
| Collection Tag | Single/Multi Select | Series that belongs in a Collection | | ||
| Format | Single/Multi Select | Series Format (epub, archive, etc) | | ||
| Want To Read | Boolean | If Series is in user's Want To Read list | | ||
| Reading Date | Date | Latest date the Series was read by the user | | ||
|
||
* People refers to fields such as Translator, Editor, Inker, etc | ||
|
||
#### Filter Combination | ||
| Filter Combination | Applies on | Description | | ||
| ------ | ----------- |----------- | | ||
| `Equal` | String/Number/Multi Select | Equals exactly | | ||
| `Not Equal` | String/Number/Multi Select | Doesn't Equal | | ||
| `Begins With` | String | Starts with string | | ||
| `Ends With` | String | Ends with string | | ||
| `Matches` | String | Applies a search-like match on the field | | ||
| `Is Before` | Date | Date is before X | | ||
| `Is After` | Date | Date is after X | | ||
| `Less Than` | Number | Less than X | | ||
| `Less Than Equal` | Number | Less than or Equal to X | | ||
| `Greater Than` | Number | Greater than X | | ||
| `Greater Than Equal` | Number | Greater than or Equal to X | | ||
| `Contains` | Multi Select | The Filter Field contains at least one entry of what is passed | | ||
| `Must Contains` | Multi Select | The Filter Field contains all of what is passed | | ||
| `Must Not Contains` | Multi Select | The Filter Field contains none of what is passed | | ||
|
||
### Smart Filters | ||
A Smart Filter is essentially a saved filter. The underlying filter can be loaded and changed and anything that is bound with the Smart Filter will automatically be reflected of the new filters. Once you have a Smart Filter created, check out [Customization](https://wiki.kavitareader.com/en/guides/customization) to learn about how you can utilize the filters. | ||
|
||
To create a Smart Filter, just add a name in the Name field and hit Save. Smart Filter names must be unique per user. Smart Filters are user-bound. | ||
![create_smart_filter](../../../public/guides/features/create_smart_filter.png) | ||
|
||
![smart%20filter%20list](../../../public/guides/features/smart%20filter%20list.png) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"comic": "Comic Library", | ||
"manga": "Manga Library", | ||
"images": "Image Library", | ||
"comicvine": "ComicVine Library", | ||
"lightnovel": "Light Novel Library", | ||
"books": "Book Library" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Generic library for books. Supports LN and normal books. Focuses on epub and pdf. Uses book terminology. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Uses loose comic regex to parse files. UI will use Comic terminology. Does not support foreign keywords (Tome, etc) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
Uses strict comic regex to parse files, expects embedded metadata. UI uses Comic terminology. Metadata/Mylar aligned. | ||
|
||
When can it be used: Only on ComicVine library type | ||
Filetypes: Archive by default. Will always ignore cover.ext in the series directory | ||
How it works: | ||
Series name is formulated first by checking comicInfo Series + Volume | ||
Falls back to Folder and checks explicitly for Series (Volume) format. Does this up until the library root. | ||
Falls back to just the folder name as the Series |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
Uses the Image Parser only. UI uses Manga termninology | ||
|
||
When can it be used: Image library type and file is an Image | ||
Filetypes: Image only | ||
How it works: | ||
Series is set to directory name | ||
Volume and Chapters are attempted to parse from folders up to library root | ||
If none are found, it will force every image to be a special |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Uses Manga regex but aimed for books. UI uses List Item view and overrides users preferences. Uses Manga terminology. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Uses loose comic regex to parse files. UI will use Comic terminology. Does not support foreign keywords (Tome, etc) |
Empty file.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.