mrhammadasif / ayatequrani Goto Github PK

=== AyateQurani ===
Contributors: nitroxis
Donate link: http://nitroxis.com/donate/
Tags: wordpress, plugin, quran, islamic, ayat, quranic verse, verse
Requires at least: 3.4
Tested up to: 4.2
Stable tag: 1.0.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Embed a Quranic Ayat (single or multiple) in your website, just by using a shortcode

== Description ==

Ayatequrani Plugin enables you to embed a Beatuful Ayat (single or multiple) in your website, just by using a shortcode. You can view the shortcode options in the Installations Tab Above

This plugin is provided by <a href="http://nitroxis.com?ref=wp-plugins">Nitroxis</a> free of cost

== Installation ==

Installing "WordPress Plugin Template" can be done either by searching for "WordPress Plugin Template" via the "Plugins > Add New" screen in your WordPress dashboard, or by using the following steps:

1. Download the plugin via WordPress.org
2. Upload the ZIP file through the 'Plugins > Add New > Upload' screen in your WordPress dashboard
3. Activate the plugin through the 'Plugins' menu in WordPress

== Usage ==

You can use this plugin by a simple shortcode

**[quran ayat="1-2" surah="2" arabic="1" english="1" urdu="1" roman="1" size="m"]**

Following are the parameters and their description:

= ayat * =

* **int** : the index of ayat in given surah
* **range** (from-to) : the index number of ayat starting from and ending until

= surah * =

* **int** : the numeric index of Surah in Quran e.g. for Surah Al-Baqara option will be 2

= arabic =

* **0** : disable the arabic text
* **1** : show the arabic text (default)

= roman =

* **0** : disable the transliteration text (talafuz/tajwid)
* **1** : show the transliteration text (talafuz/tajwid) text (default)

= english =

* **0** : disable the english text
* **1** : show the english text (default)

= urdu =

* **0** : disable the urdu text
* **1** : show the urdu text (default)


== Frequently Asked Questions ==

= Why this plugin? =

With this plugin you can embed any Quranic Ayat beautifully by just giving reference to that Surah and Ayat

= How do I use it? =

You can use this plugin by a simple shortcode
[quran ayat="1-2" surah="2" arabic="1" english="1" urdu="1" roman="1" size="m"]

= Configuration =

= ayat * =

* **int** : the index of ayat in given surah
* **range** (from-to) : the index number of ayat starting from and ending until

= surah * =

* **int** : the numeric index of Surah in Quran e.g. for Surah Al-Baqara option will be 2

= arabic =

* **0** : disable the arabic text
* **1** : show the arabic text (default)

= roman =

* **0** : disable the transliteration text (talafuz/tajwid)
* **1** : show the transliteration text (talafuz/tajwid) text (default)

= english =

* **0** : disable the english text
* **1** : show the english text (default)

= urdu =

* **0** : disable the urdu text
* **1** : show the urdu text (default)


== Changelog ==

= 1.0 =
* 2015-02-12
* Initial release

= 1.0.2 =
* 2015-02-25
* Remove the error being output if the parameters are wrong in the shortcode

== Upgrade Notice ==

= 1.0 =
Initial Release

= 1.0.2 =
Fix Bug

== Screenshots ==

1. Visual Representation How a Plugin Works and will render

== Credits ==

* Ayats text are provided by [Tanzil.net](http://tanzil.net/download/ "Tanzil Quran Text")
* Ayats translations are provided by [Tanzil.net](http://tanzil.net/trans/ "Tanzil Quran Translations")