noor 0.4

A python Quran viewer

Overview

Noor is a program written in Python for viewing quran. You can specify translation files; If specified the translation of each aya is shown after it. These are the interfaces that come with noor:

Interface	Description
noorgtk	Uses PyGtk library
noorhtmls	Outputs quran in html files in the output directory
noorcgi	Can be used as a CGI script in web servers
noortxt	Outputs a sura to a text file

New Features

• handling text direction for ltr translations in noorhtmls

• added html.fgcolor, html.bgcolor and gtk.fgcolor option

• added cgi.url option

• added common.arabic_numbers option

See the configuration file section for the description of these new options.

Getting Started

noorgtk

For using the GTK interface you need to install Python and PyGTK (they are installed by default in some linux distributions like Ubuntu). You can start it by running noorgtk.py script either from the command line or by double clicking it in the extracted folder. That is, no installation is necessary.

But if you like, you can run python setup.py install to install Noor. After that you’ll be able to run noorgtk.py in the terminal from any location.

noorhtmls

The noorhtmls interface can be used to output quran in html files in a directory. All you should do is to run:

noorhtmls.py output_folder

The index.html file will contain the list of suras and 001.html through 114.html files will contain the suras. Note that the configuration specified in the ~/.noor file is considered when generating the pages.

noorcgi

Installing the CGI script, noorcgi.py, is like installing any other CGI script. You probably have to copy it to the cgi-bin directory of your web server. But before that you should either install noor as described in the noorgtk section or change the line in noorcgi.py file which looks like:

# Add noor to the python path if its not installed:
sys.path.append('/noor/extracted/folder/')

to point to the folder in which you’ve extracted noor. Note that if you want to use the CGI interface you no longer need to install PyGTK.

Adding Translations

You can edit the ~/.noor file:

[common]
translation = /path/to/translation/file

The translation file can be in two formats. It can be either a zip file in the same format as Zekr translation files which can be obtained from http://siahe.com/zekr/resources.html or it can be a utf-8 text file with translation of each aya in one line.

Changing Font

You can change the GTK or html fonts in ~/.noor file:

[gtk]
font = nazli 19

[html]
font = nazli 6
translation_font = homa 4

Note that “html” section of config file is applied to both noorcgi and noorhtmls interfaces.

noorgtk keys

These keys can be used in the GTK interface for moving the text. Note that C- stands for control key, M- for alt key and S- for shift key.

Action	Keys
move down	j, C-n
move up	k, C-p
next page	space, C-v, PgUp
previous page	S-space, M-v, PgDn
quit	q

Configuration File

You can specify configuration options in ~/.noor file. Here is the list of all options with a short description for some of them:

[common]
# the translation file
translation = /path/to/translation.file

# should noor use arabic aya numbers
arabic_numbers = 1

[gtk]
# the font to use
font = my font name 16
fgcolor = black

[html]
# the font to use
font = my font name 5
translation_font = my font name 4
fgcolor = black
bgcolor = white

[cgi]
# the url noorcgi.py is mapped to in the server
url = noorcgi.py