Wiki Style Guide

Please follow this style guide when adding to, rearranging, copy editing, or otherwise modifying the wiki.  For general information on how the wiki is structured and how to edit it, see the page on how to edit the wiki.Please follow this style guide when adding to, rearranging, copy editing, or otherwise modifying the wiki.  For general information on how the wiki is structured and how to edit it, see the page on how to edit the wiki.

Outline

  • Expectation
  • Pages
    • Titles
    • URLs/permalinks
    • Headings
    • Images
  • Menus

Expectation

Each software ninja is responsible for maintaining a clean, up-to-date course on the wiki.  The course includes the description, essentials day lessons, additional lessons (formerly advanced lessons), a competency project, and additional resources.  Add and maintain these pages as applicable.  The bare minimum a course must have is at least one essentials day lesson and a competency project.
In order to preserve unity throughout the wiki, the guidelines presented in this style guide should be adhered to.  If you think changes should be made, discuss them in team meeting and make the change only after an agreement has been reached and all team members have been notified.

Pages

Only pages should be used to present content on this wiki (not posts).

Titles

The title of each page appears at the top of the page and in automatically generated links to the page found in menus and course navigations.  In general, keep titles descriptive and accurate but short.  Preferably links should not take up more than one line on a menu or course navigation.  Only the essentials course has numbered days.  The first word after the colon starts with a capital letter; the rest are all lowercase.  The following are specific guidelines on how to title pages in each category (examples in italic):

  • Essentials day lesson: [course name] Day [number]: [short description] Photoshop Day 1: Image types, navigation, layers, adjustments
  • Additional lesson: [course name]: [short description] Photoshop: Art creations
  • Competency Project: [course name] [type of competency] Competency Photoshop Essentials Competency
  • Resource: [course name]: [resource description] Photoshop: Shortcuts

Permalinks

Permalinks make up the URL you see in the address bar at the top of the page.  Everything after /wiki/ in the URL is editable from within the page as follows (examples in italic):

  • Class/course: /[course name]/ /photoshop/
  • Essentials day lesson: /day-[day of the class]/ /day-1/
  • Additional lesson: /[short-description]/ /art-creations/
  • Competency Project: /[type-of-competency]-competency/ /essentials-competency/
  • Resource: /[description of resource]/ /shortcuts/

Be sure to manually edit the permalink for each page you create or maintain.  The automatically generated permalink will not match this scheme.

Headings

The wiki uses three levels if headings to organize content.  There are more headings available in WordPress, but they are not used on this site.

  • Heading 1: This heading size is used by default for page titles, but should not be used on pages other than those using the Info Pages template.
  • Heading 2: This heading is used for major topics in a lesson plan, competency, or resource page.  No page should have more than eight of this size heading.
  • Heading 3: This heading is used for subtopics in lesson plans, competencies, and resource pages.

If additional emphasis is needed, use the bold face style rather than Heading 4 as in the list above.  The differences between Heading 3 and smaller headings are generally too negligible for use on this site.

Images

You can add images to pages on the wiki to improve the quality of lesson plans.

Menus

To edit the menus, go to Appearance –> Menus. To add a new menu, you can create one in Appearance –> Menus, and add it to the side of the website by going to Appearance –> Widgets.