amahule / fbreaderj Goto Github PK

This project forked from skullkey/fbreaderj

Official FBReaderJ project repository

Home Page: http://www.fbreader.org/FBReaderJ/

C 3.14% C++ 0.11% Java 63.28% Shell 33.41% Python 0.05%

fbreaderj's Introduction

-----------------------------------------------------------------------------
This fork is an initiative for developing an e-book reader for DAISY 3 files.
-----------------------------------------------------------------------------

DAISY 3 is a format that helps to make reading easier for those having reading disabilities.
Benetech (http://www.benetech.org/), the organization that leads the efforts for making the world
a better place for the print disabled, is originator of this project.
Volunteer programmers help to develop and maintain this fork.

This is a fork of the FBReaderJ project located at https://github.com/geometer/FBReaderJ.
The original FBReaderJ project in under GNU GPL license.
As a result, this effort is also under the same license.

The apk file for this project can be downloaded from the Downloads section.

To add the Bookshare library to FBReader, simply go to Network Library and add a source with the URL: http://bookshare.org

The DAISY 3 text e-books can also be loaded via the SD card into the folder set as the loading directory in
the settings of the FBReader app. The book will automatically show in the Library section of the application.

A basic implementation of the Text-To-Speech functionality has been done using the Android TTS API.
We will be working on a more sophisticated version of that module.

This version also supports other formats namely epub, fb2, palmdoc and tcr.

The link for Bookshare developer API is http://developer.bookshare.org/

If you plan to build this project, you need an API key, which can be obtained by registered at http://developer.bookshare.org and acquiring an API key.

----------------------------
Last Edited by - Abhi Mahule
----------------------------

fbreaderj's People

Contributors

Stargazers

Watchers

Forkers

nictor kevinchenbin benetech

fbreaderj's Issues

Local library search

As an Aster user, I can search my local library by common search attributes such as author, title and category so I can find my content efficiently.

test issue

test

Navigation: Ability to mark text for later access or export

Text can be marked/exported for later use (scrapbook, citations; i.e., a clipboard function that can be appended or overwritten). Limitations on the amount of text that may be exported will be set to meet copyright requirements.

Forgot Password - help page

As an Aster user, I am prompted with the right set of actions, in case I have forgotten my password, so I can reset the same.

Navigation: Current Location

User can obtain information about current location in book relative to the entire book such as "n% read, n% remaining" or "n hours remaining," and logical location such as "chapter 5, page 129, paragraph

Download directory for Bookshare API should be the sone specific in Settings

Browse and Discover content

User Story
As an Aster user, I can browse for books by category, most popular and recently added in both anonymous and logged-in mode, so I can discover content matching my interest

Navigation : Reading of foot notes

At any time during the reading of a note, the user shall be able to interrupt the reading and return to the point in the text immediately following the note reference.

Login using Bookshare account

User Story:
As an Aster user, I can login using my Bookshare account, so I can utilize both generally available and protected Bookshare content.

Ability to parse and render a text-only DAISY 3.0 book

Use case:
Be able to open , parse and render a text-only DAISY 3.0 book on the android device.

Search for Bookshare books in anonymous mode

User Stories:
As an Aster user, I have the option to use the app in anonymous mode to search and download public domain/generally available Bookshare content.
As an Aster user, I can use the same search capabilities ( eg. ISBN, Title, BookId, Title/Author etc) as in Bookshare.org, in anonymous mode, so I can quickly find the content I need.

Local library to manage downloaded content

User Story:
As an Aster user, I have a local library to organize and access my downloaded DAISY content.

Navigation : Instant Start/Stop

User Story:
Playback can be stopped/started instantly by the user. The device can be stopped and then restarted and no audio material will be missed.

Local Library organization

As an Aster user, I can find the books organized by few key attributes ( eg. author, title, recently used), so I can find my content efficiently.

Navigation: Multiple levels of granularity -- document accessible at fine level of detail

Document can be accessed at various levels of definition such as by paragraph, by sentence, or by word, depending upon user needs.

"War and peace" Freely available book on bookshare.org does not show the download button

Look for "war and peace" on the bookshare.org , advanced search
with filter set to "Freely Available" books. War and peace does show up.
on FBreader, when you do a title search, it lists 2 entries, one with the blue download sign.
clicking on it shows the book details , but the "Download" symbol does not appear.

Since it was listed as freely available on the bookshare site, I was expecting the same behaviour on FB Reader.

Modify Bookshare account preferences

As a Bookshare member I have the ability to modify basic aspects of my user profile (download password, adult content filter ) directly from the device.

Simplify the process of adding Bookshare as a catalog

Support Allowing the user to add Bookshare via any URL with bookshare.org in it. So you can just put in http://bookshare.org or http://www.bookshare.org and it would recognize that it's adding a Bookshare library.
Eliminate the warning that something is wrong with the URL you added.
Can we eliminate the custom catalog dialog that asks you to title the catalog. We should just call it Bookshare and eliminate that step.

Status of download

As an Aster user, I am alerted to the status of the download, so I can ensure the intended operation completed successfully.

Import DAISY content

User Story:
As an Aster user, I can import my personal DAISY content from my computer to my mobile device, so I can access content seamlessly.

Page delimiters seem to shift when you start speech.

It starts speaking a paragraph above the current page and then shifts the page separators by a paragrap.

Navigation: Easy skips (defined by document)

User can skip through the document by segments defined by document elements such as chapters, pages, paragraphs, etc. In this mode, the user moves through the elements sequentially, rather than jumping directly to a specific target.

Navigation: Cross-Reference notification

The user has the option of being notified via an audible signal when a cross-reference is encountered. Default is to enable it. User may choose among several audible indicators.

Navigation: Search by words

Text file can be searched by word/groups of words as input by the user.

Error Feedback

As an Aster user, I expect elegant and useful messages when things do not work as expected in every step of work flow.

Is it possible to provide audible feedback?

Navigation: Separate sets of bookmarks stored for each book

Bookmarks can be accessed per book.

Search for Bookshare books in logged-in mode

User Story:
As an Aster user, I can use the same search capabilities ( eg. ISBN, Title, BookId, Title/Author etc) as in Bookshare.org, in both anonymous and logged-in mode, so I can quickly find the books I need.

Wrong book downloaded from search results...

Steps to reproduce:

Make sure there are no "The Divine Comedy" books in local library
Do a Bookshare Title search for "The Divine Comedy"
Select the first book by Henry Wadsworth Longfellow.
Notice the Bookshare id starts with 35, however it should be 2885
Then when you go to the local library, it display book information for the one starting in 2885 and displays a download link, since it downloaded the one starting in 35.

There also seems to be issues when you click back from the search results that are related to this.

Navigation: Setting Bookmarks

User can set one or more bookmarks for later access. Bookmarks are saved even when phone is turned off and are deleted only upon user initiation.

Sign up functionality

User Story:
As an Aster user, I need to be directed to a suitable place with information to create a Bookshare membership if I do not already have a Bookshare account.

Bookshare login happens for wrong username/password as well

Following is cause of the bug:
If the response code is 401, only then the login is flagged as unsuccessful.
However, it is observed that sometimes error code 500 is sent as part of response when the login credentials are wrong.
[Adding this condition to the verifying step should be the fix]

Provide Book Info

User Story
As an Aster user, I can view detailed information about the book ( author, date published, , category, synopsis, freely available, available for download ) from the search results, so I can learn more about the book.

Download publicly available Bookshare content in anonymous mode

User Story:
As an Aster user, I have the option to use the app in anonymous mode to search and download public domain/generally available Bookshare content.

Books downloaded from Bookshare cannot be deleted from local library

Epic: Help functions

Place holder for Help functions such as:

Key identifier:
Buttons identify themselves when pressed. This function can be enabled/disabled by the user.
Confirmation messages ("earcons")
Spoken messages confirm user's action, e.g. system says "play" when "play" key is pressed.

3 Audible error feedback
Tones or spoken messages are generated when user attempts an invalid function, e.g. pressing the "move forward" key when already at the end of the document. Configurable/queryable. One configuration might involve the use of a tone to indicate an error, with a spoken message following if invoked by the user.

4 "Drill down capability" (Tell me where I am.)
More button presses provide more detailed information. For example, multiple presses might elicit location information such as title, chapter, page, etc.

Summary Information
User can query the device and obtain a quick overview of the document (e.g., 563 pages, 9 hours of play, 4 levels of heading, 2 parts, 12 chapters, 5 tables). Information is dynamic and can be tailored to the contents of the user's current location (e.g., chapter 11).

Navigation: Ability to manage foot notes

Footnotes can be managed in a variety of ways. The user can set her configuration profile so that:

footnote references and the footnotes themselves are automatically played in full,
footnote references are played but the footnotes are not unless the user chooses to hear one, or
footnote references and footnotes are skipped

Navigation: Labelling book marks

User can tag bookmarks with text or voice labels. The same label can be assigned to multiple bookmarks to create a set of related bookmarks. The user can browse through all existing bookmarks.

Add version number to FBReader

Provide version number so it is easier to associate issues with particular release of the code.

Ability to log book quality issues

Webservice userid /password prompt shown when using Bookshare catalog

Steps:

Install FBReader
Follow the process to Add Catalog ( name it Bookshare)
Click on Bookshare
Prompts for Webservice user id password.
Log out of FBReader
Re-enter, the prompt is shown again.

Questions:
Should the prompt even be shown in Step 4)?

-Ashwini.

Efficient and Smooth transition between acquiring and reading books.

User Story
As an Aster user, I need to smoothly transition between acquiring books and other activities, so I can be read efficiently.

Download protected content - starting in anonymous mode

User Story:
As an anonymous Aster user, I need the option to switch to logged-in mode seamlessly if I choose to download protected BookShare content.

Migrate API code to new Benetech API

Apply for a developer key at bookshare.mashery.com
Instead of using basic authentication, append the following parameter to your web service calls ?api_key=YOURKEY
Let's store this key in the code and use the currently authentication dialogs in the app to get Bookshare user account credentials for downloading books that are not freely available.
For user authenticated requests send md5 of user password in http header named "X-password"

Example:
http://bookshare.api.mashery.com/book/search/title/The%20Divine%20Comedy?api_key=YOURKEY

Note final endpoint will be https://api.bookshare.org

Enhancement - Need to embed the bookshare URL in the pre-existing list of book providers catalog

Currently, we need to manually enter the URL information using "Add a catalog" option under network.

Navigation: Fast forward and fast reverse

Controls allow user to move forwards or backwards through the text at 5 to 20 times normal speed, with audible feedback ("chatter," tones, or spoken cues) providing information on the structure of the document.

Navigation: Useable table of contents/index

User can access the table of contents/index from any point in the book and select an entry for immediate access. Links from table of contents lead to the item selected. Links from index lead to the top of the page selected.

Navigation : Ability to move directly to a specific target

User can easily jump directly to a specific point in the document such as page 56 or chapter 12. The user selects or enters the name of the target and then initiates the jump.

User can jump directly to a location identified in the document as a target (for example a cross-reference). The user encounters a cross-reference, for example, "See Appendix 5," and activates the link to that location. When a user prompts the device to follow a link, the device launches the nearest previous link. This allows a user to activate a link even if he has not reacted immediately after being notified of the link.

Add bookshare catalog
Search for "Beatrix Potter"
Download "The Great Big Treasury of Beatrix Potter"
Book downloads successfully, and the a link is given to "Open local library"
In local library, author is "Unknown"
The Title is displayed with hyphens as "The_Great_Big_Treasury_of_Beatrix_Potter"

Behavior in 5) and 6) are not user friendly. We should display Author name and spaces rather than hyphens in the Title.