Ci-dessous, les différences entre deux révisions de la page.
Prochaine révision | Révision précédente | ||
wiki:syntax [20/07/2009 18:48] – édition externe 127.0.0.1 | wiki:syntax [18/08/2022 08:07] (Version actuelle) – modification externe 127.0.0.1 | ||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
====== Formatting Syntax ====== | ====== Formatting Syntax ====== | ||
- | [[doku> | + | [[doku> |
- | ===== Basic text formatting | + | ===== Basic Text Formatting |
DokuWiki supports **bold**, //italic//, __underlined__ and '' | DokuWiki supports **bold**, //italic//, __underlined__ and '' | ||
Ligne 50: | Ligne 50: | ||
a [[pagename]] or use an additional [[pagename|link text]]. | a [[pagename]] or use an additional [[pagename|link text]]. | ||
- | [[doku> | + | [[doku> |
You can use [[some: | You can use [[some: | ||
Ligne 74: | Ligne 74: | ||
DokuWiki supports [[doku> | DokuWiki supports [[doku> | ||
For example this is a link to Wikipedia' | For example this is a link to Wikipedia' | ||
- | |||
==== Windows Shares ==== | ==== Windows Shares ==== | ||
Ligne 85: | Ligne 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 |
- | * See [[dokubug> | + | <?php |
+ | /** | ||
+ | * Customization of the english language file | ||
+ | * Copy only the strings that needs to be modified | ||
+ | */ | ||
+ | $lang[' | ||
+ | </ | ||
==== Image Links ==== | ==== Image Links ==== | ||
Ligne 92: | Ligne 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. | ||
Ligne 122: | Ligne 127: | ||
---- | ---- | ||
- | ===== Images and other files ===== | + | ===== Media Files ===== |
- | You can include external and internal [[doku> | + | You can include external and internal [[doku> |
Real size: {{wiki: | Real size: {{wiki: | ||
Ligne 132: | Ligne 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: |
Ligne 157: | Ligne 162: | ||
{{ wiki: | {{ wiki: | ||
- | |||
- | If you specify a filename (external or internal) that is not an image ('' | ||
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 ''? | ||
+ | |||
+ | {{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 ===== | ||
Ligne 188: | Ligne 220: | ||
</ | </ | ||
- | ===== Smileys | + | 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> | + | DokuWiki converts commonly used [[wp> |
* 8-) %% 8-) %% | * 8-) %% 8-) %% | ||
Ligne 196: | Ligne 236: | ||
* :-( %% :-( %% | * :-( %% :-( %% | ||
* :-) %% :-) %% | * :-) %% :-) %% | ||
- | |||
* =) %% =) %% | * =) %% =) %% | ||
* :-/ %% :-/ %% | * :-/ %% :-/ %% | ||
Ligne 208: | Ligne 247: | ||
* ;-) %% ;-) %% | * ;-) %% ;-) %% | ||
* ^_^ %% ^_^ %% | * ^_^ %% ^_^ %% | ||
+ | * m( %% m( %% | ||
* :?: %% :?: %% | * :?: %% :?: %% | ||
* :!: %% :!: %% | * :!: %% :!: %% | ||
Ligne 214: | Ligne 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) | ||
Ligne 226: | Ligne 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 ===== | ===== Quoting ===== | ||
Ligne 232: | Ligne 274: | ||
Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: | 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' | + | |
- | + | > No we shouldn' | |
- | >> Well, I say we should | + | |
- | + | >> Well, I say we should | |
- | > Really? | + | |
- | + | > Really? | |
- | >> Yes! | + | |
- | + | >> Yes! | |
- | >>> | + | |
+ | >>> | ||
+ | </ | ||
I think we should do it | I think we should do it | ||
Ligne 258: | Ligne 302: | ||
===== 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 '' | ||
Ligne 270: | Ligne 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, | ||
Ligne 288: | Ligne 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. | ||
Ligne 304: | Ligne 360: | ||
| 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. | ||
< | < | ||
Ligne 313: | Ligne 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. | ||
+ | </ | ||
- | [[wiki: | + | ==== Syntax Highlighting ==== |
+ | |||
+ | [[wiki: | ||
<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!" | ||
Ligne 340: | Ligne 418: | ||
</ | </ | ||
- | The following language strings are currently recognized: //abap, actionscript-french, actionscript, | + | The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac |
+ | There are additional [[doku> | ||
- | ===== RSS/ATOM Feed Aggregation | + | ==== Downloadable Code Blocks |
- | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | + | |
- | ^ Parameter | + | When you use the '' |
- | | any number | will be used as maximum number items to show, defaults | + | |
- | | 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: | + | < |
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; | ||
+ | </file> | ||
+ | </code> | ||
- | **Example: | + | <file php myexample.php> |
+ | <?php echo "hello world!"; | ||
+ | </ | ||
- | {{rss> | + | If you don't want any highlighting but want a downloadable file, specify a dash ('' |
- | + | ||
- | {{rss>http:// | + | |
===== 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: | ||
< | < | ||
< | < | ||
Ligne 381: | Ligne 460: | ||
<p style=" | <p style=" | ||
</ | </ | ||
+ | |||
+ | PHP example: | ||
< | < | ||
<php> | <php> | ||
- | echo 'A logo generated by PHP:'; | + | echo 'The PHP version: '; |
- | echo '< | + | echo phpversion(); |
- | echo ' | + | echo ' (generated inline HTML)'; |
</ | </ | ||
<PHP> | <PHP> | ||
echo '< | echo '< | ||
- | echo '< | + | echo '< |
echo '</ | echo '</ | ||
</ | </ | ||
Ligne 396: | Ligne 477: | ||
<php> | <php> | ||
- | echo 'A logo generated by PHP:'; | + | echo 'The PHP version: '; |
- | echo '< | + | echo phpversion(); |
- | echo ' | + | echo ' (inline HTML)'; |
</ | </ | ||
<PHP> | <PHP> | ||
echo '< | echo '< | ||
- | echo '< | + | 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> | ||
+ | | 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> | ||
+ | |||
===== Control Macros ===== | ===== Control Macros ===== |