LORE: About Markup Blocks

About Markup Blocks

(No modification info.)

Documentation for Wiki Markup: Blocks.

1. Code:

Any lines between [code] and [/code] are formatted with pragmatic syntax hi-lighting.

Example: [code]if ( $this eq $that ) { print "yes!\n"; }[/code]

Result:

if ( $this eq $that ) { print "yes!\n"; }

jump to top

2. List:

By prefixing each line in a block of text with an asterisk (*), the number one (1) or any of the following three letters 'i', 'a' or 'A'; the block will be converted into a list. The format of the list is governed by the prefix character. To make sublists, start the next line off with the same character but add another of the valid characters to it. See the usage example for a much clearer picture. Note that lines with invalid prefixes are not included in the list and are simply discarded on page view. The only difference between using the [list] [/list] block markers and an implied list is user preference.

Example: [list]* this is an unordered list
*1 This is an ordered sublist
*1i This is an (roman) ordered subsublist 1
*1i This is an (roman) ordered subsublist 2
*1i This is an (roman) ordered subsublist 3
*1a This is an (alpha) ordered subsublist 1
*1a This is an (alpha) ordered subsublist 2
*1A This is an (alpha) ordered subsublist 3
[/list]

Result:

this is an unordered list
1. This is an ordered sublist
  1. This is an (roman) ordered subsublist 1
  2. This is an (roman) ordered subsublist 2
  3. This is an (roman) ordered subsublist 3
  1. This is an (alpha) ordered subsublist 1
  2. This is an (alpha) ordered subsublist 2
  1. This is an (alpha) ordered subsublist 3

jump to top

3. Pre:

Any lines between [pre] and [/pre] are HTML escaped and placed inside pre tags of the "PRE" class.

Example: [pre] This is a test of the preformatting
regular expressions. These lines
should all be nicely held together.[/pre]

Result:

  This is a test of the preformatting
  regular   expressions. These  lines
  should all be nicely held together.

jump to top

4. No Markup:

Any lines between [no] and [/no] are place inside of a simple box and the content does not get the wiki markup applied.

Example: [no]This *text* \should\ ^look^ |funny|.[/no]

Result: This *text* \should\ ^look^ |funny|.

jump to top

5. Box Markup:

Any lines between [box] and [/box] are processed for more markup and placed inside of a simple box.

Example: [box]This text should be in a box.[/box]

Result:

This text should be in a box.

jump to top

6. Teletype:

Any lines between [tt] and [/tt] are formatted as teletype text.

Example: [tt]This text is in teletype format.[/tt]

Result: This text is in teletype format.

jump to top

7. Big:

Any lines between [big] and [/big] are formatted as text in a bigger font.

Example: [big]This text is in BIG format.[/big]

Result: This text is in BIG format.

jump to top

8. Small:

Any lines between [small] and [/small] are formatted as text in a smaller font.

Example: [small]This text is in small format.[/small]

Result: This text is in small format.

jump to top

9. Paragraph:

Any lines between [p] and [/p] are formatted as the text of a paragraph.

Example: [p]This text is in it's own paragraph.[/p]

Result:

This text is in it's own paragraph.

jump to top

10. Left Aligned:

Any lines between [l] and [/l] are left aligned.

Example: [l]This text is left aligned.[/l]

Result:

This text is left aligned.

jump to top

11. Right Aligned:

Any lines between [r] and [/r] are right aligned.

Example: [r]This text is right aligned.[/r]

Result:

This text is right aligned.

jump to top

12. Justify Aligned:

Any lines between [j] and [/j] are justified.

Example: [j]This text is justified.[/j]

Result:

This text is justified.

jump to top

13. Center Aligned:

Any lines between [c] and [/c] are centered.

Example: [c]This text is centered.[/c]

Result:

This text is centered.

jump to top

14. Block Bold:

Any lines between [b] and [/b] are marked bold.

Example: [b]This text is bolded.[/b]

Result: This text is bolded.

jump to top

15. Block Italic:

Any lines between [i] and [/i] are marked italic.

Example: [i]This text is italic.[/i]

Result: This text is italic.

jump to top

16. Block Underscore:

Any lines between [u] and [/u] are marked italic.

Example: [u]This text is underlined.[/u]

Result: This text is underlined.

jump to top

17. Block Insert:

Any lines between [ins] and [/ins] are marked italic.

Example: [ins]This text is underlined.[/ins]

Result: This text is underlined.

jump to top

18. Block Strike:

Any lines between [strike] and [/strike] are marked with a line through them. This has been deprecated in favour of [DEL].

Example: [strike]This text is striken.[/strike]

Result: ~~This text is striken.~~

jump to top

19. Block Delete:

Any lines between [del] and [/del] are marked with a line through them.

Example: [del]This text is striken.[/del]

Result: ~~This text is striken.~~

jump to top

20. Block Quote:

Any lines between [q] and [/q] are quoted using locale specific quotation marks.

Example: [q]This text is quoted in nicely.[/q]

Result: This text is quoted in nicely.

jump to top

21. Drop Cap:

Any letter between [dropcap] and [/dropcap] is given the appearance of a dropped cap for artistic purposes.

Example: [dc]T[/dc]his text has a dropped cap next to it.
You have to be particularly careful that there is enough text.
This also doesn't work well with bulleted lists.

Result: This text has a dropped cap next to it.
You have to be particularly careful that there is enough text.
This also doesn't work well with bulleted lists.

jump to top

22. Coloured:

Any lines between [c=colour] and [/c] are coloured according to the colour specified in the block start.

Example: [c=green]This text is green![/c]

Result: This text is green!

jump to top

23. Highlight:

Any lines between [h=colour] and [/h] are empasized with a background yellow, or the colour given in the block start.

Example: [h=green]This text has a green background![/h]

Result: This text has a green background!

jump to top

24. Table:

Any lines between [table] and [/table] are formatted in a table layout. This block syntax supports the following options: noimplied = Only block markup is allowed in table cells. noheader = Do not make the first like the table header. noaltrow = Do not make the rows alternate colours. noframe = Do not use a border around the entire table. colour:arg = Make the rows be the colour specified (hex or name) when noaltrow is used. oddcolour:arg = Make the odd-numberd rows be the colour specified (hex or name). evencolour:arg = Make the even-numberd rows be the colour specified (hex or name). align:arg = Table alignment. arg can be one of 'left', 'center', 'right'. width:arg = Table width. arg can be a percentage or a number. cell:arg = Cell alignment. arg can be one of 'left', 'center', 'right'.

Example: [table]
The First || Line Is || For Headings
Everything else || after the || first line
are more || rows in || the table.
Each cell is || separated || by two vertical
bars (aka pipes)|| Any space || before and after
all cell data is|| removed || before being used
in the HTML. || || Empty cells work
*and* so _does_ || ^all the^ || |WikiMarkup|.
[/table][table=align:right;noheader;cell:center]
The First || Line Is || For Headings
Everything else || after the || first line
are more || rows in || the table.
Each cell is || separated || by two vertical
bars (aka pipes)|| Any space || before and after
all cell data is|| removed || before being used
in the HTML. || || Empty cells work
*and* so _does_ || ^all the^ || |WikiMarkup|.
[/table]

Result:

The First	Line Is	For Headings
Everything else	after the	first line
are more	rows in	the table.
Each cell is	separated	by two vertical
bars (aka pipes)	Any space	before and after
all cell data is	removed	before being used
in the HTML.		Empty cells work
and so does	^{all the}	_{Wiki Markup}.

The First	Line Is	For Headings
Everything else	after the	first line
are more	rows in	the table.
Each cell is	separated	by two vertical
bars (aka pipes)	Any space	before and after
all cell data is	removed	before being used
in the HTML.		Empty cells work
and so does	^{all the}	_{Wiki Markup}.

jump to top