QESTonline:Guide to the User Guide - Revision history

Michael.howland at 16:48, 3 October 2007

2007-10-03T16:48:09Z

←Older revision		Revision as of 16:48, 3 October 2007
Line 31:		Line 31:
	# Update the header and footer of the page following the new page in the user guide.		# Update the header and footer of the page following the new page in the user guide.
	#Add the new page to the user guide contents page.		#Add the new page to the user guide contents page.
	#Add the new page to the printable version of the user guide. The printable version is a separate page that imports other pages. Access it via the links in the user guide.		#Add the new page to the printable version of the user guide. The printable version is a separate page that imports other pages. Access it via the links in the user guide. To edit the page, remove the '&printable=yes' from the url and load the page.
	#Check that no header and footer information appears in the printable version. If it does, add <nowiki> <noinclude> </noinclude> </nowiki> tags around the header and footer.		#Check that no header and footer information appears in the printable version. If it does, add <nowiki> <noinclude> </noinclude> </nowiki> tags around the header and footer.
	#Check that the heading levels are correct in the printable version.		#Check that the heading levels are correct in the printable version.

Michael.howland: QESTLab:Guide to the User Guide moved to QESTonline:Guide to the User Guide

2007-10-03T16:03:15Z

QESTLab:Guide to the User Guide moved to QESTonline:Guide to the User Guide

←Older revision	Revision as of 16:03, 3 October 2007
(No difference)

Michael.howland at 22:09, 2 October 2007

2007-10-02T22:09:23Z

←Older revision		Revision as of 22:09, 2 October 2007
Line 20:		Line 20:
	*The online contents page e.g. [[QESTLab:User_Guide]]		*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 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. [http://online.spectraqest.com/index.php?title=QESTLab:User_guide_module_1_-_system_administration&printable=yes]		*The printable version of the user guide e.g. [http://online.spectraqest.com/index.php?title=QESTLab:User_guide_module_1_-_system_administration&printable=yes Printable version of QESTLab user guide]

	This document will look to introduce the basic concepts by of adding a new page to the QESTLab user guide.		This document will look to introduce the basic concepts by of adding a new page to the QESTLab user guide.
Line 31:		Line 31:
	# Update the header and footer of the page following the new page in the user guide.		# Update the header and footer of the page following the new page in the user guide.
	#Add the new page to the user guide contents page.		#Add the new page to the user guide contents page.
	#Add the new page to the printable version of the user guide.		#Add the new page to the printable version of the user guide. The printable version is a separate page that imports other pages. Access it via the links in the user guide.
	#Check that no header and footer information appears in the printable version. If it does, add <nowiki> <noinclude> </noinclude> </nowiki> tags around the header and footer.		#Check that no header and footer information appears in the printable version. If it does, add <nowiki> <noinclude> </noinclude> </nowiki> tags around the header and footer.
	#Check that the heading levels are correct in the printable version.		#Check that the heading levels are correct in the printable version.

Michael.howland at 20:26, 2 October 2007

2007-10-02T20:26:57Z

←Older revision		Revision as of 20:26, 2 October 2007
Line 20:		Line 20:
	*The online contents page e.g. [[QESTLab:User_Guide]]		*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 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. [[QESTLab:User_guide_module_1_-_system_administration&printable=yes]]		*The printable version of the user guide e.g. [http://online.spectraqest.com/index.php?title=QESTLab:User_guide_module_1_-_system_administration&printable=yes]

	This document will look to introduce the basic concepts by adding a new page to the QESTLab user guide.		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:
			# Add a header and a footer to the new page. Link these to the pages preceding and following the new page.
			# Update the header and footer of the page preceeding the new page in the user guide.
			# Update the header and footer of the page following the new page in the user guide.
			#Add the new page to the user guide contents page.
			#Add the new page to the printable version of the user guide.
			#Check that no header and footer information appears in the printable version. If it does, add <nowiki> <noinclude> </noinclude> </nowiki> tags around the header and footer.
			#Check that the heading levels are correct in the printable version.

Michael.howland at 19:42, 2 October 2007

2007-10-02T19:42:29Z

New page

== 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. [[QESTLab:User_guide_module_1_-_system_administration&printable=yes]]

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