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

Ajoute une numérotation visuelle aux titres #6361

Closed
wants to merge 4 commits into from

Conversation

artragis
Copy link
Member

Fix #6228

La PR ajoute une numérotation visuelle sur le site web comme sur le PDF :
hierarchy

Pour l'instant le seul cas aux limites ce sont les h3/h4 dans les introductions de tuto/parties et de ce fait dans les billets rédigés dans l'intro

Contrôle qualité

Builder le front et refresh le cache

Aller dans un big tuto, visiter un de ses chapitres
Aller dans un mini tuto
Aller dans un article
Aller dans un billet

A chaque fois lorsqu'on met des titres, on a des numérotations.

@Arnaud-D Arnaud-D added this to En attente de QA in Suivi des PR Jul 30, 2022
@coveralls
Copy link

coveralls commented Aug 13, 2022

Coverage Status

coverage: 88.413%. remained the same when pulling 2397597 on artragis:fix/numerotation_6228 into 7297871 on zestedesavoir:dev.

@Arnaud-D
Copy link
Contributor

Arnaud-D commented Aug 13, 2022

QA NOK ✖️

Sur les titres de section et parties, on a un soucis d'espacement.

image

Il est aussi présent là, mais c'est plus secondaire :

image

La numérotation est collée au texte et c'est pas propre.

L'espace est bien présent dans le code, mais il est bouffé au rendu quelque part... Ça semble lié au fait qu'il y a un lien sur le titre, donc la situation n'est pas la même que les titres dans le corps de texte du point de vue du :before.

Copy link
Contributor

@Arnaud-D Arnaud-D left a comment

Choose a reason for hiding this comment

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

Voir message précédent.

Suivi des PR automation moved this from En attente de QA to Modification demandée Aug 13, 2022
artragis and others added 4 commits September 13, 2023 12:28
- Inutile de répéter les sélecteurs, on fait du SCSS, on peut imbriquer.
- Correction du style de code d'après les règles editorconfig : indentation avec deux espaces.
- On ne s'appuie plus sur des espaces dans le contenu, mais sur une marge à la
  taille relative à la largeur d'une lettre de la police courante.
- Les compteurs sont réinitialisés en une ligne (plus clair, inutile de
  s’embêter).
- Les numérotations sont à peine plus claires.
- J'ai tenté aussi de retirer la graisse. Je ne sais que choisir.
@AmauryCarrade
Copy link
Member

AmauryCarrade commented Sep 13, 2023

On m'a dit qu'il y avait un souci de CSS.

J'ai regardé et c'était assez facile à régler : au lieu de se baser sur les espaces dans content, on met une marge (dont la taille est relative à la largeur des lettres de la police courante), et ça roule.

J'ai, au passage, mis à jour le code depuis la branche principale et refactorisé le CSS & SCSS aux bonnes pratiques (code imbriqué, propriétés non-dupliquées).

Essais de mise en valeur du texte des titres

J’ai tenté quelque chose pour que le numéro du titre ne soit pas au même niveau d'importance visuelle que le texte. J'ai, dans cette PR, diminué légèrement l'opacité des numéros. Mais j'avais aussi tenté de diminuer la graisse. Voici les deux rendus, à la suite, après le rendu de base. Qu'en pensez-vous ?

Titres de différents niveaux numérotés (1, 1.1, etc.). Les numéros des titres sont de la même couleur et graisse que le reste.
Version de base

Titres de différents niveaux numérotés (1, 1.1, etc.). Les numéros des titres sont de la même graisse mais un peu plus clairs que le reste.
Version opacité réduite

Titres de différents niveaux numérotés (1, 1.1, etc.). Les numéros des titres sont de la même couleur mais avec moins de graisse (plus fins) que le reste.
Version graisse réduite

Souhaitable partout ?

Je pose au passage la question. Veut-on numéroter ainsi tous les titres de tous les contenus ? Ne serais-ce pas un peu lourd pour rien, notamment sur des contenus souvent légers comme les billets, articles, ou mini-tutos ?

Ne serait-ce pas mieux de limiter cette numérotation aux moyens et gros contenus ?

⚠️ Note de QA supplémentaire

Ce code CSS ajoutant la numérotation est assez peu spécifique (au sens CSS du terme : il pourrait s'appliquer facilement à des titres hors des articles). J'ajoute donc aux instructions de contrôle qualité le point suivant (et un autre qui n'est pas lié mais qui est aussi important).

  • Vérifier ailleurs sur le site qu'aucun autres titre hors des contenus n'est numéroté par accident.
  • Sur le sommaire d'un gros tuto (première page), vérifier que la numérotation n'est pas dupliquée.

@AmauryCarrade AmauryCarrade removed their request for review September 13, 2023 11:12
@AmauryCarrade
Copy link
Member

Ça vient avec quelques soucis de rendu de titres sur les pages principales des sections de gros tutos, où faute de parents, les titres sont numérotés 0 (même si on est dans la partie 2, par exemple).

Sommaire d'une partie où les titres sont numérotés 0.1, 0.1.1, et 0.1.2.

Pour être honnête, j'ai un peu peur que cette fonctionnalité amène plus de problème subtils et un peu pénibles à résoudre proprement, comme ceci, qu'elle n'apporte de confort de repérage…

@AmauryCarrade
Copy link
Member

AmauryCarrade commented Sep 13, 2023

Autres soucis repérés

  • L'ancienne page À propos est numérotée (ceci devrait être corrigé avec la nouvelle page À propos)
    Les titres Droits, Système/backend et Front-end de la page À propos sont numérotés en 0.1, 0.2, et 0.3.
  • Les CGU sont doublement numérotées
    Les titres de chaque section des CGU sont numérotés en 0.1, 0.2, etc. En plus, les titres sont re-numérotés car ils le sont à la main dans le HTML.
  • Les pages sommaires de parties ou chapitres sont doublement numérotées (car ce sont des listes numérotées de base)
    Dans le sommaire d'un chapitre (ici), les pages du chapitres sont numérotées en 1.1, 2.1, 2.2 ET en 1, 2, etc. (la numérotation recommençant pour chaque chapitre). Les sections des pages ne sont pas concernées par ce problème et sont correctement numérotées une fois.

Je soupçonne que toutes les pages de /pages sont concernées de près ou de loin.

@Arnaud-D
Copy link
Contributor

Pour moi, c'est bloquant la numérotation à partir de zéro dans l'introduction des tutos (et dans la conclusion aussi ?). Il y a énormément de contenus avec de genre de choses et ça fait vraiment buggué d'avoir ce genre de numérotation.

@AmauryCarrade
Copy link
Member

Honnêtement, je trouve que tous les exemples de défauts que j'ai donné sont bloquants, pas que ceux des sommaires et conclusions (oui, en effet) de parties.

Ça risque d'être particulièrement tricky, avec le code actuel.

@Arnaud-D
Copy link
Contributor

@philippemilink J'ai l'impression que le consensus est que c'est piégeux. On ferme ?

@artragis
Copy link
Member Author

Allez, zou

@artragis artragis closed this Sep 29, 2023
Suivi des PR automation moved this from Modification demandée to Cimetière Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Cimetière
Suivi des PR
  
Cimetière
Development

Successfully merging this pull request may close these issues.

Numéroter automatiquement la titraille (sections, parties, H1, H2…) en HTML
4 participants