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/02/22 08:42]
124.6.181.165
wiki:syntax [2013/04/04 14:33]
fooamp old revision restored
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 [[http://www.weavcast.com/|Weavcast]] 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 [[http://www.kineticfountains.com/wall-fountains.asp| Wall Fountains]] the top or bottom of the [[http://en.wikipedia.org/wiki/Bankers_Life_and_Casualty|bankers life]] page. If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is [[http://www.diamondlinks.net/|link building]] easily accessible via [[doku>toolbar|quickbuttons]], too.[[http://wikinstructions.com/| Online Instructions]]+[[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 =====+===== Basic text formatting =====
  
 DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these. DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
Line 50: Line 50:
   a [[pagename]] or use an additional [[pagename|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 [[some:namespaces]] by using a colon in the pagename. You can use [[some:namespaces]] by using a colon in the pagename.
Line 65: 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'[[http://featherranch.com/|labrador puppies]] 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 74: Line 74:
   DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis.   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]].   For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].
 +
  
 ==== Windows Shares ==== ==== Windows Shares ====
Line 84: Line 85:
  
   * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone").   * 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'': +  * For Mozilla and Firefox it can be enabled through the config option [[http://www.mozilla.org/quality/networking/docs/netprefs.html#file|security.checkloaduri]] but this is not recommended
- +  * See [[dokubug>151]] for more info.
-  $lang['js']['nosmblinks'= '';+
  
 ==== Image Links ==== ==== Image Links ====
Line 122: Line 122:
 ---- ----
  
-===== Images and Other Files =====+===== Images and other 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]] with curly brackets. Optionally you can specify the size of them.
Line 188: Line 188:
 </code> </code>
  
-Also take a look at the [[doku>faq:lists|FAQ on list items]].+===== Smileys =====
  
-===== Text Conversions ===== +DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. More smileys can be placed in the ''smiley'' directory and configured in the ''conf/smileys.conf'' file. Here is an overview of Smileys included in DokuWiki.
- +
-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 ==== +
- +
-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:+
  
   * 8-) %%  8-)  %%   * 8-) %%  8-)  %%
Line 204: Line 196:
   * :-( %%  :-(  %%   * :-( %%  :-(  %%
   * :-) %%  :-)  %%   * :-) %%  :-)  %%
 +
   * =)  %%  =)   %%   * =)  %%  =)   %%
   * :-/ %%  :-/  %%   * :-/ %%  :-/  %%
Line 221: Line 214:
   * DELETEME %% DELETEME %%   * DELETEME %% DELETEME %%
  
-==== Text to HTML Conversions ====+===== Typography =====
  
-Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.+[[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
Line 233: Line 226:
 </code> </code>
  
-The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]]. +Please noteThese conversions can be turned off through a [[doku>config:typography|config option]] and a [[doku>entities|pattern file]].
- +
-There are three exceptions which do not come from that pattern filemultiplication entity (640x480), 'single' and "double quotes". They can be turned off through a [[doku>config:typography|config option]].+
  
 ===== Quoting ===== ===== Quoting =====
Line 267: Line 258:
 ===== Tables ===== ===== Tables =====
  
-DokuWiki supports a simple syntax to create 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    | some colspan (note the double pipe) || | Row 2 Col 1    | some colspan (note the double pipe) ||
-| Row 3 Col 1    | Row Col 2     | Row Col 3        |+| Row 3 Col 1    | Row Col 2     | Row Col 3        |
  
 Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers. Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers.
Line 279: Line 270:
   | 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    | some colspan (note the double pipe) ||   | Row 2 Col 1    | some colspan (note the double pipe) ||
-  | Row 3 Col 1    | Row Col 2     | Row Col 3        |+  | Row 3 Col 1    | Row Col 2     | Row Col 3        |
  
 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! 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!
Line 297: Line 288:
   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
  
-You can have rowspans (vertically connected cells) by adding '':::'' into the cells below the one to which they should connect. +NoteVertical spans (rowspan) are not possible.
- +
-^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ +
-| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | +
-| Row 2 Col 1    | :::                        | Row 2 Col 3        | +
-| Row 3 Col 1    | :::                        | Row 2 Col 3        | +
- +
-Apart from the rowspan syntax those cells should not contain anything else. +
- +
-  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ +
-  | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | +
-  | Row 2 Col 1    | :::                        | Row 2 Col 3        | +
-  | Row 3 Col 1    | :::                        | Row 2 Col 3        |+
  
 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. 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.
Line 325: Line 304:
   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
-Note: Vertical alignment is not supported.+===== Non-parsed Blocks =====
  
-===== No Formatting ===== +You can include non-parsed 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''.
- +
-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 ===== +
- +
-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 text is indented by two spaces.+
  
 <code> <code>
Line 352: Line 313:
  
 <file> <file>
-This is pretty much the same, but you could use it to show that you quoted a file.+This is pretty much the same, but you could use it to show that you quoted a file.  
 </file> </file>
  
-Those blocks were created by this source:+To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with ''nowiki'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''.
  
-    This is text is indented by two spaces. +<nowiki
- +This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. 
-  <code+</nowiki>
-  This is preformatted code all spaces are preserved: like              <-this +
-  </code>+
  
-  <file> +See the source of this page to see how to use these blocks.
-  This is pretty much the same, but you could use it to show that you quoted a file. +
-  </file>+
  
-==== Syntax Highlighting ====+===== 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>''.+[[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 block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. ''<nowiki><code java></nowiki>''.
  
 <code java> <code java>
-/**+/** 
  * The HelloWorldApp class implements an application that  * The HelloWorldApp class implements an application that
  * simply displays "Hello World!" to the standard output.  * simply displays "Hello World!" to the standard output.
Line 383: Line 340:
 </code> </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//+The following language strings are currently recognized: //abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cobol, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, html, idl, ini, inno, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lisp, lotusformulas, lotusscript, lua, m68k, matlab, mirc, mpasm, mxml, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, pic16, plsql, povray, powershell, progress, python, qbasic, rails, reg, robots, ruby, sas, scala, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, visualfoxpro, winbatch, xml, xorg_conf, xpp, z80//
  
-==== Downloadable Code Blocks ==== 
  
-When you use the ''%%<code>%%'' or ''%%<file>%%'' syntax as aboveyou might want to make the shown code available for download as well. You can to this by specifying a file name after language code like this:+===== 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:
  
-<code> +^ Parameter  ^ Description ^ 
-<file php myexample.php> +| any number | will be used as maximum number items to show, defaults to 8 | 
-<?php echo "hello world!"; ?> +| reverse    | display the last items in the feed first | 
-</file+| author     | show item authors names | 
-</code>+| 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). |
  
-<file php myexample.php> +The refresh period defaults to 4 hoursAny 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.
-<?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>%%''.+**Example:**
  
 +  {{rss>http://slashdot.org/index.rss 5 author date 1h }}
  
-===== Embedding HTML and PHP =====+{{rss>http://slashdot.org/index.rss 5 author date 1h }}
  
-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:+===== Embedding HTML and PHP =====
  
 +You can embed raw HTML or PHP code into your documents by using the ''html'' or ''php'' tags like this:
 <code> <code>
 <html> <html>
Line 423: Line 381:
 <p style="border:2px dashed red;">And this is some block HTML</p> <p style="border:2px dashed red;">And this is some block HTML</p>
 </HTML> </HTML>
- 
-PHP example: 
  
 <code> <code>
Line 451: Line 407:
  
 **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. **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 ===== ===== Control Macros =====
Line 481: Line 417:
  
 ===== Syntax Plugins ===== ===== Syntax Plugins =====
-[[http://www.dsdmobile.com/| Cell phone repair mississauga]] +
-[[http://www.dsdmobile.com/ |Cell phone unlocking mississauga]] +
-[[http://www.dsdmobile.com/| iphone repair mississauga]]+
 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: 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~~ ~~INFO:syntaxplugins~~
  
wiki/syntax.txt · Last modified: 2020/10/11 13:56 (external edit)