Template:CiteQuran Ayah/doc
![]() | This is a documentation subpage for Template:CiteQuran Ayah It may contain usage information, categories and other content that is not part of the original template page. |
Error: no shortcuts were specified and the |msg= parameter was not set.
![]() | This template uses Lua: |
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.
This template creates an external link. As per WP:EL, External links should not normally be used in the body of an article. Use this Template only within <ref> and </ref> tags tags in the body of an article or place external links to the Quran in footnotes.
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}}
Redirects
These are the redirects means we can also use these words to use this templete, e.g. {{Qref|2|256|b=y}}
Output: Quran 2:256 {{Qverse|2|256|b=y}}
Output: Template:Qverse
- {{Qref}}
- {{Qverse}}
- {{Citequran}}
- {{Quranverse}}
- {{Quranrange}}
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.
{{qref|2|256|b=y}}
Output: Quran 2:256
- y, short for yes, To add and begin cite with the word Quran. e.g.
- yl, short for yes with link, To add and begin with 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.
2. s
- s, short-form of Superscript. It add cites in superscript style.
- It has only one value,
- y short for yes e.g.
{{qref|2|256|s=y}}
Output: [ 2:256]
- y short for yes e.g.
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.
{{qref|2|256|c=y}}
Output: Surah Al-Baqara 2:256
- y short for yes e.g.
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.
{{qref|2|256|t=c|b=yl}}
Output: Quran 2:256 -The Clear Quran
- e.g.
- 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
- nq for Noble Quran (Hilali–Khan)
- gl for Dr. Ghali
5. pl
- pl, short-form of Plainlinks. It create link which is not followed by an external link icon.
Example
{{qref|2|256}}
Output: 2:256
{{qref|2}}
Output: 2: to cite entire Surah (chapter).
{{qref|2|256-257}}
Output: 2:256-257
{{qref|2|256|b=y}}
Output: Quran 2:256
{{qref|2|256|b=y|s=y}}
Output: [Quran 2:256]
{{qref|2|256|t=c|b=yl}}
Output: Quran 2:256 -The Clear Quran
{{qref|2|256|t=si|b=yl}}
Output: Quran 2:256 -Sahih International
{{qref|2|256|t=c|c=y}}
Output: Surah Al-Baqara 2:256 -The Clear Quran
{{qref|2|256|s=y|t=si|c=y}}
Output: Surah Al-Baqara [ 2:256 -Sahih International]
See Also
- {{CiteHadith}}
- {{Cite Tafsir}}
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Surah (Chapter) | 1 | Enter Surah (Chapter) Number e.g. 4. To cite entire Surah (chapter), don't give Ayah (verse) number.
| Number | required |
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.
| Number | suggested |
Superscript (Optional) | s | It add cites in superscript style. To add, type ' y '.
| String | suggested |
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.
| String | suggested |
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.
| String | suggested |
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, nq for Noble Quran (Hilali–Khan), gl for Dr. Ghali
| String | suggested |
Plainlink (Optional) | pl | It create link which is ''not'' followed by an external link icon.
| String | suggested |