Sword read: Difference between revisions

From OLPC
Jump to navigation Jump to search
mNo edit summary
(Undo revision 275931 by Tonyforster (Talk))
 
(22 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{olpcboxtop|toptext={{PAGENAME}}|Sword read}}
{{olpcboxtop|toptext={{PAGENAME}}|Sword read}}
{{ OBX activity |[[Image:sword-read-icon.png]]|extra}}
{{ OBX activity |[[Image:sword-read-icon.png]]|extra}}
{{ OBX xobundle|http://wiki.laptop.org/images/b/b7/Swordread-1.xo}}
{{ OBX xobundle |http://wiki.laptop.org/images/0/03/Sword_read.xo}}
{{ OBX team |[[User:daryld|Daryl Daly]]}}
{{ OBX team |[[User:daryld|Daryl Daly]]}}
{{olpcboxbottom}}
{{olpcboxbottom}}


A reader for Biblical and other text modules configured for the [http://www.crosswire.org/sword Sword] project. Allows for easy browsing of the Bible by reference.
A reader for Biblical and other text modules configured for the [http://www.crosswire.org/sword Sword] project. Allows for easy browsing of the Bible by reference.

[[File:Sword read.xo|Download Sword Read]]


[[Image:Sword-read-activity.png|thumb|Sword read activity screenshot]]
[[Image:Sword-read-activity.png|thumb|Sword read activity screenshot]]


At first sight one is puzzled, because the threshold to be overcome seems to be the same in both cases. ,
== How to Install ==
Download this '''.xo''' file using the Browse activity: [http://wiki.laptop.org/images/b/b7/Swordread-1.xo Swordread-1.xo]


== Release Notes ==
== Release Notes ==
=== v1 ===
Basic functionality. Enter a bible reference (i.e. Matt 1:1) and the chapter is shown with the verse selected. The current module (Bible version) used is the [http://www.ebible.org World English Bible (WEB)]. I would like to change this to a version that is more Child oriented. Please let me know if you have any suggestions.


=== v3 ===
*update activity.info
*patch sword.so to use libpython2.7

=== v2 ===
*added chapter and book navigation
*some code cleanup

=== v1 ===
Basic functionality. Enter a bible reference (i.e. Matt 1:1) and the chapter is shown with the verse selected. The current module (Bible version) used is the [http://www.ebible.org World English Bible (WEB)]. I would like to change this to a version that is more child oriented. Please let me know if you have any suggestions.


== TODO ==
== TODO ==
Line 23: Line 32:
*add selection option to choose reference
*add selection option to choose reference
*speech (?) using eSpeak
*speech (?) using eSpeak
*shared with remote reading and follow along (Karaoke style)
*shared with remote reading and follow along (Karaoke style) for literacy
*format text to increase readability
*add modules containing texts, dictionaries, and commentaries from other religions
** Qur'an, Muslim
** Sri Guru Granth Sahib, Sikh
** Tipitaka and Tripitaka, Buddhist
** Kanjur, Tanjur, Buddhist
** Vedas, Upanishads, Bhagavad Gita, Hindu
** Laozi, Juangzi, Daozang, Daoist
** Confucius, Mencius, Confucian
** Talmud, Jewish
** Popul Vuh, Mayan
** More

[http://www.crosswire.org/wiki/index.php/DevTools:Modules Instructions for creating modules]

Test case: [[Heart Sutra]]/Prajna Paramita Hrdaya Sutra


== Feature requests ==
== Feature requests ==
Please add any features you would like added
Please add any features you would like added
* it'd be nice if there were some basic navigation buttons, such as next chapter and previous chapter, and maybe a dropdown menu for all the books --[[User:Moocapiean|Moocapiean]]
** Implemented.
* The New International Reader's Version (NIrV) is specifically worded to be read easily by children. You may want to include that as default module. --[[User:leetcharmer|leetcharmer]]
* leetcharmer - The NIrV would be nice, but it's not public domain (see http://www.ibs.org/bibles/termsofuse.php) and I think we want to make sure the translation is public domain so that there are not copyright issues for us or for users. A public domain, english translation of the Bible which uses a smaller than usual vocabulary and may thus be appropriate for children and those learning the language is the Bible in Basic English (BBE). It is available as a Sword module. --[[User:jenpc|jenpc]]
{{Activity page
|icon=Image:sword-read-icon.png
|genre=Documents (Read, Write, and Share)
|short description=A reader for Biblical and other text modules configured for the Sword project. Allows for easy browsing of the Bible by reference.
|long description=Please add any features you would like added

* it'd be nice if there were some basic navigation buttons, such as next chapter and previous chapter, and maybe a dropdown menu for all the books --Moocapiean
:o Implemented.
* The New International Reader's Version (NIrV) is specifically worded to be read easily by children. You may want to include that as default module. --leetcharmer
* leetcharmer - The NIrV would be nice, but it's not public domain (see http://www.ibs.org/bibles/termsofuse.php) and I think we want to make sure the translation is public domain so that there are not copyright issues for us or for users. A public domain, english translation of the Bible which uses a smaller than usual vocabulary and may thus be appropriate for children and those learning the language is the Bible in Basic English (BBE). It is available as a Sword module. --jenpc
* I strongly suggest NET or ESV versions. They are highly regarded for their translation work, easy read, and also their translation foundations are known for being easy to work with --Torokun

|contact person=User:Daryld
}}
{{Activity bundle
|bundle URL=http://wiki.laptop.org/images/7/78/Swordread.xo
}}

Latest revision as of 10:43, 19 October 2012

Sword read
Sword-read-icon.png

A reader for Biblical and other text modules configured for the Sword project. Allows for easy browsing of the Bible by reference.

File:Sword read.xo

Sword read activity screenshot

At first sight one is puzzled, because the threshold to be overcome seems to be the same in both cases. ,

Release Notes

v3

  • update activity.info
  • patch sword.so to use libpython2.7

v2

  • added chapter and book navigation
  • some code cleanup

v1

Basic functionality. Enter a bible reference (i.e. Matt 1:1) and the chapter is shown with the verse selected. The current module (Bible version) used is the World English Bible (WEB). I would like to change this to a version that is more child oriented. Please let me know if you have any suggestions.

TODO

  • lots !!!
  • change default module
  • add ability to download additional modules
  • add selection option to choose reference
  • speech (?) using eSpeak
  • shared with remote reading and follow along (Karaoke style) for literacy
  • format text to increase readability
  • add modules containing texts, dictionaries, and commentaries from other religions
    • Qur'an, Muslim
    • Sri Guru Granth Sahib, Sikh
    • Tipitaka and Tripitaka, Buddhist
    • Kanjur, Tanjur, Buddhist
    • Vedas, Upanishads, Bhagavad Gita, Hindu
    • Laozi, Juangzi, Daozang, Daoist
    • Confucius, Mencius, Confucian
    • Talmud, Jewish
    • Popul Vuh, Mayan
    • More

Instructions for creating modules

Test case: Heart Sutra/Prajna Paramita Hrdaya Sutra

Feature requests

Please add any features you would like added

  • it'd be nice if there were some basic navigation buttons, such as next chapter and previous chapter, and maybe a dropdown menu for all the books --Moocapiean
    • Implemented.
  • The New International Reader's Version (NIrV) is specifically worded to be read easily by children. You may want to include that as default module. --leetcharmer
  • leetcharmer - The NIrV would be nice, but it's not public domain (see http://www.ibs.org/bibles/termsofuse.php) and I think we want to make sure the translation is public domain so that there are not copyright issues for us or for users. A public domain, english translation of the Bible which uses a smaller than usual vocabulary and may thus be appropriate for children and those learning the language is the Bible in Basic English (BBE). It is available as a Sword module. --jenpc

Activity Summary

Icon: Sugar icon::Image:sword-read-icon.png
Genre: Activity genre::Documents (Read, Write, and Share)
Activity group: ,|x|Activity group::x}}
Short description: Short description::A reader for Biblical and other text modules configured for the Sword project. Allows for easy browsing of the Bible by reference.
Description: [[Description::Please add any features you would like added
  • it'd be nice if there were some basic navigation buttons, such as next chapter and previous chapter, and maybe a dropdown menu for all the books --Moocapiean
o Implemented.
  • The New International Reader's Version (NIrV) is specifically worded to be read easily by children. You may want to include that as default module. --leetcharmer
  • leetcharmer - The NIrV would be nice, but it's not public domain (see http://www.ibs.org/bibles/termsofuse.php) and I think we want to make sure the translation is public domain so that there are not copyright issues for us or for users. A public domain, english translation of the Bible which uses a smaller than usual vocabulary and may thus be appropriate for children and those learning the language is the Bible in Basic English (BBE). It is available as a Sword module. --jenpc
  • I strongly suggest NET or ESV versions. They are highly regarded for their translation work, easy read, and also their translation foundations are known for being easy to work with --Torokun]]
Maintainers: ,|x|Contact person::x}}
Repository URL:
Available languages: ,|x|Available languages::x}}
Available languages (codes): ,|x|Language code::x}}
Pootle URL:
Related projects: Related projects,|x|Related projects::x}}
Contributors: ,|x|Team member::x}}
URL from which to download the latest .xo bundle Activity bundle::
Last tested version number:
The releases with which this version of the activity has been tested. ,|x|Software release::x}}
Development status:
Ready for testing (development has progressed to the point where testers should try it out): ,|x|Ready for testing::x}}
smoke tested :
test plan available :
test plan executed :
developer response to testing :


URL from which to download the last .xo bundle that works with old releases Activity bundle::http://wiki.laptop.org/images/7/78/Swordread.xo
Activity version number: Activity version::
The releases with which this version of the activity has been tested. ,|x|Software release::x}}
Development status: