Difference between revisions of "Guidelines on Writing a Good Article"
***** (***** | *****) 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 6: | Line 7: | ||
= Article Title and Headings = | = 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 | + | The title of the article should reflect the theme of the article. Kindly capitalise the first letter of all the main words in the article title as well as in the 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 | + | *[[#Overview|Overview / Introduction]] |
*'''[[#Main_Part|Main Part]]''' | *'''[[#Main_Part|Main Part]]''' | ||
*'''[[#Further_Information|Further Information]]''' | *'''[[#Further_Information|Further Information]]''' | ||
| Line 26: | Line 27: | ||
= Main Part = | = Main Part = | ||
| − | The body of the article should be clustered into [[Help: | + | The body of the article should be clustered into [[Help:Add_Headings|different headings]]. <br/> |
| − | <br/> | + | |
= Further Information = | = Further Information = | ||
| − | This part should include | + | This part should include links to other articles or relevant documents for additional information. |
== Article References == | == Article References == | ||
| − | In order to ensure a high quality of articles | + | In order to ensure a high quality of articles and avoid plagiarism, 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: "'''[[Help:Insert References|Inserting References]]'''". | -> For instructions on how to add references please see the article: "'''[[Help:Insert References|Inserting References]]'''". | ||
| Line 64: | Line 65: | ||
#'''Internal Link: '''The first option is to [[Help:Link to an Article|link to another article]] or to [[Help:Link to a Headline|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 [[Help:Upload Pictures and Documents|uploaded before]]. For instructions on linking to a file, click [[Help:Insert File as Picture / Link|here]]. | #'''Internal Link: '''The first option is to [[Help:Link to an Article|link to another article]] or to [[Help:Link to a Headline|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 [[Help:Upload Pictures and Documents|uploaded before]]. For instructions on linking to a file, click [[Help:Insert File as Picture / Link|here]]. | ||
| − | #'''External Link: ''' | + | #'''External Link: '''For instructions on linking to external websites, click [[Help:Link_to_an_External_Website|here.]]In case of external links, there is a small arrow next to the link. |
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%" | {| cellspacing="1" cellpadding="1" border="1" style="width: 100%" | ||
|- | |- | ||
| style="background-color: rgb(204, 204, 204)" | | | style="background-color: rgb(204, 204, 204)" | | ||
| − | '''Example'''<br/><span style="line-height: 1.5em; | + | '''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> |
|} | |} | ||
Revision as of 14:31, 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 the main words in the article title as well as in the 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 / Introduction
- Main Part
- Further Information
- References (please use appropriate references within your article)
- Categories (categorize your articles according to the theme of the article)
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 links to other articles or relevant documents for additional information.
Article References
In order to ensure a high quality of articles and avoid plagiarism, 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.
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:
- 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.
- External Link: For instructions on linking to external websites, click here.In case of external links, there is a small arrow next to the link.
|
Example |
