This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
wiki:syntax [2008/05/05 18:56] – fantasai | wiki:syntax [2014/12/09 15:48] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
- | [[wiki: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: | + | [[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: |
- | ===== Markdown | + | ===== Basic Text Formatting |
- | < | + | DokuWiki |
- | This wiki supports | + | |
- | </ | + | |
- | + | | |
- | ===== Basic text formatting ===== | + | |
- | + | ||
- | DokuWiki supports **strong**, //em// __underlined em__ and '' | + | |
- | + | ||
- | DokuWiki supports **strong**, //em// __underlined em__ and '' | + | |
Of course you can **__//'' | Of course you can **__//'' | ||
Line 43: | Line 36: | ||
==== External ==== | ==== External ==== | ||
- | External links are recognized automagically: | + | External links are recognized automagically: |
DokuWiki supports multiple ways of creating links. External links are recognized | DokuWiki supports multiple ways of creating links. External links are recognized | ||
automagically: | automagically: | ||
- | | + | |
addresses like this one: < | addresses like this one: < | ||
==== Internal ==== | ==== Internal ==== | ||
- | Internal links are created by using square brackets. You can either just give a [[doku> | + | 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 [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames | + | a [[pagename]] or use an additional [[pagename|link text]]. |
- | are converted to lowercase automatically, | + | |
- | You can use [[wiki: | + | [[doku> |
- | | + | You can use [[some: |
- | For details about namespaces see [[doku>wiki:namespaces]]. | + | You can use [[some: |
+ | |||
+ | 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 [[syntax# | ||
Line 70: | Line 64: | ||
Notes: | Notes: | ||
- | * Links to [[wiki:syntax|existing pages]] are shown in a different style from [[wiki: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' | ||
==== Interwiki ==== | ==== Interwiki ==== | ||
- | DokuWiki supports [[doku>wiki: | + | DokuWiki supports [[doku> |
- | DokuWiki supports [[doku>wiki: | + | DokuWiki supports [[doku> |
For example this is a link to Wikipedia' | 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 homogenous | + | Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous |
Windows Shares like [[\\server\share|this]] are recognized, too. | Windows Shares like [[\\server\share|this]] are recognized, too. | ||
Line 91: | Line 84: | ||
* 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 the config option | + | * For Mozilla and Firefox it can be enabled through |
- | | + | |
+ | | ||
==== Image Links ==== | ==== Image Links ==== | ||
Line 128: | Line 122: | ||
---- | ---- | ||
- | ===== Images and other files ===== | + | ===== Images and Other Files ===== |
- | You can include external and internal [[doku>wiki:images]] with curly brackets. Optionally you can specify the size of them. | + | You can include external and internal [[doku> |
Real size: {{wiki: | Real size: {{wiki: | ||
Line 136: | Line 130: | ||
Resize to given width: | Resize to given width: | ||
- | Resize to given width and height: {{wiki: | + | Resize to given width and height((when the aspect ratio of the given width and height doesn' |
Resized external image: | Resized external image: | ||
Line 194: | Line 188: | ||
</ | </ | ||
- | ===== Smileys ===== | + | Also take a look at the [[doku> |
- | DokuWiki converts commonly used [[wp> | + | ===== 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, | ||
+ | |||
+ | ==== Text to Image Conversions ==== | ||
+ | |||
+ | DokuWiki converts commonly used [[wp> | ||
* 8-) %% 8-) %% | * 8-) %% 8-) %% | ||
Line 219: | Line 221: | ||
* DELETEME %% DELETEME %% | * DELETEME %% DELETEME %% | ||
- | ===== Typography ===== | + | ==== Text to HTML Conversions |
- | [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | + | Typography: |
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
Line 231: | Line 233: | ||
</ | </ | ||
- | Please note: These conversions | + | 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), ' | ||
===== Quoting ===== | ===== Quoting ===== | ||
Line 263: | Line 267: | ||
===== 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 '' | Table rows have to start and end with a '' | ||
Line 275: | Line 279: | ||
| 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, | To connect cells horizontally, | ||
Line 293: | Line 297: | ||
^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
- | Note: Vertical | + | You can have rowspans (vertically connected cells) by adding '' |
+ | |||
+ | ^ 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 309: | Line 325: | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | ===== Non-parsed Blocks ===== | + | Note: Vertical alignment is not supported. |
- | You can include | + | ===== No 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:// | ||
+ | </ | ||
+ | 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 318: | Line 352: | ||
< | < | ||
- | 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. |
</ | </ | ||
- | To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with '' | + | Those blocks were created by this source: |
- | <nowiki> | + | This is text is indented by two spaces. |
- | This is some text which contains addresses | + | |
- | </nowiki> | + | |
+ | This is preformatted code all spaces are preserved: | ||
+ | </code> | ||
- | See the source of this page to see how to use these blocks. | + | < |
+ | This is pretty much the same, but you could use it to show that you quoted a file. | ||
+ | </ | ||
- | ===== Syntax Highlighting | + | ==== Syntax Highlighting ==== |
- | [[DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http:// | + | [[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http:// |
<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 345: | Line 383: | ||
</ | </ | ||
- | The following language strings are currently recognized: // | + | The following language strings are currently recognized: //4cs, abap, actionscript-french, |
+ | ==== Downloadable Code Blocks ==== | ||
- | ===== RSS/ATOM Feed Aggregation ===== | + | When you use the '' |
- | [[DokuWiki]] can integrate data from external XML feeds. For parsing | + | |
- | ^ Parameter | + | < |
- | | any number | will be used as maximum number items to show, defaults to 8 | | + | <file php myexample.php> |
- | | reverse | + | <?php echo "hello world!"; |
- | | author | + | </file> |
- | | date | show item dates | | + | </code> |
- | | description| show the item description. If [[doku>wiki: | + | |
- | | //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. [[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 [[DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered. | + | <file php myexample.php> |
+ | <?php echo "hello world!"; | ||
+ | </file> | ||
- | **Example:** | + | If you don't want any highlighting but want a downloadable file, specify a dash ('' |
- | {{rss> | ||
- | |||
- | {{rss> | ||
===== 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: | ||
< | < | ||
< | < | ||
- | This is some <font color="red" | + | This is some <span style="color:red;font-size:150%;">inline |
</ | </ | ||
+ | < | ||
+ | <p style=" | ||
+ | </ | ||
</ | </ | ||
< | < | ||
- | This is some <font color="red" | + | This is some <span style="color:red;font-size:150%;">inline |
</ | </ | ||
+ | < | ||
+ | <p style=" | ||
+ | </ | ||
+ | |||
+ | PHP example: | ||
< | < | ||
Line 384: | Line 430: | ||
echo 'A logo generated by PHP:'; | echo 'A logo generated by PHP:'; | ||
echo '< | echo '< | ||
+ | echo ' | ||
</ | </ | ||
+ | <PHP> | ||
+ | echo '< | ||
+ | echo '< | ||
+ | echo '</ | ||
+ | </ | ||
</ | </ | ||
Line 390: | Line 442: | ||
echo 'A logo generated by PHP:'; | echo 'A logo generated by PHP:'; | ||
echo '< | 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 ===== | ||
+ | [[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 ===== | ||
+ | |||
+ | Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: | ||
+ | |||
+ | ^ Macro ^ Description | | ||
+ | | %%~~NOTOC~~%% | ||
+ | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%< | ||
===== Syntax Plugins ===== | ===== Syntax Plugins ===== | ||
- | DokuWiki' | + | DokuWiki' |
~~INFO: | ~~INFO: | ||