Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
wiki:syntax [May. 15, 2012 12:11 PM UTC ] – vitruve | wiki:syntax [Oct. 13, 2012 11:25 AM UTC ] (Version actuelle) – modification externe 127.0.0.1 | ||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
- | ====== | + | ====== |
- | [[DokuWiki]] | + | [[doku>DokuWiki]] |
+ | ===== Basic Text Formatting ===== | ||
- | ===== Mise en forme de texte basique ===== | + | DokuWiki supports **bold**, //italic//, __underlined__ and '' |
- | DokuWiki | + | |
+ | Of course you can **__//'' | ||
- | DokuWiki accepte les textes en **gras**, //italique//, __souligné__ et '' | + | You can use < |
- | Bien sûr, vous pouvez tous les **__//'' | + | You can use < |
- | Bien sûr, vous pouvez tous les **__//'' | + | You can mark something as < |
- | Vous pouvez aussi utiliser | + | You can mark something as <del>deleted</del> as well. |
- | Vous pouvez aussi utiliser < | + | **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. |
- | De plus, vous pouvez marquer un passage comme < | + | 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. | ||
- | | + | |
+ | two backslashes are only recognized at the end of a line\\ | ||
+ | or followed by\\ a whitespace \\this happens without it. | ||
- | **Les paragraphes** sont créés à partir des lignes vides. Si vous souhaitez **forcer un saut de ligne** sans paragraphe, vous pouvez utiliser deux contre-obliques suivies par un espace ou une fin de ligne. | + | You should use forced newlines only if really needed. |
- | Voici du texte avec des sauts de ligne\\ remarquez que les | + | ===== Links ===== |
- | deux contre-obliques sont reconnues uniquement en fin de ligne\\ | + | |
- | ou suivies par\\ un espace ; \\ceci se produit sinon. | + | |
- | Voici du texte avec des sauts de ligne\\ remarquez que les | + | DokuWiki supports multiple ways of creating links. |
- | deux contre-obliques sont reconnues uniquement en fin de ligne\\ | + | |
- | ou suivies par\\ un espace ; \\ceci se produit sinon. | + | |
- | Vous ne devriez forcer des sauts de ligne que si c'est vraiment nécessaire. | + | ==== External ==== |
+ | External links are recognized automagically: | ||
- | ===== Liens ===== | + | DokuWiki supports multiple ways of creating links. External links are recognized |
+ | automagically: | ||
+ | link text as well: [[http:// | ||
+ | addresses like this one: < | ||
- | DokuWiki propose plusieurs moyens pour créer des liens. | + | ==== Internal ==== |
+ | Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]]. | ||
- | ==== Externes ==== | + | Internal links are created by using square brackets. You can either just give |
+ | a [[pagename]] or use an additional [[pagename|link text]]. | ||
- | Les liens externes sont reconnus « automatiquement » : http:// | + | [[doku> |
- | Les liens externes sont reconnus « automatiquement » : http:// | + | You can use [[some:namespaces]] by using a colon in the pagename. |
- | ou simplement www.google.fr - Vous pouvez aussi donner des noms aux | + | |
- | liens : [[http:// | + | |
- | de courriel comme celle-ci : < | + | |
+ | 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 [[syntax# | ||
- | ==== Internes ==== | + | This links to [[syntax# |
- | Les liens internes sont créés en utilisant les crochets. Vous pouvez soit juste donner un [[doku> | + | Notes: |
- | + | ||
- | Les liens internes sont créés en utilisant les crochets. Vous pouvez soit | + | |
- | juste donner un [[nom de page]] soit utiliser un | + | |
- | [[nom de page|texte pour le titre]]. Les noms de pages (// | + | |
- | sont convertis automatiquement en minuscules ; les caractères spéciaux ne | + | |
- | sont pas autorisés. | + | |
- | + | ||
- | Vous pouvez utiliser des [[doku> | + | |
- | + | ||
- | Vous pouvez utiliser des [[catégories]] (// | + | |
- | + | ||
- | Pour plus de détails sur les catégories (// | + | |
- | + | ||
- | Les liens vers une section spécifique sont également possibles. Ajoutez simplement le nom de la section après un caractère dièse (#) comme en HTML. Ce lien renvoie vers [[syntax# | + | |
- | + | ||
- | Ce lien renvoie vers [[syntax# | + | |
- | + | ||
- | Notes : | + | |
- | + | ||
- | * Les liens vers des [[syntax|pages existantes]] sont montrés dans un style différent des liens vers des pages [[inexistantes]]. | + | |
- | * DokuWiki n' | + | |
- | * Lorsque le titre d'une section est modifié, alors son lien change aussi. Donc ne comptez pas trop sur les liens de section. | + | |
+ | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | ||
+ | * DokuWiki does not use [[wp> | ||
+ | * When a section' | ||
==== Interwiki ==== | ==== Interwiki ==== | ||
- | DokuWiki | + | DokuWiki |
- | + | ||
- | DokuWiki propose les liens [[doku> | + | |
- | liens rapides vers d'autres | + | |
- | définition des Wikis dans Wikipedia en français | + | |
+ | DokuWiki supports [[doku> | ||
+ | For example this is a link to Wikipedia' | ||
- | ==== Partages | + | ==== Windows |
- | Les partages | + | Windows |
- | | + | Windows |
- | Notes : | + | Notes: |
- | * Pour des raisons de sécurité, la navigation directe sur partages Windows ne fonctionne que dans //Microsoft Internet Explorer// par défaut | + | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer |
- | * Pour //Mozilla// et //Firefox//, elle peut être mise en place dans l' | + | * For Mozilla |
- | * Je viens de tester en passant la valeur à " | + | |
- | * Tiré de l'URL ci-dessus : "This preference only works in Gecko versions before 1.8 (so Firefox 1.0 and Mozilla Suite builds). In Firefox 1.5 and Seamonkey 1.0 this preference no longer has an effect." | + | |
- | * Veuillez consulter [[dokubug> | + | |
+ | $lang[' | ||
- | ==== Liens images | + | ==== Image Links ==== |
- | Vous pouvez aussi utiliser une image afin de créer un lien vers une autre page interne ou externe en combinant les syntaxes des liens et des [[#Images et autres fichiers|images]] (voir plus bas) comme ceci : | + | You can also use an image to link to another internal or external |
[[http:// | [[http:// | ||
Ligne 112: | Ligne 96: | ||
[[http:// | [[http:// | ||
- | NB : la mise en forme image est la seule syntaxe de mise en forme acceptée comme nom de lien. | + | Please note: The image formatting is the only formatting syntax accepted in link names. |
- | Les syntaxes d'[[#Images et autres fichiers|image]] | + | The whole [[#images_and_other_files|image]] |
+ | ===== Footnotes ===== | ||
- | ===== Notes de pied de page ===== | + | You can add footnotes ((This is a footnote)) by using double parentheses. |
- | Vous pouvez ajouter des notes de pied de page ((Ceci est une note de pied de page)) en utilisant des parenthèses doubles. | + | You can add footnotes |
- | Vous pouvez ajouter des notes de pied de page ((Ceci est une note de pied de page)) en utilisant des parenthèses doubles. | + | ===== 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 ''< | ||
- | ===== Découpage en sections | + | ==== Headline Level 3 ==== |
+ | === Headline Level 4 === | ||
+ | == Headline Level 5 == | ||
- | Vous pouvez utiliser jusqu' | + | ==== Headline Level 3 ==== |
- | ''< | + | === Headline Level 4 === |
+ | == Headline Level 5 == | ||
- | + | By using four or more dashes, you can make a horizontal line: | |
- | + | ||
- | + | ||
- | ==== Titre niveau 3 ==== | + | |
- | === Titre niveau 4 === | + | |
- | == Titre niveau 5 == | + | |
- | + | ||
- | ==== Titre niveau 3 ==== | + | |
- | === Titre niveau 4 === | + | |
- | == Titre niveau 5 == | + | |
- | + | ||
- | En utilisant quatre tirets ou plus, vous pouvez créer une ligne horizontale | + | |
---- | ---- | ||
- | \\ | ||
- | < | ||
- | ===== Images and other files ===== | + | ===== Images and Other Files ===== |
- | You can include external and internal [[doku>wiki:images]] with curly brackets. Optionally you can specify the size of them. | + | You can include external and internal [[doku> |
Real size: {{wiki: | Real size: {{wiki: | ||
Ligne 154: | Ligne 130: | ||
Resize to given width: | Resize to given width: | ||
- | Resize to given width and height: {{wiki: | + | Resize to given width and height((when the aspect ratio of the given width and height doesn' |
Resized external image: | Resized external image: | ||
Ligne 212: | Ligne 188: | ||
</ | </ | ||
- | ===== 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-) %% | ||
Ligne 237: | Ligne 221: | ||
* 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 249: | Ligne 233: | ||
</ | </ | ||
- | Please note: These conversions | + | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]]. |
+ | |||
+ | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' | ||
===== Quoting ===== | ===== Quoting ===== | ||
Ligne 281: | Ligne 267: | ||
===== 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 293: | Ligne 279: | ||
| 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 311: | Ligne 297: | ||
^ 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 327: | Ligne 325: | ||
| 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 336: | Ligne 352: | ||
< | < | ||
- | 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 | ||
+ | </ | ||
+ | < | ||
+ | This is pretty much the same, but you could use it to show that you quoted a file. | ||
+ | </ | ||
- | ===== Syntax Highlighting | + | ==== Syntax Highlighting ==== |
- | [[DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http:// | + | [[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!" | ||
Ligne 364: | Ligne 383: | ||
</ | </ | ||
- | The following language strings are currently recognized: // | + | The following language strings are currently recognized: //4cs, 6502acme, 6502kickass, |
+ | |||
+ | ==== Downloadable Code Blocks ==== | ||
+ | |||
+ | When you use the '' | ||
+ | |||
+ | < | ||
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; | ||
+ | </ | ||
+ | |||
+ | If you don't want any highlighting but want a downloadable file, specify a dash ('' | ||
===== 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: | ||
< | < | ||
< | < | ||
- | This is some <font color="red" | + | This is some <span style="color:red;font-size:150%;">inline |
</ | </ | ||
+ | < | ||
+ | <p style=" | ||
+ | </ | ||
</ | </ | ||
< | < | ||
- | This is some <font color="red" | + | This is some <span style="color:red;font-size:150%;">inline |
</ | </ | ||
+ | < | ||
+ | <p style=" | ||
+ | </ | ||
+ | |||
+ | PHP example: | ||
< | < | ||
Ligne 383: | Ligne 430: | ||
echo 'A logo generated by PHP:'; | echo 'A logo generated by PHP:'; | ||
echo '< | echo '< | ||
+ | echo ' | ||
</ | </ | ||
+ | <PHP> | ||
+ | echo '< | ||
+ | echo '< | ||
+ | echo '</ | ||
+ | </ | ||
</ | </ | ||
Ligne 389: | Ligne 442: | ||
echo 'A logo generated by PHP:'; | echo 'A logo generated by PHP:'; | ||
echo '< | echo '< | ||
+ | echo ' | ||
</ | </ | ||
+ | <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. | **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. | ||
- | ===== Syntax Plugins | + | ===== RSS/ATOM Feed Aggregation |
+ | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | ||
- | DokuWiki' | + | ^ 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>config:htmlok|HTML]] is disabled all tags will be stripped | | ||
+ | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | ||
- | ~~INFO:syntaxplugins~~ | + | The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki: |
+ | **Example: | ||
+ | {{rss> | ||
+ | |||
+ | {{rss> | ||
+ | |||
+ | |||
+ | ===== 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 %%< | ||
+ | |||
+ | ===== Syntax Plugins ===== | ||
+ | |||
+ | DokuWiki' | ||
+ | |||
+ | ~~INFO: | ||