Xfce Wiki

Sub domains
 

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 [2012/01/04 13:48] – [Control Macros] nickwiki:syntax [2026/02/18 02:39] (current) – Remove definition lists (plugin no longer supported) kevinbowen
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 the //Edit this page// button at the top or bottom of the 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 the //Edit this page// button at the top or bottom of the 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.
 +
 +  * **[[syntax#Basic Text Formatting|Basic Text Formatting]]**
 +  * **[[syntax#Links|Links]]**
 +  * **[[syntax#Image Links|Image Links]]**
 +  * **[[syntax#Sectioning|Sectioning]]**
 +  * **[[syntax#Images and Other Files|Images and Other Files]]**
 +  * **[[syntax#Lists|Lists]]**
 +  * **[[syntax#Text Conversions|Text Conversions]]**
 +  * **[[syntax#Quoting|Quoting]]**
 +  * **[[syntax#Tables|Tables]]**
 +  * **[[syntax#No Formatting|No Formatting]]**
 +  * **[[syntax#Code Blocks|Code Blocks]]**
 +  * **[[syntax#Downloadable Code Blocks|Downloadable Code Blocks]]**
 +  * **[[syntax#Notes|Notes]]**
 +  * **[[syntax#GUI Sequences|Gui Sequences]]**
 +  * **[[syntax#Figures|Figures]]**
 +
 +----
 +
  
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
Line 29: Line 47:
  
 You should use forced newlines only if really needed. You should use forced newlines only if really needed.
 +
 +----
  
 ===== Links ===== ===== Links =====
Line 99: Line 119:
  
 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). 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).
 +
 +[[|Back To Top]]
 +----
  
 ===== Footnotes ===== ===== Footnotes =====
Line 106: Line 129:
   You can add footnotes ((This is a footnote)) by using double parentheses.   You can add footnotes ((This is a footnote)) by using double parentheses.
  
 +----
 ===== Sectioning ===== ===== Sectioning =====
  
Line 132: Line 156:
 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:           {{http://de3.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:           {{http://de3.php.net/images/php.gif?200x50}}+  Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
  
Line 161: Line 185:
  
 For linking an image to another page see [[#Image Links]] above. For linking an image to another page see [[#Image Links]] above.
 +
 +[[|Back To Top]]
 +----
  
 ===== Lists ===== ===== Lists =====
Line 189: Line 216:
  
 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 236: Line 265:
  
 There are three exceptions which do not come from that pattern file: multiplication entity (640x480), 'single' and "double quotes". They can be turned off through a [[doku>config:typography|config option]]. There are three exceptions which do not come from that pattern file: multiplication entity (640x480), 'single' and "double quotes". They can be turned off through a [[doku>config:typography|config option]].
 +
 +[[|Back To Top]]
 +----
  
 ===== Quoting ===== ===== Quoting =====
Line 264: Line 296:
  
 >>> Then lets do it! >>> Then lets do it!
 +
 +----
  
 ===== Tables ===== ===== Tables =====
Line 326: Line 360:
  
 Note: Vertical alignment is not supported. Note: Vertical alignment is not supported.
 +
 +[[|Back To Top]]
 +----
  
 ===== No Formatting ===== ===== No Formatting =====
Line 340: Line 377:
   </nowiki>   </nowiki>
   The same is true for %%//__this__ text// with a smiley ;-)%%.   The same is true for %%//__this__ text// with a smiley ;-)%%.
 +
 +----
  
 ===== Code Blocks ===== ===== Code Blocks =====
Line 384: Line 423:
 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>%%''.
  
- +[[|Back To Top]] 
 +----
  
 ===== Notes ===== ===== Notes =====
Line 402: Line 441:
  
 <note warning>A note using **warning**.</note> <note warning>A note using **warning**.</note>
 +
 +----
 +
 +===== GUI Sequences =====
 +
 +Because of the documentation and manual target, there is a special syntax for GUI sequences or labels on the interface. The same for key combinations.
 +
 +  You can open the preferences using {gui>Menu>Edit>Preferences...} 
 +  to open the dialog or press {key>Ctrl+P}. If you click the
 +  {gui>Apply} button the settings are saved.
 + 
 +You can open the preferences using {gui>Menu>Edit>Preferences...} to open the dialog or press {key>Ctrl+P}. If you click the {gui>Apply} button the settings are saved.
 +
 +----
 +
 +===== Figures =====
 +
 +To give images a description and make then distinct from the rest of the text, you can use the figure tag.
 +
 +  <figure "Actions Preferences Dialog">
 +  {{:xfce:xfce4-panel:actions.png?nolink&|}}
 +  </figure>
 +
 +This will place the contents between the tags in a table with the string between the brackets as a table comment.
 +
 +<figure "Actions Preferences Dialog">
 +{{:xfce:xfce4-panel:actions.png?nolink&|}}
 +</figure>
 +
 +----
 +[[|Back To Top]]