Data are packaged into a directory which contains subdirectories and
several files describing the data. A package can contain the original
Quran text, or a translation or an audio set at minimum and can have
more than one translation or one audio set (but there shall be no more
than one the Quran text).
The original Quran text shall be provided only by the Arabeyes to make
it easier to control the content. The package name for the Quran text
is 'arabeyes.org', and it is the package which will be read by
libquran when it is asked to retrieve the original Quran text.
However, vendors or packagers can distribute their packages containing
translations or tafsirs or audio and there shall be no conflicts
between them.
The location of the package is arbitrary (the default known by the
libquran in Linux is /usr/share/libquran/data/) and the client can ask
the library to open the package from any place in the system as long
as it is local.
Data have a structure like this:
package-name/
text/
files/
text.db
license.txt
translations/
<id>/
files/
text.db
name.txt
language.txt
license.txt
additional-info.txt
audio/
<id>/
files/
s001001.spx
s001002.spx
....
name.txt
recitor.txt
language.txt
license.txt
mime-type.txt
additional-info.txt
- text: Holds the original text of Al Quran
license.txt: license of the text file
- translations: Holds the translations or the tafsirs
<id>: An string id distinguishing the translations/tafsirs (e.g. yusuf_ali)
name.txt: contains the name of the translation/tafsir (e.g. Yusuf Ali)
language.txt: contains the language code of the translations/tafsirs
in iso 639 format
license.txt: license of the text file
additional-info.txt: contains other info for the
translations/tafsirs (e.g. copyright info, etc)
- audio: Holds the audio
<id>: An id distinguishing the audio set (e.g. holy_quran_recitation)
name.txt: contains the name of audio data (e.g. Holy Quran Recitation)
recitor.txt: contains the recitor(s)
language.txt: contains the language code of the recitation in iso 639 format
license.txt: license of the text file
mime-type.txt: The mime-type of the audio set (e.g. "audio/mpeg")
additional-info.txt: contains other info for the
translations/tafsirs (e.g. copyright info, etc)
_______________________________________________
Developer mailing list
[email protected]
http://lists.arabeyes.org/mailman/listinfo/developer
