Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

relecture de la documentation #969

Merged
merged 14 commits into from
Nov 20, 2023
4 changes: 1 addition & 3 deletions docs/src/en/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Stylo is a semantic text editor designed and produced by the [Canada Research Ch

<img src="/uploads/images/logo-crc-ecrinum.svg" alt="logoErudit" class="img-responsive img-thumbnail" style="max-width:250px">

<img src="/uploads/images/erudit-logotype-rouge.png" alt="logoErudit" class="img-responsive img-thumbnail" style="max-width:150px">
Copy link
Contributor

@loup-brun loup-brun Nov 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C'est très pointilleux, mais le texte alternatif de l'image pourrait être écrit en prose naturelle (alt="Logo Érudit") plutôt qu'en syntaxe camelCase (alt="logoErudit").


## The project

More than a tool, Stylo is a philosophy of text.
Expand Down Expand Up @@ -63,5 +61,5 @@ The researchers participating in the project are as follows:
## Partners

- [Huma-num](https://www.huma-num.fr/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huma-num semble devoir être écrit « Huma-Num » (avec un « N » majuscule).

Voir https://www.huma-num.fr/.

- [Métopes](www.metopes.fr/)
- [Métopes](http://www.metopes.fr/)
- [Érudit](http://erudit.org/)
4 changes: 2 additions & 2 deletions docs/src/en/firststeps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Getting started with Stylo
---

## Creating an account
In order to edit in Stylo, creating a user account via Huma-Num is recommended. To create an account, go to Stylo: https://stylo.huma-num.fr and choose the type of account (we recommend that you create a Huma-Num account or log in if you already have one):
In order to edit in Stylo, creating a user account via Huma-Num is recommended. To create an account, go to Stylo: https://stylo.huma-num.fr and choose the type of account:

![Register](/uploads/images/Login-Huma-Num-V2.PNG)

Expand Down Expand Up @@ -197,7 +197,7 @@ The bibliography lists the bibliographic references that you have added. The bib
2. **Citations** : you can manually fill in your bibliography using BibTex format;
3. **Raw bibtex** : to edit the BibTeX directly.

You can directly [structure your references in BibTex](http://www.andy-roberts.net/writing/latex/bibliographies), or export your references in BibTex with your bibliography management tool:
You can directly [structure your references in BibTex](/en/bibtexsyntax/), or export your references in BibTex with your bibliography management tool:

- See tutorials : <a class="btn btn-info" href="http://sens-public.org/IMG/pdf/Utiliser_Zotero.pdf" role="button">Zotero</a> <a class="btn btn-info" href="https://libguides.usask.ca/c.php?g=218034&p=1446316" role="button">Mendeley</a>

Expand Down
2 changes: 1 addition & 1 deletion docs/src/en/sources.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Stylo Source
title: Stylo Sources
---

Report problems and bugs on the [project's GitHub repository](https://github.com/EcrituresNumeriques/stylo/issues).
Expand Down
18 changes: 9 additions & 9 deletions docs/src/fr/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Stylo est un éditeur de texte sémantique conçu et réalisé par l'équipe de

## Le projet

Plus qu'en outil, Stylo est une philosophie du texte. Il repose sur l'idée que nous devons concevoir des modèles textuels adaptés pour l'écriture en sciences humaines et sociales (SHS).
Plus qu'un outil, Stylo est une philosophie du texte. Il repose sur l'idée que nous devons concevoir des modèles textuels adaptés pour l'écriture en sciences humaines et sociales (SHS).

Il est pensé et crée pour écrire des textes scientifiques et en particulier adapté pour les revues en SHS.
Il est pensé et créé pour écrire des textes scientifiques et en particulier adapté pour les revues en SHS.

C'est actuellement un outil prototype en cours de développement, implémenté dans la chaîne éditoriale de plusieurs revues dans le cadre notamment du projet partenariat [Revue 2.0](http://revue20.org/).
Cet outil est par ailleurs utilisé par différent·e·s auteur·e·s et étudiant·e·s à titre personnel pour leurs travaux scientifiques ou institutionnels.
Expand All @@ -27,16 +27,16 @@ Le code source de Stylo est disponible sur [GitHub](https://github.com/Ecritures

Bien que fondamentale en vue d’une diffusion numérique, la structuration des documents et leur balisage sont actuellement reportés à la fin du processus éditorial quand, en réalité, ceux-ci devraient être envisagés dès la production (par l’auteur·e, dès la première révision des articles). À cet égard, il semble urgent et cohérent de réintégrer le travail de balisage et de structuration en début de chaîne éditoriale.

La philosophie de Stylo consiste à remettre dans les mains des chercheur·e·s la gestion du balisage en partant cette fois-ci de leurs compétences, qui relèvent davantage de compétences sémantiques que graphiques.
La philosophie de Stylo consiste à remettre entre les mains des chercheur·e·s la gestion du balisage du texte en partant cette fois-ci de leurs compétences, qui relèvent davantage de compétences sémantiques que graphiques.

L'éditeur est basé sur la séparation entre le balisage sémantique et les affichages graphiques, ce qui permet à l'auteur·e de se consacrer au sens du texte plutôt que sur sa mise en forme.
L'éditeur est basé sur la séparation entre le balisage sémantique et les affichages graphiques, ce qui permet à l'auteur·e de se consacrer au sens du texte plutôt qu'à sa mise en forme.

Stylo propose une solution libre, basée sur des standards (Markdown, YAML, BibTeX) qui permet de :
Stylo propose une solution libre, basée sur des standards (Markdown, YAML, BibTeX) qui permet :

- produire des textes bien balisés avec des métadonnées riches et une bibliographie structurée ;
- produire de multiples sorties (PDF, HTML, XML, ODT...) à partir d'un seul document.
- d'écrire des textes bien balisés avec des métadonnées riches et une bibliographie structurée ;
- de produire de multiples sorties (PDF, HTML, XML, ODT...) à partir d'un seul document.

Stylo est un outil qui implémente des formats et des technologies de conversion existantes et déjà utilisées par la communauté, ce qui permet une libre circulation des documents qui ne sont pas enfermés dans un format particulier.
Stylo est un outil qui implémente des formats et des technologies de conversion existantes et déjà utilisées par la communauté scientifique, ce qui permet une libre circulation des documents qui ne sont pas enfermés dans un format particulier.

## Contributeur·rice·s

Expand All @@ -62,7 +62,7 @@ Les chercheur·e·s participant à la réalisation de ce projet sont les suivant
## Partenaires

- [Huma-num](https://www.huma-num.fr/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huma-num semble écrit « Huma-Num » (avec un « N » majuscule).

Voir https://www.huma-num.fr/.

- [Métopes](www.metopes.fr/)
- [Métopes](http://www.metopes.fr/)
- [Érudit](http://erudit.org/)


10 changes: 5 additions & 5 deletions docs/src/fr/premierspas.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Pour commencer avec Stylo

## Création d'un compte

Afin d'éditer dans Stylo, la création d'un compte utilisateur via Huma-Num vous est recommandée. Pour créer un compte, rendez-vous sur Stylo : [https://stylo.huma-num.fr](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 vous en avez déjà un) :
Afin d'éditer dans Stylo, nous vous recommandons la création d'un compte utilisateur via Huma-Num. Pour créer un compte, rendez-vous sur Stylo : [https://stylo.huma-num.fr](https://stylo.huma-num.fr) et choisissez le type de compte :
Copy link
Contributor

@loup-brun loup-brun Nov 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[https://stylo.huma-num.fr](https://stylo.huma-num.fr)

L'ancre avec son lien hypertexte pourrait être réécrite avec des chevrons : <https://stylo.huma-num.fr/>. La syntaxe markdown permet d'en faire un hyperlien automatiqument. Cela pourrait faciliter l'écriture et la maintenance des URLs dans le texte -- à moins que l'on préfère afficher un texte différent.


![Register](/uploads/images/Login-Huma-Num-V2.PNG)

Expand Down Expand Up @@ -44,7 +44,7 @@ Pour chaque article, plusieurs actions sont possibles :
| ![Ajouter aux espaces de travail](/uploads/images/ajout-dans-espace-de-travail.png) | pour ajouter un article dans un espace de travail |
| ![Ajouter aux corpus](/uploads/images/add-to-corpus.png) | pour ajouter à un corpus |

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.
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 la page d'édition) pour apparaître lors de la prévisualisation ou les exports.

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

Expand Down Expand Up @@ -73,7 +73,7 @@ L'interface d'édition d'un article présente plusieurs modules :

## 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.
La fonction **[Share]** permet d'inviter des co-auteur·rice·s à travailler sur le même article. Ces utilisateur·ice·s 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 son compte utilisateur sur Stylo.

Expand Down Expand Up @@ -163,7 +163,7 @@ Pour exporter un article, il faut cliquer sur le bouton "Export" depuis la page

![Export](/uploads/images/Download.png)

Le menu d'export permet de choisir le format d'export. Il contient également la possibilité d'intégrer ou non une table des matières.
Le menu d'export permet de choisir le format d'export. Il contient également la possibilité d'intégrer ou non la table des matières.

![Export](/uploads/images/ExportConfig-V2.PNG)

Expand Down Expand Up @@ -203,7 +203,7 @@ La bibliographie liste les références bibliographiques que vous avez ajoutées
- **Citations** : il vous est possible de renseigner votre bibliographie manuellement au format BibTeX ;
- **Raw BibTeX** : il est possible de corriger directement le BibTeX.

Vous pouvez directement [structurer vos références en BibTeX](http://www.andy-roberts.net/writing/latex/bibliographies) ou exporter vos références en BibTeX grâce à votre outil de gestion de bibliographie :
Vous pouvez directement [structurer vos références en BibTeX](/fr/syntaxe-bibtex/) ou exporter vos références en BibTeX grâce à votre outil de gestion de bibliographie :

- voir tutoriels : <a class="btn btn-info" href="http://sens-public.org/IMG/pdf/Utiliser_Zotero.pdf" role="button">Zotero</a> <a class="btn btn-info" href="https://libguides.usask.ca/c.php?g=218034&p=1446316" role="button">Mendeley</a>

Expand Down
2 changes: 1 addition & 1 deletion docs/src/fr/sources.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Source de Stylo
title: Sources de Stylo
---

**Source de Stylo** :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

La métadonnée title: Sources de Stylo a été modifiée, mais pas le début du paragraphe (ligne 5). Je ne sais pas si c'est volontaire, mais c'est le même texte.

Expand Down