Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
wiki:syntax [2016/01/08 12:44] – no need for windows shares here knome | wiki:syntax [2016/01/08 20:47] – knome | ||
---|---|---|---|
Line 5: | Line 5: | ||
===== Basic Text Formatting ===== | ===== Basic Text Formatting ===== | ||
- | DokuWiki supports | + | ^ Purpose |
+ | | Bold | ''< | ||
+ | | Italic | ||
+ | | Underlined | ||
+ | | Monospace | ||
+ | | Subscript | ||
+ | | Superscript | ||
+ | | Strikethrough | ''< | ||
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | + | **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes |
- | 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 ===== | ||
- | DokuWiki supports multiple ways of creating links. | + | ^ Purpose |
- | + | | Manual | |
- | ==== External ==== | + | | Manual |
- | + | | Automatic external link | ''< | |
- | External links are recognized automagically: | + | | Email link |
- | + | | Launchpad user/team link | ''< | |
- | DokuWiki supports multiple ways of creating links. External links are recognized | + | | Ubuntu wiki link | ''< |
- | 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#internal|this Section]]. | + | |
- | + | ||
- | This links to [[syntax#internal|this Section]]. | + | |
- | + | ||
- | Notes: | + | |
- | + | ||
- | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | + | |
- | | + | |
- | * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much. | + | |
- | + | ||
- | ==== Interwiki ==== | + | |
- | + | ||
- | DokuWiki supports | + | |
- | + | ||
- | DokuWiki supports | + | |
- | For example this is a link to Wikipedia's page about Wikis: | + | |
==== Image Links ==== | ==== Image Links ==== | ||
Line 95: | Line 46: | ||
===== 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 -- this can be disabled by including the string ''< | + | You can use up to five different levels of headlines to structure your content. |
==== Headline Level 3 ==== | ==== Headline Level 3 ==== | ||
Line 146: | Line 97: | ||
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 163: | Line 103: | ||
{{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 203: | Line 131: | ||
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 %% | ||
- | * :-| %% :-| %% | ||
- | * ;-) %% ;-) %% | ||
- | * ^_^ %% ^_^ %% | ||
- | * :?: %% :?: %% | ||
- | * :!: %% :!: %% | ||
- | * LOL %% LOL %% | ||
- | * FIXME %% FIXME %% | ||
- | * DELETEME %% DELETEME %% | ||
==== Text to HTML Conversions ==== | ==== Text to HTML Conversions ==== | ||
Line 417: | Line 314: | ||
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 ===== | ||
- | |||
- | You can embed raw HTML or PHP code into your documents by using the '' | ||
- | |||
- | HTML example: | ||
- | |||
- | < | ||
- | < | ||
- | This is some <span style=" | ||
- | </ | ||
- | < | ||
- | <p style=" | ||
- | </ | ||
- | </ | ||
- | |||
- | < | ||
- | This is some <span style=" | ||
- | </ | ||
- | < | ||
- | <p style=" | ||
- | </ | ||
- | |||
- | PHP example: | ||
- | |||
- | < | ||
- | <php> | ||
- | echo 'The PHP version: '; | ||
- | echo phpversion(); | ||
- | echo ' (generated inline HTML)'; | ||
- | </ | ||
- | <PHP> | ||
- | echo '< | ||
- | echo '< | ||
- | echo '</ | ||
- | </ | ||
- | </ | ||
- | |||
- | <php> | ||
- | echo 'The PHP version: '; | ||
- | echo phpversion(); | ||
- | echo ' (inline HTML)'; | ||
- | </ | ||
- | <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. | ||
===== RSS/ATOM Feed Aggregation ===== | ===== RSS/ATOM Feed Aggregation ===== |