Glitches Over Horizontal Scrolling

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,11 @@
+<!-- Issue Template Examples - 
+ https://github.com/FolioReader/FolioReader-Android/blob/master/.github/Issue_Template_Examples.md -->
+
+Issue / Feature - 
+FolioReader version -  
+FolioReader Stock / Modified -  
+Android SDK - 
+Mobile / Tablet / Emulator Info -  
+Crash / Error - 
+
+Steps to reproduce / Describe in detail - 

.github/Issue_Template_Examples.md

@@ -0,0 +1,44 @@
+### Example No 1 -
+
+Issue / Feature - Issue <br/>
+FolioReader version - 0.3.7 <br/>
+FolioReader Stock / Modified - Stock <br/> 
+Android SDK - 4.4.4<br/>
+Mobile / Tablet / Emulator Info - Samsung Galaxy S3<br/> 
+Crash / Error - Crash<br/>
+
+Steps to reproduce / Describe in detail - <br/>
+
+I'm using library version 0.3.7
+When trying to open epub from my Activity, eg -
+
+```
+FolioReader folioReader = FolioReader.getInstance(getApplicationContext());
+folioReader.openBook(R.raw.barrett); 
+```
+
+Getting this error -
+(While i'm opening the file from my activity)
+
+```
+android.util.AndroidRuntimeException: Calling startActivity() from outside of an Activity  context requires the FLAG_ACTIVITY_NEW_TASK flag. Is this really what you want?
+        at android.app.ContextImpl.startActivity(ContextImpl.java:672)
+        at android.app.ContextImpl.startActivity(ContextImpl.java:659)
+        at android.content.ContextWrapper.startActivity(ContextWrapper.java:331)
+        at com.folioreader.FolioReader.openBook(FolioReader.java:97)
+        at com.devs.ncert.activity.MainActivity$1.onClick(MainActivity.java:35)
+```
+
+### Example No 2 -
+
+Issue / Feature - Feature <br/>
+FolioReader version - 0.3.9 <br/>
+FolioReader Stock / Modified - <br/> 
+Android SDK - <br/>
+Mobile / Tablet / Emulator Info - <br/> 
+Crash / Error - <br/>
+
+Steps to reproduce / Describe in detail - <br/>
+
+Hey guys! I need Horizontal scrolling pagination reading mode. <br/> 
+Is it possible to make this feature available?

.gitignore

@@ -1,3 +1,13 @@
+*.iml
+.gradle
+/local.properties
+/.idea/workspace.xml
+/.idea/libraries
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+
 # Custom
 _site
 
@@ -37,4 +47,7 @@ out
 # Maven
 target
 release.properties
-pom.xml.*
+pom.xml.*
+
+# Readium DRM LCP
+liblcp.aar

.travis.yml

@@ -1,17 +1,23 @@
 language: android
 
-before_install:
-  - echo yes | android update sdk --filter extra-android-support --no-ui --force > /dev/null
-  - echo yes | android update sdk --filter extra-android-m2repository --no-ui --force > /dev/null
+script:
+  - ./gradlew build
 
 android:
-  components:
-    - build-tools-27.0.3
-    - android-27
-    - extra-android-m2repository
 
   licenses:
-      - android-sdk-license-.+
+    - android-sdk-preview-license-.+
+    - android-sdk-license-.+
+
+  components:
+    # https://docs.travis-ci.com/user/languages/android/#Installing-a-newer-SDK-Platform-Tools-revision
+    - tools
+    - platform-tools
+    - tools
+
+    # The BuildTools version used by your project
+    - build-tools-28.0.3
 
-  script:
-    ./gradlew build
+    # The SDK version used to compile your project
+    - android-28
+    - extra-android-m2repository

CHANGELOG.md

@@ -0,0 +1,37 @@
+# Change Log
+
+## 0.5.4
+
+- Search API from codetoart/r2-streamer-kotlin now use window.find() instead of Rangy solution.
+
+## 0.5.3
+
+- FolioReader migrated to AndroidX. You will have to migrate your project to AndroidX. Read more about it here - [Migrating to AndroidX](https://developer.android.com/jetpack/androidx/migrate)
+- Search API calls made asynchronous.
+
+### Bugs Fixed
+
+- FolioReader/FolioReader-Android#190
+- FolioReader/FolioReader-Android#276
+- FolioReader/FolioReader-Android#239
+- FolioReader/FolioReader-Android#308
+- FolioReader/FolioReader-Android#284
+- FolioReader/FolioReader-Android#298
+
+## 0.5.2 (Unreleased)
+
+- Developer now don't need to add network_security_config.xml explicitly.
+- Android Min SDK raised to API 21 as Chrome is stuck on version 30 on API 19.
+- ReadPosition replaced with ReadLocator using CFI.
+- TTS feature temporarily disabled, see KNOWN_ISSUES.md for more information.
+- SearchQueryResults and SearchItem replaced with SearchLocator using CFI.
+
+## 0.5.1
+
+- r2-streamer-java replaced with r2-streamer-kotlin and r2-shared-kotlin
+- WebViewMarker replaced with Native text selection popup.
+- Media Overlay feature temporarily unavailable, see KNOWN_ISSUES.md for more information.
+
+## 0.4.1
+
+- Developer now don't need to specify permissions and FolioActivity tag in AndroidManifest.xml

KNOWN_ISSUES.md

@@ -0,0 +1,23 @@
+# Known Issues
+
+This is a list of major known issues. For the latest list of all issues see the
+[Github Issues page](https://github.com/FolioReader/FolioReader-Android/issues)
+
+## Errors on API 21 and 22 with Webview lower than version 44
+
+FolioReader might not work properly on API 21 and 22 Emulator images.
+As these images have Android System Webview lower than version 44.
+Devices or Emulator of API 21 and 22 with Google Play Store will be
+able to run FolioReader without any error after updating Android System
+Webview to version 44+
+
+## Media Overlay
+
+From version 0.5.1, Media Overlay would not work as the streamer implementation is not done yet in r2-streamer-kotlin.
+
+## TTS
+
+From version 0.5.2, TTS is disabled.
+In previous versions, sentences were formed by changing the DOM structure.
+To implement TTS without changing DOM would require NLP to extract sentences.
+As of now, no major reading systems other than Google Play Books implements TTS bug free.

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://api.travis-ci.org/FolioReader/FolioReader-Android.svg?branch=master)](https://travis-ci.org/FolioReader/FolioReader-Android)
 
-FolioReader-Android is an ePub reader written in Java.
+FolioReader-Android is an EPUB reader written in Java and Kotlin.
 
 ### Features
 
@@ -13,75 +13,80 @@ FolioReader-Android is an ePub reader written in Java.
 - [x] List / Edit / Delete Highlights
 - [x] Handle Internal and External Links
 - [x] Portrait / Landscape
-- [x] Reading Time Left / Pages left
+- [ ] Reading Time Left / Pages left
 - [x] In-App Dictionary
-- [x] Media Overlays (Sync text rendering with audio playback)
-- [x] TTS - Text to Speech Support
+- [ ] Media Overlays (Sync text rendering with audio playback)
+- [ ] TTS - Text to Speech Support
 - [ ] Parse epub cover image
 - [ ] PDF support
-- [ ] Book Search
+- [x] Book Search
 - [x] Add Notes to a Highlight
 - [ ] Better Documentation
-- [x] Last Read Position Listener
+- [x] Last Read Locator
+- [x] Horizontal Reading
+- [x] Distraction Free Reading
 
 ## Demo
 ##### Custom Fonts
 ![Custom fonts](https://cloud.githubusercontent.com/assets/1277242/19012915/0661c7b2-87e0-11e6-81d6-8c71051e1074.gif)
 ##### Day and Night Mode
 ![Day night mode](https://cloud.githubusercontent.com/assets/1277242/19012914/f42059c4-87df-11e6-97f8-29e61a79e8aa.gif)
-##### Text Highlighting 
+##### Text Highlighting
 ![Highlight](https://cloud.githubusercontent.com/assets/1277242/19012904/c2700c3a-87df-11e6-97ed-507765b3ddf0.gif)
-##### Media Overlays 
+##### Media Overlays
 ![Media Overlay](https://cloud.githubusercontent.com/assets/1277242/19012908/d61f3ce2-87df-11e6-8652-d72b6a1ad9a3.gif)
 
 ### Gradle
-Add following dependency to your app build.gradle
-``` java
-compile 'com.folioreader:folioreader:0.3.9'
-```
 
-Add maven repository to your top level build.gradle
+Add following dependency to your root project `build.gradle` file:
 
 ```groovy
 allprojects {
     repositories {
-        maven {
-            url "http://dl.bintray.com/mobisystech/maven"
-        }
+        ...
+        jcenter()
+        maven { url "https://jitpack.io" }
+        ...
     }
 }
 ```
 
-### Usage
-
-First add activity tag for FolioActivity in your AndroidManifest.xml
+Add following dependency to your app module `build.gradle` file:
 
-```xml
-<activity
-    android:name="com.folioreader.ui.folio.activity.FolioActivity"
-    android:configChanges="orientation|screenSize"
-    android:theme="@style/AppTheme.NoActionBar"/>
+```groovy
+dependencies {
+    ...
+    implementation "com.folioreader:folioreader:0.5.4"
+    ...
+}
 ```
 
-To use FolioReader, get singleton object of **FolioReader**.
+### Enable Multidex support
+
+Enable Multidex support as explained in this [Android Doc](https://developer.android.com/studio/build/multidex)
+
+### Usage
+
+Get singleton object of `FolioReader`:
 
 ```java
-FolioReader folioReader = FolioReader.getInstance(getApplicationContext());
+FolioReader folioReader = FolioReader.get();
 ```
 
-Call the function openBook().
+Call the function `openBook()`:
 
-##### opening book from assets
+##### opening book from assets -
 
 ```java
-folioReader.openBook("file:///android_asset/adventures.epub");
+folioReader.openBook("file:///android_asset/TheSilverChair.epub");
 ```
-##### opening book from raw
+##### opening book from raw -
 
 ```java
-folioReader.openBook(R.raw.barrett);
+folioReader.openBook(R.raw.accessible_epub_3);
 ```
 
+
 ## WIKI
 
 * [Home](https://github.com/FolioReader/FolioReader-Android/wiki)
@@ -91,14 +96,20 @@ folioReader.openBook(R.raw.barrett);
     * [Highlight Action](https://github.com/FolioReader/FolioReader-Android/wiki/Highlight-Action)
     * [Highlight Event](https://github.com/FolioReader/FolioReader-Android/wiki/Highlight-Event)
     * [Providing External Highlight](https://github.com/FolioReader/FolioReader-Android/wiki/Providing-External-Highlight)
-* [ReadPosition](https://github.com/FolioReader/FolioReader-Android/wiki/ReadPosition)
-    * [Get ReadPosition](https://github.com/FolioReader/FolioReader-Android/wiki/Get-ReadPosition)
-    * [Set ReadPosition](https://github.com/FolioReader/FolioReader-Android/wiki/Set-ReadPosition)
+* [ReadLocator](https://github.com/FolioReader/FolioReader-Android/wiki/ReadLocator)
 * [Clean up code](https://github.com/FolioReader/FolioReader-Android/wiki/Clean-up-code)
 
+## Reporting Issue
+
+See [KNOWN_ISSUES](https://github.com/FolioReader/FolioReader-Android/blob/master/KNOWN_ISSUES.md) and [CHANGELOG](https://github.com/FolioReader/FolioReader-Android/blob/master/CHANGELOG.md) first before reporting any issue. <br />
+Please follow [Issue Template](https://github.com/FolioReader/FolioReader-Android/blob/master/.github/ISSUE_TEMPLATE.md) to report any issue.
+
+## Share your application
+If you are using FolioReader in your application, share your application link in [this issue](https://github.com/FolioReader/FolioReader-Android/issues/291)
+
 ### Credits
 1. <a href="https://github.com/daimajia/AndroidSwipeLayout">SwipeLayout</a>
-2. <a href="https://github.com/readium/r2-streamer-java">r2-streamer-java</a>
+2. <a href="https://github.com/readium/r2-streamer-kotlin">r2-streamer-kotlin</a>
 3. <a href="http://developer.pearson.com/apis/dictionaries">Pearson Dictionaries</a>
 4. <a href="https://github.com/timdown/rangy">rangy</a>
 
@@ -129,3 +140,4 @@ folioReader.openBook(R.raw.barrett);
 
 ## License
 FolioReaderKit is available under the BSD license. See the [LICENSE](https://github.com/FolioReader/FolioReader-Android/blob/master/License.md) file.
+