Structured Commentary Markup Language
L'article doit être débarrassé d'une partie de son jargon ().
Sa qualité peut être largement améliorée en utilisant un vocabulaire plus directement compréhensible. Discutez des points à améliorer en page de discussion.
Cet article ne cite pas suffisamment ses sources ().
Si vous disposez d'ouvrages ou d'articles de référence ou si vous connaissez des sites web de qualité traitant du thème abordé ici, merci de compléter l'article en donnant les références utiles à sa vérifiabilité et en les liant à la section « Notes et références ».
En pratique : Quelles sources sont attendues ? Comment ajouter mes sources ?
Cet article est une ébauche concernant l’informatique et Internet.
Vous pouvez partager vos connaissances en l’améliorant (comment ?) selon les recommandations des projets correspondants.
Structured Commentary Markup Language
| Extension |
.scml, .scm |
|---|---|
| Développé par | |
| Version initiale |
2017 |
| Type de format | |
| Basé sur | |
| Site web |
Le Structured Commentary Markup Language, aussi Structured Changelog Markup Language, mais aussi Structured Commit Markup Language, abrégé SCML, est conçu pour structuré les commentaires dans une page web ou pour le versioning. C’est un langage de balisage permettant de structurer et de rendre plus pertinent un commentaire. Le SCML peut servir comme alternative aux commentaires dans un document, le rendant ainsi plus riche et interactif. Plus spécifiquement, il peut-être pour le commit sur le logiciel GitLab. Le langage est actuellement en version 2.
Dénominations
L’anglais Structured Commentary Markup Language se traduit littéralement en langage de balisage de commentaire structuré.
Syntaxe du SCML
Le SCML se caractérise par la présence d'un titre, singulièrement pour signaler la version du logiciel. Les balises "<#scml" et "#>" sont facultatives; Elles permettent de signaler quelle sont les règles de syntaxe adoptées pour le commentaire. Ensuite, le commentaire se détail par l'utilisation de plusieurs caractères, respectivement :
::v0.0.0 - Titre
<#scml
+ Ajout : bleu;
::Exemple : Ajout d’un paragraphe
* Création : bleu;
::Exemple : Création d’un nouveau formulaire
- Suppresion : rouge;
::Exemple : Suppression d’une ligne
µ Orthographe : rouge;
::Exemple : Correction d’une faute
/ Modification : vert;
::Exemple : Modification de l’ergonomie
@ Changement de destination : vert;
::Exemple : Le fichier X se trouve désormais dans le dossier Y
§ Réparation : vert;
::Exemple : Corrections de bugs mineurs
& Ambiguë : rose;
::Exemple : Problème de réalisation, élément à revoir
! Attention particulière : rose;
::Exemple : Risque de faille
? Interrogation: rose;
::Exemple : Interrogation sur d’éventuelles améliorations
$ Mise à jour : orange;
::Exemple : Mise à jour des informations
£ Normalisation : mauve;
::Exemple : Nouvelle norme mise en application
::commentaire sur une ligne : bleu clair;
/*
commentaire, sur plusieurs lignes : bleu clair;
*/
#>
Exemple de SCML & HTML
<!DOCTYPE html>
<html>
<head>
<title>
Exemple de HTML
</title>
</head>
<body>
<p>
Paragraphe
</p>
/*
* Création d'un paragraphe;
& Contenu ambiguë;
:: Essayer de détailler le contenu du paragraphe;
*/
</body>
</html>
Ainsi, dans le commentaire précédent, le SCML ne contient pas des balises "<#scml" et "#>" afin de ne pas surcharger le code.
De même pour le titre "::v0.0.0 - Titre", qui est plus commun pour le commit pour les logiciels de forge (voir versioning).
Avantages
Le SCML est un langage à la syntaxe simple et facile à apprendre. Sa tolérance lui permet une adaptation facile sur tous types d'applications. Ainsi, un document HTML ou même un document texte, grâce à leurs balises de commentaires respectifs, permet une organisation avec du SCML.
Suivant cette logique, le SCML pourrait être utilisé afin de commenter les modifications apportées lors de la rédaction (ou correction) d'une page Wikipédia.
Inconvénients
Le SCML présente des avantages mais aussi des inconvénients. En effet, il peut s'avérer lourd et son utilisation peut être éphémère, notamment pour une utilisation dans un document HTML, car une fois les remarques prises en compte dans le commentaire SCML, ce dernier est supprimable.
