QESTonline:Guidelines - Revision history

David.murphy: Updated namespaces

2012-01-25T04:56:15Z

Updated namespaces

←Older revision		Revision as of 04:56, 25 January 2012
Line 73:		Line 73:
	* Are invisible to the user (except for in the title)		* Are invisible to the user (except for in the title)
	* ALL articles appear in ONE namespace.		* ALL articles appear in ONE namespace.
	* Used to provide access control to articles (QESTLab, QESTMix and Support are the only namespaces available to external users).		* Used to provide access control to articles (Main, QESTLab, QESTMix, Boral RnD, QESTAnalysis and Support are the only namespaces available to external users).
	* Must see me if you need a new namespace to be created. Simply inventing a new one will not create a new namespace. The article will appear in the main namespace e.g., creating an article 'Crows:Are_Stupid' will create an article in the main namespace.		* Must see me if you need a new namespace to be created. Simply inventing a new one will not create a new namespace. The article will appear in the main namespace e.g., creating an article 'Crows:Are_Stupid' will create an article in the main namespace.
	* The ~~important~~ namespaces are:		* The namespaces are:
	**(Main)		**(Main)
	**Administration		**Administration
	**~~Implementation~~		**Boral RnD
	**Implementation Internal
	**QESTLab
	**QESTLab Internal
	**QESTMix
	**QESTMix Internal
	**Support
	**Support Internal
	**Systems Admin
	**Development		**Development
			**Implementation
			**Implementation Internal
			**QESTAnalysis
			**QESTDesign
			**QESTLab
			**QESTLab Internal
			**QESTMix
			**QESTMix Internal
			**Sales And Marketing
			**Support
			**Support Internal
			**Systems Admin
			Each namespace also has its own Talk namespace, but these are not used.


	==Categories==		==Categories==

Michael.howland at 21:56, 2 October 2007

2007-10-02T21:56:04Z

←Older revision		Revision as of 21:56, 2 October 2007
Line 1:		Line 1:
			==General==
			# After creating/editing a page, proof-read and spellcheck the page. This is '''not''' optional.
			# If the page is for external viewing, it is advisable to have another Spectra QEST employee give the page a thorough review.
			# If the page is for external viewing (especially any work to the user guide), please remember that most customers are not computer proficient. Pictures are highly encouraged; missing instructions (no matter how obvious the instruction appears to you) is not.

	==Page Header and Footer==		==Page Header and Footer==
	Where the page is a part of a guide, or a set of pages, "Navigation" links should be provided at the top and bottom of the page. These should be labelled "Prev" and "Next". There should also be a link back to the main page that it is accessed from (usually the user guide main page - add an anchor where possible using a #). These links should be separated by a pair of pipes '\|\|'		Where the page is a part of a guide, or a set of pages, "Navigation" links should be provided at the top and bottom of the page. These should be labelled "Prev" and "Next". There should also be a link back to the main page that it is accessed from (usually the user guide main page - add an anchor where possible using a #). These links should be separated by a pair of pipes '\|\|'
Line 16:		Line 21:
	[[Category:Help\|{{PAGENAME}}]]</pre>		[[Category:Help\|{{PAGENAME}}]]</pre>

			If a printable version of the page is to be created, use the format described below ([[QESTonline:Guidelines#<nowiki><noinclude> </noinclude></nowiki>]])

	==Tables==		==Tables==

Michael.howland at 19:20, 2 October 2007

2007-10-02T19:20:11Z

@@ Line 90: / Line 90: @@
 * Categories can have sub-categories.
 * A new category can be created by using the <nowiki>[[Category:Category_name]]</nowiki> tag. Please check that a suitable category does not already exist before creating a new category.
 Please note: When a new category is created, a new link will appear allowing users to browse that category. This page will not contain any information and so will open in 'edit' mode when the link is clicked. External users do not have edit rights and will therefore not be allowed to view this page. To avoid this, when creating a new category:
 Go to the category page and save the page with some text (saving an unchanged page will not work)
@@ Line 96: / Line 96: @@
 Check that the category page now opens in 'article' mode i.e., not edit mode.
 ==Other stuff==
 * When referring to a specific object, add a link.  e.g. [[QESTMix:System Administrator|system administrator]] - even if that page just has a couple of lines, and directs the user to a different page in the wiki.
 * Include the name of the website in brackets after external links. <br> E.g. See the [http://meta.wikimedia.org/wiki/Help:Help help page] (WikiMedia) for editing information.
 [[Category:QESTonline|{{PAGENAME}}]]
 [[Category:Guidelines|{{PAGENAME}}]]

David.murphy: Edited category

2007-07-26T01:34:53Z

Edited category

←Older revision		Revision as of 01:34, 26 July 2007
Line 101:		Line 101:
	* Include the name of the website in brackets after external links. <br> E.g. See the [http://meta.wikimedia.org/wiki/Help:Help help page] (WikiMedia) for editing information.		* Include the name of the website in brackets after external links. <br> E.g. See the [http://meta.wikimedia.org/wiki/Help:Help help page] (WikiMedia) for editing information.

	[[Category:~~QESTOnline~~\|{{PAGENAME}}]]		[[Category:QESTonline\|{{PAGENAME}}]]
	[[Category:Guidelines\|{{PAGENAME}}]]		[[Category:Guidelines\|{{PAGENAME}}]]

David.murphy: Corrected unintentional categorisation, used nowiki tags for formatting

2007-07-26T01:06:32Z

Corrected unintentional categorisation, used nowiki tags for formatting

←Older revision		Revision as of 01:06, 26 July 2007
Line 89:		Line 89:
	* Add an article to a category by adding <nowiki>[[Category:Category_name]]</nowiki> to the end of the article e.g., <nowiki>[[Category:QESTLab]]</nowiki> will add the article to the QESTLab category.		* Add an article to a category by adding <nowiki>[[Category:Category_name]]</nowiki> to the end of the article e.g., <nowiki>[[Category:QESTLab]]</nowiki> will add the article to the QESTLab category.
	* Categories can have sub-categories.		* Categories can have sub-categories.
	* A new category can be created by using the [[Category:Category_name]] tag. Please check that a suitable category does not already exist before creating a new category.		* A new category can be created by using the <nowiki>[[Category:Category_name]]</nowiki> tag. Please check that a suitable category does not already exist before creating a new category.

	Please note: When a new category is created, a new link will appear allowing users to browse that category. This page will not contain any information and so will open in 'edit' mode when the link is clicked. External users do not have edit rights and will therefore not be allowed to view this page. To avoid this, when creating a new category:		Please note: When a new category is created, a new link will appear allowing users to browse that category. This page will not contain any information and so will open in 'edit' mode when the link is clicked. External users do not have edit rights and will therefore not be allowed to view this page. To avoid this, when creating a new category:

David.murphy: Categorised

2007-07-20T07:30:42Z

Categorised

←Older revision		Revision as of 07:30, 20 July 2007
Line 87:		Line 87:
	* Are visible to the user - click on the categories link in the navigation box to be taken to a list of categories.		* Are visible to the user - click on the categories link in the navigation box to be taken to a list of categories.
	* An article may appear none, one or many categories(It should appear in at least one)		* An article may appear none, one or many categories(It should appear in at least one)
	* Add an article to a category by adding [[Category:Category_name]] to the end of the article e.g., [[Category:QESTLab]] will add the article to the QESTLab category.		* Add an article to a category by adding <nowiki>[[Category:Category_name]]</nowiki> to the end of the article e.g., <nowiki>[[Category:QESTLab]]</nowiki> will add the article to the QESTLab category.
	* Categories can have sub-categories.		* Categories can have sub-categories.
	* A new category can be created by using the [[Category:Category_name]] tag. Please check that a suitable category does not already exist before creating a new category.		* A new category can be created by using the [[Category:Category_name]] tag. Please check that a suitable category does not already exist before creating a new category.
Line 100:		Line 100:
	* When referring to a specific object, add a link. e.g. [[QESTMix:System Administrator\|system administrator]] - even if that page just has a couple of lines, and directs the user to a different page in the wiki.		* When referring to a specific object, add a link. e.g. [[QESTMix:System Administrator\|system administrator]] - even if that page just has a couple of lines, and directs the user to a different page in the wiki.
	* Include the name of the website in brackets after external links. <br> E.g. See the [http://meta.wikimedia.org/wiki/Help:Help help page] (WikiMedia) for editing information.		* Include the name of the website in brackets after external links. <br> E.g. See the [http://meta.wikimedia.org/wiki/Help:Help help page] (WikiMedia) for editing information.

			[[Category:QESTOnline\|{{PAGENAME}}]]
			[[Category:Guidelines\|{{PAGENAME}}]]

Michael.howland at 00:25, 22 May 2006

2006-05-22T00:25:19Z

←Older revision		Revision as of 00:25, 22 May 2006
Line 86:		Line 86:
	* Used to separate articles into logical groups.		* Used to separate articles into logical groups.
	* Are visible to the user - click on the categories link in the navigation box to be taken to a list of categories.		* Are visible to the user - click on the categories link in the navigation box to be taken to a list of categories.
	* An article may appear none, one or many ~~namepaces~~ (It ~~shoudl~~ appear in at least one)		* An article may appear none, one or many categories(It should appear in at least one)
	* Add an article to a category by adding [[Category:Category_name]] to the end of the article e.g., [[Category:QESTLab]] will add the article to the QESTLab category.		* Add an article to a category by adding [[Category:Category_name]] to the end of the article e.g., [[Category:QESTLab]] will add the article to the QESTLab category.
	* Categories can have sub-categories.		* Categories can have sub-categories.

Michael.howland at 00:17, 22 May 2006

2006-05-22T00:17:57Z

←Older revision		Revision as of 00:17, 22 May 2006
Line 62:		Line 62:
	<pre>[[Image:Guidelines Example.png\|frame\|center]]		<pre>[[Image:Guidelines Example.png\|frame\|center]]
	[[Image:Guidelines Example.png\|frame]]</pre>		[[Image:Guidelines Example.png\|frame]]</pre>

			==Namespaces==
			* Appear in the article title before the colon e.g., the page QESTLab:User_Guide is in the QESTlab namespace.
			* Are invisible to the user (except for in the title)
			* ALL articles appear in ONE namespace.
			* Used to provide access control to articles (QESTLab, QESTMix and Support are the only namespaces available to external users).
			* Must see me if you need a new namespace to be created. Simply inventing a new one will not create a new namespace. The article will appear in the main namespace e.g., creating an article 'Crows:Are_Stupid' will create an article in the main namespace.
			* The important namespaces are:
			**(Main)
			**Administration
			**Implementation
			**Implementation Internal
			**QESTLab
			**QESTLab Internal
			**QESTMix
			**QESTMix Internal
			**Support
			**Support Internal
			**Systems Admin
			**Development

			==Categories==
			* Used to separate articles into logical groups.
			* Are visible to the user - click on the categories link in the navigation box to be taken to a list of categories.
			* An article may appear none, one or many namepaces (It shoudl appear in at least one)
			* Add an article to a category by adding [[Category:Category_name]] to the end of the article e.g., [[Category:QESTLab]] will add the article to the QESTLab category.
			* Categories can have sub-categories.
			* A new category can be created by using the [[Category:Category_name]] tag. Please check that a suitable category does not already exist before creating a new category.

			Please note: When a new category is created, a new link will appear allowing users to browse that category. This page will not contain any information and so will open in 'edit' mode when the link is clicked. External users do not have edit rights and will therefore not be allowed to view this page. To avoid this, when creating a new category:
			Go to the category page and save the page with some text (saving an unchanged page will not work)
			Edit the page again but remove the newly added text. Save the page.
			Check that the category page now opens in 'article' mode i.e., not edit mode.

Michael.johnson at 07:48, 7 April 2006

2006-04-07T07:48:38Z

←Older revision		Revision as of 07:48, 7 April 2006
Line 33:		Line 33:

	==Naming Conventions==		==Naming Conventions==
	* Pages should generally be named using '''~~Title~~ case'''.		* Pages should generally be named using '''Sentence case'''.
	* The guidelines laid out in [http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions Naming conventions] (Wikipedia) are a good place to look if you are unsure.		* The guidelines laid out in [http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions Naming conventions] (Wikipedia) are a good place to look if you are unsure.

Line 43:		Line 43:
	Editing users</pre>		Editing users</pre>

	When adding a page, avoid replication. If you later find that there are two pages that are about the same thing, see if it makes sense to turn one of them into a ''redirect page''. Syntax for a redirect page is is:		When adding a page, avoid replication. If you later find that there are two pages that are about the same thing, see if it makes sense to turn one of them into a ''redirect page''. Syntax for a redirect page is:
	<pre>#redirect [[Redirect Target]]</pre>		<pre>#redirect [[Redirect Target]]</pre>
	You don't need any extra information on the redirect page. You can also use the ''What links here'' tool to find which pages link to the redirect page, and change them to link to the correct page instead.		You don't need any extra information on the redirect page. You can also use the ''What links here'' tool to find which pages link to the redirect page, and change them to link to the correct page instead.

Lief.martin: fixed table syntax

2006-04-05T01:33:36Z

fixed table syntax

←Older revision		Revision as of 01:33, 5 April 2006
Line 19:		Line 19:
	==Tables==		==Tables==
	Tables should be of the '''spectratable''' class. The class can be specified at the top of the table		Tables should be of the '''spectratable''' class. The class can be specified at the top of the table
	<pre>{\|class="spectratable"\|		<pre>{\| class="spectratable" \|
	\| Row 1, Column 1		! Header Row, Column 1
	\| Row 1, Column 2		! Header Row, Column 2
	\|-		\|-
	\| Row 2, Column 1		\| Content Row 1, Column 1
	\| Row 2, Column 2		\| Content Row 1, Column 2
			\|-
			\| Content Row 2, Column 1
			\| Content Row 2, Column 2
	\|}</pre>		\|}</pre>

			More information on the syntax for tables (in case you want to merge cells or do something else a little bit fancy) can be found at [http://en.wikipedia.org/wiki/Help:Table\|Help:Table] (Wikipedia).

	==Naming Conventions==		==Naming Conventions==