Differences

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

--- wiki:syntax [2012/05/24 12:36]
claes [Syntax and Usage]
+++ wiki:syntax [2021/08/14 04:21]
@@ Line 1: / Line 1: @@
-====== Formatting Syntax ======
-[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing the //Edit this page// button at the top or bottom of the page. If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.
-===== 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.
-You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-You can mark something as <del>deleted</del> as well.
-  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.
-==== 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]].
-Examples of the 2 most used interwiki links
-  [[mobot>Main_Page|MobotWare]]
-  [[frobo>Main_Page|FroboMind]]
-[[mobot>Main_Page|MobotWare]]
-[[frobo>Main_Page|FroboMind]]
-==== 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 =====
-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 =====
-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.
-==== Headline Level 3 ====
-=== Headline Level 4 ===
-== Headline Level 5 ==
-  ==== Headline Level 3 ====
-  === Headline Level 4 ===
-  == Headline Level 5 ==
-By using four or more dashes, you can make a horizontal line:
-----
-===== 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 =====
-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
-<code>
-  * 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
-</code>
-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. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
-  * 8-) %%  8-)  %%
-  * 8-O %%  8-O  %%
-  * :-( %%  :-(  %%
-  * :-) %%  :-)  %%
-  * =)  %%  =)   %%
-  * :-/ %%  :-/  %%
-  * :-\ %%  :-\  %%
-  * :-? %%  :-?  %%
-  * :-D %%  :-D  %%
-  * :-P %%  :-P  %%
-  * :-O %%  :-O  %%
-  * :-X %%  :-X  %%
-  * :-| %%  :-|  %%
-  * ;-) %%  ;-)  %%
-  * ^_^ %%  ^_^  %%
-  * :?: %%  :?:  %%
-  * :!: %%  :!:  %%
-  * LOL %%  LOL  %%
-  * FIXME %%  FIXME %%
-  * 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.
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
-"He thought 'It's a man's world'..."
-<code>
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
-"He thought 'It's a man's world'..."
-</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:
-  I think we should do it
-  > No we shouldn't
-  >> Well, I say we should
-  > Really?
-  >> Yes!
-  >>> Then lets do it!
-I think we should do it
-> No we shouldn't
->> Well, I say we should
-> Really?
->> Yes!
->>> Then lets do it!
-===== Blockquote =====
-The following code
-<code>
-<blockquote>
-Test with loads of markup...
-Another paragraph with a little [[http://nowhere|link]] to nowhere. Oh, and while we are at it, what about some **bold**, some //italic// and some __underlined__ text? And finally, an itemization:
-  * item 1
-    * item 1.1
-    * item 1.2
-  * item 2
-    - ordered item 2.1
-    - ordered item 2.2
-      - ordered item 2.2.1
-  * item 3
-Works :-)
-</blockquote>
-</code>
-results in
-<blockquote>
-Test with loads of markup...
-Another paragraph with a little [[http://nowhere|link]] to nowhere. Oh, and while we are at it, what about some **bold**, some //italic// and some __underlined__ text? And finally, an itemization:
-  * item 1
-    * item 1.1
-    * item 1.2
-  * item 2
-    - ordered item 2.1
-    - ordered item 2.2
-      - ordered item 2.2.1
-  * item 3
-Works :-)
-</blockquote>
-==== Cite attribute ====
-The following code
-  <blockquote J. Random Hacker>Test with a cite attribute...</blockquote>
-results in
-<blockquote J. Random Hacker>Test with a cite attribute...</blockquote>
-==== Cite command ====
-The following code
-  <blockquote>Test with a cite command...<cite>J. Random Hacker, [[http://localhost/~jrhacker]]</cite></blockquote>
-results in
-<blockquote>Test with a cite command...<cite>J. Random Hacker, [[http://localhost/~jrhacker]]</cite></blockquote>
-===== Tables =====
-DokuWiki supports a simple syntax to create tables.
-^ Heading 1      ^ Heading 2       ^ Heading 3          ^
-| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
-| Row 2 Col 1    | some colspan (note the double pipe) ||
-| 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.
-  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^
-  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
-  | Row 2 Col 1    | some colspan (note the double pipe) ||
-  | 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!
-Vertical tableheaders are possible, too.
-|              ^ Heading 1            ^ Heading 2          ^
-^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
-^ Heading 4    | no colspan this time |                    |
-^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
-As you can see, it's the cell separator before a cell which decides about the formatting:
-  |              ^ Heading 1            ^ Heading 2          ^
-  ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
-  ^ Heading 4    | no colspan this time |                    |
-  ^ 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.
-^ 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.
-^           Table with alignment           ^^^
-|         right|    center    |left          |
-|left          |         right|    center    |
-| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
-This is how it looks in the source:
-  ^           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 =====
-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>
-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 ====
-[[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>''.
-<code java>
-/**
- * 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>
-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 ====
-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 to this by specifying a file name after language code like this:
-<code>
-<file php myexample.php>
-<?php echo "hello world!"; ?>
-</file>
-</code>
-<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 '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 |
-===== MathJax =====
-==== Examples/Usage ====
-NOTE that the default configuration uses $ (dollar signs) to delimit TeX formulas. This may cause trouble if you have $ characters in any pages. The default configuration also lets you escape the dollar signs, however, by changing them to '\$'. This should correct any problems you might have.
-Once the plugin is installed, you can write TeX formulas in your wiki with the following syntax (by default — all delimiters are configurable):
-=== Inline Math ===
-Use dollar signs:
-  $a^2 + b^2 = c^2$
-$a^2 + b^2 = c^2$
-or escaped parentheses:
-  \(1+2+\dots+n=\frac{n(n+1)}{2}\)
-\(1+2+\dots+n=\frac{n(n+1)}{2}\)
-=== Display Math ===
-To display math on its own line, use double dollar signs:
-  $$ \frac{d}{dx}\left( \int_{0}^{x} f(u)\,du\right)=f(x) $$
-$$ \frac{d}{dx}\left( \int_{0}^{x} f(u)\,du\right)=f(x) $$
-or escaped square brackets:
-  \[ \sin A \cos B = \frac{1}{2}\left[ \sin(A-B)+\sin(A+B) \right] \]
-\[ \sin A \cos B = \frac{1}{2}\left[ \sin(A-B)+\sin(A+B) \right] \]
-===== SyntaxHighlighter3 =====
-==== Syntax and Usage ====
-Client side syntax highlighter (with copy to clipboard functionality) based on SyntaxHighlighter Plugin by David Shin. Main differences:
-=== Usage ===
-  <sxh [brush alias][; options for SyntaxHighlighter]>
-  ... code/text ...
-  </sxh>
-brush alias - The brush alias (language) that SyntaxHighlighter should use. Defaults to “text” if none is provided. See [[http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/|SyntaxHighlighter Brushes]] for a complete list of available brushes. Add new brushes to the scripts directory (see plugin structure) and the alias(es) and brush file name to the available brushes string in Config Manager (example: ”…,bat cmd shBrushBat.js”). The brush file name is case sensitive.
-options - Semicolon separated options for SyntaxHighlighter, see [[http://alexgorbatchev.com/SyntaxHighlighter/manual/configuration/|SyntaxHighlighter Configuration]]. Block Title isn't a normal configuration option, but the plugin handles it as if it was, i.e. “title: <title string>;”. :!: Do not collapse code and hide the toolbar at the same time, title will not show.
-=== Example ===
-  <sxh php; first-line: 70; highlight: [89,92]; title: New title attribute in action>
-    public function render($mode, &$renderer, $data) {
-        if($mode != 'xhtml') return false;
-        if (count($data) == 3) {
-            list($syntax, $attr, $content) = $data;
-            if ($syntax == 'sxh') {
-                // Check if there's a title in the attribute string. It can't be passed along as a normal parameter to SyntaxHighlighter.
-                if (preg_match("/title:/i", $attr)) {
-                    // Extract title(s) from attribute string.
-                    $attr_array = explode(";",$attr);
-                    $title_array = preg_grep("/title:/i", $attr_array);
-                    // Extract everything BUT title(s) from attribute string.
-                    $not_title_array =  preg_grep("/title:/i", $attr_array, PREG_GREP_INVERT);
-                    $attr = implode(";",$not_title_array);
-                    // If there are several titles, use the last one.
-                    $title = array_pop($title_array);
-                    $title = preg_replace("/.*title:\s{0,}(.*)/i","$1",$title);
-                    // Add title as an attribute to the <pre /> tag.
-                    $renderer->doc .= "<pre class=\"brush: ".$attr."\" title=\"".$title."\">".$renderer->_xmlEntities($content)."</pre>";
-                } else {
-                    // No title detected, pass all attributes as parameters to SyntaxHighlighter.
-                    $renderer->doc .= "<pre class=\"brush: ".$attr."\">".$renderer->_xmlEntities($content)."</pre>";
-                }
-             } else {
-                $renderer->file($content);
-            }
-        }
-        return true;
-    }
-  </sxh>
-<sxh php; first-line: 70; highlight: [89,92]; title: New title attribute in action>
-    public function render($mode, &$renderer, $data) {
-        if($mode != 'xhtml') return false;
-        if (count($data) == 3) {
-            list($syntax, $attr, $content) = $data;
-            if ($syntax == 'sxh') {
-                // Check if there's a title in the attribute string. It can't be passed along as a normal parameter to SyntaxHighlighter.
-                if (preg_match("/title:/i", $attr)) {
-                    // Extract title(s) from attribute string.
-                    $attr_array = explode(";",$attr);
-                    $title_array = preg_grep("/title:/i", $attr_array);
-                    // Extract everything BUT title(s) from attribute string.
-                    $not_title_array =  preg_grep("/title:/i", $attr_array, PREG_GREP_INVERT);
-                    $attr = implode(";",$not_title_array);
-                    // If there are several titles, use the last one.
-                    $title = array_pop($title_array);
-                    $title = preg_replace("/.*title:\s{0,}(.*)/i","$1",$title);
-                    // Add title as an attribute to the <pre /> tag.
-                    $renderer->doc .= "<pre class=\"brush: ".$attr."\" title=\"".$title."\">".$renderer->_xmlEntities($content)."</pre>";
-                } else {
-                    // No title detected, pass all attributes as parameters to SyntaxHighlighter.
-                    $renderer->doc .= "<pre class=\"brush: ".$attr."\">".$renderer->_xmlEntities($content)."</pre>";
-                }
-             } else {
-                $renderer->file($content);
-            }
-        }
-        return true;
-    }
-</sxh>
-===== Gallery =====
-A basic gallery can be added by selecting a [[:namespaces|namespace]] like this:
-  {{gallery>namespace}}
-All image files in the selected namespace will be added to the image gallery. Don't forget the ":" in front of the namespace.
-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).
-  {{gallery>namespace:someimage.jpg}}
-The created gallery can be aligned by using white space (defaults to centered):
-  {{gallery> namespace}} (right aligned)
-  {{gallery>namespace }} (left aligned)
-  {{gallery> namespace }} (centered)
-Instead of a namespace, you can also give an HTTP(s) URL to any [[wp>Media RSS]] or ATOM feed with enclosures (as produced by most photo sharing sites like Flickr). The images will then be pulled from that feed instead:
-  {{gallery>http://www.23hq.com/rss/schabloni}}
-Note: since the question mark is used to separate the parameters (see next section) the URL can not contain any question mark. To use such a feed URL with the gallery plugin, just use one of the many short URL services like [[http://bit.ly]].
-E.g. instead of ''%%http://api.flickr.com/services/feeds/photos_public.gne?id=22019303@N00&lang=en-us&format=rss_200%%'' use a shortened URL like ''%%http://bit.ly/HurZM%%''.
-Additionally, to have thumbnail creation correctly working you need to set [[config:fetchsize]] big enough to get the remote images downloaded.
-==== Parameters ====
-A number of parameters can be set by appending them with ''?'' character to the namespace or image. Each parameter needs to be separated with a ''&'' character. Defaults for all parameters can be set in the config manager. If a parameter is enabled by default it can be disabled in the syntax by prefixing it with the syllable ''no''. E.g. the parameter ''cache'' is usually enabled and can be disabled using the keyword ''nocache''. Below is a list of all recognized parameters
-^ Parameter                      ^ Default         ^ Description    ^
-| ''//<number>//x//<number>//''  | ''%%120x120%%'' | Sets the size for thumbnails. Unless the crop option is set, this is a boundary box into which the thumbnail will be fitted, maintaining the correct aspect ratio. |
-| ''//<number>//X//<number>//''  | ''%%800X600%%'' | Sets the size for the linked images in ''direct'' mode. This is a boundary box into which the image will be fitted, maintaining the correct aspect ratio. Note the uppercase ''X''.|
-| ''//<number>//''               | ''5''           | The number images per row in the gallery table. If you specify a 0 no table is used instead all thumbnails are added in a sequence. |
-| ''=//<number>//''              | ''=0''          | Limits the output to the given number of images. ''0'' means all. |
-| ''+//<number>//''              | ''+0''          | Skip the first number of images. Useful with the option above. |
-| ''~//<number>//''              | ''~0''          | Add a pagination for the thumbnails displaying the number of given thumbnails per page. ''0'' disables pagination. Pagination is added through JavaScript - when no JavaScript is available all thumbnails are displayed |
-| ''cache''                      | enabled         | Usually the output of the created gallery is cached. When the images in your selected namespace change, you have to manually force an update of the gallery page's [[:caching|cache]]. To disable the cache for the page showing the gallery, set ''nocache'' as option. |
-| ''crop''                       | disabled        | Make thumbnails the exact given thumbnail size big, cropping when needed. |
-| ''direct''                     | disabled        | Link thumbnails with the bigger sized images not with their detail page |
-| ''lightbox''                   | disabled        | Show images in a fancy JavaScript modal browsing window, see below for details. Setting this option automatically implies the ''direct'' mode |
-| ''reverse''                    | disabled        | Reverse the order of the displayed images |
-| ''recursive''                  | enabled         | Find images in the given namespace and all sub namespaces |
-| ''random''                     | disabled        | Sort images randomly. You might want to use ''nocache'' as well |
-| ''modsort''                    | disabled        | Sort images by file modification date |
-| ''datesort''                   | disabled        | Sort images by EXIF date |
-| ''titlesort''                  | disabled        | Sort images by EXIF title |
-| ''showname''                   | disabled        | Show filename below thumbnails |
-| ''showtitle''                  | disabled        | Show EXIF title below thumbnails |
-| anything containing a ''*''    | jpg,gif,png images | This can be used to filter the list of files found in the given namespace. ''*'' work as simple wildcard symbol. |
-__Example__:
-  {{gallery>images:vacation?image_*.jpg&80x80&crop&lightbox}}
-This displays all images beginning with ''image_'' and ending in ''.jpg'' from the namespace ''images:vacation''. Thumbnails are cropped to 80x80 pixels and images will be opened in lightbox mode.
-__Example__:
-  {{gallery>?crop&lightbox}}
-This displays all images in the current namespace using 2 parameters. Parameterlist begins with ''?'' additional ones are concatenated with ''&''.
-==== About the Lightbox mode ====
-This mode will open the clicked picture inside the current browser window without leaving the current page((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)). 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.
-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.
-The following keys can be used to navigate:
-^ Key             ^ Action ^
-| ''->'' or ''n'' | next image |
-| ''<-'' or ''p'' | previous image |
-| ''x'' or ''c'' or ''ESC'' | close the image view |
-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.
-==== Known Limitations and Caveats ====
-=== Uploading Images ===
-Uploading images is beyond the scope of this plugin. Do not request any features regarding this.
-  * Use the [[:Mediamanager]] to upload images one by one
-  * Use the [[plugin:archiveupload]] plugin to upload multiple images in a Zip file
-  * Use the Flash Uploader to upload multiple files
-  * Upload the files manually via FTP to the ''data/media'' directory. Keep in mind that image names need to be valid [[:pagenames]], all lowercase, no spaces or special chars!
-=== Caching ===
-The gallery output is cached by default. When you add pictures later, they may not show up in the gallery: add ''&purge=true'' to the end of the URL to clear the cache. See [[:caching]] for details.
-Optionally use the ''nocache'' parameter of the plugin (not recommended).
-=== EXIF Data Problems ===
-Problems with accessing [[:exif|EXIF or IPTC]] data in the images, should be reported as DokuWiki bugs and not for this plugin. All EXIF handling is in DokuWiki core. Currently EXIF Data is expected in UTF-8 encoding. There are some problems fetching the correct date from images, these are fixed in the current [[devel:develonly|development]] version of DokuWiki.
-=== Lightbox Problems ===
-When the lightbox mode doesn't work and instead images are simply opened in the same window, the JavaScript was not correctly loaded. This is most likely a Browser-Cache issue. Simply follow the steps described for fixing a similar problem with the [[faq:toolbar]]. Also make sure you don't have any conflicting plugin installed. You should **not** install any additional lightbox plugin.
-=== Images are not Resized ===
-There are different reasons why thumbnails are not created:
-  * libGD extension is missing => Install the extension or configure DokuWiki to use [[config:im_convert|imagemagick]]
-  * libGD extension is installed, but the source image size + overhead is larger than memory_limit set in php.ini => Lower the source image size or increase the memory_limit
-=== MediaRSS feed displays "nothing found" ===
-When no images from your feed are shown, be sure you don't have a question mark in your URL. Use an URL shortener as suggested above. Also be sure your feed URL (before shortening) starts with %%http://%% or %%https://%% and not with %%feed://%%. The latter is just a renamed HTTP link - simply rename it back.
-=== External Images are not Resized ===
-As written above, you need to increase the [[config:fetchsize]] config option. Also make sure LibGD or ImageMagick are installed.
-===== Cumulus =====
-<code>~~CUMULUS[&flag=value]~~</code>
-  * **flag** can be one or several (separated by & ) of:
-    * //max//    --- Maximum number of words displayed
-    * //width// --- Width in pixels (500 or more is recommended)
-    * //height//  --- Height in pixels (ideally around 3/4 of the width)
-    * //tcolor//  --- Color of the tags (6 char HEX color value without the ‘#’ prefix)
-    * //tcolor2//  --- Optional second color for gradient between small and large font links (6 char HEX color value without the ‘#’ prefix)
-    * //hicolor//  --- Optional highlight color (6 char HEX color value without the ‘#’ prefix)
-    * //bgcolor//  --- Background color (6 char HEX color value without the ‘#’ prefix)
-    * //trans//  --- Background transparency (true|false)
-    * //distr//  --- Distribute tags evenly on sphere (true|false)
-    * //speed//  --- Rotation speed (percentage, default is 100)
-    * //show//  --- By default a word cloud is displayed. By using ''show=tag'' the plugin shows tags from the [[plugin:tag]] plugin instead. The alternative ''show=namespace'' displays all namespaces in the wiki root.
-**Example:**
-<code>~~CUMULUS&max=20&bgcolor=000000&distr=true&show=tags~~</code>
-{{http://cloud.github.com/downloads/HakanS/dokuwiki-plugin-cumulus/cumulus.png}}
-==== Configuration ====
-All properties described above can also be set in the [[plugin:config|configuration manager]].
-**showtags** --- The plugin always includes all tags as standard HTML <a> links in a hidden <div> for SEO purposes but this setting decides if it should be visible as a "standard" tag cloud if the users browser doesn't support Flash 9 movies. The cloud will have same CSS class as the [[plugin:cloud]].
-===== Comments =====
-This tiny [[plugins|plugin]] allows you to leave notes to yourself (and other authors of your wiki) in the wiki source code that won't be shown on the wiki page. The syntax is like C and PHP:
-**Example:**
-<code>
-The text /* between the slash-asterisk and asterisk-slash */ is hidden
-</code>
-**Becomes:**
-  The text is hidden
-\\
-You can also have multi-line comments:
-  /**
-   * @todo: rewrite this section to reflect changes made recently
-   *
-   * this is a longer note
-   */
-But this single line example works too:
-  /********** added by Esther **********/
-===== note =====
-  <note>
-  This is my note ! Remember it!!
-  </note>
-<note>
-This is my note ! Remember it!!
-</note>
-  <note important>
-  Warning ! You're about to lose your mind ;-)
-  </note>
-<note important>
-Warning ! You're about to lose your mind ;-)
-</note>
-  <note tip>
-  The clues are in the images.
-  </note>
-<note tip>
-The clues are in the images.
-</note>
-  <note warning>
-  Beware of the dog when you open the door !!
-  </note>
-<note warning>
-Beware of the dog when you open the door !!
-</note>
-===== Graphviz =====
-Any Graphviz compatible graph definition can be given with graphviz tags.
-The rendering engine can optionally be given as argument in the opening tag. Supported are dot, neato, twopi, circo and fdp with dot being the default.
-You can also specify left, center or right to align the resulting image.
-A parameter in the form of <number>x<number> is interpreted as wanted output size.
-<code>
-<graphviz dot center 500x200>
-digraph finite_state_machine {
-	rankdir=LR;
-	size="9,5"
-	node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
-	node [shape = circle];
-	LR_0 -> LR_2 [ label = "SS(B)" ];
-	LR_0 -> LR_1 [ label = "SS(S)" ];
-	LR_1 -> LR_3 [ label = "S($end)" ];
-	LR_2 -> LR_6 [ label = "SS(b)" ];
-	LR_2 -> LR_5 [ label = "SS(a)" ];
-	LR_2 -> LR_4 [ label = "S(A)" ];
-	LR_5 -> LR_7 [ label = "S(b)" ];
-	LR_5 -> LR_5 [ label = "S(a)" ];
-	LR_6 -> LR_6 [ label = "S(b)" ];
-	LR_6 -> LR_5 [ label = "S(a)" ];
-	LR_7 -> LR_8 [ label = "S(b)" ];
-	LR_7 -> LR_5 [ label = "S(a)" ];
-	LR_8 -> LR_6 [ label = "S(b)" ];
-	LR_8 -> LR_5 [ label = "S(a)" ];
-}
-</graphviz>
-</code>
-<graphviz dot center 500x200>
-digraph finite_state_machine {
-	rankdir=LR;
-	size="9,5"
-	node [shape = doublecircle]; LR_0 LR_3 LR_4 LR_8;
-	node [shape = circle];
-	LR_0 -> LR_2 [ label = "SS(B)" ];
-	LR_0 -> LR_1 [ label = "SS(S)" ];
-	LR_1 -> LR_3 [ label = "S($end)" ];
-	LR_2 -> LR_6 [ label = "SS(b)" ];
-	LR_2 -> LR_5 [ label = "SS(a)" ];
-	LR_2 -> LR_4 [ label = "S(A)" ];
-	LR_5 -> LR_7 [ label = "S(b)" ];
-	LR_5 -> LR_5 [ label = "S(a)" ];
-	LR_6 -> LR_6 [ label = "S(b)" ];
-	LR_6 -> LR_5 [ label = "S(a)" ];
-	LR_7 -> LR_8 [ label = "S(b)" ];
-	LR_7 -> LR_5 [ label = "S(a)" ];
-	LR_8 -> LR_6 [ label = "S(b)" ];
-	LR_8 -> LR_5 [ label = "S(a)" ];
-}
-</graphviz>
-[[wp>DOT_language]]
-===== vshare =====
-The basic syntax looks like this: ''%%{{%%//videosite//>//videoid//?//size//|title%%}}%%''. Where ''//videosite//'' is one of the identifiers listed below, and ''//videoid//'' is the identifier of the video at the respective site. The ''//size//'' parameter is optional. You can either give it in the form ''//width//x//height//'' like ''500x300'', or use the keywords ''small'', ''medium'' or ''large''. The title is optional as well. The video can be aligned by adding spaces on the left or right inside the curly brackets (like in the image syntax).
-A toolbar button pops up a prompt where you can simply paste the full URL to the page of the video you want to embed. The plugin will then try to figure out the video ID by itself.
-==== Examples ====
-Display a YouTube Video:
-  {{youtube>L-WM8YxwqEU}}
-Show a larger player:
-  {{youtube>L-WM8YxwqEU?large}}
-Right-align the player :
-  {{ youtube>L-WM8YxwqEU}}
-Show a small, centered player:
-  {{ youtube>L-WM8YxwqEU?small }}
-Show a small, centered player with a title:
-  {{ youtube>L-WM8YxwqEU?small |Some funny video}}
-==== Supported Services ====
-^ Identifier  ^ Website  ^ Notes ^
-| 12seconds   | [[http://12seconds.tv|12 Seconds]]           |  |
-| 5min        | [[http://www.5min.com/|5min]]                |  |
-| bambuser    | [[http://bambuser.com|Bambuser]]             | The video ID is in the embed code, not in the URL |
-| bliptv      | [[http://blip.tv/|Blip.TV]]                  | You get the correct id when choosing to embed for wordpress.com: {{gallery>:plugin:blipexample.png?lightbox}}|
-| blogtv      | [[http://www.blogtv.com|BlogTV]]             |  |
-| break       | [[http://www.break.com|Break]]               | The ID is in the embed code: {{gallery>:plugin:break.png?lightbox}} |
-| clipfish    | [[http://www.clipfish.de/|Clipfish]]         |  |
-| current     | [[http://www.current.com|Current]]           |  |
-| dailymotion | [[http://www.dailymotion.com/|Daily Motion]] |  |
-| googlevideo | [[http://video.google.com/|Google Video]]    |  |
-| gtrailers   | [[http://www.gametrailers.com|GameTrailers]] |  |
-| justintv    | [[http://justin.tv|Justin.TV]]               |  |
-| metacafe    | [[http://www.metacafe.com/|MetaCafe]]        |  |
-| myspacetv   | [[http://vids.myspace.com/|MySpaceTV]]       |  |
-| rcmovie     | [[http://www.rcmovie.de|RCMovie]]            |  |
-| revver      | [[http://www.revver.com/|Revver]]            |  |
-| scivee      | [[http://scivee.tv|Scivee.tv]]               |  |
-| sevenload   | [[http://www.sevenload.com/|Sevenload]]      |  |
-| slideshare  | [[http://www.slideshare.com|Slideshare]]     | The ID is not in the URL. Choose "more share options" and use the ''doc'' parameter from the wordpress embed code: {{gallery>:plugin:slideshare.png?lightbox}} |
-| stickam     | [[http://stickam.com|Stickam]]               |  |
-| ustream     | [[http://ustream.tv|Ustream.TV]]             |  |
-| veoh        | [[http://www.veoh.com/|Veoh]]                |  |
-| viddler     | [[http://www.viddler.com|Viddler]]           | Use the wordpress.com embed code: {{gallery>:plugin:viddler.png?lightbox}} |
-| vimeo       | [[http://www.vimeo.com/|Vimeo]]              | The video id is the number after http://vimeo.com/ |
-| youtube     | [[http://www.youtube.com/|YouTube]]          |  |
-Additional sites can be added to the ''sites.conf'' file in the plugin directory. Video ID recognition patterns for the toolbar button are configured in ''sites.js''.
-===== Slideshow =====
-See [[playground:slideshow|DokuWiki S5 Slideshows]] for an example.
-===== AV Task Box =====
-<code>
-<task>
-TITLE: A test task
-PRIORITY: High
-ESTIMATE: 4h
-PROGRESS: 10%
-ASSIGNED: Sherri
-DESCRIPTION: Some stuff for you. You can have newlines in this part. Description must be the last item.
-</task>
-</code>
-  * The labels for each item are //not// case sensitive. I just make them all caps to make them visible.
-  * Each item must take up only one line, except the description can be on multiple lines.
-  * The description will maintain newlines.
-  * The description must be the last item in the list before the </task> tag. The other items can be in any order before the description item.
-  * You can leave out any of the items(attributes), or leave them blank, and it will still look okay.
-  * The entire thing is wrapped in a span with the CSS class "avtaskbox" so you can style it in your CSS.
-<task>
-TITLE: A test task
-PRIORITY: High
-ESTIMATE: 4h
-PROGRESS: 10%
-ASSIGNED: Sherri
-DESCRIPTION: Some stuff for you. You can have newlines in this part. Description must be the last item.
-</task>
-===== 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~~

Technology in Crop Production

User Tools

Site Tools

Differences

Page Tools