Wikihelp: Difference between revisions

Latest revision as of 15:11, 17 July 2015

Sidebar

The sidebar is displayed on the left edge of the page below the site logo (if using the MonoBook or Vector skin). This sidebar gives you access to important pages in the wiki such as Recent Changes or Upload File.

Navigation

Clicking on the logo brings you back to the main page of the wiki. The links in the navigation section just below will take you to important pages of the wiki. These links can be configured by site administrators.

Tools

Contains a selection of links which change depending on what type of page you are viewing.

On all pages (except special pages)

"What links here" takes you to a special page that lists the pages on this wiki which contain a link to the current page. This is helpful when you are looking for pages of related information. The "What links here" information can also be useful when you are re-factoring wiki pages and need to check whether links to this page are still relevant after changes in the current page.

The "Related changes" tool lists all recent changes in the pages linked to from the current page. Recent changes to all relevant template pages are included in the resulting page list.

On all pages (including special pages)

"Upload" displays a special page that allows logged-in users to upload images and other files to the wiki. Uploaded files can be linked from or embedded in wiki pages. This link is not displayed if file uploading is not enabled.

"Special pages" presents information about the Wiki and/or allows access to administration activities for the wiki. For example, a list of users registered with the wiki, statistics about the wiki such as the number of pages and number of page edits, system logs, a list of orphaned pages, and so on. These special pages are commonly generated when the special page is loaded rather than being stored in the wiki database.

Page Tabs

The page tabs are displayed at the top of the page to the right of the site logo (if using the MonoBook or Vector skin). These tabs allow you to perform actions or view pages that are related to the current page. The available default actions include: viewing, editing, and discussing the current page. The specific tabs displayed on your pages depend on whether or not you are logged into the wiki and whether you have sysop (administrator) privileges on the wiki. On special pages, only the namespace tab is displayed.

Default for all users

"namespace" (page, help, special page, template, user page etc.)
"Discussion"
"Edit" (may read "view source" if anonymous editing is disabled, the page is in the MediaWiki: namespace, or the page is protected)</translate>
"View history"

Extra tabs for logged-in users: </translate>

"Move"
"Watch"

Extra tabs for sysops: </translate>

"Protect"
"Delete"

Administrators can add or remove tabs by using JavaScript or installing extensions, so the tabs you see may be different depending on which wiki you are using.

User Links

The user links are displayed at the top far right of the page (if using the default Vector skin). These tabs allow the logged-in user to view and edit their user page and wiki preferences. Additionally, the user links allow the user to quickly access their contributions to the wiki and logout.

For anonymous users the user links is replaced by a link to the wiki login page or, if enabled by the site administrator, a link to your IP address and your IP address's talk page.

"<username>"

This links to your user page which is where you can put information about yourself, store bits of information you want to remember or whatever else you fancy.

"Talk"

This links to your discussion page, where people can leave messages for you.</translate>

"Preferences"

Allows you to change your personal site preferences.</translate>

"Watchlist"

A list of all pages that you are watching. Pages can be added to this list by clicking "<tvar|watch>watch</>" at the top of the page.</translate>

"Contributions"

A list of all contributions you have made to the wiki.

"Logout"

Click this link to log out of the wiki.

Searching

The quickest way to find information in on the support-works wiki is to look it up directly. At the top right of every page there is a Search box with a Go and Search Button next to it:

Go: clicking this (or pressing Enter) will take you to the page, if it exists.
Search: clicking this searches articles on the wiki

If a page has the same title as what you entered, you jump straight to that page. Otherwise, it searches all pages on the wiki (with some restrictions, see below), and presents a list of articles that matched your search terms, or a message that no matches were found.

How it works

It searches all pages on the wiki with some restrictions.
The article content is searched in its raw (wikitext) form - i.e., it searches the text that appears in the edit box when you click "Edit", not the rendered page. This means that content coming from an included template will not be picked up, but the target of piped links will be.
The search is not case-sensitive, so 'Support-Works', 'support-works' and 'SUPPORT-WORKS' all give the same result.

The search functionality can be considered to operate on whole words, separated by spaces or other punctuation marks. So if your search term includes the word 'book', the results will not include pages that only have the word 'books' or 'booklet'. And if your search term includes the term 'inter', the results will not include pages that only have the word 'international', but they may include pages that have the term 'inter-national'.
The results will only include pages that contain all the words in your search.
You can search for a phrase using double quotes. A phrase can be considered to consist of whole words (case-insensitive), so the phrase 'Prime Minister' will not be found by a search for "ime Min", but it will be found by a search for "pRIME mINISTER".

Restricting the search

If you click the "Search" button without filling in anything, you will be taken to "Special:Search" which gives you extra searching options (also available from any search results list)

You may find it useful to restrict a search to pages within a particular namespace e.g., only search within the User pages. Check the namespaces you require for this search.

By default only the namespaces specified in your preferences will be searched. Logged-in users can change their preferences to specify the namespaces they want to search by default. This can be done by selecting and deselecting boxes in the ”search” section of user preferences.

@@ Line 1: / Line 1: @@
-!!!!!!!!!!!NEEDS TO BE REVIEWED!!!!!!!!!!!!!!
+== Sidebar ==
+The sidebar is displayed on the left edge of the page below the site logo (if using the MonoBook or Vector skin). This sidebar gives you access to important pages in the wiki such as Recent Changes or Upload File.
+=== Navigation ===
+Clicking on the logo brings you back to the main page of the wiki. The links in the navigation section just below will take you to important pages of the wiki. These links can be configured by site administrators.
-Home > Wikihelp
+=== Tools ===
-==Introduction==
+Contains a selection of links which change depending on what type of page you are viewing.
-Get the most from the Hornbill Wiki. In this article, you will learn how to:
-* Register as a Support-works Wiki user and validate your email address
-* Find the information you need to perform daily operations.
-* Watch pages so you receive email notifications whenever they are changed.
-* Provide feedback to help improve the quality of the documentation.
-* Set preferences to enhance the way the wiki works for you.
-==Finding Information in the Wiki==
+;On all pages (except special pages):
-This wiki lets you find information as simply as possible<br\>
-The homepage organizes topics visually to help you drill down from articles with general information to more detailed content.<br\>
+:* "What links here" takes you to a special page that lists the pages on this wiki which contain a link to the current page. This is helpful when you are looking for pages of related information. The "What links here" information can also be useful when you are re-factoring wiki pages and need to check whether links to this page are still relevant after changes in the current page.
-Each wiki page offers several methods for finding information.<br\>
+:* The "Related changes" tool lists all recent changes in the pages linked to from the current page. Recent changes to all relevant template pages are included in the resulting page list.
-Search: Enter keywords in the Search box for quick access to both wiki articles and information in the ServiceNow User Community. Results are presented in a standard Google search format.<br\>
+;On all pages (including special pages):
-Navigation pane: Jump to pages in another category or perform other wiki activities, such as:
+:* "Upload" displays a special page that allows logged-in users to upload images and other files to the wiki. Uploaded files can be linked from or embedded in wiki pages. This link is not displayed if file uploading is not enabled.
-* Creating a Book that contains wiki pages of your choice and exporting it as PDF or ordering a printed copy from a third-party vendor.
-* Downloading a page as PDF.
+:* "Special pages" presents information about the Wiki and/or allows access to administration activities for the wiki. For example, a list of users registered with the wiki, statistics about the wiki such as the number of pages and number of page edits, system logs, a list of orphaned pages, and so on. These special pages are commonly generated when the special page is loaded rather than being stored in the wiki database.<br />
-* Breadcrumbs: Navigate directly to related articles in the current page's category path.
-* Contents and Topic box: Click these links to quickly access sections on the same page or related information in other articles
+== Page Tabs ==
+The page tabs are displayed at the top of the page to the right of the site logo (if using the MonoBook or Vector skin). These tabs allow you to perform actions or view pages that are related to the current page. The available default actions include: viewing, editing, and discussing the current page. The specific tabs displayed on your pages depend on whether or not you are logged into the wiki and whether you have sysop (administrator) privileges on the wiki. On special pages, only the namespace tab is displayed.
+;Default for all users
+:* "namespace" (page, help, special page, template, user page etc.)
+:* "Discussion"
+:* "Edit" (may read "view source" if anonymous editing is disabled, the page is in the MediaWiki: namespace, or the page is protected)</translate>
+:* "View history"
+;Extra tabs for logged-in users:</translate>
+:* "Move"
+:* "Watch"
+;Extra tabs for sysops:</translate>
+:* "Protect"
+:* "Delete"
+Administrators can add or remove tabs by using JavaScript or installing extensions, so the tabs you see may be different depending on which wiki you are using.
+== User Links ==
+The user links are displayed at the top far right of the page (if using the default Vector skin). These tabs allow the logged-in user to view and edit their user page and wiki preferences. Additionally, the user links allow the user to quickly access their contributions to the wiki and logout.
+For anonymous users the user links is replaced by a link to the wiki login page or, if enabled by the site administrator, a link to your IP address and your IP address's talk page.
+;"<username>"
+: This links to your user page which is where you can put information about yourself, store bits of information you want to remember or whatever else you fancy.
+; "Talk"
+: This links to your discussion page, where people can leave messages for you.</translate>
+;"Preferences"
+: Allows you to change your personal site preferences.</translate>
+; "Watchlist"
+: A list of all pages that you are watching. Pages can be added to this list by clicking "<tvar|watch>{{lcfirst:{{int:watch}}}}</>" at the top of the page.</translate>
+; "Contributions"
+: A list of all contributions you have made to the wiki.
+; "Logout"
+: Click this link to log out of the wiki.
+== Searching ==
+The quickest way to find information in on the {{SITENAME}} wiki is to look it up directly. At the top right of every page there is a '''Search''' box with a Go and Search Button next to it:
+; Go : clicking this (or pressing ''Enter'') will take you to the page, if it exists.
+; Search : clicking this searches articles on the wiki
+If a page has the same title as what you entered, you jump straight to that page.
+Otherwise, it searches all pages on the wiki (with some restrictions, see below), and presents  a list of articles that matched your search terms, or a message that no matches were found.
+=== How it works ===
+* It searches all pages on the wiki with some restrictions.
+* The article content is searched in its raw (wikitext) form - i.e., it searches the text that appears in the edit box when you click "Edit", not the rendered page.  This means that content coming from an included template will not be picked up, but the target of piped links will be.
+* The search is not case-sensitive, so 'Support-Works', 'support-works' and 'SUPPORT-WORKS' all give the same result.
+* The search functionality can be considered to operate on '''whole words''', separated by spaces or other punctuation marks.  So if your search term includes the word 'book', the results will not include pages that only have the word 'books' or 'booklet'.  And if your search term includes the term 'inter', the results will not include pages that only have the word 'international', but they may include pages that have the term 'inter-national'.
+* The results will only include pages that contain '''all''' the words in your search.
+* You can search for a phrase using double quotes.  A phrase can be considered to consist of '''whole words''' (case-insensitive), so the phrase 'Prime Minister' will '''not''' be found by a search for "ime Min", but it '''will''' be found by a search for "pRIME mINISTER".
+=== Restricting the search ===
+If you click the "Search" button without filling in anything, you will be taken to "Special:Search" which gives you extra searching options (also available from any search results list)
+You may find it useful to restrict a search to pages within a particular namespace e.g., only search within the {{ns:2}} pages. Check the namespaces you require for this search.
+By default only the namespaces specified in your preferences will be searched.  Logged-in users can change their preferences to specify the namespaces they want to search by default. This can be done by selecting and deselecting boxes in the ”search” section of user preferences.