Home

بِسْمِ اللّهِ الرَّحْمـَنِ الرَّحِيم

Tutorials to the free Open Source Quran Software "Open Quran 1.9"

Download OpenQuran 1.9.17 05.04.2010

( OpenQuran is although available as online Version HERE )

Quick Flash Tutorials

Video tutorials

Making OpenQuran in your own native language

Tutorials to Open Quran v. 1.9.16

 

Introduction

Most Quran Software are consisting of a Quran version and some translations, which users can't choose or change. For studing purpose this can't help much and the user has to use many software for getting results which has to be written else where.
OpenQuran is in this case very easy to use and can be developed the way the user like to.
Including own version of Quran and with many translation as possible.
Writting own Comments to every Vers in the Quran, also importing written comments.
Viewing some verses with own comments inbetween, This can be saved as *.oq file and shared with other OpenqQuran users.
OpenQuran can be translated easly to any language by changing a xml file
Suras names can be changed although the way user like to
and many other options.

Requirements

OpenQuran is built using MS, C# programing language. To use it, you need to have the .NET Framework at least version 2.0 installed on your machine. If you're running Vista, you already have it. If you're running Windows XP, you can download it here.

Sorry, OpenQuran doesn't work on a mac or on earlier versions of Window!

Installing OpenQuran

1. Download the latest version of OpenQuran from our site (www.openquran.de).
    
2. Run oq_setup.exe and follow instruction in the Installation wizard.
    
3. OpenQuran can be run on any System which has Net Framework 2.0 (or higher) from Microsoft. If you still don't have it, download from the MS site and install.
    
4. When you run OpenQuran for the first time, you will notice, that there are no translations (only the arabic Quran and an empty comments tables). Open Quran is delivered with a Quran table which consists of 6234 lines. It means that sura 9 has only 127 verses. But you decide by your self at the beginning whether you want that Sura 9 has to be 127 or 129 verses. Once you decided for one of them, this means all of other translations which you like to include later must have the same number of Verses. If you choose Sura 9 with 127 Verses this means your Quran versions/translations consists of 6234 Verses otherwise 6236 Verses.
    
5. To include a new translation, see the "include" part of this document 

Including new Translation

In Open Quran we can easly include any translation we like. The translated file has to be a txt-file and every Verse in it must be on 1 line (Not seperated to many lines). Be sure that txt file has to be converted first to UTF-8 (universal code)
If your txt file does'nt have the right formate, do as follow

1. Select all text (Ctrl+A)
2. Cut text to Clipboard (Ctrl+X)
3. Change the Uni code of the text file (deppends on your text editor) to UTF-8
4. paste Text (Ctrl+V) again and save

Now the txt-file is ready to include in the database of Open Quran. To include the txt-file if our new translation, we do as follow:

1. Start OpenQuran
2. Click on the Menu " Tools" and choose "Text To Data"
3. Now we need the txt file which has our Quran version. If you did not download any txt file, you can do that by visting our site, where you can find some of them.
4. In the Options Window we want to tell the program whether Sura 9 of our quran version or translation consists of 127 or 129 Verses. (Does Sura 9 have 127 or 129 Verses?)
   (usualy open quran is deliverd with 127 verses for sura 9. But you can delete and include your arabic version with 129 verses)
5. If your txt file has Sura and Vers Numbers, than check this box: (My text file has already sura and vers numbers like this example). Sura and Vers numbers must be written in the right manner as the Example show
6. (Language) is the Language used in the text file
7. (Publisher) The name of the translator or author of this script
8. (Comment) For now you don’t need to change
9. (Sort) This tells how the program should sort the translations. A Number will be automaticly generated. You can change now or later in the options of OpenQuran
10. (Text Direction) For text files which written in arabic or hebrew similar languages Choose between (right to left) or (left to right)
11. After including the text file you can see how the verses are sorted. If everything went OK, just click the Button underneath (Save Access file) The new txt file is included and can be seen and used after restarting OpenQuran (v. 1.9.4 no need to restart)

Hint: Never include the same txt-file 2 times. First delete the older one from the options, than include again

Show selected Sura

Double clicking a Sura name will show you the whole Sura. But you can select more than one sura by holding the Ctrl-key down and choosing with mouse the suras you like to see. After selecting the Suras click on the left Mouse key and choose (Show selected) .

There are also many selection variations:

• "Initialed" (all Suras which begins with initiales),
• "Uninitialed" (Suras which have no initiales),
• "Meccan" suras (Suras revealed in Mecca) and
• "Medinan" (Suras revealed in Medina)

Changing the order of Suras by:

• "Revelation" or
• "Chronological" and
• "Alphabeticaly" or
• "ABGD" (Old arabic order of Alphabets)

Changing Suras Names to your own language

In this version of Openquran we've included only the arabic names of the Suras. If you would like to change the Suras names to your own native language or any other language, do as follow:

1. Open the Folder where OpenQuran saves the database and options (My Documents\openquran)
2. Open folder (xml)
3. you'll find a file called (suranames.xml). Open the file with any txt editor
4. There are 114 lines showing sura numbers and names like this line:
   <sura Nr="001" name="الفاتحة" />
5. Change the content of the name as you want to: name="The Key"
6. save file and restart OpenQuran to see changes on the left side of it
7. Do the same to all 114 Sura names. Save the xml document and run Openquran

Hint: Before changing the names of the suras, make a copy of the file (suranames.xml) in case you did anything wrong

 

Browser RightClick

Some functions which are in the upper menu are added to the right click also, such as: Navigating fore- and backwards, select all and copy

Search selected (Alt+F): any selected word or phrase in the browser can be send to search box

Show selected Sura (Ctrl+Alt+Space): selecting any verse number from the browser and clicking this option will navigate directly to choosen Sura. Selecting 2 numbers with double point inbetween (e.g. 1:1) will show the choosen verse.

Sort Verse numbers: This option shows only verse numbers from displayed verses (such as search results) in case we would like to share only the numbers of verses with some one else. It shows also the count of "even" and "odd" verse numbers.

Sort only text: Browser content will be clearyfied from all formating, if we need only the text.

Write comments (Alt+C): selecting a verse numbers (e.g. 1:1) and choosing write comments will lead directly to the "comments Editor" to write comments to the choosen verse

Gematrical Value: If you select the verse text und choose "Gematrical Value", OQ will calculate ths value of every letter and give the sum of the whole verse/s. If did not select a text, this will prompt a popup window letting you type your own text (Only for arabic language).
The (P) beside the number means that the Result is a prime number.
Also if result is divisible to 19, this will be shown. To change the divisible number, click on the "statusbar" and type your number.

Writing Comments

1. Choose in the Menu (File) => (Write Comment)
2. Type the Sura and Vers numbers that you like to add your comments to and click "OK"
   The other way is to select Sura and Vers number from the browser and choose (File) => (Write Comment) or just press Alt+C. This will lead you directly to the choosen Vers in the Comments-Editor.
3. On the status of the editor you see the Sura and Vers numbers. Write your Comments and save

Now doubleclick on the sura name in which you included the comment. If the table of comments is checked (translations tab), you'll see what you wrote under the choosen Vers of Quran

To use the "HTML fomating menu" in the "Comments Editor", select the txt and right click to change color, font, style etc….

Translations Tab

The "Translation Tab" of Open Quran shows all translation tables, which are installed in your database.
We need to select at least one of them to browse the information we require.

Right click menu:

• Select All of the tables
   
• Refresh in case we add a new translation from "Text to data" menu (See "Including new translation" part in this document).
   
• Move UP or DOWN sorting table
   
• Make writable for your own comments
   
• Remove selected table (this option can't be undo!!!)
   

Search box RightClick

To search for any letter, word or phrase, choose first from the "pulldown" menu in which table to search in.

Search (Return): searching for letter, word or phrase in the search box

Match Whole Word: Select this Checkbox in case you're looking for a phrase, else OQ willl search for every word in this phrase alone

Case Sensitive: Search for the same letter/word/phrase

Whole Quran: will search in the whole quranic text

Only in selected Sura: Select one or many Suras from the Suras Names (Down left) to search only in them

Within Browser Content: It allows user to search many times in the same browsed text

Right Click on the searchbox

Analyse (Alt+Space): The result of search will show only calculated numbers of Enteries, Suras, Verses, count of letters etc….

search unique: count(); function allows user to find letters, words or phrases with a specifed repitation in every verse.
( S means searched letter/word/phrase)
( = means equal to the specified number)
( < smaller than specified number)
( > bigger than specified number).
Examples:

1. count(S=2); // Verse must have 2 such letters or Words
   count(ك­=1); // search for all verses that have 1 letter ك­
   count(ي|س=2); // search for ي or س that appears only 2 times in every verse
2. count(S<2); // Verse must have smaller than 2 such letters or words
   count(ب<4); // search for verses which have at least 1 ب and not more than 3 Ù† letters
3. count(S>2); // Verse must have bigger than 2 such letters or words
   count(ب>2); // search for verses which have 3 ب and more
4. cutSpace(يس); // OQ will cut spaces from verses before searching

   in OpenQuran v. 1.9.16 we added another 3 function:

5. gv(l=10); // search for (l)etters  whicht have the gematrical value of 10
6. gv(w=19); // search for (w)ords which have the gematrical value of 19
7. gv(v=228); // search for (v)erses which have the gematrical value of 228
   
   Hint: The first example shows us, that the use of "Regular Expression" in the count(); function is allowed under the condition that the 3 symbols = < > don't be used.

Clear Search (Ctrl+del): deleting content of the searchbox

Select all, Copy, Cut and Paste are added to the search box

RTL (RightToLeft Searchbox direction)

Search result colorize function (changing the color of search results)

The new methode of OpenQuran allows although searching for Numbers of verses. There are 2 ways to to look for a specified number:

1. by typing the number with or without duoble points inbetween: 2:7
2. or by using "Regular Expressions" numbers methodes such as: \d+:3[ ] (This will browse every third verse from every sura)

SearchResults are set in the statusbar which shows beside founded Enteries although the amount of Verses

Declaring own search expressions

If you press ( F9) a listBox will appear under the searchBox, which contains some expressions that can be usefull by searching.
All expressions listed here are saved in a xml file: "C:\My Documents(or User)\User name\openquran\xml\expressions.xml".
Users of OpenQuran can edit or modify this listBox by opening the expressions.xml. All we have to do is to add one more Tag like this one:

<sura exp="Your Expression " meaning="Explanation for this expression-…. " />

between <quran> … and … </quran>

Save the file and restart Openquran to see/use the new expression.

 

Using Nav

If you are looking for few Verses which you like to keep to your Document, (NAV) will do you this service besides you can add some comments to the choosen verses. The following Example will show you 3 different verses with your own comment:

Copy the following line into the NAV Textbox:

(The Phrase "Besm Allah" occures 3 times in the Quran) 1:1 11:41 27:30

Underneath the Textbox choose (File) => (Run Code) or press (Alt+Space) to run the code. In the Browser you'll see the comment and the 3 verses which you choosed.

• To write Comments use easly parenthesis ( )
• For a whole sura, you need only the Number of it. (I'm showing you Sura number 1) 1
• By specified Vers, sura and vers number must be seperrated with double points 1:1
• By specifying a range of verses in a sura, use hyphen as shown 1:1-3 (This will show sura 1 vers 1 to 3)

OpenQuran can also handel *.oq files which can be written with any Text-Editor such as Notepad.
Save your file (e.g. myfile.oq) and open it (or drop it on OpenQuran.exe). OpenQuran will start in this case and run the file in NAV Tab by it self.

Hint:

1. You are allowed to use only such signs in your commenst ( – , ; : . " ' and HTML Tags for formating your comments )
2. If the Text box too small for your work, you can use any other Text-Editor; save the text file to your harddisk as *.oq file (e.g.: myText.oq) , than you can load it within Open Quran => (Nav) window and run the code.

 

Using Calc

With version 1.9.8 of OpenQuran we included a new Tab for large numbers Calculations (Calc).

We can directly select search results from the Browser and send them to "Calc" by right clicking the mouse on the selected verses.

Right MouseClick on the CalcTab opens the options menu, where we can choose whether we need to calculate

1. Only Verse Numbers (F5) (Only if double points : is set between sura- and verse number)
2. Only Sura Number (F6) (Only if double points : is set between sura- and verse number)
3. Set Counts before: will put a continuous number before every verse number (F7)
4. Set Count after: will put a continuous number after every verse number (F8)
5. The divisible number (the number used for our calculations) can be changed to any number we want to

 

Hijri /Gregorian Calendar

The calendar shows only the gregorian date. At the bottom there is also hijri date and an image of the moon periods.

In version 1.9.9 of OpenQuran we included a Multi Time Organizer (MTO), which plays a specified sound when the given date and time are reached.

To inculde your own dates click on the upper menu (Tools => Options => Timer)

To write own dates, double click on the left sided TextBox to make it editable. After writing your dates double click again to save.
Adding a new date must be sorted in the right sequencing like the next example:

23.11,17:03;
23.11,17:04;
24.11,05:05;

Typing a single number time or date has to begin with 0 like  (05:05) and not as (5:5)

For daily use of always same times, type 00.00 for the date:

00.00,07:00;
00.00,12:30;
00.00,17:55;

Here you can also change the sound of the alarm or de- activate the Timer.

Options

Changing Sort or Deleting one of quran edition / translations

1. Click in the Menu (Tools) => (Options)
2. The first Tab (Sort/Delete) shows all translations included in OpenQuran
3. Choose the one you like to change
4. write another number of sorting and click (Change Sort)

If you want to delete the translation or version:

• Choose the one you like to change and Click the Button (Delete)

* You need to restart Openquran (No need in v. 1.9.3) after changing Sort or deleting one of the tables

Configuring Font color and size

In the second Tab of the Options window (Fonts / Comments Table) you can change font style of every translation or version

1. Choose a translation/Version from the "pulldown menu"
2. Change font family and size
3. Change forecolor of the text
4. Change back color of the text
5. (Right To Left) changing the direction of the Text
6. Choosing comments table

(Check this as Comments table) means that this table is specified for writting your own Comments. You can use only one table for own Comments. To write own Comments see the part "Write Comments" in this document.

Diverses

1. In this section, we can set the color of the search results. <b> Bold <i> italic <u> Underline
2. Change order of Suras Names
3. set a background color or a background image of your browser
   Fixed: Non scrollbar image
   Vertical: Repeat image in vertical position
   Horizontal: repeat image in Horizontal position
   Vertical + Horizontal: repeat image in vertical and horizontal positions

OQ Folders

In OpenQuran we can define more than one folder for our options/database configurations. In such manner we can have our program with different translations and interfaces. It's also usefull when changes in the options assumed which result errors, in this case we can set the path to the backup files and restart OpenQuran.

Keyboard Shortcuts

 

Upper Menu Shortcuts
Alt+C	Copy selected Sura/vers number and activate Comments Editor
Ctrl+P	Print Browser contents
Alt+F4	Exit OpenQuran
Ctrl+left	Go Backward
Ctrl+right	Go Foreward
Ctrl+F	Show Search Tab
Alt+F	Copy selected word from Browser and throw it in the search box
Ctrl+T	Show translations Tab
Nav Tab Shorcuts
Ctrl+N	Write a new Nav comment
Ctrl+O	Open existing Nav comment
Alt+Space	Run Nav Code
Ctrl+S	Save Nav comment
Ctrl+Shift+S	Save as a new comment
Ctrl+R	Change direction of the Nav box to the right
Ctrl+Up	A bigger Nav box height
Ctrl+Down	A smaller Nav box height
Alt+Up	get bigger font size
Alt+Down	make font size smaller
Table of Suras Names
Ctrl+A	Select all
Space	Show specified Suras
Comments Editor Shortcuts
Alt+N	Write new Comment
Alt+S	Save Comment
Crtl+P	Print Comment
Ctrl+Shift+P	Print Preview
Ctrl+R	Change direction of the Editor Right to left
Ctrl+H	Show HTML of your Document
Ctrl+Z	Undo
Ctrl+Y	Redo
Ctrl+A	Select all Text
Ctrl+C	Copy selected Text
Ctrl+X	Cut selected Text
Ctrl+V	Paste Clipboard contents
Ctrl+B	Make selection Bold
Ctrl+I	Make selection italic
Ctrl+U	underline your selection
Ctrl+L	Add link

 

LICENSE

Open Quran 1.9. is free software:

you can redistribute iit under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should see a copy of the GNU General Public License under http://www.gnu.org/licenses/

 

About and Contact

OpenQuran was created by me, Ayman Teryaki. You can read my blog at www.openquran.de. If you find bugs (you probably will) send them to me and I'll try to take care of them. InshaAllah

If you believe that OpenQuran helped by doing a good job for your studies, you can help poor people as well by donating any sum of money on S.O.S Kinderdorf: or any aid organisation you like.

Thank God for good future

Regards and Salam

 

The open Quran team wishes you success on your way. Inscha Allah. Coworker:

Ayman Teryaki deutsch / english / عربي www.openquran.de

Hasan Oztürk deutsch, english, türkçe

Bouqdib Elarabi french, english / عربي/ spanish www.openquran.de

Kerem A. www.alrahman.de deutsch / english / türkçe

Mohammed deutsch / english / عربي www.nur-koran.de

Önder K. deutsch / english / türkçe

* * * * ** * * ** * ** **