903 mise a jour documentation #939

RochDLY · 2023-09-25T13:26:36Z

No description provided.

…ens absolus + pointer sur les bonnes images) + modification des nouvelles urls des pages dans les hyperliens

…json), ajout des documents pour les nouvelles fonctionnalités, début de l'écriture de la fonction corpus

… metadata, premierspas, versionner

…e fichier fr.json

…s espaces de travail + ajout des dernières publications en lien avec stylo

…, corpus, espaces de travail

netlify · 2023-09-25T13:26:40Z

✅ Deploy Preview for stylo-docs ready!

Name	Link
🔨 Latest commit	`f35a025`
🔍 Latest deploy log	https://app.netlify.com/sites/stylo-docs/deploys/651ee34b1736ad0008924d2d
😎 Deploy Preview	https://deploy-preview-939--stylo-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify · 2023-09-25T13:27:21Z

✅ Deploy Preview for stylo-dev ready!

Name	Link
🔨 Latest commit	`881f88f`
🔍 Latest deploy log	https://app.netlify.com/sites/stylo-dev/deploys/65118a8e3093340008db0bb6
😎 Deploy Preview	https://deploy-preview-939--stylo-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

… monaco, premiers pas, syntaxe bibtex, syntaxe yaml)

…entation

… et modification des alert-block dans l'index

…commencer avec, les contacts pour signaler les bugs passent de sources à contact.md, ajout d'un article dans les publications, aerer la page versionner.md

loup-brun · 2023-09-29T15:43:24Z

@RochDLY pour une section «nouvelles/changelog/...», il serait possible de créer une nouvelle section dans la documentation (un dossier dans docs/src/<section>), avec son fichier de métadonnées éponyme (docs/src/<section>/<section>.json). Il serait ainsi possible d'avoir une section avec une navigation cliquable (comme c'est actuellement le cas dans la barre supérieure: Stylo > Documentation > Titre de la page).

Je mentionne ça juste parce que je vois qu'il y a des premières tentatives d'«alertes» sur la page d'accueil! 😉

…json

…ection actualités, problème d'affichage à résoudre

…ncres sur les titres + reparation d'un lien mort dans les premierspas.md

…ontacts / premierspas / publications et sources.

…hortcode pour les images dans eleventy.js

…re de l'écran

loup-brun

Voir les commentaires ciblés. Je recommanderais de rapidement segmenter la PR et de faire une liste dans l'issue correspondante.

loup-brun · 2023-10-02T20:08:29Z

docs/src/_includes/styles/modern-normalize.css

+
+/* 
+Overlay images
+*/
+
+.overlay {
+  position: fixed;
+  z-index: 99;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  background: rgba(0,0,0,0.9);
+  display: flex;
+  align-items: center;
+  text-align: center;
+  visibility: hidden; /* reset on :target */
+  opacity: 0; /* reset on :target */
+  transition: opacity .3s;
+}
+
+.overlay img{
+  width: auto;
+  height: auto;
+  transform: scale(0.95);
+  transition: transform .3s;
+  max-height: 40vh;
+  object-fit: unset;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.overlay:target {
+  visibility: visible;
+  outline: none;
+  cursor: default;
+  opacity: 1;
+}
+
+.overlay:target img {
+    transform: scale(1.5);
+}


@RochDLY ces styles ne devraient pas figurer dans modern-normalize.css. La mission d'un « normalize » est de faire un « reset » – remettre des styles généraux à une base cohérente, pas d'ajouter des nouvelles fonctionnalités.

Ces styles devraient être déplacés dans une feuille CSS séparée, ex. image-overlay.css ou à tout le moins styles/global.css.
Mieux : La plupart des styles sont encapsulés dans des composantes. Il semble que les images cliquables soient tous encapsulés dans la prose. Ma recommandation serait donc de déplacer ces styles dans le bloc <style> du composant prose-block.webc (docs/src/_includes/components/prose-block.webc).

loup-brun · 2023-10-02T20:09:42Z

docs/src/en/about.md

@@ -54,8 +54,11 @@ The researchers participating in the project are as follows:
 - [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/en/Equipe/Roch-Delannay)
+- [Louis-Olivier Brassard]()


Mon URI personnel pourrait convenir, en attendant mon profil sur ÉcrituresNumériques.ca :

https://www.loupbrun.ca

loup-brun · 2023-10-02T20:15:41Z

docs/src/fr/actualites/actualites.json

+    "sectionTitle": "Actualités",
+    "sectionUrl": "/fr/actualites",
+    "disableSearch": false,
+    "searchIndexUrl": "/fr/search-index.json"


Attention : l'index de recherche est-il alimenté par des nouveaux contenus de la section actualités? (à tester)

loup-brun · 2023-10-02T20:16:39Z

docs/src/fr/actualites/actualites.json

+    "layout": "docs",
+    "useSideMenu": true,
+    "siteTitle": "Stylo",
+    "lang": "fr",
+    "description": "Stylo est un éditeur de texte simplifiant la rédaction et l'édition d'articles scientifiques en Sciences Humaines et Sociales.",
+    "rights": "Licence <a href=\"https://creativecommons.org/licenses/by-sa/4.0/\">Creative Commons [CC BY-SA 4.0]</a> – Chaire de recherche du Canada sur les écritures numériques",
+    "sectionTitle": "Actualités",


Attention : ces paramètres ne devraient pas être répétés dans les sections enfant, à moins d'être signifiants et surtout différents.

loup-brun · 2023-10-02T20:20:04Z

docs/src/fr/syntaxe-yaml.md

+
+```yaml
+auteur: "Bruce Wayne"
+


Attention aux lignes vides superflues dans les blocs de texte préformaté.

loup-brun · 2023-10-02T21:41:49Z

docs/.eleventy.js

+const pluginTOC = require('eleventy-plugin-toc');
+const markdownIt = require('markdown-it');
+const markdownItAnchor = require('markdown-it-anchor');
+
+// des options pour le rendu avec markdown-it
+const mdOptions = {
+  html: true,
+  breaks: false,
+  linkify: true,
+  typographer: true
+}
+
+// constante pour les ancres dans les titres
+const mdAnchorOpts = {
+  permalink: true,
+  permalinkClass: 'anchor-link',
+  permalinkSymbol: '#',
+  level: [1, 2, 3, 4]
+};

 module.exports = function(eleventyConfig) {

+  //Markdown : ajout des ancres sur les titres et la classe 'anchor-link'
+  eleventyConfig.setLibrary(
+    'md',
+    markdownIt(mdOptions)
+      .use(markdownItAnchor, mdAnchorOpts)
+  )


Petite remarque sur l’étendue (scope-creep) de cette PR : cette mise à jour de la documentation ratisse très large au point qu’une révision devient difficile (la révision du contenu modifié partout) et multifacette (contenu ainsi que structure de programmation).

Ici, l'ajout de paquets modifie potentiellement le rendu du contenu HTML et ajoute des dépendances supplémentaires (à considérer avec soin).

Je recommanderais de différer l'ajout d'éléments structurels de changements au contenu de la documentation (autrement dit: modifications markdown d'une part; modifications 11ty d'autre part).

L'ajout de # (ancres aux en-têtes) induit des considérations visuelles (design visuel plus chargé et à ajuster).
Cela pourrait facilement faire l'objet d'une PR séparée.

….webc

…-yaml.md

…ui ne sont plus utilisées, il en reste encore ..., ajout d'un nouveau gif

…nséquences dans les documents

…e image du gestionnaire d'articles

…ibliographie.md

loup-brun

:(

loup-brun · 2023-10-05T17:47:24Z

docs/src/_includes/layouts/docs.webc

+
+  .toc {
+    position: fixed;
+  }
+
+  .toc ul {
+    list-style: none;
+  }
+
+  .toc a:link, a:visited {
+    text-decoration: none;
+    color: var(--couleur-police);
+  }
+
+  .toc ul > li > a:hover, a:active {
+    color: var(--couleur-lien, inherit);
+  }


Ces styles devraient figurer dans le composant toc (lequel devrait d'ailleurs, d'après la convention des web components, comporter un trait d'union pour éviter les conflits futurs avec des éléments HTML).

loup-brun · 2023-10-05T17:49:15Z

docs/src/_includes/layouts/docs.webc

@@ -171,10 +171,13 @@
        </div>

        <div class="docs-layout__center-wrapper | grid-area--page-sidebar">
-          <nav class="docs-layout__center-sidebar">
+          <div class="docs-layout__center-sidebar">


Cela peut rester un nav sémantique et être assigné à un composant avec les bons attributs (webc:is="nom-du-composant")

RochDLY added 12 commits September 15, 2023 04:25

correction des liens des images (transformer les liens relatifs en li…

88d7a82

…ens absolus + pointer sur les bonnes images) + modification des nouvelles urls des pages dans les hyperliens

restructuration de la documentation (voir les modifs dans le menu fr.…

4a85e89

…json), ajout des documents pour les nouvelles fonctionnalités, début de l'écriture de la fonction corpus

modification et ajout dans la doc pages corpus, exports, mesarticles,…

c8aee05

… metadata, premierspas, versionner

debut de la fiche sur la syntaxe yaml

552ae9d

mise à jour de la page d'index de la documentation

bf12df2

quelques ajouts dans la fiche sur la syntaxe yaml

159ef7f

ajout de quelques informations dans la fiche bibliographie.md

db28728

ajout de la fiche sur l'éditeur monaco et modification du menu dans l…

16dacbe

…e fichier fr.json

ajout des informations pour la syntaxe BibTeX

296834b

ajout dans la fiche sur l'édition collaborative synchrone

071414d

ajout des informations sur l'API GraphQl, l'édition collaborative, le…

9f7cae8

…s espaces de travail + ajout des dernières publications en lien avec stylo

modification des images dans la documentation : edition collaborative…

881f88f

…, corpus, espaces de travail

RochDLY added 6 commits September 25, 2023 16:21

premieres corrections de la doc après déploiement en preprod (editeur…

7dc62b2

… monaco, premiers pas, syntaxe bibtex, syntaxe yaml)

Changement du titre de la fiche syntaxe Markdown

4f59a24

changement du label syntaxe markdown dans le menu fr.json de la docum…

8703b73

…entation

modification du menu de la doc-en, Langue -> Language

e482cdd

documentation : correction des coquilles dans la page de syntaxe yaml…

452a491

… et modification des alert-block dans l'index

corrections dans la documentation : les premiers pas deviennent pour …

ee7b207

…commencer avec, les contacts pour signaler les bugs passent de sources à contact.md, ajout d'un article dans les publications, aerer la page versionner.md

RochDLY added 9 commits September 29, 2023 18:07

documentation : test d'ajout de la section actualités dans la doc

e5811db

documentation : ajout de la page actualités dans le menu fr

d56dec6

documentation : correction de l'erreur de syntaxe dans le fichier fr.…

3c6ef13

…json

documentation : ajout de l'index dans les actualités

9f3ec7d

documentation : modification du json et de l'index pour la nouvelle s…

65000a8

…ection actualités, problème d'affichage à résoudre

documentation : mise à jour du logo de la chaire

81bcf0f

ajout des plugins et modification de la config 11ty pour mettre les a…

3057871

…ncres sur les titres + reparation d'un lien mort dans les premierspas.md

fix #946 et ajout des shortcodes pour les link-button et les alert-block

d9af19d

documentation : intégration des corrections ortho typo dans about / c…

e697470

…ontacts / premierspas / publications et sources.

RochDLY added 2 commits October 1, 2023 22:12

documentation : ajout de GIFs dans la documentation fr + ajout d'un s…

ff0c506

…hortcode pour les images dans eleventy.js

documentation : mise à jour du css pour afficher .overlay img au cent…

06e57ef

…re de l'écran

loup-brun suggested changes Oct 2, 2023

View reviewed changes

RochDLY added 11 commits October 3, 2023 00:23

déplacement du css pour img overlay dans le web component prose-block…

3ee65c6

….webc

documentation : correction du fichier actualites.json

bd61a12

documentation : corrections des lignes vides dans le document syntaxe…

7042c79

…-yaml.md

documentation : ajout de nouvelles images (et suppression de celles q…

8fd5432

…ui ne sont plus utilisées, il en reste encore ..., ajout d'un nouveau gif

documentation : suppression des images en trop et modifications en co…

f1ba91c

…nséquences dans les documents

ajout du toc

9254c88

documentation: modification du fonctionnement du toc

63e12f7

documentation : ajout des gifs pour la fonction de comparaison + 1 un…

12ec861

…e image du gestionnaire d'articles

documentation: mise à jour de la version anglaise de la doc

2e927c9

documentation : corrections du contenu fr de la doc

90b83fa

documentation : mise à jour de l'index fr/en et correction coquille b…

f35a025

…ibliographie.md

RochDLY merged commit 30b8583 into master Oct 5, 2023
3 checks passed

RochDLY had a problem deploying to github-pages October 5, 2023 16:45 — with GitHub Actions Failure

RochDLY deleted the 903-mise-a-jour-documentation branch October 5, 2023 16:49

loup-brun reviewed Oct 5, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

903 mise a jour documentation #939

903 mise a jour documentation #939

RochDLY commented Sep 25, 2023

netlify bot commented Sep 25, 2023 •

edited

Loading

netlify bot commented Sep 25, 2023

loup-brun commented Sep 29, 2023 •

edited

Loading

loup-brun left a comment

loup-brun Oct 2, 2023

loup-brun Oct 2, 2023

loup-brun Oct 2, 2023

loup-brun Oct 2, 2023

loup-brun Oct 2, 2023

loup-brun Oct 2, 2023

loup-brun left a comment

loup-brun Oct 5, 2023

loup-brun Oct 5, 2023


		```yaml
		auteur: "Bruce Wayne"

903 mise a jour documentation #939

903 mise a jour documentation #939

Conversation

RochDLY commented Sep 25, 2023

netlify bot commented Sep 25, 2023 • edited Loading

✅ Deploy Preview for stylo-docs ready!

netlify bot commented Sep 25, 2023

✅ Deploy Preview for stylo-dev ready!

loup-brun commented Sep 29, 2023 • edited Loading

loup-brun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

loup-brun left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Sep 25, 2023 •

edited

Loading

loup-brun commented Sep 29, 2023 •

edited

Loading