Licence CC BY

[Chronique]Zest of Dev 6

le zmd nouveau est arrivé

Bonjour à tous !

La chronique de la semaine sera un peu différente de ce qu’on trouve à l’accoutumée car nous allons parler de la version 27 du site.

La v27 : ce qu'elle apporte

Cela fait un moment que je vous parle de la version 27 du site avec sa refonte de notre moteur markdown.

Durant la dernière semaine, nous avons travaillé pour vous proposer une version de test de notre code : la version 27 est donc déployée sur beta.zestedesavoir.com.

Le but de ce test est de permettre à un maximum de mon de chasser les bugs.

Pour simplifier les choses, si vous rencontrez un bug sur la béta, remontez-le dans les commentaires de ce billet et uniquement là. Je me chargerai ensuite de faire un ticket github qui rassemble toutes les informations.

Au sommaire de cette version :

  • une refonte du markdown pour le rendre plus facilement extensible
  • les pings (ils sont activés sur la béta !)
  • un gros travail de debug des notifications
  • le retour des epubs et des pdfs, mais cette fois-ci on a de quoi vous aider à debuger si la génération ne marche pas
  • la publication partielle
  • Le bloc neutre (nous n’avons pas encore mis en place le CSS de ce bloc)
  • Les titres sur les blocs (nous n’avons pas encore mis en place de CSS pour ça)

C’est quoi un bloc neutre?

C’est un bloc que l’on crée ainsi:

[[n|le titre du bloc]]
| le texte du bloc. 

[[neutre|le titre du bloc]]
| Le texte du bloc

Dans le cas le plus demandé par les matheux, ça donnerait :

[[n|Théorème]]
| Loi d'Ohm: $U = R \times I$.

Comment on utilise la publication partielle?

Créez un tutoriel moyen ou un big tuto. Allez dans une partie que vous pensez ne pas être prête à publier, puis cliquer sur "Marquer comme à ne pas publier".

Lorsque vous demanderez la validation — et que le validateur publiera — cette partie ne sera pas prise en compte. Plus précisément, le validateur verra un avertissement lui signalant que la partie est en rédaction et la version publiée ne contiendra même pas la partie.

Du dev et de l’ops, ça fait devops (buzzword incoming)

Comme nous le disions dans le récap communautaire, Avril a été un mois de pause pour le développement de zds. Pour autant nous continuons et notre bonhomme de chemin.

Pour faciliter et rendre plus rapide le déploiement du site ainsi que ses backup notre sysadmin, sandhose a créé un playbook ansible et a déjà déployé le béta avec ce dernier.

De plus comme zmarkdown est désormais un projet à part entière qui vit sa vie dans l’écosystème remark, nous avons eu droit à

  • Eskimon qui a créé un plugin pour lié zmd à pélican
  • plusieurs personnes de l’écosystème remark qui ont commencé à utiliser nos plugins et à faire des rapports de bugs que victor a corrigés à la vitesse de la lumière!

la v28: vers une priorisation par la communauté

Plusieurs développeurs ont annoncé leur motivation à nous aider à développer soit des nouvelles fonctionnalités pour zmarkdown soit à participer au développement de zds-site.

Cependant, afin de fournir un site qui correspond plus aux désires de la communauté, nous avons décidé de nous organiser légèrement différement par rapport à d’habitude.

Bien évidemment, la version 28 arrivera avec plusieurs bugfix (firm1 en a déjà proposé quelques uns qui sont pas mal) mais elle arrivera aussi avec deux fonctionnalités majeures que vous, la communauté devez choisir.

Pour cela, il suffit de répondre au sondage https://framadate.org/vZFxEqZ3FVGOBi4o.

Je donnerai les résultats dans deux semaines.


44 commentaires

Juste pour noter : les titres sont optionnels pour tous les blocs sauf le bloc neutre. Ce dernier a été mis en place à la demande des rédacteurs de contenus scientifiques qui veulent mettre en avant leurs théorèmes. Ils sont la première cible de cette fonctionnalité.

Petit problème niveau équation $\LaTeX$ :

Cette formule (aussi stupide soit-elle) :

1
\hat \theta_{MC} = \frac{\sum_{i = 1}^n P(Y_i | X = 1)}{\pi^3}

Devrait donné ça : $\hat \theta_{MC} = \frac{\sum_{i = 1}^n P(Y_i | X = 1)}{\pi^3}$

Et à la place j’obtient ceci : Lien de l’image

La formule est décalé très à droite.

Ouch… Il n’y a pas moyen de faire ça automatiquement pour la transition ? Parce que sinon, ça veut dire republier à la main chacun des 662 contenus de ZdS.

+3 -0

informaticienzero : il y a un bug en cours de correction sur la publication PDF.

entwanne : pour l’archive, je note, j’essaierai de voir ce qu’il se passe mais je pense que l’erreur qui cause le bug dans le PDF est la cause (une exception non attrapée).

informaticienzero : (franchement vivement le ping) je regarde pour le tuto de C, mais tu es peut être dans le cas d’eskimon. Il semblerait que nous ayions des soucis avec les tutos contenant des formules de math. Je t’en dis plus dès que je sais quoi.

Ouch… Il n’y a pas moyen de faire ça automatiquement pour la transition ? Parce que sinon, ça veut dire republier à la main chacun des 662 contenus de ZdS.

pour les pdf : si ça existe déjà c’est même grâce à ça que j’ai vu les erreurs.

+1 -0

le retour des epubs et des pdfs, mais cette fois-ci on a de quoi vous aider à debuger si la génération ne marche pas

On ne devrait pas laisser la possibilité à l’auteur de proposer sa propre version de epub ou de pdf ? Ou on souhaite garder une certaine harmonisation de epub/pdf ? Bien qu’on pourrait créer une norme ou un template de base.

Pour l’interface il suffirait d’ajouter deux inputs (champs de texte) et de vérifier s’ils sont remplis ou non.

@A-312 : C’est techniquement possible mais :

  1. Je doute que beaucoup d’auteurs prennent le temps de faire un PDF à partir du Markdown ou de l’HTML généré
  2. Il faudrait faire valider le PDF par un validateur pour son contenu
  3. Il faudrait s’assurer que le PDF ne contiennent pas de code malicieux contre le serveur ou les utilisateurs qui le téléchargent (on peut mettre pas mal de choses dans un PDF)
+5 -0

Salut tout le monde !

pour les tutoriels contenant des maths : dans l’ancienne version du markdown nous n’avions que de modes d’affichage/interprétation : math et inlineMath.

A votre demande, un troisième mode displayMath a été ajouté.

Cela génère des rupture de compatibilité, en effet, on ne peut plus mettre d’environnement style align dans un mode "math".

Pour info, voici les moyens d’écrire des math:

1
2
3
4
5
6
7
bonjour $\text{inline}$

une autre ligne $$\text{mode "math"}$$

$$
\text{mode inline Math. Vous noterez qu'il est important de mettre les dollars de fermeture à la ligne}
$$

Pas mal de tutoriels sont touchés par ça : si vous voulez mettre à jour votre tuto et qu’il soit republié, il faudra aussi repasser sur vos équations pour qu’elles soient bien affichées.

+0 -0

python zmarkdown n’est plus développé, en effet, il est trop complexe à maintenir et trop peu de personnes l’utilise.

On en avait déjà parlé dans une autre chronique d’ailleurs. Aujourd’hui c’est zmarkdown (donc la version js) qui est utilisée, développée et améliorée au fur et à me sure. Elle est vraiment plus facile d’utilisation.

A votre demande, un troisième mode displayMath a été ajouté.

Cela génère des rupture de compatibilité, en effet, on ne peut plus mettre d’environnement style align dans un mode "math".

Pour info, voici les moyens d’écrire des math:

1
2
3
4
5
6
7
bonjour $\text{inline}$

une autre ligne $$\text{mode "math"}$$

$$
\text{mode inline Math. Vous noterez qu'il est important de mettre les dollars de fermeture à la ligne}
$$
artragis

Les deux dernières façon de faire des maths déconnent totalement. Le mode "math" et le mode inline Math. :)

@A-312 : C’est techniquement possible mais :

  1. Je doute que beaucoup d’auteurs prennent le temps de faire un PDF à partir du Markdown ou de l’HTML généré
  2. Il faudrait faire valider le PDF par un validateur pour son contenu
  3. Il faudrait s’assurer que le PDF ne contiennent pas de code malicieux contre le serveur ou les utilisateurs qui le téléchargent (on peut mettre pas mal de choses dans un PDF)
Situphen

Ce qui me dérange, c’est que dans certain cas le saut de page est inopiné lors d’une génération automatique. Pourrait-on laisser la possibilité d’agir avec un markdown qui force le retour à la ligne saut de page ?

EDIT : Lapsus.

+0 -0

Les deux dernières façon de faire des maths déconnent totalement. Le mode "math" et le mode inline Math. :)

Le premier aussi. Sur l’un de mes tutos, les formules complexes inline ($||\vec{v}_i||$) sont cassées, avec le v qui s’envole.

+0 -0
Connectez-vous pour pouvoir poster un message.
Connexion

Pas encore membre ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte