Template:Cite quran/doc

This is a documentation subpage for Template:Cite quran.
It contains usage information, categories and other content that is not part of the original template page.

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

Usage

{{cite quran|#1|#2
 | end=
 | translator=
 | style=
 | expand=
 | quote=
}}

Required Parameters

#1

integer representing the number of the surah (this must be the first parameter)

#2

integer representing the ayah number (this must be the second parameter)

Optional Parameters

end

last ayah number being cited

quote

the text of the quotation

translator

y (for Yusuf Ali)
p (for Pickthall)
s (for Shakir)
a (for Asad)
name of other translator

expand=no

does not prepend link with "Qur'an"

style

nosup to use non-superscript style
ref to use expanded form for citing as a reference (short form for style=nosup|expand=yes)

Examples

Example 1

{{cite quran|5|4|quote=quoted text}}

“quoted text”^{[Qur'an 5:4]}

Example 2

{{cite quran|5|4|expand=no|quote=quoted text}}

“quoted text”^[5:4]

Example 3

{{cite quran|5|4|end=7|quote=quoted text}}

“quoted text”^{[Qur'an 5:4-7]}

Example 5

{{cite quran|5|4|translator=y|quote=quoted text}}

“quoted text”^{[Qur'an 5:4 (Yusuf Ali)]}

Example 6

{{cite quran|5|4|end=7|translator=y|quote=quoted text}}

“quoted text”^{[Qur'an 5:4-7 (Pickthall)]}

Example 8

{{cite quran|5|4|end=7|style=nosup|translator=p|quote=quoted text}}

Qur'an 5:4-7 ^{(Translated by Pickthall)}. “quoted text”

Example 9

{{cite quran|5|4|end=7|style=nosup|translator=p}}

Qur'an 5:4-7 ^{(Translated by Pickthall)}

Example 10

{{cite quran|5|4|end=7|style=nosup}} OR
{{cite quran|5|4|end=7|style=ref}}

Qur'an 5:4-7
Qur'an 5:4-7

Example 11

{{cite quran|5|4|end=7|style=ref|quote=quoted text}}

Qur'an 5:4-7. “quoted text”

Example 12

{{cite quran|5|4|end=7|style=ref|translator=s|quote=quoted text}}

Qur'an 5:4-7 ^{(Translated by Shakir)}. “quoted text”

Example 13

{{cite quran|5|4|end=7|style=ref|translator=a|quote=quoted text}}

Qur'an 5:4-7 ^{(Translated by Asad)}. “quoted text”