Differences

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

--- wiki:syntax [2011/07/14 04:42] – external edit 127.0.0.1
+++ wiki:syntax [2011/10/04 14:48] – WIKI:Added syntax page for wiki coding matttpowell
@@ Line 1: / Line 1: @@
-====== Formatting Syntax ======
+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 quickbuttons, too (the bar at the top of the editor).
-[[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.
 ===== Basic Text Formatting =====
-DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
+Supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
-  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
+  Supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
   Of course you can **__//''combine''//__** all these.
@@ Line 17: / Line 15: @@
   You can mark something as <del>deleted</del> as well.
-**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.
+Multiple ways of creating links.
 ==== External ====
@@ Line 38: / Line 24: @@
 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
+  External links are recognized automagically: http://www.google.com or simply www.google.com
-  automagically: http://www.google.com or simply www.google.com - You can set
+  - 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: <andi@splitbrain.org> are recognized, too.
@@ Line 50: / Line 35: @@
   a [[pagename]] or use an additional [[pagename|link text]].
-[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
+[[Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
 You can use [[some:namespaces]] by using a colon in the pagename.
@@ Line 56: / Line 41: @@
   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]] .
 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]].
@@ Line 74: / Line 59: @@
   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/local.protected.php'':
-  $lang['js']['nosmblinks'] = '';
-==== 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://www.php.net|{{wiki:dokuwiki-128.png}}]]
-[[http://www.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 =====
@@ Line 121: / Line 81: @@
 ----
-===== Images and Other Files =====
-You can include external and internal [[doku>images]] 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:           {{http://de3.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:           {{http://de3.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}}
-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.
 ===== Lists =====
@@ Line 189: / Line 109: @@
 Also take a look at the [[doku>faq:lists|FAQ on list items]].
-===== Text Conversions =====
-DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
-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.
 ==== Text to Image Conversions ====
@@ Line 369: / Line 283: @@
 ==== Syntax Highlighting ====
-[[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 is the same like in the code and file blocks in the previous section, but this time the name of the used language is inserted inside the tag. Eg. ''<nowiki><code java></nowiki>'' or ''<nowiki><file java></nowiki>''.
+Any language supported by GeSHi is supported. The name of the used language is inserted inside the tag. Eg. ''<nowiki><code java></nowiki>'' or ''<nowiki><file java></nowiki>''.
 <code java>
@@ Line 382: / Line 296: @@
 }
 </code>
-The following language strings are currently recognized: //4cs, abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, ecmascript, eiffel, email, erlang, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lisp, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, plsql, postgresql, povray, powerbuilder, powershell, progress, prolog, properties, providex, purebasic, 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, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, z80//
 ==== Downloadable Code Blocks ====
@@ Line 401: / Line 313: @@
 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 'A logo generated by PHP:';
-echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
-echo '(generated inline HTML)';
-</php>
-<PHP>
-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 '</tr></table>';
-</PHP>
-</code>
-<php>
-echo 'A logo generated by PHP:';
-echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
-echo '(inline HTML)';
-</php>
-<PHP>
-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 '</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:
-^ Parameter  ^ Description ^
-| any number | will be used as maximum number items to show, defaults to 8 |
-| reverse    | display the last items in the feed first |
-| author     | show item authors names |
-| date       | show item dates |
-| description| show the item description. If [[doku>config:htmlok|HTML]] is disabled all tags will be stripped |
-| //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. [[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.
-**Example:**
-  {{rss>http://slashdot.org/index.rss 5 author date 1h }}
-{{rss>http://slashdot.org/index.rss 5 author date 1h }}
-===== Control Macros =====
-Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
-^ 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~~