-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MàJ du readme et archivage du contenu de l'ancien (#135)
- Loading branch information
Showing
1 changed file
with
12 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,20 @@ | ||
| # Normes pour les données d'offres de transport | ||
| Le contenu des normes présentes sur le site https://normes.transport.data.gouv.fr. | ||
| # Profil France de NeTEx | ||
|
|
||
| ## Structure | ||
| Chaque dossier correspond à une norme et contient un fichier `index.md` ainsi qu'un dossier `media` contenant les images présentes dans la page. | ||
| Ce répertoire regroupe l'ensemble des éléments du profil France de NeTEx tel que publié sur le site : https://normes.transport.data.gouv.fr. | ||
|
|
||
| ## Déploiement | ||
| La mise en ligne de ces fichiers se fait via un site statique, généré par [Hugo](https://gohugo.io/) et dont le code est [ici](https://github.com/etalab/transport-normes-site). Pour qu'un changement de contenu sur ce repo déclenche un redéploiement du site, une [github action](https://github.com/etalab/transport-normes/blob/main/.github/workflows/github-actions.yml) 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](https://github.com/etalab/transport-normes/settings/secrets/actions) 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é. | ||
| # Structure | ||
|
|
||
| ## Historique | ||
| 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é. | ||
| Ce répertoire est composé : | ||
| - d'un dossier `NeTEx` qui comprend le profil France avec un sous-dossier pour chaque partie du profil ; chaque partie comprend le texte en Markdown et un dossier pour les illustrations | ||
| - d'un dossier `originaux` qui comprend l'ensemble des parties du profil France de NeEtex, tels que publiés par le GT7 après approbation du CN03. | ||
|
|
||
| ## Conversion .doc -> .md | ||
| 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. | ||
| # Gouvernance | ||
|
|
||
| ### Sur Word | ||
| * Ouvrir le fichier .doc à convertir | ||
| * Faire `Fichier > Informations > Vérifier l'absence de problèmes > inspecter le document` | ||
| * Supprimer les commentaires, les révisions, les versions, **le texte masqué** | ||
| * Faire `Enregistrer sous` et convertir le document en `.docx` | ||
| * Supprimer manuellement le sommaire (qui est régénéra par le générateur de site) | ||
| * fermer le fichier sur Word | ||
| Le contenu de ce répertoire est le fruit du travail de normalisation au sein du GT7 (groupe de travail dédié à l'information voyageur et l'exploitation des services de mobilité). Ce groupe de travail s'insère dans les travaux de la CN03 (Commission nationale pour les transports publics) au sein du BNTRA (Bureau de normalisation pour les transports, les routes et leurs aménagements). | ||
| Toute personne peut poser des questions, faire des demandes de changement du profil France de NeTEx en utilisant les `Issues` de ce répetoire. Si les discussions peuvent avoir lieu directement ici, les décisions finales seront prises par les membres du GT7 lors des plénières. Ces décisions sont, ensuite, avalisées formellement par la CN03 lors de ses plénières. | ||
|
|
||
| ## Modifier le .zip | ||
| * renommer le .docx en .zip | ||
| * ouvrir l'archive | ||
| * ouvir le fichier `/word/document.xml` | ||
| * remplacer toutes les occurences de `<w:highlight w:val="lightGray"/>` par `<w:shd w:fill="C0C0C0" w:val="clear"/>` | ||
| * Sauvegarder le fichier et mettre à jour l'archive zip avec. | ||
| L'équipe du Point d'Accès National aux données de transport (transport.data.gouv.fr) soutient le maintien technique de ce répertoire. Elle n'est pas responsable du contenu. | ||
|
|
||
| ### LibreOffice prend le relais | ||
| LibreOffice présente l'avantage de pouvoir sélectionner un texte qui est surligné d'une certaine couleur. | ||
| * Faire `Edit > Find and replace` (Ctrl + H) | ||
| * Mettre dans find : `.*`, Replace : `<span class="hl">&</span>` | ||
| * Cocher la case `Regular Expressions` | ||
| * Faire Format... > Highlighting > Color > et mettre `c0c0c0` comme valeur Hex de couleur, cliquer sur Ok | ||
| * Cliquer sur `Replace All` | ||
| # Contributions | ||
|
|
||
| ### Conversion avec Pandoc | ||
| * installer [Pandoc](https://pandoc.org/installing.html) | ||
| * Dans un terminal, entrer `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. | ||
|
|
||
| ### Edition du markdown | ||
| - Ajouter un en tête au fichier index.md, en prenant modèle sur les autres normes. | ||
| - Dans le texte, passer `Avant propos` et `Introduction` en gras (pas en H1, pour garder la numérotation inchangée) | ||
| - Remplacer les `\<span` par `<span` et les `\</span` par `</span` | ||
| - Remplacer les `<` par `<` et les `>` par `>` | ||
| - Si certaines images du dossier `media` ne sont pas en JPEG ou en PNG, les convertir (en faisant une copie d'écran si on ne peut pas faire mieux) | ||
| - Remplacer les balises du style `<img src="./md/arrets//media/image1.png" style="width:4.54583in;height:4.18264in" />` par `` et mettre la légende juste en dessous en italique (entourés de \*) pour que la numérotation automatique des images se fasse. | ||
| - Partie `termes et définitions` : mettre en ordre les parties, supprimer la numérotation manuelle. | ||
| - Supprimer les numérotations manuelles des tables, et entourer les légendes des tables de `<div class="table-title"> ... </div>` pour que celles-ci soient numérotées automatiquement. | ||
| - supprimer les mises en italiques (les `*`) des légendes des tables | ||
| - changer `gris` en `jaune` dans le texte qui explique ce que signifie le texte surligné. | ||
| - supprimer tous les `<!-- -->` | ||
| - supprimer les lignes vides des tableaux dus au texte masqué : les | ||
| ```<tr class="(.*)"> | ||
| <td></td> | ||
| <td></td> | ||
| <td></td> | ||
| <td></td> | ||
| <td></td> | ||
| </tr>``` | ||
| sont supprimés (regex). | ||
| Toute personne souhaitant contribuer aux travaux peut se rapprocher de l'animatrice du GT7 (@TuThoThai). |