|
|
| (31 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| | | | |
| − | {| cellspacing="1" cellpadding="1" border="0" style="width: 100%"
| + | = Article Title = |
| − | |-
| + | |
| − | | style="width: 40%" |
| + | |
| − | __TOC__
| + | |
| | | | |
| − | | + | 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'''". |
| − | <br/>
| + | |
| − | | + | |
| − | <br/>
| + | |
| − | | + | |
| − | | style="width: 2%" | <br/>
| + | |
| − | |
| + | |
| − | After you [http://help.energypedia.info/index.php/Create_a_new_article created a new article] these guidelines will give all necessary information about the structure, editing and style of your article. This will help energypedia to get a clearer appearance, to become more consistent and easier as well as more intuitive to use.
| + | |
| − | <p style="text-align: center">'''Don't let doubts about the format be a reason for not publishing good articles!'''</p>
| + | |
| − | <br/>You can always use the "[http://help.energypedia.info/index.php/Sandbox energypedia sandbox]" first, which allows you to try the different functions of the editor: add some headlines, a table or a graph without worrying that you might mess up an existing article!
| + | |
| − | | + | |
| − | <span id="Ten_things_you_should_do_and_ten_you_should_not_while_being_on_energypedia:.C2.A0" class="mw-headline">While writing your articles keep in mind the energypedia "[http://help.energypedia.info/index.php/Do's_and_Don'ts Do's and Don'ts]" (10 things you should do and 10 you should not</span>).
| + | |
| − | | + | |
| − | <br/><u>You can always ask for support or help:</u>
| + | |
| − | *First, there is the general [http://help.energypedia.info/index.php/Main_Page help section]
| + | |
| − | *Secondly, the official [https://energypedia.info/index.php/User:Wiki_Gardener energypedia Wiki Gardener]
| + | |
| − | *Finally, the energypedia Team directly via [mailto:info@energypedia.info info@energypedia.info]
| + | |
| − | <p style="text-align: center"><br/>'''We are very happy to help and welcome you as an author to the energypedia community.'''</p>
| + | |
| − | |}
| + | |
| | | | |
| | <br/> | | <br/> |
| Line 29: |
Line 8: |
| | = Article Structure<br/> = | | = Article Structure<br/> = |
| | | | |
| − | *Good articles usually start with a short [[Guidelines to Make Good Articles#Overview|„Overview“]],
| + | A good article should have the following structure: |
| − | *followed by the '''[[Guidelines to Make Good Articles#Main Part|main part]]''' (content should be clustered into [[Guidelines_to_Make_Good_Articles#Paragraphs|Paragraphs]])<br/>
| + | |
| − | *including [[Guidelines to Make Good Articles#Further Information|"Further Information"]],
| + | |
| − | *and end with [[Guidelines to Make Good Articles#References|"References"]].
| + | |
| | | | |
| − | <br/> | + | *'''Overview''' or '''Introduction''' |
| − | | + | *'''Main Part''' (should be clustered into [[Add Headings|different headings]])<br/> |
| − | == Overview<br/> ==
| + | *'''Conclusion'''<br/> |
| − | | + | *'''Further Information '''(links to articles or other relevant documents for additional information) |
| − | The “Overview” is a short text introducing the reader to the general topic of your article. This will help the reader to evaluate the article's relevance for him / her. Furthermore, by clearly explaining the subject, the reader will be better prepared for the following details. Background information can be given here as well as relevant definitions of important aspects.
| + | *'''[[#Article_References|References]] '''(please use appropriate references within your article) |
| | + | *'''[[#Article_Categories|Categories]] '''(categorize your articles according to the theme of the article)<br/> |
| | | | |
| | <br/> | | <br/> |
| | | | |
| − | == Main Part<br/> == | + | == Article References<br/> == |
| | | | |
| − | The main part includes the specific paragraphs and subparagraphs and if you have also further information.
| + | In order to ensure a high quality of articles on energypedia, we highly encourage all our authors to add relevant references to their articles. |
| | | | |
| − | <br/>
| + | 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. |
| − | | + | |
| − | === Paragraphs<br/> ===
| + | |
| − | | + | |
| − | Paragraphs are used to structure texts and to make it easier for readers to follow the article's argumentation line.
| + | |
| − | | + | |
| − | A paragraph compromises several sentences which focus on one idea, argument or aspects.
| + | |
| − | *Overly long paragraphs can usually be divided into several, shorter subparagraphs, each dealing with different aspects.
| + | |
| − | | + | |
| − | <br/>
| + | |
| − | | + | |
| − | === Headings<br/> ===
| + | |
| − | | + | |
| − | The headings automatically appear in the table of contents on top of each article (once there are at least 3 headings).
| + | |
| − | *When it comes to choosing a headline always try to find a description that focuses on the key aspects of the following paragraph and make it short and significant. If you are using a expression with a common abbreviation you can always add it there.
| + | |
| − | *When formatting always start with “Heading 1” and go hierarchically down for the subheadings. Subjects with the same hierarchy should have the same hierarchically heading format.
| + | |
| − | *Before each heading please include a space line and use capital letters in the heading<span style="color:#ff0000"></span>.
| + | |
| − | *Headings should not be a link at the same time - it is preferred if links are given in the section below the heading.
| + | |
| − | | + | |
| − | <br/>
| + | |
| | | | |
| | {| cellspacing="1" cellpadding="1" border="1" style="width: 100%" | | {| cellspacing="1" cellpadding="1" border="1" style="width: 100%" |
| | |- | | |- |
| − | | style="background-color: rgb(255, 255, 204)" | | + | | style="background-color: rgb(204, 204, 204)" | |
| − | '''Example:''' | + | '''Example''' |
| − | | + | |
| − | <span class="tocnumber">1</span> <span class="toctext">Overview</span>
| + | |
| − | | + | |
| − | <span class="tocnumber">2</span> <span class="toctext">Energy Situation</span>
| + | |
| − | | + | |
| − | <span class="tocnumber">3</span> <span class="toctext">Problem Situation</span>
| + | |
| − | | + | |
| − | <span class="tocnumber">4</span> <span class="toctext">Energy Resources</span>
| + | |
| − | | + | |
| − | <span class="tocnumber">4.1</span> <span class="toctext">Biomass</span>
| + | |
| − | | + | |
| − | <span class="tocnumber">4.1.1</span> <span class="toctext">Biomass Potential and Distribution</span>
| + | |
| | | | |
| − | <span class="tocnumber">4.1.2</span> <span class="toctext">Biomass Stoves: Best Practice Case Study<span id="cke_bm_197E" style="display: none" data-cke-bookmark="1"></span></span>
| + | Berkman, R. I. 1994, Find It Fast: How to Uncover Expert Information on Any Subject, HarperPerennial, New York |
| | | | |
| | |} | | |} |
| Line 90: |
Line 36: |
| | <br/> | | <br/> |
| | | | |
| − | -> For help how to add a heading find more information [http://help.energypedia.info/index.php/Add_headlines here]. | + | -> For instructions on how to add references please see the article: "'''[[Set References|Set References]]'''". |
| | | | |
| | <br/> | | <br/> |
| | | | |
| − | === Length<br/> ===
| |
| | | | |
| − | <span style="color:#ff0000"></span>When articles grow fast they can easily become confusing. This may dount some reader, who are trying to find the wanted information. This is why sometimes it makes sense to create a main page for this headline and link the sub articles to it. The main page would give the general information about the topic and all the other articles can go much more into detail being self contained articles itself as each article on a subtopic should be written as a stand-alone article. <span style="color:#ff0000"></span>
| + | == Article Categories<br/> == |
| | | | |
| − | <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.<br/> |
| | | | |
| − | == Further Information<br/> ==
| + | *To see a list of categories, click '''[https://energypedia.info/wiki/Special:Categories here]'''. |
| | + | *For help on how to categorize articles, please click '''[[How to use Categories|here]]'''. |
| | | | |
| − | If you have any further information to the specific topic this paragraph is the place to list it. However energypedia should not become a link list. Whenever this information can be included into your article this is the better solution.
| |
| | | | |
| − | <br/>
| + | = Article Length = |
| | | | |
| − | == References<br/> ==
| + | 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]]'''. |
| | | | |
| − | In order to ensure the quality, confirmability and trust in energypedia's articles we highly encourage all authors to make extensive use of references and footnotes if the quote from other sources directly or indirectly.
| |
| − |
| |
| − | Furthermore you might use these footnotes to make minor comments that did not fit in the flow of the main text but are still worthwhile sharing.
| |
| − |
| |
| − | 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]:
| |
| − |
| |
| − | {| cellspacing="1" cellpadding="1" border="1" style="width: 100%"
| |
| − | |-
| |
| − | | style="background-color: rgb(255, 255, 204)" |
| |
| − | '''Example'''
| |
| − |
| |
| − | Berkman, R. I. 1994,Find It Fast: How to Uncover Expert Information on Any Subject,HarperPerennial, New York
| |
| − |
| |
| − | |}
| |
| − |
| |
| − | <br/>
| |
| − |
| |
| − | -> For help how to [http://help.energypedia.info/index.php/Insert_Footnotes_and_References insert], [http://help.energypedia.info/index.php/Edit_Footnotes edit], [http://help.energypedia.info/index.php/Link_Footnotes_and_References link] references please find more information in the help section "[http://help.energypedia.info/index.php/Category:Articles All about Articles]".
| |
| − |
| |
| − | <br/>
| |
| | | | |
| | = Integration Into the Wiki Structure<br/> = | | = Integration Into the Wiki Structure<br/> = |
| | | | |
| − | == Links<br/> == | + | == Links (External/Internal)<br/> == |
| | | | |
| − | Links are especially important for other users to get further information on the topic and it's a possibility to keep each article as short and precise as possible as you can "link" to the deeper level of your information instead of cramming it into one huge paragraph and repeating information that has been documented already somewhere else extensively. | + | 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 to structure the wiki so that individual articles do not get lost. On energypedia we usualy distinguish between two different 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: |
| | | | |
| − | <br/>
| + | #'''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]]. |
| − | #'''Internal Link: '''The first option here is to [http://help.energypedia.info/index.php/Link_Articles link to another article] or to [http://help.energypedia.info/index.php/Link_to_a_Headline link to a particular headline] in another or the same article. If you want to link to a document it needs to be [http://help.energypedia.info/index.php/Uploading_Pictures_and_Documents uploaded]before. | + | #'''External Link: '''Using external links, you can [[Link to an External Website|link to external articles in the web]]. |
| − | #'''External Link: '''Gives further information about organizations or articles in the web. Please use the short name (if given) for the link. | + | |
| − | | + | |
| − | <br/>
| + | |
| | | | |
| | {| cellspacing="1" cellpadding="1" border="1" style="width: 100%" | | {| cellspacing="1" cellpadding="1" border="1" style="width: 100%" |
| | |- | | |- |
| − | | style="background-color: rgb(255, 255, 204)" | | + | | style="background-color: rgb(204, 204, 204)" | |
| − | '''Example'''<br/> | + | '''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> |
| − | | + | |
| − | According to the'''World Health Organization ([http://www.who.int/en/ 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. | + | |
| | | | |
| | |} | | |} |
| Line 154: |
Line 74: |
| | <br/> | | <br/> |
| | | | |
| − | == Categories<br/> == | + | = Further Information = |
| | | | |
| − | To give your article the last polish don't forget to categorize it.
| + | *[[:Category:Articles|Help portal on energypedia]] |
| − | *You can add one or more category tag to your article. | + | |
| − | *Adding these tags creates links at the bottom of the article which lead you to a list of all pages in that category, which makes it easy to browse related articles.
| + | |
| − | | + | |
| − | <br/>
| + | |
| − | | + | |
| − | -> For help how to categorize articles please find more information [http://help.energypedia.info/index.php/How_to_use_Categories here].<br/>
| + | |
| − | | + | |
| − | <br/>
| + | |
| | | | |
| | __NOAUTHORLIST__ | | __NOAUTHORLIST__ |
| − | <br/>
| |
| | | | |
| | + | [[Category:Articles]] |
| | [[Category:Basics]] | | [[Category:Basics]] |
| − | [[Category:Articles]]
| |
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".
In order to ensure a high quality of articles on energypedia, we highly encourage all our authors to add relevant references to their articles.
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.
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.
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:
