User Tools

Differences

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

Link to this comparison view

Next revision		Previous revision
wiki:syntax [2024/08/05 06:28] – created - external edit 127.0.0.1wiki:syntax [2025/05/15 09:12] (current) – add info about ad-hoc wrap shanes
Line 5: Line 5:
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
  
-DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.+The wiki supports a variety of text styles, which can be produced 
 +by wrapping text with markup:
  
-  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. +^ Style          ^ Markup                          ^ Example                 ^ 
-  Of course you can **__//''combine''//__** all these.+| Bold           | ''%%**example text**%%''        | **example text**        | 
 +| Italic         | ''%%//example text//%%''        | //example text//        | 
 +| Underline      | ''%%__example text__%%''        | __example text__        | 
 +| Superscript    | ''%%example<sup>text</sup>%%''  | example<sup>text</sup>  | 
 +| Subscript      | ''%%example<sub>text</sub>%%''  | example<sub>text</sub>  | 
 +| Strikethrough  | ''%%<del>example text</del>%%'' | <del>example text</del> | 
 +| Code           | ''%%''example text''%%''        | ''example text''        | 
 +| Variable       | ''%%<var>example text</var>%%'' | <var>example text</var> | 
 +| Keyboard Input | ''%%<kbd>example text</kbd>%%'' | <kbd>example text</kbd> | 
 +| Sample Output  | ''%%<samp>example text</samp>%%'' | <samp>example text</samp> | 
 +| Abbreviation   | ''%%<abbr "BridgeWire">BW</abbr>%%'' | <abbr "BridgeWire">BW</abbr> | 
 +| Definition     | ''%%<dfn>example text</dfn>%%'' | <dfn>example text</dfn> | 
 +| Highlight      | ''%%<mark>example text</mark>%%'' | <mark>example text</mark> |
  
-You can use <sub>subscript</sub> and <sup>superscript</sup>, too.+You can also combine styles by nesting their markup. For example, ''%%**//example text//**%%'' produces bold italic: **//example text//**.
  
-  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.+===== Paragraph Breaks =====
  
-You can mark something as <del>deleted</del> as well.+<dfn>Paragraphs</dfn> are created from blank lines. If you want to force a line break without a paragraph break, you can use two backslashes followed by a whitespace or the end of line.
  
-  You can mark something as <del>deleted</del> as well. +This is some text with some linebreaks.\\ Note that the
- +
-**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\\ 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.
  
-  This is some text with some linebreaks\\ Note that the+  This is some text with some linebreaks.\\ Note that the
   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 line breaks only if really needed.
  
 ===== Links ===== ===== Links =====
Line 74: Line 83:
   DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis.   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]].   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 ==== ==== Image Links ====
Line 361: Line 352:
  
 Note: Vertical alignment is not supported. Note: Vertical alignment is not supported.
 +
 +
 +===== Boxes =====
 +
 +You can separate some text from the main flow of the article by putting it in a styled box:
 +<div info>
 +You can put text in boxes like this. That's useful for warnings, hints, or anything else you want to draw special attention to.
 +
 +Boxes can contain multiple paragraphs, as well as most other kinds of wiki markup like links or lists.
 +</div>
 +
 +You do so by wrapping the content in a ''%%<div>%%'' tag with an extra keyword like so:
 +<code>
 +<div info>
 +You can put text in boxes like this. That's useful for warnings, hints, or anything else you want to draw special attention to.
 +
 +Boxes can contain multiple paragraphs, as well as most other kinds of wiki markup like links or lists.
 +</div>
 +</code>
 +
 +
 +There are six available box styles:
 +<div grid-2-columns>
 +<div info>''%%<div info>%%''</div>
 +<div tip>''%%<div tip>%%''</div>
 +<div important>''%%<div important>%%''</div>
 +<div alert>''%%<div alert>%%''</div>
 +<div outline>''%%<div outline>%%''</div>
 +<div box>''%%<div box>%%''</div>
 +</div>
 +
 +You can also use smaller boxes with the same styles inline in a paragraph by using a ''%%<span>%%'' tag instead of ''%%<div>%%''. For example, ''%%<span info>Helpful tip!</span>%%'' produces <span info>Helpful tip!</span>. However, inline boxes can only contain other markup that works inside a paragraph (e.g. bold or links), not markup that creates its own paragraphs like lists or tables.
  
 ===== No Formatting ===== ===== No Formatting =====