Help:Beginner's guide

From AVENwiki
Revision as of 01:56, 31 December 2007 by Jaybird721 (talk | contribs) (Style Guide)
Jump to: navigation, search

First things first

If you aren't familiar with mediawiki syntax, check out this [tutorial] from Wikieducator. This covers basic wiki commands and style.

You should also create your user profile, making sure to add [[Category:User]] at the bottom. Generally, every time you make a new page, you should categorize it. A list of existing categories can be found [here], but don't be afraid to create your own if you feel the need.

You may also want to create a subpage of your user page just for experimenting and playing with syntax, so that you can try out new things without affecting pages in the wiki. For example, you can create a Sandbox subpage of your user page by putting [[User:USERNAME/Sandbox]] in your profile.

Templates and userboxes

You can copy/paste templates into new pages to save yourself some work.

These are currently under construction, so check back here in the future to find them.

Style Guide

In order for our wiki to be coherent and readable, everyone should follow a basic set of stylistic conventions.

Naming pages

  • check for alternative capitalizations; it would be awfully confusing to have a page named "Project Team" and another page named "Project team"
  • avoid capitalizing titles, unless there are proper nouns (for example, "Beginner's guide", not "Beginner's Guide")

Subpages

Subpage creation should be carefully considered and general avoided. Good uses of subpages include:

  • user subpages - it's fine to make [[User:USERNAME/Sandbox]] or [[User:USERNAME/Brainstorming]]
  • archive pages of a general page - for example, [[Boston meetups]] could give general information for planning the latest meet, and [[Boston meetups/Jan 12 2007]] could give information about a specific past meetup

Looking to the future

You should start a page with the most generalized name possible. For example, start by making [[Boston meetups]] and not [[Boston meetups 2008]].

Links

  • when linking within the wiki, use spaces instead of underscores, even if they go to the same place - i.e. [[Boston meetups]] instead of [[Boston_meetups]]
  • avoid running together words in CamelCase unless you are referring to a proper noun (like MediaWiki); this allows for easier reading and comprehension

Headers

DO NOT use H1 headers (single =) within a page; start with H2 headers. H1 headers indicate the title of a page, so using them within a page should signify inclusion of an entire new page.

General writing

  • write clearly
  • try to avoid words with unclear or multiple meanings
  • avoid making pages dependent on one another; this makes reading and editing unnecessarily difficult
  • categorize pages!

Color

In general, avoid using colored text. To emphasize text, use '' or '''