<commit_before># EPUB3Reader Android App

## Abstract 

* Version: 1.1
* Date: 2013-10-29
* Developers: <NAME>, <NAME>, <NAME>
* Mentors: <NAME>, <NAME>
* License: The MIT License (MIT), see the included `LICENSE.md` file
* Contact: see section `Contact Information` below

The goal of this project consists in exploring new ways of interacting with rich, structured eBooks in [EPUB format](http://idpf.org/epub/).

The rationale behind this choice is simple: 1) EPUB is an open format for eBooks and it is the _de facto_ standard for non-Amazon eBooks; and 2) the current reading systems (eReaders, desktop programs, apps) are not suitable for reading structured, complex eBooks, as they are almost always designed with linear-reading books in mind.

Hence, the main goal of the project is proposing efficient ways of interacting with structured and complex content like:

* books with many internal (e.g., footnotes/endnotes) and external links (e.g., Web resources), and
* parallel texts (e.g., original text and its translation into another language).

In both cases, the app allows the user to split the viewport, creating two separate viewing areas, mimicking the familiar interaction with paper books, where, at the same time, the user can read 1) a footnote and the main text, 2) multiple passages from the same book, 3) passages from different books, and 4) the original text with its translation in another language, on facing pages.

In the case of links, a single tap will follow them in the same window panel, while a long tap will split the viewport into two window panels, opening the link target in the second one. This mechanism makes footnotes (internal links) or other supplemental materials (internal or external links) visible at the same time with the referring text passage, exactly like footnotes in paper books.

If the XHTML files inside an EPUB comply with the naming convention described below, the app is capable of automatically showing facing pages in two languages, turning to the previous/next chapter in both panels simultaneously.

Finally, the user can split the viewport for reading two completely unrelated eBooks.


### Screenshots

[See SCREENSHOTS.md](SCREENSHOTS.md)


### Download, Installation, and Privacy/Security Notes
<commit_msg>Updated README to version 1.1<commit_after># EPUB3Reader Android App

## Abstract 

* Version: 1.1
* Date: 2014-03-03
* Developers: <NAME>, <NAME>, <NAME>
* Mentors: <NAME>, <NAME>
* License: The MIT License (MIT), see the included `LICENSE.md` file
* Contact: see section `Contact Information` below

The goal of this project consists in exploring new ways of interacting with rich, structured eBooks in [EPUB format](http://idpf.org/epub/).

The rationale behind this choice is simple: 1) EPUB is an open format for eBooks and it is the _de facto_ standard for non-Amazon eBooks; and 2) the current reading systems (eReaders, desktop programs, apps) are not suitable for reading structured, complex eBooks, as they are almost always designed with linear-reading books in mind.

Hence, the main goal of the project is proposing efficient ways of interacting with structured and complex content like:

* books with many internal (e.g., footnotes/endnotes) and external links (e.g., Web resources), and
* parallel texts (e.g., original text and its translation into another language).

In both cases, the app allows the user to split the viewport, creating two separate viewing areas, mimicking the familiar interaction with paper books, where, at the same time, the user can read 1) a footnote and the main text, 2) multiple passages from the same book, 3) passages from different books, and 4) the original text with its translation in another language, on facing pages.

In the case of links, a single tap will follow them in the same window panel, while a long tap will split the viewport into two window panels, opening the link target in the second one. This mechanism makes footnotes (internal links) or other supplemental materials (internal or external links) visible at the same time with the referring text passage, exactly like footnotes in paper books.

If the XHTML files inside an EPUB comply with the naming convention described below, the app is capable of automatically showing facing pages in two languages, turning to the previous/next chapter in both panels simultaneously.

Finally, the user can split the viewport for reading two completely unrelated eBooks.


### Screenshots

[See SCREENSHOTS.md](SCREENSHOTS.md)


### Download, Installation, and Privacy/Security Notes

{'fraction_non_alphanumeric': 0.05927384076990376, 'fraction_numerical': 0.007874015748031496, 'mean_word_length': 4.773989898989899, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1804956', 'n_tokens_mistral': 1181, 'n_tokens_neox': 1113, 'n_words': 676}