diff --git a/var/lib/gsl/help/article-comment-ecrire.md b/var/lib/gsl/help/article-comment-ecrire.md new file mode 100644 index 0000000..9370557 --- /dev/null +++ b/var/lib/gsl/help/article-comment-ecrire.md @@ -0,0 +1,284 @@ +# 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 selon le slug: /POST-TITLE.html +type: page + +# Article (monarticle) +# Création 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 +Dans les 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 +- utilisez ```ø``` pour définir une liste ordonnée (alt+gr + o (FR azerty)) + +``` +( +Voici une liste += 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 ```
``` 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 +) + +``` diff --git a/var/lib/gsl/help/template-comment-creer.md b/var/lib/gsl/help/template-comment-creer.md new file mode 100644 index 0000000..88679a5 --- /dev/null +++ b/var/lib/gsl/help/template-comment-creer.md @@ -0,0 +1,58 @@ +# Créer un Template +------------------------------------------------------------------------ + +Vous devrez pour que votre site soit à vôtre goût créer et définir les +styles dans styles.css. Placez ce fichier (en fonction du choix de votre +configuration du DOMAIN) dans : +- HOME: ~/.config/gsl/domains/DOMAIN/templates/ +- GLOBAL: /var/lib/gsl/domains/DOMAIN/templates/ + +Concernant les contenus images et fichiers dans vos articles, placez-les +dans les dossiers +- .../templates/images +- .../templates/files + +Astuce: Une fois votre article créé, vous verrez dans sa source HTML que +beaucoup d'éléments ont une class="ACRONYM_uneclass". Utilisez +ces classes dans style.css pour décorer votre site à votre goût. + +Pour mettre à jour et voir vos modifications de styles + +``` +gsl sync +``` + +GSL synchronisera votre template sur votre webserver. +Rechargez votre page dans votre navigateur + +Si vous avez modifié header ou footer.html, ou si de nouvelles fonctions +sont arrivées et concernent les pages HTML dans GSL, il vous faudra +reconstruire toutes les pages + +``` +gsl make -F +``` + +## Listes de classes utilisées. +Rappel: les classes et IDs commencent passent votre ACRONYM configuré, +lors de la création d'un domaine avec ```gsl new```, suivi par ```_``` + +- ID= +- - body: ACRONYM_page +- - header: ACRONYM_banner +- - logo dans header: ACRONYM_site-logo +- - title dans header: ACRONYM_site-title +- - name dans header: ACRONYM_site-name +- - Description dans header: ACRONYM_site-description +- - section avant article: ACRONYM_spage-wrapper +- - article: ACRONYM_SLUG (SLUG est le "slug: SLUG" de l'artciel) +- - div metas (auteur, date...): ACRONYM_metas +- - p dans div metas: ACRONYM_auteur + +- CLASS= +- - div après chaque titre `````: ACRONYM_content-pX +- - p dans div content-pX: ACRONYM_paragraph +- - - si contenu ```( 2```: ACRONYM_paragraph-2 +- - code for inline-code: ACRONYM_icode + +... more to be listed here