Skip to content

Commit

Permalink
doc(export): mise à jour de la documentation sur les templates stylo-…
Browse files Browse the repository at this point in the history
…export
  • Loading branch information
thom4parisot committed Sep 30, 2024
1 parent 92de4e6 commit 487ff67
Show file tree
Hide file tree
Showing 9 changed files with 38 additions and 2,262 deletions.
28 changes: 14 additions & 14 deletions docs/src/en/exports.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Export Page
title: Export Page
---

## Export en article
Expand Down Expand Up @@ -29,7 +29,7 @@ It is possible to choose from several bibliographic styles: some embed the refer

The export module takes care of formatting references, adding or removing spaces, inserting "Ibids." according to the style, etc.

Exports are produced using the conversion tool [Pandoc](https://pandoc.org/) based on the templates available [here](./export/templates).
Exports are produced using the conversion tool [Pandoc](https://pandoc.org/) based on the [`stylo-export` templates](https://gitlab.huma-num.fr/ecrinum/stylo/stylo-export/-/tree/main/templates/generique).

The export also allows you to download the source files of Stylo (.md,.bib,.yaml) and the media inserted in the article if there are any.

Expand All @@ -43,11 +43,11 @@ For more information on how to use templates, see this [tutorial](https://gitlab

## Export page

The current version of the Stylo export module ([https://export.stylo.huma-num.fr/](https://export.stylo.huma-num.fr/)) supports generic export and integrated export into the editorial cheange of Métopes (XML-TEI Commons Publisihing schema for Métopes or OpenEdition).
The current version of the Stylo export module ([https://export.stylo.huma-num.fr/](https://export.stylo.huma-num.fr/)) supports generic export and integrated export into the editorial cheange of Métopes (XML-TEI Commons Publisihing schema for Métopes or OpenEdition).

Stylo's *old* export module (https://stylo-export.ecrituresnumeriques.ca) lists the other custom exports from Stylo, including:

- exports for journals that use Stylo in their editorial chains:
- exports for journals that use Stylo in their editorial chains:
- [Sens public](http://sens-public.org/)
- [Scriptura](https://www.facebook.com/RevueScriptura/)
- [Nouvelles vues](https://nouvellesvues.org/presentation-de-la-revue/)
Expand All @@ -56,16 +56,16 @@ Stylo's *old* export module (https://stylo-export.ecrituresnumeriques.ca) lists

## Special exports

### University of Montreal Template Exports
### University of Montreal Template Exports

The Stylo exports page for [University of Montreal Templates](https://stylo-export.ecrituresnumeriques.ca/exportudem.html) was created to allow students at the University of Montreal to produce their renderings directly with the regulatory formatting.
The Stylo exports page for [University of Montreal Templates](https://stylo-export.ecrituresnumeriques.ca/exportudem.html) was created to allow students at the University of Montreal to produce their renderings directly with the regulatory formatting.

Three templates are available:
Three templates are available:

- The Département des littératures de langue fraçaise (DLLF) template
- with /or/ without table of contents (coming soon)

- The Lesson template
- The Lesson template

<iframe src="http://stylo-doc.ecrituresnumeriques.ca/uploads/pdf/testPlanCours.pdf" title="testPlanCours" width="100%" height="500" allowfullscreen></iframe>

Expand Down Expand Up @@ -112,13 +112,13 @@ year: '2021'
```
2. Register a version (major or minor) and select it
3. Select in the version url the version key (the last digits after "/version/")
4. Copy the version key
4. Copy the version key
5. In the Lesson Plan export page, paste the version key in the dedicated location
6. Then enter a name for the export, select the Lesson Plan template and click on "Submit"

#### EBSI template
#### EBSI template

To export your document according to the EBSI template, you need to:
To export your document according to the EBSI template, you need to:

1. Edit the following metadata in the metadata pane in "RAW" mode

Expand All @@ -139,7 +139,7 @@ day: '05'
course:
- id: acronym
title: Course title
teachers:
teachers:
- forname: First name
surname: Name
lang: fr
Expand All @@ -155,8 +155,8 @@ typeWork: TP2

2. Save a version (major or minor) and select it
3. Select in the version url the version key (i.e. the last digits after "/version/")
4. Copy the version key
4. Copy the version key
5. In the EBSI export page, paste the version key in the dedicated location
6. Then enter a name for the export, select the EBSI model and click on "Submit"

**Warning**: do not forget to refresh the export page if you make several exports in a row.
**Warning**: do not forget to refresh the export page if you make several exports in a row.
10 changes: 5 additions & 5 deletions docs/src/en/firststeps.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ During this operation, you can also choose the tags related to the article:

![Add Tags](/uploads/images/AddTag.png)

The article will then appear in your list of articles.
The article will then appear in your list of articles.

Click on the button

Expand All @@ -117,12 +117,12 @@ The Stylo article must be written in Markdown, an easy-to-learn markup language.

Markdown language allows a syntax structure that is easy to both read and write. Here are the main writing rules for Markdown:

- Title: the levels of the title (level 1 for the title of the article, level 2 for the titles of the section, etc.) are organised using ```#```, like this:
- Title: the levels of the title (level 1 for the title of the article, level 2 for the titles of the section, etc.) are organised using ```#```, like this:
- ```# Title of the article```, ```## Introduction```, etc.

Careful: The article's body text does not support titles for level 1; titles for level 1 are only used for the *Title* fields in the metadata.

- **Italics**: italics can be created in two ways: ```_word_``` or ```*word*```
- **Italics**: italics can be created in two ways: ```_word_``` or ```*word*```
- **Bold**: bold can be created like this: ```**word**```
- **Long citation**: long citations are created like this: ```> long citation```
- **Footnote**: a footnote can be created with or without a number:
Expand Down Expand Up @@ -179,7 +179,7 @@ It is possible to choose from several bibliographic styles: some embed the refer

The export module takes care of formatting references, adding or removing spaces, inserting "Ibids." according to the style, etc.

Exports are produced using the conversion tool [Pandoc](https://pandoc.org/) based on the templates available [here](https://framagit.org/stylo-editor/templates-stylo).
Exports are produced using the conversion tool [Pandoc](https://pandoc.org/) based on the templates available [here](export/templates).

For more information on Stylo exporting, you can see this [page](/en/exports/)

Expand Down Expand Up @@ -228,7 +228,7 @@ The [Metadata] button opens the metadata pane. Three editing modes are available

For more information on metadata editing, you can see this [page]().

**Careful**: In the metadata pane is the "Bibliography" division, including the *Display* option, which allows you to choose to view the bibliography either in its entirety ("All citations"), or just the references which have been cited in the body of the article ("Only used").
**Careful**: In the metadata pane is the "Bibliography" division, including the *Display* option, which allows you to choose to view the bibliography either in its entirety ("All citations"), or just the references which have been cited in the body of the article ("Only used").

![All citation](/uploads/images/allCitation.png)

Expand Down
8 changes: 4 additions & 4 deletions docs/src/en/myarticles.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,9 @@ 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
## 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.
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.

Expand All @@ -156,7 +156,7 @@ To export an article, you must click on the "Export" button, then the page "My a

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

The export menu allows you to choose the export format. It also contains the option to include or exclude a table of contents.
The export menu allows you to choose the export format. It also contains the option to include or exclude a table of contents.

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

Expand All @@ -177,7 +177,7 @@ It is possible to choose from several bibliographic styles, some of which integr

The export module manages the reference formatting, adding or removing spaces, and inserting "ibid" according to the style, etc.

Exports are produced thanks to the [pandoc](https://pandoc.org/) conversion tool, based on templates available [here](https://framagit.org/stylo-editeur/templates-stylo).
Exports are produced thanks to the [pandoc](https://pandoc.org/) conversion tool, based on [`stylo-export` templates](https://gitlab.huma-num.fr/ecrinum/stylo/stylo-export/-/tree/main/templates/generique).

The export also downloads the Stylo source files (.md, .bib, .yaml) and the media inserted in the article, if this is the case.

Expand Down
22 changes: 11 additions & 11 deletions docs/src/fr/exports.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Il est possible de choisir parmi plusieurs styles bibliographiques : certains i

Le module d'export se charge de mettre en forme les références, d'ajouter ou d'enlever les espaces, d'insérer des "Ibid." en accord avec le style, etc.

Les exports sont produits grâce à l'outil de conversion [Pandoc](https://pandoc.org/) sur la base des templates disponibles [ici](https://framagit.org/stylo-editeur/templates-stylo).
Les exports sont produits grâce à l'outil de conversion [Pandoc](https://pandoc.org/) sur la base des [templates `stylo-export`](https://gitlab.huma-num.fr/ecrinum/stylo/stylo-export/-/tree/main/templates/generique).

L'export permet aussi de télécharger les fichiers source de Stylo (.md, .bib, .yaml) et les médias insérés dans l'article s'il y en a.

Expand All @@ -45,9 +45,9 @@ Pour plus d'informations sur l'emploi des templates, voir ce [tutoriel](https://

La version actuelle du module d'export de Stylo ([https://export.stylo.huma-num.fr/](https://export.stylo.huma-num.fr/)) propose un export générique et un export pour une intégration dans la chaîne d'édition de Métopes (schéma XML-TEI Commons Publishing pour Métopes ou OpenEdition).

La version _legacy_ de l'export de Stylo ([https://stylo-export.ecrituresnumeriques.ca](https://stylo-export.ecrituresnumeriques.ca/)) liste d'autres exports personnalisés de Stylo dont :
La version _legacy_ de l'export de Stylo ([https://stylo-export.ecrituresnumeriques.ca](https://stylo-export.ecrituresnumeriques.ca/)) liste d'autres exports personnalisés de Stylo dont :

- les exports pour les revues qui utilisent Stylo dans leurs chaînes éditoriales :
- les exports pour les revues qui utilisent Stylo dans leurs chaînes éditoriales :
- [Sens public](http://sens-public.org/)
- [Scriptura](https://www.facebook.com/RevueScriptura/)
- [Nouvelles Vues](https://nouvellesvues.org/presentation-de-la-revue/)
Expand All @@ -56,22 +56,22 @@ La version _legacy_ de l'export de Stylo ([https://stylo-export.ecrituresnumeriq

## Les exports spéciaux

### Exports modèles de l'Université de Montréal
### Exports modèles de l'Université de Montréal

La page des exports Stylo [Modèles de l'Université de Montréal](https://stylo-export.ecrituresnumeriques.ca/exportudem.html) a été créée pour permettre aux étudiant.es de l'Université de Montréal de produire leurs rendus directement avec la mise en forme réglementaire.
La page des exports Stylo [Modèles de l'Université de Montréal](https://stylo-export.ecrituresnumeriques.ca/exportudem.html) a été créée pour permettre aux étudiant.es de l'Université de Montréal de produire leurs rendus directement avec la mise en forme réglementaire.

Trois modèles sont proposés :
Trois modèles sont proposés :

- Le modèle du Département des littératures de langue française (DLLF)
- avec /ou/ sans table des matières (en cours d'implémentation)

- Le modèle du Plan de cours
- Le modèle du Plan de cours

<iframe src="http://stylo-doc.ecrituresnumeriques.ca/uploads/pdf/testPlanCours.pdf" title="testPlanCours" width="100%" height="500" allowfullscreen></iframe>

- Le modèle de L'École de bibliothéconomie et des sciences de l'information (EBSI)

<iframe src="http://stylo-doc.ecrituresnumeriques.ca/uploads/pdf/test.pdf" title="testEBSI" width="100%" height="500" allowfullscreen></iframe>
<iframe src="http://stylo-doc.ecrituresnumeriques.ca/uploads/pdf/test.pdf" title="testEBSI" width="100%" height="500" allowfullscreen></iframe>

#### Modèle DLLF
(à venir)
Expand Down Expand Up @@ -116,9 +116,9 @@ year: '2021'
5. Dans la page d'export du Plan de cours, coller la clef de version à l'emplacement dédié;
6. Puis attribuer un nom à l'export, sélectionner le modèle du Plan de cours et cliquer sur "Submit".

#### Modèle EBSI
#### Modèle EBSI

Pour exporter votre document selon le modèle de l'EBSI, il faut :
Pour exporter votre document selon le modèle de l'EBSI, il faut :

1. Éditer les métadonnées suivantes dans le volet des métadonnées en mode "RAW" :

Expand All @@ -139,7 +139,7 @@ day: '05'
cours:
- id: Sigle
title: Titre du cours
teachers:
teachers:
- forname: Prénom
surname: Nom
lang: fr
Expand Down
8 changes: 4 additions & 4 deletions docs/src/fr/premierspas.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ L'interface d'édition d'un article présente plusieurs modules :

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.
**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.

## Nouvel article

Expand Down Expand Up @@ -151,7 +151,7 @@ Pour approfondir vos connaissances en syntaxe Markdown, vous pouvez consulter la

![Active](/uploads/images/Nom-Version-V2.PNG)

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.
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.

Expand Down Expand Up @@ -184,7 +184,7 @@ Il est possible de choisir parmi plusieurs styles bibliographiques : certains i

Le module d'export se charge de mettre en forme les références, d'ajouter ou d'enlever les espaces, d'insérer des "Ibid." en accord avec le style, etc.

Les exports sont produits grâce à l'outil de conversion [Pandoc](https://pandoc.org/) sur la base des templates disponibles [ici](https://framagit.org/stylo-editeur/templates-stylo).
Les exports sont produits grâce à l'outil de conversion [Pandoc](https://pandoc.org/) sur la base des [templates `stylo-export`](https://gitlab.huma-num.fr/ecrinum/stylo/stylo-export/-/tree/main/templates/generique).

Pour davantage d'informations sur l'export Stylo, vous pouvez consulter la [page dédiée](/fr/exports).

Expand Down Expand Up @@ -228,7 +228,7 @@ Le bouton [**Metadata**] permet d'ouvrir le volet des métadonnées. Trois modes

**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").
**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").

![Bibliography-Display](/uploads/images/Bibliography-Display-V2.PNG)

Expand Down
Loading

0 comments on commit 487ff67

Please sign in to comment.