Le SCML, pour " Structured Commentary Markup Language", décliné Structured Changelog Markup Language, Structured Commit Markup Language, Structured Changes Markup Language, est un langage de balisage.
Il permet l'organisation des commentaires, des changelogs ou des commits de façon structurée et claire.
Le SCML peut être utilisé de plusieurs manières :
Le SCML trouve ses racines en juin 2016, lors d'un premier stage de développement web PHP à l'École Nationale Supérieure d'Architecture de Normandie (Wikipédia). La mission de ce stage consistait à concevoir une solution web en PHP pour automatiser la génération de PDFs de planning destinés aux moniteurs informatiques des étudiants dotés de compétences techniques chargés d'assister leurs camarades moins familiarisés avec l'informatique.
C'est dans ce contexte que naît un premier brouillon du langage, adopté d'emblée pour structurer les commits et les pushs sur GitLab. Le SCML était ainsi déjà en usage, de façon informelle, bien avant sa publication officielle. 2017 marque quant à elle la version standardisée et publiée du langage, fruit de cette expérience fondatrice.
Ressources
Le projet SCML est disponible en ligne :
Wikipédia
Syntaxe
Il existe 7 catégories de balises :
+, * pour un Ajout
/, @ et $ pour une Altération
- et µ pour une Suppression
&, ! et ? pour une Attente
$ et £ pour une Actualisation
< et > pour une Action
:: et /* */ pour un Commentaire
<#scml
::v0.0.0 - Titre
+ 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 : orange;
::Exemple : Nouvelle norme mise en application
> Action interne : mauve;
::Exemple : Action du technicien sur un poste utilisateur ou un serveur
< Action externe : mauve;
::Exemple : Action d'un client, utilisateur, ou prestataire, sur un poste utilisateur ou un serveur
::commentaire sur une ligne : bleu clair
/*
commentaire, sur plusieurs lignes : bleu clair
*/
#>
Changelogs
Version actuelle : v2.1
Identité visuelle
Différentes versions du logo SCML
Logo SCML v1
Logo SCML v2 stylisé "Shield"
Logo original
Licence
Ce programme est un logiciel libre ; vous pouvez le redistribuer ou le modifier suivant les termes de la GNU General Public License telle que publiée par la Free Software Foundation ; soit la version 3 de la licence, soit (à votre gré) toute version ultérieure. Ce programme est distribué dans l'espoir qu'il sera utile, mais SANS AUCUNE GARANTIE ; sans même la garantie tacite de QUALITÉ MARCHANDE ou d'ADÉQUATION à UN BUT PARTICULIER. Consultez la GNU GPL pour plus de détails.
Contact
Vous souhaitez me joindre ?