Make sure you register to our monthly newsletter, it's going out soon! Stay up do date about the latest energy news and our current activities.
Click here to register!

Difference between revisions of "Guidelines on Writing a Good Article"

From energypedia
***** (***** | *****)
m
***** (***** | *****)
m
Line 1: Line 1:
 +
 
{{template:Tabs-1
 
{{template:Tabs-1
 
|Energypedia_Community:_Help|Back to the Help Portal
 
|Energypedia_Community:_Help|Back to the Help Portal
Line 4: Line 5:
 
}}
 
}}
  
= Article Title =
+
= Article Title and Headings =
  
The title of the article should reflect the theme of the article. Kindly capitalise the first letter of all main words in the article title. For example, instead of writing "'''energy source"''' as the article title, please write "'''Energy Source'''".
+
The title of the article should reflect the theme of the article. Kindly capitalise the first letter of all main words in the article title and in headlines. For example, instead of writing "'''energy source"''' as the article title, please write "'''Energy Source'''".
  
 
<br/>
 
<br/>
Line 14: Line 15:
 
A good article should have the following structure:
 
A good article should have the following structure:
  
 
+
*Overview / Introduction
 
*'''[[#Main_Part|Main Part]]'''
 
*'''[[#Main_Part|Main Part]]'''
*'''[[#Conclusion|Conclusion]]'''<br/>
 
 
*'''[[#Further_Information|Further Information]]'''
 
*'''[[#Further_Information|Further Information]]'''
 
*'''[[#Article_References|References]] '''(please use appropriate references within your article)
 
*'''[[#Article_References|References]] '''(please use appropriate references within your article)
Line 28: Line 28:
  
 
The body of the article should be clustered into [[Help:Add Headings|different headings]].&nbsp;
 
The body of the article should be clustered into [[Help:Add Headings|different headings]].&nbsp;
 
+
<br/>
= Conclusion =
 
 
 
This part should include the major findings of the article.
 
 
 
 
= Further Information =
 
= Further Information =
  
Line 74: Line 70:
 
|-
 
|-
 
| style="background-color: rgb(204, 204, 204)" |  
 
| style="background-color: rgb(204, 204, 204)" |  
'''Example'''<br/><span style="line-height: 1.5em; font-size: 13.6px;">According to the </span>'''World Health Organization ([http://www.who.int/en/ WHO]) '''<span style="line-height: 1.5em; font-size: 13.6px;">as many as 1.6 million people die each year as a result of it. This can be compared with one death every 20 seconds.</span>
+
'''Example'''<br/><span style="line-height: 1.5em; font-size: 13.6px">According to the </span>'''World Health Organization ([http://www.who.int/en/ WHO]) '''<span style="line-height: 1.5em; font-size: 13.6px">as many as 1.6 million people die each year as a result of it. This can be compared with one death every 20 seconds.</span>
  
 
|}
 
|}
  
 
{{Help Magic Words}}
 
{{Help Magic Words}}

Revision as of 12:18, 11 August 2016


Article Title and Headings

The title of the article should reflect the theme of the article. Kindly capitalise the first letter of all main words in the article title and in headlines. For example, instead of writing "energy source" as the article title, please write "Energy Source".


Article Structure

A good article should have the following structure:

Overview

The "Overview" section in each article should give a short summary of the article so that other users can get an initial understanding of the article.

Main Part

The body of the article should be clustered into different headings

Further Information

This part should include to links to articles or other relevant documents for additional information

Article References

In order to ensure a high quality of articles on energypedia, we highly encourage all our authors to add relevant references to their articles. Please include the author's name, year of publication, title of publication and link to it if possible in the reference.

-> For instructions on how to add references please see the article: "Inserting References".


Article Categories

To make your articles easily accessible to other energypedia users, don't forget to categorize them. Categories help consolidate the articles on energypedia into relevant themes, making it easier for other users to search and find them.

  • To see a list of articles, click here.
  • For help on how to categorize articles, please click here.


Article Length

Long articles are difficult to follow and the reader can easily get lost or confused. Therefore, please create short articles. In the case of a long articles, kindly break them into smaller short articles and link them to one another.


Integration Into the Wiki Structure

Links (External/Internal)

Links are especially useful to other users who may want to get further information on a topic. They help to make an article short and precise by interlinking between articles and not repeating the information available elsewhere.

Links also help to structure a wiki so that the individual articles do not get lost. On energypedia we usually distinguish between two types of links:

  1. Internal Link: The first option is to link to another article or to link to a particular headline in another or the same article, within energypedia. If you want to link to a file it needs to be uploaded before. For instructions on linking to a file, click here.
  2. External Link: Using external links, you can link to external articles in the web.

Example
According to the World Health Organization (WHO) as many as 1.6 million people die each year as a result of it. This can be compared with one death every 20 seconds.