====== MonkeyWiki Formatting ======
See also: [[software:MonkeyWiki]]
===== Bold Text =====
Enclose your text in three sets of single quotes
' ' 'example' ' ' = **example**
===== Italic Text =====
Enclose your text in two sets of single quotes
' 'example' ' = //example//
===== Headings and Sub Headings =====
Ensure that the following is alone on a line: starting from the beginning of a line, enclose your subheading's text in 2 - 6 underscores. The number of underscores represents the level. (The level 1 heading is reserved for the page's title.)
____example Level 4 Heading____
=== example Level 4 Heading ===
If you fail to balance the number of underscores either side of your text, the lower number will be used, with the extra ones the other side being displayed as underscores.
No other wiki mark-up will be honored within a heading.
==== Lists - Bulleted ====
Type one or more spaces from the beginning of a line, followed by *. The number of spaces represents the indent level. Can be mixed with NumberedLists.
*example level 1
*example level 2a
*example level 2b
* example level 1
* example level 2a
* example level 2b
==== Lists - Numbered ====
Type one or more spaces from the beginning of a line, followed by #. The number of spaces represents the indent level. Can be mixed with Bulleted Lists.
#example level 1
#example level 2a
#example level 2b
- example level 1
- example level 2a
- example level 2b
==== Images ====
You can place an image on a page by hotlinking: i.e. providing a reference to an image which lives elsewhere on the web. Please note that you should either own, or have permission to use, an image in this way. It is otherwise considered by some to amount to theft (of bandwidth).
To place your image, just type its URL. To be recognised as an image, it must have one of the following extensions: .jpg, .jpeg, .gif, .png. Thus: ''www.example.com/image.jpg'' would place the image (with //default alignment// and //without// text wrapping)
Optionally you can align an image left, center or right using the | character (Shift \). Think of the | as representing the margin. So: ''|www.example.com/image.jpg'' would place the image aligned left (with text wrapping) ''|www.example.com/image.jpg|'' would place the image aligned centrally (//without// text wrapping) ''www.example.com/image.jpg|'' would place the image aligned right (with text wrapping)
==== Indented Blocks ====
Exactly as BulletedLists or NumberedLists, but omitting * or #.
example block 1
example block 2a
example block 2b
example block 1
example block 2a example block 2b
==== Horizontal Lines ====
Type four or more hyphens //on their own line//.
example: ----
Some text
----
and here's some text after the line
==== Preformatted Text ====
Although the wiki will honor single line breaks you put in, your browser will ignore multiple line breaks or spaces. Also, it is rare for web pages to show in a non-proportional font like this which you may want to use:.
For example, this was the original way of creating a table because all the characters will stay aligned in columns.
To achieve an 'exactly as you typed' effect, you need to use preformatted text. The text will typically appear in a non-proportional font.
To do this, enclose the text in two sets of curly braces '' {{}} ''.
{{
ex
amp
le
}}
And here's a simple table:
Profit Enjoyment
Merchant banker 98 20
Professional gambler 7 50
Furniture maker -20 3
Bank robber 274 19
You need to add spacing yourself in the table (since it's converted to a non-proportional font).
You would also use this for entering Source Code (like a bash shell script) to make it different from "normal" text. However, if you use enter source code, watch that some syntax does not affect the formatting. For instance the double square bracket used in bash '' [ [ '' must have six single quotes (') between the first square bracket and the second or it hides the contents (see "Hidden Comments" further down on this page). You may run into other challenges as well, so carefully review code (and likewise, don't completely trust code displayed in the wiki and blindly copy and run it!).
==== Clear Margins ====
When you have text wrapping around pictures, you may want to start a new line from the margin, clear of any picture.
To do this type two backslashes ''/ /'' on their own line:
\\
==== Hidden Comments ====
It is unlikely you will need these - they are mainly for internal use.
Enclose text in two sets of square brackets ''[ [ ] ]''. Text will be saved but will not show up in the browser.
(Although Tim does use these in words he really dorsn't want to be seen as Camel Case on some of these pages. The only problem with that is that pages can be format viewing or it can be formatted for editing.)
**NOTE**: This is how I was able to add CamelCase words on this page. By inserting the ''[ [ ] ]'' between the words Camel and Case, it now shows up correctly.