Differences

This shows you the differences between two versions of the page.

--- wiki:syntax [2015/08/23 13:57] – external edit 127.0.0.1
+++ wiki:syntax [2016/01/08 20:47] – knome
@@ Line 1: / Line 1: @@
 ====== Formatting Syntax ======
-[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all 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:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.
+[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.
 ===== Basic Text Formatting =====
-DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
+^ Purpose       ^ Syntax                                        ^ Produces                 ^
+| Bold          | ''<nowiki>**bold**</nowiki>''                 | **bold**                 |
+| Italic        | ''<nowiki>//italic//</nowiki>''               | //italic//               |
+| Underlined    | ''<nowiki>__underline__</nowiki>''            | __underline__            |
+| Monospace     | ''<nowiki>''monospace''</nowiki>''            | ''monospace''            |
+| Subscript     | ''<nowiki><sub>sub</sub>script</nowiki>''     | <sub>sub</sub>script     |
+| Superscript   | ''<nowiki><sup>super</sup>script</nowiki>''   | <sup>super</sup>script   |
+| Strikethrough | ''<nowiki><del>strikethrough</del></nowiki>'' | <del>strikethrough</del> |
-  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
+**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.
-  Of course you can **__//''combine''//__** all these.
-You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-You can mark something as <del>deleted</del> 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.
 ===== Links =====
-DokuWiki supports multiple ways of creating links.
+^ Purpose                  ^ Syntax                                          ^ Produces                   ^
+| Manual link              | ''<nowiki>[[syntax]]</nowiki>''                 | [[syntax]]                 |
-==== External ====
+| Manual link with text    | ''<nowiki>[[syntax|something else]]</nowiki>''  | [[syntax|something else]]  |
+| Automatic external link  | ''<nowiki>http://xubuntu.org/</nowiki>''        | http://xubuntu.org/        |
-External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too.
+| Email link               | ''<nowiki><noreply@example.com></nowiki>''      | <noreply@example.com>      |
+| Launchpad user/team link | ''<nowiki>[[lphome>xubuntu-team]]</nowiki>''    | [[lphome>xubuntu-team]]    |
-  DokuWiki supports multiple ways of creating links. External links are recognized
+| Ubuntu wiki link         | ''<nowiki>[[ubuntu>ReleaseSchedule]]</nowiki>'' | [[ubuntu>ReleaseSchedule]] |
-  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 [[pagename|link text]].
-  Internal links are created by using square brackets. You can either just give
-  a [[pagename]] or use an additional [[pagename|link text]].
-[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
-You can use [[some: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 [[doku>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 [[syntax#internal|this Section]].
-  This links to [[syntax#internal|this Section]].
-Notes:
-  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.
-  * DokuWiki does not use [[wp>CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki 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 ====
-DokuWiki 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]].
-  DokuWiki 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 [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>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 [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|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 [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]): <code - conf/lang/en/lang.php>
-<?php
-/**
- * Customization of the english language file
- * Copy only the strings that needs to be modified
- */
-$lang['js']['nosmblinks'] = '';
-</code>
 ==== Image Links ====
@@ Line 113: / Line 46: @@
 ===== 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.
+You can use up to five different levels of headlines to structure your content.
 ==== Headline Level 3 ====
@@ Line 164: / Line 97: @@
 For linking an image to another page see [[#Image Links]] above.
-==== 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
@@ Line 181: / Line 103: @@
 {{wiki:dokuwiki-128.png?linkonly}} 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'', DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
-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 =====
@@ Line 221: / Line 131: @@
 Also take a look at the [[doku>faq:lists|FAQ on list items]].
-===== 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 ====
-DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
-  * 8-) %%  8-)  %%
-  * 8-O %%  8-O  %%
-  * :-( %%  :-(  %%
-  * :-) %%  :-)  %%
-  * =)  %%  =)   %%
-  * :-/ %%  :-/  %%
-  * :-\ %%  :-\  %%
-  * :-? %%  :-?  %%
-  * :-D %%  :-D  %%
-  * :-P %%  :-P  %%
-  * :-O %%  :-O  %%
-  * :-X %%  :-X  %%
-  * :-| %%  :-|  %%
-  * ;-) %%  ;-)  %%
-  * ^_^ %%  ^_^  %%
-  * :?: %%  :?:  %%
-  * :!: %%  :!:  %%
-  * LOL %%  LOL  %%
-  * FIXME %%  FIXME %%
-  * DELETEME %% DELETEME %%
 ==== Text to HTML Conversions ====
@@ Line 435: / Line 314: @@
 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:
-<code>
-<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>
-</code>
-<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>
-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**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.
 ===== RSS/ATOM Feed Aggregation =====