WikiIslam:Standardization: Difference between revisions

Latest revision as of 18:35, 26 December 2020

Shortcut: WIS

Standardization of content is important. The more standardized WikiIslam is, the more readable its text is, the better the impression it makes on readers, and the easier it is to edit an article.

Templates

Templates are one of the tools that WikiIslam uses to standardize its content. These templates:

Act like a black box so the editor can just type and the template does all of the standardization.
Allow quick and easy changes to the standard; changes which immediately affects all text that used that template.

Citation template

Main pages: WikiIslam:Citing,_Linking,_and_Quoting and WikiIslam:Source_Editing

For non Quran/hadith citations, always use the "Citation" template. At present, several other templates for citations exist (such as "Cite Web Quotebox" template, "Cite Book" template, and "Cite" template), however these templates should not be used. These other templates for citation exist for now only because site administrators are in the process of removing these templates, which will take some time since much of the older content on the site is formatted using the several other, older, and messier templates for citations.

Quotation Boxes and Islamic Text

Templates make it easy to cite Islamic sources. For example, instead of finding the exact USC-MSA URL of a Qur'an verse or hadith, all that is needed is to type {{Muslim|7|88}} and the reference and link is automatically created. A list of templates that are available for use can bee found on the WikiIslam:Citing Sources page.

Spelling

All pages should be written using the American English spelling. This is due to their relative popularity and the need to make a choice between one or the other for consistency, and is not a show of favoritism. Some Internet browsers come with built in spell-checkers which should come in useful for those who are not familiar with the difference between UK and US spelling. Also see this page on Wikipedia.

Transliteration of Arabic words

Standardized spelling of transliterated Arabic words and names is important due to the subject matter of WikiIslam. Over time, an article may be modified by numerous editors, often leaving it with multiple spelling variations of a single word. Below is a brief list of the most often transliterated words:

Islam, Qur'an, Hadith, Taurat, Injil, Tafsirs, Sirah, Surah, Jahannam, Jannah, Muslim, Muhammad, Aisha, Jibreel, Jizyah, Zakat, Ka'aba, Shari'ah, Caliph, Umar, Abu Bakr, Jihad, Mecca, Medina, Shaykh

Capitalization

Section headings

Use title-case for capitalization of headings. Thus "Section Headings" and not "Section headings".

The same applies to the titles of articles. Minor words (such as "a, an, the, at, by, for, in, of, on, to, up, and, as, but, it, or, and nor") should be left in small caps. See this link for details.

Links

Wikipedia:Manual of Style

@@ Line 1: / Line 1: @@
-{{shortcut|WI:S}}
+{{shortcut|[[WIS]]}}
-There is a need for standardization at WikiIslam, and the principle reason behind this is quality control. The more standardized WikiIslam is, the more readable its text is, the better the impression it makes on WikiIslam's readers, and the easier it is to edit an article.
+Standardization of content is important. The more standardized WikiIslam is, the more readable its text is, the better the impression it makes on readers, and the easier it is to edit an article.
 ==Templates==
-Templates will be the tool that WikiIslam will use to standardize its content. Templates are the best option since
+[[WikiIslam:Templates|Templates]] are one of the tools that WikiIslam uses to standardize its content. These templates:
-*Templates act like a black box so the editor can just type away and the template does all of the standardization
-*Templates allow quick and easy changes to the standard; changes which immediately affects all text that used that template
-To learn more about templates please read the [http://en.wikipedia.org/wiki/Help:Template Wikipedia article on Templates]
-==Referencing Islamic Texts==
+*Act like a black box so the editor can just type and the template does all of the standardization.
+*Allow quick and easy changes to the standard; changes which immediately affects all text that used that template.
-===Referencing the Qur'an===
+===Citation template===
+{{main|WikiIslam:Citing,_Linking,_and_Quoting|WikiIslam:Source_Editing}}For non Quran/hadith citations, always use the [[template:citation|"Citation" template]]. At present, several other templates for citations exist (such as [[template:cite web quotebox|"Cite Web Quotebox" template]], [[template:cite book|"Cite Book" template]], and [[template:cite|"Cite" template]]), however these templates should not be used. These other templates for citation exist for now only because site administrators are in the process of removing these templates, which will take some time since much of the older content on the site is formatted using the several other, older, and messier templates for citations.
-====Single verse====
+==Quotation Boxes and Islamic Text==
-To reference a verse from the Qur'an type: {&#123;Quran|###|###}}<BR>
+Templates make it easy to cite Islamic sources. For example, instead of finding the exact USC-MSA URL of a Qur'an verse or hadith, all that is needed is to type <tt><nowiki>{{Muslim|7|88}}</nowiki></tt> and the reference and link is automatically created. A list of templates that are available for use can bee found on the [[WikiIslam:Citing Sources]] page.
-Where the first parameter is the chapter number, or Surah, while the second parameter is the verse number.<BR>
-====Multiple verses====
+==Spelling==
-To reference multiple verses from the Qur'an type: {&#123;Quran-range|###|###|###}}<BR>
+All pages should be written using the American English spelling. This is due to their relative popularity and the need to make a choice between one or the other for consistency, and is not a show of favoritism. Some Internet browsers come with built in spell-checkers which should come in useful for those who are not familiar with the difference between UK and US spelling. Also see [http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences this] page on Wikipedia.
-Where the first parameter is the chapter number, or Surah, while the second parameter is the starting verse number, and the "end" parameter is the ending verse number.<BR>
-====Verse and transliteration====
+===Transliteration of Arabic words===
-To reference a verse from the Qur'an along with its Romanized transliteration type: {&#123;Qtt|###|###}}<BR>
+Standardized spelling of transliterated Arabic words and names is important due to the subject matter of WikiIslam. Over time, an article may be modified by numerous editors, often leaving it with multiple spelling variations of a single word. Below is a brief list of the most often transliterated words:
-Where the first parameter is the chapter number, or Surah, while the second parameter is the verse number.<BR>
-See the Q section on [[:Category:Templates|this]] page for all Quran related templates.
+Islam, Qur'an, Hadith, Taurat, Injil, Tafsirs, Sirah, Surah, Jahannam, Jannah, Muslim, Muhammad, Aisha, Jibreel, Jizyah, Zakat, Ka'aba, Shari'ah, Caliph, Umar, Abu Bakr, Jihad, Mecca, Medina, Shaykh
-===Referencing al-Bukhari===
-To reference a verse from [http://www.cmje.org/religious-texts/hadith/bukhari/ al-Bukhari] type: {&#123;Bukhari|###|###|###}}<BR>
-Where the first parameter is the volume number, the second parameter is the book number and the third parameter is the verse number.<BR>
-===Referencing Muslim===
-To reference a verse from [http://www.cmje.org/religious-texts/hadith/muslim/ Muslim] type: {&#123;Muslim|###|###}}<BR>
-Where the first parameter is the book number and the second parameter is the verse number.<BR>
-===Referencing Tabari===
-To reference text from [[The History of al-Tabari|Tabari]], type: {&#123;Tabari|###|###}}<BR>
-Where the first parameter is the volume number and the second parameter is the page or page range.<BR> See the template page for more help: [[Template:Tabari]]
-===Referencing Abu Dawud===
-To reference a verse from [http://www.cmje.org/religious-texts/hadith/abudawud/ Abu Dawud] type: {&#123;Abudawud|###|####}}<BR>
-Where the first parameter is the book number and the second parameter is the verse number.<BR>
-===Referencing Muwatta===
-To reference a verse from [http://www.cmje.org/religious-texts/hadith/muwatta/ Malik's Muwatta] type: {&#123;Muwatta|###|#|#|}}<BR>
-Where the first parameter is the book number, the second parameter is the section number and the third parameter is the verse number.<BR>
-===Examples===
-{| style="width:700px; height:200px" border="1"
-!What you type !! What it looks like
-|-
-| |{&#123;Quran|2|35}} || {{Quran|2|35}}
-|-
-| |{&#123;Quran-range|2|35|36}} || {{Quran-range|2|35|36}}
-|-
-| |{&#123;Qtt|2|35}} || {{Qtt|2|35}}
-|-
-| |{&#123;Bukhari|1|1|5}} || {{Bukhari|1|1|5}}
-|-
-| |{&#123;Muslim|1|5}} || {{Muslim|1|5}}
-|-
-| |{&#123;Abudawud|1|7}} || {{Abudawud|1|7}}
-|-
-| |{&#123;Muwatta|1|1|5|}} || {{Muwatta|1|1|5|}}
-|}
-==Quotes==
-If you are quoting a source type {&#123;Quote|***|***|***}}<BR>
-All three parameters are optional, a call to this template with no parameters will create an empty quote box. The first parameter will be displayed at the very top of the quote box. The second parameter (if it exists) will insert a newline directly after the first parameter and it will then display its (i.e. the second parameter's) text directly after the newline (i.e. underneath the first parameter). The third parameter (if it exists) will be placed directly underneath the second parameter and a newline will be inserted between the second parameter and the third parameter.
-===Examples===
-{| style="width:100%; height:200px" border="1"
-!What you type !! What it looks like
-|-
-| |{&#123;Quote}} || {{Quote}}
-|-
-| |{&#123;Quote|For disbelievers is a painful doom. }} || {{Quote|For disbelievers is a painful doom. }}
-|-
-| |{&#123;Quote|Quran 002.104 |For disbelievers is a painful doom. }} || {{Quote|Quran 002.104 |For disbelievers is a painful doom. }}
-|-
-| |{&#123;Quote|Quran 002.104 |For disbelievers is a painful doom.|See Also Quran 002.174}} || {{Quote|Quran 002.104 |For disbelievers is a painful doom.|See Also Quran 002.174}}
-|-
-| |{&#123;Quote|Our youths only want one thing, to kill you so they can go to paradise.|-Osama bin Laden}} || {{Quote|Our youths only want one thing, to kill you so they can go to paradise.|-Osama bin Laden}}
-|}
-==Quoting Islamic Texts==
-Due to how frequently Islamic texts are quoted at this site, this standard is one of the most important standards used here at WikiIslam. To quote an Islamic text first use the Quote template discussed above with the first parameter being a reference to the verse and the second parameter being the verse itself.
-You may add any type of emphasis (i.e. '''bold text''' or ''italic text'') to the quote. You are also able to do almost anything that you would have regularly been able to do with WikiIslam while inside of a quote.
-===Examples===
-So the above table should have been formatted like this:
-{| style="width:100%; height:200px" border="1"
-!What you type !! What it looks like
-|-
-| |{&#123;Quote|{&#123;Quran|2|104}}|For disbelievers is a painful doom.}} || {{Quote|{{Quran|2|104}}|For disbelievers is a painful doom.}}
-|-
-| |{&#123;Quote|{&#123;Quran|2|104}}|For disbelievers is a painful doom.|See Also {&#123;Quran|2|174}}}} || {{Quote|{{Quran|2|104}}|For disbelievers is a painful doom.|See Also {{Quran|2|174}}}}
-|-
-| |{&#123;Quote|{&#123;Bukhari|7|62|33}}|Narrated Usama bin Zaid: The Prophet said, "After me I have not left any affliction more harmful to men than women."}} || {{Quote|{{Bukhari|7|62|33}}|Narrated Usama bin Zaid: The Prophet said, "After me I have not left any affliction more harmful to men than women."}}
-|-
-| |{&#123;Quote|{&#123;Muslim|36|6597}}|...I looked into the Fire and there I found the majority constituted by women}} || {{Quote|{{Muslim|36|6597}}|...I looked into the Fire and there I found the majority constituted by women}}
-|}
-==Spelling==
-All pages should be written using the American English spelling. Some Internet browsers come with built in spell-checkers which should come in useful for those who are not familiar with the difference between UK and US spelling. Also see [http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences this] page on Wikipedia.
 ==Capitalization==
 ===Section headings===
-Use title-case for capitalization of headings. Thus {{xt|Section Headings}} and ''not'' {{!xt|Section headings}}.
+Use title-case for capitalization of headings. Thus "Section Headings" and ''not'' "Section headings".
-The same applies to the titles of articles.
-===Transliteration of Arabic words===
-Standardized spelling of transliterated Arabic words and names is important due to the subject matter of WikiIslam. Over time, an article may be modified by numerous editors, often leaving it with multiple spelling variations of a single word. Below is a brief list of the most often transliterated words:
-Islam, Qur'an, Hadith, Taurat, Injil, Tafsirs, Sirat, Surah, Jahannam, Jannah, Muslim, Muhammad, Aisha, Jibreel, Jizyah, Zakat, Ka'aba, Shari'ah, Caliph, Umar, Abu Bakr, Jihad, Mecca, Medina, Shaykh
+The same applies to the titles of articles. Minor words (such as "a, an, the, at, by, for, in, of, on, to, up, and, as, but, it, or, and nor") should be left in small caps. See [http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html this link] for details.
 ==See Also==
 *[[Help:Contents]]
+*[[WikiIslam:Formatting]]
 ==Links==
-* [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia:Manual of Style]
+*[http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Wikipedia:Manual of Style]
 [[Category:Help Pages]]
-[[Category:WikiIslam policies and guidelines]]
+[[Category:Policies and Guidelines]]