Better help

This commit is contained in:
Cyrille L 2022-06-29 11:06:08 +02:00
parent 70d06f033e
commit a5e46da318
2 changed files with 76 additions and 50 deletions

View File

@ -1,13 +1,23 @@
# Créer un article depuis la ligne de commande # Créer un article depuis la ligne de commande
------------------------------------------------------------------------ ------------------------------------------------------------------------
Vous pouvez créer un article daté du jour avec les METAS obligatoires
intégrées (à renseigner après) depuis la ligne de commande. Vous devez
spécifier si votre article sera une page ou un post (Voir section plus
bas), et lui donner un nom. Les metas optionnelles sont ajoutées en
commentaires.
Rendez vous dans le dossier de vos articles, enregistrés lors de l'ajout Rendez vous dans le dossier de vos articles, enregistrés lors de l'ajout
de votre domaine (ou celui que vous avez configuré). de votre domaine (ou celui que vous avez configuré)
```
cd MON-DOSSIER-ARTICLES
gsl setdir
```
Vous pouvez créer un article daté du jour avec les METAS obligatoires
intégrées (à renseigner après) depuis la ligne de commande.
Vous devez spécifier si votre article sera une 'page' ou un 'post'
(Voir section plus bas), et lui donner un nom sans l'extension .gsl. Les
metas optionnelles sont ajoutées en commentaires.
```
gsl new page|post FILENAME
```
Mettez des guillemets pour les nom du fichier avec espaces. Mettez des guillemets pour les nom du fichier avec espaces.
@ -35,7 +45,7 @@ Votre article doit contenir 2 sections. Les METAS avant ```#1``` et
l'article à partir de ce repère (servant de titre h1). l'article à partir de ce repère (servant de titre h1).
- METAS : configurer votre article (titre, date, liens...) - METAS : configurer votre article (titre, date, liens...)
- ARTICLE : contenue rédactionnel avec quelques marqueurs (gras...) - ARTICLE : contenu rédactionnel avec quelques marqueurs (gras...)
## METAS obligatoires (avant ```#1```) ## METAS obligatoires (avant ```#1```)
**Écrire sur une seule ligne** chaque META **Écrire sur une seule ligne** chaque META
@ -45,12 +55,12 @@ type: page
title: POST TITLE title: POST TITLE
slug: MY-SLUG (si espaces, GSL les convertira en -) slug: MY-SLUG (si espaces, GSL les convertira en -)
info: DESCRIPTION (À propos de cet article) info: DESCRIPTION (À propos de cet article)
author: NAME (doit être enregistré via la commande: gsl author edit author: NAME (doit être enregistré via la commande : gsl author edit
date: YYYY-MM-DD date: YYYY-MM-DD
tags: TAG1,Mon TAG2 (séparés par une virgule) tags: TAG1,Mon TAG2 (séparés par une virgule)
``` ```
### Page ou Article ? ### Page ou post ?
Vous devez spécifier pour chaque article si c'est une **page** ou un Vous devez spécifier pour chaque article si c'est une **page** ou un
**post** **post**
@ -68,7 +78,7 @@ Création HTML dans un dossier selon le slug: /MY-SLUG/index.html
``` ```
type: post type: post
slug: turoriel/xmpp/configurer-gajim slug: tutoriel/xmpp/configurer-gajim
``` ```
## METAS optionnelles ## METAS optionnelles
@ -95,14 +105,14 @@ image: NUMERO : NOM-DU-FICHIER : TEXT-ALTERNATIF
Les marqueurs (hors listes) et leur contenu (ex: ```*ceci est en gras*```) Les marqueurs (hors listes) et leur contenu (ex: ```*ceci est en gras*```)
**doivent être sur la même ligne**. **doivent être sur la même ligne**.
Les marqueurs à retenir et leur Combinaison de touches sur un clavier Les marqueurs à retenir et leur combinaison de touches sur un clavier
azerty français par défaut azerty français (disposition par défaut)
- Gras: ```*...*``` - Gras: ```*...*```
- Italique: ```\...\``` - Italique: ```\...\```
- Code en ligne: "`...`" (altgr + 7) - Code en ligne: "`...`" (altgr + 7)
- Très gras: ```¤...¤``` (altgr + $) - Très gras: ```¤...¤``` (altgr + $)
- Barré: ```~...~``` (altgr + $) - Barré: ```~...~``` (altgr + 2)
- Personnalisé: ```×...×``` (altgr + shift + ;) - Personnalisé: ```×...×``` (altgr + shift + ;)
### Écrire en très gras ### Écrire en très gras
@ -126,7 +136,7 @@ Dans l'article...
C'est \en italique\ C'est \en italique\
``` ```
### Créer un texte "barré" ### Créer un texte "barré" (HTML del)
Dans l'article... Dans l'article...
``` ```
@ -138,11 +148,12 @@ Dans l'article...
``` ```
`gsl help -w && echo "Be Happy"` `gsl help -w && echo "Be Happy"`
# Si besoin dans le code de "`..`", replacer par $(...)
``` ```
### Personnaliser un élément via CSS ### Personnaliser un élément via CSS
Ce marqueur permet d'appliquer un ```<span class="xxx_cross">...</span>``` afin Ce marqueur permet d'appliquer un ```<span class="xxx_cross">...</span>``` afin
dde personnaliser une partie spécifique d'un texte ciblé grâce à ses de personnaliser une partie spécifique d'un texte ciblé grâce à ses
propriétés CSS (voir la doc CSS) propriétés CSS (voir la doc CSS)
``` ```
Personnaliser ces ×jolis mots× Personnaliser ces ×jolis mots×
@ -150,9 +161,9 @@ Personnaliser ces ×jolis mots×
### Abréviations ### Abréviations
Définir en METAS... Définir en METAS...
- L'abréviation (i.e. CSS doit être en **lettres CAPITALES**) - L'abréviation (ex: "CSS" doit être en **lettres CAPITALES**)
- L'écriture longue de l'abréviation - L'écriture longue de l'abréviation
- Optionnel: valeur au choix pour forcer l'écriture HTML de "CSS" en minuscule - Optionnel : valeur au choix pour forcer l'écriture HTML de "CSS" en minuscule
``` ```
abbr: CSS : Cascading Style Sheets abbr: CSS : Cascading Style Sheets
@ -167,8 +178,8 @@ Ce POUET est chouette # Affiche "pouet" sur la page
``` ```
### Paragraphes ### Paragraphes
- Ouvrir avec ```(``` et fermez avec ```)``` **Au début d'une nouvelle ligne**. - Ouvrir avec ```(``` et fermer avec ```)``` **Au début d'une nouvelle ligne**.
- Définir le nom de la classe du paragraphe,par exemple : "p3" (optionnel) - Optionnel : définir le nom de la classe du paragraphe (ex "p3")
Dans l'article... Dans l'article...
``` ```
@ -298,7 +309,7 @@ _brut:1
### Citation simple ### Citation simple
Commun aux citations : Commun aux citations :
- Définir un bloc pour la citation. Utilisez ```---``` - Définir un bloc pour la citation. Utilisez ```---```
- Définir une classe CSS spécifique ```--- ma-classe-css``` (optionnel) - Optionnel : définir une classe CSS spécifique ```--- ma-classe-css```
Dans l'article... Dans l'article...
@ -332,7 +343,7 @@ world a worse place
``` ```
### Citation avancée : données optionnelles ### Citation avancée : données optionnelles
Ajoutez ces marqueurs, si connus dans la citation Ajoutez ces marqueurs, si connus dans la citation (ex : sous "_cite")
``` ```
_year: 2021 _year: 2021
@ -343,7 +354,7 @@ _book: Esperanza 64
### Créer des listes ### Créer des listes
L'arborescence est "infinie". L'arborescence est "infinie".
- Définir le début d'une liste par ```<<``` et sa fin par ```>>``` - Définir le début d'une liste par ```<<``` et sa fin par ```>>```
- Définir une classe CSS après ```<< ``` (optionnel) - Optionnel : définir une classe CSS après ```<< ```
Dans l'article... Dans l'article...
- utilisez ```=``` pour définir une liste simple (ul) - utilisez ```=``` pour définir une liste simple (ul)
@ -366,8 +377,10 @@ Voici une liste simple
=== Verts === Verts
>> >>
) )
```
Voici une liste mixe avec sa classe "couverture" Voici une liste mixe avec sa classe "couverture"
```
<< couverture << couverture
= Livre 1 = Livre 1
+ Chapitre 1 + Chapitre 1
@ -389,7 +402,7 @@ Dans l'article...
``` ```
#1 Mon titre #1 Mon titre
( (
Ceci est un long paragraphe (Un peu d'imagination...) Ceci est un long paragraphe (un peu d'imagination...)
| |
Retour "forcé" à la ligne Retour "forcé" à la ligne
) )

View File

@ -1,13 +1,23 @@
# Créer un article depuis la ligne de commande # Créer un article depuis la ligne de commande
------------------------------------------------------------------------ ------------------------------------------------------------------------
Vous pouvez créer un article daté du jour avec les METAS obligatoires
intégrées (à renseigner après) depuis la ligne de commande. Vous devez
spécifier si votre article sera une page ou un post (Voir section plus
bas), et lui donner un nom. Les metas optionnelles sont ajoutées en
commentaires.
Rendez vous dans le dossier de vos articles, enregistrés lors de l'ajout Rendez vous dans le dossier de vos articles, enregistrés lors de l'ajout
de votre domaine (ou celui que vous avez configuré). de votre domaine (ou celui que vous avez configuré)
```
cd MON-DOSSIER-ARTICLES
gsl setdir
```
Vous pouvez créer un article daté du jour avec les METAS obligatoires
intégrées (à renseigner après) depuis la ligne de commande.
Vous devez spécifier si votre article sera une 'page' ou un 'post'
(Voir section plus bas), et lui donner un nom sans l'extension .gsl. Les
metas optionnelles sont ajoutées en commentaires.
```
gsl new page|post FILENAME
```
Mettez des guillemets pour les nom du fichier avec espaces. Mettez des guillemets pour les nom du fichier avec espaces.
@ -35,7 +45,7 @@ Votre article doit contenir 2 sections. Les METAS avant ```#1``` et
l'article à partir de ce repère (servant de titre h1). l'article à partir de ce repère (servant de titre h1).
- METAS : configurer votre article (titre, date, liens...) - METAS : configurer votre article (titre, date, liens...)
- ARTICLE : contenue rédactionnel avec quelques marqueurs (gras...) - ARTICLE : contenu rédactionnel avec quelques marqueurs (gras...)
## METAS obligatoires (avant ```#1```) ## METAS obligatoires (avant ```#1```)
**Écrire sur une seule ligne** chaque META **Écrire sur une seule ligne** chaque META
@ -45,12 +55,12 @@ type: page
title: POST TITLE title: POST TITLE
slug: MY-SLUG (si espaces, GSL les convertira en -) slug: MY-SLUG (si espaces, GSL les convertira en -)
info: DESCRIPTION (À propos de cet article) info: DESCRIPTION (À propos de cet article)
author: NAME (doit être enregistré via la commande: gsl author edit author: NAME (doit être enregistré via la commande : gsl author edit
date: YYYY-MM-DD date: YYYY-MM-DD
tags: TAG1,Mon TAG2 (séparés par une virgule) tags: TAG1,Mon TAG2 (séparés par une virgule)
``` ```
### Page ou Article ? ### Page ou post ?
Vous devez spécifier pour chaque article si c'est une **page** ou un Vous devez spécifier pour chaque article si c'est une **page** ou un
**post** **post**
@ -68,7 +78,7 @@ Création HTML dans un dossier selon le slug: /MY-SLUG/index.html
``` ```
type: post type: post
slug: turoriel/xmpp/configurer-gajim slug: tutoriel/xmpp/configurer-gajim
``` ```
## METAS optionnelles ## METAS optionnelles
@ -95,14 +105,14 @@ image: NUMERO : NOM-DU-FICHIER : TEXT-ALTERNATIF
Les marqueurs (hors listes) et leur contenu (ex: ```*ceci est en gras*```) Les marqueurs (hors listes) et leur contenu (ex: ```*ceci est en gras*```)
**doivent être sur la même ligne**. **doivent être sur la même ligne**.
Les marqueurs à retenir et leur Combinaison de touches sur un clavier Les marqueurs à retenir et leur combinaison de touches sur un clavier
azerty français par défaut azerty français (disposition par défaut)
- Gras: ```*...*``` - Gras: ```*...*```
- Italique: ```\...\``` - Italique: ```\...\```
- Code en ligne: "`...`" (altgr + 7) - Code en ligne: "`...`" (altgr + 7)
- Très gras: ```¤...¤``` (altgr + $) - Très gras: ```¤...¤``` (altgr + $)
- Barré: ```~...~``` (altgr + $) - Barré: ```~...~``` (altgr + 2)
- Personnalisé: ```×...×``` (altgr + shift + ;) - Personnalisé: ```×...×``` (altgr + shift + ;)
### Écrire en très gras ### Écrire en très gras
@ -126,7 +136,7 @@ Dans l'article...
C'est \en italique\ C'est \en italique\
``` ```
### Créer un texte "barré" ### Créer un texte "barré" (HTML del)
Dans l'article... Dans l'article...
``` ```
@ -138,11 +148,12 @@ Dans l'article...
``` ```
`gsl help -w && echo "Be Happy"` `gsl help -w && echo "Be Happy"`
# Si besoin dans le code de "`..`", replacer par $(...)
``` ```
### Personnaliser un élément via CSS ### Personnaliser un élément via CSS
Ce marqueur permet d'appliquer un ```<span class="xxx_cross">...</span>``` afin Ce marqueur permet d'appliquer un ```<span class="xxx_cross">...</span>``` afin
dde personnaliser une partie spécifique d'un texte ciblé grâce à ses de personnaliser une partie spécifique d'un texte ciblé grâce à ses
propriétés CSS (voir la doc CSS) propriétés CSS (voir la doc CSS)
``` ```
Personnaliser ces ×jolis mots× Personnaliser ces ×jolis mots×
@ -150,9 +161,9 @@ Personnaliser ces ×jolis mots×
### Abréviations ### Abréviations
Définir en METAS... Définir en METAS...
- L'abréviation (i.e. CSS doit être en **lettres CAPITALES**) - L'abréviation (ex: "CSS" doit être en **lettres CAPITALES**)
- L'écriture longue de l'abréviation - L'écriture longue de l'abréviation
- Optionnel: valeur au choix pour forcer l'écriture HTML de "CSS" en minuscule - Optionnel : valeur au choix pour forcer l'écriture HTML de "CSS" en minuscule
``` ```
abbr: CSS : Cascading Style Sheets abbr: CSS : Cascading Style Sheets
@ -167,8 +178,8 @@ Ce POUET est chouette # Affiche "pouet" sur la page
``` ```
### Paragraphes ### Paragraphes
- Ouvrir avec ```(``` et fermez avec ```)``` **Au début d'une nouvelle ligne**. - Ouvrir avec ```(``` et fermer avec ```)``` **Au début d'une nouvelle ligne**.
- Définir le nom de la classe du paragraphe,par exemple : "p3" (optionnel) - Optionnel : définir le nom de la classe du paragraphe (ex "p3")
Dans l'article... Dans l'article...
``` ```
@ -298,7 +309,7 @@ _brut:1
### Citation simple ### Citation simple
Commun aux citations : Commun aux citations :
- Définir un bloc pour la citation. Utilisez ```---``` - Définir un bloc pour la citation. Utilisez ```---```
- Définir une classe CSS spécifique ```--- ma-classe-css``` (optionnel) - Optionnel : définir une classe CSS spécifique ```--- ma-classe-css```
Dans l'article... Dans l'article...
@ -332,7 +343,7 @@ world a worse place
``` ```
### Citation avancée : données optionnelles ### Citation avancée : données optionnelles
Ajoutez ces marqueurs, si connus dans la citation Ajoutez ces marqueurs, si connus dans la citation (ex : sous "_cite")
``` ```
_year: 2021 _year: 2021
@ -343,7 +354,7 @@ _book: Esperanza 64
### Créer des listes ### Créer des listes
L'arborescence est "infinie". L'arborescence est "infinie".
- Définir le début d'une liste par ```<<``` et sa fin par ```>>``` - Définir le début d'une liste par ```<<``` et sa fin par ```>>```
- Définir une classe CSS après ```<< ``` (optionnel) - Optionnel : définir une classe CSS après ```<< ```
Dans l'article... Dans l'article...
- utilisez ```=``` pour définir une liste simple (ul) - utilisez ```=``` pour définir une liste simple (ul)
@ -366,8 +377,10 @@ Voici une liste simple
=== Verts === Verts
>> >>
) )
```
Voici une liste mixe avec sa classe "couverture" Voici une liste mixe avec sa classe "couverture"
```
<< couverture << couverture
= Livre 1 = Livre 1
+ Chapitre 1 + Chapitre 1
@ -389,7 +402,7 @@ Dans l'article...
``` ```
#1 Mon titre #1 Mon titre
( (
Ceci est un long paragraphe (Un peu d'imagination...) Ceci est un long paragraphe (un peu d'imagination...)
| |
Retour "forcé" à la ligne Retour "forcé" à la ligne
) )