Différences

Ci-dessous, les différences entre deux révisions de la page.

--- aide:syntaxe:ext_cli [28.01.2023 @ 15:35] – créée Chewbacca
+++ aide:syntaxe:ext_cli [28.01.2023 @ 17:43] (Version actuelle) – Chewbacca
@@ Ligne 8: / Ligne 8: @@
 Voir [[wpfr>Interface en ligne de commande|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.
+Ici, l'extension CLI sert à représenter graphiquement ce que l'ordinateur retourne suite à une commande. Le [[doku>plugins:cli|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 [[wpfr>Bourne-Again shell|Unix Bash Shell]] standard, mais convient pour documenter d'autres types d'interaction CLI, par exemple, d'une [[wpfr>Console Windows]], [[wpfr>Python (langage)|Python]], [[wpfr>Interactive Ruby]], [[wpfr>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 [[wpfr>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 : [[doku>plugin:cli#configuration_and_settings|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  FIXME             | FIXME          | FIXME  |
+| VALEUR (une classe)  FIXME     | FIXME          | FIXME  |
@@ Ligne 35: / Ligne 62: @@
 user@ubports:~$
 </cli></code>