Pergamon Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Mystic Help ======

==== MarkDown Formatting Language ====

Various areas of Mystic support the MarkDown formatting language. This language allows you to enter codes into normal plain-text which are not confusing when read as plain text, but which can be interpreted by the Mystic MarkDown interpreter to display the text in a more style formation - such as with headings, indents, bullet points etc.

----

==== MarkDown Layout Conventions =====

=== Double-Spacing ===

One of the most basic conventions is to use double-spacing between your paragraphs (or certain MarkDown codes which should exist on a separate line, rather than embeded in the text - see below).

=== Single-Spacing ===

If you type a series of consecutive lives, all lines are displayed as if they were typed in a continuous paragraph (other than line-break, see below).

=== Additional Spacing ===

In most cases,  multiple empty lines are crushed down to a single line.

In order to force additional spacing in an article, ensure that the empty line consists of a single space character (see line-breaks, below).

----
==== Notation (separate lines) ====

=== Horizontal Rule ===

Placing [a minimum of] three hyphens, asterisks or underscores on a line **by themselves** translates to a horizontal rule which can be used to divide sections of your document. 

We recommend using three hyphens as this is the more natural appearing in raw-text.

Typing - - - (no spaces) results in:

----


==== Notation (line affixes) ====

=== Header ===

By placing a **'#'** (hash) symbol followed by a space at the begining of a line of text, the line is displayed as a header. 

Adding multiple hashes (e.g. '## ', '### ' etc.) will represent various levels of header, such as a sub-header and so on. 

Most style-sheets implemented in Mystic support **three levels** of header, to a maximum of six.

=== Headers using underlines ===

As an alternative, Main Headers can be added by following a conventional line (with a trailing space) with at least two '=' (equals) symbols.

Similarly, a sub-header can be added by following a conventional line (with a trailing space) with at least two '-' (hyphen) symbols.

*Note: This method is only available for the first two levels of headers.*

=== Line Breaks ===

Ending a line with a **space** will create a line-break in the paragraph and force the next text onto a separate line.

Lines added after a line-break do not need to be double-spaced.

A line-break can also be forced *within* a continuous paragraph by adding the HTML notation of **<br>** and continuing to type on the same line. This notation however, results in the text clearly containing format notation and is harder to read.

=== Indents & Blockquotes ===

By placing a **'>'** (greater-than) symbol followed by a space at the beginning of a line of text, the line is indented or placed in block-quotes.

> This is indented.

Additional symbols can be added (e.g. '>>') to increase the indentation.

=== Lists ===

By placing a **'-'** (hyphen) symbol followed by a space, or a **number** followed by a dot and space at the beginning of a line of text, the line is incorporated into an unordered or numbered list.

  * Unordered item
  * Unordered item
    * Unordered item

  1. Ordered item
  2. Ordered item

Note that:
- Items should be placed on consecutive lines (not double-spaced)
- The first non-hyphen or non-numbered line in a sequence is regarded as an end to current list.
- Nested lists can be created by prefixing the **-** or *number* with a space.
- Lists of the other type can be nested within a ongoing list, as long as a continuous list sequence is not broken.
- *Any* number can be used in ordered lists (even the same, repeating number) but it is best to use ordered numbers so that the text can be viewed correctly in its raw form.

==== Notation (in-line) ====

A range of formatting can be added in-line in order to provide emphasis to words and phrases.

In all cases (unless otherwise stated), the same code should both **prefix** and **suffix** the word or phrase being emphasised.

- &#x2a;&#x2a; bold &#x2a;&#x2a; becomes **bold** 
- &#x2a; italic &#x2a; becomes *italic* 
- &#x2a;&#x2a;&#x2a; bold and italic &#x2a;&#x2a;&#x2a; becomes both ***bold and italic*** 
- &#x2d;&#x2d; strikethrough &#x2d;&#x2d; becomes --strikethrough-- 
- &#x60;code&#x60; (the grav or backtick) becomes `code` 

*Note: If so desired, the underscore can be used to replace the asterisk.*

----

{{:logo.png?nolink |}}\\
[[:pergamonmystic:linkedhelp|Mystic Linked Help Files]]\\
[[:start|Pergamon Wiki Home]]
Pergamon Wiki

User Tools

Site Tools

Page Tools
