wiki:syntax
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
wiki:syntax [2011/11/05 06:58] – 124.6.181.161 | wiki:syntax [2012/10/07 04:13] – Reverted vandalism 98.248.89.12 | ||
---|---|---|---|
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 '' | ||
Line 50: | Line 50: | ||
a [[pagename]] or use an additional [[pagename|link text]]. | a [[pagename]] or use an additional [[pagename|link text]]. | ||
- | [[doku> | + | [[doku> |
You can use [[some: | You can use [[some: | ||
Line 65: | Line 65: | ||
* Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | ||
- | * DokuWiki does not use [[wp> | + | * DokuWiki does not use [[wp> |
* When a section' | * When a section' | ||
Line 74: | Line 74: | ||
DokuWiki supports [[doku> | DokuWiki supports [[doku> | ||
For example this is a link to Wikipedia' | For example this is a link to Wikipedia' | ||
+ | |||
==== Windows Shares ==== | ==== Windows Shares ==== | ||
Line 84: | Line 85: | ||
* For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone" | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone" | ||
- | * For Mozilla and Firefox it can be enabled through | + | * For Mozilla and Firefox it can be enabled through the config option |
- | + | | |
- | | + | |
==== Image Links ==== | ==== Image Links ==== | ||
Line 122: | Line 122: | ||
---- | ---- | ||
- | ===== Images and Other Files ===== | + | ===== Images and other files ===== |
You can include external and internal [[doku> | You can include external and internal [[doku> | ||
Line 188: | Line 188: | ||
</ | </ | ||
- | Also take a look at the [[doku> | + | ===== Smileys ===== |
- | ===== Text Conversions ===== | + | DokuWiki converts commonly used [[wp> |
- | + | ||
- | 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, | + | |
- | + | ||
- | ==== Text to Image Conversions ==== | + | |
- | + | ||
- | DokuWiki converts commonly used [[wp> | + | |
* 8-) %% 8-) %% | * 8-) %% 8-) %% | ||
Line 204: | Line 196: | ||
* :-( %% :-( %% | * :-( %% :-( %% | ||
* :-) %% :-) %% | * :-) %% :-) %% | ||
+ | |||
* =) %% =) %% | * =) %% =) %% | ||
* :-/ %% :-/ %% | * :-/ %% :-/ %% | ||
Line 221: | Line 214: | ||
* DELETEME %% DELETEME %% | * DELETEME %% DELETEME %% | ||
- | ==== Text to HTML Conversions | + | ===== Typography ===== |
- | Typography: | + | [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. |
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
Line 233: | Line 226: | ||
</ | </ | ||
- | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku> | + | Please note: These conversions |
- | + | ||
- | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' | + | |
===== Quoting ===== | ===== Quoting ===== | ||
Line 267: | Line 258: | ||
===== Tables ===== | ===== Tables ===== | ||
- | DokuWiki supports a simple syntax to create tables. | + | DokuWiki supports a simple syntax to create tables. |
^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
| Row 2 Col 1 | some colspan (note the double pipe) || | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
- | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | + | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | |
Table rows have to start and end with a '' | Table rows have to start and end with a '' | ||
Line 279: | Line 270: | ||
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
| Row 2 Col 1 | some colspan (note the double pipe) || | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
- | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | + | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | |
To connect cells horizontally, | To connect cells horizontally, | ||
Line 297: | Line 288: | ||
^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
- | You can have rowspans (vertically connected cells) by adding '' | + | Note: Vertical |
- | + | ||
- | ^ 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 | + | |
- | + | ||
- | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | + | |
- | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | + | |
- | | Row 2 Col 1 | ::: | Row 2 Col 3 | | + | |
- | | Row 3 Col 1 | ::: | Row 2 Col 3 | | + | |
You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. | You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. | ||
Line 325: | Line 304: | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | Note: Vertical alignment is not supported. | + | ===== Non-parsed Blocks ===== |
- | ===== No Formatting ===== | + | You can include |
- | + | ||
- | If you need to display text exactly like it is typed (without any formatting), | + | |
- | + | ||
- | < | + | |
- | This is some text which contains addresses like this: http:// | + | |
- | </ | + | |
- | The same is true for %%// | + | |
- | + | ||
- | < | + | |
- | This is some text which contains addresses like this: http:// | + | |
- | </ | + | |
- | The same is true for %%// | + | |
- | + | ||
- | ===== Code Blocks ===== | + | |
- | + | ||
- | You can include | + | |
- | + | ||
- | This is text is indented by two spaces. | + | |
< | < | ||
Line 352: | Line 313: | ||
< | < | ||
- | 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. |
</ | </ | ||
- | Those blocks were created by this source: | + | To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with '' |
- | | + | < |
+ | This is some text which contains addresses like this: http:// | ||
+ | </ | ||
- | < | + | See the source of this page to see how to use these blocks. |
- | This is preformatted code all spaces are preserved: like <-this | + | |
- | </ | + | |
- | < | + | ===== Syntax Highlighting ===== |
- | This is pretty much the same, but you could use it to show that you quoted a file. | + | |
- | </ | + | |
- | ==== Syntax Highlighting ==== | + | [[wiki: |
- | + | ||
- | [[wiki: | + | |
<code java> | <code java> | ||
- | /** | + | /** |
* The HelloWorldApp class implements an application that | * The HelloWorldApp class implements an application that | ||
* simply displays "Hello World!" | * simply displays "Hello World!" | ||
Line 383: | Line 340: | ||
</ | </ | ||
- | The following language strings are currently recognized: //4cs, abap, actionscript-french, | + | The following language strings are currently recognized: //abap, actionscript-french, |
- | ==== Downloadable Code Blocks ==== | ||
- | When you use the '' | + | ===== RSS/ATOM Feed Aggregation ===== |
+ | [[DokuWiki]] can integrate data from external XML feeds. For parsing | ||
- | < | + | ^ Parameter |
- | <file php myexample.php> | + | | any number | will be used as maximum number items to show, defaults to 8 | |
- | <?php echo "hello world!"; | + | | reverse |
- | </file> | + | | author |
- | </code> | + | | date | show item dates | |
+ | | description| show the item description. If [[doku>config: | ||
+ | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | ||
- | <file php myexample.php> | + | The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki: |
- | <?php echo "hello world!"; | + | |
- | </file> | + | |
- | If you don't want any highlighting but want a downloadable file, specify a dash ('' | + | **Example:** |
+ | {{rss> | ||
- | ===== Embedding HTML and PHP ===== | + | {{rss> |
- | You can embed raw HTML or PHP code into your documents by using the '' | ||
- | HTML example: | + | ===== Embedding |
+ | You can embed raw HTML or PHP code into your documents by using the '' | ||
< | < | ||
< | < | ||
Line 423: | Line 381: | ||
<p style=" | <p style=" | ||
</ | </ | ||
- | |||
- | PHP example: | ||
< | < | ||
Line 451: | Line 407: | ||
**Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. | **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. | ||
- | |||
- | ===== RSS/ATOM Feed Aggregation ===== | ||
- | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | ||
- | |||
- | ^ 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: | ||
- | |||
- | **Example: | ||
- | |||
- | {{rss> | ||
- | |||
- | {{rss> | ||
- | |||
===== Control Macros ===== | ===== Control Macros ===== |
wiki/syntax.txt · Last modified: 2022/10/01 16:26 by 127.0.0.1