Header Style Guide

From Common Energy UVic

The Header Style Guide is a style guide for the Common Energy wiki. Please adhere to this guide whenever editing or creating page content.

[edit] Discussion

Headers are very important to place pages in context in the wiki. They are key for linking pages together, because the wiki environment has the potential to become chaotic, with dozens of users editing and creating numerous pages at any given time. A header comes at the beginning of a page, without a heading and before the table of contents (don't worry about this - Mediawiki automatically takes care of the table of contents), while categories come at the end of a page to orient users. An additional purpose of headers is to provide a summary of long or discussion-intensive pages.

[edit] Paragraph One

The first paragraph should serve to place the page within the wiki. It begins with a sentence in the active voice, in which the name of the page appears as a link in the first two or three words. Linking a page to itself will bold the link (for example, the words "Header Style Guide" in the header of this page are coded as "[[Header Style Guide]]". Next, try to mention other pages in whose category the page fits. For example, the header for a page about a project on which the food group is working should link to both the Food Working Group and the Projects pages.

[edit] Subsequent Paragraphs

All paragraphs after the first should summarize information contained in the page. This will not always be necessary, but is very important for knowledge base pages.

Whos here now:   Members 0   Guests 0   Bots & Crawlers 1