wiki:syntax backlinks history revert

Navigation

History

Typyl

World

Culture

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 [2020/03/09 07:47]
fiakaiera fixed formatting 		wiki:syntax [2020/06/05 04:25] (current)
Line 1: Line 1:
-====== Syntax Cheetsheet ====== +====== Formatting Syntax ======
-The Furria Wiki uses a simple markup language from [[doku>DokuWiki]] extended by plugins to make datafiles to be +
-readable as simple as possible. If you want to test around with syntax, you can use the [[playground:playground|playground]] +
-page and edit there.+
  
-{{INLINETOC}}+[[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.
  
-===== Style ===== +===== Basic Text Formatting =====
-==== Basic Formatting ==== +
-|< 100%  15em - 15em >| +
-^   Description   ^   Syntax   ^   Result  ^ +
-|{{http://owiki.furria.net/lib/images/toolbar/bold.png?nolink}} Bold Text|<code>**bold text**</code>|**bold text**| +
-|{{http://owiki.furria.net/lib/images/toolbar/italic.png?nolink}} Italic Text|<code>//italic text//</code>|//italic text//| +
-|{{http://owiki.furria.net/lib/images/toolbar/underline.png?nolink}} Underline Text|<code>__underline text__</code>|__underline text__| +
-|{{http://owiki.furria.net/lib/images/toolbar/mono.png?nolink}} Monospace Text|<code>''monospace text''</code>|''monospace text''| +
-|{{http://owiki.furria.net/lib/images/toolbar/strike.png?nolink}} Strikethrough Text|<code><del>strikethrough text</del></code>|<del>strikethrough text</del>|+
  
-==== Font Adjustment ==== +DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
-|< 100%  15em - 15em >| +
-^   Description   ^   Syntax   ^   Result  ^ +
-|{{http://owiki.furria.net/lib/images/toolbar/../../plugins/fontsize2/images/toolbar/picker.png?nolink}} Font Size|<code><fs x-small>extra small text</fs> +
-<fs 50%>50% size text</fs>+
  
-Options: +  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. 
-xx-small|x-small|small|normal|large|x-large|xx-large +  Of course you can **__//''combine''//__** all these.
-Values: ?em ?ex ?% ?px</code>|<fs x-small>extra small text</fs>\\ <fs 50%>50% size text</fs>| +
-|{{http://owiki.furria.net/lib/images/toolbar/../../plugins/fontcolor/images/toolbar_icon.png}} Font Color|<code><fc #aaa>#AAA colored text</fc> +
-Accepts any hex color combinations #??? and #??????</code>|<fc #aaa>#AAA colored text</fc>| +
-|Furrian Cipher|<code>-::ciphered::-</code>|-::ciphered::-| +
-|Furrian Code|<code>**-::ciphered::-** +
-(simply a bold filter on ciphered text)</code>|**-::ciphered::-**|+
  
-==== Text Alignment ==== +You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-|< 100%  15em - 15em >| +
-^   Description   ^   Syntax   ^   Result  ^ +
-|{{http://owiki.furria.net/lib/images/toolbar/../../plugins/divalign2/images/pleft.png?nolink}} Left-aligned Text|<code>#;; +
-left-aligned text +
-#;;</code><code><div leftalign> +
-left-aligned text +
-</div></code>|left-aligned text   | +
-|{{http://owiki.furria.net/lib/images/toolbar/../../plugins/divalign2/images/pcenter.png?nolink}} Center-aligned Text|<code>;#; +
-center-aligned text +
-;#;</code><code><div centeralign> +
-center-aligned text +
-</div></code>|   center-aligned text   | +
-|{{http://owiki.furria.net/lib/images/toolbar/../../plugins/divalign2/images/pright.png?nolink}} Right-aligned Text|<code>;;# +
-right-aligned text +
-;;#</code><code><div rightalign> +
-right-aligned text +
-</div></code>|   right-aligned text| +
-|{{http://owiki.furria.net/lib/images/toolbar/../../plugins/divalign2/images/pjustify.png?nolink}} Justified Text|<code>### +
-this is justified text +
-so it should be equally spaced +
-###</code><code><div justify> +
-this is justified text +
-so it should be equally spaced +
-</div></code>|<div justify 100%>this is justified text so it should be equally spaced</div>|+
  
-==== Entities ==== +  You can use <sub>subscript</sub> and <sup>superscript</sup>, too. 
-|< 100%>| + 
-^   Syntax   ^   Result  ^ +You can mark something as <del>deleted</del> as well. 
-|<code>-> <- <-> => <= <=> >> << -- ---</code>|-> <- <-> => <= <=> >> << -- ---| + 
-|<code>640x480 (c) (tm) (r)</code>|640x480 (c) (tm) (r)| +  You can mark something as <del>deleted</del> as well. 
-|<code>"He thought I was the one..."</code>|"He thought I was the one..."| + 
-|<code>:flamma: :flumine: :aer: :solum:</code>(any [[furria:aspects|aspect]] available)|:flamma: :flumine: :aer: :solum:|+**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\\ 
 +or followed by\\ a whitespace \\this happens without it. 
 + 
 +  This is some text with some linebreaks\\ Note that the 
 +  two backslashes are only recognized at the end of a line\\ 
 +  or followed by\\ a whitespace \\this happens without it. 
 + 
 +You should use forced newlines only if really needed. 
 + 
 +===== Links ===== 
 + 
 +DokuWiki supports multiple ways of creating links. 
 + 
 +==== 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: <andi@splitbrain.org> are recognized, too. 
 + 
 +  DokuWiki supports multiple ways of creating links. External links are recognized 
 +  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 
 +  addresses like this one: <andi@splitbrain.org> are recognized, too. 
 + 
 +==== Internal ==== 
 + 
 +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 
 +  a [[pagename]] or use an additional [[pagename|link text]]. 
 + 
 +[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed. 
 + 
 +You can use [[some: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]]. 
 + 
 +Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax#internal|this Section]]. 
 + 
 +  This links to [[syntax#internal|this Section]]. 
 + 
 +Notes: 
 + 
 +  * 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. 
 + 
 +==== 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/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 ==== 
 + 
 +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 ===== 
 + 
 +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 =====
-==== Headlines / Headers ==== 
-|< 100%  15em - 15em >| 
-^   Description   ^   Syntax   ^   Result  ^ 
-|{{http://owiki.furria.net/lib/images/toolbar/h1.png?nolink}} Headline Level 1\\ <fs x-small>(aka title header)</fs>|<code>====== Header 1 ======</code>|<fs 3em>Header 1</fs>| 
-|{{http://owiki.furria.net/lib/images/toolbar/h2.png?nolink}} Headline Level 2|<code>===== Header 2 =====</code>|<fs 2.2em>Header 2</fs>| 
-|{{http://owiki.furria.net/lib/images/toolbar/h3.png?nolink}} Headline Level 3|<code>==== Header 3 ====</code>|<fs 1.8em>Header 3</fs>| 
-|{{http://owiki.furria.net/lib/images/toolbar/h4.png?nolink}} Headline Level 4|<code>=== Header 4 ===</code>|<fs 1.4em>Header 4</fs>| 
-|{{http://owiki.furria.net/lib/images/toolbar/h5.png?nolink}} Headline Level 5|<code>== Header 5 ==</code>|<fs 1.2em>Header 5</fs>| 
  
-==== Table of Contents & Footnotes ==== +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.
-|< 100%  15em - 15em >| +
-^   Description   ^   Syntax   ^   Result  ^ +
-|Table of Contents|<code>{{INLINETOC}}</code>|{{INLINETOC}}| +
-|Footnote|<code>footnote((This is a foot note. +
-Accessible at the bottom of the page.))</code>|footnote((This is a foot note. Accessible at the bottom of the page.))|+
  
-==== Section Breaks ==== +==== Headline Level 3 ==== 
-|< 100%  15em - 15em >| +=== Headline Level 4 === 
-^   Description   ^   Syntax   ^   Result  ^ +== Headline Level 5 ==
-|Line Break|<code>line\\ break</code><code>line\\ +
-break</code>|line\\ break| +
-|New Paragraph|<code>paragraph 1+
  
-paragraph 2</code>|paragraph 1\\ \\ paragraph 2| +  ==== Headline Level 3 ==== 
-|{{http://owiki.furria.net/lib/images/toolbar/hr.png?nolink}} Horizontal Rule|<code>---- +  === Headline Level 4 === 
-(^ should be the only one in the line)</code>|(horizontal rule)|+  == Headline Level 5 == 
 + 
 +By using four or more dashes, you can make a horizontal line: 
 + 
 +---- 
 + 
 +===== 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://secure.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://secure.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 ==== 
 + 
 +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. 
 + 
 +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 ==== 
 + 
 +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 ===== 
 + 
 +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 
 +  * The second item 
 +    * You may have different levels 
 +  * Another item 
 + 
 +  - The same list but ordered 
 +  - Another item 
 +    - Just use indention for deeper levels 
 +  - That's it
  
-==== Quotes ==== 
 <code> <code>
-> quote line that is extremely and unnecessarily long +  * This is a list 
-> quote line that is extremely and unnecessarily long +  * The second item 
->> quote line that is extremely and unnecessarily long+    * You may have different levels 
 +  * Another item
  
->> quote line that is extremely and unnecessarily long +  - The same list but ordered 
->>> quote line that is extremely and unnecessarily long</code> +  - Another item 
-> quote line that is extremely and unnecessarily long +    - Just use indention for deeper levels 
-> quote line that is extremely and unnecessarily long +  - That's it 
->> quote line that is extremely and unnecessarily long+</code>
  
->> quote line that is extremely and unnecessarily long +Also take a look at the [[doku>faq:lists|FAQ on list items]].
->>> quote line that is extremely and unnecessarily long+
  
-==== Lists ==== +===== Text Conversions =====
-<fs 2em>{{http://owiki.furria.net/lib/images/toolbar/ol.png?nolink}} Ordered List</fs> +
-|< 90%  50% >| +
-^Syntax^Result^ +
-<div column 45%><code> +
-  - ordered list entry +
-  - ordered list entry +
-    - ordered list entry +
-    - ordered list entry +
-  - ordered list entry +
-    - ordered list entry +
-       - ordered list entry +
-         - ordered list entry +
-  - ordered list entry</code> +
-</div> +
-<div column 45%> +
-  - ordered list entry +
-  - ordered list entry +
-    - ordered list entry +
-    - ordered list entry +
-  - ordered list entry +
-    - ordered list entry +
-       - ordered list entry +
-  - ordered list entry +
-</div> +
-<div clear></div>+
  
-<fs 2em>{{http://owiki.furria.net/lib/images/toolbar/ul.png?nolink}} Unordered List</fs> +DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
-|< 90%  50% >| +
-^Syntax^Result^ +
-<div column 45%><code> +
-  * ordered list entry +
-  * ordered list entry +
-    * ordered list entry +
-    * ordered list entry +
-  * ordered list entry +
-    * ordered list entry +
-       * ordered list entry +
-         * ordered list entry +
-  * ordered list entry</code> +
-</div> +
-<div column 45%> +
-  * ordered list entry +
-  * ordered list entry +
-    * ordered list entry +
-    * ordered list entry +
-  * ordered list entry +
-    * ordered list entry +
-       * ordered list entry +
-  * ordered list entry +
-</div> +
-<div clear></div>+
  
-===== Links ===== +The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.
-==== Internal Links ==== +
-All pages are case-insensitive and are all in lowercase by default. +
-|< 100%  15em - 15em >| +
-^   Description   ^   Syntax   ^   Result  ^ +
-|{{http://owiki.furria.net/lib/images/toolbar/link.png?nolink}} Internal Link\\ <fs x-small>(relative namespace)</fs>|<code>[[syntax]]</code>|[[syntax]]| +
-|{{http://owiki.furria.net/lib/images/toolbar/link.png?nolink}} Internal Link\\ <fs x-small>(root namespace)</fs>|<code>[[:home]]</code>|[[:home]]| +
-|{{http://owiki.furria.net/lib/images/toolbar/link.png?nolink}} Internal Link\\ <fs x-small>(defined namespace)</fs>|<code>[[playground:playground]]</code>|[[playground:playground]]| +
-|{{http://owiki.furria.net/lib/images/toolbar/link.png?nolink}} Internal Link\\ <fs x-small>(substituted text)</fs>|<code>[[:home|Home]]</code>|[[:home|Home]]| +
-|{{http://owiki.furria.net/lib/images/toolbar/link.png?nolink}} Internal Link\\ <fs x-small>(specific section)</fs>|<code>[[wiki:syntaxexplained#lists]]</code>|[[wiki:syntaxexplained#lists]]| +
-|{{http://owiki.furria.net/lib/images/toolbar/link.png?nolink}} Internal Link\\ <fs x-small>(section of the same page)</fs>|<code>[[syntax#lists]]</code>|[[syntax#lists]]|+
  
-==== External Links ==== +==== Text to Image Conversions ====
-|< 100%  15em - 15em >| +
-^   Description   ^   Syntax   ^   Result  ^ +
-|{{http://owiki.furria.net/lib/images/toolbar/linkextern.png?nolink}} External Link|<code>[[http://www.furria.net]]</code>|[[http://www.furria.net]]| +
-|{{http://owiki.furria.net/lib/images/toolbar/linkextern.png?nolink}} External Link\\ <fs x-small>(autodetected)</fs>|<code>http://www.furria.net +
-www.furria.net</code>|http://www.furria.net\\ www.furria.net| +
-|{{http://owiki.furria.net/lib/images/toolbar/linkextern.png?nolink}} External Link\\ <fs x-small>(substituted text)</fs>|<code>[[http://www.furria.net|FurriaNET]]</code>|[[http://www.furria.net|FurriaNET]]| +
-|{{http://owiki.furria.net/lib/images/toolbar/linkextern.png?nolink}} E-mail Link|<code><no-reply@furria.net></code>|<no-reply@furria.net>|+
  
-==== Interwiki Links ==== +DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
-|< 100%  15em - 15em >| +
-^   Description   ^   Syntax   ^   Result  ^ +
-|Wikipedia|<code>[[wp>Wikipedia]]</code>|[[wp>Wikipedia]]| +
-|DokuWiki|<code>[[doku>DokuWiki]]</code>|[[doku>DokuWiki]]| +
-|Bulbapedia|<code>[[bb>Pokémon]]</code>|[[bb>Pokémon]]| +
-|TV Tropes|<code>[[tv>TropeTrope|Trope Tropes]]</code>|[[tv>TropeTrope|Trope Tropes]]| +
-|Furria Wiki User|<code>[[user>fiaKaiera]]</code>|[[user>fiaKaiera]]|+
  
-===== Media Files ===== +  * 8-) %%  8-)  %% 
-^**Supported Media Formats:**|| +  * 8-O %%  8-O  %% 
-^Images|''gif'' ''jpg'' ''png''| +  * :-( %%  :-(  %% 
-^Video|''webm'' ''ogv'' ''mp4''| +  * :-) %%  :-)  %% 
-^Audio|''ogg'' ''mp3'' ''wav''| +  * =)  %%  =)   %% 
-^Flash|''swf''| +  * :-/ %%  :-/  %% 
-**NOTE:** Files are also categorized in namespaces so follow namespace guidelines found in [[syntax#internal links]]+  * :-\ %%  :-\  %% 
 +  * :-? %%  :-?  %% 
 +  * :-D %%  :-D  %% 
 +  * :-P %%  :-P  %% 
 +  * :-O %%  :-O  %% 
 +  * :-X %%  :-X  %% 
 +  * :-| %%  :-|  %% 
 +  * ;-) %%  ;-)  %% 
 +  * ^_^ %%  ^_^  %% 
 +  * :?: %%  :?:  %% 
 +  * :!: %%  :!:  %% 
 +  * LOL %%  LOL  %% 
 +  * FIXME %%  FIXME %% 
 +  * DELETEME %% DELETEME %%
  
-|< 100%  15em - 15em >| +==== Text to HTML Conversions ====
-^   Description   ^   Syntax   ^   Result  ^ +
-|{{http://owiki.furria.net/lib/images/media_align_noalign.png?nolink}} Embed Media|<code>{{:typyl:mugs:heilao.png}}</code>|{{:typyl:mugs:heilao.png?100}}| +
-|{{http://owiki.furria.net/lib/images/media_link_lnk.png?nolink}} With Title|<code>{{:typyl:mugs:heilao.png|Paupe}}</code>(Hover over to see title name)|{{:typyl:mugs:heilao.png?100|Paupe}}| +
-|{{http://owiki.furria.net/lib/images/media_link_direct.png?nolink}} Direct Link|<code>{{:typyl:mugs:heilao.png?direct}}</code>|{{:typyl:mugs:heilao.png?100&direct}}| +
-|{{http://owiki.furria.net/lib/images/media_link_lnk.png?nolink}} No Link|<code>{{:typyl:mugs:heilao.png?nolink}}</code>|{{:typyl:mugs:heilao.png?100&nolink}}| +
-|{{http://owiki.furria.net/lib/images/media_link_displaylnk.png?nolink}} Link Only|<code>{{:typyl:mugs:heilao.png?linkonly}}</code>|{{:typyl:mugs:heilao.png?linkonly}}| +
-|{{http://owiki.furria.net/lib/images/media_align_left.png?nolink}} Left Aligned|<code>{{:typyl:mugs:heilao.png }}</code>|{{:typyl:mugs:heilao.png?100 }}| +
-|{{http://owiki.furria.net/lib/images/media_align_center.png?nolink}} Centered|<code>{{ :typyl:mugs:heilao.png }}</code>(Hover over to see title name)|{{ :typyl:mugs:heilao.png?100 }}| +
-|{{http://owiki.furria.net/lib/images/media_align_right.png?nolink}} Right Aligned|<code>{{ :typyl:mugs:heilao.png}}</code>(Hover over to see title name)|{{ :typyl:mugs:heilao.png?100}}| +
-|Resize to given width|<code>{{:typyl:mugs:heilao.png?50}}</code>|{{ :typyl:mugs:heilao.png?50 }}| +
-|Resize to given height|<code>{{:typyl:mugs:heilao.png?0x50}}</code>|{{ :typyl:mugs:heilao.png?0x80 }}| +
-|Crop to given width and height|<code>{{:typyl:mugs:heilao.png?100x50}}</code>|{{ :typyl:mugs:heilao.png?100x50 }}| +
-|External Image|<code>{{http://php.net/images/php.gif}}</code>- External images can also use parameters from above.|{{ http://php.net/images/php.gif?100x20&nolink }}| +
-|Multiple Parameters|<code>{{ http://php.net/images/php.gif?50&nolink |PHP Logo }}</code>- First parameter starts with ''?''\\ and all preceding parameters starts with ''&''.|{{ http://php.net/images/php.gif?50&nolink |PHP Logo }}| +
-|No Cache|<code>{{ http://php.net/images/php.gif?nocache }}</code>(image will change on refresh in browser when file is changed or modified immediately)|{{ http://php.net/images/php.gif?100&nocache }}| +
-|Recache|<code>{{ http://php.net/images/php.gif?recache }}</code>(image will change on refresh in browser when file is changed or modified only in regular intervals)|{{ http://php.net/images/php.gif?100&recache }}|+
  
-===Fallback Formats=== +Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
-Not all browsers are unable to understand all video and audio formats. You can optionally upload a file +
-in different formats for browser compatiblility.+
  
-<code>{{video.mp4|A Funny Video}}</code> +-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) 
-The wiki will automatically add ''video.webm'' and ''video.ogg'' when they are available.\\ +"He thought 'It's a man's world'..."
-Poster images also show before the video if there's a ''jpg'' or ''png'' file available, provided with the same +
-filename, in this example: ''video.jpg''.+
  
-===== Tables ===== +<code> 
-<div column 45%> +-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) 
-|<100%>| +"He thought 'It's a man's world'..." 
-^Syntax^+</code> 
 + 
 +The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]]. 
 + 
 +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]]. 
 + 
 +===== Quoting ===== 
 + 
 +Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
  
 <code> <code>
-^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +I think we should do it 
-| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | + 
-| Row 2 Col 1    | Row 2 Col 2     | Row 2 Col 3        | +> No we shouldn't 
-| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        | + 
-</code></div> +>> Well, I say we should 
-<div column 45%> + 
-|<100%>| +> Really? 
-^Result^+ 
 +>> Yes! 
 + 
 +>>> Then lets do it! 
 +</code> 
 + 
 +I think we should do it 
 + 
 +> No we shouldn't 
 + 
 +>> Well, I say we should 
 + 
 +> Really? 
 + 
 +>> Yes! 
 + 
 +>>> Then lets do it! 
 + 
 +===== Tables ===== 
 + 
 +DokuWiki supports a simple syntax to create tables.
  
 ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ ^ Heading 1      ^ Heading 2       ^ Heading 3          ^
 | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
-| Row 2 Col 1    | Row 2 Col 2     | Row 2 Col 3        |+| Row 2 Col 1    | some colspan (note the double pipe) ||
 | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        | | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
-</div> + 
----- +Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers. 
-<div column 45%><code> + 
-^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ 
-| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | +  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | 
-| Row 2 Col 1    | Double Pipe for colspan             || +  | Row 2 Col 1    | some colspan (note the double pipe) || 
-| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        | +  | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        | 
-</code></div> + 
-<div column 45%> +To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators! 
-^ Heading 1      ^ Heading 2       ^ Heading 3          ^ + 
-| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | +Vertical tableheaders are possible, too. 
-| Row 2 Col 1    | Double Pipe for colspan             || + 
-| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        | +|              ^ Heading 1            ^ Heading 2          ^ 
-</div> +^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | 
----- +^ Heading 4    | no colspan this time |                    | 
-<div column 45%><code> +^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        | 
-^ Heading 1      ^ Heading 2       ^ Heading 3          ^ + 
-| Row 1 Col 1    | 3 colons for rowspan| Row 1 Col 3        | +As you can see, it's the cell separator before a cell which decides about the formatting: 
-| Row 2 Col 1    | :::             | Row 2 Col 3        | + 
-| Row 3 Col 1    | :::             | Row 3 Col 3        | +  |              ^ Heading 1            ^ Heading 2          ^ 
-</code></div> +  ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | 
-<div column 45%> +  ^ Heading 4    | no colspan this time |                    | 
-^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +  ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        | 
-| Row 1 Col 1    | 3 colons for rowspan| Row 1 Col 3        | + 
-| Row 2 Col 1    | :::             | Row 2 Col 3        | +You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect. 
-| Row 3 Col 1    | :::             | Row 3 Col 3        | + 
-</div> +^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ 
----- +| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | 
-<div column 45%><code> +| Row 2 Col 1    | :::                        | Row 2 Col 3        | 
-|< 100% - 20% >| +| Row 3 Col 1    | :::                        | Row 2 Col 3        | 
-^ -      ^ Always 20%          ^ + 
-| First value is table width    | ?%        | +Apart from the rowspan syntax those cells should not contain anything else. 
-| The rest is per column    | ?em ?ex       | + 
-| ''-'' means unchanged    | ?px        | +  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ 
-</code></div> +  | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | 
-<div column 45%> +  | Row 2 Col 1    | :::                        | Row 2 Col 3        | 
-|< 100% - 20% >| +  | Row 3 Col 1    | :::                        | Row 2 Col 3        | 
-^ -      ^ Always 20%          ^ + 
-| First value is table width    | ?%        | +You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. 
-| The rest is per column    | ?em ?ex       | + 
-| ''-'' means unchanged    | ?px        | +^           Table with alignment           ^^^ 
-</div> +|         right|    center    |left          | 
-<div clear></div> +|left          |         right|    center    | 
-===== Ignore Formatting ===== +| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | 
-**Syntax:** ''%%text%%'' or ''<nowiki>text</nowiki>'' + 
-**Example:** +This is how it looks in the source: 
-> %%You cannot even **bold** this text in any way or form unless it is outside the <nowiki> symbol. </nowiki>%%+ 
 +  ^           Table with alignment           ^^^ 
 +  |         right|    center    |left          | 
 +  |left          |         right|    center    | 
 +  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | 
 + 
 +Note: Vertical alignment is not supported. 
 + 
 +===== No Formatting ===== 
 + 
 +If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%<nowiki>%%'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''. 
 + 
 +<nowiki> 
 +This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. 
 +</nowiki> 
 +The same is true for %%//__this__ text// with a smiley ;-)%%. 
 + 
 +  <nowiki> 
 +  This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. 
 +  </nowiki> 
 +  The same is true for %%//__this__ text// with a smiley ;-)%%. 
 ===== Code Blocks ===== ===== Code Blocks =====
-**Syntax:** ''%%<code></code>%%'' or ''%%<file></file>%%'' + 
-Alternatively, you can indent by at least 2 spaces. +You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''%%<code>%%'' or ''%%<file>%%''. 
-  This is a code block. + 
-<file>This is a file block.</file>+  This is text is indented by two spaces. 
 + 
 +<code> 
 +This is preformatted code all spaces are preserved: like              <-this 
 +</code> 
 + 
 +<file> 
 +This is pretty much the same, but you could use it to show that you quoted a file. 
 +</file> 
 + 
 +Those blocks were created by this source: 
 + 
 +    This is text is indented by two spaces. 
 + 
 +  <code> 
 +  This is preformatted code all spaces are preserved: like              <-this 
 +  </code> 
 + 
 +  <file> 
 +  This is pretty much the same, but you could use it to show that you quoted a file. 
 +  </file> 
 ==== Syntax Highlighting ==== ==== Syntax Highlighting ====
-**Syntax:** ''%%<code java></code>%%'', ''%%<code php></code>%%'', etc. + 
-<code php> +[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<nowiki><code java></nowiki>'' or ''<nowiki><file java></nowiki>''. 
-  &variable = 0; + 
-  if (&variable){ +<code java> 
-    return true; +/** 
-  }+ * The HelloWorldApp class implements an application that 
 + * simply displays "Hello World!" to the standard output. 
 + */ 
 +class HelloWorldApp { 
 +    public static void main(String[] args) { 
 +        System.out.println("Hello World!"); //Display the string. 
 +    } 
 +}
 </code> </code>
-**Supported Languages:** + 
-<fs x-small>4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, +The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic// 
-actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, + 
-bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, +There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers. 
-cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, +
-diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, +
-fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, +
-html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, +
-latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, +
-lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, +
-nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, +
-perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, +
-powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, +
-reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, +
-tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, +
-visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic</fs> +
-...and any other languages supported by [[http://qbnz.com/highlighter/|GeSHi]].+
 ==== Downloadable Code Blocks ==== ==== Downloadable Code Blocks ====
-**Syntax:** + 
-  <file php myexample.php> +When you use the ''%%<code>%%'' or ''%%<file>%%'' syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this: 
-  <?php echo "hello world!"; ?> + 
-  </file> +<code>
-\\ +
 <file php myexample.php> <file php myexample.php>
-  <?php echo "hello world!"; ?>+<?php echo "hello world!"; ?>
 </file> </file>
-**Note:** If the editor does not want syntax highlighting, you can place (''-'') instead than specifying +</code> 
-a programming language.+ 
 +<file php myexample.php> 
 +<?php echo "hello world!"; ?> 
 +</file> 
 + 
 +If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. 
 + 
 + 
 +===== Embedding HTML and PHP ===== 
 + 
 +You can embed raw HTML or PHP code into your documents by using the ''%%<html>%%'' or ''%%<php>%%'' tags. (Use uppercase tags if you need to enclose block level elements.) 
 + 
 +HTML example: 
 + 
 +<code> 
 +<html> 
 +This is some <span style="color:red;font-size:150%;">inline HTML</span> 
 +</html> 
 +<HTML> 
 +<p style="border:2px dashed red;">And this is some block HTML</p> 
 +</HTML> 
 +</code> 
 + 
 +<html> 
 +This is some <span style="color:red;font-size:150%;">inline HTML</span> 
 +</html> 
 +<HTML> 
 +<p style="border:2px dashed red;">And this is some block HTML</p> 
 +</HTML> 
 + 
 +PHP example: 
 + 
 +<code> 
 +<php> 
 +echo 'The PHP version: '; 
 +echo phpversion(); 
 +echo ' (generated inline HTML)'; 
 +</php> 
 +<PHP> 
 +echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; 
 +echo '<td>'.phpversion().'</td>'; 
 +echo '</tr></table>'; 
 +</PHP> 
 +</code> 
 + 
 +<php> 
 +echo 'The PHP version: '; 
 +echo phpversion(); 
 +echo ' (inline HTML)'; 
 +</php> 
 +<PHP> 
 +echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; 
 +echo '<td>'.phpversion().'</td>'; 
 +echo '</tr></table>'; 
 +</PHP> 
 + 
 +**Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. 
 + 
 +===== RSS/ATOM Feed Aggregation ===== 
 +[[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:
  
-===== RSS/ATOM Feed Integration ===== 
-The wiki can integrate data from external XML feeds using [[http://simplepie.org/|SimplePie]]. 
-All formats understood by SimplePie can be used in the wiki. 
 ^ Parameter  ^ Description ^ ^ Parameter  ^ Description ^
 | any number | will be used as maximum number items to show, defaults to 8 | | any number | will be used as maximum number items to show, defaults to 8 |
Line 345: Line 499:
 | nosort     | do not sort the items in the feed | | nosort     | do not sort the items in the feed |
 | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |
-The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. 
  
-By default the feed will be sorted by date, newest items first. +The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered. 
-You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''. + 
 +By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''.
  
 **Example:** **Example:**
-  {{rss>https://twitrss.me/twitter_user_to_rss/?user=fiaKaiera 5 author date 1h }} + 
-{{rss>https://twitrss.me/twitter_user_to_rss/?user=fiaKaiera 5 author date 1h }}+  {{rss>http://slashdot.org/index.rss 5 author date 1h }} 
 + 
 +{{rss>http://slashdot.org/index.rss 5 author date 1h }} 
  
 ===== Control Macros ===== ===== Control Macros =====
-Some syntax influences how the wiki renders a page without creating any output itself. 
-The following control macros are availble:  
  
-^Macro^Description^ +Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: 
-|%%~~NOTOC~~%%|If this macro is found on the page, no table of contents will be created| + 
-|%%~~NOCACHE~~%%|The wiki caches all output by default. Sometimes this might not be wanted, adding this macro will force a page to rerender on every call. |+^ Macro           ^ Description | 
 +| %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created | 
 +| %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call | 
 + 
 +===== Syntax Plugins ===== 
 + 
 +DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation: 
 + 
 +~~INFO:syntaxplugins~~ 
wiki/syntax.1583740032.txt.gz · Last modified: 2020/03/09 07:47 by fiakaiera
Creative Commons License DokuWiki
Furria by fiaKaiera is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
Copyright © 2008-2024 fiaKaiera. All Rights Reserved.