Help:Contents
From TeamF::CGT
Contents |
[edit]
Guidelines for Using This Wiki
[edit]
Personal Configuration
- Turn on auto-number headings
- browse to Special:Preferences -> select "Misc" -> tick "Auto-number headings"
- Turn on table of contents
- browse to Special:Preferences -> select "Misc" -> tick "Show table of contents"
[edit]
Naming Conventions
- Capitalize all page/section/template/image/file names.
- Correct: "Risk Management Plan"
- Incorrect: "risk management plan"
- Only use spaces to separate words in page/section/template names.
- Correct: "Software Requirements Specification"
- Incorrect: "Software-Requirements-Specification"
- Avoid the definite article ("the") and the indefinite article ("a"/"an") at the beginning of a page/section/template name.
- Correct: "Project Lifecycle"
- Incorrect: "The Project Lifecycle"
- Start image names with a key word in capital letters, followed by a description phrase connected by '-'s. Use "TEAM" for general items.
- Correct: "SRS-high-level-functions.jpg" "TEAM-logo.png"
- Incorrect: "High-level-functions.jpg" "Srs-high-level-functions.jpg" "TEAM_logo.png" "teamlogo.png"
- A PDF document name will be the same with the document page name except spaces are substituted by underscores.
- Correct: "Software_Requirements_Specification.pdf"
- Incorrect: "Software Requirements Specification.pdf"
- Be careful with special characters. Do NOT use these characters in a name: # + < > [ ] | { } / ?
- Correct: "C Sharp Language"
- Incorrect: "C# Language" "Mission Complete?"
[edit]
Table Style
A table style class called "wikitable" is to be used throughout this wiki, unless under special circumstances. A template for the table style is:
{| class="wikitable"
|+ '''Table title'''
|-
! Primary colume title
! Colume one title
! Colume two title
|-
! Item one ID
| Item one colume one
| Item one colume two
|-
! Item two ID
| Item two colume one
| Item two colume two
|-
|}
which produces something like:
| Primary colume title | Colume one title | Colume two title |
|---|---|---|
| Item one ID | Item one colume one | Item one colume two |
| Item two ID | Item two colume one | Item two colume two |
[edit]
Image Style
The generic image syntax is:
[[Image:{name}|{type}|{location}|{size}|{caption}]]
[edit]
Ordinary-Sized Image
An ordinary-sized image should be placed inside a frame with no replacement or resizing. A template for this image style is:
[[Image:TEAM-logo.jpg|frame|none|Team Logo]]
which produces something like:
Team Logo
[edit]
Overlarge-Sized Image
An overlarge-sized image can be placed as a thumbnail with resizing but no replacement. A template for this image style is:
[[Image:TEAM-logo.jpg|thumb|none|100px|Team Logo]]
which produces something like:
[edit]
Editing Issues
- Whenever you change a page/section/template/image/file name, make sure you search the current page as well as the whole wiki for possible in-links to this name. Update the link location and label of each of those in-links correspondingly. Use the search panel and "What links here" link in the sidebar to aid your search.
- Do NOT use more than 4 levels of sub-sections, i.e., "=====" should be the smallest level. Use lists and tables instead.
- Avoid using HTML markup whenever possible and only use wikitext. For example, use double newspaces instead of <br>, and use ''' ''' instead of <b></b>.
- Prefer double quotes (") over single quotes (') in your text whenever possible, because single quotes may accidentally mess up with bold text (''') and italic text ('') markup.
[edit]
Versioning Issues
Tagging can be done in wiki, through linking to a particular version of a document listed in its "Page history". An example would be:
[http://www.eirikr.net/projects/cgt/wiki/index.php?title=Software_Architectural_Design_Description&oldid=1634 Software Architectural Design Description DRAFT]
which produces something like:
[edit]
MediaWiki Handbooks
[edit]