ºÝºÝߣ

ºÝºÝߣShare a Scribd company logo
Alfanous
Quran Search Engine API
(for Developers)
By +Assem Chelli | @assem-ch
What is Alfanous ?
Alfanous (The Lantern - ? ) ????????is an Arabic
search engine API that provides the simple
and advanced search in the Holy Quran,
including
interfaces...

lot

of

features

and

many
Why Alfanous?
1. Alfanous is a Search Engine: not just a search tool.
2. Alfanous is FREE LIBRE OPEN SOURCE: Anyone can use it ,
anyone can contribute in coding, translating, design...etc. the
source code is here!
3. Alfanous is a Python API: that allows anyone to create
independently a web interface, desktop interface ,
Android/Iphone/Windows phone interfaces , facebook/twitter/G+
applications ...and so on.
4. Alfanous is a research project : so we figure out how to improve
search features and introduce new ones..
5. Alfanous has lot of features.
6. Alfanous has many interfaces for many platforms
7. Alfanous is FREE GRATIS: no payment, no ads.
Contact Info
Author
Name: Assem Chelli (?)???? ????
Email: assem.ch@gmail.com
Github: @assem-ch
Project
Mailing list: alfanous@googlegroups.com
Feedback: feedback.alfanous.org
Website: www.alfanous.org
Github: https://github.com/Alfanous-team/alfanous
Contributors: Contributors
Interfaces Dependency Hierarchy
Console Interface
$ sudo easy_install alfanous
$ alfanous-console -h
$ alfanous-console -a search -q qawl
Json Web Service
Url: http://www.alfanous.org/jos2
Wiki: https://github.com/Alfanousteam/alfanous/blob/master/src/alfanous-cgi/README.rst
Terms of use
¡ñ This service is free to use.
¡ñ Don't name your application "Alfanous" before we are
okey about that.
¡ñ We highly recommend to refer Alfanous engine
somewhere in your pages using icons or texts like
"Alfanous engine", "Powered by Alfanous.org", or
"Based on Alfanous.org" linked to "http://www.alfanous.
org" or "http://www.alfanous.org/jos2".
¡ñ We highly recommend to describe clearly somewhere in
your application the relation to the whole Alfanous
project, such as an about button.
¡ñ Art works you may need are available here, the Art is
licenced with AGPL license.
How to inquire?
Syntax : http://www.alfanous.org/jos2?ARGUMENT
Argument is a chain of flags:
# action to perform
1. action: ¡°search¡± | ¡°suggest¡± | ¡°show¡±
# search unit
2. unit: ¡°aya¡± | ¡°word¡± | ¡°translation¡±
# query attached to action
3. query: a string
eg: http://www.alfanous.org/jos2?

action=search&unit=aya&query=???????
Extra Request flags 1
# sorting order of results
sortedby: ¡°mushaf¡± | ¡°tanzil¡± | ¡°score¡± ... see more
# page number
page
# results per page
perpage
# recitation id
recitation
# translation id
translation
#script of aya text
script : ¡°standard¡± | ¡°uthmani¡±
Extra Request flags 2
# enable vocalization of aya text
vocalized: "true" | ¡°false¡±,
# romanization system
romanization: ¡°buckwalter¡± | ¡°iso¡± | none,
# highlight method
highlight: ¡°css¡± | ¡°html¡± | ¡°bold¡± | ¡°bbcode¡±
# fuzzy search
fuzzy: ¡°true¡± | ¡°false¡±

see full details
Minimizing/Enriching results
aya_stat_info ? enable aya stat information retrieving
annotation_word ? enable query terms annotations retrieving
word_info ? enable word information retrieving
sura_stat_info ? enable sura stats retrieving
word_synonyms ? enable retrieving of keyword synonyms
word_vocalizations ? enable retrieving of keyword vocalizations
aya_sajda_info ? enable aya sajda information retrieving
next_aya ? enable next aya retrieving
aya ? enable retrieving of aya text in the case of translation search
prev_aya ? enable previous aya retrieving
sura_info ? enable sura information retrieving
annotation_aya ? enable aya words annotations retrieving
word_derivations ? enable retrieving of keyword derivations
aya_theme_info ? enable aya theme information retrieving
aya_position_info ? enable aya position information retrieving
# pre-defined configuration for what information to retrieve
view: ¡°normal¡± | ¡°minimal¡± | ¡°full¡± | ¡°statiscal¡± | ¡°linguistic¡±
How to parse the results
Request Url: http://www.alfanous.org/jos2?
action=search
&unit=aya
&query=????????
API meta info
You can request meta info by using:
action: ¡°show¡±
&query: all | translations |recitations |
information | hints | surates | chapters | defaults
| flags | fields | fields_reverse | errors | domains
| help_messages
eg: http://www.alfanous.org/jos2?
action=show&query=surates
Advanced Queries Examples
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ
¡ñ

Simple search: ???????
Phrases : " ?"??????
Logical relations - ANDNOT : (?)????? - ???????
Logical relations - AND : ?????? + ???????
Logical relations - OR : ?????? | ???????
Joker * : *?*????
Joker ? : ??????
Fielded search : ? ( ????:???look for other Fields_ )
Fielded search (2) : ?????:????
Intervals : ????_??????:]1 ??? 5[ ? ??
Partial vocalization : ?'???_:'????
Tuples (root,type= ? )???? | ??? | ????as: {?}????????
Derivations - lemma : >??????
Derivations - root : >>??????
Interfaces
1. Alfanous Python API, source.
2. JSON web interface 2, link, source.
3. Django web interface [Multi-language],link ,
source.
4. Alfanous Desktop application (Windows:
[Arabic] [English]; Ubuntu/Sabily), source.
5. Alfanous Firefox toolbar, link, source.
6. Alfanous Firefox search bar addon, link.
7. Chrome extension (alpha), source.
8. App for Nokia S60 (prototype), source.
9. Facebook app (prototype), source.
Contribute (1/2)
1. Learning Git is essential, read about Set up
Git and you can also try it online here!
2. Browse a milestone and choose an open
issue (or more) that fits your skills.
3. To get more information about any issue you
can contact us on mailing list: or leave a
comment on the issue.
4. Start with forking
the repository and
preparing your development environment, see
How to prepare your development environment
to contribute?.
Contribute (2/2)
1. Prepare your changes, test them and then
make a pull request to alfanous-team
when
you think your code is ready.
2. The project is not well documented but you
may find helpful information in Readme files:
¡ð Application Programming Interface &
Console Interface
¡ð JSON output system
¡ð Desktop Interface
¡ð Django application
Thank You
+Me
+Alfanous
+GDG Algiers
Ad

Recommended

Realtime Apps with Django
Realtime Apps with Django
Renyi Khor
?
Ruby - The Hard Bits
Ruby - The Hard Bits
Paul Gallagher
?
Mashups & APIs
Mashups & APIs
Pamela Fox
?
The Developer Experience
The Developer Experience
Pamela Fox
?
Functional Web Apps with WebMachine Framework - Mikhail Bortnyk
Functional Web Apps with WebMachine Framework - Mikhail Bortnyk
Ruby Meditation
?
±Ê±á±Ê¤ÇÎÄ×Ö¥³©`¥É¤È¥¨¥é©`¥á¥Ã¥»©`¥¸¤ò¥³¥ó¥È¥í©`¥ë¤¹¤ë
±Ê±á±Ê¤ÇÎÄ×Ö¥³©`¥É¤È¥¨¥é©`¥á¥Ã¥»©`¥¸¤ò¥³¥ó¥È¥í©`¥ë¤¹¤ë
Sotaro Omura
?
XMPP, TV and the Semantic Web
XMPP, TV and the Semantic Web
Dan Brickley
?
Google Wave 20/20: Product, Protocol, Platform
Google Wave 20/20: Product, Protocol, Platform
Pamela Fox
?
Frans Ros¨¦n Keynote at BSides Ahmedabad
Frans Ros¨¦n Keynote at BSides Ahmedabad
Security BSides Ahmedabad
?
Kibana: Real-World Examples
Kibana: Real-World Examples
Salvatore Cordiano
?
Shall we search? Lviv.
Shall we search? Lviv.
Vira Povkh
?
Introduction to Google API - Focusky
Introduction to Google API - Focusky
Focusky Presentation
?
Zotero Visualisierungen
Zotero Visualisierungen
Adrian Wilke
?
The liferay case: lessons learned evolving from RPC to Hypermedia REST APIs
The liferay case: lessons learned evolving from RPC to Hypermedia REST APIs
Jorge Ferrer
?
Finding things on the web with BOSS
Finding things on the web with BOSS
Christian Heilmann
?
The Future of SEO #LearnInbound
The Future of SEO #LearnInbound
Britney Muller
?
How to Design and Build a Great Web API
How to Design and Build a Great Web API
LaunchAny
?
Kiran karnad rtc2014 ghdb-final
Kiran karnad rtc2014 ghdb-final
Romania Testing
?
Alexander Janssens & Gert-Jan van Rooij- Getting started with API
Alexander Janssens & Gert-Jan van Rooij- Getting started with API
TOPdesk
?
Y Boss External 20091017
Y Boss External 20091017
JH Lee
?
Python 101
Python 101
The Active Network
?
Real-time search in Drupal with Elasticsearch @Moldcamp
Real-time search in Drupal with Elasticsearch @Moldcamp
Alexei Gorobets
?
Leveraging Lucene/Solr as a Knowledge Graph and Intent Engine: Presented by T...
Leveraging Lucene/Solr as a Knowledge Graph and Intent Engine: Presented by T...
Lucidworks
?
Yahoo! BOSS API external 20091001
Yahoo! BOSS API external 20091001
Fred Meng
?
Jeff Siarto: Party Like It¡¯s 1984, An introduction to social APIs
Jeff Siarto: Party Like It¡¯s 1984, An introduction to social APIs
SocialDevCamp Chicago
?
Introduction to enterprise search
Introduction to enterprise search
Usama Nada
?
Introduction to Social APIs
Introduction to Social APIs
jsiarto
?
Search Intelligence @elo7.com
Search Intelligence @elo7.com
Fernando Meyer
?
How to get in GSoC , DevFest Algiers 2018
How to get in GSoC , DevFest Algiers 2018
Assem CHELLI
?
Dev environment for linux (Mainly KDE and python)
Dev environment for linux (Mainly KDE and python)
Assem CHELLI
?

More Related Content

Similar to Alfanous Quran Search Engine API (20)

Frans Ros¨¦n Keynote at BSides Ahmedabad
Frans Ros¨¦n Keynote at BSides Ahmedabad
Security BSides Ahmedabad
?
Kibana: Real-World Examples
Kibana: Real-World Examples
Salvatore Cordiano
?
Shall we search? Lviv.
Shall we search? Lviv.
Vira Povkh
?
Introduction to Google API - Focusky
Introduction to Google API - Focusky
Focusky Presentation
?
Zotero Visualisierungen
Zotero Visualisierungen
Adrian Wilke
?
The liferay case: lessons learned evolving from RPC to Hypermedia REST APIs
The liferay case: lessons learned evolving from RPC to Hypermedia REST APIs
Jorge Ferrer
?
Finding things on the web with BOSS
Finding things on the web with BOSS
Christian Heilmann
?
The Future of SEO #LearnInbound
The Future of SEO #LearnInbound
Britney Muller
?
How to Design and Build a Great Web API
How to Design and Build a Great Web API
LaunchAny
?
Kiran karnad rtc2014 ghdb-final
Kiran karnad rtc2014 ghdb-final
Romania Testing
?
Alexander Janssens & Gert-Jan van Rooij- Getting started with API
Alexander Janssens & Gert-Jan van Rooij- Getting started with API
TOPdesk
?
Y Boss External 20091017
Y Boss External 20091017
JH Lee
?
Python 101
Python 101
The Active Network
?
Real-time search in Drupal with Elasticsearch @Moldcamp
Real-time search in Drupal with Elasticsearch @Moldcamp
Alexei Gorobets
?
Leveraging Lucene/Solr as a Knowledge Graph and Intent Engine: Presented by T...
Leveraging Lucene/Solr as a Knowledge Graph and Intent Engine: Presented by T...
Lucidworks
?
Yahoo! BOSS API external 20091001
Yahoo! BOSS API external 20091001
Fred Meng
?
Jeff Siarto: Party Like It¡¯s 1984, An introduction to social APIs
Jeff Siarto: Party Like It¡¯s 1984, An introduction to social APIs
SocialDevCamp Chicago
?
Introduction to enterprise search
Introduction to enterprise search
Usama Nada
?
Introduction to Social APIs
Introduction to Social APIs
jsiarto
?
Search Intelligence @elo7.com
Search Intelligence @elo7.com
Fernando Meyer
?
Shall we search? Lviv.
Shall we search? Lviv.
Vira Povkh
?
Zotero Visualisierungen
Zotero Visualisierungen
Adrian Wilke
?
The liferay case: lessons learned evolving from RPC to Hypermedia REST APIs
The liferay case: lessons learned evolving from RPC to Hypermedia REST APIs
Jorge Ferrer
?
Finding things on the web with BOSS
Finding things on the web with BOSS
Christian Heilmann
?
The Future of SEO #LearnInbound
The Future of SEO #LearnInbound
Britney Muller
?
How to Design and Build a Great Web API
How to Design and Build a Great Web API
LaunchAny
?
Kiran karnad rtc2014 ghdb-final
Kiran karnad rtc2014 ghdb-final
Romania Testing
?
Alexander Janssens & Gert-Jan van Rooij- Getting started with API
Alexander Janssens & Gert-Jan van Rooij- Getting started with API
TOPdesk
?
Y Boss External 20091017
Y Boss External 20091017
JH Lee
?
Real-time search in Drupal with Elasticsearch @Moldcamp
Real-time search in Drupal with Elasticsearch @Moldcamp
Alexei Gorobets
?
Leveraging Lucene/Solr as a Knowledge Graph and Intent Engine: Presented by T...
Leveraging Lucene/Solr as a Knowledge Graph and Intent Engine: Presented by T...
Lucidworks
?
Yahoo! BOSS API external 20091001
Yahoo! BOSS API external 20091001
Fred Meng
?
Jeff Siarto: Party Like It¡¯s 1984, An introduction to social APIs
Jeff Siarto: Party Like It¡¯s 1984, An introduction to social APIs
SocialDevCamp Chicago
?
Introduction to enterprise search
Introduction to enterprise search
Usama Nada
?
Introduction to Social APIs
Introduction to Social APIs
jsiarto
?
Search Intelligence @elo7.com
Search Intelligence @elo7.com
Fernando Meyer
?

More from Assem CHELLI (8)

How to get in GSoC , DevFest Algiers 2018
How to get in GSoC , DevFest Algiers 2018
Assem CHELLI
?
Dev environment for linux (Mainly KDE and python)
Dev environment for linux (Mainly KDE and python)
Assem CHELLI
?
Python Workshop
Python Workshop
Assem CHELLI
?
?????? ?? ???????? ?? ???????? ????? - ????? ????
?????? ?? ???????? ?? ???????? ????? - ????? ????
Assem CHELLI
?
Proposal of an Advanced Retrieval System for NobleQur'an - Thesis defending
Proposal of an Advanced Retrieval System for NobleQur'an - Thesis defending
Assem CHELLI
?
Global Schema for Alfanous Quran Search Engine
Global Schema for Alfanous Quran Search Engine
Assem CHELLI
?
Proposal of an Advanced Retrieval System for Noble Qur¡¯an
Proposal of an Advanced Retrieval System for Noble Qur¡¯an
Assem CHELLI
?
OpenSSH tricks
OpenSSH tricks
Assem CHELLI
?
How to get in GSoC , DevFest Algiers 2018
How to get in GSoC , DevFest Algiers 2018
Assem CHELLI
?
Dev environment for linux (Mainly KDE and python)
Dev environment for linux (Mainly KDE and python)
Assem CHELLI
?
?????? ?? ???????? ?? ???????? ????? - ????? ????
?????? ?? ???????? ?? ???????? ????? - ????? ????
Assem CHELLI
?
Proposal of an Advanced Retrieval System for NobleQur'an - Thesis defending
Proposal of an Advanced Retrieval System for NobleQur'an - Thesis defending
Assem CHELLI
?
Global Schema for Alfanous Quran Search Engine
Global Schema for Alfanous Quran Search Engine
Assem CHELLI
?
Proposal of an Advanced Retrieval System for Noble Qur¡¯an
Proposal of an Advanced Retrieval System for Noble Qur¡¯an
Assem CHELLI
?
Ad

Recently uploaded (20)

How to Customize Quotation Layouts in Odoo 18
How to Customize Quotation Layouts in Odoo 18
Celine George
?
List View Components in Odoo 18 - Odoo ºÝºÝߣs
List View Components in Odoo 18 - Odoo ºÝºÝߣs
Celine George
?
LDMMIA Yoga S10 Free Workshop Grad Level
LDMMIA Yoga S10 Free Workshop Grad Level
LDM & Mia eStudios
?
K12 Tableau User Group virtual event June 18, 2025
K12 Tableau User Group virtual event June 18, 2025
dogden2
?
Gladiolous Cultivation practices by AKL.pdf
Gladiolous Cultivation practices by AKL.pdf
kushallamichhame
?
IIT KGP Quiz Week 2024 Sports Quiz (Prelims + Finals)
IIT KGP Quiz Week 2024 Sports Quiz (Prelims + Finals)
IIT Kharagpur Quiz Club
?
This is why students from these 44 institutions have not received National Se...
This is why students from these 44 institutions have not received National Se...
Kweku Zurek
?
LAZY SUNDAY QUIZ "A GENERAL QUIZ" JUNE 2025 SMC QUIZ CLUB, SILCHAR MEDICAL CO...
LAZY SUNDAY QUIZ "A GENERAL QUIZ" JUNE 2025 SMC QUIZ CLUB, SILCHAR MEDICAL CO...
Ultimatewinner0342
?
CRYPTO TRADING COURSE BY FINANCEWORLD.IO
CRYPTO TRADING COURSE BY FINANCEWORLD.IO
AndrewBorisenko3
?
Photo chemistry Power Point Presentation
Photo chemistry Power Point Presentation
mprpgcwa2024
?
University of Ghana Cracks Down on Misconduct: Over 100 Students Sanctioned
University of Ghana Cracks Down on Misconduct: Over 100 Students Sanctioned
Kweku Zurek
?
How to Add New Item in CogMenu in Odoo 18
How to Add New Item in CogMenu in Odoo 18
Celine George
?
Birnagar High School Platinum Jubilee Quiz.pptx
Birnagar High School Platinum Jubilee Quiz.pptx
Sourav Kr Podder
?
Q1_TLE 8_Week 1- Day 1 tools and equipment
Q1_TLE 8_Week 1- Day 1 tools and equipment
clairenotado3
?
Public Health For The 21st Century 1st Edition Judy Orme Jane Powell
Public Health For The 21st Century 1st Edition Judy Orme Jane Powell
trjnesjnqg7801
?
Hurricane Helene Application Documents Checklists
Hurricane Helene Application Documents Checklists
Mebane Rash
?
OBSESSIVE COMPULSIVE DISORDER.pptx IN 5TH SEMESTER B.SC NURSING, 2ND YEAR GNM...
OBSESSIVE COMPULSIVE DISORDER.pptx IN 5TH SEMESTER B.SC NURSING, 2ND YEAR GNM...
parmarjuli1412
?
Learning Styles Inventory for Senior High School Students
Learning Styles Inventory for Senior High School Students
Thelma Villaflores
?
Pests of Maize: An comprehensive overview.pptx
Pests of Maize: An comprehensive overview.pptx
Arshad Shaikh
?
2025 June Year 9 Presentation: Subject selection.pptx
2025 June Year 9 Presentation: Subject selection.pptx
mansk2
?
How to Customize Quotation Layouts in Odoo 18
How to Customize Quotation Layouts in Odoo 18
Celine George
?
List View Components in Odoo 18 - Odoo ºÝºÝߣs
List View Components in Odoo 18 - Odoo ºÝºÝߣs
Celine George
?
LDMMIA Yoga S10 Free Workshop Grad Level
LDMMIA Yoga S10 Free Workshop Grad Level
LDM & Mia eStudios
?
K12 Tableau User Group virtual event June 18, 2025
K12 Tableau User Group virtual event June 18, 2025
dogden2
?
Gladiolous Cultivation practices by AKL.pdf
Gladiolous Cultivation practices by AKL.pdf
kushallamichhame
?
IIT KGP Quiz Week 2024 Sports Quiz (Prelims + Finals)
IIT KGP Quiz Week 2024 Sports Quiz (Prelims + Finals)
IIT Kharagpur Quiz Club
?
This is why students from these 44 institutions have not received National Se...
This is why students from these 44 institutions have not received National Se...
Kweku Zurek
?
LAZY SUNDAY QUIZ "A GENERAL QUIZ" JUNE 2025 SMC QUIZ CLUB, SILCHAR MEDICAL CO...
LAZY SUNDAY QUIZ "A GENERAL QUIZ" JUNE 2025 SMC QUIZ CLUB, SILCHAR MEDICAL CO...
Ultimatewinner0342
?
CRYPTO TRADING COURSE BY FINANCEWORLD.IO
CRYPTO TRADING COURSE BY FINANCEWORLD.IO
AndrewBorisenko3
?
Photo chemistry Power Point Presentation
Photo chemistry Power Point Presentation
mprpgcwa2024
?
University of Ghana Cracks Down on Misconduct: Over 100 Students Sanctioned
University of Ghana Cracks Down on Misconduct: Over 100 Students Sanctioned
Kweku Zurek
?
How to Add New Item in CogMenu in Odoo 18
How to Add New Item in CogMenu in Odoo 18
Celine George
?
Birnagar High School Platinum Jubilee Quiz.pptx
Birnagar High School Platinum Jubilee Quiz.pptx
Sourav Kr Podder
?
Q1_TLE 8_Week 1- Day 1 tools and equipment
Q1_TLE 8_Week 1- Day 1 tools and equipment
clairenotado3
?
Public Health For The 21st Century 1st Edition Judy Orme Jane Powell
Public Health For The 21st Century 1st Edition Judy Orme Jane Powell
trjnesjnqg7801
?
Hurricane Helene Application Documents Checklists
Hurricane Helene Application Documents Checklists
Mebane Rash
?
OBSESSIVE COMPULSIVE DISORDER.pptx IN 5TH SEMESTER B.SC NURSING, 2ND YEAR GNM...
OBSESSIVE COMPULSIVE DISORDER.pptx IN 5TH SEMESTER B.SC NURSING, 2ND YEAR GNM...
parmarjuli1412
?
Learning Styles Inventory for Senior High School Students
Learning Styles Inventory for Senior High School Students
Thelma Villaflores
?
Pests of Maize: An comprehensive overview.pptx
Pests of Maize: An comprehensive overview.pptx
Arshad Shaikh
?
2025 June Year 9 Presentation: Subject selection.pptx
2025 June Year 9 Presentation: Subject selection.pptx
mansk2
?
Ad

Alfanous Quran Search Engine API

  • 1. Alfanous Quran Search Engine API (for Developers) By +Assem Chelli | @assem-ch
  • 2. What is Alfanous ? Alfanous (The Lantern - ? ) ????????is an Arabic search engine API that provides the simple and advanced search in the Holy Quran, including interfaces... lot of features and many
  • 3. Why Alfanous? 1. Alfanous is a Search Engine: not just a search tool. 2. Alfanous is FREE LIBRE OPEN SOURCE: Anyone can use it , anyone can contribute in coding, translating, design...etc. the source code is here! 3. Alfanous is a Python API: that allows anyone to create independently a web interface, desktop interface , Android/Iphone/Windows phone interfaces , facebook/twitter/G+ applications ...and so on. 4. Alfanous is a research project : so we figure out how to improve search features and introduce new ones.. 5. Alfanous has lot of features. 6. Alfanous has many interfaces for many platforms 7. Alfanous is FREE GRATIS: no payment, no ads.
  • 4. Contact Info Author Name: Assem Chelli (?)???? ???? Email: assem.ch@gmail.com Github: @assem-ch Project Mailing list: alfanous@googlegroups.com Feedback: feedback.alfanous.org Website: www.alfanous.org Github: https://github.com/Alfanous-team/alfanous Contributors: Contributors
  • 6. Console Interface $ sudo easy_install alfanous $ alfanous-console -h $ alfanous-console -a search -q qawl
  • 7. Json Web Service Url: http://www.alfanous.org/jos2 Wiki: https://github.com/Alfanousteam/alfanous/blob/master/src/alfanous-cgi/README.rst
  • 8. Terms of use ¡ñ This service is free to use. ¡ñ Don't name your application "Alfanous" before we are okey about that. ¡ñ We highly recommend to refer Alfanous engine somewhere in your pages using icons or texts like "Alfanous engine", "Powered by Alfanous.org", or "Based on Alfanous.org" linked to "http://www.alfanous. org" or "http://www.alfanous.org/jos2". ¡ñ We highly recommend to describe clearly somewhere in your application the relation to the whole Alfanous project, such as an about button. ¡ñ Art works you may need are available here, the Art is licenced with AGPL license.
  • 9. How to inquire? Syntax : http://www.alfanous.org/jos2?ARGUMENT Argument is a chain of flags: # action to perform 1. action: ¡°search¡± | ¡°suggest¡± | ¡°show¡± # search unit 2. unit: ¡°aya¡± | ¡°word¡± | ¡°translation¡± # query attached to action 3. query: a string eg: http://www.alfanous.org/jos2? action=search&unit=aya&query=???????
  • 10. Extra Request flags 1 # sorting order of results sortedby: ¡°mushaf¡± | ¡°tanzil¡± | ¡°score¡± ... see more # page number page # results per page perpage # recitation id recitation # translation id translation #script of aya text script : ¡°standard¡± | ¡°uthmani¡±
  • 11. Extra Request flags 2 # enable vocalization of aya text vocalized: "true" | ¡°false¡±, # romanization system romanization: ¡°buckwalter¡± | ¡°iso¡± | none, # highlight method highlight: ¡°css¡± | ¡°html¡± | ¡°bold¡± | ¡°bbcode¡± # fuzzy search fuzzy: ¡°true¡± | ¡°false¡± see full details
  • 12. Minimizing/Enriching results aya_stat_info ? enable aya stat information retrieving annotation_word ? enable query terms annotations retrieving word_info ? enable word information retrieving sura_stat_info ? enable sura stats retrieving word_synonyms ? enable retrieving of keyword synonyms word_vocalizations ? enable retrieving of keyword vocalizations aya_sajda_info ? enable aya sajda information retrieving next_aya ? enable next aya retrieving aya ? enable retrieving of aya text in the case of translation search prev_aya ? enable previous aya retrieving sura_info ? enable sura information retrieving annotation_aya ? enable aya words annotations retrieving word_derivations ? enable retrieving of keyword derivations aya_theme_info ? enable aya theme information retrieving aya_position_info ? enable aya position information retrieving # pre-defined configuration for what information to retrieve view: ¡°normal¡± | ¡°minimal¡± | ¡°full¡± | ¡°statiscal¡± | ¡°linguistic¡±
  • 13. How to parse the results Request Url: http://www.alfanous.org/jos2? action=search &unit=aya &query=????????
  • 14. API meta info You can request meta info by using: action: ¡°show¡± &query: all | translations |recitations | information | hints | surates | chapters | defaults | flags | fields | fields_reverse | errors | domains | help_messages eg: http://www.alfanous.org/jos2? action=show&query=surates
  • 15. Advanced Queries Examples ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ ¡ñ Simple search: ??????? Phrases : " ?"?????? Logical relations - ANDNOT : (?)????? - ??????? Logical relations - AND : ?????? + ??????? Logical relations - OR : ?????? | ??????? Joker * : *?*???? Joker ? : ?????? Fielded search : ? ( ????:???look for other Fields_ ) Fielded search (2) : ?????:???? Intervals : ????_??????:]1 ??? 5[ ? ?? Partial vocalization : ?'???_:'???? Tuples (root,type= ? )???? | ??? | ????as: {?}???????? Derivations - lemma : >?????? Derivations - root : >>??????
  • 16. Interfaces 1. Alfanous Python API, source. 2. JSON web interface 2, link, source. 3. Django web interface [Multi-language],link , source. 4. Alfanous Desktop application (Windows: [Arabic] [English]; Ubuntu/Sabily), source. 5. Alfanous Firefox toolbar, link, source. 6. Alfanous Firefox search bar addon, link. 7. Chrome extension (alpha), source. 8. App for Nokia S60 (prototype), source. 9. Facebook app (prototype), source.
  • 17. Contribute (1/2) 1. Learning Git is essential, read about Set up Git and you can also try it online here! 2. Browse a milestone and choose an open issue (or more) that fits your skills. 3. To get more information about any issue you can contact us on mailing list: or leave a comment on the issue. 4. Start with forking the repository and preparing your development environment, see How to prepare your development environment to contribute?.
  • 18. Contribute (2/2) 1. Prepare your changes, test them and then make a pull request to alfanous-team when you think your code is ready. 2. The project is not well documented but you may find helpful information in Readme files: ¡ð Application Programming Interface & Console Interface ¡ð JSON output system ¡ð Desktop Interface ¡ð Django application