Read Etexts: Difference between revisions

From OLPC
Jump to navigation Jump to search
(use the template)
 
(43 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Activity migrated to sl.o
{{Translations}}
| download=http://activities.sugarlabs.org/sugar/addon/4035

| git=http://git.sugarlabs.org/projects/readetexts
{{Olpcboxtop|toptext=[[{{PAGENAME}}|Read Etexts]]}}
| homepage=http://wiki.sugarlabs.org/go/Activities/Read_Etexts
{{ OBX activity |[[Image:readetexts.png]]||2=extra|Version 8 }}
| icon=[[Image:readetexts.png]]
{{ OBX source|http://git.sugarlabs.org/projects/readetexts}}
{{ OBX test |[[Tests/ReadEtexts|Read ETexts]]}}
{{ OBX devtickets |readetexts}}
{{ OBX pootle|}}
{{ OBX team |James Simmons}}
{{ OBX mimetypes |text|plain|application|zip }}
<small>see more [[:Category:OBX templates|templates]] or [[OBX proposals|propose new]]</small>
{{Olpcboxbottom}}

== Description & Goals==
{{Users}}

''"Outside of a dog, a book is man's best friend. Inside of a dog it's too dark to read."'' -- Groucho Marx

The Read Etexts activity is meant to allow the XO laptop to read Project Gutenberg ETexts, which are plain text files. The core Read activity will eventually support this, so you can consider this activity to be a useful stopgap. If you have a choice between a text file and a pdf, you may find that the text file is easier on the eyes than a pdf, takes up less space in the Journal (especially in zip format), and uses less memory to read.

The interface to Read Etexts is very similar to the core Read activity, which should not be surprising as the toolbar code was adapted from Read's toolbar. You can use the up and down arrows or the game controller to scroll pages, and the '+' and '-' keys to adjust the font size. Use Page Up and Page Down to move to the previous and next pages respectively.

[http://www.gutenberg.org/wiki/Main_Page Project Gutenberg] is a website where you can download thousands of public domain books for free. There are books for every interest: classics, history, childen's novels, science fiction, and much, much more. [http://www.gutenberg.org/browse/loccs/pz Browse By Library of Congress Class: Language and Literatures: Juvenile belles lettres] will give you a list of books suitable for young readers.

Read ETexts can read books in plain text format or in Zip format. These are by far the most popular formats on the Gutenberg website. If you are downloading books using the Browse activity you should download one of the Zip file formats. This can be encoded as us-ascii text or as iso-8859-1; Read Etexts can handle either one. The iso-8859-1 encoding is used for books that need accent marks, etc. Save the Zip file to the Journal, change the Journal entry name to match the title of the book, and then resume it using the Read Etexts option on the Resume menu. See the first screenshot.

== Screenshots ==

{|style="border: solid 1px gray; margin: 1em auto 1em; auto"
|-
| valign="top"|
[[Image:ReadEtextsJournal.jpg|thumb|center|Launching the Activity from the Journal]]
| valign="top"|
[[Image:ReadEtextsReadToolbar.jpg|thumb|center|The Read Etexts Activity in action]]
| valign="top"|
[[Image:SpeechToolbar.jpg|thumb|center|The Speech tool bar in action]]
| valign="top"|
[[Image:ReadEtextsComparison.jpg|thumb|center|The Read Activity, for comparison]]
|-
|}

== Current Features ==

* Currently Read Etexts can be used to read Gutenberg Etexts, either as text files or as zip files containing one text file. The toolbars include Activity, Read (skip to page), Edit (copy to clipboard, search for text) and View (zoom text bigger or smaller).
* Book sharing is supported.
* The power management code from the core Read activity has been added, with a few minor changes, and seems to work OK.
* A new feature is text to speech with Karaoke highlighting. The purpose of this is to produce a tool to help someone learn to read. Support for text to speech on the XO laptop is done using speech-dispatcher and espeak. Speech-dispatcher currently is not part of the software included on the XO, but can be easily added using Yum. You do '''not''' need speech-dispatcher installed to use Read Etexts, but you will of course not have text to speech working unless you do.

== Using Text to Speech ==

Read Etexts uses software called Speech Dispatcher to read text aloud and to perform callbacks which enable the word being spoken to be highlighted. Speech Dispatcher is not yet included with the normal XO software distribution, but can be installed using the instructions found [[Speech_Server#Installing_speech-dispatcher_on_the_xo|here]].

To start text to speech you simply press the check mark button on the XO's display (Numeric Keypad "End" on a standard keyboard). This button will also pause and resume speech. Only the current page will be spoken, and always starting from the first word on the page unless you are resuming after pausing. You need to have the text control containing the text to be spoken in focus. I use the check button because you can use it when the XO is folded into its ebook reader configuration. There is also a Play/Pause button on the Speech tab of the toolbar that you can use instead.

If you do not have the Python bindings for speech-dispatcher installed you will ''not'' see the Speech tool bar. This is intentional. The toolbar is very much like the one in the Speak activity and was adapted from its code. It allows you to change the language, pitch, and rate of speech. You can only do this while the Activity is not speaking. You can pause the speech, change its rate, pitch,or language, and then resume.

There is a version of Read Etexts that replaces speech-dispatcher with a gstreamer espeak plugin developed by Aleksey Lim for the Sugar project. This plugin should be part of Sugar on a Stick and future releases of Sugar for the XO. This plugin works much better than speech-dispatcher does and does not require running a demon program or doing any configuration. I will release this new version of Read Etexts when the gstreamer plugin is generally available.

== Sharing Documents ==

This activity uses code adapted from the core Read activity for document sharing over the network. To share a document with someone that person must also have the Read Etexts activity installed, and it should be the same version for best results. You can invite an individual to join the activity or share it with the whole neighborhood, but either way only those who have the activity installed will see the invitation.

When someone accepts the invitation to join the activity a copy of the document is sent to his computer for him to read. When he exits the activity the document will be saved in the journal. The Journal entry will be titled "Read Etexts Activity", not the title of the book. Of course the recipient can modify this title to match the actual title of the book, but the activity currently will not do this for her.

This is a bit different from the core Read activity because I actually save a copy of the received document in the Journal, whereas Read does not. If you try to resume a shared Read activity when the document is not currently being shared you will get an empty document.

== Planned Features ==

* Nothing new planned at the moment. I'm still focusing on getting TTS working better, and also book sharing.

== Activity .xo file ==

* [[media:ReadETexts-8.xo|ReadETexts.xo]] v.8


{{Developers}}

== Bugs ==

* The activity, like core Read, uses metadata to save the page number the reader was on when the user exits the activity, and it should go to that page when the activity is resumed. This works while the XO is running; you can exit the activity, go do something else, then resume the activity and it will return to the correct page. However, the metadata will not be present after you restart the computer, so resuming will take you back to page 1. This is actually a bug in the Journal activity (which has been fixed in an unreleased version of Sugar), but since this is the most common complaint against the Read activity I thought I should document the problem here.
* When changing font sizes, the first attempt to change the font size will produce a font that is comically large. After that you can adjust the font size with no problems. I cannot recreate this bug in my test environment. It only happens on my XO.
* Text to speech does not work perfectly. Some word are spoken but never highlighted. Sometimes highlighting lags a bit behind speech, but it generally catches up again. The problem of skipped highlighted words may be an issue with espeak. Speech-dispatcher receives callbacks when espeak encounters XML text marks in the text to be read. These marks are placed before each word in the text by my Activity. It seems that a few times per page espeak will omit doing these callbacks. I am told that festival works better than espeak when doing these callbacks, but espeak is what is bundled with the XO software.
* Because the current implementation of text to speech needs a multi-threaded application to work, power management might not kick in when using this app if you have speech-dispatcher installed. (It works OK if you don't install speech-dispatcher). This is an issue with Python that should be resolved with a newer version of Python or a version of speech-dispatcher that doesn't need multiple threads. For now, if you don't intend to use speech-dispatcher don't install it.
* Sharing documents does not always work, for reasons explained in the "Bugs" section of the View Slides activity. This seems to be an issue with Salut on the Mesh network. When using gabble with a regular internet connection sharing works OK.
* There is no word-wrap feature for books with long lines. At the moment I consider this more of a feature than a bug, because all of the many thousands of Project Gutenberg Etexts available use a standard line width so word-wrapping isn't really necessary.

== Source ==

http://git.sugarlabs.org/projects/readetexts

[[Category:Software]]
[[Category:Developers]]
[[Category:Sugar]]
{{Activity page
|icon=Image:readetexts.png
|genre=General Search and Discovery
|short description=Allow the XO laptop to read Project Gutenberg ETexts, which are plain text files. The core Read activity will eventually support this, so you can consider this activity to be a useful stopgap.
|contact person=James Simmons
|activity source=http://git.sugarlabs.org/projects/readetexts
|bundle URL=http://wiki.laptop.org/images/e/e8/ReadETexts-8.xo
|activity version=8
}}
{{Activity bundle
|bundle URL=http://wiki.laptop.org/images/e/e8/ReadETexts-8.xo
|activity version=8
}}
}}

Latest revision as of 07:16, 19 June 2009

?Sugar icon}}    This activity is now hosted at the Sugar Activity Library.

The information here is likely to be out-of-date. Consult the new pages for "Read Etexts" first:

Retrieved from "http://wiki.laptop.org/mediawiki/index.php?title=Read_Etexts&oldid=210505"