bLADE Wiki: Formatting

Make your notes all pretty looking! 

Wiki markup

When you are in Edit mode you use special "wiki markup" to tell the wiki how to format your notes.

This has been created with a couple of ideas in mind:

  • obvious - easy to remember
  • quick - easy to enter

Wiki markup - the basic idea 

Inline markup - formatting a bit of text 

Inline markup is applied by surrounding the text to be formatted with the relevent special characters.  

For example, to make something bold, you surround it with * (emphasising it)

The following text is *bold*

In View mode, this will be displayed with bold text:

Paragraph formatting - formatting a whole paragraph

Paragraph markup is applied by starting a line with the relevent special characters. 

For example, to make text into a heading, start the line with a +

+This is a heading

When you switch back to View mode, it will be displayed as a heading. 

What if you don't want the formatting - you want the actual markup characters?

The way to handle this varies between the different markup types, but in general:

  • inline formatting (e.g. bold) - use two of the markup characters next to each other   ("escaping")
  • paragraph formatting (e.g. heading) - put a space before the  character at the start of the line

 For example:

    This ** is not bold - it's actually an asterisk

     +This is not a heading - cos of the space

 

looks like this:

Being 'smart'er about applying inline wiki markup

"Smart syntax" changes the way that wiki markup is used.  If you enable smart syntax, for markup to be recognised, it must:

  • Have whitespace immediately before
  • The wiki markup character
  • Some non-whitespace text
  • The wiki markup character
  • Some whitespace immediately after

For example, this would be recognised as being bold:

    *I am bold*

but these would all ignored by the parser and be shown as the characters:

    blah*Writing before stops this one
    Writing after stops this*blah
    * Space at the start stops this
    Space at the end stops it *

The idea of "smart" syntax is to make it harder for syntax to be applied unintentionally. (Based on the assumption that if the wiki characters are not immediately surrounding text, then they are probably not trying to format text).

This behaviour can be enabled or disabled in Preferences.

What if you don't want the formatting at all?

No formatting for a bit of the page... 

If you want to ignore all formatting for a chunk of text, surround it with [{ and }]. For example:

normal here [{ blah blah blah
 blah * blah - blah = ignore _ all * of - these
blingy *not bold* }] back to normal here!

This is useful when copying and pasting large amounts of text into a wiki page, and you don't want to have to go through it escaping  (adding another - see above) all of the wiki markup characters.

No formatting... ever! 

You can use Preferences to disable an individual type of markup - e.g. bold. 

If you do that, asterisk (*) characters will never be interpreted as bold.