wiki:syntax

Differences

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

Link to this comparison view

Next revision		 Previous revision
Last revisionBoth sides next revision
wiki:syntax [2020/07/29 11:35] – external edit 127.0.0.1wiki:syntax [2024/03/31 18:47] – andi
Line 27: Line 27:
   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 42: 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 67: Line 70:
   * 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 84: Line 88:
  
   * 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]]): <code - conf/lang/en/lang.php>+  * 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 <?php
 /** /**
Line 91: Line 97:
  */  */
 $lang['js']['nosmblinks'] = ''; $lang['js']['nosmblinks'] = '';
 +
 </code> </code>
 +
  
 ==== Image Links ==== ==== Image Links ====
Line 115: Line 123:
 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 3 ==== +== Headline Level 2 
-=== Headline Level 4 === +=== Headline Level 3 
-== Headline Level 5 ==+==== Headline Level 4 
 +===== Headline Level 5
  
-  ==== Headline Level 3 ==== +  == Headline Level 2 
-  === Headline Level 4 === +  === Headline Level 3 
-  == Headline Level 5 ==+  ==== Headline Level 4 
 +  ===== 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 137: Line 147:
 Resize to given width and height((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)): {{wiki:dokuwiki-128.png?200x50}} Resize to given width and height((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)): {{wiki:dokuwiki-128.png?200x50}}
  
-Resized external image:           {{https://secure.php.net/images/php.gif?200x50}}+Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
   Real size:                        {{wiki:dokuwiki-128.png}}   Real size:                        {{wiki:dokuwiki-128.png}}
   Resize to given width:            {{wiki:dokuwiki-128.png?50}}   Resize to given width:            {{wiki:dokuwiki-128.png?50}}
   Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}   Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
-  Resized external image:           {{https://secure.php.net/images/php.gif?200x50}}+  Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
  
Line 164: Line 174:
  
 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 172: Line 183:
 | 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 181: Line 192:
  
 {{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 193: Line 205:
  
 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 208: Line 221:
   - That's it   - That's it
  
-<code>+```
   * This is a list   * This is a list
   * The second item   * The second item
Line 218: Line 231:
     - 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 247: Line 261:
   * ;-) %%  ;-)  %%   * ;-) %%  ;-)  %%
   * ^_^ %%  ^_^  %%   * ^_^ %%  ^_^  %%
 +  * m(  %%  m(   %%
   * :?: %%  :?:  %%   * :?: %%  :?:  %%
   * :!: %%  :!:  %%   * :!: %%  :!:  %%
Line 436: Line 451:
  
 If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. 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 ===== ===== RSS/ATOM Feed Aggregation =====
Line 496: Line 460:
 | author     | show item authors names | | author     | show item authors names |
 | date       | show item dates | | date       | show item dates |
-| description| show the item description. If [[doku>config:htmlok|HTML]] is disabled all tags will be stripped |+| description| show the item description. All HTML tags will be stripped |
 | nosort     | do not sort the items in the feed | | 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). | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |
Line 518: Line 482:
 | %%~~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.txt
  • Last modified: 2024/08/05 08:28
  • by 127.0.0.1