Le contenu des normes présentes sur le site https://normes.transport.data.gouv.fr.
Chaque dossier correspond à une norme et contient un fichier index.md
ainsi qu'un dossier media
contenant les images présentes dans la page.
La mise en ligne de ces fichiers se fait via un site statique, généré par Hugo et dont le code est ici. Pour qu'un changement de contenu sur ce repo déclenche un redéploiement du site, une github action est utilisée, donc la tâche consiste à faire une requête POST pour déclencher le déploiement. Pour des raisons de sécurité, le token de l'url de déploiement est gardé secret dans les secrets du projet. Pour y accéder, il faut être admin sur le repo. Y accéder n'est utile que pour changer le token, si par hasard celui-ci devait être changé.
La rédaction de ces normes a eu lieu pendant plusieurs années sur des documents word, le suivi des modifications étant fait en utilisant l'outil du même nom sur Word. Ces documents Word étaient mis à disposition sur la page http://www.normes-donnees-tc.org/profils/. Afin de garder une tracabilité maximale sur le contenu des fichiers, le dossier originaux
contient les documents Word (.doc) qui ont servi à la conversion vers le format Markdown (.md) dorénant utilisé.
Ces étapes ont permis la conversion des fichiers .doc vers les .md correspondants. Il pourra être utile de s'y référer par la suite pour la conversion de nouveaux documents.
Fichier > Informations > Vérifier l'absence de problèmes > inspecter le document
Enregistrer sous
et convertir le document en .docx
/word/document.xml
<w:highlight w:val="lightGray"/>
par <w:shd w:fill="C0C0C0" w:val="clear"/>
LibreOffice présente l'avantage de pouvoir sélectionner un texte qui est surligné d'une certaine couleur.
Edit > Find and replace
(Ctrl + H)
.*
, Replace : <span class="hl">&</span>
Regular Expressions
c0c0c0
comme valeur Hex de couleur, cliquer sur OkReplace All
pandoc -t gfm --extract-media ./md/norme_xxx/ -o ./md/norme_xxx/index.md norme_xxx.docx
, ce qui aura pour conséquence de créer un dossier md/norme_xxx
contanant la conversion de norme_xxx.docx
en markdown et en images dans le dossier media.Avant propos
et Introduction
en gras (pas en H1, pour garder la numérotation inchangée)\<span
par <span
et les \</span
par </span
<
par <
et les >
par >
media
ne sont pas en JPEG ou en PNG, les convertir (en faisant une copie d'écran si on ne peut pas faire mieux)<img src="https://github.com/etalab/transport-profil-netex-fr/raw/main/md/arrets//media/image1.png" style="width:4.54583in;height:4.18264in" />
par ![image](media/image1.png)
et mettre la légende juste en dessous en italique (entourés de *) pour que la numérotation automatique des images se fasse.termes et définitions
: mettre en ordre les parties, supprimer la numérotation manuelle.<div class="table-title"> ... </div>
pour que celles-ci soient numérotées automatiquement.*
) des légendes des tablesgris
en jaune
dans le texte qui explique ce que signifie le texte surligné.<!-- -->
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>```
sont supprimés (regex).