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 7: | Line 8: | ||
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'''". | 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 = | = Article Structure = | ||
| Line 18: | Line 17: | ||
*'''[[#Further_Information|Further Information]]''' | *'''[[#Further_Information|Further Information]]''' | ||
*'''[[#References|References]] '''(please use appropriate references within your article) | *'''[[#References|References]] '''(please use appropriate references within your article) | ||
| − | *'''[[#Article_Categories|Categories]] '''( | + | *'''[[#Article_Categories|Categories]] '''(categorise your articles according to the theme of the article)<br/> |
== Overview == | == Overview == | ||
| Line 34: | Line 33: | ||
== References == | == 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. | + | 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 section. |
-> 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 40: | Line 39: | ||
== Article Categories<br/> == | == Article Categories<br/> == | ||
| − | To make your articles easily accessible to other energypedia users, don't forget to | + | To make your articles easily accessible to other energypedia users, don't forget to categorise them. Categories help to consolidate the articles into relevant themes, making it easier for other users to search and find them.<br/> |
| − | *To see a list of | + | *To see a list of categories used on energypedia, click '''[[Special:Categories|here]]'''. |
| − | *For help on how to | + | *For help on how to categorise articles, please click '''[[Help:Categorize an Article|here]]'''. |
<br/> | <br/> | ||
| Line 50: | Line 49: | ||
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 '''[[Help:Link to an Article|link them to one another]]'''. | 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 '''[[Help:Link to an Article|link them to one another]]'''. | ||
| − | |||
| − | |||
== Add Pictures == | == Add Pictures == | ||
| − | Pictures increase the aesthetics of the article and attracts users. Therefore, whenever possible, please add pictures to your article. Before adding the picture, kindly [[Help: | + | Pictures increase the aesthetics of the article and attracts users. Therefore, whenever possible, please add pictures to your article. Before adding the picture, kindly [[Help:Upload Pictures and Documents|upload it]] to energypedia and then [[Help:Insert Pictures or Documents|link to it]]. |
Kindly add the appropriate copyrights to the pictures and do not upload pictures where the copyrights are not clear. | Kindly add the appropriate copyrights to the pictures and do not upload pictures where the copyrights are not clear. | ||
Revision as of 08:26, 16 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 (categorise 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.
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 section.
-> 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 categorise them. Categories help to consolidate the articles into relevant themes, making it easier for other users to search and find them.
- To see a list of categories used on energypedia, click here.
- For help on how to categorise 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.
Add Pictures
Pictures increase the aesthetics of the article and attracts users. Therefore, whenever possible, please add pictures to your article. Before adding the picture, kindly upload it to energypedia and then link to it.
Kindly add the appropriate copyrights to the pictures and do not upload pictures where the copyrights are not clear.
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 |
