=== Islam Companion === Contributors: nadirlatif Tags: islam,quran,sunnat,hadith,religion Requires at least: 3.0 Tested up to: 4.5.2 Stable tag: 2.2.2 License: GPLV2 License URI: http://www.gnu.org/licenses/gpl-2.0.html The goal of the Islam Companion plugin is to help users understand Islam == Description == The Islam Companion plugin has following features: 1. The plugin provides Holy Quran translation in following languages: Amharic, Arabic, Bosnian, Bengali, Bulgarian, Amazigh, Czech, German, Divehi, Spanish, English, Persian, French, Hindi, Hausa, Indonesian, Italian, Japanese, Korean, Kurdish, Malayalam, Malay, Dutch, Norwegian, Portuguese, Polish, Russian, Romanian, Swedish, Somali, Sindhi, Albanian, Swahili, Turkish, Tajik, Tamil, Tatar, Thai, Uzbek, Urdu, Uyghur and Chinese 2. It provides a dashboard widget that displays Holy Quran Navigator. The Holy Quran navigator allows reading the Holy Quran in the chosen language. It also allows listening to Holy Quran verses in Arabic and Urdu 3. It provides a dashboard widget that displays Hadith Navigator. The Hadith navigator allows reading hadith from following Hadith collection: Sahih Muslim, Sahih Bukhari, Abu Dawud, Authentic Supplications of the Prophet, Hadith Qudsi, An Nawawi's Fourty Hadiths, Maliks Muwatta and Shamaa-il Tirmidhi. Currently, the Hadith Navigator only allows reading the Hadith in English language. Urdu and Arabic versions of the Hadith text are planned 4. It allows finding the meaning of a translated word using an online dictionary 5. It provides a settings page from where the user can set the language, translator and division for Holy Quran navigator. The user can also set the Hadith language and source of the data. The data source option allows the user to specify the location of the quranic and hadith data. If the local option is selected then all the Quranic and Hadith data is imported to the users wordpress server. If remote option is used, then the Quranic and Hadith data is fetched from remote server. The local option has better performance and should be used if possible. The remote optin is less reliable because it relies on internet connection to remote server. 6. It allows organizing Holy Quran reading by the following divisions: Sura, Hizb, Juz, Page and Manzil. 7. It allows users to keep all Holy Quran data on their own servers. This improves performance and also reduces chances of errors 8. It provides a shortcode for embedding Holy Quran verse text and audio in pages and posts 9. It provides a widget that displays Holy Quran verse text and audio player 10. It provides a shortcode for embedding Hadith text in pages and posts 11. It provides a widget that displays Hadith text Plugin information: 1. Quranic Translation provided by: http://tanzil.net 2. Quranic Audio provided by: http://www.quranurdu.com/ 3. Hadith Data provided by: http://hadithcollection.com/ 4. Learn Arabic online: http://www.madinaharabic.com/Arabic_Reading_Course/Lessons/L000_001.html 5. Discuss Islam on Facebook: https://www.facebook.com/Holyquran.Islam786/ 6. Visit the plugin author's website: http://pakjiddat.com 7. Support the development of the plugin by making a donation. Please contact nadir@pakjiddat.com for more information == Installation == Login to your wordpress blog and go to Plugins then Add New and then search for Islam Companion and then click Install == Frequently Asked Questions == 1. What does this plugin do. The plugin allows reading Holy Quran and Hadith. It also allows provides Holy Quran audio in Arabic and Urdu 2. Where does the plugin get its data. The plugin uses Holy Quran translations from http://tanzil.net/trans/ and Holy Quran audio from http://www.quranurdu.com/. It uses Hadith data from http://hadithcollection.com/ 3. How does the online dictionary option work. On the Holy Quran and Hadith navigator widgets, you have to select a word and then click on the dictionary icon. This will open the online dictionary in a new tab. The online dictionary will show the meaning of the word. 4. How does the data source setting option work. The data source setting option allows the user to keep all data on his own server. The data is stored as WordPress custom posts. The data source setting has two options. The local option and the remote option. The local option allows the user to keep all data on his own server. The remote option allows the data to be accessed from external server. 5. How to keep all data on local server. If you want to keep all data on your local server, then first select the language and narrator for Holy Quran. Then select local from the data source option. Then click on Import Data button. This will import all the data used by the plugin to your wordpress database. The data is imported into WordPress posts. 6. What is the purpose of keeping all data on local server. The main purpose of keeping all data on local server is to make the plugin more reliable and to improvide its performance. Another reason is to allow plugin and theme developers to use the data in their own themes and plugins. 7. How to use shortcodes in pages and posts. To add Holy Quran verse text and audio to your pages and posts, you can use shortcodes. You can get shortcode from the Holy Quran Navigator widget. The widget has a yellow star icon. When you click on the icon it copies shortcode text. You can then paste the text inside a post or page. You can change the sura number, start ayat, end ayat and other options. Similarly, The Hadith Navigator also provides a shortcode option. 8. How to use widgets. The Islam Companion plugin provides two widgets. One displays Holy Quran verses and audio player. The other displays the Hadith text. To add a widget to your widget area, you have to go to appearance then widgets and then drag and drop the widget to the widget area. Then you have to configure the widget settings. The Holy Quran widget has following settings: Title (The widget title), Narrator (the translator name), Language (the translation language), Sura (the sura number), Start Ayat (the start ayat), End Ayat (end ayat), Container (it allows changing the presentation of the verse text), Css Class (a custom css class that can be used to change the presentation of the verse text), Audio Player (allows displaying an audio player above the verse text). The Hadith widget has following settings: Title (The widget title), Hadith Source (The Hadith source. e.g Sahih Bukhari), Hadith Language (currently only English is supported. Arabic and Urdu translations are planned), Hadith Book (The name of the Hadith book), Hadith Title (The book category), Hadith Number Start (The start Hadith number), Hadith Number End (The end Hadith number), Css Class (a custom css class that can be used to change the presentation of the hadith text). == Changelog == = 2.2.2 = * Updated islamcompanion api url to new server url = 2.2.1 = * Corrected text formatting error in Hadith Dashboard Widget = 2.2.0 = * Added Hadith Navigator widget * Added Shortcodes for Hadith * Added Frontend widget for Hadith * Corrected error in auto populating narrator dropdown on widgets admin page = 2.1.4 = * Corrected layout errors on Firefox browser * Updated url of audio files so it points to audio files hosted on pakjiddat.com website * Updated font file for Urdu and Arabic text = 2.1.3 = * Corrected minor bugs = 2.1.2 = * Corrected minor bugs in settings page = 2.1.1 = * Added dropdown fields to Holy Quran widget * Corrected minor bugs = 2.1.0 = * Added shortcode for displaying Holy Quran verses and audio on pages and posts * Added widget for displaying Holy Quran verses and audio on widget areas * Added an icon to Holy Quran navigator for copying shortcode text = 2.0.2 = * Corrected error in audio player = 2.0.1 = * Corrected error in data import = 2.0.0 = * Moved the Islam Companion plugin to Pak Php framework * Added option for importing all plugin data to local wordpress database * Updated layout of the Holy Quran dashboard widget so it shows verses in both Arabic and the Translated language * Updated layout of the dropdown option on the Holy Quran dashboard widget = 1.2.3 = * Corrected minor bugs * Added error handling to API functions * Simplified API functions = 1.2.2 = * Corrected session_start error = 1.2.1 = * Corrected html closing tag error * Corrected error in saving settings from Dashboard widget = 1.2.0 = * Added options for navigating the Holy Quran from the Dashboard widget * Removed some of the navigation options from the settings page * Updated the remote API * Changed verse number to decimal format for all left to right languages that do not have browser support for numbering * Added remote API to version control = 1.1.0 = * Added option for selecting Holy Quran divisions on the settings page * Updated the Holy Quran Dashboard widget layout * Updated remote API to object oriented class based format * Unit tested the remote API = 1.0.8 = * Update api server url = 1.0.7 = * Update online dictionary icon so it gets the dictionary link from database * Removed option for entering online dictionary url = 1.0.6 = * Added option for searching for a word using an online dictionary * Added option to the settings page for setting online dictionary url = 1.0.5 = * Replaced option for selecting ayat with option for selecting ruku * Added audio player for listening to Quranic Verses * Added multi user and multi site support. It allows each user to have his own plugin settings * Added internationalization and localization to the plugin. The plugin text is displayed in the users own language. Currently the plugin only contains translations in Urdu language. Translations in other languages can easily be created * Added css classes for displaying verses with bullet numbering in the language of the user. If the user language is not supported then a default numbered bullet is displayed * Uploaded media files to content delivery network * Secured the plugin code by adding try/catch statements, exception throwing, exception handling and error logging * Removed addslashes function on line 246 in file class-islam-companion-settings.php * Corrected PayPal donation link * Updated plugin description * Renamed "Message of the day" feature to "Holy Quran Dashboard Widget" = 1.0.4 = * Corrected layout bug in admin dashboard widget * Added default settings for plugin = 1.0.3 = * Added next and previous links to admin dashboard widget. the user can browser Quranic verses using these links * Added meta information of the Quranic verses to the admin dashboard widget = 1.0.2 = * Added option under settings for saving the surah, verse and verse count * Updated dashboard widget so it displays Quranic verses according to the settings = 1.0.1 = * Moved message for the day text to admin dashboard widget * Corrected bugs in displaying message for the day = 1.0.0 = * Added option for configuring language * Added function that displays Quranic verse at top of the admin page == Upgrade Notice == = 2.2.2 = * Updated islamcompanion api url to new server url = 2.2.1 = * Corrected text formatting error in Hadith Dashboard Widget = 2.2.0 = * Added Hadith Navigator widget * Added Shortcodes for Hadith * Added Frontend widget for Hadith * Corrected error in auto populating narrator dropdown on widgets admin page * Corrected layout error in displaying widget on frontend of wordpress twentysixteen theme = 2.1.4 = * Corrected layout errors on Firefox browser = 2.1.3 = * Corrected minor bugs = 2.1.2 = * Corrected minor bugs in settings page = 2.1.1 = * Added dropdown fields to Holy Quran widget * Corrected minor bugs = 2.1.0 = * Added shortcode for displaying Holy Quran verses and audio on pages and posts * Added widget for displaying Holy Quran verses and audio on widget areas * Added an icon to Holy Quran navigator for copying shortcode text = 2.0.2 = * Corrected error in audio player = 2.0.1 = * Corrected error in data import = 2.0.0 = * Added option for importing all plugin data to local wordpress database * Updated layout of the Holy Quran dashboard widget so it shows verses in both Arabic and the Translated language = 1.2.3 = * Corrected minor bugs * Organized source code = 1.2.2 = * Corrected minor bugs = 1.2.1 = * Corrected minor bugs = 1.2.0 = * Added options for navigating the Holy Quran from the Dashboard widget * Removed some of the navigation options from the settings page * Updated the remote API * Changed verse number to decimal format for all left to right languages that do not have browser support for numbering = 1.1.0 = * Added option for selecting Holy Quran divisions * Updated the Holy Quran Dashboard widget layout = 1.0.8 = * Update api server url = 1.0.7 = * Update online dictionary icon so it gets the dictionary link from database * Removed option for entering online dictionary url = 1.0.6 = * Added option for searching for a word using an online dictionary * Added option to the settings page for setting online dictionary url = 1.0.5 = * Added audio player for listening to Quranic Verses in Arabic and Urdu languages * Updated settings page and replaced option for selecting ayat with option for selecting ruku * Added multi user and multi site support. It allows each user to have his own plugin settings * Added internationalization and localization to the plugin. The plugin text is displayed in the users own language. Currently the plugin only contains translations in Urdu language. Translations in other languages can easily be created * Secured the plugin code by adding error handling and logging = 1.0.4 = * Corrected layout bug in admin dashboard widget * Added default settings for plugin = 1.0.3 = * Updated Holy Quran dashboard widget so it allows user to browse the Quranic verses using next,prev links * Add verse information to the Holy Quran dashboard widget = 1.0.2 = * Updated Holy Quran dashboard widget so it displays the verses according to the configured settings * Added option under settings for saving the surah, verse and verse count = 1.0.1 = * Message for the day text is now displayed in admin dashboard widget * Corrected bugs in displaying message for the day == Screenshots == 1. This screenshot shows how the plugin displays verses from the Holy Quran and Hadith on the admin dashboard. The user can browse the verses using navigation links. The audio player recites the Holy Quran verses in Arabic and Urdu. The star button allows copying shortcode. The dictionary button allows looking up the meaning of a word in an online dictionary 2. This screenshot shows how to change the settings for the plugin. The language, narrator and division can be configured from here. It also allows configuring data source option 3. This screenshot shows the shortcode text and the widget text 4. This screenshot shows the configuration page for the widget