Website Guidelines
Contents |
The Wiki
The STK website is based on MediaWiki and as such is easily editable. You must register to edit pages, and most pages are protected (only editable by developers) to prevent spam, but to allow the help from people outside of the development team, several pages can be modified by any registered user. However, if you have been involved with STK (you are a known contributor), just ask for privileges and most likely you will get them!
Developers new at wiki editing should check how to use this wiki. Try the Sandbox if you want to practice or try something.
By the way... you can easily sign up WITHOUT e-mail or any personal information.
For more information go to How To Work On The STK Site.
Style Guide
Page content should be simple, with HTML used only where absolutely necessary (for example on the downloads page), and unless a page is special in some way, content should be laid out in a simple header-content fashion. It should also appear like the rest of the site. We want consistency.
Headings
Top-level headings should be level two:
== Heading ==
(Level 1 headings are used for the page title). Sub-headings go up a level:
== Heading ==
Content
=== Sub-heading ===
==== Sub-sub-heading ====
Content
Code Snippets
Code snippets can be put in <code> tags to mark them up as code:
Code snippet
Beware that whitespace inside <code> tags is preserved; any spaces or line returns inside the tag will be rendered. This means when you're pasting in lists of commands or lines of code, you don't need to put <br /> tags after each line.
The Skin
The STK skin has a helpful feature to enable tighter control over the styling of the site design: each page's <body> tag is given an id corresponding to the page's title (e.g. 'main_page') so that styles can be applied easily to individual pages. The id is the page's title in lowercase with spaces converted to underscores. For example, if you wanted all paragraphs on the 'Contact us' page to be 16ems wide:
#contact_us #content p { width: 16em; }
If you have any questions about the skin, you can ask Tom; just email the ML.
Grammar Checker
You may have noticed that spelling on this site occasionally goes haywire. Some of the grammar ain't to good neither. You can help by running over the already created pages and inserting periods, changing spellings and changing a to an. You can help without STK knowledge! Please use this page to keep track of pages checked.
Your Page
All the main contributors have User pages. These give a bit of information about oneself. To make your own user page, log in and look at the bottom of this page. There should be a section of links titled Me. These links contain "Log out", "My preferences" and "My page". Click "My page" then find a link titled "Edit". Click this and create your User Page.
Discussion Pages
All pages have separate pages leading off called Discussion Pages. The link can be found under this page. Discussion pages are used to discuss the page at hand and suggest updates/edits.
User Tools
- This page
- Other