| ... | ... | @@ -24,14 +24,16 @@ Ces pages sont actuellement "en construction", dans un premier temps toutes les |
|
|
|
## Utilisation du wiki en complément du repo
|
|
|
|
On donnera ici :
|
|
|
|
- quelques avantages de remplir le readme et le wiki : informations sur le code mis à disposition (contact, contexte, aide à l'installation et à l'utilisation...) **faciles à mettre à jour** !
|
|
|
|
- quelques inconvénients par rapport à une doc classique :disappointed:
|
|
|
|
- quelques inconvénients par rapport à une doc classique :
|
|
|
|
- si on veut profiter du format wiki il faut réfléchir à la structure et consacrer du temps de rédaction (un peu lourd), et bien sûr **apprivoiser le markdown spécifique à GitLab** !
|
|
|
|
-
|
|
|
|
- le wiki n'est pas consultable hors ligne ; il vaut donc mieux compiler aussi une version pdf, mais a priori il n'est pas facile de passer de plusieurs fichiers md à un doc unique pdf
|
|
|
|
- une note sur les **autorisations** : le propriétaire d'une page peut gérer des droits d'édition du wiki, indépendamment des droits du repo
|
|
|
|
|
|
|
|
|
|
|
|
## Liste des fonctions sélectionnées
|
|
|
|
Pour l'instant tout est dans cette page, l'idée est de mettre par la suite juste un lien par thème vers une page dédiée.
|
|
|
|
|
|
|
|
## Fonctions de base
|
|
|
|
### Fonctions de base
|
|
|
|
Les fonctions courantes seront très faciles à trouver via un tuto et via la barre d'outils, elles seront donc peu détaillées ici :
|
|
|
|
- niveaux de titre (header) avec des dièses : un `#` par niveau de titre, suivi d'une >kbd>espace</kbd> ; c'est traître car pour les symboles pour le gras `*` et l'italique `_` il ,n'en faut pas !
|
|
|
|
- **gras** avec la barre d'outils ou `**` encadrant le texte, sans espace
|
| ... | ... | @@ -67,12 +69,13 @@ Text B |
|
|
|
A noter que [le site w3c school](https://www.w3schools.io/file/markdown-line-break/) indique d'autres possibilités, qui ne sont pas forcément disponibles dans GitLab.
|
|
|
|
|
|
|
|
|
|
|
|
## Mise en forme "niveau intermédiaire"
|
|
|
|
### Mise en forme "niveau intermédiaire"
|
|
|
|
- très utiles :
|
|
|
|
- Tableaux (différent selon les 2 éditeurs !), citations dont code avec coloration syntaxique, "section déroulante" (collapsible section), insérer une image (et mise en forme via les 2 éditeurs !), équations...
|
|
|
|
- pourquoi pas : les emoji :bulb:, mettre du texte en couleur
|
|
|
|
|
|
|
|
### Insérer du code, avec coloration syntaxique
|
|
|
|
#### "utiles"
|
|
|
|
##### Insérer du code, avec coloration syntaxique
|
|
|
|
Pour insérer du code : trois "back quotes" (<kbd>AltGr + 7 + espace</kbd> en début de bloc et trois en fin de bloc
|
|
|
|
```
|
|
|
|
ceci est un bloc
|
| ... | ... | @@ -94,9 +97,34 @@ for lettre in mon_langage: |
|
|
|
<text x="5" y = "12" >avec le mot-clé html : ici, extrait d'un fichier svg ></text>
|
|
|
|
<circle fill_color="yellow" cx="5" cy = "12" r = "50">
|
|
|
|
```
|
|
|
|
#### "pourquoi pas"
|
|
|
|
|
|
|
|
##### texte en couleur
|
|
|
|
Une première astuce est de créer un [lien hypertexte bidon]("il n'y a pas de lien"), qui sera donc repéré en bleu, sans URL. C'est simple à faire, mais éventuellement étrange pour le lecteur.
|
|
|
|
Une seconde astuce est de... passer par LateX !
|
|
|
|
> $`\textcolor{teal}{ \text{ligne en bleu clair dans une syntaxe LateX}}`$
|
|
|
|
$`\textcolor{teal}{ \text{ligne en bleu clair dans une syntaxe LateX}}`$
|
|
|
|
|
|
|
|
## liens hypertexte
|
|
|
|
Reste à trouver la liste des couleurs "autorisées" dans GitLab...
|
|
|
|
|
|
|
|
##### Les équations
|
|
|
|
Selon votre problème, ce peut être crucial !
|
|
|
|
Astuce : le site [**pandoc**](https://pandoc.org/try/) pour convertir d'une syntaxe à une autre.
|
|
|
|
|
|
|
|
a) exemple simple
|
|
|
|
|
|
|
|
### *V* = *K*<sub>*s*</sub>.*R*<sub>*h*</sub><sup>(2/3)</sup>.*i* <sup>(1/2)</sup>
|
|
|
|
{: .alert .alert-info .text-center}
|
|
|
|
|
|
|
|
où:
|
|
|
|
- les indices sont obtenus avec la balise **sub** : `K<sub>*s*</sub>`
|
|
|
|
- les exposants sont obtenus avec la balise **sup** `rayon_hydraulique<sup>(2/3)</sup>`.
|
|
|
|
- la tentative de centrer a lamentablement échoué
|
|
|
|
|
|
|
|
b) exemple complexe
|
|
|
|
passer par LateX
|
|
|
|
|
|
|
|
### liens hypertexte
|
|
|
|
- Liens externes
|
|
|
|
- liens vers d'autres pages du wiki
|
|
|
|
- liens vers des titres (headers) repérés par des signets (anchors)
|
| ... | ... | @@ -104,4 +132,4 @@ for lettre in mon_langage: |
|
|
|
- **liste des pages** (sidebar) : sidebar par défaut, sidebar customisée
|
|
|
|
|
|
|
|
|
|
|
|
## sous Linux : le wiki est un repo clonable |
|
|
|
### sous Linux : le wiki est un repo clonable |
