GSI - BEA Wiki

User Tools

Site Tools

Trace:
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 [2011/09/12 15:01]
andreasreiter created 		wiki:syntax [2020/07/29 11:35] (current)
Line 1: Line 1:
 ====== Formatting Syntax ====== ====== Formatting Syntax ======
  
-[[http://wiki.splitbrain.org/wiki:dokuwiki|Dokuwiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains <del>all</del> most 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 bottom of the page. If you want to try something, just use the [[usage:sandbox:overview|sandbox]] page. The simpler markup is easily accessible via [[usage:syntax#quickbuttons|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.
  
-===== Quickbuttons ===== +===== Basic Text Formatting =====
- +
-The Editing-Toolbar is based upon the one from [[wpmeta>MediaWiki]]. It becomes visible above the editbox automatically if your Browser is capable of the **//needed//** JavaScript. They work pretty much like the formatting buttons in your favourite word processor. In Mozilla and IE you can select a word and press a button to format theselected word. If you **click without** a //selection//, it inserts sample text at the cursor. +
- +
-Browsers without support to insert at the current cursor position will add the string to the end of the edit box. +
- +
-Most buttons have accesskeys assigned to them, too. +
- +
-^ Button ^ Key ^ Function ^ +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/bold.png?nolink}}     |  ''**b**''  | bold formatting | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/italic.png?nolink}}   |  ''**i**''  | italic formatting | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/underline.png?nolink}}  |  ''**u**''  | underlined formatting | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/strike.png?nolink}}   |  ''**d**''  | strikethrough formatting | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/h1.png?nolink}}   |  ''**1**''  | size 1 headline | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/h2.png?nolink}}   |  ''**2**''  | size 2 headline | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/h3.png?nolink}}   |  ''**3**''  | size 3 headline | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/h4.png?nolink}}   |  ''**4**''  | size 4 headline | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/h5.png?nolink}}   |  ''**5**''  | size 5 headline | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/link.png?nolink}}     |  ''**l**''  | link formatting | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/linkextern.png?nolink}}  |           | external link formatting | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/ol.png?nolink}}     |           | ordered list item | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/ul.png?nolink}}  |           | unordered list item | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/hr.png?nolink}}     |           | horizontal rule | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/image.png?nolink}}    |           | Media Selection | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/smiley.png?nolink}}      |  | smiley picker | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/chars.png?nolink}}      |  | character picker | +
-|  {{http://wiki.splitbrain.org/lib/images/toolbar/sig.png?nolink}}      |  ''**y**''  | signature (only when logged in)| +
- +
- +
-===== 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 38: Line 9:
   DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.   DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
   Of course you can **__//''combine''//__** all these.   Of course you can **__//''combine''//__** all these.
- 
-You can also <color orange>colourise</color> your text. 
- 
-  You can also <color orange>colourise</color> your text. 
-   
-Following colours are available: 
-  * <color black>black</color> 
-  * <color navy>navy</color> 
-  * <color blue>blue</color> 
-  * <color green>green</color> 
-  * <color teal>teal</color> 
-  * <color lime>aqua</color> 
-  * <color maroon>maroon</color> 
-  * <color purple>purple</color> 
-  * <color olive>olive</color> 
-  * <color gray>gray</color> 
-  * <color silver>silver</color> 
-  * <color red>red</color> 
-  * <color fuchsia>fuchsia</color> 
-  * <color yellow>yellow</color> 
-  * <color white>white</color> (white) 
-  * <color orange>orange</color> 
  
 You can use <sub>subscript</sub> and <sup>superscript</sup>, too. You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
Line 84: Line 33:
  
 DokuWiki supports multiple ways of creating links. DokuWiki supports multiple ways of creating links.
- 
- 
  
 ==== External ==== ==== External ====
  
-External links are recognized automagically: http://www-bd.gsi.de or simply www-bd.gsi.de - You can set Linknames, too: [[http://www-bd.gsi.com|This Link points to our department page]]. Email addresses like this one: <W.Kunert@gsi.de> are recognized, too. +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.
- +
-  External links are recognized automagically: http://www-bd.gsi.de or simply www-bd.gsi.de - +
-  You can set Linknames, too: [[http://www-bd.gsi.com|This Link points to our department page]]. +
-  Email addresses like this one: <W.Kunert@gsi.de> 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 ====
  
-Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames are converted to lowercase automatically, special characters are not allowed. +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 [[usage:pagename]] or use an additional [[usage:pagename|Title Text]]. Wiki pagenames +  a [[pagename]] or use an additional [[pagename|link text]].
-  are converted to lowercase automatically, special chars are not allowed.+
  
-You can use [[usage:namespaces]] by using a colon in the pagename.+[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
  
-  You can use [[usage:namespaces]] by using a colon in the pagename.+You can use [[some:namespaces]] by using a colon in the pagename.
  
-Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[usage:syntax#internal|this Section]].+  You can use [[some:namespaces]] by using a colon in the pagename.
  
-  This links to [[usage:syntax#internal|this Section]].+For details about namespaces see [[doku>namespaces]].
  
-Links to [[usage:syntax|existing pages]] are shown in a different style from [[usage:nonexisting]] ones.+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 ==== ==== Image Links ====
Line 126: Line 97:
 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: 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.gsi.de|{{usage:gsi_logo.png|}}]]+  [[http://php.net|{{wiki:dokuwiki-128.png}}]]
  
-[[http://www.gsi.de|{{usage:gsi_logo.png|}}]]+[[http://php.net|{{wiki:dokuwiki-128.png}}]]
  
 Please note: The image formatting is the only formatting syntax accepted in link names. 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 154: Line 127:
 ---- ----
  
 +===== Media Files =====
  
-===== Images and other 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.
  
-You can include external and internal images with curly brackets. Optionally you can specify the size of them.+Real size:                        {{wiki:dokuwiki-128.png}}
  
-Real size:                        {{usage:gsi_logo.png}}+Resize to given width:            {{wiki:dokuwiki-128.png?50}}
  
-Resize to given width:            {{usage:gsi_logo.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}}
  
-Resize to given width and height: {{usage:gsi_logo.png?400x50}}+Resized external image:           {{https://secure.php.net/images/php.gif?200x50}}
  
-Resized external image:           {{http://www-bd-new.gsi.de/dokuwiki/lib/tpl/arctic/images/gsi-sd-logo.png?100}} +  Real size:                        {{wiki:dokuwiki-128.png}} 
- +  Resize to given width:            {{wiki:dokuwiki-128.png?50}} 
-  Real size:                        {{usage:gsi_logo.png}} +  Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} 
-  Resize to given width:            {{usage:gsi_logo.png?50}} +  Resized external image:           {{https://secure.php.net/images/php.gif?200x50}}
-  Resize to given width and height: {{usage:gsi_logo.png?400x50}} +
-  Resized external image:           {{http://www-bd-new.gsi.de/dokuwiki/lib/tpl/arctic/images/gsi-sd-logo.png?50}}+
  
  
 By using left or right whitespaces you can choose the alignment. By using left or right whitespaces you can choose the alignment.
  
-{{ usage:gsi_logo.png}}+{{ wiki:dokuwiki-128.png}}
  
-{{usage:gsi_logo.png }}+{{wiki:dokuwiki-128.png }}
  
-{{ usage:gsi_logo.png }}+{{ wiki:dokuwiki-128.png }}
  
-  {{ usage:gsi_logo.png}} +  {{ wiki:dokuwiki-128.png}} 
-  {{usage:gsi_logo.png }} +  {{wiki:dokuwiki-128.png }} 
-  {{ usage:gsi_logo.png }}+  {{ wiki:dokuwiki-128.png }}
  
 Of course, you can add a title (displayed as a tooltip by most browsers), too. Of course, you can add a title (displayed as a tooltip by most browsers), too.
  
-{{ usage:gsi_logo.png |This is the caption.}}+{{ wiki:dokuwiki-128.png |This is the caption}}
  
-  {{ usage:gsi_logo.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. 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 ===== ===== Lists =====
Line 221: Line 220:
 </code> </code>
  
-===== Smileys =====+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 ====
  
-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 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 246: Line 253:
   * DELETEME %% DELETEME %%   * DELETEME %% DELETEME %%
  
 +==== Text to HTML Conversions ====
  
- +Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
-===== Typography ===== +
- +
-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 259: Line 264:
 "He thought 'It's a man's world'..." "He thought 'It's a man's world'..."
 </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]].
 +
 +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 ===== ===== Quoting =====
Line 264: Line 273:
 Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
  
-  I think we should do it +<code> 
-   +I think we should do it 
-  > No we shouldn't + 
-   +> No we shouldn't 
-  >> Well, I say we should + 
-   +>> Well, I say we should 
-  > Really? + 
-   +> Really? 
-  >> Yes! + 
-   +>> Yes! 
-  >>> Then lets do it!+ 
 +>>> Then lets do it! 
 +</code>
  
 I think we should do it I think we should do it
Line 290: Line 301:
 ===== 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 2 Col 2     | Row 2 Col 3        |+| Row 3 Col 1    | Row 3 Col 2     | Row 3 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 302: Line 313:
   | 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 2 Col 2     | Row 2 Col 3        |+  | Row 3 Col 1    | Row 3 Col 2     | Row 3 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 320: Line 331:
   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
  
-Note: Vertical spans (rowspan) are not possible.+You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect. 
 + 
 +^ 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 336: Line 359:
   | 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 346: Line 386:
  
 <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>
  
-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>''.+Those blocks were created by this source:
  
-<nowiki> +    This is text is indented by two spaces.
-This is some text which contains addresses like this: http://www.gsi.de and **formatting**, but nothing is done with it. +
-</nowiki>+
  
-See the source of this page to see how to use these blocks.+  <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 ====
  
-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>''.+[[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>''.
  
 <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 374: Line 417:
 </code> </code>
  
-The following language strings are currently recognized: //abap actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, gml, groovy, haskell, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, m68k, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, plsql, python, qbasic, rails, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml, xpp, z80//+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//
  
 +There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers.
  
-===== Picture Gallery =====+==== Downloadable Code Blocks ====
  
-A basic gallery can be added by selecting a [[namespace]] like this:+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:
  
-  {{gallery>namespace}}+<code> 
 +<file php myexample.php> 
 +<?php echo "hello world!"; ?> 
 +</file> 
 +</code>
  
-All imagefiles in the selected namespace will be added to the image gallery. Note: those images need to be a valid [[pagename]], eg. all lowercase.+<file php myexample.php> 
 +<?php echo "hello world!"; ?> 
 +</file>
  
-Instead of using a whole namespace of images, you can also specify a single image -- this makes most sense when combined with the lightbox mode (see below).+If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.
  
-  {{gallery>namespace:someimage.jpg}} 
  
-The created gallery can be aligned by using whitespace (defaults to centered):+===== Embedding HTML and PHP =====
  
-  {{gallery> namespace}} (right aligned) +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.)
-  {{gallery>namespace }} (left aligned) +
-  {{gallery> namespace }} (centered)+
  
-You can define the wanted thumbnail size by adding its dimension as parameter:+HTML example:
  
-  {{gallery>namespace?150x150}}+<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>
  
-The default is a dimension of 120x120 pixels.+<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>
  
-You can define the number of columns as well:+PHP example:
  
-  {{gallery>namespace?6}} +<code> 
- +<php> 
-The default number of columns is 5 and can be configured in the config manager. If you specify a 0 no table is used instead all thumbnails are added in a sequence. +echo 'The PHP version: '; 
- +echo phpversion(); 
-To have the filename displayed below the thumbnails add the ''showname'' parameter (if this is made the default in the config, you may disable it with ''noshowname''): +echo ' (generated inline HTML)'; 
- +</php> 
-  {{gallery>namespace?showname}} +<PHP> 
- +echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; 
-If you want the files sorted in the reverse order use the ''reverse'' keyword (if this is made the default in the config, you may disable it with ''noreverse''): +echo '<td>'.phpversion().'</td>'; 
- +echo '</tr></table>'; 
-  {{gallery>namespace?reverse}} +</PHP> 
- +</code>
-If you don't want to link to the image detail pages but directly to the image itself use the ''direct'' parameter (if this is made the default in the config, you may disable it with ''nodirect''): +
- +
-  {{gallery>namespace?direct}} +
- +
-For fancy JavaScript based inline browsing of the images use the ''lightbox'' keyword ((This feature is based on the [[http://www.huddletogether.com/projects/lightbox/|Lightbox]] and [[http://serennz.cool.ne.jp/sb/sp/lightbox/|Lightbox Plus]] scripts with some additions)). This feature implicitly sets the direct parameter. If this is made the default in the config, you may disable it with ''nolightbox''. +
- +
-  {{gallery>namespace?lightbox}} +
- +
-All params can be combined: +
- +
-  {{gallery>namespace?150x150&6&showname}} +
- +
-You can also specify the size of lightbox images. It is done the same way as with thumbnails, except using a capital 'X'. The default is 800X600. +
- +
-  {{gallery>namespace?lightbox&500X400}} +
- +
- +
-IMPORTANT: When you have added your pictures they may not show up in the gallery: add '&purge=true' to the end of the URL to clear the cache - and then you should see them.+
  
-=== About the Lightbox mode ===+<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>
  
-This mode will open the clicked picture inside the current browser window without leaving the current page. You can close the picture view by clicking the little X in the upper right corner or anywhere in the picture. You can move to the next or previous image by using the arrow buttons in the lower corners.+**Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.
  
-The picture is downsized if necessary to fit into the current browser window. You can enlarge it with the arrow button in the top corner.+===== 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:
  
-The following keys can be used to navigate:+^ 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 | 
 +| 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). |
  
-^ Key             ^ Action ^ +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.
-| ''->'' or ''n'' | next image | +
-| ''<-'' or ''p'' | previous image | +
-| ''x'' or ''c'' or ''ESC'' | close the image view |+
  
-The Lightbox feature will also be used for all images embedded using the standard DokuWiki image syntax and having set the ''direct'' parameter. This behavior can easily be disabled by changing the ''lightboxForEveryImg'' variable to ''0'' at the very top of the ''script.js'' file.+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''.
  
-More info at :[[http://www.dokuwiki.org/plugin:gallery|DokuWiki-Gallery]]+**Example:**
  
-Note: The feature does not use [[http://www.huddletogether.com/projects/lightbox2/|Version 2]] of the Lightbox script because of its heavy and DokuWiki-incompatible dependencies.+  {{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~~
  
wiki/syntax.1315832486.txt.gz · Last modified: 2011/09/12 15:01 by andreasreiter

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki