Accueil > Fonctionnement du site > Guide de l’utilisateur : écrire un article

Guide de l’utilisateur : écrire un article

Informations sur l'article (auteurs, licence)

Rédaction : le mercredi 6 février 2019, par DEGOUL Samuel

Se connecter pour modifier l'article (droit réservé à ses auteurs et aux webmesters)

Licence : CC BY-SA 4.0  (voir le contenu)

1 - Création d’un article

L’item « Édition » dans le menu supérieur offre deux possibilités d’accès :

  • liste des articles, dont ceux que l’on a rédigés (onglet « Mes articles »). La création d’un nouvel article à partir de ce point nécessitera de choisir une rubrique existante où l’inclure,
  • hiérarchie des rubriques, permettant d’accéder à voire de créer la rubrique qui doit accueillir le nouvel article.

Le bouton « Écrire un nouvel article » semble suffisamment explicite.
Lors de sa création, il est nécessaire de déterminer le titre +/- la rubrique concernée.
Le contenu de l’article est rédigé dans la section « Texte » via l’éditeur intégré (voir explications infra).


Ne pas oublier d’enregistrer ! (bouton en bas de page à droite)

1.1 - Contenu

Celui-ci dépend ce que vous voulez y mettre. Soyez juste conscients que l’édition web n’offre pas la même souplesse qu’un logiciel de traitement de texte, ce qui peut être vu d’abord comme une limitation mais qui est en fait un atout quand on veut transmettre une information structurée. Qu’importe la taille et le style de la police, le formatage des titres, la position exacte d’une ligne, ce qui compte est le sens. Pour cela, les outils de structuration du texte sont suffisants, avec gestion de plusieurs niveaux de titres, mise en évidence de texte, « classique » par du gras de l’italique, ou à l’aide de cadres prévus à cet effet (voir infra). Pour la distinction fond / forme, je vous renvoie à mon cours sur la rédaction scientifique.

Il est tout à fait possible de créer des tableaux et d’insérer des images.

1.2 - Pièces jointes et documents source

Il est tout à fait possible d’associer une ou des pièce(s) jointe(s) à l’article, et cela sera même généralement nécessaire quand il s’agira, notamment, de la mise en ligne d’un protocole : son contenu complet se trouvera dans la pièce jointe. Dans ce cas, il est bienvenu de ne pas laisser l’article vide sous prétexte que tout se trouve dans la pièce jointe : le contenu de la page web doit en effet expliciter un minimum le sujet et apporter les informations principales, notamment celles qui sont utiles directement pour la pratique de soin.


Les pièces jointes étant généralement destinées à la lecture et non à l’édition, merci des les rendre disponible sous un format adapté pour cela, c’est-à-dire principalement .pdf pour les documents texte et .png ou .jpg pour les images. Les formats éditables, notamment .doc, .docx et .pptx, ne garantissent pas une bonne lisibilité par tous les visiteurs, qui n’ont pas forcément le bon logiciel ou sa bonne version (à noter que la plupart des présentations « PowerPoint » passent très bien en PDF si elles ne sont pas truffées d’animation).

Afin de favoriser l’échange et la réutilisation de nos publications, il est de bon ton de publier les documents source ayant servi à construire la pièce jointe, si vous êtes l’auteur de celle-ci et qu’elle est publiée sous licence libre. Il s’agira le plus souvent de fichier sous l’un des formats éditables cités ci-dessus (.doc, .docx, .pptx mais aussi .odt pour ceux utilisant LibreOffice, .tex pour les fadas comme moi, ...).


Dans ce cas, merci d’y associer le mot-clé « type_document/document source » et de le nommer de la même façon que le document résultant.

En cas de multiples fichiers source, il peut être approprié de les rassembler dans une archive zip.

2 - Métadonnées

2.1 - Mots clés

Il est fortement conseillé d’associer des mots clés à l’article, pour faciliter l’indexation des informations dans le site et rendre la fonction de recherche efficace. Les mots-clés sont organisés en groupes :

  • thème, indexation « classique » : sujets abordés dans le documents, à choisir parmi une liste prédéfinie. Si des mots clés manquent, il faut demander à l’administrateur de les ajouter à la liste,
  • service d’anesthésie concerné au sein du GHRMSA (si applicable),
  • type d’article : s’agit-il d’un cours, d’un protocole, ... ?
  • degré d’urgence de la situation de soin concerné : ceci ne s’applique que pour les protocoles, pour distinguer ceux qui apparaîtront via le raccourci « Urgences vitales » du menu principal du site,
  • licence à appliquer à la ressource : si rien n’est indiqué explicitement ici, c’est la licence libre par défaut choisie pour le contenu du site qui s’appliquera à l’article.


Il est recommandé de publier son article sous les termes d’une licence libre (voir explication dans cet article).

2.2 - Évènement associé

Il est aussi possible d’associer un événement à l’article, par exemple une date de cours (avec heure et lieu), qui apparaîtra alors dans l’agenda du site.

3 - Publication

Enfin, toute contribution au site étant soumise à modération (voir explication ici), il faut proposer l’article à la modération via un bouton explicite en bas de page, ou en changeant le statut de l’article dans le menu à gauche, sous le numéro de l’article (passer de « en cours de rédaction » à « proposé à l’évaluation »).

L’article n’apparaîtra en ligne qu’après validation par un administrateur.

4 - Utilisation de l’éditeur de texte intégré.

Il existe plusieurs possibilités de rédaction.

4.1 - Syntaxe de base

Il s’agit de la syntaxe de base du système de gestion de contenu SPIP, sur lequel est basé ce site web.

Cette syntaxe simple comprend des raccourcis pour la mise en page, au lieu d’écrire directement du code HTML.

Ressources :

4.2 - Titres de section & sommaire

Si la syntaxe de base ne permet qu’un seul niveau de titres de section (notation : {{{titre}}}), l’utilisation du plugin « Intertitres hiérarchiques » (documentation ici) permet de dépasser cette limite.

On notera ainsi les titres :

  • {{{# Titre...}}} : titre de niveau 1
  • {{{## Titre...}}} : titre de niveau 2
  • {{{### Titre...}}} : titre de niveau 3

La numérotation des titres sera établie automatiquement.

L’utilisation de « * » au lieu de « # » permet d’obtenir des titres non numérotés (par ex. {{{** Titre...}}}). Ceci n’est pas conseillé sur ce site.

Un sommaire s’affiche automatiquement au début de l’article. Il est possible de modifier ce comportement par défaut en écrivant au début de l’article ces indications (qui n’apparaîtront pas dans l’article publié) :

  • <retire_sommaire> : ne pas afficher de sommaire
  • <sommaire|niveau_max=2> : afficher un sommaire en précisant sa profondeur maximale (2 niveaux de « profondeur » ici)

Voir la documentation du plugin « Sommaire automatique » pour plus d’informations.


24/08/23 : Il n’est désormais plus possible d’utiliser la syntaxe Markdown pour faire des titres.
L’utilisation des balises <md> et </md> n’a plus aucun effet.

4.3 - HTML

On peut saisir directement du code HTML. Néanmoins, ceci n’est pas recommandé car le système intégré de SPIP transforme automatiquement les raccourcis utilisés en balises HTML correctes avec les propriétés CSS adéquates.
Cependant, ceci peut s’avérer utiles pour des cas particuliers (par exemple, les blocs de code de cette article, où la classe CSS « spip_code » a du être spécifiée à la main).

4.4 - Fonctionnalités particulières

Certaines des ces fonctionnalités de rédaction ont été spécifiquement développées pour ce site.

4.4.1 - Encadrés

Des paragraphes peuvent être encadrés afin de mettre en valeur un message spécifique. La syntaxe générale est <cadre_x> ... </cadre_x>, avec x un style parmi « info », « points_cle », « citation », « avertissement », « danger » et « code » (destiné principalement au code informatique).

Exemple

<cadre_info>
Ceci est un cadre du type « info »
</cadre_info>

donne :


Ceci est un cadre de « info »

Voici le rendu des autres styles :


Ceci est un cadre de type « points_cle »


Ceci est un cadre de type « citation »


Ceci est un cadre de type « avertissement »


Ceci est un cadre de type « danger »


Ceci est un cadre de type « code »

NB : le rendu graphique de ces cadres n’est pas visible dans la prévisualisation de l’article dans l’espace privé, mais apparaît correctement dans l’article accessible aux lecteurs dans l’espace publique du site.

4.4.2 - Formules mathématiques

Il est possible d’écrire de belles formules mathématiques à l’aide de la syntaxe LATEX (voir un aperçu ici) intégrée entre des balises <math>...</math>.
Ainsi, <math>$a = \sqrt{b^{2} \times c^{2}}$</math> donne :

${a=\sqrt{b^{2} \times c^{2}}}$

Un message, un commentaire ?

modération a priori

Attention, votre message n’apparaîtra qu’après avoir été relu et approuvé.

Qui êtes-vous ?
Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.