ILS wiki

Multilinguisme

Normalement, l'aide est affichée dans la langue du navigateur ou la langue choisie dans le menu. Il suffit donc de changer la langue pour avoir la même page dans une autre langue.

Si la page n'existe pas dans la langue choisie, il faut donc la créer (voir comment crééer la page dans une autre langue).

Édition d'une page

La page existe déjà

• Se rendre sur la page.
• Cliquer sur Edit.

La page n'existe pas encore (création d'une page)

Depuis une page existante, faire un lien vers la page que l'on veut créer. C'est la bonne méthode, puisque cela assure qu'il est possible d'atteindre cette page sans passer par la recherche.

Après avoir suivi le lien, il faut créer la page avec le bouton Edit, puis sélectionner dans quelle langue on veut créer cette page, avec le bouton Éditer en tout au fond de la page.

Édition/création d'une page dans une autre langue

Lorsqu'une page n'existe pas dans la langue désirée, mais qu'elle existe dans une autre langue, il est possible de l'éditer dans cette langue, ce qui revient à la créer.

• Depuis la page existante, cliquer sur Edit.
• Tout au fond de la page, il y a un bouton Éditer en, avec un sélecteur qui permet de choisir la langue.
• Ne pas oublier de sélectionner la langue lors de la création d'une nouvelle page

⚠️ lorsqu'une page est crée ainsi, le risque existe qu'elle ne soit référencée nulle part et qu'il ne soit pas possible de l'atteindre facilement. Il est donc préférable d'utiliser la méthode qui consiste à créer un lien depuis une autre page.

Syntaxe Markdown

On trouve une aide détaillée sur le site de CommonMark

Dans la mesure du possible, essayez de ne pas compliquer la structure et la mise en forme au-delà de :

• italique
• gras
• les niveaux de titres (#, ##, ###, etc.)
• les listes et les listes numérotées
• les liens
• les insertions d'images

Les liens

Liens externes

Pour insérer un lien, la syntaxe habituelle est la suivante :

[commonmark](https://commonmark.org)

Entre crochets se trouve le texte du lien et entre parenthèses, la cible.

Il est possible d'ajouter un texte qui apparaîtra au survol du lien :

[commonmark](https://commonmark.org "Le site de la norme markdown")

Il y a une variante pour les liens consistant à détacher la cible du texte du lien, ce qui a l'avantage d'améliorer la lisibilité du texte « source » (par opposition au rendu html) :

[commonmark][1]
…
[1]: https://commonmark.org "Le site de la norme markdown"

La cible peut être placée n'importe où dans le fichier, soit à la fin de la section, ou à la fin du document. L'important est de s'assurer que les références sont cohérentes.

Liens internes à l'aide

Pour faire écrire un lien vers une autre page de l'aide, il faut spécifier la cible selon le mode suivant :

• /help va pointer vers l'accueil de l'aide.
• /help/home également.
• help/home/<nom-de-la-page> va pointer vers cette page.

Autrement dit, la plupart du temps /help/home/ est un préfixe nécessaire. Les URL sont établis indépendemment de la langue. L'utilisateur est redirigé vers la bonne page selon la langue de l'interface.

Liens internes à la page

Au sein d'une page, chaque section (niveau de titre) peut être pointé directement par un lien. Par exemple, il est possible d'écrire un lien vers la section Connexion de cette page :

[texte du lien][1]
…
[1]: #connexion

Lorsque le titre de la section est un peu plus complexe, il faut remplacer les espaces par des tirets. Tous les accents et les ponctuations doivent être simplement retirées :

[texte du lien][1]
…
[1]: #liens-internes-a-l-aide

Il est possible de se donner une idée du lien exact en observant la table des matières en haut à droite (une fois que le fichier est enregistré).

Enfin, il est bien sûr possible de combiner les différents types de liens pour pointer vers une section particulière d'une page précise de l'aide :

[texte du lien][1]
…
[1]: /help/home/autre-page#liens-vers-section

Insérer une image

Pour l'insertion d'une image, le mieux est de suivre les étapes suivantes :

1. Depuis la page que vous este en train d'éditer, faites un clic-droit sur l'onglet Files en haut à gauche, dans la barre d'outil de l'aide, et sélectionner ouvrir dans un nouvel onglet.
2. Dans ce nouvel onglet s'est ouvert le gestionnaire de fichier, très minimal. Au moyen du bouton télécharger un fichier vous pouvez ouvrir un navigateur de fichier sur votre ordinateur et sélectionner l'image que vous voulez ajouter.
3. Une fois l'image ajoutée, elle s'affiche avec une prévisualisation, le nom du fichier et un outil pour copier le lien vers l'image.
4. Cliquez sur l'icône à droite du nom de fichier, ce qui copie les éléments d'une insertion d'image avec la syntaxe Markdown.
5. Allez dans la page que vous éditez, et coller ce que vous venez de copier.
6. Modifier la partie entre crochet, qui est affichée comme légende.
7. Modifier la partie entre guillemets, qui est ce qui est affiché au survol de l'image avec le curseur.

La syntaxe est la suivante :

![légende](/help/files/<nom-fichier>.<extension> "attribut title")

Le point d'exclamation initial indique que le lien se fait vers un fichier.

Les notes en bas de page

Il peut arriver qu'on en ait besoin, quoi que très rarement. La syntaxe est très proche du lien :

Voici un texte avec une note[^1].
…
[^1]: Et voici le texte de la note.

Comme pour les liens avec des références, le contenu de la note peut être placé n'importe où, au fond de la section ou au fond du document.

Tableau

Il est possible de faire des tableau en Mardown, et c'est supporté par le wiki de l'aide. Toutefois, c'est souvent assez pénible de le faire, aussi le conseil est de les éviter. Un exemple tout de même :

| No  | Titre                     | Localisation |
| --- | :----------               | :----------: |
| 1   | L'histoire sans fin       | Libre accès  |
| 2   | Voyage au bout de la nuit | Compactus    |
| 3   | Les fleurs du mal         | Enfer        |

No	Titre	Localisation
1	L'histoire sans fin	Libre accès
2	Voyage au bout de la nuit	Compactus
3	Les fleurs du mal	Enfer

Le mieux est d'utiliser un générateur de tableau.