User Tools

Site Tools


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 [2012/11/13 11:19]
legatum
wiki:syntax [2015/06/23 07:27] (current)
Line 1: Line 1:
 ====== Formatting Syntax ====== ====== Formatting Syntax ======
  
-Legatum Homeopathicum runs on [[doku>​DokuWiki]] ​engine and 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" ​button in the right upper part of the browser window. If you want to try something, just use the [[playground:​playground|playground]] page. +[[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.
- +
-The simpler markup is easily accessible via toolbar buttons too, so you are encouraged to use these as much as you can. Just select the text using your mouse or keyboard and click the toolbar button or hit the corresponding access key (hotkey) combination on the keyboard to achieve the same (Alt + Key). +
- +
-===== Toolbar Buttons =====  +
- +
-Most buttons have access keys assigned to them -- just press Alt button and a corresponding access key (see the table below). +
- +
-:!: If quickbuttons do not work with ALT, please refer to the [[doku>accesskeys|access keys page]] or to your browser manual to see how to use access keys. +
- +
-^ Button ​ ^ Key  ^ Function ​ ^ +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​bold.png?​nolink}} ​       |  ''​**b**'' ​ | Bold formatting | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​italic.png?​nolink}} ​     |  ''​**i**'' ​ | Italic formatting | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​underline.png?​nolink}} ​  ​| ​ ''​**u**'' ​ | Underlined formatting | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​mono.png?​nolink}} ​       |  ''​**c**'' ​ | Code formatting | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​strike.png?​nolink}} ​     |  ''​**d**'' ​ | Strike-through formatting | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​hequal.png?​nolink}} ​     |  ''​**8**'' ​ | Same level headline | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​hminus.png?​nolink}} ​     |  ''​**9**'' ​ | Lower headline | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​hplus.png?​nolink}} ​      ​| ​ ''​**0**'' ​ | Higher headline | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​h.png?​nolink}} ​          ​| ​            | Select headline | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​h1.png?​nolink}} ​         |  ''​**1**'' ​ | Level 1 headline (via '​Select headline'​ button) | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​h2.png?​nolink}} ​         |  ''​**2**'' ​ | Level 2 headline (via '​Select headline'​ button) | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​h3.png?​nolink}} ​         |  ''​**3**'' ​ | Level 3 headline (via '​Select headline'​ button) | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​h4.png?​nolink}} ​         |  ''​**4**'' ​ | Level 4 headline (via '​Select headline'​ button) | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​h5.png?​nolink}} ​         |  ''​**5**'' ​ | Level 5 headline (via '​Select headline'​ button) | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​link.png?​nolink}} ​       |  ''​**l**'' ​ | Internal link formatting (launches the Link Wizard) | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​linkextern.png?​nolink}} ​ |             | External link formatting | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​ol.png?​nolink}} ​         |  ''​**-**'' ​ | Ordered list item | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​ul.png?​nolink}} ​         |  ''​**.**'' ​ | Unordered list item | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​hr.png?​nolink}} ​         |             | Horizontal rule | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​image.png?​nolink}} ​      ​| ​            | [[media manager|Media Selectionincludes file/​attachment uploader]] | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​smiley.png?​nolink}} ​     |             | Smiley picker | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​chars.png?​nolink}} ​      ​| ​            | Character picker | +
-|  {{http://​www.dokuwiki.org/​lib/​images/​toolbar/​sig.png?​nolink}} ​        ​| ​ ''​**y**'' ​ | Signature (only when logged in)|+
  
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
Line 43: Line 10:
   Of course you can **__//''​combine''//​__** all these.   Of course you can **__//''​combine''//​__** all these.
  
-You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>,​ too. For example, Lyc.<​sup>​30</​sup>​ would be a good use.+You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>,​ too.
  
-  You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>,​ too. For example, Lyc.<​sup>​30</​sup>​ would be a good use.+  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.
Line 69: Line 36:
 ==== External ==== ==== External ====
  
-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: <info@legatum.sk> are recognized, too.+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.
  
   DokuWiki supports multiple ways of creating links. External links are recognized   DokuWiki supports multiple ways of creating links. External links are recognized
   automagically:​ http://​www.google.com or simply www.google.com - You can set   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   link text as well: [[http://​www.google.com|This Link points to google]]. Email
-  addresses like this one: <info@legatum.sk> are recognized, too.+  addresses like this one: <andi@splitbrain.org> are recognized, too.
  
 ==== Internal ==== ==== Internal ====
Line 98: Line 65:
  
   * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.   * 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.   * 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/​userscript.js'':​
 +
 +  LANG.nosmblinks = '';​
  
 ==== Image Links ==== ==== Image Links ====
Line 134: Line 122:
 ---- ----
  
-===== Images and Other Files =====+===== Media Files =====
  
-You can include external and internal [[doku>​images]] 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.
  
 Real size:                        {{wiki:​dokuwiki-128.png}} Real size:                        {{wiki:​dokuwiki-128.png}}
Line 169: Line 157:
  
   {{ wiki:​dokuwiki-128.png |This is the caption}}   {{ wiki:​dokuwiki-128.png |This is the caption}}
- 
-If you specify a filename (external or internal) that is not an image (''​gif,​ jpeg, png''​),​ then it will be displayed as a link instead. 
  
 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 ====
 +
 +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.
 +
 +==== 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 ===== ===== Lists =====
Line 440: Line 449:
 <​code>​ <​code>​
 <php> <php>
-echo 'A logo generated by PHP:';​ +echo 'The PHP version: '; 
-echo '<​img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP Logo !" />'+echo phpversion(); 
-echo '​(generated inline HTML)';​+echo ' (generated inline HTML)';​
 </​php>​ </​php>​
 <PHP> <PHP>
 echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​
-echo '<​td>​<img src="' . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '" alt="​PHP Logo !" /></​td>';​+echo '<​td>'​.phpversion().'</​td>';​
 echo '</​tr></​table>';​ echo '</​tr></​table>';​
 </​PHP>​ </​PHP>​
Line 452: Line 461:
  
 <php> <php>
-echo 'A logo generated by PHP:';​ +echo 'The PHP version: '; 
-echo '<​img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP Logo !" />'+echo phpversion(); 
-echo '​(inline HTML)';​+echo ' (inline HTML)';​
 </​php>​ </​php>​
 <PHP> <PHP>
 echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​
-echo '<​td>​<img src="' . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '" alt="​PHP Logo !" /></​td>';​+echo '<​td>'​.phpversion().'</​td>';​
 echo '</​tr></​table>';​ echo '</​tr></​table>';​
 </​PHP>​ </​PHP>​
Line 497: Line 506:
  
 ~~INFO:​syntaxplugins~~ ~~INFO:​syntaxplugins~~
 +
wiki/syntax.1352805566.txt.gz · Last modified: 2012/11/13 11:19 by legatum