Documentation du Dr FRAPPE

Ce wiki regroupe les résultats de mes expériences en informatique accumulés au cours de mes recherches sur le net.

Dans la mesure du possible, j'ai cité mes sources ; il en manque certainement… :-)

Ceci est une ancienne révision du document !


Syntaxe de formatage

DokuWiki utilise un langage de balisage simple, qui rend les fichiers de données aussi lisibles que possible.

Cette page présente toutes les syntaxes utilisables lors de l'édition des pages.

Pour essayer quelque chose, utilisez la page du bac à sable.

Des boutons donnent un accès direct au balisage simplifié.

Formatage de base du texte

DokuWiki prend en charge les textes en gras, en italique, soulignés et en espace unique. Vous pouvez bien sûr combiner toutes ces options.

DokuWiki prend en charge les textes en **gras**, en //italique//, __soulignés__ et en ''espace unique''.
Vous pouvez bien sûr **__//''combiner''//__** toutes ces options.

Vous pouvez également utiliser subscript et superscript.

Vous pouvez également utiliser <sub>subscript</sub> et <sup>superscript</sup>.

Vous pouvez également marquer quelque chose comme supprimé.

Vous pouvez également marquer quelque chose comme <del>supprimé</del>.

Les paragraphes sont créés à partir de lignes vides. Si vous souhaitez forcer une nouvelle ligne sans paragraphe, vous pouvez utiliser deux barres obliques inverses suivies d'un espace ou d'une fin de ligne.

Ceci est du texte avec des sauts de ligne
Notez que les deux barres obliques inverses ne sont reconnues qu'à la fin d'une ligne
ou suivi par
un espace \\voila ce qui se produit se produit sans espace.

Ceci est du texte avec des sauts de ligne\\ Notez que les deux barres obliques inverses ne sont reconnues qu'à la fin d'une ligne\\
ou suivi par\\ un espace \\voila ce qui se produit se produit sans espace.

Vous ne devez utiliser les sauts de ligne forcés que si c'est vraiment nécessaire.

Liens

DokuWiki prend en charge plusieurs méthodes pour créer des liens.

Externe

Les liens externes sont reconnus automatiquement : http://www.google.com ou simplement www.google.com - Vous pouvez également définir le texte du lien : Ce lien pointe vers google. Les adresses e-mail comme celle-ci : andi@splitbrain.org sont également reconnues.

Les liens externes sont reconnus automatiquement : http://www.google.com ou simplement www.google.com - Vous pouvez également définir le texte du lien : [[http://www.google.com|Ce lien pointe vers google]]. Les adresses e-mail comme celle-ci : <andi@splitbrain.org> sont également reconnues.

Interne

Les liens internes sont créés à l'aide de crochets. Vous pouvez soit simplement donner un pagename, soit utiliser un texte du lien supplémentaire.

Les noms de pages Wiki sont automatiquement convertis en minuscules, les caractères spéciaux ne sont pas autorisés.

Vous pouvez utiliser [[some:namespaces]] en utilisant deux points dans le nom de la page.

→ Vous pouvez utiliser namespaces en utilisant deux points dans le nom de la page.

Pour plus de détails sur les espaces de noms, voir namespaces.

Il est également possible de créer un lien vers une section spécifique. Ajoutez simplement le nom de la section derrière un # :

Cela renvoie à [[syntaxe#interne|cette section]].

→ Cela renvoie à cette section.

  • Les liens vers les pages existantes sont affichés dans un style différent de ceux des pages inexistantes.
  • DokuWiki n'utilise pas CamelCase pour créer automatiquement des liens par défaut, mais ce comportement peut être activé dans le fichier config. Astuce : si DokuWiki est un lien, alors il est activé.
  • Lorsque le titre d'une section est modifié, son signet change également. Alors ne comptez pas trop sur les liens de section.

Interwiki

DokuWiki prend en charge les liens [[doku>Interwiki]]. Ce sont des liens rapides vers d'autres wikis. Par exemple, il s'agit d'un lien vers la page de Wikipédia sur les wikis : [[wp>Wiki]].

→ DokuWiki prend en charge les liens Interwiki. Ce sont des liens rapides vers d'autres wikis. Par exemple, il s'agit d'un lien vers la page de Wikipédia sur les wikis : Wiki.

Partages Windows

Les partages Windows comme [[\server\share|this]] sont également reconnus.

Veuillez noter que ceux-ci n'ont de sens que dans un groupe d'utilisateurs homogène comme un Intranet d'entreprise.

Windows shares like this are recognized, too.

  • Pour des raisons de sécurité, la navigation directe sur les partages Windows ne fonctionne que dans Microsoft Internet Explorer par défaut (et uniquement dans la “zone locale”).
  • Pour Mozilla et Firefox, il peut être activé via différentes solutions de contournement mentionnées dans la Base de connaissances Mozilla. Cependant, il y aura toujours un avertissement JavaScript concernant la tentative d'ouverture d'un partage Windows. Pour supprimer cet avertissement (pour tous les utilisateurs), mettez la ligne suivante dans conf/lang/en/lang.php (plus de détails sur localization) :
    conf/lang/en/lang.php
    <?php
    /**
     * Customization of the english language file
     * Copy only the strings that needs to be modified
     */
    $lang['js']['nosmblinks'] = '';

Liens d'images

Vous pouvez également utiliser une image pour créer un lien vers une autre page interne ou externe en combinant la syntaxe des liens et des images (voir ci-dessous) comme ceci :

[[http://php.net|{{wiki:dokuwiki-128.png}}]]

Remarque : Le format image est la seule syntaxe de mise en forme acceptée dans les noms de liens.

L'intégralité de la syntaxe image et link est prise en charge (y compris le redimensionnement des images, les images et URL internes et externes et les liens interwiki).

Notes de bas de page

Vous pouvez ajouter des notes de bas de page 1) en utilisant des doubles parenthèses. →

Vous pouvez ajouter des notes de bas de page ((Ceci est une note de bas de page)) en utilisant des doubles parenthèses.

Sectionnement

Vous pouvez utiliser jusqu'à cinq niveaux différents de titres pour structurer votre contenu. Si vous avez plus de trois titres, une table des matières est générée automatiquement – cela peut être désactivé en incluant la chaîne ~~NOTOC~~ dans le document.

Headline Level 3

Headline Level 4

Headline Level 5
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

En utilisant quatre tirets ou plus, vous pouvez créer une ligne horizontale :

----


Fichiers multimédias

Vous pouvez inclure des images externes et internes, des vidéos et des fichiers audio entre crochets. En option, vous pouvez spécifier leur taille.

Taille réelle:

Redimensionner à une largeur donnée :

Redimensionner à la largeur et à la hauteur données 2):

Image externe redimensionnée :          

Taille réelle :                        {{wiki:dokuwiki-128.png}}
Redimensionner à une largeur donnée:            {{wiki:dokuwiki-128.png?50}}
Redimensionner à la largeur et à la hauteur données : {{wiki:dokuwiki-128.png?200x50}}
Image externe redimensionnée :           {{https://secure.php.net/images/php.gif?200x50}}

En utilisant des espaces à gauche ou à droite, vous pouvez choisir l'alignement.

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Bien sûr, vous pouvez également ajouter un titre (affiché sous forme d'info-bulle par la plupart des navigateurs).

This is the caption

{{ wiki:dokuwiki-128.png |This is the caption}}

Pour lier une image à une autre page, voir Liens d'images ci-dessus.

Formats multimédias pris en charge

DokuWiki peut intégrer directement les formats multimédias suivants.

Image gif, jpg, png
Video webm, ogv, mp4
Audio ogg, mp3, wav
Flash swf

Si vous spécifiez un nom de fichier qui n'est pas un format multimédia pris en charge, il sera alors affiché sous forme de lien.

En ajoutant ?linkonly, vous fournissez un lien vers le média sans l'afficher en ligne

{{wiki:dokuwiki-128.png?linkonly}}

dokuwiki-128.png Ceci est juste un lien vers l'image.

Formats de secours

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 video.webm and video.ogv next to the referenced video.mp4, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.

Additionally DokuWiki supports a “poster” image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a video.jpg file would work.

Listes

Dokuwiki prend en charge les listes ordonnées et non ordonnées. Pour créer un élément de liste, indentez votre texte de deux espaces et utilisez une * pour les listes non ordonnées ou un - pour les listes ordonnées.

  • Ceci est une liste
  • Le deuxième élément
    • Vous pouvez avoir différents niveaux
  • Un autre article
  1. La même liste mais ordonnée
  2. Un autre élément
    1. Utilisez simplement l'indentation pour les niveaux plus profonds
  3. C'est tout
  * Ceci est une liste
  * Le deuxième élément
    * Vous pouvez avoir différents niveaux
  * Un autre article

  - La même liste mais ordonnée
  - Un autre élément
    - Utilisez simplement l'indentation pour les niveaux plus profonds
  - C'est tout

Jetez également un œil à la FAQ sur les éléments de liste.

Text Conversions

DokuWiki peut convertir certains caractères ou chaînes prédéfinis en images, autre texte ou HTML.

La conversion de texte en image concerne surtout les smileys. Et la conversion de texte en HTML est utilisée pour les remplacements de typographie, mais peut également être configurée pour utiliser d'autres HTML.

Text to Image Conversions

DokuWiki convertit les émoticônes couramment utilisés en leurs équivalents graphiques. Ces Smileys et autres images peuvent être configurés et étendus. Voici un aperçu des Smileys inclus dans DokuWiki :

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Text to HTML Conversions

Typographie : DokuWiki peut convertir des caractères de texte simples en leurs entités typographiquement correctes. Voici un exemple de caractères reconnus.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

La même chose peut être faite pour produire n'importe quel type de HTML, il suffit de l'ajouter au pattern file.

Trois exceptions ne proviennent pas de ce fichier de modèle : signe de multiplication (640×480), “guillemets simple” et “guillemets doubles”. Ils peuvent être désactivés via une config option.

Citations

Parfois, vous voulez marquer un texte pour montrer qu'il s'agit d'une réponse ou d'un commentaire. Vous pouvez utiliser la syntaxe suivante :

je pense qu'on devrait le faire

> Non, nous ne devrions pas

>> Eh bien, je dis que nous devrions

> Ah bon?

>> Yes!

>>> Then lets do it!

je pense qu'on devrait le faire

Non, nous ne devrions pas
Eh bien, je dis que nous devrions
Ah bon?
Oui!
Alors faisons-le !

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 | for normal rows or a ^ for headers.

^ 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, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

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 ::: into the cells below the one to which they should connect.

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           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| 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), enclose the area either with <nowiki> tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. The same is true for //__this__ text// with a smiley ;-).

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for %%//__this__ text// with a smiley ;-)%%.

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 <code> or <file>.

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.
<code>
This is preformatted code all spaces are preserved: like              <-this
</code>
<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

Syntax Highlighting

DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. <code java> or <file java>.

/**
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

The following language strings are currently recognized: 4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic

There are additional advanced options available for syntax highlighting, such as highlighting lines or adding line numbers.

Downloadable Code Blocks

When you use the <code> or <file> syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>
myexample.php
<?php echo "hello world!"; ?>

If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: <code - myfile.foo>.

Embedding HTML and PHP

You can embed raw HTML or PHP code into your documents by using the <html> or <php> tags. (Use uppercase tags if you need to enclose block level elements.)

HTML example:

<html>
This is some <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">And this is some block HTML</p>
</HTML>

This is some <span style="color:red;font-size:150%;">inline HTML</span>

<p style="border:2px dashed red;">And this is some block HTML</p>

PHP example:

<php>
echo 'The PHP version: ';
echo phpversion();
echo ' (generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';
</PHP>

The PHP version: 8.1.29 (inline HTML)

The same, but inside a block level element:8.1.29

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, SimplePie is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:

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 HTML is disabled all tags will be stripped
nosort do not sort the items in the feed
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. 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 DokuWiki to re-render the page if it is more than refresh period since the page was last rendered.

By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the reverse parameter, or display the feed as is with nosort.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

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~~ If this macro is found on the page, no table of contents will be created
~~NOCACHE~~ DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force DokuWiki to rerender a page on every call

Syntax Plugins

DokuWiki's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:

1)
Ceci est une note de bas de page
2)
lorsque le rapport hauteur/largeur de la largeur et de la hauteur données ne correspond pas à celui de l'image, il sera recadré au nouveau rapport avant le redimensionnement