Freddie Akeroyd at 19:01, 16 January 2007

2007-01-16T19:01:32Z

Freddie Akeroyd at 17:44, 16 January 2007

2007-01-16T17:44:32Z

New 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.'', <nowiki>==Formatting a Page==</nowiki>, 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 [http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide].

==Headings==
Section headings are created by surrounding the heading text with two or more equal signs.
*<nowiki>==Level 1 Heading==</nowiki>
*<nowiki>===Level 2 Heading===</nowiki>
*<nowiki>====Level 3 Heading====</nowiki>
When you have three 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 <nowiki><pre></nowiki> tag).
* You can add line breaks without creating a new paragraph by using the standard HTML <nowiki> </nowiki> 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).
{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
* List item 1
* List item 2
** Sublist item 1
** Sublist item 2
* List item 3
</pre>
|
* 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.
{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
# List item 1
# List item 2
#* Sublist item 1
#* Sublist item 2
# List item 3
</pre>
|
# List item 1
# List item 2
#* Sublist item 1
#* Sublist item 2
# List item 3
|}
A third type of list is called a definition list.
{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
;Term 1: Definition of term 1
;Term 2: Definition of term 2
</pre>
|
;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.'', <nowiki>[[New Topic]]</nowiki>.

*If you want the link to use different text, add a vertical bar after the page title and follow it with the replacement text.

{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
* [[New Topic]]
* [[New Topic|Same link, different text]]
</pre>
|
* [[New Topic]]
* [[New Topic|Same link, different text]]
|}

==External links==
External links, ''i.e.'', to pages outside the ''wiki'', including the rest of the NeXus 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.

{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
* http://www.nexus.anl.gov/
* [http://www.nexus.anl.gov/]
* [http://www.nexus.anl.gov/ NeXus Home Page]
</pre>
|
* http://www.nexus.anl.gov/
* [http://www.nexus.anl.gov/]
* [http://www.nexus.anl.gov/ NeXus Home Page]
|}

==Centering Text==
Text can be centered by using the standard HTML <nowiki><center></nowiki> tag.
{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
This text is not centered.

<center>This text is.</center>
</pre>
|
This text is not centered.

<center>This text is.</center>
|}

==Preformatting Text==
You can use the HTML <nowiki><pre></nowiki> 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.

{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
This text
is not preformatted.
<pre>
This text
is.
</pre>
</pre>
|
This text
is not preformatted.
<pre>
This text
is.
</pre>
|}

==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 [http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide:_Creating_special_characters MediaWiki User's Guide] for a complete list). If you need to produce a complex equation, you can [http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide:_Editing_mathematical_formulae use TeX] within <nowiki><math></nowiki> tags (the NeXus web server needs some configuration to get this to work properly).
{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
* This text is ''emphasized''.
* This is '''emphasized even more'''.
* This is '''''emphasized the most'''''.
</pre>
|
* This text is ''emphasized''.
* This is '''emphasized even more'''.
* This is '''''emphasized the most'''''.
|-
| <pre>
* <tt>Typewriter font</tt>
</pre>
|
* <tt>Typewriter font</tt>
|-
| <pre>
* Small text
</pre>
|
* Small text
|-
| <pre>
* x2 and H2O
</pre>
|
* x2 and H2O
|-
| <pre>
* &alpha;, &beta;, &gamma;
</pre>
|
* α, β, γ
|-
| <pre>
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>
</pre>
|
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>
|}

==Images==
To upload images, use the [[Special:Upload|upload page]]. You can find previous uploads on the [[Special:Imagelist|image list]]. Clicking on an uploaded image displays a description page, which you can also link directly to, ''e.g.'' [[:Image:NeXus.png]]. The syntax is like an internal link, with alternate text following a '|'. However, this alternate text is only displayed by browsers if the image can't be located. If you add an additional '|', you can specify the image positioning ('left', 'right', 'center'). Use a 'media' link if you want to link to an image but not display it at all.
{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
A picture: [[Image:NeXus_narrow.png|NeXus]]
</pre>
|
A picture: [[Image:NeXus_narrow.png|NeXus]]
|-
| <pre>
On the right: [[Image:NeXus_narrow.png|NeXus|right]]
</pre>
|
On the right: [[Image:NeXus_narrow.png|NeXus|right]]
|-
| <pre>
Or left: [[Image:NeXus_narrow.png|NeXus|left]]
</pre>
|
Or left: [[Image:NeXus_narrow.png|NeXus|left]]
|-
| <pre>
[[media:NeXus.png|NeXus banner]]
</pre>
|
[[media:NeXus.png|NeXus banner]]
|}

==Tables==
Tables can be entered using standard HTML tags. However, a simpler [http://meta.wikimedia.org/wiki/Help:Table#Pipe_syntax pipe syntax] requires less typing. Here is a simplified description of that syntax.

* Start the table with "<code>{|</code>" at the start of a new line optionally followed by HTML attributes.
* Start a new row with "<code>|-</code>" 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 "<code>|}</code>".

{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
{| align="center" border="1"
|-
! &nbsp; || Col 1 || Col 2
|-
! Row 1
| align="center" | a11
| align="center" | a12
|-
! Row 2
| align="center" | a21
| align="center" | a22
|}
</pre>
|
{| align="center" border="1" cellpadding="5"
|-
!   || Col 1 || Col 2
|-
! Row 1
| align="center" | a11
| align="center" | a12
|-
! Row 2
| align="center" | a21
| align="center" | a22
|}
|}

In the NeXus wiki, we have defined a couple of templates, <nowiki>{{Tablestyle}}</nowiki> and <nowiki>{{Headcellstyle}}</nowiki>, for producing the default table formatting.

{| width="100%" border="1" style="border:1px solid navy; border-collapse: collapse"
|-
! width="50%" | What you type
! width="50%" | What you get
|-
| <pre>
{| {{Tablestyle}}
|-
! {{Headcellstyle}} | &nbsp;
! {{Headcellstyle}} | Col 1
! {{Headcellstyle}} | Col 2
|-
! {{Headcellstyle}} | Row 1
| align="center" | a11
| align="center" | a12
|-
! {{Headcellstyle}} | Row 2
| align="center" | a21
| align="center" | a22
|}
</pre>
|
{| {{Tablestyle}}
|-
! {{Headcellstyle}} |  
! {{Headcellstyle}} | Col 1
! {{Headcellstyle}} | Col 2
|-
! {{Headcellstyle}} | Row 1
| align="center" | a11
| align="center" | a12
|-
! {{Headcellstyle}} | Row 2
| align="center" | a21
| align="center" | a22
|}
|}

==References==
*[http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide]
*[http://meta.wikipedia.org/wiki/MediaWiki_i18n MediaWiki Interface Customization]
*[http://home.earthlink.net/~awinkelried/keyboard_shortcuts.html Special characters in HTML]

@@ Line 104: / Line 104: @@
 |-
 | <pre>
-* http://www.nexus.anl.gov/
+* http://www.nexusformat.org/
-* [http://www.nexus.anl.gov/]
+* [http://www.nexusformat.org/]
-* [http://www.nexus.anl.gov/ NeXus Home Page]
+* [http://www.nexusformat.org/ NeXus Home Page]
 </pre>
+|
-* http://www.nexus.anl.gov/
+* http://www.nexusformat.org/
-* [http://www.nexus.anl.gov/]
+* [http://www.nexusformat.org/]
-* [http://www.nexus.anl.gov/ NeXus Home Page]
+* [http://www.nexusformat.org/ NeXus Home Page]
 |}

Help:Editing - Revision history

Freddie Akeroyd at 19:01, 16 January 2007

Freddie Akeroyd at 17:44, 16 January 2007