WikiIslam:Source Editing: Difference between revisions

From WikiIslam, the online resource on Islam
Jump to navigation Jump to search
No edit summary
(In-Line Citations)
Line 2: Line 2:
Formatting a [[WikiIslam]] article differs from when writing on a standard word processor. Wikis use text codes to create particular elements of the page (e.g., headings). This markup language is known as wikitext (or wiki-markup) and is designed for ease of editing.
Formatting a [[WikiIslam]] article differs from when writing on a standard word processor. Wikis use text codes to create particular elements of the page (e.g., headings). This markup language is known as wikitext (or wiki-markup) and is designed for ease of editing.


== Font ==
==Font==
'''Bolding''' and ''italicizing'' are done by surrounding a word or phrase with multiple apostrophes (<tt>'</tt>):
'''Bolding''' and ''italicizing'' are done by surrounding a word or phrase with multiple apostrophes (<tt>'</tt>):


Line 101: Line 101:
! width="50%" |Input!! width="50%" |Output
! width="50%" |Input!! width="50%" |Output
|-
|-
| <tt>{&#123;Quote   |{&#123;<nowiki>Quran|2|256}}|Let there be no compulsion in religion: Truth stands out clear from Error...}}</nowiki>
| <tt>{&#123;Quote   |{&#123;<nowiki>Quran|2|256}}|Let there be no compulsion in religion: Truth stands out clear from Error...}}</nowiki>
|{{Quote|{{Quran|2|256}}|Let there be no compulsion in religion: Truth stands out clear from Error...}}
|{{Quote|{{Quran|2|256}}|Let there be no compulsion in religion: Truth stands out clear from Error...}}
|}
|}
Line 112: Line 112:
|<tt><nowiki>{{Quote|{{cite web quotebox|url= http://www.jordantimes.com/?news=19888|title= Productivity suffers during holy month|publisher= The Jordan Times|author= Mohammad Ghazal|date= September 10, 2009|archiveurl= http://www.webcitation.org/query?url=http://www.jordantimes.com/?news=19888&date=2011-04-04|deadurl=no}}|The holy month at the time of the Prophet Mohammad and his companions was a time of great achievements and crucial battles won by the Muslims, Sharia (Islamic law) scholar Hamdi Murad said Wednesday.}}</nowiki></tt>
|<tt><nowiki>{{Quote|{{cite web quotebox|url= http://www.jordantimes.com/?news=19888|title= Productivity suffers during holy month|publisher= The Jordan Times|author= Mohammad Ghazal|date= September 10, 2009|archiveurl= http://www.webcitation.org/query?url=http://www.jordantimes.com/?news=19888&date=2011-04-04|deadurl=no}}|The holy month at the time of the Prophet Mohammad and his companions was a time of great achievements and crucial battles won by the Muslims, Sharia (Islamic law) scholar Hamdi Murad said Wednesday.}}</nowiki></tt>
|{{Quote|{{cite web quotebox|url= http://www.jordantimes.com/?news=19888|title= Productivity suffers during holy month|publisher= The Jordan Times|author= Mohammad Ghazal|date= September 10, 2009|archiveurl= http://www.webcitation.org/query?url=http://www.jordantimes.com/?news=19888&date=2011-04-04|deadurl=no}}|The holy month at the time of the Prophet Mohammad and his companions was a time of great achievements and crucial battles won by the Muslims, Sharia (Islamic law) scholar Hamdi Murad said Wednesday.}}
|{{Quote|{{cite web quotebox|url= http://www.jordantimes.com/?news=19888|title= Productivity suffers during holy month|publisher= The Jordan Times|author= Mohammad Ghazal|date= September 10, 2009|archiveurl= http://www.webcitation.org/query?url=http://www.jordantimes.com/?news=19888&date=2011-04-04|deadurl=no}}|The holy month at the time of the Prophet Mohammad and his companions was a time of great achievements and crucial battles won by the Muslims, Sharia (Islamic law) scholar Hamdi Murad said Wednesday.}}
|}
|}<br />
 
== In-line Citations ==
 
===Single Citation===
An example of a reference being made on a page:
{| border="1" cellpadding="20" cellspacing="0"
|This is how to provide inline citations.<ref>This is the reference text. [http://example.com/ Links can also be provided]</ref>''(article text)''
 
''(more article text)''
 
<big>'''References'''</big>
----
<references group=""></references>
|}Here is what has to be typed:
 
::<code>This is how to provide inline citations.<nowiki><ref>This is the reference text. [http://example.com/ Links can also be provided]</ref></nowiki></code>
 
At the end of an article, there should be a "References" heading and below that:
 
::<code><nowiki>{{reflist}}</nowiki></code>
 
The wiki will then automatically do everything else to produce the reference. To edit the reference section produced at the bottom, edit the <nowiki><ref></nowiki> tags.
===Multiple Citations===
For multiple citations of the same reference or footnote:
 
::<code><nowiki><ref name="name here">details of the citation</ref></nowiki></code>
 
Thereafter, the same footnote may be used multiple times by adding:
 
::<code><nowiki><ref name="name here"></ref></nowiki></code>


===Multi-Columned References===
For ease of reading, when a page includes many citations, the standard <code><nowiki>{{reflist}}</nowiki></code> template should be replaced by <code><nowiki>{{Reflist|30em}}</nowiki></code>  (for 10+ citations).
==Links==
==Links==



Revision as of 18:34, 4 January 2019

Shortcut:
WIFMT

Formatting a WikiIslam article differs from when writing on a standard word processor. Wikis use text codes to create particular elements of the page (e.g., headings). This markup language is known as wikitext (or wiki-markup) and is designed for ease of editing.

Font

Bolding and italicizing are done by surrounding a word or phrase with multiple apostrophes ('):

Input Output
''italic'' italic

'''bold'''

bold

'''''bold italic'''''

bold italic

Bold emphasis should only be used within quotation boxes or when the name of an article's subject in an encyclopedic page is first mentioned. In all other cases, italics should be used when emphasis is needed (this should be used sparingly and only when absolutely needed). Underlining and ALLCAPS should be avoided.

Sections

Headings and subheadings are a way to improve the organization of an article. If there are two or more distinct topics being discussed, the article should be made more readable by inserting a heading for each topic — that is making each into its own section. This can go up to subsubsubsubheadings.

Input Output
==Headings==

Headings

===Subheadings===

Subheadings

====Subsubheadings====

Subsubheadings

If an article has at least four headings, a table of contents will automatically be generated. Headings do not form a part of the main text. They only indicate the general topic of that particular section, and should not contain information not found within its main text. So when choosing titles for headings and subheading, questions or long sentences should be avoided.

Lists

Input Output

* Unordered lists can be created by:
** Starting every line with a star.
*** More stars indicate a deeper level.
*: Previous item continues.
** A new line
* in a list
marks the end of the list.
* A new list can be started again.

  • Unordered lists can be created by:
    • Starting every line with a star.
      • More stars indicate a deeper level.
    Previous item continues.
    • A newline
  • in a list

marks the end of the list.

  • A new list can be started again.

# Used appropriately, numbered lists can be:
## Very organized
## Easy to follow
A new line marks the end of the list.
# New numbering starts with 1.

  1. Used appropriately, numbered lists can be:
    1. Very organized
    2. Easy to follow

A new line marks the end of the list.

  1. New numbering starts with 1.

Quotations

When quoting a source, the Quotation template should be used. The first parameter is the reference for the text being quoted (this parameters can be left empty if references are being cited via ref tags). The second parameter is where the actual quotation is placed.

There are many templates available for Islamic sources (e.g. Qur'an, Bukhari, Muslim, Dawud, Malik's Muwatta, Tirmidhi, Nasai, Majah and Tabari). To quote an Islamic text, the relevant template for referencing that particular text must be placed within the first parameter of the Quotation template.

Input Output
{{Quran|2|256}}|Let there be no compulsion in religion: Truth stands out clear from Error...}}
Let there be no compulsion in religion: Truth stands out clear from Error...

For quoting general sources, a modified version of the Cite Web template is used. The modified Cite Web template must be placed within the first parameter of the Quotation template.

Input Output
{{Quote|{{cite web quotebox|url= http://www.jordantimes.com/?news=19888|title= Productivity suffers during holy month|publisher= The Jordan Times|author= Mohammad Ghazal|date= September 10, 2009|archiveurl= http://www.webcitation.org/query?url=http://www.jordantimes.com/?news=19888&date=2011-04-04|deadurl=no}}|The holy month at the time of the Prophet Mohammad and his companions was a time of great achievements and crucial battles won by the Muslims, Sharia (Islamic law) scholar Hamdi Murad said Wednesday.}}
The holy month at the time of the Prophet Mohammad and his companions was a time of great achievements and crucial battles won by the Muslims, Sharia (Islamic law) scholar Hamdi Murad said Wednesday.
"Productivity suffers during holy month" (archived)
Mohammad Ghazal, The Jordan Times, September 10, 2009, http://www.jordantimes.com/?news=19888.
 


In-line Citations

Single Citation

An example of a reference being made on a page:

This is how to provide inline citations.[1](article text)

(more article text)

References


  1. This is the reference text. Links can also be provided

Here is what has to be typed:

This is how to provide inline citations.<ref>This is the reference text. [http://example.com/ Links can also be provided]</ref>

At the end of an article, there should be a "References" heading and below that:

{{reflist}}

The wiki will then automatically do everything else to produce the reference. To edit the reference section produced at the bottom, edit the <ref> tags.

Multiple Citations

For multiple citations of the same reference or footnote:

<ref name="name here">details of the citation</ref>

Thereafter, the same footnote may be used multiple times by adding:

<ref name="name here"></ref>

Multi-Columned References

For ease of reading, when a page includes many citations, the standard {{reflist}} template should be replaced by {{Reflist|30em}} (for 10+ citations).

Links

Internal Links

Internal link can be added by enclosing the name of the target page in double square brackets ([[]]). If the page exists, it is displayed in blue, if it does not, it is displayed in red. Leaving red links should always be avoided. Piped links can be used when the displayed text is required to be different to the page title of the actual target page ([[page title|desired text]]). This is often required because WikiIslam uses title-case for capitalization of headings.

External Links

Most articles also include links to supplementary external web content (i.e. an "External Links" section). These sections should always be placed below the "See Also" section and above the "References" section. Links should be kept to a minimum (about two) and should be beneficial to the page in some way. They should not be provided just for the sake of providing them. They should include additional information that is not available or out of the scope of WikiIslam. External links should always be archived and can be cited using the External link template.

See Also