Template:CiteQuran Ayah/doc

A Template to makes citations of the Quran, linking to pages of https://quran.com.

Usage
This template is used to provide reference of Quran Verses.

Basic Code format:


 * OR Shortcut



Advance Code format:

Optional Parameters
1. b
 * b, short-form of begin. It make the cite to begin cite with the word Quran.
 * It has two value:
 * y, short for yes, To add and begin cite with the word Quran. e.g.   Output:


 * yl, short for yes with link, To add and begin with the word Quran with link of word 'Quran' to it's Wikipedia page.


 * e.g.  Output:

2. s
 * s, short-form of Superscript. It add cites in superscript style.
 * It has only one value,
 * y short for yes e.g.  Output:

3. c
 * c, short-form of Chapter (Surah). It add and begin cite with the Surah (Chapter) Name. There is no effect of s parameter on it. It is recommended to not use this together with b parameter.
 * It has only one value,
 * y short for yes e.g.  Output:

4. t
 * t, short-form of translation. It is use to add a specific translation, like The Clear Quran, Sahih International, Tafhim-ul-Quran and translation of Abdul Haleem, Pickthall, Yusuf Ali and other popular Quran translations. Translation name will be always in superscript.


 * e.g.  Output:


 * It has following value.
 * c for The Clear Quran


 * si for Sahih International


 * tq for Tafhim-ul-Quran


 * h for Abdul Haleem


 * p for Pickthall


 * y for Yusuf Ali

Example

 * Output:


 * Output: to cite entire Surah (chapter).


 * Output:


 * Output:


 * Output:


 * Output:


 * Output:


 * Output:


 * Output:


 * Output:


 * Output:


 * Output:

TemplateData
{	"params": { "1": {			"label": "Surah (Chapter)", "description": "Enter Surah (Chapter) Number e.g. 4. To cite entire Surah (chapter), don't give Ayah (verse) number.", "type": "number", "required": true, "example": "4" },		"2": {			"label": "Ayah (Verse or Range of Verse)", "description": "Enter Ayah (Verses) Number e.g. 2, or Range of Verse e.g. 2-7. To cite entire Surah (chapter), leave this blank.", "type": "number", "example": "2 or 2-7", "suggested": true },		"s": { "label": "Superscript (Optional)", "description": "It add cites in superscript style. To add, type ' y '.", "example": "y ", "type": "string", "suggestedvalues": [ "y" ],			"suggested": true },		"b": { "label": "Add Word Quran (Optional)", "description": "It make the cite to begin with the word Quran. Type ' y ' to add and begin with the word Quran which show as 'Quran 3:24'. Type ' yl ' to add the word Quran with link of word 'Quran' to it's Wikipedia page. Avoid use of yl, more than once in a single article as per MOS:REPEATLINK.", "example": "y or yl", "type": "string", "suggestedvalues": [ "y", "yl" ],			"suggested": true },		"c": { "label": "Add Chapter (Surah) Name. (Optional)", "description": "It add and begin cite with the Surah (Chapter) Name. There is no effect of s parameter on it. It is recommended to not use this together with b parameter.", "example": "y", "type": "string", "suggestedvalues": [ "y" ],			"suggested": true },		"t": { "label": "Add Specific Translation (Optional)", "description": "It is use to add a specific translation, like The Clear Quran, Sahih International, Tafhim-ul-Quran and translation of Abdul Haleem, Pickthall, Yusuf Ali and other popular Quran translations. Translation name will be always in superscript. Give these values: c for The Clear Quran, si for Sahih International, tq for Tafhim-ul-Quran, h for Abdul Haleem, p for Pickthall, y for Yusuf Ali", "example": "c or si", "type": "string", "suggestedvalues": [ "c", "si", "tq", "h", "y", "p" ],			"suggested": true }	},	"description": "Cite Quran Verse/Chapter with Translation from quran.com. This Template will create a link of Ayah (verse), range of Ayah (verse) or just an entire Surah (Chapter). This is CiteQuran Ayah Template.", "paramOrder": [ "1",		"2",		"s", "b", "c", "t" ] }