QESTonline:Guide to the User Guide

Purpose

This document outlines the procedures to be followed when adding pages to the QESTLab/QESTMix user guide or when creating any other user guide.

Scope

This document applies to all Spectra QEST personnel past, present, and future. Failure to adhere to the rules outlined in this document will cause the wrath of Michael Howland to be released on the offender. Michael is not a nice man.

Failure to read this document does not excuse you from Michael's wrath. You have been warned.

Prerequisites

• Ability to read and write English
• Knowledge of wiki syntax
• Read the editors guideline at QESTonline:Guidelines

Introduction

Writing/Editing pages for a user guide is slightly more difficult than writing stand-alone pages due to the extra editing that must be performed. To add a new page, edits will need to be made to:

• The online contents page e.g. QESTLab:User_Guide
• The pages preceeding and following the new page in order to adjust the links in the headers and footers
• The printable version of the user guide e.g. [1]

This document will look to introduce the basic concepts by of adding a new page to the QESTLab user guide.

Procedure

To add a newly created page to the QESTLab user guide:

1. Add a header and a footer to the new page. Link these to the pages preceding and following the new page.
2. Update the header and footer of the page preceeding the new page in the user guide.
3. Update the header and footer of the page following the new page in the user guide.
4. Add the new page to the user guide contents page.
5. Add the new page to the printable version of the user guide.
6. Check that no header and footer information appears in the printable version. If it does, add <noinclude> </noinclude> tags around the header and footer.
7. Check that the heading levels are correct in the printable version.