| ... | ... | @@ -2,55 +2,61 @@ |
|
|
|
|
|
|
|
N'hésitez surtout pas à faire remonter vos remarques et même proposer des pages.
|
|
|
|
|
|
|
|
|
|
|
|
Quelques infos sur le **format markdown** et sur la **gestion des images insérées**. On verra que le wiki est lui-même un dépôt gitlab ; un indice est l'indication d'un 'commit' quand on enregistre les modifs. Utiliser cette propriété doit faciliter le travail à plusieurs (pour éviter d'intervenir en même temps...) et la gestion des images.
|
|
|
|
|
|
|
|
## 1. Le format markdown et les deux éditeurs disponibles sur le gitlab
|
|
|
|
|
|
|
|
Markown est un langage à balises, très classique. Vous trouverez facilement des infos sur la syntaxe, sachant que la version 'gitlab' offre moins de possibilités que les versions plus récentes.
|
|
|
|
Dans la version de février 2022, vous avez le choix entre 2 éditeurs, le "standard" au format texte brut, et une version "rich text" qui vous permet de voir la mise en forme même pendant l'édition, et offre quelques facilités supplémentaires.
|
|
|
|
Markown est un langage à balises, très classique. Vous trouverez facilement des infos sur la syntaxe, sachant que la version 'gitlab' offre moins de possibilités que les versions plus récentes. Pour éditer une page, si vous avez les droits vous verrez une icône "crayon" en haut à droite, pour passer **en mode édition**. Dans la version de février 2022, vous avez le choix entre 2 éditeurs, le "standard" au format texte brut, et une version "rich text" qui vous permet de voir la mise en forme même pendant l'édition, et offre quelques facilités supplémentaires.
|
|
|
|
|
|
|
|
### Editeur "standard" du gitlab
|
|
|
|
L'éditeur qui s"ouvre quand vous demandez à modifier un texte vous montre le code "brut", avec les balises.
|
|
|
|
Vous voyez que pour **mettre en gras** il faut écrire `**mettre en gras**`
|
|
|
|
En haut de la fenêtre d'édition vous verrez des icônes pour vous aider à écrire en gras, en italique, insérer du code, des numéros...
|
|
|
|
La fonction "add a collapsible section" est pratique pour intégrer des infos complémentaires sans alourdir le texte.
|
|
|
|
<details><summary>cliquez pour voir le paragraphe supplémentaire</summary>
|
|
|
|
ici vous mettez un exemple, des explications, des références ou un "spoiler".
|
|
|
|
Par contre, on ne peut pas vraiment mettre en forme ce texte.
|
|
|
|
</details>
|
|
|
|
Plus "technique" :
|
|
|
|
|
|
|
|
###les tableaux
|
|
|
|
les cellules sont définies par des séparateurs "pipe" (|), cela n'est pas toujours facile à lire
|
|
|
|
###les images
|
|
|
|
:cactus: Soyons francs, j'ai attendu la version de l'éditeur 'rich text' pour réussir à ajouter des images. J'ai vraiment eu du mal à comprendre les posts qui me parlaient d'un répertoire "upload" que je ne voyais nulle part, alors que dans le Readme.md du dépôt on crée un répertoire illustrations (par exemple) auquel on a accès et on fait référence explicitement... Finalement, le malentendu vient du fait que la nature du wiki est... un dépôt git, qu'il faut récupérer ("pull" ) pour pouvoir travailler dessus... Voir la partie correspondante.
|
|
|
|
L'éditeur qui s"ouvre quand vous demandez à modifier un texte vous montre le code "brut", avec les balises. Vous voyez que pour **mettre en gras** il faut écrire `**mettre en gras**` En haut de la fenêtre d'édition vous verrez des icônes pour vous aider à écrire en gras, en italique, insérer du code, des numéros... La fonction "add a collapsible section" est pratique pour intégrer des infos complémentaires sans alourdir le texte.
|
|
|
|
|
|
|
|
<details>
|
|
|
|
<summary>cliquez pour voir le paragraphe supplémentaire</summary>
|
|
|
|
ici vous mettez un exemple, des explications, des références ou un "spoiler". Par contre, on ne peut pas vraiment mettre en forme ce texte.
|
|
|
|
</details>Dès que vous tapez ":" suivis d'une lettre l'éditeur vous propose des icônes (et c'est parfois envahissant quand on ne veut pas insérer de petits dessins....). Si on sélectionne un petit nombre d'icônes associés clairement chacune à une signification, cela peut être une aide à la lecture.
|
|
|
|
|
|
|
|
Par exemple : :cactus: pour un point épineux ! :books: pour des références
|
|
|
|
|
|
|
|
#### Fonctions plus "techniques" : tableaux et insertion d'images
|
|
|
|
|
|
|
|
#### les tableaux
|
|
|
|
|
|
|
|
### Editeur "rich text" du gitlab : une solution et quelques problèmes
|
|
|
|
les cellules sont définies par des séparateurs "pipe" (|), cela n'est pas toujours facile à lire
|
|
|
|
|
|
|
|
Un éditeur plus performant est apparu fin 2021, et une bascule est maintenant proposé par le texte cliquable "Edit rich text".
|
|
|
|
Il facilite l'édition des tableaux (on "voit" ce qu'on fait !) et surtout l'import d'images.
|
|
|
|
#### les images
|
|
|
|
|
|
|
|
Attention cependant, il m'est arrivé d'activer l'éditeur rich text et de le voir "pédaler dans le vide" (donc : :warning: toujours sauvegarder avant de basculer vers l'autre éditeur...) et également de constater la disparition de code Python (il ne reste que les balises). Un effet de bord temporaire ??
|
|
|
|
D'où l'intérêt de garder des traces du travail effectué, en travaillant sur le dépôt gitlab du wiki.
|
|
|
|
:cactus: Soyons francs, j'ai attendu la version de l'éditeur 'rich text' pour réussir à ajouter des images. J'ai vraiment eu du mal à comprendre les posts qui me parlaient d'un répertoire "upload" que je ne voyais nulle part, alors que dans le Readme.md du dépôt on crée un répertoire illustrations (par exemple) auquel on a accès et on fait référence explicitement... Finalement, le malentendu vient du fait que la nature du wiki est... un dépôt git, qu'il faut récupérer ("pull" ) pour pouvoir travailler dessus... Voir la partie correspondante.
|
|
|
|
|
|
|
|
### Editeur "rich text" du gitlab : une solution et quelques problèmes
|
|
|
|
|
|
|
|
Sites de ressource
|
|
|
|
https://gitlab.irstea.fr/help/user/markdown#wiki-specific-markdown
|
|
|
|
https://gitlab.com/francoisjacquet/rosariosis/-/wikis/Markdown-Cheatsheet
|
|
|
|
Un éditeur plus performant est apparu fin 2021, et une bascule est maintenant proposé par le texte cliquable "Edit rich text". La barre de menu du haut est un peu plus étoffée. Sont en particulier grandement facilités : l'édition des **tableaux** (on "voit" ce qu'on fait !) et surtout l'**import d'images** (insert image/upload images).
|
|
|
|
|
|
|
|
Quand on passe de l'un à l'autre il faut ajuster ses réflexes... dans "rich text" la balise ### qui est utilisée pour définir un titre (ici de niveau 3) n'est pas reconnue, il faut passer par l'icône de gauche et changer de "normal text" à "header3" par exemple
|
|
|
|
|
|
|
|
Attention cependant, il m'est arrivé (début 2022) d'activer l'éditeur rich text et de le voir "pédaler dans le vide" (donc : :warning: toujours sauvegarder avant de basculer vers l'autre éditeur...) et également de constater la disparition de code Python (il ne reste que les balises). Un effet de bord temporaire ?? D'où l'intérêt de garder des traces du travail effectué, en travaillant sur le dépôt gitlab du wiki.
|
|
|
|
|
|
|
|
:books: Sites de ressource
|
|
|
|
|
|
|
|
[https://gitlab.irstea.fr/help/user/markdown#wiki-specific-markdown ](https://gitlab.irstea.fr/help/user/markdown#wiki-specific-markdown)
|
|
|
|
|
|
|
|
<https://gitlab.com/francoisjacquet/rosariosis/-/wikis/Markdown-Cheatsheet>
|
|
|
|
|
|
|
|
## 2. Le wiki est un dépôt gitlab...
|
|
|
|
|
|
|
|
Cela paraît évident pour un informaticien (je suppose) mais j'ai mis du temps à comprendre... Le texte cliquable "Clone repository" en haut à droite vous permet de récupérer tous les fichiers du wiki, répertoire d'images compris ("Uploads").
|
|
|
|
Ainsi, vous pouvez :
|
|
|
|
Cela paraît évident pour un informaticien (je suppose) mais j'ai mis du temps à comprendre... Le texte cliquable "Clone repository" en haut à droite vous permet de récupérer tous les fichiers du wiki, répertoire d'images compris ("Uploads"). Ainsi, vous pouvez :
|
|
|
|
|
|
|
|
- **travailler en local** et mettre à jour par des commit et push classiques
|
|
|
|
- gérer les fichiers d'image du répertoire uploads
|
|
|
|
- récupérer plus facilement les modifs perdues...
|
|
|
|
|
|
|
|
Il faut installer un éditeur de wiki ; si vous cliquez sur"Clone repository" vous aurez les instructions pour installer l'éditeur wiki **Gollum** ; c'est en fait un outil **LINUX** !
|
|
|
|
|
|
|
|
La copie d'écran ci-dessous montre l'arborescence des fichiers quand on a récupéré le dépôt (\*.wiki) et dézippé (merci à Sylvain Coulibaly de l'équipe d'Hydraulique des Rivières).
|
|
|
|
|
|
|
|
Il faut installer un éditeur de wiki ; si vous cliquez sur"Clone repository" vous aurez les instructions pour installer l'éditeur wiki **Gollum** ; c'est en fait un outil **LINUX** !
|
|
|
|
Chaque page est un fichier markdown, c'est logique. On **voit enfin le répertoire uploads** ! !
|
|
|
|
|
|
|
|
Dans le répertoire, on trouve une liste de répertoires avec des noms "de code"... typiquement des identifiants générés automatiquement. Dans chaque répertoire se trouve un unique fichier image (png, svg...) qui a en revanche conservé son nom "de baptême", plus explicite pour un humain.
|
|
|
|
|
|
|
|
(à compléter) |
|
|
\ No newline at end of file |
|
|
|
 |
|
|
\ No newline at end of file |
