Skip to main content

Rédiger les textes Formations/Règlements

Nous rejoindre sur Discord : lien discord

Objet : EcrireÉcrire son texte en markdown.Markdown.

Nous avons amélioréamélioré la rérédaction des rèrèglements préprésents sur les sites principaux (/reglements) et la rérédaction des livrets de formation préprésents sur les intranets (/formation). La rérédaction de ces textes devait se faire en html et dans le fichier Twig directement. DansDepuis la version 2.2.0.0, la rérédaction des textes se fera àà l'intéintérieur de fichiers Markdown.

Le Markdown est un langage de balisage léléger créécréé en 2004 par John Gruber avec l'aide d'Aaron Swartz. Il a étéété créécréé dans le but d'offrir une syntaxe facile àà lire et àà éécrire. (WikipéWikipédia)

Voici un lien pour savoir comment éécrire en markdownMarkdown : https://guides.github.com/features/mastering-markdown/

Voici les élééléments pris en compte dans la rérédaction des textes :

  • Titre 1 : #Titre 1 => Anciennement : (<h1>Titre 1</h1>)
  • Titre 2 : ##Titre 2 => Anciennement : (<h2>Titre 2</h2>)
  • Titre 3 : ###Titre 3 => Anciennement : (<h3>Titre 3</h3>)
  • Image : ![decription](img) => Anciennement : (<img src="url" alt="description"/>)
  • Lien : [text affichéaffiché](lien) => Anciennement : (<a href="lien">text affichéaffiché</a>)

Explication de la structure des fichiers

Chaque site va posséposséder un nouveau rérépertoire nomménommé content dans ce rérépertoire, il y aura les fichiers markdownMarkdown (*.md) contenant les textes. Chaque rérépertoire possèpossèdera éégalement un fichier index.json permettant de gégérer les fichiers markdowns.Markdown.

index.js pour les sites vitrines

Voici uneun exemple de fichier jsonJSON pour les sites vitrines :

{
  "navigation": [
    {
      "nom": "Introduction",
      "identifiant": "introduction"
    },
    {
      "nom": "Equipement",
      "identifiant": "equipement"
    },
    	etc...
    {
      "nom": "Organisation",
      "identifiant": "organisation"
    }
  ],
  "contenu": [
    {
      "identifiant": "introduction",
      "fichier": "introduction.md"
    },
    {
      "identifiant": "equipement",
      "fichier": "equipement.md"
    },
    	etc...
    {
      "identifiant": "organisation",
      "fichier": "organisation.md"
    }
  ]
}

Navigation

Le champ navigation permet de mettre en forme l'onglet de navigation qui apparaîapparaît sur les sites dans la page des rèrèglements. Ce champ se comporte comme un tableau, c'est à est-à-dire que le premier éléélément préprésent dans le tableau sera le premier éléélément préprésent dans le menu de navigation. Voici comment dédéfinir un lien dans la barre de navigation :

Vous devez ajouter la structure suivante dans la section navigation. Le champ nom repréreprésente le nom qui sera affichéaffiché dans la barre de navigation. La cléclé identifiant est un indicatif permettant de lier un titre àà un texte. Il est trètrès important que l'identifiant préprésent dans la partie navigation ait une correspondance dans la partie contenue (nous verrons çça plus tard).

ÀÀ la fin de chaque Structure {}, il faut ajouterajoutez une , sauf pour le dernier éléélément de la liste

{
 "nom": "Nom qui apparait dans le menu",
 "identifiant": "identifiant rattachérattaché au fichier markdown"
}

Contenu

Le champ contenu regroupe tous les fichiers markdownMarkdown qui seront utiliséutilisés pour la rérédaction de la page. Chaque fichier contient un chapitre ou partie de la page. Comme pour la navigation, le premier éléélément préprésent dans le tableau contenu sera le premier élementélément affichéaffiché dans la page. Voici comment crécréer un chapitre dans la page.

Tout d'abord, vous devez rérédiger le chapitre dans un fichier au format markdown,Markdown, exemple :

#Loi Miranda
*“<<Vous avez le droit de garder le silence, si vous renoncez àà ce droit, tout ce que vous direz pourra et sera retenu contre vous. Vous avez le droit àà un avocat. Toutes vos communications vous ont étéété coupécoupées, vous avez éégalement le droit àà des soins, àà boire et àà manger.”>>*

*Avez-vous bien compris vos droits ?*

**Pour les rèrègles logiques non évoquéévoquées veuillez faire preuve de bon sens.**

Une fois que vous avez rédigérédigé le chapitre, il suffit de renseigner le nom du fichier ainsi que l'identifiant auquel il est attribuéattribué (dédéfini dans la section navigation). Vous devez ajouter la structure suivante dans la section contenu.

  • La cléclé identifiant est l'identifiant dédéfini dans la partie navigation.
  • La cléclé fichier dédéfinit le nom du fichier préprésent dans le rérépertoire content.
  • La cléclé type permet d'appliquer une mise en page spéspécifique.

Si vous utilisez la mêmême rérédaction de votre loi Miranda que la notrenôtre cela peut êêtre utile, dans le cas contraire, garder le type en normal.

ÀÀ la fin de chaque Structure {}, il faut ajouterajoutez une , sauf pour le dernier éléélément de la liste

{
  "identifiant": "miranda",
  "fichier": "miranda.md",
  "type": "miranda" // Le format miranda est spéspécifique au miranda par dédéfaut utiliséutilisé le type : normal
}

index.js pour les intranets

La structure et le fonctionnement du fichier index.json pour les intranets COP et SECOURS est identique àà celui des sites vitrines. CependantCependant, pour les intranets, il n'y a pas de champ type pour les structures de la section contenu.

{
  "navigation": [
    {
      "nom": "Introduction",
      "identifiant": "introduction"
    },
    	etc...
    {
      "nom": "NéNégociation",
      "identifiant": "negociation"
    }
  ],
  "contenu": [
    {
      "identifiant": "introduction",
      "fichier": "introduction.md"
    },
    	etc...
    {
      "identifiant": "negociation",
      "fichier": "negociation.md"
    }
  ]
}

La rédaction de cette page de présentation n'est pas terminée. Si vous rencontrer des difficultés dans la rédaction n'hésitez pas à nous contacter afin que l'on puisse vous aider. Vous pouvez également vous inspirer des documents présents dans les fichiers de bases.

Back to top