Help:Contents

From canSAS
Revision as of 18:58, 29 August 2008 by Jemian (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

A wiki is a web application that allows users both to add and/or edit the content of web pages directly from their web browser. The name is derived from the Hawaiian term wiki wiki, meaning "quick" or "informal", and the most famous example of a wiki site is probably the Wikipedia, which allows thousands of people around the world to contribute to a free online encyclopedia.

We have set up the canSAS wiki to:

  1. encourage people to contribute comments and suggestions for improving the canSAS standards.
  2. allow people to update, clarify, correct, or add to the content of the canSAS web pages.

We welcome constructive contributions of any kind, but please read the following guidelines before making any changes.

Contents

Guidelines

We want to encourage the small-angle scattering community to collaborate. This wiki is but one means to facilitate this collaborative involvement. The contents of the canSAS wiki will be periodically reviewed by the administrators; suggested changes to the format or its online documentation will be reviewed on a regular basis. Please don't be inhibited from making constructive changes of any kind; the point of running this wiki is to encourage lively debate.

Signatures

Whenever you make a comment on a discussion page (see below), you should sign it at the bottom using the :~~~~ shortcut at the beginning of a new line. A colon at the beginning of a line indents the signature on a new line while the ~~~~ inserts a link to your user page along with a date stamp.

What you type What you get
This is my opinion.
:~~~~
This is my opinion.
Pete Jemian 15:45, 22 Dec 2007 (CDT)

Discussing a New Topic

If you wish to raise a new issue , please visit the canSAS Discussions page, choose the relevant area, and add a new item to the list. If you want others to contribute to the new discussion, we suggest that you advertise the new page on the canSAS email list. See below for instructions on adding a new page.

Wiki Pages

Page Layout

Every page displayed in the canSAS wiki has a number of tabs along the top that are links to different views of the web page:

Article
This is a link to the formatted view of the web page, which is the default display.
Discussion
This is a link to a Talk page, where people can add comments or discuss the content of the 'article', without touching the article itself. Talk pages have, in addition to the regular tabs, an additional Edit tag, labelled with a '+' sign. Click on this to add a comment at the end of the discussion (but please remember to sign it using the signature and date shortcut, '~~~~').
Edit
This is a link to a form which allows you to edit the text of the article, and add the formatting instructions. This is only available when you have logged in.
History
This is a link to previous versions of the 'article' so that you can see what changes have been made. These previous versions can be restored if the latest version has become corrupted in any way. Simply click on the previous version that you want to restore, click on its 'Edit' tab, and then save it.

There is also a navigation bar on the left hand side of the screen with links to common pages on the canSAS wiki.

Creating a Page

It is simple to create a new page on the canSAS wiki; you just add a link to it on an existing page and then click on the link to start editing it.

For example, suppose you wish to create a page called New Topic, which is linked from canSAS Discussions page.

  1. Visit the page (for example, by clicking on the link in the navigation bar)
  2. Click on its 'Edit' tab. This opens the page in an editable text box.
  3. In the relevant place, add the title of the new page, surrounded by two square brackets, i.e., type [[New Topic]].
  4. Click on the 'Save Page' button below the text box.
  5. The updated page now contains a link to the new page, which is colored red to show that it doesn't yet exist.
  6. Click on the new link. This automatically sends you to the new article's 'Edit' page.
  7. Edit the new page (see instructions below) and save it. The link on the canSAS Discussions page should now be colored blue.

Editing a Page

To edit a canSAS wiki page, click on the 'Edit' tab at the top. This will bring you to the edit page: a page with a text box containing the article's text. After adding to or changing the text, you can press "Show preview" to see what the page looks like before saving it. If you are not satisfied you can make more changes and preview the page as many times as necessary. Then write a short edit summary in the small text field below the edit-box and press "Save". A checkbox allows you to specify that the edit is minor, if, for example, you have just corrected a spelling mistake.

Formatting a Page

The pages on a wiki can be edited easily even by those with no experience of web design (i.e., it is not necessary to know any HTML in advance). Editing a page consists of typing in the text along with a few simple formatting instructions. For example,

  • Typing * at the start of each line creates a bulleted list (like this one).
  • Surrounding text by two "=" characters, e.g., ==Formatting a Page==, creates a level-1 header (like the header of this section).

Here is a brief description of the more commonly-used formatting instructions. You can find more comprehensive help in the MediaWiki User's Guide.

Headings

Section headings are created by surrounding the heading text with two or more equal signs.

  • ==Level 1 Heading==
  • ===Level 2 Heading===
  • ====Level 3 Heading====

When you have four or more 'Level 1' headings, a table of contents is automatically produced before the first section. In this section, Formatting a Page is the Level 1 heading and Headings is a Level 2 heading.

Paragraphs

The wiki ignores single newlines in the text. To create a new paragraph, type in two carriage returns in succession (i.e., make sure that there is a blank line between paragraphs). Note however that single newlines are important when formatting lists (see below). Please note a couple of things:

  • Although single newlines are ignored, you should make sure that there are no spaces at the beginning of each line. Lines starting with a space are treated as preformatted text (equivalent to using the <pre> tag).
  • You can add line breaks without creating a new paragraph by using the standard HTML <br> tag.

Lists

Bulleted lists are created by putting a '*' at the beginning of the line (i.e., there must be no blank characters before it). An extra '*' creates a list within a list. A newline will end the list (so you cannot have any newlines within any list item).

What you type What you get
* List item 1
* List item 2
** Sublist item 1
** Sublist item 2
* List item 3
  • List item 1
  • List item 2
    • Sublist item 1
    • Sublist item 2
  • List item 3

Similarly, numbered lists are created by putting a '#' at the beginning of the line.

What you type What you get
# List item 1
# List item 2
#* Sublist item 1
#* Sublist item 2
# List item 3
  1. List item 1
  2. List item 2
    • Sublist item 1
    • Sublist item 2
  3. List item 3

A third type of list is called a definition list.

What you type What you get
;Term 1: Definition of term 1
;Term 2: Definition of term 2
Term 1
Definition of term 1
Term 2
Definition of term 2

This is very useful if you want to have a subheader followed by indented text, but you don't want to create a new section.

Incidentally, notice that you can indent any new paragraph by putting a colon at the beginning of the line.

Internal Links

If you want to link to another wiki page, just put the title of the page within two square brackets, e.g., [[New Topic]].

  • If you want the link to use different text, add a vertical bar after the page title and follow it with the replacement text.
What you type What you get
* [[New Topic]]
* [[New Topic|Same link, different text]]

External links

External links, i.e., to pages outside the wiki, including the rest of the canSAS web site, can be displayed in a couple of ways. If the text is a valid URL, it will automatically be formatted as a hyperlink or you can enclose the URL in single square brackets. If the brackets only contain the URL, the hyperlink will be displayed as a reference, but if you add some text after a space, the text is formatted as the hyperlink.

What you type What you get
* http://www.smallangles.net/
* [http://www.smallangles.net/]
* [http://www.smallangles.net/ canSAS Home Page]

Centering Text

Text can be centered by using the standard HTML <center> tag.

What you type What you get
This text is not centered.

<center>This text is.</center>

This text is not centered.

This text is.

Preformatting Text

You can use the HTML <pre> tag, to preserve precise line breaks, etc. This is also used to display XML files; otherwise, the XML tags would be treated as unknown HTML tags and not be printed.

  • Preformatted text is also automatically displayed within a shaded box in monospace font, as if it were code.
What you type What you get
This text 
is not preformatted.
<pre>
This text 
is.
</pre>

This text is not preformatted.

This text 
is.

Formatting Characters

Put two or more (single) apostrophe characters around text to add progressively greater emphasis. Standard HTML markup can be used for other formatting and special characters (see the MediaWiki User's Guide for a complete list). If you need to produce a complex equation, you can use TeX within <math> tags.

What you type What you get
* This text is ''emphasized''.
* This is '''emphasized even more'''.
* This is '''''emphasized the most'''''.
  • This text is emphasized.
  • This is emphasized even more.
  • This is emphasized the most.
* <tt>Typewriter font</tt>
  • Typewriter font
* <small>Small text</small>
  • Small text
* x<sup>2</sup> and H<sub>2</sub>O
  • x2 and H2O
* &alpha;, &beta;, &gamma;
  • α, β, γ
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>

<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>

Images

To upload images, use the upload page (you must be logged in). You can find previous uploads on the image list. Clicking on an uploaded image displays a description page, which you can also link directly to, e.g. Image:cansas1d-v1-1-SASroot.png. Use a 'media' link if you want to link to an image but not display it.

What you type What you get
A picture: [[Image:cansas1d-v1-1-SASroot.png|SASroot]]

A picture: SASroot

A link: [[media:cansas1d-v1-1-SASroot.png|SASroot block diagram]]

A link: SASroot block diagram

Tables

Tables can be entered using standard HTML tags. However, a simpler pipe syntax requires less typing. Here is a simplified description of that syntax.

  • Start the table with "{|" at the start of a new line optionally followed by HTML attributes.
  • Start a new row with "|-" at the start of a new line.
  • Start a new cell with "|" or "||" at the start of a new line, or "||" between cells in the same row.
  • If you need to modify the cell formatting, put the HTML attributes between the two vertical bars.
  • If the cell is a header cell, replace the first (or only) vertical bar with "!".
  • End the table with the line "|}".
What you type What you get
{| align="center" border="1"
|-
! &nbsp; || Col 1 || Col 2
|-
! Row 1
| align="center" | a<sub>11</sub> 
| align="center" | a<sub>12</sub>
|-
! Row 2 
| align="center" | a<sub>21</sub> 
| align="center" | a<sub>22</sub>
|}
  Col 1 Col 2
Row 1 a11 a12
Row 2 a21 a22

In the canSAS wiki, we have defined a couple of templates, {{Tablestyle}} and {{Headcellstyle}}, for producing the default table formatting.

What you type What you get
{| {{Tablestyle}}
|-
! {{Headcellstyle}} | &nbsp;
! {{Headcellstyle}} | Col 1 
! {{Headcellstyle}} | Col 2
|-
! {{Headcellstyle}} | Row 1
| align="center" | a<sub>11</sub> 
| align="center" | a<sub>12</sub>
|-
! {{Headcellstyle}} | Row 2 
| align="center" | a<sub>21</sub> 
| align="center" | a<sub>22</sub>
|}
  Col 1 Col 2
Row 1 a11 a12
Row 2 a21 a22

References

Personal tools
Namespaces
Variants
Actions
canSAS Meetings
canSAS Working Groups
Navigation
Toolbox