This is the style guide for the Myplace Support site.
Content
The Myplace Suport site offers a number of different styles of page:
Instructional / How to guidance
Technical / Reference guidances
Index
Conventions
Bold | is used to indicate elements that should appear on the screen, be readily identifiable or are emphasised. |
Italic | is used to indicate values, arguments or other user supplied values that should be entered. |
Constant Width | is used to show output from commands or contents of files. |
Organisation
The Myplace support site is split in to two broad areas:
- Staff Support
- Student Support
A number of smaller ancillary areas for specific staff audiences also exist:
- Learning Technologists
- Library Staff
Support Page Layout
- All pages should use the Excerpt macro to designate a short piece of text that will be extracted and potentially presented elsewhere. This should give a clear indication as to what the page will cover. This also prevents inappropriate content to be presented in these contexts.
- All pages should use a Table of Contents macro after the Excerpt. If there is only 1 section of content that matches the title of the page the table of contents can be omitted.
- Where steps are sequential each step should be numbered, rather than bulleted. This allows each step to be individually referenced in previous or following steps.
- Where the instructions are alternatives they should be bulleted.
If you wish to include rich content in the numbered item you should combine the list with a Section macro:
Heading levels should be used appropriate.
- The Top level of headings should be Heading 1.
- Each further sub-heading should increase the heading level.
Page Layout should be used to chunk pages up: