Wiki SaxnIT

User Tools

Site Tools

Trace:
wiki:syntax

Differences

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

Link to this comparison view

Next revision		Previous revision
wiki:syntax [2025/11/22 20:24] – created - external edit 127.0.0.1wiki:syntax [2026/04/26 10:34] (current) – [Lists] janw
Line 1: Line 1:
-====== Formatting Syntax ======+# 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". If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.
  
-===== Basic Text Formatting =====+## Basic Text Formatting ##
  
 DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these. DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
Line 29: Line 29:
  
 You should use forced newlines only if really needed. You should use forced newlines only if really needed.
 +
 +===== Advanced Text Formatting =====
 +
 +++++ You can fold paragraphs |
 +  By with  `++++ You can fold paragraphs |` and `++++`
 +++++
 +\\
 +
 +==== PlantUML ====
 +
 +You can can create UML diagrams with syntax you can learn here [[https://plantuml.com/de/]]
  
 ===== Links ===== ===== Links =====
Line 84: Line 95:
  
   * 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 php conf/lang/en/lang.php>
 <?php <?php
 /** /**
Line 92: Line 106:
 $lang['js']['nosmblinks'] = ''; $lang['js']['nosmblinks'] = '';
 </code> </code>
 +
  
 ==== Image Links ==== ==== Image Links ====
Line 114: Line 129:
  
 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 4
 +##### Headline Level 5
  
-==== Headline Level 3 ==== +  ### Headline Level 3 
-=== Headline Level 4 === +  #### Headline Level 4 
-== Headline Level 5 ==+  ##### Headline Level 5
  
-  ==== Headline Level 3 ==== +By using four or more dashes `----`, you can make a horizontal line:
-  === Headline Level 4 === +
-  == Headline Level 5 == +
- +
-By using four or more dashes, you can make a horizontal line:+
  
 ---- ----
  
-===== Media Files =====+## Media Files ##
  
 You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them. You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them.
Line 165: Line 179:
 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 ###
  
 DokuWiki can embed the following media formats directly. DokuWiki can embed the following media formats directly.
Line 193: Line 207:
  
 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 =====+
  
 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. 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.
  
-  * This is a list +#### unordered List ####
-  * The second item +
-    * You may have different levels +
-  * Another item+
  
-  - The same list but ordered +* This is a list 
-  - Another item +* The second item 
-    - Just use indention for deeper levels +  * You may have different levels 
-  - That's it+* Another item  
 + 
 +#### ordered List #### 
 + 
 +1. The same list but ordered 
 +2. Another item  
 +  1. Just use indention for deeper levels  
 +3. That's it 
  
 <code> <code>
 +
   * This is a list   * This is a list
   * The second item   * The second item
     * You may have different levels     * You may have different levels
-  * Another item +  * Another item  
- +   
-  - The same list but ordered +  1. The same list but ordered  
-  - Another item +  2. Another item  
-    - Just use indention for deeper levels +    1. Just use indention for deeper levels  
-  - That's it+  3. That's it  
 +    
 </code> </code>
  
Line 258: Line 277:
 Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)+-> <- <-> => <= <=> -- --- 640x480 (c) (tm) (r)
 "He thought 'It's a man's world'..." "He thought 'It's a man's world'..."
  
-<code> +``` 
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)+-> <- <-> => <= <=> -- --- 640x480 (c) (tm) (r)
 "He thought 'It's a man's world'..." "He thought 'It's a man's world'..."
-</code>+```
  
 The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]]. The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]].
Line 278: Line 297:
  
 > No we shouldn't > No we shouldn't
- 
->> Well, I say we should 
- 
-> Really? 
- 
->> Yes! 
- 
->>> Then lets do it! 
 </code> </code>
  
 I think we should do it I think we should do it
- 
 > No we shouldn't > No we shouldn't
  
->> Well, I say we should 
- 
-> Really? 
- 
->> Yes! 
- 
->>> Then lets do it! 
  
 ===== Tables ===== ===== Tables =====
wiki/syntax.1763839479.txt.gz · Last modified: by 127.0.0.1