Skip to content

Commit

Permalink
bulk updates
Browse files Browse the repository at this point in the history
bulk updates and additions
  • Loading branch information
DieselTech committed Mar 31, 2024
1 parent c5265aa commit 32f6829
Show file tree
Hide file tree
Showing 19 changed files with 112 additions and 19 deletions.
1 change: 1 addition & 0 deletions pages/guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Here you can find walkthroughs and all the various settings of Kavita.
[Admin Settings](guides/admin-settings/general) - All the settings explained that deal with running the Kavita server. <br/>
[User Settings](guides/user-settings/account) - All the settings explained for users. <br/>
[Updating](guides/updating/updating-docker) - Instructions on how to update the Kavita server based on your install method. <br/>
[Features](guides/features) - A breadown of the major features that kavita has. <br/>
[3rd Party Clients](guides/3rdparty/aidoku) - Setup instructions for setting up various 3rd party software to work with Kavita. <br/>
[External Tools](guides/external-tools/mangamanager) - A list of tools that may helpful manipulating your media to better work with Kavita. <br/>
[Metadata](guides/external-tools/mangamanager) - Information on how Kavita uses various metadata <br/>
Expand Down
7 changes: 7 additions & 0 deletions pages/guides/features/_meta.json
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"
}
16 changes: 16 additions & 0 deletions pages/guides/features/bookmarks.mdx
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.
59 changes: 59 additions & 0 deletions pages/guides/features/filtering.mdx
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)

8 changes: 8 additions & 0 deletions pages/guides/features/librarytypes/_meta.json
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"
}
1 change: 1 addition & 0 deletions pages/guides/features/librarytypes/books.mdx
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.
1 change: 1 addition & 0 deletions pages/guides/features/librarytypes/comic.mdx
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)
8 changes: 8 additions & 0 deletions pages/guides/features/librarytypes/comicvine.mdx
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
8 changes: 8 additions & 0 deletions pages/guides/features/librarytypes/images.mdx
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
1 change: 1 addition & 0 deletions pages/guides/features/librarytypes/lightnovel.mdx
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.
1 change: 1 addition & 0 deletions pages/guides/features/librarytypes/manga.mdx
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.
18 changes: 0 additions & 18 deletions pages/guides/user-settings/preferences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,9 @@ import { Callout } from 'nextra-theme-docs'
## User Settings
To access the user settings page, which holds the all settings for the logged-in user, you can use the nav bar dropdown on your username and select "User Settings". These settings apply to the logged-in user and will not affect any other user.


### Preferences
In this section, the user can configure site-wide preferences like default how the chapters/volumes are displayed (cards/list) or to blur the summaries descriptions.

#### Reading Settings
In the reading section, you will find all the options for the manga reader and the book reader. You can customize these as you like and they will apply on any of your devices. You can read more about each reader's setting [here (manga)](https://wiki.kavitareader.com/guides/webreader) and [here (book)](https://wiki.kavitareader.com/guides/bookreader).

## 3rd Party clients
Kavita provides multiple ways to connect to your server from external applications. You can find them below:

[Generic (OPDS)](./opds)

[Tachiyomi](../06.misc/tachiyomi)

#### Smart Filters

The list of smart filters you have created on your account will appear here. You have the option of deleting them if you no longer need them.

### Stats

Your individual stats customized just for you are displayed here.

### Reading Settings
In the reading section, you will find all the options for the manga reader and the book reader. You can customize these as you like and they will apply on any of your devices. You can read more about each reader's setting [here (manga)](https://wiki.kavitareader.com/guides/webreader) and [here (book)](https://wiki.kavitareader.com/guides/bookreader).
2 changes: 1 addition & 1 deletion pages/installation/remote-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Callout } from 'nextra-theme-docs'
import { Tabs } from 'nextra/components'

<Callout type="info">
While we recgonize that most people want to access their system remotely, we do not provide an avenue for support. Any issues based around remote access should be brought up with the devs / support group of the remote access tool used.
While we recognize that most people want to access their system remotely, we do not provide an avenue for support. Any issues based around remote access should be brought up with the devs / support group of the remote access tool used.
</Callout>

These are the recommended ways:
Expand Down
Binary file added public/guides/features/bookmark_library.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/guides/features/create_smart_filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/guides/features/filtering.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/guides/features/smart filter list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 32f6829

Please sign in to comment.