Premiers pas dans Stylo

Création d'un compte

Afin d'éditer dans Stylo, la création d'un compte utilisateur via Huma-Num est recommandée. Pour créer un compte, rendez-vous sur Stylo : https://stylo.huma-num.fr et choisissez le type de compte (nous vous recommandons de créer un compte Huma-Num ou de vous connecter si en avez déjà un) :

Si vous possédez déjà un compte Stylo ou Huma-Num, connectez-vous ici.

Page d'utilisateur

La page d'accueil de votre compte Stylo liste vos articles personnels ainsi que ceux qui ont été partagés avec vous par d'autres utilisateurs de Stylo.

Par défaut, un premier article “How to Stylo” est présent sur la plateforme et détaille chaque étape de la rédaction d’un article. N’hésitez pas à vous y référer si vous souhaitez directement écrire votre article dans Stylo ou si vous avez des questions sur des articles à traitement particulier (illustrations, etc.).

Pour chaque article, plusieurs actions sont possibles :

Bouton	Fonction
	pour ouvrir l'article en édition
	pour partager l'article et son historique de versions avec un autre usager de Stylo qui s'intitulera ainsi : "[Copy]New article"
	pour dupliquer uniquement la dernière version de l'article
	pour renommer l'article
	pour supprimer l'article
	pour développer d'autres fonctions de l'article :
	pour consulter l'historique des versions enregistrées
	pour choisir les tags de l'article

Note : le nom du document tel que visible sur Stylo ne correspond pas au titre de l'article qui sera généré. Le titre doit être renseigné dans les métadonnées (volet de droite sur l'article) pour apparaître sur la prévisualisation ou les exports.

Attention : supprimer un article est irréversible. Si l'article est partagé avec un autre usager, après sa suppression, il restera accessible pour cet utilisateur.

Comprendre la structure d'un article

Un article dans Stylo est composé à partir de trois éléments distincts :

• un corps de texte ;
• des métadonnées ;
• une bibliographie.

Stylo propose une interface intégrée pour éditer chacun de ces éléments, dont les sources sont accessibles à tout moment via le module d'export.

L'interface d'édition

L'interface d'édition d'un article présente plusieurs modules :

• un corps de texte : espace d'édition du corps de texte de l'article ;
• un gestionnaire de métadonnées : espace d'édition des informations concernant l'article (résumé, auteur, mot-clés, date de publication, etc.) ;
• un gestionnaire de versions : espace permettant d'enregistrer et de nommer des versions mineures (Create Minor) ou majeures (Create Major), d'accéder aux versions successives pour les consulter, les exporter ou les comparer avec d'autres versions ;
• une table des matières : présentant automatiquement le sommaire de l'article, à partir des titres du corps de texte ;
• un gestionnaire de bibliographie : espace d'édition des références (citées ou non dans le corps du texte) ;
• un outil de statistiques : présentant les informations statistiques de l'article (nombre de mots, de caractères, etc.).

L'option Share

La fonction [Share] permet d'inviter des co-auteur·rice·s à travailler sur le même article. Ces utilisateurs ont alors accès à tout l'historique. Les versions de l'article se synchronisent pour tous les utilisateurs au fur et à mesure des modifications effectuées sur le document.

Attention : partager un article avec un autre utilisateur est possible uniquement en renseignant l'adresse courriel qui a servi à créer le compte utilisateur sur Stylo.

Nouvel article

Pour créer un nouvel article, il suffit de cliquer sur le bouton :

Vous devez ensuite renseigner le nom du document dans le champ prévu à cet effet

et valider l'opération en cliquant une nouvelle fois sur le bouton

Lors de cette opération, il vous est également possible de choisir les tags associés à l'article :

L’article apparaît désormais dans votre liste d’articles.

Cliquez sur le bouton

pour accéder à l’environnement d’édition et commencer à éditer votre article.

Importer

Si le contenu destiné à être édité est déjà structuré dans un autre format, dans un autre environnement, il est possible de le transférer dans l'espace d'édition de Stylo. Stylo gère essentiellement du langage Markdown (extension .md) : pour importer un contenu actuellement en format DOC (extension .doc) ou DOCX (extension .docx), nous avons mis en place un convertisseur en ligne permettant de convertir un document docx vers md. La procédure à adopter est détaillée sur la page de conversion.

Une fois la conversion effectuée, un document .md est généré : ouvrez-le avec un éditeur de texte (Atom, GeDit), puis copier-coller le contenu du document dans l'espace de votre article en Stylo.

Édition

L'environnement d'édition est composé de cinq modules :

• au centre : l'espace d'écriture consacré au corps de texte de l'article;
• à droite : le bouton [Metadata] ouvre l'éditeur de métadonnées;
• à gauche :
  • l'historique des versions du document (Versions) pour naviguer et agir sur les différentes versions enregistrées;
  • le sommaire (Table of content) de l'article liste les titres de niveau 2, 3 et suivants;
  • la bibliographie (Bibliography) liste les références bibliographiques;
  • les statistiques (Stats) offrent quelques données quantitatives sur l'article.

Écrire en Markdown

L'article dans Stylo doit être écrit en langage Markdown, un langage de balisage simple à prendre en main.

Le langage Markdown permet une syntaxe simple d'usage autant en lecture qu'en écriture. Voici les principales règles d'écriture en Markdown :

• Titre : les niveaux de titre (titre de niveau 1 pour le titre de l'article, de niveau 2 pour les titres de section, etc.) sont renseignés avec un #, ainsi :
  • # Titre d'article, ## Introduction, etc.

Attention : le corps de texte de l'article ne supporte pas les titres de niveau 1, le titre de niveau 1 étant uniquement réservé au champ Title dans les métadonnées.

• Italique : l'italique se balise dans le texte de deux manières : _mot_ ou *mot*
• Gras : le gras se balise dans le texte ainsi : **mot**
• Citation longue : les citations longues dans le texte sont balisées ainsi : > citation longue
• Note : une note dans le texte se balise selon qu'elle est avec ou sans appel de note :

avec appel de note :

Voici mon texte[^1]

[^1]:Une note de bas de page avec appel et renvoi.

sans appel de note :

Voici mon texte^[Une note de bas de page inline.]

Pour approfondir vos connaissances en syntaxe Markdown, vous pouvez consulter la page suivante.

Versions

Une version du document correspond à une sauvegarde de votre travail. Une version contient toujours les trois éléments de l'article : métadonnées, bibliographie, corps de texte. En chargeant une ancienne version, ce sont donc ces trois éléments qui sont mis à jour.

Votre travail est par défaut automatiquement sauvegardé sur Stylo, mais vous devez créer vous-mêmes les versions. Pour ce faire, vous pouvez donc - et cela est conseillé - utiliser la fonction de sauvegarde [New Version] qui permet de générer une nouvelle version du travail :

Ainsi, lorsque vous êtes parvenu·e·s à une version que vous jugez satisfaisante, il vous est possible de nommer votre version dans le champ Label of the version avant de l'enregistrer en tant que version mineure ([Create Minor]) ou majeure ([Create Major]).

Une version mineure correspond à des modifications mineures, tandis qu'une version majeure acte l'établissement d'une version dont les modifications sont importantes.

À tout moment, vous pouvez visualiser votre travail, qu'il s'agisse de la version actuelle que vous êtes en train d'éditer ou des versions précédentes. Il suffit de cliquer sur le bouton [Preview] :

Chaque version comporte plusieurs fonctionnalités :

• Pour la version éditable (Edition) :

Bouton	Fonction
	pour sauvegarder une version majeure de votre travail
	pour sauvegarder une version mineure de votre travail
	pour exporter et télécharger la version dans différents formats
	pour accéder à la prévisualisation de votre travail et l'annoter

• Pour une version antérieure :
  • [Compare] pour comparer les différentes versions (une version antérieure et la version actuelle ou deux versions antérieures). Pour davantage d'informations sur la fonction [Compare], vous pouvez consulter la page suivante;
  • [Export] : pour exporter et de télécharger le document dans différents formats : HTML, PDF, XML, etc.;
  • [Preview] pour accéder à la prévisualisation de votre travail et l'annoter. Pour davantage d'informations sur la fonction [Preview], vous pouvez consulter la page suivante.

Pour visualiser une ancienne version, il vous suffit de cliquer sur son titre. Pour retourner à la version éditable, il vous faut cliquer sur le bouton [Edit Mode].

Export

Le module d'export offre plusieurs formats (HTML, XML, PDF, etc.). Il permet de choisir un style bibliographique et la présence ou non d'une table des matières.

Pour davantage d'informations sur l'export Stylo, vous pouvez consulter la page suivante.

Sommaire

Le sommaire affiche une liste des titres de niveau 2, 3 et suivants. Ces titres sont cliquables pour accéder rapidement à la partie du texte correspondante.

Bibliographie

La bibliographie liste les références bibliographiques que vous avez ajoutées. Celles-ci peuvent être ajoutées une par une ou groupées. Pour ajouter vos références, vous devez cliquer sur [Manage Bibliography] dans le volet de gauche : l'outil Bibliographie s'ouvre alors et vous propose plusieurs possibilités :

1. Zotero : il vous est possible de synchroniser une bibliographie en connectant Stylo à votre compte Zotero (groupes/collections privées ou publiques) ;
2. vous pouvez également indiquer l'URL d'une collection d'un groupe public Zotero ;
3. Citations : il vous est possible de renseigner votre bibliographie manuellement au format BibTeX ;
4. Raw bibtex : il est possible de corriger directement le BibTeX.

Vous pouvez directement structurer vos références en BibTeX ou exporter vos références en BibTex grâce à votre outil de gestion de bibliographie :

• voir tutoriels : Zotero Mendeley

Pour ajouter une référence à l'article, il suffit de cliquer sur la référence, puis de coller (Ctrl+V) la référence dans le texte à l'endroit souhaité. Ainsi, un clic revient à "copier" la clé de la référence dans le presse-papiers. Il ne reste plus qu'à la coller dans le corps de texte. Un système d'autocomplétion vous permet aussi d'afficher les références disponible en tapant [@ ou @ suivi ou non des premières lettres de l'identifiant de la référence.

Pour davantage d'informations sur la gestion de la bibliographie, vous pouvez consulter la page suivante.

Métadonnées

Le bouton [Metadata] permet d'ouvrir le volet des métadonnées. Trois modes d'édition sont disponibles :

1. Basic Mode : permet d'éditer les métadonnées fondamentales : titre, sous-titre, résumés, auteur·e·s et mots-clés ;
2. Editor Mode : permet d'éditer l'ensemble des métadonnées relatives à une revue savante : identifiant d'un article, informations de dossier, informations sur l'évaluation, catégories et mots-clés de la revue, etc. ;
3. Raw Mode : espace d'édition pour utilisateur avancé qui permet de modifier les champs d'entrées directement dans la structure du format YAML.

Important : afin d'exporter un article, les champs "Title" et "Authors" doivent obligatoirement être renseignés.

Attention : dans le volet des métadonnées se trouve la division sur la "Bibliographie" dont l'option Display permet de choisir la visualisation de la bibliographie dans son entièreté ("All citations") ou uniquement des références qui ont été citées dans le corps de l'article ("Only used").

Statistiques

Le menu Stats donne des informations sur :

• Le nombre de mots ;
• Le nombre de caractères sans la prise en compte des espaces ;
• Le nombre de caractères, espaces compris ;
• Le nombre de citations.

Annotation

Il y a deux possibilités d'annotation :

1. Annoter une version ;
2. Annoter l'article.

Pour annoter une version, cliquez sur le numéro de la version que vous voulez annoter et ensuite cliquez sur [Preview]. Une prévisualisation de l'article en html s'ouvrira avec l'outil d'annotation hypothes.is sur la droite.

Important : si vous annotez une version, vos annotations ne seront pas visibles sur les autres versions.

Pour annoter l'article, cliquez sur [Preview (open a new window)]. Les annotations concerneront l'article. Cependant, puisque la version éditable est sujette à des changements, les annotations pourront ne plus être ancrées aux bonnes parties du texte (qui pourraient avoir été supprimées ou déplacées).