Différences
Ci-dessous, les différences entre deux révisions de la page.
wiki:syntax [12/11/2013 16:26] heuzef |
wiki:syntax [29/07/2020 11:35] |
||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
- | ====== Formatting Syntax ====== | ||
- | |||
- | |||
- | [[doku> | ||
- | |||
- | |||
- | ===== Basic Text Formatting ===== | ||
- | |||
- | |||
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
- | < | ||
- | 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 deleted as well. | ||
- | </ | ||
- | |||
- | |||
- | **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line. | ||
- | |||
- | |||
- | 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. | ||
- | |||
- | |||
- | < | ||
- | 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 ===== | ||
- | |||
- | |||
- | DokuWiki supports multiple ways of creating links. | ||
- | |||
- | |||
- | ==== External ==== | ||
- | |||
- | |||
- | External links are recognized automagically: | ||
- | |||
- | |||
- | < | ||
- | DokuWiki supports multiple ways of creating links. External links are recognized | ||
- | automagically: | ||
- | link text as well: [[http:// | ||
- | addresses like this one: < | ||
- | </ | ||
- | |||
- | |||
- | ==== Internal ==== | ||
- | |||
- | |||
- | Internal links are created by using square brackets. You can either just give a [[: | ||
- | |||
- | |||
- | < | ||
- | 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 [[: | ||
- | |||
- | |||
- | < | ||
- | 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 [[: | ||
- | |||
- | |||
- | < | ||
- | This links to [[syntax# | ||
- | </ | ||
- | |||
- | |||
- | Notes: | ||
- | |||
- | |||
- | * Links to [[: | ||
- | * DokuWiki does not use [[wp> | ||
- | * When a section' | ||
- | |||
- | |||
- | ==== Interwiki ==== | ||
- | |||
- | |||
- | DokuWiki supports [[doku> | ||
- | |||
- | |||
- | < | ||
- | DokuWiki supports [[doku> | ||
- | For example this is a link to Wikipedia' | ||
- | </ | ||
- | |||
- | |||
- | ==== 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 [[wp> | ||
- | |||
- | |||
- | < | ||
- | 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:// | ||
- | |||
- | |||
- | < | ||
- | LANG.nosmblinks = ''; | ||
- | </ | ||
- | |||
- | |||
- | ==== Image Links ==== | ||
- | |||
- | |||
- | You can also use an image to link to another internal or external page by combining the syntax for links and [[# | ||
- | |||
- | |||
- | < | ||
- | [[http:// | ||
- | </ | ||
- | |||
- | |||
- | [[http:// | ||
- | |||
- | |||
- | Please note: The image formatting is the only formatting syntax accepted in link names. | ||
- | |||
- | |||
- | The whole [[# | ||
- | |||
- | |||
- | ===== Footnotes ===== | ||
- | |||
- | |||
- | You can add footnotes ((1)) by using double parentheses. | ||
- | |||
- | |||
- | < | ||
- | You can add footnotes ((This is a footnote)) by using double parentheses. | ||
- | </ | ||
- | |||
- | |||
- | ===== 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 ''< | ||
- | |||
- | |||
- | ==== Headline Level 3 ==== | ||
- | |||
- | |||
- | === Headline Level 4 === | ||
- | |||
- | |||
- | == Headline Level 5 == | ||
- | |||
- | |||
- | < | ||
- | ==== Headline Level 3 ==== | ||
- | === Headline Level 4 === | ||
- | == Headline Level 5 == | ||
- | </ | ||
- | |||
- | |||
- | By using four or more dashes, you can make a horizontal line: | ||
- | |||
- | |||
- | ---- | ||
- | |||
- | |||
- | ===== Images and Other Files ===== | ||
- | |||
- | |||
- | You can include external and internal [[doku> | ||
- | |||
- | |||
- | Real size: {{: | ||
- | |||
- | |||
- | Resize to given width: {{: | ||
- | |||
- | |||
- | Resize to given width and height((2))) : {{: | ||
- | |||
- | |||
- | Resized external image: {{http:// | ||
- | |||
- | |||
- | < | ||
- | Real size: {{wiki: | ||
- | Resize to given width: | ||
- | Resize to given width and height: {{wiki: | ||
- | Resized external image: | ||
- | </ | ||
- | |||
- | |||
- | By using left or right whitespaces you can choose the alignment. | ||
- | |||
- | |||
- | {{ : | ||
- | |||
- | |||
- | {{: | ||
- | |||
- | |||
- | {{ : | ||
- | |||
- | |||
- | < | ||
- | {{ wiki: | ||
- | {{wiki: | ||
- | {{ wiki: | ||
- | </ | ||
- | |||
- | |||
- | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
- | |||
- | |||
- | {{ : | ||
- | |||
- | |||
- | < | ||
- | {{ wiki: | ||
- | </ | ||
- | |||
- | |||
- | If you specify a filename (external or internal) that is not an image ('' | ||
- | |||
- | |||
- | For linking an image to another page see [[# | ||
- | |||
- | |||
- | ===== Lists ===== | ||
- | |||
- | |||
- | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' | ||
- | |||
- | |||
- | * This is a list | ||
- | * The second item | ||
- | * You may have different levels | ||
- | * Another item | ||
- | |||
- | |||
- | - The same list but ordered | ||
- | - Another item | ||
- | - Just use indention for deeper levels | ||
- | - That's it | ||
- | |||
- | |||
- | < | ||
- | * This is a list | ||
- | * The second item | ||
- | * You may have different levels | ||
- | * Another item | ||
- | |||
- | - The same list but ordered | ||
- | - Another item | ||
- | - Just use indention for deeper levels | ||
- | - That's it | ||
- | </ | ||
- | |||
- | |||
- | 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-O < | ||
- | * :-( < | ||
- | * :-) < | ||
- | * =) < | ||
- | * :-/ < | ||
- | * :-\" class= < | ||
- | * :-? < | ||
- | * :-D < | ||
- | * :-P < | ||
- | * :-O < | ||
- | * :-X < | ||
- | * :-| < | ||
- | * ;-) < | ||
- | * ^_^ < | ||
- | * :?: < | ||
- | * :!: < | ||
- | * LOL < | ||
- | * FIXME < | ||
- | * DELETEME < | ||
- | |||
- | |||
- | ==== Text to HTML Conversions ==== | ||
- | |||
- | |||
- | Typography: [[: | ||
- | |||
- | |||
- | → <- < | ||
- | |||
- | |||
- | < | ||
- | -> <- <-> => <= < | ||
- | "He thought ' | ||
- | </ | ||
- | |||
- | |||
- | 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 (640×480), ' | ||
- | |||
- | |||
- | ===== 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 ===== | ||
- | |||
- | |||
- | DokuWiki supports a simple syntax to create tables. | ||
- | |||
- | |||
- | ^Heading 1 ^Heading 2 ^Heading 3 | | ||
- | |Row 1 Col 1 |Row 1 Col 2 |Row 1 Col 3 | | ||
- | |Row 2 Col 1 |some colspan (note the double pipe) || | ||
- | |Row 3 Col 1 |Row 3 Col 2 |Row 3 Col 3 | | ||
- | |||
- | |||
- | Table rows have to start and end with a '''' | ||
- | |||
- | |||
- | < | ||
- | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
- | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
- | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
- | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | ||
- | </ | ||
- | |||
- | |||
- | To connect cells horizontally, | ||
- | |||
- | |||
- | Vertical tableheaders are possible, too. | ||
- | |||
- | |||
- | |Heading 1 ^Heading 2 | | ||
- | ^Heading 3 |Row 1 Col 2 |Row 1 Col 3 | | ||
- | ^Heading 4 |no colspan this time | | ||
- | ^Heading 5 |Row 2 Col 2 |Row 2 Col 3 | | ||
- | |||
- | |||
- | As you can see, it's the cell separator before a cell which decides about the formatting: | ||
- | |||
- | |||
- | < | ||
- | | ^ Heading 1 ^ Heading 2 ^ | ||
- | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | | ||
- | ^ Heading 4 | no colspan this time | | | ||
- | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
- | </ | ||
- | |||
- | |||
- | 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 syntax those cells should not contain anything else. | ||
- | |||
- | |||
- | < | ||
- | ^ 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. | ||
- | |||
- | |||
- | ^Table with alignment ^^^ | ||
- | |right |center |left | | ||
- | |left |right |center | | ||
- | |xxxxxxxxxxxx |xxxxxxxxxxxx |xxxxxxxxxxxx | | ||
- | |||
- | |||
- | This is how it looks in the source: | ||
- | |||
- | |||
- | < | ||
- | ^ Table with alignment | ||
- | | | ||
- | |left | | ||
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | </ | ||
- | |||
- | |||
- | Note: Vertical alignment is not supported. | ||
- | |||
- | |||
- | ===== 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 </ | ||
- | </ | ||
- | |||
- | |||
- | ===== Code Blocks ===== | ||
- | |||
- | |||
- | You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''</ | ||
- | |||
- | |||
- | < | ||
- | < | ||
- | |||
- | This is text is indented by two spaces. | ||
- | |||
- | < | ||
- | This is preformatted code all spaces are preserved: like <-this | ||
- | </ | ||
- | |||
- | < | ||
- | 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: | ||
- | |||
- | This is text is indented by two spaces. | ||
- | |||
- | < | ||
- | This is preformatted code all spaces are preserved: like <-this | ||
- | </ | ||
- | |||
- | < | ||
- | This is pretty much the same, but you could use it to show that you quoted a file. | ||
- | </ | ||
- | |||
- | ==== Syntax Highlighting ==== | ||
- | |||
- | [[wiki: | ||
- | |||
- | <code java> | ||
- | /** | ||
- | * The HelloWorldApp class implements an application that | ||
- | * simply displays "Hello World!" | ||
- | */ | ||
- | class HelloWorldApp { | ||
- | public static void main(String[] args) { | ||
- | System.out.println(" | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | |||
- | The following language strings are currently recognized: //4cs, 6502acme, 6502kickass, | ||
- | |||
- | |||
- | ==== Downloadable Code Blocks ==== | ||
- | |||
- | |||
- | When you use the ''</ | ||
- | |||
- | |||
- | '' | ||
- | |||
- | |||
- | ''< | ||
- | |||
- | |||
- | PHP example: | ||
- | |||
- | |||
- | < | ||
- | <php> | ||
- | echo 'A logo generated by PHP:'; | ||
- | echo '< | ||
- | echo ' | ||
- | </ | ||
- | <PHP> | ||
- | echo '< | ||
- | echo '< | ||
- | echo '</ | ||
- | </ | ||
- | </ | ||
- | |||
- | |||
- | <php> echo 'A logo generated by PHP:'; 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 ===== | ||
- | |||
- | |||
- | [[: | ||
- | |||
- | |||
- | ^Parameter ^Description | | ||
- | |any number |will be used as maximum number items to show, defaults to 8 | | ||
- | |reverse |display the last items in the feed first | | ||
- | |author |show item authors names | | ||
- | |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. [[: | ||
- | |||
- | |||
- | **Example: | ||
- | |||
- | |||
- | < | ||
- | {{rss> | ||
- | </ | ||
- | |||
- | |||
- | {{rss> | ||
- | |||
- | |||
- | // | ||
- | |||
- | |||
- | //< | ||
- | |||
- | |||
- | //< | ||
- | |||
- | |||
- | \\ | ||