OSP Wiki:General guidelines
From OSP Wiki
Contents |
The guidelines are still under discussion, please use the talk page to submit suggestions and comments.
The purpose of this guidelines is to create a common ground for contributors, in order to achieve a consistent look and feel throughout the wiki, not only in the way that pages are presented, but also in the way information is organized.
Namespaces
Namespaces are a way of organizing content on a Wiki, by "isolating" information that is useful for maintaining the project from the project's "public" information.
The OSPhoto wiki makes use of several namespaces:
- Main
- This is where all the content pages about Open Source Photography are stored. The Main namespace is the default, so it' doesn't use a namespace prefix. Articles in the main namespace are linked by using something like:
[[Main Page]].
- Talk
- Each article in the Main namespace has a corresponding page in the Talk namespace where readers can add comments about the article.
- Help
- The Help namespace is for pages with documentation about editing pages and wiki syntax and conventions. To refer an help page you use something like:
[[help:how to edit a page]].
- OSP_Wiki
- The OSP_Wiki namespace is for pages about the project itself, such as this page. You can link to it by using
[[OSP_Wiki:namespaces]]or by using the "project" prefix ([[project:namespaces]]).
- User
- Each registered user is assigned a page in the User namespace. This page can (and should) be used a a homepage for contributors to publicize information about their background reggarding to Open Source and Photography.
- User_talk
- Each user also has a Talk page that can be used to comunicate with others. Whenever someone edits the user's Talk page, the next time reloads a page he is informed that a new "message" is waiting.
Categories
Categories are the main tool for organizing pages. Each article needs to be in at least one category, although often it should be in several (see the sample category tree below).
Using categories
You assign a category to an article by adding the code [[category:Category name]] to the article. Although the category attribution can be anywhere in the text, it's standard to include at the bottom of the page.
If you need to reference a category in the middle of the text but you don't want to assign it to article, you need to prefix it with a column: [[:category:Category name]].
Category tree
This list is not all inclusive and is meant just as a guide to category creation.
Templates
Naming conventions
Page names are case sensitive, meaning that [[Gimp]] will link to a different page from [[GIMP]]. There are several exceptions to this rule:
- The first character on the page name is always converted to uppercase.
[[split toning]]is the same as[[Split toning]] - Namespaces are case insensitive.
[[OSP_Wiki:About]]is the same as[[osp_wiki:about]]
Another thing to have in mind is that, in page names and wikilinks, the space character equivalent to the underscore character. This means [[OSP_Wiki:General guidelines]] can also be written as [[osp wiki:general guidelines]].
Now that parsing rules are understood, we can setup some guidelines for naming pages on the OSPhoto wiki. This guidelines are based on the ones used on the Wikipedia, the major project using MediaWiki.
- Always use lowercase for page names (eg: "tone mapping" and not "Tone Mapping") so it's easier to write links inline with other text.
- When using program names in page names, use the official way to spell it (eg: "GIMP" and not "Gimp"). When in doubt, a quick check to the project page should help.
