wikiacademia

site

Wiki Markup Syntax

This page explains what you can type while editing these wiki pages. Much of it works like Wikipedia's markup syntax.
The basics are pretty simple: leave a blank line for a new paragraph, and put double brackets around a link.
If you know HTML, you can use that, too.
Beyond that, the details are described in the table below.
What it looks likeWhat you type

Page Title

Put a title at the top of each page, like the one above. The equal sign must be at the beginning of a line.
Within the page, use sections (==), subsections (===), and sub-subsections (====) to organize your material.

Section I

This text is in section 1.

Section II

This text is in section II.

Subsection II.1

And this text is in subsection II.1

sub-subsection II.1.a

While this is in II.1.a.
All of these turn into HTML header tags, namely <h1> <h2> and so on; you can type the tags directly if that's easier.
= Page Title =

Put a title at the top of each page, like the one above.
The equal sign must be at the beginning of a line.

Within the page, use sections (==), subsections (===),
and sub-subsections (====) to organize your material.

== Section I ==

This text is in section 1.

== Section II ==

This text is in section II.

=== Subsection II.1 ===

And this text is in subsection II.1

==== sub-subsection II.1.a ====

While this is in II.1.a.

All of these turn into HTML header tags, 
namely <h1> <h2> and so on;
you can type the tags directly if that's easier.
Lines are filled into paragraraphs, so carriage returns are ignored.
Paragraphs are separated by a blank line.
The corresponding HTML puts the paragraphs into <div>blocks</div> which again you can type directly if you'd prefer.
Lines are filled into
paragraraphs, so carriage returns
are ignored.

Paragraphs are separated by a blank line.

The corresponding HTML puts the paragraphs
into <div>blocks</div> which again
you can type directly if you'd prefer.
Bullet and numbered lists are typed with asterisks and number signs on the left margin, with more characters for more indentation.
  • The first item in a list.
  • Another item.
    • An indented item.
  1. A numbered list.
    1. An indented entry.
  2. Another entry.
Or you can type the usual <ul>, <ol>, and <li> HTML list tags directly.
Bullet and numbered lists are typed with
asterisks and number signs on the left margin,
with more characters for more indentation.

* The first item in a list.
* Another item.
** An indented item.

# A numbered list.
## An indented entry.
# Another entry.

Or you can type the usual <ul>, 
<ol>, and <li> HTML list tags directly.
Consecutive lines that start with a space are grouped together and displayed in a yellow box, just as you typed them. This is especially useful for formatted code.
   # --- a perl program ---  
   for (my $i=1..10){
     print "The root of $i is " . sqrt($i) . "\n";
   }
Or you can put your code within <code> blocks, which does essentially the same thing. HTML within these code blocks will just show up as source code, not formatted as html.
 <html>   - an HTML tag
 <div>    - another one
Or if you want to be really fancy,
0: # you can even format code with
1: # pretty colors and line numbers.
2: if (my $mood eq 'good'){
3:   print "Yeah, baby. \n";
4: }
For a few programming and markup languages, you can accomplish the same effect by using the name of the langauge as the tag. The current list of languages that work this way in wiki markup is (c html java javascript lisp perl python).
if (up==1)
 a += 1;
else
 a -= 1;
<person name="Jim">
  <phone number="xxx xxxx" />
</person>
Consecutive lines that start with a space are 
grouped together and displayed in a yellow box,
just as you typed them.  This is especially useful
for formatted code.

   # --- a perl program --- 
   for (my $i=1..10){
     print "The root of $i is " . sqrt($i) . "\n";
   }

Or you can put your code within <code> blocks,
which does essentially the same thing.

<code>
 <html>   - an HTML tag
 <div>    - another one
</code>

Or if you want to be really fancy,

<pretty numbers=1 lang="perl">
# you can even format code with
# pretty colors and line numbers.
if (my $mood eq 'good'){
  print "Yeah, baby. \n";
}
</pretty>

For a few programming and markup languages, you can accomplish the 
same effect by using the name of the langauge as the tag.  
The current list of languages that work this way in wiki markup 
is (c html java javascript lisp perl python).

<c>
if (up==1)
 a += 1;
else
 a -= 1;
</c>

<xml>
 <person name="Jim">
   <phone number="xxx xxxx" />
 </person>
</xml>

Threaded conversations are typically typed with colons (:) at the start of a line, which indents that section. More colons gives more indentation. Successive lines with the same indentation are wrapped together.
Hi Bob.
Hi Charlie.
How's it going?
It's going great. How are you doing?
If you expect the conversation to be read by many others and to be visible for some time, signing and dating it is often a good idea.
Threaded conversations are typically typed
with colons (:) at the start of a line, 
which indents that section.  More colons
gives more indentation.  Successive lines
with the same indentation are wrapped together.

: Hi Bob.

:: Hi Charlie.

: How's it going?

:: It's going great.
:: How are you doing?

If you expect the conversation to be read by many others
and to be visible for some time, signing and dating it
is often a good idea.
A backslash at the end of a line continues it without doing extra wiki formatting on the next one. This can be useful for long lines in bullet lists, for example, although you can accomplish the same effect by not typing a carriage return.

  • This is the first item.
  • This is the second item which is on a long line which continues onto this one.
To see a slash at the end of a line without this effect, put a space after it.
Two backslashes are left alone. (This is a common LaTeX syntax.)
A backslash at the end of a line continues it without doing
extra wiki formatting on the next one.  This can be useful
for long lines in bullet lists, for example, although you can 
accomplish the same effect by not typing a carriage return.

* This is the first item.
* This is the second item which is on a long line \
  which continues onto this one.

To see a slash at the end of a line without this effect,
put a space after it.

Two backslashes are left alone. (This is a common LaTeX syntax.)

Links to other pages can be typed in a number of ways; however, the syntax is a bit different from Wikipedia's because the underlying assumptions here are a bit different: here the URIs reflect a directory file structure.
  • A regular HTML anchor tag works fine: google
  • Double brackets around the page name are the suggested link to a wiki page in the same directory : some new page is a link to some_new_page.wiki
  • A vertical bar after a link gives alternate text to display: displayed text
  • A leading slash within double brackets is interpreted as the home directory of the current course; for example assignments is a link to the assignments page for the course that the page is in.
  • Two leading slashes within double brackets marks the home directory for the wikiacademia site. For example, help is the sitewide help page.
  • Double brackets with a full URI and text also work as external links : Marlboro College.
  • The wikipedia convention of single brackets for external links is also acceptible: Marlboro College .
Links to other pages can be typed in a number of ways;
however, the syntax is a bit different from Wikipedia's
because the underlying assumptions here are a bit different: 
here the URIs reflect a directory file structure.

Warning: these wiki have been known to be a bit buggy; 
if in doubt, use a regular HTML link.

* A regular HTML anchor works fine: \
  <a href="http://www.google.com">google</a>

* Double brackets around the page name are the suggested link \
  to a wiki page in the same directory : \
  [[ some new page ]] is a link to some_new_page.wiki

* A vertical bar after a link gives alternate text to display: \
  [[ some new page | displayed text ]]

* Links to wikipedia articles look like this : \
  [[ wikipedia: finite state machine ]]

* A leading slash within double brackets is interpreted \
  as the home directory of the current course; for example \
  [[ /special/assignments ]] is a link to \
  the assignments page for the course that the page is in.

* Two leading slashes within double brackets marks \
  the home directory for the wikiacademia site.  \
  For example, [[ //help ]] is the sitewide help page.

* Double brackets with a full URI and text also work \
  as external links : \
  [[ http://marlboro.edu Marlboro College ]].

* The wikipedia convention of single brackets for \
  external links is also acceptible: \
  [ http://marlboro.edu Marlboro College ] .
To enter text that you don't want to be interpreted as wiki markup, use a <nowiki> tag.
* This would usually be a list item - but not here.
To enter text that you don't want to be interpreted as wiki markup,
use a <nowiki> tag.

<nowiki>
* This would usually be a list item - but not here.
</nowiki>
Multiple single quotes may be used for italic, bold, and bold italic, but the HTML tags <i> and <b> also work and may be simpler.
Multiple single quotes may be used for 
''italic'', 
'''bold''', and
''''bold italic'''',
but the HTML tags <i> and <b> also work and may be simpler.
Four dashes at the start of a line

gives a horizontal line, as does the standard <hr>
Four dashes at the start of a line
----
gives a horizontal line, as does the standard <hr>
Math equations can be entered using LaTeX, using the MathJax engine. (The AMS macros are loaded by default.)
Here's an example of display math
\[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2 a} \]
and some inline math : \( \left(-b \pm \sqrt{b^2 - 4 a c} \right) /2 a \) .
Two dollar signs can also be used as the display math delimiter. However, the single dollar sign is not by default used for inline math, since it's too common.
Math equations can be entered using LaTeX, 
using the [[http://mathjax.org | MathJax]] engine.
(The AMS macros are loaded by default.)

Here's an example of display math

\[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2 a} \]

and some inline math :
\( \left(-b \pm \sqrt{b^2 - 4 a c} \right) / 2a \) .

Two dollar signs can also be used as the display math delimiter. 
However, the single dollar sign is not by default used for 
inline math, since it's too common.
http://cs.marlboro.edu/ courses/ help/ markup
last modified Friday April 4 2014 2:06 pm EDT