Aide:Syntaxe:EXT CLI
CLI est l'abréviation de “Command Line Interface” qui signifie “interface en ligne de commande”. Il s'agit d'une interface homme-machine dans laquelle la communication entre l'utilisateur et l'ordinateur s'effectue en mode texte :
- l'utilisateur tape une ligne de commande, c'est-à-dire du texte au clavier pour demander à l'ordinateur d'effectuer une opération ;
- l'ordinateur affiche du texte correspondant au résultat de l'exécution des commandes tapées ou à des questions qu'un logiciel pose à l'utilisateur.
Voir Interface en ligne de commande sur Wikipédia pour plus de détail.
Ici, l'extension CLI sert à représenter graphiquement ce que l'ordinateur retourne suite à une commande. Le CLI Plugin complète les possibilités et la présentation des balises <code>…</code>. Voir blocs de code.
Description
Cette extension ajoute une syntaxe qui permet de présenter visuellement une interface en ligne de commande à Dokuwiki. Elle vous permet de aussi d'afficher les transcription de sortie (le résultat de la commande), par exemple pour afficher un manuel d'utilisation ou faire un didacticiel en ligne. Il est conçu pour fonctionner avec la sortie d'un Unix Bash Shell standard, mais convient pour documenter d'autres types d'interaction CLI, par exemple, d'une Console Windows, Python, Interactive Ruby, MATLAB, etc.
Les hypothèses retenues pour la mise en forme sont :
- toutes les commandes utilisateur commencent par une invite de commande ;
- l'invite de commande d'un CLI se terminera par un caractère reconnaissable (généralement '$' ou '>') ;
- les commandes de l'utilisateur suivront l'invite CLI sur la même ligne ;
- les commandes de l'utilisateur peuvent contenir un commentaire introduit par un caractère facilement reconnaissable (généralement '#') ;
- les lignes qui ne commencent pas par une invite sont des sorties du CLI (la réponse de l'ordinateur, le résultat).
Syntaxe
Il suffit de faire un copier le contenu de votre CLI et de le mettre entre les balises <cli>…</cli>.
Les paramètres utilisable sont :
| Param | Valeurs | Notes |
|---|---|---|
| prompt='VALEUR' | n/a | Permet de définir l'invite de commande si elle n'est pas reconnue par les expressions régulières définies par défaut. Voir les exemples ci-après et voir les détails (en anglais) pour régler ce paramètre : Configuration and settings. |
| continue='VALEUR' | n/a | Permet de définir l'invite de poursuite si elle n'est pas reconnue pas défaut. Une invite de poursuite est une autre invite de commande qui ne peut apparaître qu'immédiatement après une ligne contenant l'invite initiale. Elle se règle exactement comme le paramètre 'prompt'. |
| comment='VALEUR' | n/a | Permet de définir les marqueurs de commentaire. Comme les précédants paramètres il s'agit de définir une expression régulière si les commentaires ne sont pas reconnus par défaut. |
type=VALEUR  | | |
| VALEUR (une classe) | | |
user@ubports:~$ apt moo (__) (oo) /------\/ / | || * /\---/\ ~~ ~~ ..."Have you mooed today?"... user@ubports:~$
<cli>
user@ubports:~$ apt moo
(__)
(oo)
/------\/
/ | ||
* /\---/\
~~ ~~
..."Have you mooed today?"...
user@ubports:~$
</cli>
user@ordinosaure:~$ aptitude moo Il n'y a pas d'œufs de Pâques dans ce programme. user@ordinosaure:~$
<cli coloronblack> user@ordinosaure:~$ aptitude moo Il n'y a pas d'œufs de Pâques dans ce programme. user@ordinosaure:~$ </cli>
user@ordinosaure:~$ aptitude moo -v Il n'y a vraiment pas d'œufs de Pâques dans ce programme. user@ordinosaure:~$
<cli whiteonblack> user@ordinosaure:~$ aptitude moo -v Il n'y a vraiment pas d'œufs de Pâques dans ce programme. user@ordinosaure:~$ </cli>
user@ordinosaure:~$ aptitude moo -vv Ne vous ai-je pas déjà dit qu'il n'y avait pas d'œufs de Pâques dans ce programme ? user@ordinosaure:~$
<cli retro-green uppercase> user@ordinosaure:~$ aptitude moo -vv Ne vous ai-je pas déjà dit qu'il n'y avait pas d'œufs de Pâques dans ce programme ? user@ordinosaure:~$ </cli>
user@ordinosaure:~$ aptitude moo -vvv Arrêtez donc ! user@ordinosaure:~$
<cli retro-green uppercase reverse> user@ordinosaure:~$ aptitude moo -vvv Arrêtez donc ! user@ordinosaure:~$ </cli>
user@ordinosaure:~$ aptitude moo -vvvv D'accord, d'accord, si je vous donne un œuf de Pâques, vous en irez-vous ? user@ordinosaure:~$
<cli retro-ochre> user@ordinosaure:~$ aptitude moo -vvvv D'accord, d'accord, si je vous donne un œuf de Pâques, vous en irez-vous ? user@ordinosaure:~$ </cli>
user@ordinosaure:~$ aptitude moo -vvvvv D'accord, vous avez gagné. /----\ -------/ \ / \ / | -----------------/ --------\ ---------------------------------------------- user@ordinosaure:~$
<cli retro-ochre reverse>
user@ordinosaure:~$ aptitude moo -vvvvv
D'accord, vous avez gagné.
/----\
-------/ \
/ \
/ |
-----------------/ --------\
----------------------------------------------
user@ordinosaure:~$
</cli>
user@ordinosaure:~$ aptitude moo -vvvvvv Qu'est-ce que c'est ? C'est un éléphant qui se fait manger par un serpent, bien sûr. user@ordinosaure:~$
<cli c64> user@ordinosaure:~$ aptitude moo -vvvvvv Qu'est-ce que c'est ? C'est un éléphant qui se fait manger par un serpent, bien sûr. user@ordinosaure:~$ </cli>
commodore basic v7.0 122365 bytes free (c)1986 commodore electronics, ldt. (c)1977 microsoft corps. all rights reserved Ready. Go64 are you sure?y
<cli c128>
commodore basic v7.0 122365 bytes free
(c)1986 commodore electronics, ldt.
(c)1977 microsoft corps.
all rights reserved
Ready.
Go64
are you sure?y
</cli>