wiki:syntax

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
wiki:syntax [2024/03/31 16:47] – andiwiki:syntax [2026/08/13 18:56] (current) – external edit 127.0.0.1
Line 9: Line 9:
   DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.   DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
   Of course you can **__//''combine''//__** all these.   Of course you can **__//''combine''//__** all these.
 +
 +Note that the formatting markers have to directly enclose the text, so ''%%** bold **%%'' with spaces inside the markers will not be formatted.
  
 You can use <sub>subscript</sub> and <sup>superscript</sup>, too. You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
Line 27: Line 29:
   two backslashes are only recognized at the end of a line\\   two backslashes are only recognized at the end of a line\\
   or followed by\\ a whitespace \\this happens without it.   or followed by\\ a whitespace \\this happens without it.
- 
  
 You should use forced newlines only if really needed. You should use forced newlines only if really needed.
- 
  
 ===== Links ===== ===== Links =====
Line 44: Line 44:
   link text as well: [[http://www.google.com|This Link points to google]]. Email   link text as well: [[http://www.google.com|This Link points to google]]. Email
   addresses like this one: <andi@splitbrain.org> are recognized, too.   addresses like this one: <andi@splitbrain.org> are recognized, too.
- 
  
 ==== Internal ==== ==== Internal ====
Line 70: Line 69:
   * 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.   * 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.   * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
- 
  
 ==== Interwiki ==== ==== Interwiki ====
Line 88: Line 86:
  
   * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone").   * 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]]):  +  * 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>
- +
-<code - conf/lang/en/lang.php>+
 <?php <?php
 /** /**
Line 97: Line 93:
  */  */
 $lang['js']['nosmblinks'] = ''; $lang['js']['nosmblinks'] = '';
- 
 </code> </code>
- 
  
 ==== Image Links ==== ==== Image Links ====
Line 123: Line 117:
 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. 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 2 +==== Headline Level 3 ==== 
-=== Headline Level 3 +=== Headline Level 4 === 
-==== Headline Level 4 +== Headline Level 5 ==
-===== Headline Level 5+
  
-  == Headline Level 2 +  ==== Headline Level 3 ==== 
-  === Headline Level 3 +  === Headline Level 4 === 
-  ==== Headline Level 4 +  == Headline Level 5 ==
-  ===== Headline Level 5+
  
 By using four or more dashes, you can make a horizontal line: By using four or more dashes, you can make a horizontal line:
Line 166: Line 158:
   {{wiki:dokuwiki-128.png }}   {{wiki:dokuwiki-128.png }}
   {{ wiki:dokuwiki-128.png }}   {{ wiki:dokuwiki-128.png }}
 +
 +You can also set the alignment explicitly with a ''?left'', ''?right'' or ''?center'' parameter. This takes precedence over the whitespace alignment above and can be combined with a size.
 +
 +{{wiki:dokuwiki-128.png?100&right}}
 +
 +  {{wiki:dokuwiki-128.png?100&right}}
  
 Of course, you can add a title (displayed as a tooltip by most browsers), too. Of course, you can add a title (displayed as a tooltip by most browsers), too.
Line 174: Line 172:
  
 For linking an image to another page see [[#Image Links]] above. For linking an image to another page see [[#Image Links]] above.
- 
  
 ==== Supported Media Formats ==== ==== Supported Media Formats ====
Line 183: Line 180:
 | Video | ''webm'', ''ogv'', ''mp4'' | | Video | ''webm'', ''ogv'', ''mp4'' |
 | Audio | ''ogg'', ''mp3'', ''wav''  | | 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. If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
Line 192: Line 189:
  
 {{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image. {{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image.
- 
  
 ==== Fallback Formats ==== ==== Fallback Formats ====
Line 205: Line 201:
  
 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. 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 ===== ===== Lists =====
Line 221: Line 216:
   - That's it   - That's it
  
-```+<code>
   * This is a list   * This is a list
   * The second item   * The second item
Line 231: Line 226:
     - Just use indention for deeper levels     - Just use indention for deeper levels
   - That's it   - That's it
-```+</code>
  
 Also take a look at the [[doku>faq:lists|FAQ on list items]]. Also take a look at the [[doku>faq:lists|FAQ on list items]].
- 
  
 ===== Text Conversions ===== ===== Text Conversions =====
Line 482: Line 476:
 | %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created | | %%~~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 | | %%~~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 ===== ===== Syntax Plugins =====
  • wiki/syntax.1711903646.txt.gz
  • Last modified: 2024/03/31 16:47
  • by andi