Not logged in - Log In / Register

This page tells you the conventions we use in maintaining this wiki. Please ask for help if you have any questions.

Most of the conventions in this wiki are self-explanatory. If you see something wrong, please just fix it (or if you're not sure, ask for help and then fix it).

There is a PageTemplate that can help you when creating new files.

Summary Bar

Most pages have a horizontal, black-background summary bar near the top, stating briefly what that page will tell the user. This is so readers can know quickly whether or not they've landed in the right place. (See Getting or Running, for example). A summary bar looks like this:

This page tells you how to frobnicate Launchpad's flux capacitors. Ask for help right away if you have any questions.

When appropriate, the summary bar can end with a sentence encouraging the reader to ask for help if needed. This won't be right for every summary bar; just use your judgement. If the page is about performing some complex task, such as Getting or Running, then it's more important to offer help than it would be for a merely informational page.

Please put a summary bar on any new pages you start. If you see existing pages that don't have the bar, fix them. (You can just copy-and-paste from one of the pages that does have it.)

Distinguish Between Explanatory Pages and Reference Pages

When a page explains a topic from the top down, don't try to pack too much information onto that page; instead, split material out to sub-pages as necessary. But when a page is a reference page, it's okay to make it big, because the expectation is that the reader will search within the page rather than browse it from the beginning.

Use Categories

Categories are a way of unifying themes that might be scattered around various pages. For example, see the Tips and Tricks category. To create a new CategoryFoo, just make a new page called CategoryFoo, based on the CategoryTemplate. Put other pages into that category by adding this at the bottom of each page:


See also Gavin Panella's mail about categories.

WikiConventions (last edited 2010-04-27 00:15:29 by adiroiban)