Add-on:EBooks: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(Blanked the page)
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Addon
|Name=eBooks
|provider-name=robwebset
|ID=script.ebooks
|latest-version=1.0.0
|extension point=xbmc.python.script
|provides=executable
|Summary=View eBooks
|Description=Allows the viewing of eBooks
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.kodi.tv/showthread.php?tid=238835
|Website=
|Source=https://github.com/robwebset/script.ebooks
|Email=
|broken=
|icon url=https://raw.githubusercontent.com/robwebset/script.ebooks/master/icon.png}}


<!-- Page content goes here -->
<br />
<br />
== Introduction ==
eBooks is an addon that allows you to list and view your epub and mobi eBooks using Kodi.  Only the text will be displayed, no images.
<br /><br />
Supported book formats are
* ePub
* Mobi
* PDF
<br />
On installation of the eBook addon it will need configuring to point to the directory that contains all of your eBook files. This can be done via the eBooks Settings, or if not set, you will be prompted on first use.
<br />
<br />
== Book Listing ==
When entering the addon via the Programs Menu the available books will be listed in the format:
<br /><br />
:''Author - Title''
<br />
Any directories that exist will be displayed with their directory name and enclosed in square brackets. On selecting a book, the chapters in that book will be displayed (Note: If there are no chapters, then a single entry for the entire book will be displayed).
<br /><br />
Any books or chapters that have been marked previously as read will start with an asterisk ("*").
<br />
<br />
== Text Viewer ==
When a chapter is selected for reading it will be displayed in the text viewer. This enables the reader to scroll down the text either using the scrollbar or up and down arrow keys.  Once the chapter has been read the user can either
* Select "Close" to close the window
* Select "Mark As Read" to record that this chapter has been read and then close the window
* Select "<" (Or the Page Up key) to go back to the previous chapter
* Select ">" (Or the Page Down key) to go to the next chapter
<br />
<br />
== Cover Art ==
The cover art for a given book is retrieved in the following order:
# A jpg file in the same directory as the book with the same name (i.e. a book with the name mybook.epub and an image with the name mybook.jpg)
# An image that has previously been cached from a book (Based on the file name of the book)
# Extracted internal image from the book file
# The default cover image set in the eBooks settings screen.
<br />
<br />
== Settings ==
=== General ===
{| border="0"
|- valign=top
|
:'''eBooks Folder'''
::The Location where the eBooks are stored
:'''Default Book Cover Image'''
::The default cover image to use if there is no image available for the book
:'''Only Show Whole Book If No Chapters'''
::Will only show a link to the entire book if there are no chapters available in the book
:'''Mark Chapter As Read When Navigating To Next Chapter'''
::When using the next button on the viewer, mark the chapter being left as read
:'''Use White Background For Reader'''
::Use black text on a white background for the viewer window
:'''Always Use Page Numbers For PDF Files'''
::When listing PDF files, use page numbers rather than any chapters found
| [[File:EBooks-Settings1.JPG|400px]]
|}
=== Operations ===
{| border="0"
|- valign=top
|
:'''Clean Book Cover Cache'''
::Removes any book covers that have been cached
:'''Clear Book Details Cache'''
::Clears and data cached about the ebooks (inc. read markers)
:<u>'''''Debugging'''''</u>
::
:'''Enable debug logging'''
::Enables TvTunes debug logging (Required if reporting a problem) - for this to work, system-wide Kodi | [[File:EBooks-Settings2.JPG|400px]]
|}
<br />
<br />
== Debugging ==
If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:
* Kodi [[Settings/System#Debugging|logging]] from the main setting menu
* eBooks debug from the eBooks addon settings menu
Please do not paste the log into the forum thread, just link to it.
<br />
<br />
== Donations ==
If you have found the eBooks Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.
<br />
<br />
Please use the link on the top of the [http://forum.kodi.tv/showthread.php?tid=238835 eBooks Forum]
<br />
<br />
[[Category:Gotham add-on repository]]

Latest revision as of 04:12, 19 October 2016

Retrieved from "https://kodi.wiki/index.php?title=Add-on:EBooks&oldid=124621"