Help:Contents

From Q
Jump to: navigation, search

In order to write new pages you need to have a login. Pages are created by by creating a cross-reference. For example, to write a new page called New Page you would write a cross-reference New Page and the act of clicking on the resulting link (New Page) would cause the new page to be created. If you want to have a link that differs from the name of the page, you write [[New Page|Name of the link]]

Structure (Category)

All pages should contain at least one category name at the bottom [[Category:Name]].

Pages documenting dialog boxes and other aspects of the user interface (e.g., a tab) should use [[Category:User Interface]]

Pages of code snippets for the different types of JavaScript should have [[Category:JavaScript Library]], as the plan is that users will be able to edit such pages.

Other pages should be organized by subject matter, using three (or more if required) tiers. See Structue of this Wiki for the basic overview and go to the Main Page or Categories in the sidebar for the detail.

When creating a new category, the category shown for the new category needs to be that for the level above it. For example, [[Category:Installing and Updating Q]] is itself a part of [[Category:Setup]], and this it has its category set to Setup, whereas pages within Installing and Updating Q have [[Category:Installing and Updating Q ]]

Where appropriate, use multiple categories on the same page. However, do not put multiple categories where they one is a sub-category of another as the software does this automatically.

Q Versioning

Be explicit about versions when writing on a new or changed feature in Q. For example, a change in a feature should say how it is now, and how it used to be:

Q's default for '''Minimal sample size for testing''' is 2.  In [[Release Notes#1.1.0.0|Q 1.1]] and earlier versions, the default was 10.

Q's default for Minimal sample size for testing is 2. In Q 1.0.1 and earlier versions, the default was 10.

Another example for a new feature:

The Segments dialog is new in [[Release Notes#4.0.0.0|Q 4]].

The Segments dialog is new in Q 4.

Cross-referencing (creating links)

Cross-references are created by entering [[Name]]. When you save, the link will go blue if the cross-reference exists and red otherwise. Clicking on a red link causes the cross-reference page to be created. Links to external pages will not have this automatic red if they do not exist.

The link to a cross-reference can be created so that the wording of cross-reference differs from the file being cross-reference. For example: [[Name of Cross-Reference|Click here]]

Where the link is to a category page, it is written as[[[[:Category:Category Name|Name shown on screen]]

To link to a section in the same page you can use [[#section name|displayed text]], and to link to a section in another page [[page name#section name|displayed text]].

Links to general web pages (e.g., surveyanalysis.org) are written with this syntax [http://surveyanalysis.org surveyanalysis.org]. When writing a link to surveyanalysis.org instead use [[surveyanalysis:page on that wiki]].

Links to online training

Related Online Training modules
Stacking data
Generally it is best to access online training from within Q by selecting Help : Online Training

Online training tutorials related to a particular topic should generally be listed in an a box at the top of the page. For example, the following code generates the box shown at the right:

{{Infobox
|header1 = Related Online Training modules
|data2   = [http://www.q-researchsoftware.com/training/ReferencedLesson.aspx?id=173 Stacking data]
|data3  = <small>Generally it is best to access online training from within Q by selecting '''Help : Online Training'''</small>
}}

Page names, headings and capitalization

Page names should be written with capitals preceding each word except where it looks silly (e.g., 'New Page Name').

Within a page, headings should only use capitals for the first word, except where referring to specific things. (The only exception to this is on the home page, where the sub-headings are capitalized to match to the category names).

Levels of heading are indicated by == signs.

== Top level heading ==
=== Sub-heading ===

Where there are lots of fields, buttons and/or options on a page, they can be included under a sub-heading of Buttons, options and fields and other related topics under See also.

Formatting

Technical terms should, in general, be cross-referenced but where this is not desirable instead use italics (''name'').

Options, buttons, fields, menus and items are showng with an appropriate cross-reference, or, in bold '''name'''.

Text that appears on tables, file names and things to be typed are shown in this style, which is created using:

<tt>'''the thing to show'''</tt>

you can also set the color of the background behind text.

JavaScript

JavaScript is shown with syntax highlight:

var x = 3;
alert(x * 3);

and is written like this:

<syntaxhighlight>
var x = 3;
alert(x * 3);
</syntaxhighlight>

See SyntaxHighlight_GeSHi for more formatting help, including changing the highlight language (our default is JavaScript).

Referring to menus

When referring to objects in menus use colons to indicate sub-menus and avoid typing .... For example, save as is shown as File : Save Project As.

Graphics

Graphics are uploaded by clicking on Upload file on the left of the screen. They are included on a page using:

[[File:ValueAttributesNumeric.png]]

Formulas

The formula ) is written using:

<math> f(x) = x^2\,\!</math>)

Redirecting pages

You can create a redirection on page by replacing its contents with #REDIRECT [[target]]

Turning off the table of contents for a page

At the top of the page enter __NOTOC__

Navigation sidebar

To edit the links that appear on the left, use the special MediaWiki:Sidebar page.

Learning more about editing pages

Generally the best way to learn how to use WikiMedia (this software) is to edit or view the source of a page. Alternatively, consult the User's Guide for information on using the wiki software.