User Tools

Site Tools


syntax

Formatting Syntax

burnley.org supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains some possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing “Edit this page”. If you want to try something, just use the playground page. The simpler markup is easily accessible via quickbuttons, too.

Basic Text Formatting

burnley.org supports bold, italic, underlined and monospaced texts. Of course you can combine all these.

burnley.org supports **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.

burnley.org supports multiple ways of creating links.

External

External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: This Link points to google. Email addresses like this one: andi@splitbrain.org are recognized, too.

burnley.org supports multiple ways of creating links. External links are recognized
automagically: http://www.google.com or simply www.google.com - You can set
link text as well: [[http://www.google.com|This Link points to google]]. Email
addresses like this one: <andi@splitbrain.org> are recognized, too.

Internal

Internal links are created by using square brackets. You can either just give a pagename or use an additional link text.

Internal links are created by using square brackets. You can either just give
a [[pagename]] or use an additional [[pagename|link text]].

Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

You can use namespaces by using a colon in the pagename.

You can use [[some:namespaces]] by using a colon in the pagename.

For details about namespaces see namespaces.

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]].

Notes:

  • Links to existing pages are shown in a different style from nonexisting ones.
  • burnley.org does not use CamelCase to automatically create links by default, but this behavior can be enabled in the config file. Hint: If burnley.org is a link, then it's enabled.
  • When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.

Interwiki

burnley.org supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: Wiki.

burnley.org supports [[doku>Interwiki]] links. These are quick links to other Wikis.
For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].

Windows Shares

Windows shares like this are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate Intranet.

Windows Shares like [[\\server\share|this]] are recognized, too.

Notes:

  • For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the “local zone”).
  • For Mozilla and Firefox it can be enabled through different workaround mentioned in the Mozilla Knowledge Base. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in conf/lang/en/lang.php (more details at localization):
    conf/lang/en/lang.php
    <?php
    /**
     * Customization of the english language file
     * Copy only the strings that needs to be modified
     */
    $lang['js']['nosmblinks'] = '';

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://php.net|{{http://www.burnley.org/lib/tpl/dokuwiki/images/burnley.png}}]]

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 ==

Media Files

You can include external and internal images, videos and audio files with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height2):

Resized external image:

Real size:                        {{http://www.burnley.org/lib/tpl/dokuwiki/images/burnley.png}}
Resize to given width:            {{http://www.burnley.org/lib/tpl/dokuwiki/images/burnley.png?50}}
Resize to given width and height: {{http://www.burnley.org/lib/tpl/dokuwiki/images/burnley.png?200x50}}
Resized external image:           {{http://php.net/images/php.gif?200x50}}

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

{{ http://www.burnley.org/lib/tpl/dokuwiki/images/burnley.png}}
{{http://www.burnley.org/lib/tpl/dokuwiki/images/burnley.png }}
{{ http://www.burnley.org/lib/tpl/dokuwiki/images/burnley.png }}

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

This is the caption

{{ http://www.burnley.org/lib/tpl/dokuwiki/images/burnley.png |This is the caption}}

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

Supported Media Formats

burnley.org can embed the following media formats directly.

Image gif, jpg, png
Video webm, ogv, mp4
Audio ogg, mp3, wav
Flash swf

If you specify a filename that is not a supported media format, then it will be displayed as a link instead.

By adding ?linkonly you provide a link to the media without displaying it inline

{{wiki:burnley.org-128.png?linkonly}}

burnley.org-128.png This is just a link to the image.

Fallback Formats

Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.

For example consider this embedded mp4 video:

{{video.mp4|A funny video}}

When you upload a video.webm and video.ogv next to the referenced video.mp4, burnley.org will automatically add them as alternatives so that one of the three files is understood by your browser.

Additionally burnley.org supports a “poster” image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a video.jpg file would work.

Lists

burnley.org supports ordered and unordered lists. 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

Also take a look at the FAQ on list items.

Text Conversions

burnley.org can convert certain pre-defined characters or strings into images or other text or HTML.

The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.

Text to Image Conversions

burnley.org converts commonly used emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in burnley.org:

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

Text to HTML Conversions

Typography: burnley.org 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'..."

The same can be done to produce any kind of HTML, it just needs to be added to the pattern file.

There are three exceptions which do not come from that pattern file: multiplication entity (640×480), 'single' and “double quotes”. They can be turned off through a config option.

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

burnley.org 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 3 Col 2 Row 3 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 3 Col 2     | Row 3 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        |

You can have rowspans (vertically connected cells) by adding ::: into the cells below the one to which they should connect.

Heading 1 Heading 2 Heading 3
Row 1 Col 1 this cell spans vertically Row 1 Col 3
Row 2 Col 1 Row 2 Col 3
Row 3 Col 1 Row 2 Col 3

Apart from the rowspan syntax those cells should not contain anything else.

^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
| Row 2 Col 1    | :::                        | Row 2 Col 3        |
| Row 3 Col 1    | :::                        | Row 2 Col 3        |

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 |

Note: Vertical alignment is not supported.

No Formatting

If you need to display text exactly like it is typed (without any formatting), enclose the area either with <nowiki> tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. The same is true for //__this__ text// with a smiley ;-).

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for %%//__this__ text// with a smiley ;-)%%.

Code Blocks

You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags <code> or <file>.

This is text is indented by two spaces.
This is preformatted code all spaces are preserved: like              <-this
This is pretty much the same, but you could use it to show that you quoted a file.

Those blocks were created by this source:

  This is text is indented by two spaces.
<code>
This is preformatted code all spaces are preserved: like              <-this
</code>
<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

Syntax Highlighting

burnley.org can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. <code java> or <file java>.

/**
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

The following language strings are currently recognized: 4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch xbasic xml xojo xorg_conf xpp yaml z80 zxbasic

There are additional advanced options available for syntax highlighting, such as highlighting lines or adding line numbers.

Downloadable Code Blocks

When you use the <code> or <file> syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>
myexample.php
<?php echo "hello world!"; ?>

If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: <code - myfile.foo>.

Embedding HTML and PHP

You can embed raw HTML or PHP code into your documents by using the <html> or <php> tags. (Use uppercase tags if you need to enclose block level elements.)

HTML example:

<html>
This is some <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">And this is some block HTML</p>
</HTML>

This is some inline HTML

And this is some block HTML

PHP example:

<php>
echo 'The PHP version: ';
echo phpversion();
echo ' (generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';
</PHP>

echo 'The PHP version: '; echo phpversion(); echo ' (inline HTML)';

echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';

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

RSS/ATOM Feed Aggregation

burnley.org can integrate data from external XML feeds. For parsing the XML feeds, SimplePie is used. All formats understood by SimplePie can be used in burnley.org as well. You can influence the rendering by multiple additional space separated parameters:

Parameter Description
any number will be used as maximum number items to show, defaults to 8
reverse display the last items in the feed first
author show item authors names
date show item dates
description show the item description. If HTML is disabled all tags will be stripped
nosort do not sort the items in the feed
n[dhm] refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours).

The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. burnley.org will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells burnley.org to re-render the page if it is more than refresh period since the page was last rendered.

By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the reverse parameter, or display the feed as is with nosort.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Control Macros

Some syntax influences how burnley.org renders a page without creating any output it self. The following control macros are availble:

Macro Description
~~NOTOC~~ If this macro is found on the page, no table of contents will be created
~~NOCACHE~~ burnley.org caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force burnley.org to rerender a page on every call

imagebox Plugin

—- plugin —- description: Syntax for display an image with a caption, like Wikipedia.org

Description

This plugin displays an image with a caption, like Wikipedia.org

Example img

Example img

Example img

Usage

Just add [ ] around the image tag.

[{{ImagePath|Caption}}]

The caption can be formatted.

Configuration

The plugin can be configured within the admin panel.

display magnify

Display the click-enlarge icon:

  • If necessary
  • Always
  • Never

center align

default caption style

Default style for the image caption:

  • Normal
  • Italic
  • Bold

Columns Plugin

Basics

The minimal syntax is simply add two lines around your information and enter your column breaks.

First column text (50% width).

Second column text.

Third column text.

<columns 100% 50% - ->

First column text (50% width).

<newcolumn>

Second column text.

<newcolumn>

Third column text.

</columns>

The first attribute of the <columns> tag is the width of the column set. The following attributes are for the columns. If you do not want to specify a value for the table- or column-width use “-” instead.

The column breaks are specified with <newcolumn> tag, which may also take optional attributes described below. In the original plugin the breaks were specified with ~~NEWCOL~~ and for compatibility reasons it is still possible to configure the plugin to use this tag, but some of the newer features will be disabled.

Extended Syntax

Apart from the width, each column may have a number of additional attributes that specify formatting of the column contents. These attributes should be specified in front of the column width:

First column text.

Second column text.

<columns 100% first column attributes 50% second column attributes ->

First column text.

<newcolumn>

Second column text.

</columns>

With these extra attributes the columns declaration gets more and more cluttered. To prevent that you can specify column attributes in the <newcolumn> tag. In this case the order of the attributes and column width is not important:

First column text.

Second column text.

Third column text.

<columns 100% first column attributes 50%>

First column text.

<newcolumn second column 25% attributes>

Second column text.

<newcolumn>

Third column text.

</columns>

Column Alignment

By default the text in the columns is justified but alignment for each column can be specified explicitly. There are few ways to so. The most simple one is by adding asterisks on either side of the column width specification. The asterisk indicates non-justified side of the text block, so to achieve left alignment add the asterisk on the right side.

First column with justified text.

Second column is aligned on the left side.

Third column is center-aligned.

Fourth column is aligned on the right side.

<columns 100% 25% 25%* *-* *->

First column with justified text.

<newcolumn>

Second column is aligned on the left side.

<newcolumn>

Third column is center-aligned.

<newcolumn>

Fourth column is aligned on the right side.

</columns>

Alternatively the alignment can be specified with separate attributes. This approach allows to define both horizontal and vertical alignment. There are four attributes for horizontal alignment (left, center, right and justify) and three for the vertical (top, middle and bottom). There may be multiple alignment attributes per column:

First column is aligned on the left side.

Second column is aligned to the right-bottom corner.

<columns 100% left 50% right bottom ->

First column is aligned on the left side.

<newcolumn>

Second column is aligned to the right-bottom corner.

</columns>

All attributes can be abbreviated to the first letter, the single letter attributes may be merged together:

First column is aligned on the left side.

Second column is aligned to the right-bottom corner.

Simple alignment syntax is still supported. Contents of the third column is centered both ways.

<columns 100% l 50%>

First column is aligned on the left side.

<newcolumn rb>

Second column is aligned to the right-bottom corner.

<newcolumn m *-*>

Simple alignment syntax is still supported.
Contents of the third column is centered both ways.

</columns>

Headings

The headings within column sets are specified the using the standard DokuWiki syntax:

Heading

Content of the first column.

Content of the second column.

<columns 100% 50% ->

===== Heading =====

Content of the first column.

<newcolumn>

Content of the second column.

</columns>

By default plugin puts the content within a column without explicitly specifying the section level. This works fine when the entire column set belongs to a single section but can produce unexpected results when the headings are used within the set:

Level 1 Heading

Implicit level 1 content.

Level 2 Headline 1

Level 2 content.

Implicit level 1 content that should be in level 2 section.

Level 2 Headline 2

Level 2 content.

====== Level 1 Heading ======

<columns 100% 50% ->

Implicit level 1 content.

===== Level 2 Headline 1 =====

Level 2 content.

<newcolumn>

Implicit level 1 content that should be in level 2 section.

===== Level 2 Headline 2 =====

Level 2 content.

</columns>

You can force the beginning of the second column to be in level 2 by specifying continue attribute (or shorthand ...):

Level 1 Heading

Implicit level 1 content.

Level 2 Headline 1

Level 2 content.

Level 2 content.

Level 2 Headline 2

Level 2 content.

====== Level 1 Heading ======

<columns 100% 50% ->

Implicit level 1 content.

===== Level 2 Headline 1 =====

Level 2 content.

<newcolumn continue>

Level 2 content.

===== Level 2 Headline 2 =====

Level 2 content.

</columns>

DivAlign2 Plugin

Simple syntax used to align text or images.

Align Left:

This is aligned left.

Align Left:  

#;;
This is aligned left.
#;;

Align Right:

This is aligned right.

Align Right:

;;#
This is aligned right.
;;#

Align Center:

This is aligned center.

Align Center:

;#;
This is aligned center.
;#;

Align Justify:

This text is justified.

Align Justify:

###
This text is justified.
###

Syntax Plugins

burnley.org's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular burnley.org installation:

1)
This is a footnote
2)
when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing
syntax.txt · Last modified: 2020/12/28 09:55 by admin


- HOLD TO THE TRUTH -