gsl-statique-litterateur/var/lib/gsl/help/article-comment-ecrire.md

# Créer un fichier depuis la ligne de commande
------------------------------------------------------------------------

Vous pouvez créer un fichier daté du jour avec les METAS obligatoires
intégrés (à renseigner après). Vous devez spécifier si votre article
sera une page ou un post (Voir section plus bas) et lui donner un nom.

Rendez vous dans le dossier de vos articles, enregistrés lors de l'ajout
de votre domaine (ou celui que vous avez configuré).

Évitez les espaces dans le nom du fichier ou utilisez des guillemets.

```
# Crréer une page nommée index
gsl create page index

# Créer un article nommé mes-vacances
gsl create post mes-vacances
```

Vous pouvez l'éditer dans le terminal ou avec votre éditeur de texte.

```
gsl edit mes-vacances.gsl
```

# Comment écrire un article
------------------------------------------------------------------------

Votre article doit contenir 2 sections. Les METAS avant ```#1``` et 
l'article à partir de ce repère (servant de titre h1).

- METAS : configurer votre article (titre, date, liens...)
- ARTICLE : contenue rédactionnel avec quelques marqueurs (gras...)

## METAS obligatoires (avant #1)

```
title: POST TITLE
slug: POST-TITLE (si espaces, GSL les convertira en -)
info: DESCRIPTION (À propos de cet article)
author: NAME (doit être enregistré via ($ gsl author add)
date: YYYY-MM-DD
tags: TAG1,Mon TAG2,TAG3 (séparé par une virgule)
```

### Page ou Article ?

Vous pouvez spécifier pour chaque article si c'est une page ou un article
Si non renseigné, GSL ajoutera le type: post (article) par défaut à la 
première ligne de votre article

```
# Page (index, 404, about...)
# Création HTML selon le slug: /POST-TITLE.html
type: page

# Article (monarticle)
# Création HTML selon le slug: /POST-TITLE/index.html
type: post
```

## METAS optionnelles (avant ```#1```)

Définir les marqueurs (abbr:, link:...) et utiliser ``` : ``` comme séparateur

```
abbr: COURT : LONG
file: NOM : NOM-DU-FICHIER : Text alternatif
link: NOM : URL : Text alternatif
code: NUMERO : NOM-DU-FICHIER : Text alternatif
image: NUMERO : NOM-DU-FICHIER : TEXT-ALTERNATIF
```

## Contenu de l'article:

Les marqueurs *et leur contenu* (ex: ```= list 1...```, ```*__monfichier...```)
**doivent commencer et finir sur la même ligne**.

### Abréviations
Définir en METAS...

```
abbr: CSS : Cascading Style Sheets
```

Dans l'article:

```
Les propriétés CSS ne sont pas définies
```

### Paragraphes

Au début d'une nouvelle ligne, ouvrez avec ( et fermez avec ).
Vous pouvez utiliser 4 classes de paragraphes différentes : ( 1 ( 2 ( 3

Dans l'article...
```
( 2
Paragraphe avec une classe 2 (css)
)

(
Paragraphe sans numéro de classe
)
```

### Liens

Définir en METAS

```
link: Mon lien : URL : Alt text
link: https://a-lec.org/ : URL : Alt text
```

Dans l'article..
- Écrivez ```_``` devant le nom du lien
- Ajoutez ```+``` pour ouvrir le lien dans un nouvel onglet

```
Visitez _Mon lien+ et charger ici la page _https://a-lec.org/
```

### Fichiers

Définir en METAS

```
file: Mon fichier : FILENAME : ALT-TEXT
```

Dans l'article...
```
__Mon fichier
```

### Images

Définir en METAS

```
image: 1 : FILENAME : ALT-TEXT
image: 2 : FILENAME : ALT-TEXT
```

Dans l'article...
Définir le marqueur ```_image``` sur une seule ligne et spécifiez les
valeurs séparées par ":"

- Numero d'image
- Alignement: l,r, ou c (g,d également) pour gauche, droite, centre)
- Longueur width: juste le nombre
- Largeur height: juste le nombre
- Champ non vide: Lien de l'image dans un nouvel onglet

Exemple d'images affichées l'une à côté de l'autre

```
(
_image:1
_image:2:c:640:480
_image:3:c:320:240:+
)
```

Exemple d'images affichées l'une en dessous de l'autre, dont la première
peut s'ouvrir dans un nouvel onglet

```
(
_image:1:c:640:480:+
)
(
_image:2:c:1920:1080
)
```

### Block-Code depuis un fichier

Définir en METAS

```
code: 1 : FILENAME : Alt Text
```

Dans l'article...
```
_code:1
```

### Écrire en très gras

Dans l'article...

```
**c'est du surgras**
c'est in**défini**ssable
il ad**juge** : pas de pub !
```

### Gras

Dans l'article...

```
*c'est en gras*
```

### Italique
Dans l'article...

```
C'est /en italique/
```

### Code en ligne

Info: ¤ = alt-gr + $ sur un clavier FR azerty)
Dans l'article...

```
¤gsl help -w¤
```

### Citation simple

(au début de la ligne, mettez 3x -)
Dans l'article...

```
---
(
Une citation simple dans un paragraphe
)
---
```

### Citation avancée

Dans l'article...
```
---
_cite : Richard Matthew Stallman
_link : https://stallman.org/
_lang : en
(
In the free/libre software movement, we develop software that respects
users' freedom, so we and you can escape from software that doesn't. I
could have made money this way, and perhaps amused myself writing code.
But I knew that at the end of my career, I would look back on years of
building walls to divide people, and feel I had spent my life making the
world a worse place
)
---
```

### Citation avancée : optionnel

Ajoutez ces marqueurs, si connus dans la citation, par ex sous ```_cite```

```
_year: 2021
_book: Esperanza 64
```


### Créer des listes
L'arborescence est "infinie".
- Chaque contenu de la liste **doit être sur la même ligne**

Dans l'article...
- utilisez ```=``` pour définir l'arborescence d'une liste simple (ul)
- utilisez ```+``` pour définir une liste ordonnée (ol)

```
(
Voici une liste simple
= Fruits : *mangez-en*
== Kiwis
== Fraises
=== pas mûres
== Bananes
=== Plantins
= Légumes
== Haricots
=== Rouges
=== Verts
Fin de la liste
)
```

### Ajouter des lignes vides

Vous pouvez ajouter des ```<br />``` dans votre rédaction, mais pour une
lecture plus propre de votre article, vous pouvez utiliser le caractère
```|``` *au tout début d'une nouvelle ligne*

Dans l'article...

```
#1 Mon titre
(
Ceci est un long paragraphe (Un peu d'imagination...)
|
Retour "forcé" à la ligne
)

```