TextFormattingRules

From X-Plane SDK

! Paragraphs

• Don't indent paragraphs
• Words wrap and fill as needed
• Use blank lines as separators
• Four or more minus signs make a horizontal rule
•  %%'% makes a linebreak (in headings and lists too)
• Use two %% signs in a row to escape the %%.
• ---- four dashes make a horizontal rule.

! Lists

• asterisk for first level
  • asterisk-asterisk for second level, etc.
• Use * for bullet lists, # for numbered lists (mix at will)
• semicolon-term-colon-definition for definition lists:

term here

definition here, as in the

list

• One line for each item
• Other leading whitespace signals preformatted text, changes font.

! Headings

• '!' at the start of a line makes a small heading
• '!!' at the start of a line makes a medium heading
• '!!!' at the start of a line makes a large heading

! Fonts

• Indent with one or more spaces to use a monospace font:

This is in monospace

This is not

!Indented Paragraphs

• semicolon-colon -- works like

this is an indented block of text

each line must have the semcolon and colon.

! Emphasis

• Use doubled single-quotes ('____') for emphasis (usually italics)
• Use doubled underscores (_'_) for strong emphasis (usually __bold__)
• Mix them at will: __bold italics__
• Emphasis can be used multiple times within a line, but cannot cross line boundaries:

this will not work

! References

• Hyperlinks to other pages within the Wiki are made by placing the page name in square brackets: [this is a page link] or UsingWikiWords (preferred)
• Hyperlinks to external pages are done like this: [1]
• You can name the links by providing a name, a bar (|) and then the hyperlink or pagename: [PhpWiki home page | http://phpwiki.sourceforge.net/] - [the front page | FrontPage]
• [1], [2], [3], [4] refer to remote references. Click EditLinks on the edit form to enter URLs. These differ from the newer linking scheme; references are unique to a page.
• Also, the old way of linking URL's is still supported: precede URLs with "http:", "ftp:" or "mailto:" to create links automatically as in: http://c2.com/
• URLs ending with .png, .gif, or .jpg are inlined if in square brackets, by themselves: [2]
• Use double square opening and one closing brackets to escape the [[ symbols ].

! HTML Mark-Up Language

• Don't bother
• < and > are themselves
• The & characters will not work
• If you really must use HTML, your system administrator can enable this feature. Start each line with a bar (|). Note that this feature is disabled by default.

! Special Constructions

A few special pre-formed constructions can be built. Each one is enclosed in two percent signs before and after the token:

• Search - creates a quick search by page title.
• Fullsearch - creates a search by full text context.
• Mostpopular - creates a list of the most popular pages by hitcount.
• Sitemap - creates a tree of the entire site.
• Recentchanges - creates a list of pages changed since the user's last login.
• Signup - makes the user signup form.
• Usertools - makes the user prefs box.

(The big list of recent changes with user names is not a special construction; the code that records page edits manually manipulates the Wiki text of the RecentChanges page.)