Formatting Syntax

Master Plan Direct uses a wiki inspired syntax to make your operations manual or website easy to edit and pleasant to view and print.

  • To start editing a user must only know a few simple rules. This makes it easy for a user to start editing in literally minutes. As a user gets more experienced more advanced syntax can be learned.
  • Why use a syntax at all? We asked ourselves that too. After trying a system that allowed Microsoft Word© style editing we ran across a big problem. Every page looked different! It began looking like the a stack of pages from a dozen different books. But with the syntax, every page matched. It looked perfect no matter who edited it.

Basic text formatting

You may use bold, italic, underlined and monospaced texts. Of course you can combine all these.

You may use **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use subscript and superscript, too.

You can use <sub>subscript</sub> and <sup>superscript</sup>, too.

You can mark something as deleted as well.

You can mark something as <del>deleted</del> as well.

Paragraphs are created from blank lines. If you want to force a newline without a paragraph, you can use two backslashes followed by a whitespace or the end of line.

This is some text with some linebreaks
Note that the two backslashes are only recognized at the end of a line
or followed by
a whitespace \\this happens without it.

This is some text with some linebreaks\\ Note that the
two backslashes are only recognized at the end of a line\\
or followed by\\ a whitespace \\this happens without it.

You should use forced newlines only if really needed.

Menu Items

Adding items to the menu is easy. The best way to learn to do this is to edit the menu and see what the current menu items look like.

++++Section Name |
      * [[Section name:Document name | Document Name]]
      * [[Section name:Document name | Document Name]]
++++

Links

There are multiple ways of creating links.

External

External links are recognized automagically: http://www.google.com or simply www.google.com - You can set Linknames, too: This Link points to google. Email addresses like this one: trevor@masterplandirect.com are recognized, too.

Master Plan Direct supports multiple ways of creating links. External links are recognized
automagically: http://www.google.com or simply www.google.com - You can set
Linknames, too: [[http://www.google.com|This Link points to google]]. Email
addresses like this one: <trevor@masterplandirect.com> are recognized, too.

Internal

Internal links are created by using square brackets. You can either just give a section and pagename or use an additional Title Text. Pagenames are converted to lowercase automatically, special characters are not allowed.

Internal links are created by using square brackets. You can either just give
a [[section:pagename]] or use an additional [[section:pagename|Title Text]]. Pagenames
are converted to lowercase automatically, special chars are not allowed.

Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to this Section.

This links to [[syntax#internal|this Section]].

Image Links

You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:

[[http://www.masterplandirect.com/|{{help_center:2006_06_11_045.jpg|}}]]

Please note: The image formatting is the only formatting syntax accepted in link names.

The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).

Footnotes

You can add footnotes 1) by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

Sectioning

You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically – this can be disabled by including the string ~~NOTOC~~ in the document.

Headline Level 3

Headline Level 4

Headline Level 5
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

By using four or more dashes, you can make a horizontal line:


Images and other files

You can include external and internal with curly brackets. Optionally you can specify the size of them.

Real size: 2006_06_11_045.jpg

Resize to given width: 2006_06_11_045.jpg

Resize to given width and height: 2006_06_11_045.jpg

Resized external image:

Real size:                        {{help_center:2006_06_11_045.jpg}}
Resize to given width:            {{help_center:2006_06_11_045.jpg?50}}
Resize to given width and height: {{help_center:2006_06_11_045.jpg?200x50}}
Resized external image:           {{help_center:2006_06_11_045.jpg?200x50}}

By using left or right whitespaces you can choose the alignment.

2006_06_11_045.jpg

2006_06_11_045.jpg

2006_06_11_045.jpg

{{ help_center:2006_06_11_045.jpg}}
{{help_center:2006_06_11_045.jpg }}
{{ help_center:2006_06_11_045.jpg }}

Of course, you can add a title (displayed as a tooltip by most browsers), too.

This is the caption

{{ help_center:2006_06_11_045.jpg |This is the caption}}

If you specify a filename (external or internal) that is not an image (gif, jpeg, png), then it will be displayed as a link instead.

For linking an image to another page see Image Links above.

Lists

Ordered and unordered lists are suported. To create a list item, indent your text by two spaces and use a * for unordered lists or a - for ordered ones.

  • This is a list
  • The second item
    • You may have different levels
  • Another item
  1. The same list but ordered
  2. Another item
    1. Just use indention for deeper levels
  3. That’s it
  * This is a list
  * The second item
    * You may have different levels
  * Another item

  - The same list but ordered
  - Another item
    - Just use indention for deeper levels
  - That's it

Smileys

Yes you can even include smilies!

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Typography

You can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought ‘It’s a man’s world’...”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Quoting

Some times you want to mark some text to show it’s a reply or comment. You can use the following syntax:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn’t
Well, I say we should
Really?
Yes!
Then lets do it!

Tables

Master Plan supports a simple syntax to create tables.

Heading 1 Heading 2 Heading 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 some colspan (note the double pipe)
Row 3 Col 1 Row 2 Col 2 Row 2 Col 3

Table rows have to start and end with a | for normal rows or a ^ for headers.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |

To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

Vertical tableheaders are possible, too.

Heading 1 Heading 2
Heading 3 Row 1 Col 2 Row 1 Col 3
Heading 4 no colspan this time
Heading 5 Row 2 Col 2 Row 2 Col 3

As you can see, it’s the cell separator before a cell which decides about the formatting:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

Note: Vertical spans (rowspan) are not possible.

You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.

Table with alignment
right center left
left right center
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

This is how it looks in the source:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Embedding HTML and PHP

You can embed raw HTML or PHP code into your documents by using the html or php tags like this:

 <html>
 This is some <font color="red" size="+1">HTML</font>
 </html>
 
 <html>
 This is some <font color="red" size="+1">HTML</font>
 </html>

 <code>
 <php>
 echo 'A logo generated by PHP:';
 echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
 </php>
 

<code>

 echo 'A logo generated by PHP:';
 echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
 

Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.

1) This is a footnote
Help Center/syntax · Last modified: 2007/08/15 01:45 by charlie
Recent changes RSS feed