How to Stylo

Introduction

Stylo est un éditeur de texte scientifique. Pour faire vos premiers pas sur Stylo, commencez par éditer cet article.

Stylo utilise le format markdown pour baliser et styler le texte. Cet article présente la syntaxe de base du markdown, et une documentation plus complète est accessible ici.

Vous pouvez visualiser l’article à tout moment en cliquant sur le bouton Preview dans le menu de gauche.

Les titres

Les titres de niveaux 2 doivent être balisés avec 2 # (##) et non un seul, car le titre de niveau 1 correspond au titre de l’article, déclaré dans les métadonnées.

Titres de niveau 3

Les titres de niveaux 3 doivent être balisés avec 3 # et ainsi de suite.

Un saut de ligne correspond au début d’un nouveau paragraphe.

Syntaxe minimale

Gras et italique

Voici du texte en italique. Voici du texte en gras.

Commentaire

La ligne ci-dessous n’apparaitra pas dans le document final.

Images

On peut insérer des images:

Notez que le «Titre de mon image» sera pris en compte comme légende de l’image dans l’article.

Listes

Les listes non numérotées:

• item
• item
• item

Les listes numérotées:

1. item
2. item
3. item

L’ordre des chiffres n’est pas important:

1. item
2. item
3. item
4. item

Cette liste sera automatiquement ordonnée de 1 à 4.

Appareil critique

Notes de bas de page

Un appel de note de bas de page se fait ainsi[^1]. Par ailleurs, la note peut être déclarée n’importe où dans le document[^2], en fin de document ou juste en dessous par exemple[^3].

[^3]: Une note déclarée “n’importe où”, ici, juste en dessous du paragraphe correspondant.

Le label de la note peut être ce que vous voulez : il peut être indifféremment un chiffre ou une suite de caractères[^notePage].

Une note de bas de page peut aussi être écrite dans le corps du texte, en sortant l’accent circonflexe des crochets^[Ceci est une note de bas de page inline. Elle peut être aussi longue que vous voulez, elle sera transformée comme les autres en note de bas de page].

Les références

Un article scientifique utilise des références. Vous pouvez soit importer un fichier bibtex généré par votre logiciel de gestion bibliographique (conseillé), ou bien créer manuellement les références au format bibtex.

Les références sont ensuite insérées dans le texte grâce à leur clé bibtex. Pour récupérer la clé bibtex d’une référence, il suffit de cliquer sur la référence souhaitée dans la liste des référence ci-contre. La clé est alors ajouté à votre presse-papier, il suffit ensuite de la coller dans le texte [@goody_raison_1979].

Pour résumer :

1. clic sur la référence: copier la clé
2. coller ou CTRL+V : colle la clé dans le texte où est positionné le curseur [@goody_raison_1979].

Il est également possible d’ajouter une référence ainsi : « Comme le dit @goody_raison_1979, le geste … »

La clé peut aussi être accompagnée de précision comme ici [@goody_raison_1979, pp.115].

Les références citées se retrouveront ensuite à la fin du texte dans la section ## Bibliographie

Les citations

Une citation dans le corps du texte est indiquée par guillemets « Stat rosa pristina nomine, nomina nuda tenemus ». Une citation plus longue peut être indiquée ainsi :

Stat rosa pristina nomine, nomina nuda tenemus.

la citation se poursuit avec un second paragraphe.

Versions et export

Métadonnées

Les métadonnées de l’article s’éditent dans le menu en haut à droite. Vous pouvez y indiquer le titre, sous-titre, le nom de l’auteur et son identifiant de l’Orcid[^orcid], le résumé et les mot-clés de l’article. Pour les éditeurs de revue, une série plus complète de métadonnées est également disponible.

[^orcid]: L’identifiant Orcid permettra de récupérer automatiquement l’affiliation et la biographie de l’auteur.

Preview et annotation

Chaque version de votre texte peut être prévisualisée et annotée avec l’outil d’annotation Hypothes.is. Pour accéder à la preview, cliquez sur le bouton Preview. Pour accéder à la version html annotable, cliquez sur le bouton Anotate. Vous pouvez alors partager ces urls de preview et d’annotation. Chaque url est relative à la version du document.

Export

Plusieurs types d’exports sont disponibles :

• XML Erudit : exporte un fichier xml compatible avec le schéma Erudit
• Zip : comprend les trois sources de l’article : yaml (métadonnées), bibtex (bibliographie), md (corps de texte)
• …

Annotations sémantiques

Il est possible de structurer sémantiquement votre texte avec des simples balises.

Il y a deux types d’annotation sémantiques:

1. Des annotations qui concernent un ou plusieurs mots dans le même paragraphe
2. Des annotations qui concernent plusieurs paragraphes

Annotation dans un paragraphe

La syntaxe:

[Voici la thèse de l’article]{.these}

Produira en HTML:

Voici la thèse de l’article

Dans la preview vous pouvez visualiser les classes:

• these
• definition
• exemple
• concept
• epigraphe
• dedicace
• note

Annotation de plusieurs paragraphes

La syntaxe:

::: {.maclasse}

Ici un paragraphe.

Ici un autre paragraphe.

:::

Produira en HTML:

<div class="maclasse">
  <p>Ici un paragraphe.</p>
  <p>Ici un autre paragraphe.</p>
</div>

Pour plus d’informations, consultez la documentation.

Bibliographie

[^1]: La note se trouve ensuite à la fin du texte. [^2]: Voici une note déclarée en fin de document [^notePage]: Voici une note avec un label textuel.