Template:CiteQuran Ayah/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

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


Usage[edit source]

This template is used to provide reference of Quran Verses.

Basic Code format: {{CiteQuran Ayah|SurahNumber|AyahNumber}}

OR Shortcut
{{qref|SurahNumber|AyahNumber}}

Advance Code format: {{CiteQuran Ayah|SurahNumber|AyahNumber|b=y/yt|s=y|t=c/si|c=y}}

Optional Parameters[edit source]

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. {{CiteQuran Ayah|2|256|b=y}} Output: Quran 2:256
  • 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. {{CiteQuran Ayah|2|256|b=yl}} Output: Quran 2:256


2. s

s, short-form of Superscript. It add cites in superscript style.
It has only one value,
y short for yes e.g. {{CiteQuran Ayah|2|256|s=y}} Output: [ 2:256]


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. {{CiteQuran Ayah|2|256|c=y}} Output: Surah Al-Baqara 2:256


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. {{CiteQuran Ayah|2|256|t=c|b=yl}} Output: Quran 2:256 -The Clear Quran
It has following value.


Example[edit source]

  • {{CiteQuran Ayah|2|256}} Output: 2:256


  • {{CiteQuran Ayah|2}} Output: 2: to cite entire Surah (chapter).


  • {{CiteQuran Ayah|2|256|b=y}} Output: Quran 2:256



  • {{CiteQuran Ayah|2|256|b=y|s=y}} Output: [Quran 2:256]


  • {{CiteQuran Ayah|2|256|b=yl|s=y}} Output: [Quran 2:256]








TemplateData[edit source]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for CiteQuran Ayah

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.

Template parameters

ParameterDescriptionTypeStatus
Surah (Chapter)1

Enter Surah (Chapter) Number e.g. 4. To cite entire Surah (chapter), don't give Ayah (verse) number.

Example
4
Numberrequired
Ayah (Verse or Range of Verse)2

Enter Ayah (Verses) Number e.g. 2, or Range of Verse e.g. 2-7. To cite entire Surah (chapter), leave this blank.

Example
2 or 2-7
Numbersuggested
Superscript (Optional)s

It add cites in superscript style. To add, type ' y '.

Suggested values
y
Example
y
Stringsuggested
Add Word Quran (Optional)b

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.

Suggested values
y yl
Example
y or yl
Stringsuggested
Add Chapter (Surah) Name. (Optional)c

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.

Suggested values
y
Example
y
Stringsuggested
Add Specific Translation (Optional)t

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

Suggested values
c si tq h y p
Example
c or si
Stringsuggested