zestedesavoir / zds-site

Cœur du projet technique de Zeste de Savoir
https://zestedesavoir.com
Other
268 stars 161 forks source link

Identifier clairement l’introduction et la conclusion dans les contenus #6227

Open SpaceFox opened 2 years ago

SpaceFox commented 2 years ago

Description du besoin

Aujourd’hui, dans les versions HTML des contenus, les introduction et conclusions n’ont pas de titres dédiés (contrairement aux PDF par exemple).

C’est assez peu gênant pour l’introduction, mais plus pour la conclusion, qui n’est séparée du contenu que par une simple ligne peu visible. Un exemple de remontée du problème ici.

Description de la solution

Il suffirait de rajouter des titres « Introduction » et « Conclusion » au débuts de ces parties dans les templates d’affichage HTML.

Pour moi c’est simple à faire, il y a une seule exception à gérer : le cas des billets dont beaucoup sont intégralement rédigés dans l’introduction et/ou la conclusion ; dans ce cas on ne devrait pas afficher les titres car non pertinents.

Description des alternatives

Laissé vide intentionnellement

Contexte additionnel

Pas de contenu additionnel

SpaceFox commented 2 years ago

Il y a une subtilité : avec certains types de contenu – à priori ceux affichés sur une seule page – tout le contenu est dans le HTML déjà pré-rendu.

C’est par exemple le cas qui rentre dans cette condition : https://github.com/zestedesavoir/zds-site/blob/dev/templates/tutorialv2/view/content_online.html#L139

Il faut donc :

  1. Ajouter les <h3>Introduction</h3> et <h3>Conclusion</h3> dans ce HTML (on pourrait mettre l’introduction dans le template, mais pas la conclusion qui est déjà intégrée au HTML). Je ne sais pas où c’est fait.
  2. Vérifier que ça ne crée pas les balises en double dans les exports (ça impose d’avoir un environnement de dev avec LaTeX…)