Difference between revisions of "Template:Reference Hadith/doc"

From islamWiki...
Jump to: navigation, search
(Update - Parameters (+ref name, edit - book name), TemplateData (+1, descriptions).)
Line 1: Line 1:
 
* It is recommended that Hadith translations and its references are quoted from [http://sunnah.com/ Sunnah.com]
 
* It is recommended that Hadith translations and its references are quoted from [http://sunnah.com/ Sunnah.com]
* The parameter <code>Grade</code> is not absolutely necessary to be defined for the compilations [http://sunnah.com/bukhari Sahih al-Bukhari] and [http://sunnah.com/muslim Sahih Muslim].
+
* The parameter <code>Grade</code> may be unnecessary for the [http://sunnah.com/bukhari Sahih al-Bukhari] and [http://sunnah.com/muslim Sahih Muslim] Hadith compilations.
  
 
== Usage ==
 
== Usage ==
 
<pre>{{Reference Hadith| hadith collection = Sunan Abi Dawud| hadith number = 2564| url = http://sunnah.com/abudawud/15/88| book name = Book of Jihad (Kitab Al-Jihad)| arabic reference =| in-book reference = Book 15, Hadith 88| english reference = Book 14, Hadith 2558| grade = Sahih (Al-Albani)}}</pre>
 
<pre>{{Reference Hadith| hadith collection = Sunan Abi Dawud| hadith number = 2564| url = http://sunnah.com/abudawud/15/88| book name = Book of Jihad (Kitab Al-Jihad)| arabic reference =| in-book reference = Book 15, Hadith 88| english reference = Book 14, Hadith 2558| grade = Sahih (Al-Albani)}}</pre>
  
 +
== TemplateData ==
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 16: Line 17:
 
"type": "string",
 
"type": "string",
 
"default": "Provide hadith collection name",
 
"default": "Provide hadith collection name",
"required": true
+
"required": true,
},
+
"description": "Name of Hadith collection which includes the Hadith being referenced."
"book name": {
 
"aliases": [
 
"4"
 
],
 
"label": "Book name",
 
"example": "Book of Revelation",
 
"type": "string",
 
"suggested": true
 
 
},
 
},
 
"arabic reference": {
 
"arabic reference": {
Line 34: Line 27:
 
"example": "Book 1, Hadith 1",
 
"example": "Book 1, Hadith 1",
 
"type": "string",
 
"type": "string",
"suggested": true
+
"suggested": true,
 +
"description": "In case an Arabic reference for the referenced Hadith is included in the source."
 
},
 
},
 
"in-book reference": {
 
"in-book reference": {
Line 43: Line 37:
 
"example": "in-book reference",
 
"example": "in-book reference",
 
"type": "string",
 
"type": "string",
"suggested": true
+
"suggested": true,
 +
"description": "In case an In-book reference for the quoted Hadith is included in the source."
 
},
 
},
 
"english reference": {
 
"english reference": {
Line 60: Line 55:
 
],
 
],
 
"label": "Grade",
 
"label": "Grade",
"description": "The reliability grade for the Hadith. Sahih Muslim and Bukhari's grade are not absolutely necessary.",
+
"description": "The reliability grade for the Hadith. Sahih Muslim and Bukhari's grade may not be necessary.",
 
"example": "Sahih (Darussalam)",
 
"example": "Sahih (Darussalam)",
 
"type": "string",
 
"type": "string",
Line 70: Line 65:
 
],
 
],
 
"label": "URL",
 
"label": "URL",
"description": "Link to an online copy of the Hadith",
+
"description": "Link to an online copy of the referenced Hadith",
 
"example": "http://sunnah.com/bukhari/1/1",
 
"example": "http://sunnah.com/bukhari/1/1",
 
"type": "url",
 
"type": "url",
Line 82: Line 77:
 
"example": "1",
 
"example": "1",
 
"type": "number",
 
"type": "number",
 +
"suggested": true,
 +
"description": "If the Hadith collection ascribes a separate single number to the Hadith being referenced, without the use of a volume or chapter."
 +
},
 +
"book": {
 +
"aliases": [
 +
"4"
 +
],
 +
"label": "Book/Chapter name",
 +
"description": "Some Hadith collections include a name of book or chapter under which a particular Hadith is written down.",
 +
"example": "Book of Revelation",
 +
"type": "string",
 +
"suggested": true
 +
},
 +
"reference name": {
 +
"aliases": [
 +
"ref name"
 +
],
 +
"label": "Reference name",
 +
"description": "When the Hadith reference is to be reused later on in the article, include a name for the reference.",
 +
"example": "sboboho",
 +
"type": "string",
 
"suggested": true
 
"suggested": true
 
}
 
}
Line 90: Line 106:
 
"hadith number",
 
"hadith number",
 
"url",
 
"url",
"book name",
+
"book",
 
"arabic reference",
 
"arabic reference",
 
"in-book reference",
 
"in-book reference",
 
"english reference",
 
"english reference",
"grade"
+
"grade",
 +
"reference name"
 
],
 
],
 
"description": "islamWiki template for referencing Hadiths"
 
"description": "islamWiki template for referencing Hadiths"

Revision as of 02:43, 1 January 2018

  • It is recommended that Hadith translations and its references are quoted from Sunnah.com
  • The parameter Grade may be unnecessary for the Sahih al-Bukhari and Sahih Muslim Hadith compilations.

Usage

{{Reference Hadith| hadith collection = Sunan Abi Dawud| hadith number = 2564| url = http://sunnah.com/abudawud/15/88| book name = Book of Jihad (Kitab Al-Jihad)| arabic reference =| in-book reference = Book 15, Hadith 88| english reference = Book 14, Hadith 2558| grade = Sahih (Al-Albani)}}

TemplateData

islamWiki template for referencing Hadiths

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Hadith collectionhadith collection1

Name of Hadith collection which includes the Hadith being referenced.

Default
Provide hadith collection name
Example
Sahih al-Bukhari
Auto value
empty
Stringrequired
Hadith numberhadith number2

If the Hadith collection ascribes a separate single number to the Hadith being referenced, without the use of a volume or chapter.

Default
empty
Example
1
Auto value
empty
Numbersuggested
URLurl3

Link to an online copy of the referenced Hadith

Default
empty
Example
http://sunnah.com/bukhari/1/1
Auto value
empty
URLsuggested
Book/Chapter namebook4

Some Hadith collections include a name of book or chapter under which a particular Hadith is written down.

Default
empty
Example
Book of Revelation
Auto value
empty
Stringsuggested
Arabic referencearabic reference5

In case an Arabic reference for the referenced Hadith is included in the source.

Default
empty
Example
Book 1, Hadith 1
Auto value
empty
Stringsuggested
In-book referencein-book reference6

In case an In-book reference for the quoted Hadith is included in the source.

Default
empty
Example
in-book reference
Auto value
empty
Stringsuggested
English referenceenglish reference7

References such as those used in USC-MSA web (English) references

Default
empty
Example
Vol. 1, Book 1, Hadith 1
Auto value
empty
Stringsuggested
Gradegrade8

The reliability grade for the Hadith. Sahih Muslim and Bukhari's grade may not be necessary.

Default
empty
Example
Sahih (Darussalam)
Auto value
empty
Stringsuggested
Reference namereference nameref name

When the Hadith reference is to be reused later on in the article, include a name for the reference.

Default
empty
Example
sboboho
Auto value
empty
Stringsuggested