Skip to content

Commit

Permalink
relecture de la documentation (#969)
Browse files Browse the repository at this point in the history
resolves #968 - intégration des corrections dans la documentation de Stylo

---------

Co-authored-by: Camille <[email protected]>
  • Loading branch information
RochDLY and Camille authored Nov 20, 2023
1 parent e17bcc5 commit edd0c48
Show file tree
Hide file tree
Showing 18 changed files with 87 additions and 64 deletions.
8 changes: 3 additions & 5 deletions docs/src/en/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ title: "About _Stylo_"

Stylo is a semantic text editor designed and produced by the [Canada Research Chair in Digital Textualities](http://ecrituresnumeriques.ca) team, under the [GPL-3.0](https://github.com/EcrituresNumeriques/stylo/blob/master/LICENSE) license.

<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">
<img src="/uploads/images/logo-crc-ecrinum.svg" alt="Logo CRCDT" class="img-responsive img-thumbnail" style="max-width:250px">

## The project

Expand Down Expand Up @@ -62,6 +60,6 @@ The researchers participating in the project are as follows:

## Partners

- [Huma-num](https://www.huma-num.fr/)
- [Métopes](www.metopes.fr/)
- [Huma-Num](https://www.huma-num.fr/)
- [Métopes](http://www.metopes.fr/)
- [Érudit](http://erudit.org/)
14 changes: 7 additions & 7 deletions docs/src/en/collaborative-writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ title: "Collaborative writing"
## Prerequisites for synchronous writing

Synchronous collaborative editing enables several users to edit an article in Stylo at the same time.
This feature is similar to that found in other applications such as [Hedgedoc](https://hedgedoc.org/) and Google Docs.
This feature is similar to those found in other applications such as [Hedgedoc](https://hedgedoc.org/) and Google Docs.

Unlike these applications, where sharing a simple URL is enough to grant write rights to a document, Stylo requires user authentication to obtain this right.
Unlike these applications, where sharing a simple URL is enough to grant writing rights to a document, Stylo requires user authentication to obtain this right.

Information on authentication can be found on the [Getting started with Stylo](/en/first-steps/#creating-an-account) page.

Next, users who wish to write on a Stylo article during a collaborative session must have access to the article to be edited.
Then, users who wish to write in a Stylo article during a collaborative session must have access to the article.
To gain access rights to an article, 3 solutions are available: 

- [create an article](/en/myarticles/#create-a-new-article)
Expand All @@ -31,17 +31,17 @@ The first user to press this button becomes the moderator of the collaborative e
To join a collaborative session, other users must also click on this button in their interface.

A collaborative writing session is a special mode that does not correspond to the nominal writing function in Stylo.
In this collaborative mode, only Markdown text is accessible for writing.
Other information is not accessible (the panes on the left and right of the text editor).
In this collaborative mode, only Markdown text is accessible.
All other information is not accessible (the panels on the left and right of the text editor).

![Collaborative editing interface](/uploads/images/collaborative-editing-interface.png)

To ensure that the application functions correctly, the end of a collaborative session must be marked by a synchronous mode closure.
To ensure correct operation of the application, the end of a collaborative session must be marked by closing the synchronous mode.
Only the session moderator can perform this action, by pressing the end session button at the top right of the screen, above the Monaco editor.

<alert-block heading="Important">

If a collaborative session is not closed correctly, the article concerned will no longer be accessible in simple editing.
If a collaborative session is not closed correctly, the article will no longer be accessible in simple edition.

</alert-block>

Expand Down
8 changes: 7 additions & 1 deletion docs/src/en/corpus.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ A pop-up window containing a form will open, allowing you to modify the data con

## Export a corpus

<alert-block heading="Important">

Corpus exports are not yet available. They will be developed in 2024.

</alert-block>

![Export a corpus](/uploads/images/Export.png)

Exporting a corpus is done in the same way as for an article.
Expand All @@ -96,4 +102,4 @@ A window opens, offering several export options:
- numbering of chapters and sections;
- type of content division.

![Corpus exporting form](/uploads/images/corpus-formulaire-export.png)
![Corpus exporting form](/uploads/images/corpus-formulaire-export.png)
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
8 changes: 8 additions & 0 deletions docs/src/en/myarticles.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,14 @@ This function also allows you to send the article with the same system:

The [Send a Copy] option is not sharing the article; only the last version of the article will be visible for the user and the changes will not be visible to other users. In the [Send a Copy] process, two versions of the article are created and the users each work on a version that is not visible to the other.

## Take over

When an article is shared (via a workspace or the share button) with another user, the article editing function is only available to one person at a time. You'll see by the red dot in the box that a collaborator is editing the article or has not properly closed his editing session. If you also want to edit the article, you can take over the editing session by pressing ![Edit](/uploads/images/edit-red.png) and confirm. The other collaborator will then be in read-only mode and you will be able to edit the article.

To properly close an editing session, simply return to the *Articles* page when you've finished your work.

{% figure "/uploads/gif/reprise-de-session.gif", "Take over" %}

## Duplicate an article

You can duplicate your article by clicking on the following icon:
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
32 changes: 16 additions & 16 deletions docs/src/en/workspaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,29 @@ Workspaces meet the need to share Stylo articles between several users.
This implementation allows us to distinguish several spaces within Stylo.
First, there's the most commonly used space, the personal space: this is where every user arrives by default.

Personal space is where everyone can create and manipulate articles in Stylo.
The personal space is where everyone can create and manipulate articles in Stylo.
It's perfectly possible to remain in this space and share articles manually with other users via the [share functionality](/en/myarticles/#share-an-article).

However, if a document is to be shared with several users, it may be worth using the workspace feature.

Workspaces are not entities to which a user can assign ownership of an article.
All articles remain associated with the users who created them.
All articles remain associated with the user who created them.
The workspace, on the other hand, simply serves as a gateway for sharing a set of articles with several other users.
It should be seen as a specific channel for sharing content.

For example, you can create a workspace for a magazine and share the various articles currently being edited.
The workspace itself may be named "XX Magazine", but the articles associated with it will not belong to this workspace.
Each article will remain attached to the user account that created it.

Access to this feature is via the drop-down menu accessible by clicking on the non-user at the top of the page.
You can access this feature via the drop-down menu accessible by clicking on the non-user at the top of the page.

![Menu to access workspaces](/uploads/images/menu-espace-de-travail.png)

Then click on \[All spaces\] to access the workspace manager.
Then click on \[All spaces\] to access the workspace management menu.

## Manage your workspaces

The workspace manager has four functions:
The workspace management menu has three functionalities:

- create a workspace by clicking on the corresponding button \[Create workspace]. This opens a form with three fields: Name, Description and Color.
- the ability to exit a workspace. To do this, click on the \[Leave workspace] button.
Expand All @@ -53,19 +53,19 @@ Everyone is responsible for managing information and collaborative dynamics.
A workspace is a configuration that allows only related documents to be displayed in the Stylo interface.
They are displayed instead of personal articles.

Articles are not displayed in the workspace manager, but on the \[Articles\] page (by clicking on the button in the black banner at the top of the page).
Articles are not displayed in the workspace management menu, but on the \[Articles\] page (available at the top of the page).

Then click on your \[User name] and select the workspace you wish to work in from the drop-down menu.

The user's workspace is indicated in two different places:

1. in the menu at the top of the page (black banner), if nothing is indicated under the user name, you are in the personal area;
1. in the menu at the top of the page, under the [User name];

![Indication of the workspace in which you work](/uploads/images/BarreLateraleStyloNoire-V2.PNG)
![bar with workspace](/uploads/images/affichage-espace-de-travail.png)

Otherwise, the name of the workspace you are in is indicated under the username;
If nothing is indicated under the Username, you are in your personal workspace;

![](/uploads/images/indication-espace-de-travail-dans-menu.png)
![Bar with personal workspace](/uploads/images/affichage-espace-perso.png)

2. the workspace name is also shown at the top of the article list.

Expand All @@ -75,25 +75,25 @@ Articles shared in the workspace appear in place of personal articles.
They can be accessed with the same functionality as in a personal workspace.

The [corpus](/en/corpus) feature is also available in workspaces.
A distinction is made between personal corpora and corpora linked to workspaces.
A distinction is made between personal corpus and corpus linked to workspaces.

## Associating an article with a workspace

The \[Articles\] page changes slightly between the personal and workspaces.
The \[Articles\] page changes slightly between the personal space and workspaces.
The \[Create article\] button is no longer present in the workspace.

As mentioned above, the workspace is not the owner of the articles shared within it.
Consequently, to associate an article with a workspace, you need to return to your personal workspace by clicking on its \[User name] in the black banner at the top of the page, then on \[My workspace] to display its articles.
Consequently, to associate an article with a workspace, you need to return to your personal workspace by clicking on its \[User name] in the black banner at the top of the page, then on \[My workspace] to display your articles.

You can only create an article (or add it to your workspace) from this interface.
Once an article has been created, open its information by clicking on the chevron ![](/uploads/images/plus.png) and tick the box associated with the workspace in which you wish to share the article.
Once an article has been created, open its information by clicking on the arrow ![arrow](/uploads/images/plus.png) and tick the box associated with the workspace in which you wish to share the article.

## Deleting a workspace

There is no button for deleting a workspace.
This task is performed automatically when the last member of a workspace clicks on the \[Leave workspace\] button in the workspace manager.
This task is performed automatically when the last member of a workspace clicks on the \[Leave workspace\] button in the workspace management menu.

If the last member of a workspace wishes to leave it, a pop-up window appears, asking for confirmation of this action.

Only the sharing instance between members is deleted once the last member has left the workspace.
Only the sharing session between members is deleted once the last member has left the workspace.
As articles remain associated with their creator, they remain available on the owner's personal space.
22 changes: 11 additions & 11 deletions docs/src/fr/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ useSideMenu: true

Stylo est un éditeur de texte sémantique conçu et réalisé par l'équipe de la [Chaire de recherche du Canada sur les écritures numériques](http://ecrituresnumeriques.ca), sous licence [GPL-3.0](https://github.com/EcrituresNumeriques/stylo/blob/master/LICENSE).

<img src="/uploads/images/logo.png" alt="logo CRCEN" class="img-responsive img-thumbnail" style="max-width:250px">
<img src="/uploads/images/logo.png" alt="Logo CRCEN" class="img-responsive img-thumbnail" style="max-width:250px">


## 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 @@ -61,8 +61,8 @@ Les chercheur·e·s participant à la réalisation de ce projet sont les suivant

## Partenaires

- [Huma-num](https://www.huma-num.fr/)
- [Métopes](www.metopes.fr/)
- [Huma-Num](https://www.huma-num.fr/)
- [Métopes](http://www.metopes.fr/)
- [Érudit](http://erudit.org/)


8 changes: 7 additions & 1 deletion docs/src/fr/corpus.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ Une fenêtre pop-up contenant un formulaire va s'ouvrir et permettre de modifier

## Exporter un corpus

<alert-block heading="Important">

Les exports des corpus ne sont pas fonctionnels. Ils seront développés courant 2024.

</alert-block>

![Exporter un corpus](/uploads/images/Export.png)

L'export d'un corpus se réalise de la même manière que pour un article.
Expand All @@ -96,4 +102,4 @@ Une fenêtre s'ouvre et propose plusieurs options d'export :
- la numérotation ou non des chapitres et sections ;
- le type de division des contenus.

![Formulaire d'export d'un corpus](/uploads/images/corpus-formulaire-export.png)
![Formulaire d'export d'un corpus](/uploads/images/corpus-formulaire-export.png)
5 changes: 2 additions & 3 deletions docs/src/fr/edition-collaborative.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ C'est un mode qu'il faut initialiser en appuyant sur l'icône \[*Collaborative e
Le premier utilisateur à appuyer sur ce bouton devient le modérateur de la session d'écriture collaborative.
Pour rejoindre une session collaborative, les autres utilisateurs devront eux aussi cliquer sur ce bouton dans leur interface.

Une session d'écriture collaborative est un mode particulier qui ne correspond pas au fonctionement nominal d'écriture dans Stylo.
Dans ce mode collaboratif, seul le texte en Markdown est accessible en écriture.
Les autres informations ne sont pas accessibles (les volets à gauche et à droite de l'éditeur de texte).
Une session d'écriture collaborative est un mode particulier qui ne correspond pas au fonctionnement nominal d'écriture dans Stylo.
Dans ce mode collaboratif, seul le texte en Markdown est accessible. Les autres informations ne sont pas accessibles (les volets à gauche et à droite de l'éditeur de texte).

![Collaborative editing interface](/uploads/images/collaborative-editing-interface.png)

Expand Down
Loading

0 comments on commit edd0c48

Please sign in to comment.