Video Document - wiki: syntax

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

Footnotes

You can add footnotes ((This is a footnote)) 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 ''<nowiki>~~NOTOC~~</nowiki>'' in the document.

Headline Level 3

Headline Level 4

Headline Level 3

Headline Level 4

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

----

Media Files

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

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

Supported Media Formats

DokuWiki 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

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 source:

Video source:

Additionally DokuWiki 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

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

- The same list but ordered

- Another item

- Just use indention for deeper levels

- That's it

<code>

- The same list but ordered

- Another item

- Just use indention for deeper levels

- That's it

</code>

Text Conversions

DokuWiki 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

Text to HTML Conversions

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)

"He thought 'It's a man's world'..."

<code>

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)

"He thought 'It's a man's world'..."

</code>

Quoting

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

<code>

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

</code>

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

Tables

DokuWiki 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 ''<nowiki>%%</nowiki>''.

<nowiki>

formatting

</nowiki>

The same is true for %%//__this__ text// with a smiley ;-)%%.

<nowiki>

formatting

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

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

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

<code java>

*/

class HelloWorldApp {

public static void main(String[] args) {

System.out.println("Hello World!"); //Display the string.

}

}

</code>

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:

<code>

<file php myexample.php>

<?php echo "hello world!"; ?>

</file>

</code>

<file php myexample.php>

<?php echo "hello world!"; ?>

</file>

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

HTML example:

<code>

This is some <span style="color:red;font-size:150%;">inline HTML</span>

<HTML>

<p style="border:2px dashed red;">And this is some block HTML

</HTML>

</code>

This is some <span style="color:red;font-size:150%;">inline HTML</span>

<HTML>

<p style="border:2px dashed red;">And this is some block HTML

</HTML>

PHP example:

<code>

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

</code>

<php>

echo 'The PHP version: ';

echo phpversion();

echo ' (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>

Please Note

RSS/ATOM Feed Aggregation

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

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

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

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

Control Macros

Some syntax influences how DokuWiki 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~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |

Syntax Plugins

~~INFO:syntaxplugins~~