WikiIslam:Structure: Difference between revisions

From WikiIslam, the online resource on Islam
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
[[File:Lead Image.png|thumb|The Lead Media is the first image seen when opening an article. It should appear on the right-hand side of the lead text, before the table of contents. It should be entered before any text as to align with the top row of the lead paragraph.]]The '''Structure''' of an article concerns the organization of sections and media. Better structure allows the reader to navigate the page easier and feels more intuitive. The structure should also seek to give maintain cohesiveness throughout the wiki. This aims to give the reader a better experience by using a predictable layout. WikiIslam generally adopts an encyclopedic format (e.g. [[72 Virgins]]), but can also include table/list formatted articles (e.g. [[The Timeline of Muhammad]]). All articles can be adjusted to keep the flow and intuitive feel of the article.
[[File:Lead Image.png|thumb|The Lead Media is the first image seen when opening an article. It should appear on the right-hand side of the lead text, before the table of contents. It should be entered before any text as to align with the top row of the lead paragraph.]]The '''Structure''' of an article concerns the organization of sections and media. Better structure allows the reader to navigate the page easier and feels more intuitive. The structure should also seek to give maintain cohesiveness throughout the wiki. This aims to give the reader a better experience by using a predictable layout. WikiIslam employs an encyclopedic format for all articles. All articles can be adjusted to keep the flow and intuitive feel of the article, deviating from these rules where necessary, however such deviations should be deliberate and rare.


==Lead==
==Lead==
Line 5: Line 5:


===First Paragraph===
===First Paragraph===
The first sentence should tell the reader what or who the subject is. If possible the page title should be the subject and if the subject is definable then the first sentence should be the definition. The first sentence should have the subject’s name in bold for the first occurrence and should not be linked. The rest of the paragraph should aim to answer the questions “Who, What, Where, When, and Why” that have not already been answered in the first sentence. Remember to only use simple
The first sentence should tell the reader what or who the subject is. If possible the page title should be the subject and if the subject is definable then the first sentence should be the definition. The first sentence should have the subject’s name in bold for the first occurrence and should not be linked. The rest of the paragraph should aim to answer the questions “Who, What, Where, When, and Why” that have not already been answered in the first sentence.


Here is a good example from the page on [[Muhammad ibn Abdullah|Muhammad]]:
Here is a good example from the page on [[Muhammad ibn Abdullah|Muhammad]]:
Line 16: Line 16:


===Sections===
===Sections===
There are no compulsory sections that are expected in the article or in which particular order they should be. However there are some commonly recurring sections. Articles will cover fast amounts of subjects and each article will be different. We recommend that you use your best judgement to order the article specific sections by relevance. If illustrating a biographical account of someone’s life, try to keep these sections in chronological unless there is critical information that should come first.
There are no compulsory sections that are expected in the article or in which particular order they should be. However there are some commonly recurring sections. Articles will cover fast amounts of subjects and each article will be different. We recommend that the editor use your best judgement to order the article specific sections by relevance. If illustrating a biographical account of someone’s life, try to keep these sections in chronological unless there is critical information that should come first.


Avoid one-sentence paragraphs as they inhibit the flow of the article. In the same vein, also avoid exceedingly long paragraphs that become hard to read. Conversely, short paragraphs usually do not warrant their own sections, tag it along another section where it fits, or if relevant enough add more to the new section.
Avoid one-sentence paragraphs as they inhibit the flow of the article. In the same vein, also avoid exceedingly long paragraphs that become hard to read. Conversely, short paragraphs usually do not warrant their own sections, tag it along another section where it fits, or if relevant enough add more to the new section.


Always consider the trade off between length and readability. For sections that are not as relevant to the subject of the article it may not be necessary to go into exhaustive detail (such as referencing multiple hadiths that say the same thing). If this is a topic worth such attention consider making a page of its own. Some subjects may naturally require more extensive coverage than others.
Always consider the trade off between length and readability. For sections that are not as relevant to the subject of the article it may not be necessary to go into exhaustive detail (such as referencing multiple hadiths that say the same thing). If this is a topic worth such attention consider making a page of its own. Some subjects may naturally require more extensive coverage than others. Sections which become overly long should be considered for articles of their own.  


===Text Quote===
===Text Quote===

Revision as of 09:45, 9 November 2020

The Lead Media is the first image seen when opening an article. It should appear on the right-hand side of the lead text, before the table of contents. It should be entered before any text as to align with the top row of the lead paragraph.

The Structure of an article concerns the organization of sections and media. Better structure allows the reader to navigate the page easier and feels more intuitive. The structure should also seek to give maintain cohesiveness throughout the wiki. This aims to give the reader a better experience by using a predictable layout. WikiIslam employs an encyclopedic format for all articles. All articles can be adjusted to keep the flow and intuitive feel of the article, deviating from these rules where necessary, however such deviations should be deliberate and rare.

Lead

The lead is an introductory summary that comes before the table of contents and is not followed by any section titles. It aims to give the most essential information about the subject within the first few lines in simple and short sentences. The lead should contain no more than five easy to read paragraphs.

First Paragraph

The first sentence should tell the reader what or who the subject is. If possible the page title should be the subject and if the subject is definable then the first sentence should be the definition. The first sentence should have the subject’s name in bold for the first occurrence and should not be linked. The rest of the paragraph should aim to answer the questions “Who, What, Where, When, and Why” that have not already been answered in the first sentence.

Here is a good example from the page on Muhammad:

Lead First Paragraph Example.png

Following Paragraphs

Following paragraphs should include “peacock terms” or stand out summarized information about the subject from the body. For example, in an article about Aisha, her age at marriage would be a peacock term of interest. This should be mentioned in the lead in no more than one or two sentences and developed later on in the body. These paragraphs should also be kept as simply written and possible. All text should aim to be as neutral as possible.

Body

Sections

There are no compulsory sections that are expected in the article or in which particular order they should be. However there are some commonly recurring sections. Articles will cover fast amounts of subjects and each article will be different. We recommend that the editor use your best judgement to order the article specific sections by relevance. If illustrating a biographical account of someone’s life, try to keep these sections in chronological unless there is critical information that should come first.

Avoid one-sentence paragraphs as they inhibit the flow of the article. In the same vein, also avoid exceedingly long paragraphs that become hard to read. Conversely, short paragraphs usually do not warrant their own sections, tag it along another section where it fits, or if relevant enough add more to the new section.

Always consider the trade off between length and readability. For sections that are not as relevant to the subject of the article it may not be necessary to go into exhaustive detail (such as referencing multiple hadiths that say the same thing). If this is a topic worth such attention consider making a page of its own. Some subjects may naturally require more extensive coverage than others. Sections which become overly long should be considered for articles of their own.

Text Quote

Text quotes are sometimes necessary to highlight a relevant piece of work within the article. Generally, using the "Template:Quote" format outside of the "Relevant Quotations" section should be avoided, as it is highly preferable to simple incorporate a summary of the source directly into the text along with a footnote. If, however, a summary would prove ineffective and a brief direct quote cannot be incorporated into the text directly (if, for instance, the quote is lengthy or includes a bulleted list), then the "Template:Quote" format may be used. Be sure to include a footnote reference either way.

Commonly Recurring Sections

Terms, Authenticity, Relevant Quotations, and Apologetic Arguments are reoccurring sections of Islamic articles but can be foregone where they don’t apply (for example, "Apologetic Arguments" and "Terms" sections wouldn’t make sense in an article about Abu Bakr, but would make sense in an article about his rulings).

Terms

This section should establish lexical translations of Arabic or classical Arabic terms that will be recurring in a specific article. These terms should be formatted into a "numbered list".

Here is a good example from the page on Embryology in the Quran:

Terms Example.png

Authenticity

This is a recurring section that should be included if the subject allows. This section of the body will use Qur’an, hadith, and exegeses to show the accuracy and reliability of the sources that support the claims in the lead and body. This is extremely important in relation to hadiths, since they can range from da’if (weak) to sahih (authentic). Be as objective as possible and let the scripture confront itself. Thus, any and all claims in this section must be cited, and language kept neutral.

The “Authenticity” section should come after the lead and table of contents of rulings, events, stances, and claims, or any heavily disputed articles. This section should not appear in an article about a person.

Association with X

This section is a reoccurring section that intends to highlight the harms of some claims and their consequences. Many of the harmful ideas in Islam have real world consequences, so in neutral language, a clear distinction can and should be drawn if applicable and justifiable.

Here are some examples:

A section on “Association with Terrorism” from the article on 72 Virgins

A section on “Association with Child Marriage” from the article on Aisha's Age of Consummation

Relevant Quotations

The “Relevant Quotations” section will contain the most direct relevant quotations from Quran, hadith, and exegeses. These will only be in “Template:Quote" format. Unless necessary this section should contain the only usage of the quotation template in the article.

This section should be around a single page in length, with the '''important sections of quotes''' in bold with a working link at the bottom right (when referencing outside the article).

Here is an example of a quote formatted for use in a "Relevant Quotations" section:

Relevant Quotations Example.png

If you must reference something to support a claim in other sections, summarize what it says and cite it in a footnote. If you must quote a published work, including Quran and hadith outside of the “Relevant Quotations” section use the quotation template (if, for instance, the quote is lengthy or includes a bulleted list) or, better yet, incorporate the quote into the text -- include a footnote citation at the end either way, and remember that incorporating a quote into the text directly is preferred when possible.

Apologetic Arguments

The “Apologetic Arguments” section aims to mention and clarify common apologetic arguments as well as related scripture and counter arguments from other scholars. This section should allow readers to determine for themselves the strength of the apologetic argument.

This section should come at the end of the article. Within this section, the titles of individual arguments should be in Sub-heading 1 format. Each argument should be presented in two parts: The first part being an short and concise objective explanation of the main points of the apologetic argument which should always be cited wherever possible. The second paragraph (or subsequent paragraphs) should contain a short and concise objective counter argument(s). The counter argument should summarize other scholarly sources, preferably Islamic scriptures. Avoid using quote templates in this section as much as possible  - use citation footnotes and attempt to incorporate quotes, where they are necessary, into the text directly.

Example of weak structure:

Weak Structure Example.png

Amended version:

Amended Structure Example.png


Ending

No Conclusions or Endings

The article should contain no conclusions or endings after the body. The editor should not come to conclusions about the sources and should leave the reader to draw their own conclusions from the information provided. Endings give a sense of finality and do not encourage the reader to do more research. The bottom of the page should be the least important section of the page or the Apologetic Arguments section.

Media

All media must:

  • Adhere to usage rights that allow for free use, sharing, and modification.
Usage rights.png
  • Images must be appropriate to audiences of all ages, and safe to view in workspaces, unless they are historically or artistically relevant
  • Be relevant to the associated article and include a short description.

Lead Media

The Lead Media is the first image seen when opening an article. It should appear on the right-hand side of the lead text, before the table of contents. It should be entered before any text as to align with the top row of the lead paragraph.

For Individual subjects: If the article focuses on an individual/entity/being then the image should be included in an infobox template (a sidebar that includes pertinent factual information listed under a relevant image). If available, the image should be the clearest possible picture which includes the subject’s face. If no photos of the subject exist, then a portrait or historical depiction of the subject will suffice, if also unavailable choose an image that a reader would understand and be able to connect to the subject.

For Other Subjects: Choose the most relevant and appropriate article available that is directly relatable to the topic. The reader should not have to work out the relevance of the image to the subject.

Infobox

The infobox is a fact-sheet style mediawiki template. It consists of a table which lists known facts about the subject (usually a person). Infoboxes should include, but are not limited to, the lead media, birth and death dates, birth name, spouses, family, notable works, and other pertinent facts. Infobox should never include opinions or any challangable claim.

Body Media

Body Media are images that follow all the criteria of the Lead Media but appear on the right hand side spread throughout the body. Body media should avoid being too close and should aim to have one per section and should be relevant to the subsection it is presented in.

See Also

Additional help with formatting and other related issues can be found at: