This shows you the differences between two versions of the page.
wiki:syntax [2010/11/07 08:43] 127.0.0.1 external edit |
wiki:syntax [2018/07/09 18:34] (current) spfohl |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
- | [[doku> | + | [[doku> |
===== Basic Text Formatting ===== | ===== Basic Text Formatting ===== | ||
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | + | DokuWiki supports **bold**, //italic//, __underlined__ and '' |
+ | < | ||
+ | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
+ | Of course you can **__//'' | ||
+ | </ | ||
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | + | You can use < |
- | Of course you can **__//'' | + | < |
- | + | You can use < | |
- | You can use < | + | </ |
- | + | ||
- | You can use < | + | |
You can mark something as < | You can mark something as < | ||
- | + | < | |
- | You can mark something as < | + | You can mark something as < |
+ | </ | ||
**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. | **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 | + | This is some text with some \linebreaks |
- | two backslashes are only recognized at the end of a line\\ | + | Note that the two backslashes are only recognized at the end of a \line |
- | or followed | + | or followed \by |
+ | a whitespace \\this happens without it. | ||
- | | + | < |
- | two backslashes are only recognized at the end of a line\\ | + | This is some text with some \linebreaks |
- | or followed by\\ a whitespace \\this happens without it. | + | Note that the |
+ | two backslashes are only recognized at the end of a line | ||
+ | or followed | ||
+ | a whitespace \\this happens without it. | ||
+ | </ | ||
You should use forced newlines only if really needed. | You should use forced newlines only if really needed. | ||
Line 36: | Line 44: | ||
==== External ==== | ==== External ==== | ||
- | External links are recognized automagically: | + | External links are recognized automagically: |
+ | - You can set the link text as well: [[http:// | ||
- | | + | < |
- | automagically: | + | DokuWiki supports multiple ways of creating links. External links are recognized |
- | link text as well: [[http:// | + | automagically: |
- | addresses like this one: < | + | link text as well: [[http:// |
+ | addresses like this one: < | ||
+ | </ | ||
==== Internal ==== | ==== 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 [[:wiki:pagename|]] or use an additional [[:wiki:pagename|link text]]. |
- | | + | < |
- | 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> | [[doku> | ||
- | You can use [[some: | + | You can use [[:some: |
- | | + | < |
+ | You can use [[some: | ||
+ | </ | ||
- | For details about namespaces see [[doku> | + | For details about namespaces see [[doku> |
- | 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# | + | Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[:wiki:syntax# |
- | | + | < |
+ | This links to [[syntax# | ||
+ | </ | ||
Notes: | Notes: | ||
- | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | + | * Links to [[:wiki:syntax|existing pages]] are shown in a different style from [[:wiki:nonexisting|]] ones. |
- | * DokuWiki does not use [[wp> | + | * DokuWiki does not use [[wp> |
* When a section' | * When a section' | ||
==== Interwiki ==== | ==== Interwiki ==== | ||
- | DokuWiki supports [[doku> | + | DokuWiki supports [[doku> |
- | | + | < |
- | For example this is a link to Wikipedia' | + | DokuWiki supports [[doku> |
+ | For example this is a link to Wikipedia' | ||
+ | </ | ||
==== Windows Shares ==== | ==== 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> | + | 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> |
- | | + | < |
+ | Windows Shares like [[\\server\share|this]] are recognized, too. | ||
+ | </ | ||
Notes: | Notes: | ||
Line 86: | Line 107: | ||
* For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http:// | * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http:// | ||
- | | + | < |
+ | $lang[' | ||
+ | </ | ||
==== Image Links ==== | ==== Image Links ==== | ||
Line 92: | Line 115: | ||
You can also use an image to link to another internal or external page by combining the syntax for links and [[# | You can also use an image to link to another internal or external page by combining the syntax for links and [[# | ||
- | [[http:// | + | < |
[[http:// | [[http:// | ||
+ | </ | ||
+ | |||
+ | [[http:// | ||
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. | ||
Line 102: | Line 127: | ||
===== Footnotes ===== | ===== Footnotes ===== | ||
+ | You can add footnotes ((This is a footnote)) | ||
+ | |||
+ | < | ||
You can add footnotes ((This is a footnote)) by using double parentheses. | You can add footnotes ((This is a footnote)) by using double parentheses. | ||
- | + | </ | |
- | You can add footnotes ((This is a footnote)) by using double parentheses. | + | |
===== Sectioning ===== | ===== Sectioning ===== | ||
- | 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 | + | 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 |
==== Headline Level 3 ==== | ==== Headline Level 3 ==== | ||
+ | |||
=== Headline Level 4 === | === Headline Level 4 === | ||
+ | |||
== Headline Level 5 == | == Headline Level 5 == | ||
- | | + | < |
- | === Headline Level 4 === | + | ==== Headline Level 3 ==== |
- | == Headline Level 5 == | + | === Headline Level 4 === |
+ | == Headline Level 5 == | ||
+ | </ | ||
By using four or more dashes, you can make a horizontal line: | By using four or more dashes, you can make a horizontal line: | ||
Line 124: | Line 155: | ||
===== Images and Other Files ===== | ===== Images and Other Files ===== | ||
- | You can include external and internal [[doku> | + | You can include external and internal [[doku> |
- | Real size: {{wiki: | + | Real size: {{:wiki: |
- | Resize to given width: | + | Resize to given width: {{:wiki: |
- | Resize to given width and height((when the aspect ratio of the given width and height doesn' | + | Resize to given width and height((when the aspect ratio of the given width and height doesn' |
+ | Resized external image: {{http:// | ||
+ | |||
+ | < | ||
+ | Real size: {{wiki: | ||
+ | Resize to given width: | ||
+ | Resize to given width and height: {{wiki: | ||
Resized external image: | Resized external image: | ||
+ | </ | ||
- | Real size: {{wiki: | + | By using left or right whitespaces you can choose the alignment. |
- | Resize to given width: | + | |
- | Resize to given width and height: {{wiki: | + | |
- | Resized external image: | + | |
+ | {{ : | ||
- | By using left or right whitespaces you can choose the alignment. | + | {{: |
- | {{ wiki: | + | {{ :wiki: |
+ | < | ||
+ | {{ wiki: | ||
{{wiki: | {{wiki: | ||
- | |||
{{ wiki: | {{ wiki: | ||
- | + | </ | |
- | {{ wiki: | + | |
- | {{wiki: | + | |
- | {{ wiki: | + | |
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. | ||
+ | {{ : | ||
+ | |||
+ | < | ||
{{ wiki: | {{ wiki: | ||
- | + | </ | |
- | {{ wiki: | + | |
If you specify a filename (external or internal) that is not an image ('' | If you specify a filename (external or internal) that is not an image ('' | ||
- | For linking an image to another page see [[#Image Links]] above. | + | For linking an image to another page see [[#image_links|Image Links]] above. |
===== Lists ===== | ===== Lists ===== | ||
- | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' | + | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' |
* This is a list | * This is a list | ||
* The second item | * The second item | ||
- | | + | |
* Another item | * Another item | ||
- The same list but ordered | - The same list but ordered | ||
- Another item | - Another item | ||
- | | + | |
- That's it | - That's it | ||
Line 198: | Line 234: | ||
==== Text to Image Conversions ==== | ==== Text to Image Conversions ==== | ||
- | DokuWiki converts commonly used [[wp> | + | DokuWiki converts commonly used [[wp> |
- | * 8-) %% | + | * 8-) < |
- | * 8-O %% | + | * 8-O < |
- | * :-( %% | + | * :-( < |
- | * :-) %% | + | * :-) < |
- | * =) | + | * =) < |
- | * :-/ %% | + | * :-/ < |
- | * :-\ %% | + | * :-" class= < |
- | * :-? %% | + | * :-? < |
- | * :-D %% | + | * :-D < |
- | * :-P %% | + | * :-P < |
- | * :-O %% | + | * :-O < |
- | * :-X %% | + | * :-X < |
- | * :-| %% | + | * :-| < |
- | * ;-) %% | + | *;-) < |
- | * ^_^ %% | + | * ^_^ < |
- | * :?: %% | + | * :?: < |
- | * :!: %% | + | * :!: < |
- | * LOL %% | + | * LOL < |
- | * FIXME %% | + | * FIXME < |
- | * DELETEME | + | * DELETEME |
==== Text to HTML Conversions ==== | ==== Text to HTML Conversions ==== | ||
- | Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | + | Typography: [[: |
- | -> <- <-> => <= <=> >> << | + | → <- <→ ⇒ <= <⇒>> <<– — 640×480 © ™ ® "He thought ' |
- | "He thought ' | + | |
< | < | ||
- | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | + | -> <- <-> => <= < |
"He thought ' | "He thought ' | ||
</ | </ | ||
Line 235: | Line 270: | ||
The same can be done to produce any kind of HTML, it just needs to be added to the [[doku> | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku> | ||
- | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' | + | There are three exceptions which do not come from that pattern file: multiplication entity (640×480), ' |
===== Quoting ===== | ===== Quoting ===== | ||
Line 241: | Line 276: | ||
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 | |
- | | + | > No we shouldn' |
- | + | >> Well, I say we should | |
- | | + | |
- | + | > Really? | |
- | > Really? | + | >> Yes! |
- | + | ||
- | | + | >>> |
- | + | </ | |
- | >>> | + | |
I think we should do it | I think we should do it | ||
Line 269: | Line 303: | ||
DokuWiki supports a simple syntax to create 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 '''' | ||
+ | |||
+ | < | ||
^ 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 3 Col 2 | Row 3 Col 3 | | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | ||
- | + | </ | |
- | Table rows have to start and end with a '' | + | |
- | + | ||
- | ^ 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, | To connect cells horizontally, | ||
Line 285: | Line 321: | ||
Vertical tableheaders are possible, too. | Vertical tableheaders are possible, too. | ||
- | | ^ Heading 1 ^ Heading 2 ^ | + | | ^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 3 | Row 1 Col 2 | Row 1 Col 3 | | ||
- | ^ Heading 4 | no colspan this time | | | + | ^ Heading 4 | no colspan this time | |
^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ^ 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: | + | You can have rowspans (vertically connected cells) by adding |
- | | | + | ^Heading 1 ^Heading 2 ^Heading 3 | |
- | ^ Heading 3 | Row 1 Col 2 | + | |Row 1 Col 1 |this cell spans vertically|Row 1 Col 3 | |
- | | + | |Row 2 Col 1 |
- | ^ Heading 5 | + | |Row 3 Col 1 | ::: |Row 2 Col 3 | |
- | You can have rowspans (vertically connected cells) by adding '':::'' | + | Apart from the rowspan syntax those cells should |
+ | < | ||
^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | ||
| Row 2 Col 1 | ::: | Row 2 Col 3 | | | Row 2 Col 1 | ::: | Row 2 Col 3 | | ||
| Row 3 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. | + | 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 |
- | | Row 1 Col 1 | + | | right| |
- | | Row 2 Col 1 | + | |left |
- | | Row 3 Col 1 | + | |xxxxxxxxxxxx|xxxxxxxxxxxx|xxxxxxxxxxxx| |
- | 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. | + | This is how it looks in the source: |
+ | < | ||
^ Table with alignment | ^ Table with alignment | ||
| | | | ||
|left | | |left | | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | + | </ | |
- | This is how it looks in the source: | + | |
- | + | ||
- | ^ Table with alignment | + | |
- | | | + | |
- | |left | | + | |
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | + | |
Note: Vertical alignment is not supported. | Note: Vertical alignment is not supported. | ||
Line 329: | Line 371: | ||
===== No Formatting ===== | ===== No Formatting ===== | ||
- | If you need to display text exactly like it is typed (without any formatting), | + | If you need to display text exactly like it is typed (without any formatting), |
+ | < | ||
+ | |||
+ | < | ||
< | < | ||
This is some text which contains addresses like this: http:// | This is some text which contains addresses like this: http:// | ||
</ | </ | ||
- | The same is true for %%//__this__ text// with a smiley ;-)%%. | + | The same is true for < |
- | + | </code> | |
- | | + | |
- | This is some text which contains addresses like this: http:// | + | |
- | </nowiki> | + | |
- | The same is true for %%// | + | |
===== Code Blocks ===== | ===== 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 '' | + | 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 ''< |
- | | + | < |
+ | This is text is indented by two spaces. | ||
+ | </ | ||
< | < | ||
Line 357: | Line 400: | ||
Those blocks were created by this source: | Those blocks were created by this source: | ||
- | | + | < |
+ | | ||
+ | </ | ||
- | | + | < |
- | This is preformatted code all spaces are preserved: like <-this | + | '' |
- | </ | + | This is preformatted code all spaces are preserved: like <-this |
- | | + | '' |
- | This is pretty much the same, but you could use it to show that you quoted a file. | + | </code> |
- | </file> | + | |
+ | < | ||
+ | |||
+ | This is pretty much the same, but you could use it to show that you quoted a file. | ||
+ | </code> | ||
==== Syntax Highlighting ==== | ==== Syntax Highlighting ==== | ||
- | [[wiki: | + | [[:wiki:dokuwiki|DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http:// |
<code java> | <code java> | ||
Line 387: | Line 436: | ||
==== Downloadable Code Blocks ==== | ==== Downloadable Code Blocks ==== | ||
- | When you use the '' | + | When you use the ''< |
< | < | ||
Line 399: | Line 448: | ||
</ | </ | ||
- | If you don't want any highlighting but want a downloadable file, specify a dash ('' | + | If you don't want any highlighting but want a downloadable file, specify a dash ('' |
===== Embedding HTML and PHP ===== | ===== Embedding HTML and PHP ===== | ||
- | You can embed raw HTML or PHP code into your documents by using the '' | + | You can embed raw HTML or PHP code into your documents by using the '' |
HTML example: | HTML example: | ||
Line 417: | Line 465: | ||
</ | </ | ||
- | < | + | < |
- | This is some <span style=" | + | |
- | </ | + | |
- | < | + | |
- | <p style=" | + | |
- | </ | + | |
PHP example: | PHP example: | ||
Line 439: | Line 482: | ||
</ | </ | ||
- | <php> | + | <php> echo 'A logo generated by PHP:'; echo '< |
- | echo 'A logo generated by PHP:'; | + | |
- | echo '< | + | |
- | echo ' | + | |
- | </ | + | |
- | <PHP> | + | |
- | echo '< | + | |
- | echo '< | + | |
- | echo '</ | + | |
- | </ | + | |
**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 ===== | ===== RSS/ATOM Feed Aggregation ===== | ||
- | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | ||
- | ^ Parameter | + | [[:wiki: |
- | | any number | will be used as maximum number items to show, defaults to 8 | | + | |
- | | reverse | + | |
- | | author | + | |
- | | date | show item dates | | + | |
- | | description| show the item description. If [[doku> | + | |
- | | //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: | + | ^Parameter |
+ | |any number|will be used as maximum number items to show, defaults to 8| | ||
+ | |reverse | ||
+ | |author | ||
+ | |date |show item dates| | ||
+ | |description|show the item description. If [[doku> | ||
+ | |//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|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|DokuWiki]] to re-render the page if it is more than //refresh period// | ||
**Example: | **Example: | ||
- | | + | < |
+ | {{rss> | ||
+ | </ | ||
{{rss> | {{rss> | ||
- | |||
===== Control Macros ===== | ===== Control Macros ===== | ||
Line 476: | Line 512: | ||
Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: | Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: | ||
- | ^ Macro | + | ^Macro |
- | | %%~~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 ===== | ===== Syntax Plugins ===== | ||
Line 485: | Line 521: | ||
~~INFO: | ~~INFO: | ||
+ | |||
+ | |||
+ | |||