Utilisateur:Landerster/Brouillon

Une page de Wikipédia, l'encyclopédie libre.
SCML
Structured Commentary Markup Language
Logo
Caractéristiques
Extension
.scml, .scm
Développé par
Version initiale
2017
Type de format
Basé sur
Spécification
Site web

Structured Commentary Markup Language est un langage de balisage léger créé en 2017 par Marvin Gracias. Son but est d'offrir une syntaxe facile à lire et à écrire pour la rédaction des versioning, commit, et d'une manière général les changements. La syntaxe simple du SCML permet une organisation des informations simples.

Un document balisé par SCML peut être converti en XML. La source d’inspiration principale est le Markdown et le XML. Le langage est actuellement en version 2.1.

Dénominations[modifier | modifier le code]

Structured Commentary Markup Language se traduit littéralement en Langage de Balisage de Commentaire Structuré. Il est aussi décliné sous la forme Structured Changelog Markup Language (Langage de Balisage de Changelog Structuré) Structured Markup Language (Langage de Balisage de Commit Structuré), ou Structured Changes Markup Language (Langage de Balisage de Structuré).

Syntaxe du SCML[modifier | modifier le code]

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 :

<#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 : mauve;
		::Exemple : Nouvelle norme mise en application
	::commentaire sur une ligne : bleu clair;
	/*
	commentaire, sur plusieurs lignes : bleu clair;
	*/
#>

Exemple de SCML & HTML[modifier | modifier le code]

<!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[modifier | modifier le code]

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.

Sources[modifier | modifier le code]

Documentation du Structured Commentary Markup Language

Catégorie:Standard du web Catégorie:Codage du texte Catégorie:Format ouvert