1
0
mirror of https://github.com/janeczku/calibre-web synced 2024-11-28 04:19:59 +00:00

Update

Ozzieisaacs 2020-02-27 20:39:26 +01:00
parent f6c49a30d2
commit fe057bc13e
2 changed files with 23 additions and 6 deletions

@ -173,6 +173,9 @@ Limits the number of book covers shown on one page (and the number of books load
No. of random books:\ No. of random books:\
Limits the number of books showning up in the random books section. To deactivate the feature untick the "Show random books in detail view" on the user's settings page. Limits the number of books showning up in the random books section. To deactivate the feature untick the "Show random books in detail view" on the user's settings page.
No. of Authors to Display before hiding:\
If books having many authors, cover view pages can be very confusing. Therefore it's possible to limit the number of authors shown in this case. Entering a zero deactivates this feature and all authors are shown.
Theme:\ Theme:\
Currently Calibre-Web supports two theme, the Standard ligh one, and the dark Caliblur! plex like theme. Currently Calibre-Web supports two theme, the Standard ligh one, and the dark Caliblur! plex like theme.
@ -183,13 +186,27 @@ Example: ".\*" would exclude all custom columns, "Read" only the column with the
Regular expression for title sorting:\ Regular expression for title sorting:\
Calibre stores internally the title and a "sorted title". Title often starting with articles like "A" in english, or "Die/Der/Das" in german, which make no sense to sort after, therfore all of the listed words in these field are ignored for sorting the title. The default is taken from a german Calibre program. For french it should be something like "^(Le|La)\s" Calibre stores internally the title and a "sorted title". Title often starting with articles like "A" in english, or "Die/Der/Das" in german, which make no sense to sort after, therfore all of the listed words in these field are ignored for sorting the title. The default is taken from a german Calibre program. For french it should be something like "^(Le|La)\s"
Tags for Mature Content:\ Link Read/Unread Status to Calibre Column:\
Sometimes you want to hide certain books from some users (like your kids). In this case you have to add certain categories to this books, afterwards you can add this categories in the field here (comma seperated if more than one). Calibre-Web then prevents access to books having these categories for useres not having the "show mature content" option ticked (Users role settings). In a single user Calibre installation you can use a boolean custom column to keep track of your read and unread books. Calibre-web can do the following. You can link the Calibre status to the read/unread status in Calibre-Web. As mentioned above this only works in a SINGLE USER use-case. If you are having more than one user in Calibre-Web this will cause trouble, because the read/unread status is used for all users, so if one user ticks a book as read, all users will see this book as read. In a multiuser Calibre-Web use case it's absolutly manatory not to use this feature.\
How to use the feature?
1. Open Calibre (the Desktop program) and create a boolean custom column name it accordingly (e.g. Read Status)
2. Calibre will ask you for a restart to apply the change. Afterwards please close Calibre
3. For safety reasons it's recommended to restart Calibre-Web
4. Log in to Calibre-Web as admin and go to Admin->UI configuration->View Configuration
5. The field "Link read/unread status to Calibre column" should now offer a selection of all boolean custom columns of the corresponding Calibre library, select the appropriate entry and save
The read/unread status is now identical in Calibre and Calibre-Web
View Restrictions based on Calibre Column:\
Sometimes you want to hide certain books from some users (like your kids). You can allow and deny the visibility of books based on the content of a Custom Column. Alternativly you can also use tags to allow and deny books. Both features can be used on a per user base. In this setting you define the Custom Column where the restriction shall be baed on. Lateron you can add all rules by editing the user settings. Furthermore you can define a default Visibilitys in the "Default Visibilitys for New Users" section. Admins can change their own visibility restirctions on their own user settings page.
### Default settings and visibilitys for new users ### Default settings and visibilitys for new users
The options selected in this section define the access rights and visibilitys new users having upon registering, and the default settings for newly created users by the admin (can be changed during initial creation, or later by admins). The options selected in this section define the access rights and visibilitys new users having upon registering, and the default settings for newly created users by the admin (can be changed during initial creation, or later by admins).
The visibilitys (except mature content settings) can be changed by the users themselves later on. The Guest user (User for anonymous access) is an except from this, only admins can change the visibilities for the Guest user. The visibilitys (except Visibility Restriction settings) can be changed by the users themselves later on. The Guest user (User for anonymous access) is an except from this, only admins can change the visibilities for the Guest user.
### eBook Viewer and eBook Download
The integrated eBook viewer is available for pdf, epub, txt and cbr, cbz and cbt files. The option is showing up if user has the right to "View Ebooks". If you are upgrading from older versions, it might be possible that the admin user lost the right to download or view books.
### Using Goodreads integration ### Using Goodreads integration

4
FAQ.md

@ -116,10 +116,10 @@ open the file with a advanced editor like notepad++ and change the line endings
### Link Read Status to calibre custom column ### Link Read Status to calibre custom column
In a single user Calibre installation you can use a boolean custom column to keep track of your read and unread books. Calobre-web can do the following. You can link the Calibre status to the read/unread status in Calibre-Web. As mentioned above this only works in a SINGLE USER use-case. If you are having more than one user in Calibre-Web this will cause trouble, because the read/unread status is than used for all users, so if one user ticks a book as read, all users will see this book as read. In a multiuser Calibre-Web use case it's absolutly manatory not to use this feature.\ In a single user Calibre installation you can use a boolean custom column to keep track of your read and unread books. Calibre-web can do the following. You can link the Calibre status to the read/unread status in Calibre-Web. As mentioned above this only works in a SINGLE USER use-case. If you are having more than one user in Calibre-Web this will cause trouble, because the read/unread status is used for all users, so if one user ticks a book as read, all users will see this book as read. In a multiuser Calibre-Web use case it's absolutly manatory not to use this feature.\
How to use the feature? How to use the feature?
1. Open Calibre (the Desktop program) and create a boolean custom column name it accordingly (e.g. Read Status) 1. Open Calibre (the Desktop program) and create a boolean custom column name it accordingly (e.g. Read Status)
2. Calibre will ask you for a restart to apply the change. Afterewards please close Calibre 2. Calibre will ask you for a restart to apply the change. Afterwards please close Calibre
3. For safety reasons it's recommended to restart Calibre-Web 3. For safety reasons it's recommended to restart Calibre-Web
4. Log in to Calibre-Web as admin and go to Admin->UI configuration->View Configuration 4. Log in to Calibre-Web as admin and go to Admin->UI configuration->View Configuration
5. The field "Link read/unread status to Calibre column" should now offer a selection of all boolean custom columns of the corresponding Calibre library, select the appropriate entry and save 5. The field "Link read/unread status to Calibre column" should now offer a selection of all boolean custom columns of the corresponding Calibre library, select the appropriate entry and save