diff --git a/help/comment_ecrire-article.md b/help/comment_ecrire-article.md index fcdc743..5c57329 100644 --- a/help/comment_ecrire-article.md +++ b/help/comment_ecrire-article.md @@ -1,13 +1,23 @@ # 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 -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. @@ -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). - 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```) **Écrire sur une seule ligne** chaque META @@ -45,12 +55,12 @@ type: page title: POST TITLE slug: MY-SLUG (si espaces, GSL les convertira en -) 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 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 **post** @@ -68,7 +78,7 @@ Création HTML dans un dossier selon le slug: /MY-SLUG/index.html ``` type: post -slug: turoriel/xmpp/configurer-gajim +slug: tutoriel/xmpp/configurer-gajim ``` ## 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*```) **doivent être sur la même ligne**. -Les marqueurs à retenir et leur Combinaison de touches sur un clavier -azerty français par défaut +Les marqueurs à retenir et leur combinaison de touches sur un clavier +azerty français (disposition par défaut) - Gras: ```*...*``` - Italique: ```\...\``` - Code en ligne: "`...`" (altgr + 7) - Très gras: ```¤...¤``` (altgr + $) -- Barré: ```~...~``` (altgr + $) +- Barré: ```~...~``` (altgr + 2) - Personnalisé: ```×...×``` (altgr + shift + ;) ### Écrire en très gras @@ -123,10 +133,10 @@ Dans l'article... 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... ``` @@ -138,11 +148,12 @@ Dans l'article... ``` `gsl help -w && echo "Be Happy"` +# Si besoin dans le code de "`..`", replacer par $(...) ``` ### Personnaliser un élément via CSS Ce marqueur permet d'appliquer un ```...``` 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) ``` Personnaliser ces ×jolis mots× @@ -150,9 +161,9 @@ Personnaliser ces ×jolis mots× ### Abréviations 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 -- 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 @@ -167,8 +178,8 @@ Ce POUET est chouette # Affiche "pouet" sur la page ``` ### Paragraphes -- Ouvrir avec ```(``` et fermez avec ```)``` **Au début d'une nouvelle ligne**. -- Définir le nom de la classe du paragraphe,par exemple : "p3" (optionnel) +- Ouvrir avec ```(``` et fermer avec ```)``` **Au début d'une nouvelle ligne**. +- Optionnel : définir le nom de la classe du paragraphe (ex "p3") Dans l'article... ``` @@ -298,7 +309,7 @@ _brut:1 ### Citation simple Commun aux citations : - 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... @@ -332,7 +343,7 @@ world a worse place ``` ### 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 @@ -343,7 +354,7 @@ _book: Esperanza 64 ### Créer des listes L'arborescence est "infinie". - 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... - utilisez ```=``` pour définir une liste simple (ul) @@ -366,8 +377,10 @@ Voici une liste simple === Verts >> ) +``` Voici une liste mixe avec sa classe "couverture" +``` << couverture = Livre 1 + Chapitre 1 @@ -389,7 +402,7 @@ Dans l'article... ``` #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 ) diff --git a/var/lib/gsl/help/comment_ecrire-article.md b/var/lib/gsl/help/comment_ecrire-article.md index fcdc743..5c57329 100644 --- a/var/lib/gsl/help/comment_ecrire-article.md +++ b/var/lib/gsl/help/comment_ecrire-article.md @@ -1,13 +1,23 @@ # 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 -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. @@ -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). - 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```) **Écrire sur une seule ligne** chaque META @@ -45,12 +55,12 @@ type: page title: POST TITLE slug: MY-SLUG (si espaces, GSL les convertira en -) 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 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 **post** @@ -68,7 +78,7 @@ Création HTML dans un dossier selon le slug: /MY-SLUG/index.html ``` type: post -slug: turoriel/xmpp/configurer-gajim +slug: tutoriel/xmpp/configurer-gajim ``` ## 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*```) **doivent être sur la même ligne**. -Les marqueurs à retenir et leur Combinaison de touches sur un clavier -azerty français par défaut +Les marqueurs à retenir et leur combinaison de touches sur un clavier +azerty français (disposition par défaut) - Gras: ```*...*``` - Italique: ```\...\``` - Code en ligne: "`...`" (altgr + 7) - Très gras: ```¤...¤``` (altgr + $) -- Barré: ```~...~``` (altgr + $) +- Barré: ```~...~``` (altgr + 2) - Personnalisé: ```×...×``` (altgr + shift + ;) ### Écrire en très gras @@ -123,10 +133,10 @@ Dans l'article... 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... ``` @@ -138,11 +148,12 @@ Dans l'article... ``` `gsl help -w && echo "Be Happy"` +# Si besoin dans le code de "`..`", replacer par $(...) ``` ### Personnaliser un élément via CSS Ce marqueur permet d'appliquer un ```...``` 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) ``` Personnaliser ces ×jolis mots× @@ -150,9 +161,9 @@ Personnaliser ces ×jolis mots× ### Abréviations 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 -- 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 @@ -167,8 +178,8 @@ Ce POUET est chouette # Affiche "pouet" sur la page ``` ### Paragraphes -- Ouvrir avec ```(``` et fermez avec ```)``` **Au début d'une nouvelle ligne**. -- Définir le nom de la classe du paragraphe,par exemple : "p3" (optionnel) +- Ouvrir avec ```(``` et fermer avec ```)``` **Au début d'une nouvelle ligne**. +- Optionnel : définir le nom de la classe du paragraphe (ex "p3") Dans l'article... ``` @@ -298,7 +309,7 @@ _brut:1 ### Citation simple Commun aux citations : - 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... @@ -332,7 +343,7 @@ world a worse place ``` ### 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 @@ -343,7 +354,7 @@ _book: Esperanza 64 ### Créer des listes L'arborescence est "infinie". - 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... - utilisez ```=``` pour définir une liste simple (ul) @@ -366,8 +377,10 @@ Voici une liste simple === Verts >> ) +``` Voici une liste mixe avec sa classe "couverture" +``` << couverture = Livre 1 + Chapitre 1 @@ -389,7 +402,7 @@ Dans l'article... ``` #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 )