Wiki Markup

From Research Computing

Table of contents

How do I create a new page?

To create a new page, you have to edit an existing page and add an internal link to it. When you save the page with the new internal link, the internal link will be colored red, which means that the link refers to a page that does not exist. To create the page and add content to it, click on the link; an edit window will appear with the title "Editing internal link." If you add content to the edit window and then click on the "save page" button at the bottom of the screen, the new page will be created and the referring internal link will point to it and change color from red to blue.

Bold and Italics

Bold text is produced with the following syntax.

'''Bold text'''

Italics is produced with the following syntax.

''Italics''

Headings

Headings are produced with leading and trailing equal signs. The level 1 and level 2 headings come with horizontal lines; the rest don't.

level 1 heading (h1)

is produced with

= level 1 heading (h1) = 

level 2 heading (h2)

is produced with

== level 2 heading (h2) == 

level 3 heading (h3)

is produced with

=== level 3 heading (h3) === 

level 4 heading (h4)

is produced with

==== level 4 heading (h4) ==== 
level 5 heading (h5)

is produced with

===== level 5 heading (h5) =====
level 6 heading (h6)

is produced with

====== level 6 heading (h6) ======

Links

A link refers to some other page, either on the web, or in this wiki. There are two kinds of links: external, and internal.

An external link, such as google (http://www.google.com), is produced with

[http://www.google.com google] 

An internal link to a page within this wiki, such as this link, is produced with

 [[this link]]

<nowiki>: preventing wiki evaluation of HTML syntax

The preceding were examples of "forced" links. A forced link is explicitly coded and evaluated link in wiki syntax. The wiki will interpret HTML URL syntax as a link, even if you do not supply the brackets. That's known as an "unforced" link. In general, the Wiki will believe and evaluate the HTML syntax you give it, in addition to its own syntax. However, your intention might have been to show the unevaluated syntax. The following syntax accomplishes this:

<nowiki>Insert non-formatted text here</nowiki>

Now you know how I produced the examples on this page.

There are cases where you want to specify in text a URI that doesn't necessarily exist. To mention one of many possible examples, a web service name is conventionally given as a URI with a domain name prefix, even though the domain's DNS servers usually will not have entries for them (the domain name is used to "claim ownership" of the service URI).* For example, to get

http://gc.cuny.edu/globus/ogsa/wsdl/xml-rpc/soap/rmi/dev/null

instead of

http://gc.cuny.edu/globus/ogsa/wsdl/xml-rpc/soap/rmi/dev/null (which happens to have been entered into the wiki with "unforced" HTML), use the following syntax.

<nowiki>http://gc.cuny.edu/globus/ogsa/wsdl/xml-rpc/soap/rmi/dev/null</nowiki>

* In an article appearing (http://www.xml.com/pub/a/2005/04/13/namespace-uris.html) in http://www.xml.com, Michael Day (http://www.xml.com/pub/au/250) writes, "The decision to identify XML namespaces (http://www.w3.org/TR/REC-xml-names/) with URIs was an architectural mistake that has caused much suffering for XML users and needless complexity for XML tools."

Horizontal Lines

A horizontal line is produced with four dashes; level 1 and level 2 headings come with horizontal lines.

----

produces


Images

An unforced link (no square brackets around the URL) to an image will display it.

gciscuny_logo183.gif

The unforced link is HTML URL syntax, as follows.

http://www.gc.cuny.edu/img/logos/gciscuny_logo183.gif

The previous example illustrates the use of "unforced" links (a link without the surrounding square brackets) as opposed to a forced link (with the surrounding square brackets). To display an image, you must use an unforced link to the image; the use of the forced link [http://www.gc.cuny.edu/img/logos/gciscuny_logo183.gif] would result in [1] (http://www.gc.cuny.edu/img/logos/gciscuny_logo183.gif), which links to the image.

Surrounding boxes

To surround this text in a box, start in a column other than the first.

 To surround this text in a box, start in a column other than the first.

A blank line will terminate the box. Sometimes one wants a box to enclose several lines which include blank lines, without terminating the box. For example, to get

this
 
effect

instead of

 this
 effect

insert an "italic" blank space on each blank line to be included in the box, as follows.

this
'' '' 
effect

Subscripts and superscripts

In addition to the simplified wiki markup syntax, the wiki understands HTML. So, one can typeset H2O with

H<sub>2</sub>O

and famous equations such as E = mc2 with

E = mc<sup>2</sup>

not to mention footnotes in small type.*

not to mention footnotes in small type.<sup>*</sup> 

*You call this a footnote?

<font size=1><sup>*</sup>You call this a footnote?</font>