nouvelle structure de la documentation FR (#1049)

* essai d'une nouvelle structure de la documentation plutôt que d'avoir toute la documentation à la racine du site, la proposition suivante consiste à découper la navigation à partir de 4 sections : - les fonctionnalités - les guides d'utilisation - les tutoriels - la faq Pour l'instant cette preuve de concept n'est que pour la partie fr de la documentation, il faudra la dupliquer sur la partie en anglais dès qu'elle sera validée * modification du json à la racine de la langue fr: correction de l'entrée menu * documentation: suppression de l'entrée 'langue' des menus des sous-sections faq, tutoriels, fonctionnalites, guides_utilisation * documentation: suppression de la sous-section actualites Cette partie ne devrait pas être dans la documentation de Stylo, on peut utiliser soit le site de R30 pour ça, soit faire un blog pour Stylo, soit utiliser la fonctionnalité discussion pour épingler des nouveautés et informer les utilisateurs * documentation: changement du comportement d'eleventy pour empêcher le dataDeepMerge sur les données des menus de navigation * documentation: ajout des langues dans les menus des sous-sections fonctionnalites, faq, guides_utilisation et tutoriels * documentation: mise à jour de la version et changement du titre dans le fichier fonctionnalites/index.md * documentation: modification de la structure avec utilisation du mode dataDeepMerge(true) + reordonner le menu à gauche + certaines pages sont maintenant dans le footer * documentation: modification des css pour les éléments du footer avec changement du comportement des hyperliens et changement des noms des classes pour correspondre aux contenus. Ajout des variables globales utilisées dans le ocmposant page-footer.webc. Correction des métadonnées dans bibliographie.md. Corrections des informations dans le colophon.md. Déplacement de la page contact.md à la racine (et modifications des hyperliens)
EcrituresNumeriques · Oct 31, 2024 · e142b51 · e142b51
1 parent bbc2c40
commit e142b51
Show file tree

Hide file tree

Showing 34 changed files with 264 additions and 196 deletions.
diff --git a/docs/.eleventy.js b/docs/.eleventy.js
@@ -50,6 +50,11 @@ module.exports = function(eleventyConfig) {
     ],
   });
 
+  // Réglage du comportement par défaut d'11ty de fusionner n'importe quelle propriété héritée de la structure de données
+  // Prend true ou false comme valeur (false permet de désactiver le comportement de fusion)
+  // Documentation ici : <https://www.11ty.dev/docs/data-deep-merge/>
+  eleventyConfig.setDataDeepMerge(true);
+
   // Collections
   // Tous les contenus sous /fr
   eleventyConfig.addCollection('docs__fr', function(collection) {

diff --git a/docs/src/_includes/components/page-footer.webc b/docs/src/_includes/components/page-footer.webc
@@ -1,14 +1,26 @@
 <!---- Pied de page ---->
 <!----
 Pied de page partagé par les documents.
-Exploite la variable globale `rights`.
+Exploite les variables globales :  `rights`, `colophon`, `sources`, `contact`.
 
 Usage:
 
   <document-footer></footer>
 ---->
 
 <div class="document-footer">
+  <div
+    class="document-footer__contact"
+    @html="$data.contact"
+  ></div>
+  <div
+    class="document-footer__sources"
+    @html="$data.sources"
+  ></div>
+    <div
+    class="document-footer__colophon"
+    @html="$data.colophon"
+  ></div>
   <div
     class="document-footer__rights"
     @html="$data.rights"
@@ -21,20 +33,55 @@ Usage:
     padding: 1rem 0;
 
     border-top: 1px solid var(--couleur-fond-accent);
-    color: var(--couleur-fond-accent);
     font-size: .875rem;
   }
 
+
+  /* Déclare les propriétés CSS pour les valeurs des variables globales `contact`, `sources`, `colophon`
+  Cette mise en page est temporaire, elle devra faire l'objet d'une discussion ultérieure.*/
+  .document-footer__contact {
+    line-height: var(--interlignage, 125%);
+
+  }
+
+  .document-footer__sources {
+    line-height: var(--interlignage, 125%);
+
+  }
+
+  .document-footer__colophon {
+    line-height: var(--interlignage, 125%);
+  }
+
+  /* Déclare les propriétés css de la valeur récupéré avec la variable globale `rights` */
   .document-footer__rights {
     line-height: var(--interlignage, 125%);
+    color: var(--couleur-fond-accent);
   }
 
   /* Liens */
+
+  /* Comportement par défaut des hyperliens dans le footer.
+  Le comportement ajouté est similaire au hyperliens présents dans la documentation.
+  Élément à rediscuter/valider. */
   .document-footer a {
+    color: var(--couleur-lien, inherit);
     text-decoration: underline;
-    color: inherit;
   }
+
   .document-footer a:hover {
     color: var(--couleur-lien);
+    text-decoration: none; 
+  }
+
+  /* On préserve le comportement initialement prévu pour les hyperliens présents dans la valeur de la variable
+  globale `rights`. */
+  .document-footer__rights a {
+    text-decoration: underline;
+    color: inherit;
+  }
+
+  .document-footer__rights a:hover {
+    color: var(--couleur-lien);
   }
 </style>
diff --git a/docs/src/fr/actualites/actualites.json b/docs/src/fr/actualites/actualites.json
diff --git a/docs/src/fr/actualites/index.md b/docs/src/fr/actualites/index.md
diff --git a/docs/src/fr/about.md → docs/src/fr/colophon.md b/docs/src/fr/about.md → docs/src/fr/colophon.md
@@ -1,13 +1,7 @@
 ---
-title: À propos de _Stylo_
-useSideMenu: true
+title: "Colophon"
 ---
 
-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">
-
-
 ## Le projet
 
 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).
@@ -19,8 +13,6 @@ Cet outil est par ailleurs utilisé par différent·e·s auteur·e·s et étudia
 
 Stylo peut être utilisé en ligne à l'adresse [stylo.huma-num.fr](https://stylo.huma-num.fr). Cette instance de Stylo est déployée et maintenue par [Huma-Num](https://www.huma-num.fr), qui assure la sauvegarde et la sécurité des données.
 
-Le code source de Stylo est disponible sur [GitHub](https://github.com/EcrituresNumeriques/stylo/).
-
 ## La *Stylo*-sophie
 
 Éditeur de texte WYSIWYM pour les sciences humaines, Stylo est conçu pour changer l’ensemble de la chaîne éditoriale numérique des revues savantes en sciences humaines et sociales.
@@ -38,31 +30,43 @@ Stylo propose une solution libre, basée sur des standards (Markdown, YAML, BibT
 
 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
 
-Les chercheur·e·s participant à la réalisation de ce projet sont les suivants :
+## Contributeur·rice·s actuels
+
+### Chercheur·e·s
 
 - [Antoine Fauchié](https://ecrituresnumeriques.ca/fr/Equipe/Antoine-Fauchie/)
-- [Arthur Juchereau](https://ecrituresnumeriques.ca/fr/Equipe/Arthur-Juchereau)
-- [Lena Krause](https://ecrituresnumeriques.ca/fr/Equipe/Lena-Krause)
 - [Margot Mellet](https://ecrituresnumeriques.ca/fr/Equipe/Margot-Mellet)
 - [Servanne Monjour](https://ecrituresnumeriques.ca/fr/Equipe/Servanne-Monjour-)
 - [Nicolas Sauret](https://ecrituresnumeriques.ca/fr/Equipe/Nicolas-Sauret)
 - [Marcello Vitali-Rosati](https://ecrituresnumeriques.ca/fr/Equipe/Marcello-Vitali-Rosati-)
 - [Roch Delannay](https://ecrituresnumeriques.ca/fr/Equipe/Roch-Delannay)
 - [Louis-Olivier Brassard](https://www.loupbrun.ca)
 
-## Développeurs
+### Développeurs
 
 - [Guillaume Grossetie](https://github.com/ggrossetie)
 - [Thomas Parisot](https://détour.studio)
 - [David Larlet](http://larlet.com/)
-- [Arthur Juchereau](https://ecrituresnumeriques.ca/fr/Equipe/Arthur-Juchereau)
+- [Yves Marcoux](https://recherche.umontreal.ca/fr/nos-equipes-de-recherche/repertoire-des-professeurs/chercheur/is/in14146/)
 
-## Partenaires
+### Designers
+
+- [Maïtané Lenoir](https://maiwann.net/)
+
+### Partenaires
 
 - [Huma-Num](https://www.huma-num.fr/)
 - [Métopes](http://www.metopes.fr/)
 - [Érudit](http://erudit.org/)
 
 
+## Ancien·ne·s Contributeur·rice·s
+
+- [Arthur Juchereau](https://ecrituresnumeriques.ca/fr/Equipe/Arthur-Juchereau)
+- [Lena Krause](https://ecrituresnumeriques.ca/fr/Equipe/Lena-Krause)
+
+
+## Briques technologiques
+
+La documentation de Stylo a été créée avec le générateur de site statique [11ty](https://www.11ty.dev/)
diff --git a/docs/src/fr/faq/faq.json b/docs/src/fr/faq/faq.json
@@ -0,0 +1,17 @@
+{
+    "sectionTitle": "Foire aux questions",
+    "sectionUrl": "/fr/faq",
+    "disableSearch": false,
+    "searchIndexUrl": "/fr/search-index.json",
+    "menu": [
+      {
+        "label": "FAQ",
+        "children": [
+          {
+            "label": "Problèmes connus",
+            "url": "/fr/faq/problemes"
+          }
+        ]
+      }
+    ]
+}
diff --git a/docs/src/fr/faq/index.md b/docs/src/fr/faq/index.md
@@ -0,0 +1,5 @@
+---
+title: "Foire aux questions"
+---
+
+La foire aux questions
diff --git a/docs/src/fr/problemes.md → docs/src/fr/faq/problemes.md b/docs/src/fr/problemes.md → docs/src/fr/faq/problemes.md
diff --git a/docs/src/fr/corpus.md → docs/src/fr/fonctionnalites/corpus.md b/docs/src/fr/corpus.md → docs/src/fr/fonctionnalites/corpus.md
@@ -1,5 +1,5 @@
 ---
-title: Les corpus
+title: "Les corpus"
 ---
 
 La fonctionnalité **Corpus** permet de regrouper un ensemble d'articles Stylo sous un même label.

diff --git a/docs/src/fr/editeur-monaco.md → .../src/fr/fonctionnalites/editeur-monaco.md b/docs/src/fr/editeur-monaco.md → .../src/fr/fonctionnalites/editeur-monaco.md
@@ -1,5 +1,5 @@
 ---
-title: L'éditeur de texte Monaco
+title: "L'éditeur de texte Monaco"
 ---
 
 L'éditeur de texte, pièce centrale de Stylo, a été remplacé par l'éditeur de texte [Monaco](https://microsoft.github.io/monaco-editor/).

diff --git a/docs/src/fr/edition-collaborative.md → .../fonctionnalites/edition-collaborative.md b/docs/src/fr/edition-collaborative.md → .../fonctionnalites/edition-collaborative.md
@@ -1,5 +1,5 @@
 ---
-title: L'édition collaborative synchrone
+title: "L'édition collaborative synchrone"
 ---
 
 ## Les pré-requis pour l'écriture synchrone

diff --git a/docs/src/fr/espace-de-travail.md → ...c/fr/fonctionnalites/espace-de-travail.md b/docs/src/fr/espace-de-travail.md → ...c/fr/fonctionnalites/espace-de-travail.md
@@ -1,5 +1,5 @@
 ---
-title: Les espaces de travail
+title: "Les espaces de travail"
 ---
 
 ## Fonctionnement

diff --git a/docs/src/fr/exports.md → docs/src/fr/fonctionnalites/exports.md b/docs/src/fr/exports.md → docs/src/fr/fonctionnalites/exports.md
@@ -1,5 +1,5 @@
 ---
-title: Exports
+title: "Exports"
 ---
 
 ## Exporter un article

diff --git a/docs/src/fr/fonctionnalites/fonctionnalites.json b/docs/src/fr/fonctionnalites/fonctionnalites.json
@@ -0,0 +1,41 @@
+{
+    "sectionTitle": "Fonctionnalités",
+    "sectionUrl": "/fr/fonctionnalites",
+    "disableSearch": false,
+    "searchIndexUrl": "/fr/search-index.json",
+    "menu": [
+      {
+        "label": "Fonctionnalités",
+        "children": [
+          {
+            "label": "Corpus",
+            "url": "/fr/fonctionnalites/corpus"
+          },
+          {
+            "label": "Éditeur Monaco",
+            "url": "/fr/fonctionnalites/editeur-monaco"
+          },
+          {
+            "label": "Édition collaborative",
+            "url": "/fr/fonctionnalites/edition-collaborative"
+          },
+          {
+            "label": "Espace de travail",
+            "url": "/fr/fonctionnalites/espace-de-travail"
+          },
+          {
+            "label": "Exports",
+            "url": "/fr/fonctionnalites/exports"
+          },
+          {
+            "label": "Prévisualisation",
+            "url": "/fr/fonctionnalites/preview"
+          },
+          {
+            "label": "Versionner",
+            "url": "/fr/fonctionnalites/versionner"
+          }
+        ]
+      }
+    ]
+}
diff --git a/docs/src/fr/fonctionnalites/index.md b/docs/src/fr/fonctionnalites/index.md
@@ -0,0 +1,5 @@
+---
+title: "Les fonctionnalités de Stylo"
+---
+
+La documentation des fonctionnalités de Stylo
diff --git a/docs/src/fr/preview.md → docs/src/fr/fonctionnalites/preview.md b/docs/src/fr/preview.md → docs/src/fr/fonctionnalites/preview.md
@@ -1,5 +1,5 @@
 ---
-title: Prévisualiser et annoter un article
+title: "Prévisualiser et annoter un article"
 ---
 
 ## Prévisualisation

diff --git a/docs/src/fr/versionner.md → docs/src/fr/fonctionnalites/versionner.md b/docs/src/fr/versionner.md → docs/src/fr/fonctionnalites/versionner.md
@@ -1,5 +1,5 @@
 ---
-title: Versionner ses documents
+title: "Versionner ses documents"
 ---
 
 ## Introduction