Update documentation, readme

This commit is contained in:
Cyrille L 2022-07-20 22:44:30 +02:00
parent a4ffcf83c0
commit 3d3adcd7b8
5 changed files with 35 additions and 11 deletions

View File

@ -142,7 +142,13 @@ stl wip sidebar=2 (ARTICLE.stl)
``` ```
## Documentation de STL ## Documentation de STL
Les fichiers de documentations sont dans le dossier help. Les fichiers de documentations sont dans le dossier help. Pensez à la
commande. Le README est accessible depuis la ligne de commande également
```
gsl help
gsl readme
```
## Dépendances ## Dépendances

View File

@ -149,13 +149,16 @@ Chaque marqueur d'image doit se trouver sur sa propre ligne.
- - - t=http|ftp # Pointe l'image vers le site http|ftp - - - t=http|ftp # Pointe l'image vers le site http|ftp
- - c=(CLASS) - - c=(CLASS)
- - - c=maclasse # Définir la classe CSS "maclasse" : xxx_image maclasse - - - c=maclasse # Définir la classe CSS "maclasse" : xxx_image maclasse
- - - c=d ou c=r # Classe CSS right
- - - c=g ou c=l # Classe CSS : left
- - - c=c # Classe CSS : center (défaut si non définie)
- - w=(WIDTH) # Si pas d'unité, défaut = 'px' - - w=(WIDTH) # Si pas d'unité, défaut = 'px'
- - - w=480 # Affiche l'image avec une largeur de 480px - - - w=480 # Affiche l'image avec une largeur de 480px
- - h=(HEIGHT) # Si pas d'unité, défaut = 'px' - - h=(HEIGHT) # Si pas d'unité, défaut = 'px'
- - - h=30% # Affiche l'image avec une hauteur de 30% - - - h=30% # Affiche l'image avec une hauteur de 30%
Si WIDTH ou HEIGHT renseigné uniquement, affiche l'image avec Si WIDTH ou HEIGHT renseigné uniquement, affiche l'image avec
HEIGHT ou WIDTH addapté HEIGHT ou WIDTH adapté
#### Quelques exemples de marqueurs d'images #### Quelques exemples de marqueurs d'images
@ -202,7 +205,7 @@ abbr: POUET : Descriptif : Pouets
Dans l'article : Dans l'article :
``` ```
Des POUET très inscructifs Des POUET très instructifs
# "POUET" doit avoir un espace, avant ou après pour être pris en compte # "POUET" doit avoir un espace, avant ou après pour être pris en compte
# "Descriptif" est utilisé dans la balise title HTML # "Descriptif" est utilisé dans la balise title HTML
@ -244,9 +247,9 @@ Dans l'article, entourer le ou les mots par :
Dans l'article, entourer le ou les mots par : Dans l'article, entourer le ou les mots par :
``` ```
# × : combinaisaon de touche altgr + shift + ; sur clavier FR défaut
×_Géniale, cet affichage de ces mots_× ×_Géniale, cet affichage de ces mots_×
# × : combinaisaon de touche altgr + shift + ; sur clavier FR défaut
# Classe CSS utilisée : xxx_cross # Classe CSS utilisée : xxx_cross
``` ```
@ -357,7 +360,7 @@ Dans l'article :
# Chaque item <li> utilise la classe : xxx_li xxx_li-X # Chaque item <li> utilise la classe : xxx_li xxx_li-X
# où X est le nombre de marquurs # où X est le nombre de marquurs
# La sortie de cette liste en HTML, avec le domaine css "a-lec" : # La sortie de cette liste en HTML, avec le valeur CSS choisie "a-lec" :
<ul class="a-lec_list a-lec_list-ul couverture couverture-ul"> <ul class="a-lec_list a-lec_list-ul couverture couverture-ul">
<li class="a-lec_li a-lec_li-1">Livre 1</li> <li class="a-lec_li a-lec_li-1">Livre 1</li>

View File

@ -142,7 +142,13 @@ stl wip sidebar=2 (ARTICLE.stl)
``` ```
## Documentation de STL ## Documentation de STL
Les fichiers de documentations sont dans le dossier help. Les fichiers de documentations sont dans le dossier help. Pensez à la
commande. Le README est accessible depuis la ligne de commande également
```
gsl help
gsl readme
```
## Dépendances ## Dépendances

View File

@ -149,13 +149,16 @@ Chaque marqueur d'image doit se trouver sur sa propre ligne.
- - - t=http|ftp # Pointe l'image vers le site http|ftp - - - t=http|ftp # Pointe l'image vers le site http|ftp
- - c=(CLASS) - - c=(CLASS)
- - - c=maclasse # Définir la classe CSS "maclasse" : xxx_image maclasse - - - c=maclasse # Définir la classe CSS "maclasse" : xxx_image maclasse
- - - c=d ou c=r # Classe CSS right
- - - c=g ou c=l # Classe CSS : left
- - - c=c # Classe CSS : center (défaut si non définie)
- - w=(WIDTH) # Si pas d'unité, défaut = 'px' - - w=(WIDTH) # Si pas d'unité, défaut = 'px'
- - - w=480 # Affiche l'image avec une largeur de 480px - - - w=480 # Affiche l'image avec une largeur de 480px
- - h=(HEIGHT) # Si pas d'unité, défaut = 'px' - - h=(HEIGHT) # Si pas d'unité, défaut = 'px'
- - - h=30% # Affiche l'image avec une hauteur de 30% - - - h=30% # Affiche l'image avec une hauteur de 30%
Si WIDTH ou HEIGHT renseigné uniquement, affiche l'image avec Si WIDTH ou HEIGHT renseigné uniquement, affiche l'image avec
HEIGHT ou WIDTH addapté HEIGHT ou WIDTH adapté
#### Quelques exemples de marqueurs d'images #### Quelques exemples de marqueurs d'images
@ -202,7 +205,7 @@ abbr: POUET : Descriptif : Pouets
Dans l'article : Dans l'article :
``` ```
Des POUET très inscructifs Des POUET très instructifs
# "POUET" doit avoir un espace, avant ou après pour être pris en compte # "POUET" doit avoir un espace, avant ou après pour être pris en compte
# "Descriptif" est utilisé dans la balise title HTML # "Descriptif" est utilisé dans la balise title HTML
@ -244,9 +247,9 @@ Dans l'article, entourer le ou les mots par :
Dans l'article, entourer le ou les mots par : Dans l'article, entourer le ou les mots par :
``` ```
# × : combinaisaon de touche altgr + shift + ; sur clavier FR défaut
×_Géniale, cet affichage de ces mots_× ×_Géniale, cet affichage de ces mots_×
# × : combinaisaon de touche altgr + shift + ; sur clavier FR défaut
# Classe CSS utilisée : xxx_cross # Classe CSS utilisée : xxx_cross
``` ```
@ -357,7 +360,7 @@ Dans l'article :
# Chaque item <li> utilise la classe : xxx_li xxx_li-X # Chaque item <li> utilise la classe : xxx_li xxx_li-X
# où X est le nombre de marquurs # où X est le nombre de marquurs
# La sortie de cette liste en HTML, avec le domaine css "a-lec" : # La sortie de cette liste en HTML, avec le valeur CSS choisie "a-lec" :
<ul class="a-lec_list a-lec_list-ul couverture couverture-ul"> <ul class="a-lec_list a-lec_list-ul couverture couverture-ul">
<li class="a-lec_li a-lec_li-1">Livre 1</li> <li class="a-lec_li a-lec_li-1">Livre 1</li>

View File

@ -142,7 +142,13 @@ stl wip sidebar=2 (ARTICLE.stl)
``` ```
## Documentation de STL ## Documentation de STL
Les fichiers de documentations sont dans le dossier help. Les fichiers de documentations sont dans le dossier help. Pensez à la
commande. Le README est accessible depuis la ligne de commande également
```
gsl help
gsl readme
```
## Dépendances ## Dépendances