Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
wiki:syntax [2016/01/08 20:45] – knome | wiki:syntax [2023/05/22 06:15] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
- | [[doku> | + | [[doku> |
===== Basic Text Formatting ===== | ===== Basic Text Formatting ===== | ||
- | ^ Purpose | + | DokuWiki supports |
- | | Bold | ''< | + | |
- | | Italic | + | |
- | | Underlined | + | |
- | | Monospace | + | |
- | | Subscript | + | |
- | | Superscript | + | |
- | | Strikethrough | ''< | + | |
- | **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes | + | DokuWiki supports **bold**, //italic//, __underlined__ and '' |
+ | Of course you can **__//'' | ||
+ | |||
+ | You can use < | ||
+ | |||
+ | You can use < | ||
+ | |||
+ | 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 | ||
+ | |||
+ | 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 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 ===== | ===== Links ===== | ||
- | ^ Purpose | + | DokuWiki supports multiple ways of creating links. |
- | | Manual | + | |
- | | Manual | + | ==== External ==== |
- | | Automatic external link | + | |
- | | Email link | ''< | + | External links are recognized automagically: |
- | | Launchpad user/ | + | |
- | | Ubuntu wiki link | + | DokuWiki supports multiple ways of creating links. External links are recognized |
+ | automagically: | ||
+ | link text as well: [[http:// | ||
+ | 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> | ||
+ | |||
+ | You can use [[some: | ||
+ | |||
+ | You can use [[some: | ||
+ | |||
+ | 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# | ||
+ | |||
+ | This links to [[syntax# | ||
+ | |||
+ | 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> | ||
+ | * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much. | ||
+ | |||
+ | ==== Interwiki ==== | ||
+ | |||
+ | DokuWiki supports [[doku> | ||
+ | |||
+ | DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. | ||
+ | For example this is a link to Wikipedia's page about Wikis: | ||
+ | |||
+ | ==== 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 | ||
+ | |||
+ | 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:// | ||
+ | <?php | ||
+ | /** | ||
+ | * Customization of the english language file | ||
+ | * Copy only the strings that needs to be modified | ||
+ | */ | ||
+ | $lang['js'][' | ||
+ | </ | ||
==== Image Links ==== | ==== Image Links ==== | ||
Line 30: | Line 97: | ||
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://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. | ||
Line 46: | Line 113: | ||
===== Sectioning ===== | ===== Sectioning ===== | ||
- | You can use up to five different levels of headlines to structure your content. | + | 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 ''< |
==== Headline Level 3 ==== | ==== Headline Level 3 ==== | ||
Line 70: | Line 137: | ||
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: | + | Resized external image: |
Real size: {{wiki: | Real size: {{wiki: | ||
Resize to given width: | Resize to given width: | ||
Resize to given width and height: {{wiki: | Resize to given width and height: {{wiki: | ||
- | Resized external image: | + | Resized external image: |
Line 97: | Line 164: | ||
For linking an image to another page see [[#Image Links]] above. | 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 ''? | By adding ''? | ||
Line 103: | Line 181: | ||
{{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}} | ||
+ | |||
+ | When you upload a '' | ||
+ | |||
+ | Additionally DokuWiki supports a " | ||
===== Lists ===== | ===== Lists ===== | ||
Line 131: | Line 221: | ||
Also take a look at the [[doku> | Also take a look at the [[doku> | ||
+ | |||
+ | ===== 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-O %% 8-O %% | ||
+ | * :-( %% :-( %% | ||
+ | * :-) %% :-) %% | ||
+ | * =) %% =) %% | ||
+ | * :-/ %% :-/ %% | ||
+ | * :-\ %% :-\ %% | ||
+ | * :-? %% :-? %% | ||
+ | * :-D %% :-D %% | ||
+ | * :-P %% :-P %% | ||
+ | * :-O %% :-O %% | ||
+ | * :-X %% :-X %% | ||
+ | * :-| %% :-| %% | ||
+ | * ;-) %% ;-) %% | ||
+ | * ^_^ %% ^_^ %% | ||
+ | * m( %% m( %% | ||
+ | * :?: %% :?: %% | ||
+ | * :!: %% :!: %% | ||
+ | * LOL %% LOL %% | ||
+ | * FIXME %% FIXME %% | ||
+ | * DELETEME %% DELETEME %% | ||
==== Text to HTML Conversions ==== | ==== Text to HTML Conversions ==== | ||
Line 296: | Line 418: | ||
</ | </ | ||
- | The following language strings are currently recognized: //4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, | + | The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 |
+ | |||
+ | There are additional [[doku> | ||
==== Downloadable Code Blocks ==== | ==== Downloadable Code Blocks ==== | ||
Line 313: | Line 437: | ||
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 ('' | ||
- | |||
===== RSS/ATOM Feed Aggregation ===== | ===== RSS/ATOM Feed Aggregation ===== | ||
Line 323: | Line 446: | ||
| author | | author | ||
| date | show item dates | | | date | show item dates | | ||
- | | description| show the item description. | + | | description| show the item description. |
| nosort | | nosort | ||
| //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | |