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
***** (***** | *****)
(Created page with " <br/>= Article Title = 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 examp...")
 
***** (***** | *****)
m
Line 1: Line 1:
  
<br/>= Article Title =
+
= Article Title =
  
 
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. For example, instead of writing "'''energy source"''' as the article title, please write "'''Energy Source'''".
  
&lt;br/&gt;
+
<br/>
  
= Article Structure&lt;br/&gt; =
+
= Article Structure<br/> =
  
 
A good article should have the following structure:
 
A good article should have the following structure:
  
*'''Overview''' or&nbsp;'''Introduction'''<br/>*'''Main Part''' (should be clustered into &#x5B;&#x5B;Add Headings|different headings&#x5D;&#x5D;)&lt;br/&gt;<br/>*'''Conclusion'''&lt;br/&gt;<br/>*'''Further Information '''(links to articles or other relevant documents for additional information)<br/>*'''&#x5B;&#x5B;#Article_References|References&#x5D;&#x5D;&nbsp;'''(please use appropriate references within your article)<br/>*'''&#x5B;&#x5B;#Article_Categories|Categories&#x5D;&#x5D;&nbsp;'''(categorize your articles according to the theme of the article)&lt;br/&gt;
+
*'''Overview''' or&nbsp;'''Introduction'''
 +
*'''Main Part''' (should be clustered into [[Add Headings|different headings]])<br/>
 +
*'''Conclusion'''<br/>
 +
*'''Further Information '''(links to articles or other relevant documents for additional information)
 +
*'''[[#Article_References|References]]&nbsp;'''(please use appropriate references within your article)
 +
*'''[[#Article_Categories|Categories]]&nbsp;'''(categorize your articles according to the theme of the article)<br/>
  
&lt;br/&gt;
+
<br/>
  
== Article References&lt;br/&gt; ==
+
== Article References<br/> ==
  
 
In order to ensure a high quality of articles on energypedia, we highly encourage all our authors to add relevant references to their articles.
 
In order to ensure a high quality of articles on energypedia, we highly encourage all our authors to add relevant references to their articles.
Line 20: Line 25:
 
In order to ensure a consistent quotation style we encourage you to use the [http://guides.is.uwa.edu.au/harvard Harvard Citation Style for reference lists], however you are free to use whatever reference style suits you best.
 
In order to ensure a consistent quotation style we encourage you to use the [http://guides.is.uwa.edu.au/harvard Harvard Citation Style for reference lists], however you are free to use whatever reference style suits you best.
  
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%"<br/>|-<br/>| style="background-color: rgb(204, 204, 204)" |&nbsp;<br/>'''Example'''
+
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%"
 +
|-
 +
| style="background-color: rgb(204, 204, 204)" |  
 +
'''Example'''
  
 
Berkman, R. I. 1994, Find It Fast: How to Uncover Expert Information on Any Subject, HarperPerennial, New York
 
Berkman, R. I. 1994, Find It Fast: How to Uncover Expert Information on Any Subject, HarperPerennial, New York
Line 26: Line 34:
 
|}
 
|}
  
&lt;br/&gt;
+
<br/>
  
-> For instructions on how to add references please see the article: "'''&#x5B;&#x5B;Set References|Set References&#x5D;&#x5D;'''".
+
-> For instructions on how to add references please see the article: "'''[[Set References|Set References]]'''".
  
&lt;br/&gt;
+
<br/>
  
== Article Categories&lt;br/&gt; ==
+
== Article Categories<br/> ==
  
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.&lt;br/&gt;
+
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.<br/>
  
*To see a list of articles, click '''[https://energypedia.info/wiki/Special:Categories here]'''.&nbsp;<br/>*For help on how to categorize articles, please click&nbsp;'''&#x5B;&#x5B;How to use Categories|here&#x5D;&#x5D;'''.
+
*To see a list of articles, click '''[[Special:Categories|here]]'''.&nbsp;
 +
*For help on how to categorize articles, please click&nbsp;'''[[How to use Categories|here]]'''.
  
&lt;br/&gt;
+
<br/>
  
 
= Article Length =
 
= 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 '''&#x5B;&#x5B;Link Articles|link them to one another&#x5D;&#x5D;'''.
+
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 Articles|link them to one another]]'''.
  
&lt;br/&gt;
+
<br/>
  
= Integration Into the Wiki Structure&lt;br/&gt; =
+
= Integration Into the Wiki Structure<br/> =
  
== Links (External/Internal)&lt;br/&gt; ==
+
== Links (External/Internal)<br/> ==
  
 
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 information that has already been documented somewhere else.
 
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 information that has already been documented somewhere else.
Line 54: Line 63:
 
Links also help structure a wiki so that individual articles do not get lost. On energypedia we usually distinguish between two types of links:
 
Links also help structure a wiki so that individual articles do not get lost. On energypedia we usually distinguish between two types of links:
  
#'''Internal Link: '''The first option is to &#x5B;&#x5B;Link Articles|link to another article&#x5D;&#x5D; or to &#x5B;&#x5B;Link to a Headline|link to a particular headline&#x5D;&#x5D; in another or the same article, within energypedia. If you want to link to a file it needs to be &#x5B;&#x5B;Uploading Pictures and Documents|uploaded before&#x5D;&#x5D;. For instructions on linking to a file, click &#x5B;&#x5B;Insert File as Picture / Link|here&#x5D;&#x5D;.<br/>#'''External Link: '''Using external links, you can &#x5B;&#x5B;Link to an External Website|link to external articles in the web&#x5D;&#x5D;.
+
#'''Internal Link: '''The first option is to [[Link Articles|link to another article]] or to [[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 [[Uploading Pictures and Documents|uploaded before]]. For instructions on linking to a file, click [[Insert File as Picture / Link|here]].
 +
#'''External Link: '''Using external links, you can [[Link to an External Website|link to external articles in the web]].
  
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%"<br/>|-<br/>| style="background-color: rgb(204, 204, 204)" |&nbsp;<br/>'''Example'''&lt;br/&gt;&lt;span style="line-height: 1.5em; font-size: 13.6px;"&gt;According to the&nbsp;&lt;/span&gt;'''World Health Organization ([http://www.who.int/en/ WHO]) '''&lt;span style="line-height: 1.5em; font-size: 13.6px;"&gt;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.&lt;/span&gt;
+
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%"
 +
|-
 +
| style="background-color: rgb(204, 204, 204)" |  
 +
'''Example'''<br/><span style="line-height: 1.5em; font-size: 13.6px;">According to the&nbsp;</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>
  
 
|}
 
|}
  
&lt;br/&gt;
+
<br/>
  
 
= Further Information =
 
= Further Information =
  
*&#x5B;&#x5B;:Category:Articles|Help portal on energypedia&#x5D;&#x5D;
+
*[[:Category:Articles|Help portal on energypedia]]
  
&#95;&#95;NOAUTHORLIST&#95;&#95;
+
__NOAUTHORLIST__

Revision as of 13:29, 9 June 2016

Article Title

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".


Article Structure

A good article should have the following structure:

  • Overview or Introduction
  • Main Part (should be clustered into different headings)
  • Conclusion
  • Further Information (links to articles or other relevant documents for additional information)
  • References (please use appropriate references within your article)
  • Categories (categorize your articles according to the theme of the article)


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.

In order to ensure a consistent quotation style we encourage you to use the Harvard Citation Style for reference lists, however you are free to use whatever reference style suits you best.

Example

Berkman, R. I. 1994, Find It Fast: How to Uncover Expert Information on Any Subject, HarperPerennial, New York


-> For instructions on how to add references please see the article: "Set 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 information that has already been documented somewhere else.

Links also help structure a wiki so that 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.


Further Information