Style Guide

This is a draft only!
It is still under construction and content may change. Do not rely on this information.

This page documents the standard style preferred for various types of pages on this wiki.

Style Guide for Course Web Pages

Naming Conventions

Course web pages much be named according to this scheme:

Pages Containing General Content

Wherever possible, pages should be written in such a way that the content is reusable in other courses and linked from other content pages.

Page name template: Content

Where:

• Content is a descriptive content title for the page. It should be as general as possible. If it applies to only one open source project or platform, that project or platform should appear in the title, but where appropriate, the page title should be made generic ("Logical Volume Management" instead of "Logical Volume Management on Fedora", or "Building Firefox" instead of "Building Firefox on Windows"), even if content for other projects/platforms is added in the future.

Examples: IPTables, Logical Volume Management, Irc, Blog Guidelines

Main Page for a Course

Page name template: CourseCode

Where:

• CourseCode is the 6-character Seneca course code

Example: OPS235

Pages Specific to a Particular Course

This applies to pages that are specific to a particular course and which cannot be reused for another course or general content (for example, labs and course policies).

Page name template: CourseCode Content

Where:

• CourseCode is the 6-character Seneca course code
• Content is a descriptive content title for the page. It should be as general as possible.

Example: OPS235 Lab 1

Pages Specific to a Particular Semester of a Course

This applies to pages that are tied to a specific semester offering of a course, and which cannot be reused for another semester of that course (for example, weekly schedules).

Page name template: Semester Year CourseCode Title

Where:

• Semester is Winter, Summer, or Fall
• Year is a 4-digit year
• CourseCode is the 6-character Seneca course code
• Content is a descriptive content title for the page. It should be as general as possible.

Example: Winter 2011 OPS235 Weekly Schedule

Categories

Each course must have:

• A Course Category for all of the pages related to that course (including general content pages), named using the 6-character Seneca course code.
  • Example: Category:SBR600
• A Course Offering category for each semester in which the course is offered, named Semester Year CourseCode. This category must belong to the Course Category.
  • Example: Category:Winter 2011 SBR600

Choose one!
Pages must not belong to both the Course Category and the Course Offering Category. Generally, pages containing the semester and year belong in the Course Offering category, and other course pages belong in the Course Category. General content pages (those not containing a course code in the title) must not appear in the Course Offering category.

Page Content

Headings

Pages should contain appropriate headings. If three or more headings appear in a document, a table of contents will be generated directly above the first heading.

Headings should follow the MediaWiki User Guide Headings recommendations, with the exception that they should start at level 1.

Commands and Code

Generic mentions of commands should be italicized (e.g., bash).

Examples of single command lines should be monospaced with <code> tags, with subsitutable text italicized: dd if=inputfile of=outputfile bs=1M

Multi-line examples should be indented (which will cause them to be monospaced):

 <os>
   <type arch='arm' machine='versatileab'>hvm</type>
   <kernel>/var/lib/libvirt/images/zImage-versatile-2.6.37.3.armv5tel</kernel>
   <cmdline>"root=0800"</cmdline>
   <boot dev='hd'/>
 </os>