Remonter

Structured Commentary Changelog Commit Markup Language

I - Description


Le SCML (initialement Structured Commentary Markup Language, décliné Structured Changelog Markup Language ou Structured Commit 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. Son extension est .scml ou .scm, mais peut être utilisée dans un fichier texte, le langage n'étant pas strict sur la syntaxe.
De plus, les balises "<#scml" "#>" ne sont pas obligatoires, elles servent à définir la zone de SCML dans le document.

On recense 5 catégories de balises :
- Ajout - Altération - Suppression - Attente - Autres


II - Cas d'utilisation


Le SCML peut servir comme alternative aux simples commentaires dans un document, le rendant ainsi plus riche et interactif. Plus spécifiquement, il peut-être utilisé pour les changelogs, les commits ainsi que pour les commentaires (sur Wikipédia par exemple).

III - 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.

IV – Syntaxe


::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;
*/
#>

V - Changelogs


Liste des versions

VI - Téléchargement


Téléchargement du fichier .xml afin d'ajouter le SCML comme langage sur Notepad++