Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
wiki:syntax [2005/02/10 20:11] – (alte Version wieder hergestellt) 127.0.0.1 | wiki:syntax [2024/08/15 09:47] (aktuell) – Externe Bearbeitung 127.0.0.1 | ||
---|---|---|---|
Zeile 1: | Zeile 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 | + | [[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 |
- | ===== Basic text formatting | + | ===== Basic Text Formatting |
DokuWiki supports **bold**, //italic//, __underlined__ and '' | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
Zeile 36: | Zeile 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> | + | You can use [[some: |
- | Linking to a specific section is possible, too. Just add the sectionname | + | 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# | ||
This links to [[syntax# | This links to [[syntax# | ||
Zeile 63: | Zeile 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>Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia' |
- | DokuWiki supports [[interwiki]] links. These are quick links to other Wikis. | + | 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. | ||
- | Note: | + | Notes: |
- | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer. | + | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer |
+ | * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http:// | ||
+ | <?php | ||
+ | /** | ||
+ | * Customization of the english language file | ||
+ | * Copy only the strings that needs to be modified | ||
+ | */ | ||
+ | $lang[' | ||
+ | </ | ||
==== Image Links ==== | ==== Image Links ==== | ||
- | You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this: | + | You can also use an image to link to another internal or external page by combining the syntax for links and [[# |
- | [[http://www.php.net|{{wiki: | + | [[http:// |
- | [[http://www.php.net|{{wiki: | + | [[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. | ||
+ | |||
+ | The whole [[# | ||
===== Footnotes ===== | ===== Footnotes ===== | ||
- | You can add footnotes ((This is a footnote)) by using double | + | You can add footnotes ((This is a footnote)) by using double |
- | You can add footnotes ((This is a footnote)) by using double | + | You can add footnotes ((This is a footnote)) by using double |
===== Sectioning ===== | ===== Sectioning ===== | ||
Zeile 116: | Zeile 127: | ||
---- | ---- | ||
- | ===== Images and other files ===== | + | ===== Media Files ===== |
- | You can include external and internal [[doku> | + | You can include external and internal [[doku> |
- | Real size: {{wiki:php-powered.png}} | + | Real size: {{wiki:dokuwiki-128.png}} |
- | Resize to given width: | + | Resize to given width: |
- | Resize to given width and height: {{wiki:php-powered.png?100x100}} | + | Resize to given width and height((when the aspect ratio of the given width and height doesn' |
- | Resized external image: | + | Resized external image: |
- | Real size: {{wiki:php-powered.png}} | + | Real size: {{wiki:dokuwiki-128.png}} |
- | Resize to given width: | + | Resize to given width: |
- | Resize to given width and height: {{wiki:php-powered.png?100x100}} | + | Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} |
- | Resized external image: | + | Resized external image: |
- | By using left or right whitespaces you can choose the alignment | ||
- | {{ wiki: | + | By using left or right whitespaces you can choose the alignment. |
- | {{wiki:php-powered.png }} | + | {{ wiki:dokuwiki-128.png}} |
- | {{ wiki:php-powered.png }} | + | {{wiki:dokuwiki-128.png }} |
- | | + | {{ wiki:dokuwiki-128.png }} |
- | {{wiki:php-powered.png }} | + | |
- | {{ wiki:php-powered.png }} | + | {{ wiki: |
+ | {{wiki:dokuwiki-128.png }} | ||
+ | {{ wiki:dokuwiki-128.png }} | ||
Of course, you can add a title (displayed as a tooltip by most browsers), too. | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
- | {{ wiki:php-powered.png |This is the caption}} | + | {{ wiki:dokuwiki-128.png |This is the caption}} |
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | For linking an image to another page see [[#Image Links]] above. | ||
+ | |||
+ | ==== Supported Media Formats ==== | ||
+ | |||
+ | DokuWiki can embed the following media formats directly. | ||
+ | |||
+ | | Image | '' | ||
+ | | Video | '' | ||
+ | | Audio | '' | ||
+ | | Flash | '' | ||
+ | |||
+ | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. | ||
+ | |||
+ | By adding ''? | ||
+ | |||
+ | {{wiki: | ||
+ | |||
+ | {{wiki: | ||
+ | |||
+ | ==== Fallback Formats ==== | ||
+ | |||
+ | Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility. | ||
+ | |||
+ | For example consider this embedded mp4 video: | ||
+ | |||
+ | {{video.mp4|A funny video}} | ||
- | {{ wiki: | + | When you upload a '' |
- | If you specify | + | Additionally DokuWiki supports |
===== Lists ===== | ===== Lists ===== | ||
Zeile 179: | Zeile 220: | ||
</ | </ | ||
- | ===== 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-) %% | ||
Zeile 198: | Zeile 247: | ||
* ;-) %% ;-) %% | * ;-) %% ;-) %% | ||
* ^_^ %% ^_^ %% | * ^_^ %% ^_^ %% | ||
+ | * m( %% m( %% | ||
* :?: %% :?: %% | * :?: %% :?: %% | ||
* :!: %% :!: %% | * :!: %% :!: %% | ||
Zeile 204: | Zeile 254: | ||
* 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) | ||
Zeile 216: | Zeile 266: | ||
</ | </ | ||
- | Please note: These conversions | + | 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), ' | ||
+ | |||
+ | ===== 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' | ||
+ | |||
+ | >> Well, I say we should | ||
+ | |||
+ | > Really? | ||
+ | |||
+ | >> Yes! | ||
+ | |||
+ | >>> | ||
+ | </ | ||
+ | |||
+ | I think we should do it | ||
+ | |||
+ | > No we shouldn' | ||
+ | |||
+ | >> Well, I say we should | ||
+ | |||
+ | > Really? | ||
+ | |||
+ | >> Yes! | ||
+ | |||
+ | >>> | ||
===== 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 '' | ||
Zeile 232: | Zeile 314: | ||
| 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, | ||
Zeile 250: | Zeile 332: | ||
^ 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. | ||
Zeile 266: | Zeile 360: | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | ===== Nonparsed 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. | ||
< | < | ||
Zeile 275: | Zeile 387: | ||
< | < | ||
- | 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: |
- | < | + | |
- | 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. | ||
+ | </ | ||
- | [[DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http:// | + | ==== Syntax Highlighting ==== |
+ | |||
+ | [[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!" | ||
Zeile 302: | Zeile 418: | ||
</ | </ | ||
- | The following language strings are currently recognized: // | + | The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 |
- | ===== Embedding HTML and PHP ===== | + | There are additional [[doku> |
- | You can embed raw HTML or PHP code into your documents by using the '' | + | ==== Downloadable Code Blocks ==== |
- | < | + | |
- | < | + | |
- | This is some <font color=" | + | |
- | </ | + | |
- | </ | + | |
- | <html> | + | When you use the '' |
- | This is some <font color=" | + | |
- | </html> | + | |
< | < | ||
- | < | + | <file php myexample.php> |
- | echo 'A logo generated by PHP:'; | + | <?php echo "hello world!"; ?> |
- | echo '<img src="' | + | </file> |
- | </php> | + | |
</ | </ | ||
- | < | + | <file php myexample.php> |
- | echo 'A logo generated by PHP:'; | + | <? |
- | echo '<img src="' | + | </ |
- | </php> | + | |
+ | If you don't want any highlighting but want a downloadable file, specify a dash ('' | ||
+ | |||
+ | ===== 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. All HTML tags will be stripped | | ||
+ | | nosort | ||
+ | | //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: | ||
+ | |||
+ | By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the '' | ||
+ | |||
+ | **Example: | ||
+ | |||
+ | {{rss> | ||
+ | |||
+ | {{rss>http:// | ||
+ | |||
+ | |||
+ | ===== 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 %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call | | ||
+ | |||
+ | ===== Syntax Plugins ===== | ||
+ | |||
+ | DokuWiki' | ||
+ | |||
+ | ~~INFO: | ||
- | **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. |