Vanderbilt ENT Resident Wiki

Since 1987

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 revisionPrevious revision
Next revision		Previous revision
wiki:syntax [2023/07/19 11:23] – jceremsakwiki:syntax [2024/02/10 10:59] (current) – external edit 127.0.0.1
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 [[wiki: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 =====
Line 45: Line 45:
 ==== Internal ==== ==== Internal ====
  
-Internal links are created by using square brackets. You can either just give a pagename or use an additional link text.+Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]].
  
   Internal links are created by using square brackets. You can either just give   Internal links are created by using square brackets. You can either just give
-  a pagename or use an additional link text.+  a [[pagename]] or use an additional [[pagename|link text]].
  
 [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed. [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
  
-You can use namespaces by using a colon in the pagename.+You can use [[some:namespaces]] by using a colon in the pagename.
  
-  You can use namespaces by using a colon in the pagename.+  You can use [[some:namespaces]] by using a colon in the pagename.
  
 For details about namespaces see [[doku>namespaces]]. For details about namespaces see [[doku>namespaces]].
Line 64: Line 64:
 Notes: Notes:
  
-  * 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.   * 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.
Line 93: Line 93:
 </code> </code>
  
 +==== Image Links ====
 +
 +You can also use an image to link to another internal or external page by combining the syntax for links and [[#images_and_other_files|images]] (see below) like this:
 +
 +  [[http://php.net|{{wiki:dokuwiki-128.png}}]]
 +
 +[[http://php.net|{{wiki:dokuwiki-128.png}}]]
 +
 +Please note: The image formatting is the only formatting syntax accepted in link names.
 +
 +The whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
  
 ===== Footnotes ===== ===== Footnotes =====
Line 116: Line 127:
 ---- ----
  
 +===== 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.
 +
 +Real size:                        {{wiki:dokuwiki-128.png}}
 +
 +Resize to given width:            {{wiki:dokuwiki-128.png?50}}
 +
 +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://www.php.net/images/php.gif?200x50}}
 +
 +  Real size:                        {{wiki:dokuwiki-128.png}}
 +  Resize to given width:            {{wiki:dokuwiki-128.png?50}}
 +  Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
 +  Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
 +
 +
 +By using left or right whitespaces you can choose the alignment.
 +
 +{{ wiki:dokuwiki-128.png}}
 +
 +{{wiki:dokuwiki-128.png }}
 +
 +{{ wiki:dokuwiki-128.png }}
 +
 +  {{ wiki:dokuwiki-128.png}}
 +  {{wiki:dokuwiki-128.png }}
 +  {{ wiki:dokuwiki-128.png }}
 +
 +Of course, you can add a title (displayed as a tooltip by most browsers), too.
 +
 +{{ wiki:dokuwiki-128.png |This is the caption}}
 +
 +  {{ wiki:dokuwiki-128.png |This is the caption}}
 +
 +For linking an image to another page see [[#Image Links]] above.
  
 ==== Supported Media Formats ==== ==== Supported Media Formats ====
Line 130: Line 178:
 By adding ''?linkonly'' you provide a link to the media without displaying it inline By adding ''?linkonly'' you provide a link to the media without displaying it inline
  
 +  {{wiki:dokuwiki-128.png?linkonly}}
 +
 +{{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image.
  
 ==== Fallback Formats ==== ==== Fallback Formats ====
wiki/syntax.1689780232.txt.gz · Last modified: by jceremsak

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki