|
|
Line 1: |
Line 1: |
− | {| style="width: 100%" border="0" cellpadding="1" cellspacing="1" | + | |
| + | {| cellspacing="1" cellpadding="1" border="0" style="width: 100%" |
| |- | | |- |
− | | width="40%" | | + | | style="width: 40%" | |
| __TOC__ | | __TOC__ |
| | | |
| | | |
| + | <br/> |
| | | |
| + | <br/> |
| | | |
− | | width="2%" | <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. | | 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. |
Line 13: |
Line 16: |
| <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! | | <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 class="mw-headline" id="Ten_things_you_should_do_and_ten_you_should_not_while_being_on_energypedia:.C2.A0">While writing your articles keep in mind the energypedia "[http://help.energypedia.info/index.php/Do%27s_and_Don%27ts Do's and Don'ts]" (10 things you should do and 10 you should not</span>). | + | <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> | | <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] | | *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] | | *Secondly, the official [https://energypedia.info/index.php/User:Wiki_Gardener energypedia Wiki Gardener] |
Line 23: |
Line 25: |
| |} | | |} |
| | | |
| + | <br/> |
| | | |
| = Article Structure<br/> = | | = Article Structure<br/> = |
| | | |
− | *Good articles usually start with a short [[Guidelines to Make Good Articles#Overview|„Overview“]], | + | *Good articles usually start with a short [[Guidelines to Make Good Articles#Overview|„Overview“]], |
− | *followed by the '''[[Guidelines to Make Good Articles#Main Part|main part]]''' (content should be clustered into [http://help.energypedia.info/Guidelines to Make Good Articles#Paragraphs Paragraphs]) | + | *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"]], | | *including [[Guidelines to Make Good Articles#Further Information|"Further Information"]], |
− | *and end with [[Guidelines to Make Good Articles#References|"References"]]. | + | *and end with [[Guidelines to Make Good Articles#References|"References"]]. |
| | | |
| <br/> | | <br/> |
Line 47: |
Line 50: |
| === Paragraphs<br/> === | | === Paragraphs<br/> === |
| | | |
− | Paragraphs are used to structure texts and to make it easier for readers to follow the article's argumentation line. | + | 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. | | A paragraph compromises several sentences which focus on one idea, argument or aspects. |
Line 56: |
Line 59: |
| === Headings<br/> === | | === Headings<br/> === |
| | | |
− | The headings automatically appear in the table of contents on top of each article (once there are at least 3 headings). | + | 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 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. | | *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. |
Line 81: |
Line 84: |
| <span class="tocnumber">4.1.1</span> <span class="toctext">Biomass Potential and Distribution</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 data-cke-bookmark="1" style="display: none" id="cke_bm_197E"></span></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> |
| | | |
| |} | | |} |
Line 124: |
Line 127: |
| -> 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]". | | -> 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/> |
− | | + | |
− | = Qustions? =
| + | |
− | | + | |
− | [mailto:info@energypedia.info?Subject=energypedia feedback Simply send us an email].
| + | |
− | | + | |
| | | |
| = Integration Into the Wiki Structure<br/> = | | = Integration Into the Wiki Structure<br/> = |
Line 139: |
Line 137: |
| 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 to structure the wiki so that individual articles do not get lost. On energypedia we usualy distinguish between two different types of links: |
| | | |
− | | + | <br/> |
− | | + | #'''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. |
− | #'''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: '''Gives further information about organizations or articles in the web. Please use the short name (if given) for the link. | | #'''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%" |
− | {| style="width: 100%" border="1" cellpadding="1" cellspacing="1" | + | |
| |- | | |- |
− | | style="background-color: rgb(255, 255, 102)" | | + | | style="background-color: rgb(255, 255, 204)" | |
− | '''Example''' | + | '''Example'''<br/> |
| | | |
− | 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. | + | 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. |
| | | |
| |} | | |} |
| | | |
− | | + | <br/> |
| | | |
| == Categories<br/> == | | == Categories<br/> == |
| | | |
| To give your article the last polish don't forget to categorize it. | | To give your article the last polish don't forget to categorize it. |
− |
| |
| *You can add one or more category tag to your article. | | *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. | | *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/> |
| | | |
− | -> For help how to categorize articles please find more information [http://help.energypedia.info/index.php/How_to_use_Categories here].
| + | <br/> |
| | | |
| __NOAUTHORLIST__ | | __NOAUTHORLIST__ |
| + | <br/> |
| | | |
− | [[Category:Articles]]
| |
| [[Category:Basics]] | | [[Category:Basics]] |
| + | [[Category:Articles]] |
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.
The main part includes the specific paragraphs and subparagraphs and if you have also further information.
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.
The headings automatically appear in the table of contents on top of each article (once there are at least 3 headings).
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.
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.
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 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:
To give your article the last polish don't forget to categorize it.