Difference between revisions of "Help:Structuring a page's content"

From Power Shifts wiki
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Always a few lines at the very top explaining what the page is about including the article headline in the beginning of the text
+
If you have a clear outlook of what you want to write about, it is important to find out whether a related article already exists and/or if the information is already included in an existing article. You can use the search function to find out. If you find an existing article, consider updating it with your information rather than creating new pages.
Avoid structural headings (“Introduction”)
 
  
 +
List of all existing content pages: [[Special:AllPages]].
  
If the chair has a clear outlook of what to add the second step is to find out whether an article already exists or if the information is included in an existing article as a sub point. Please use the search function on the wiki to find out. If you find an existing article do update it with your information rather than creating new pages.
+
== Writing the introduction ==
 +
Every article starts with the full name of the page in bold, as the subject of the first sentence. It can be followed by the acronym or abbreviation in bold inside parentheses (with the parentheses not in bold).  
 +
For example, an article titled ''Peanut butter and jelly sandwich'' should start with a sentence similar to the following:
 +
<code>A '''Peanut butter and jelly sandwich''' ('''PB&J''') is a snack that includes [...]</code>.
  
Every article starts with the full name of the page in bold (internal links to the same page also makes it bold) followed by the initials/abbreviation in bold too, inside parenthesis
+
The introduction should always be a few lines explaining what the page is about.
 +
 
 +
== Using headings ==
 +
For longer articles, it makes sense to organise content in different-level headings. By default, a '''table of contents''' (sometimes abbreviated to TOC) is automatically generated on a page when more than three section headings are used.
 +
*If you don't wish a TOC to appear, using <code><nowiki>__NOTOC__</nowiki></code> on the top of your page hides the table of contents.
 +
*You should always avoid structural headings (e.g. Introduction).
 +
*In case your order of headings does not follow a chronological order of events described, you probably need to restructure the article.
 +
 
 +
== Adding the list of references and links ==
 +
At the end of your article, add <code><nowiki>{{Reference}}</nowiki></code> to get all references included in the text displayed, as well as a list of articles that link to yours. You can learn more about citations and references at [[Help:References]].
  
Add the code {{Reference}} in the end to get all references included in the text
 
In case your order of headings does not follow a chronological order of events described, you probably need to restructure the article.
 
  
 
[[Category:Help]]
 
[[Category:Help]]

Latest revision as of 12:17, 15 May 2017

If you have a clear outlook of what you want to write about, it is important to find out whether a related article already exists and/or if the information is already included in an existing article. You can use the search function to find out. If you find an existing article, consider updating it with your information rather than creating new pages.

List of all existing content pages: Special:AllPages.

Writing the introduction

Every article starts with the full name of the page in bold, as the subject of the first sentence. It can be followed by the acronym or abbreviation in bold inside parentheses (with the parentheses not in bold). For example, an article titled Peanut butter and jelly sandwich should start with a sentence similar to the following: A Peanut butter and jelly sandwich (PB&J) is a snack that includes [...].

The introduction should always be a few lines explaining what the page is about.

Using headings

For longer articles, it makes sense to organise content in different-level headings. By default, a table of contents (sometimes abbreviated to TOC) is automatically generated on a page when more than three section headings are used.

  • If you don't wish a TOC to appear, using __NOTOC__ on the top of your page hides the table of contents.
  • You should always avoid structural headings (e.g. Introduction).
  • In case your order of headings does not follow a chronological order of events described, you probably need to restructure the article.

Adding the list of references and links

At the end of your article, add {{Reference}} to get all references included in the text displayed, as well as a list of articles that link to yours. You can learn more about citations and references at Help:References.