|
|
Line 5: |
Line 5: |
| __TOC__ | | __TOC__ |
| | | |
− | | + | <br/><br/><br/><br/><br/><br/><br/> |
− | <br/><br/><br/><br/><br/><br/> | + | |
| | | |
| | style="width: 2%" | <br/> | | | style="width: 2%" | <br/> |
| | | | | |
− | After you have [http://help.energypedia.info/wiki/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 have [[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> | | <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! | + | <br/>You can always use the "[[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>). | + | <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 "[[Do's_and_Don'ts|Do's and Don'ts]]" (10 things you should do and 10 you should not</span>). |
| | | |
| |- | | |- |
Line 20: |
Line 19: |
| | style="width: 2%" | | | | style="width: 2%" | |
| | <u>You can always ask for support or help:</u><br/> | | | <u>You can always ask for support or help:</u><br/> |
− | *First, there is the general [http://help.energypedia.info/index.php/Main_Page help section] | + | *First, there is the general [[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] |
| *Finally, the energypedia Team directly via [mailto:info@energypedia.info info@energypedia.info] | | *Finally, the energypedia Team directly via [mailto:info@energypedia.info info@energypedia.info] |
Line 54: |
Line 53: |
| | | |
| 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. |
| + | |
| *Overly long paragraphs can usually be divided into several, shorter subparagraphs, each dealing with different aspects. | | *Overly long paragraphs can usually be divided into several, shorter subparagraphs, each dealing with different aspects. |
| | | |
Line 61: |
Line 61: |
| | | |
| 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 91: |
Line 92: |
| <br/> | | <br/> |
| | | |
− | -> For help how to add a heading find more information [http://help.energypedia.info/index.php/Add_headlines here]. | + | -> For help how to add a heading find more information [[Add_headlines|here]]. |
| | | |
| <br/> | | <br/> |
Line 109: |
Line 110: |
| <br/> | | <br/> |
| | | |
| + | <br/> |
| | | |
| == References<br/> == | | == References<br/> == |
Line 129: |
Line 131: |
| <br/> | | <br/> |
| | | |
− | -> For help how to insert, edit, link references please find more information in the help section "[[Set_References|Set References]]". | + | -> For help how to insert, edit, link references please find more information in the help section "[[Set References|Set References]]". |
| | | |
| <br/> | | <br/> |
| | | |
| + | <br/> |
| | | |
| = Integration Into the Wiki Structure<br/> = | | = Integration Into the Wiki Structure<br/> = |
Line 143: |
Line 146: |
| | | |
| <br/> | | <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 [[Link_Articles|link to another article]] or to [[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 [[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. |
| | | |
Line 162: |
Line 166: |
| | | |
| 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. |
Line 167: |
Line 172: |
| <br/> | | <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 [[How_to_use_Categories|here]].<br/> |
| | | |
| <br/> | | <br/> |
| | | |
− | __NOAUTHORLIST__ | + | __NOAUTHORLIST__<br/> |
− | <br/> | + | |
| | | |
| [[Category:Articles]] | | [[Category:Articles]] |
| [[Category:Basics]] | | [[Category:Basics]] |
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.
-> For help how to insert, edit, link references please find more information in the help section "Set References".
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.