From aa809cf7ce46ab1bdc7f8128192c700297ac360d Mon Sep 17 00:00:00 2001
From: Cyrille LOUARN
-Les métadonnées indispensables ont des marqueurs uniques qui doivent être -configurés sur une seule ligne. -
--Les métadonnées optionnels peuvent avoir des marqueurs multiples qui doivent -être configurés sur 3 lignes, hormis pour les marqueurs de gestion +Les métadonnées optionnelles peuvent avoir des marqueurs multiples qui +doivent être configurés sur 3 lignes, hormis pour les marqueurs de gestion
La 1ère ligne comprend le marqueur, suvi par son identité. Cette identité
doit être unique (toutes identités confondues), et doit être reprise dans
les contenus rédactionnels, préfixée par ::
.
-Les marqueurs de gestion sont uniques, ptionnels et sans métadonnée. +Les marqueurs de gestion sont uniques, optionnels et sans métadonnée.
Dans la zone des contenus rédactionnels - sous le séparateur, les retours -à la lignes n'ont aucun effet sur la page HTML, afin de rendre les documents -plus lisibles et aérés. Il est également utile d'indenter les marqueurs -de blocs et leurs contenus. +à la lignes n'ont aucun effet sur la page HTML. Vous pouvez en profiter pour +rendre vos documents plus lisibles et aérés. Il est également utile +d'indenter les marqueurs de blocs et leurs contenus.
La commande tyto help
regroupe différentes sections d'aides. Vous
pouvez par exemple taper tyto help article
pour avoir un aperçu de
diff --git a/website_doc/article/index.tyto b/src/usr/share/tyto/docs/www/article/index.tyto
similarity index 66%
rename from website_doc/article/index.tyto
rename to src/usr/share/tyto/docs/www/article/index.tyto
index 1d8a6c2..af7da4a 100644
--- a/website_doc/article/index.tyto
+++ b/src/usr/share/tyto/docs/www/article/index.tyto
@@ -1,15 +1,15 @@
title: Écrire un article au format .tyto
-about: Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur
+about: Comment écrire un article pour Tyto - Littérateur
date: 2024-01-06
tags: format .tyto,écrire,
authors: echolib
logo: @logos/format_tyto.png
-link: Les métadonnées indispensables
+link: les métadonnées indispensables
./metas_obligatoires.html
Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur
-link: Écrire/créer des liens
+link: Créer des liens
./metas_liens.html
Comment écrire des liens pour Tyto - Littérateur
@@ -17,10 +17,22 @@ link: Les URIs spécifiques
./metas_uris.html
Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur
-link: Écrire les titres
+link: Écrire des titres
./redac_titres.html
Comment écrire les titres et les sous-titres pour Tyto - Littérateur
+link: Écrire des paragraphes
+ ./redac_paragraphes.html
+ Comment écrire des paragraphes pour Tyto - Littérateur
+
+link: Afficher des images
+ ./mere_images.html
+ Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur
+
+link: Afficher du code en bloc
+ ./redac_blockcodes.html
+ Comment afficher du code en bloc pour Tyto - Littérateur
+
! LOGO
-------------------------------------------------------------------------------
! TOC
@@ -32,7 +44,9 @@ link: Écrire les titres
structure dans le fichier source. Il est recommandé d'utiliser un simple
éditeur de texte. Ce fichier doit :
(=
+ = être depuis le dossier [` ...articles/ `]
= avoir l'extension [...]*` .tyto `*
+ = contenir ::les métadonnées indispensables
= contenir un séparateur d'au moins 5 tirets {` ----- `}
)=
))
@@ -53,35 +67,29 @@ link: Écrire les titres
Une métadonnée est composée par un marqueur, et ses contenus. Il y a 2 types
de métadonnées dans l'entête :
(=
- = Les métadonnées indispensables
+ = ::les métadonnées indispensables
= les métadonnées optionnelles
)=
))
-#3 Les métadonnées indispensables
-((
- ::Les métadonnées indispensables ont des marqueurs uniques qui doivent être
- configurés sur une seule ligne.
-))
-
#3 Les métadonnées optionnelles
((
- Les métadonnées optionnels peuvent avoir des marqueurs multiples qui doivent
- être configurés sur 3 lignes, hormis pour >`toc_6:les marqueurs de gestion`<
+ Les métadonnées optionnelles peuvent avoir des marqueurs multiples qui
+ doivent être configurés sur 3 lignes, hormis pour >`toc_6:les marqueurs de gestion`<
))
((
La 1ère ligne comprend le marqueur, suvi par son identité. Cette identité
doit être unique (toutes identités confondues), et doit être reprise dans
les contenus rédactionnels, préfixée par {` :: `}.
(=
- = ::Écrire/créer des liens
+ = ::Créer des liens
= ::Les URIs spécifiques
)=
))
#3 Les marqueurs de gestion
((
- Les marqueurs de gestion sont uniques, ptionnels et sans métadonnée.
+ Les marqueurs de gestion sont uniques, optionnels et sans métadonnée.
(=
= +`! NOMAP`+ : article non présent dans le sitemap
= +`! NORSS`+ : article non présent dans le flux RSS
@@ -93,11 +101,14 @@ link: Écrire les titres
#2 Dans la rédaction
((
Dans la zone des contenus rédactionnels - sous le séparateur, les retours
- à la lignes n'ont aucun effet sur la page HTML, afin de rendre les documents
- plus lisibles et aérés. Il est également utile d'indenter les marqueurs
- de blocs et leurs contenus.
+ à la lignes n'ont aucun effet sur la page HTML. Vous pouvez en profiter pour
+ rendre vos documents plus lisibles et aérés. Il est également utile
+ d'indenter les marqueurs de blocs et leurs contenus.
(=
- = ::Écrire les titres, créer la table des matières
+ = ::Écrire des titres, créer une table des matières
+ = ::Écrire des paragraphes
+ = ::Afficher des images
+ = ::Afficher du code en bloc
)=
))
diff --git a/src/usr/share/tyto/docs/www/article/mere_images.html b/src/usr/share/tyto/docs/www/article/mere_images.html
new file mode 100644
index 0000000..a8a18f0
--- /dev/null
+++ b/src/usr/share/tyto/docs/www/article/mere_images.html
@@ -0,0 +1,207 @@
+
+
+
+
+Pour pouvoir afficher des images dans un article, il faut d'abord les
+référencer dans l'entête (au dessus du séparateur -----
). Le marqueur
+d'entête image:
se configure sur 3 lignes.
+
+++
- +
# Dans l'entête de l'article (avant le séparateur)
- +
image: Identité1
- +
monimage.png
- +
Un texte alternatif accessible
- +
- +
image: Identité2
- +
@team01.png
- +
L'équipe en image
- +
- +
image: Identité3
- +
/divers/photo1.png
- +
Texte alternatif décrivant la photo
+L'identité du marqueur. image: UniqueID
. L'image doit avoir une
+identité unique (y compris des autres marqueurs d'entête).
+
+URI du fichier. Depuis le dossier du domaine articles/
. L'URI peut
+avoir 3 dossiers sources différents, en fonction du premier caractère ; voir
+les URIs spécifiques :
+
@team01.png
: depuis le dossier articles/images/
/team01.png
: depuis le dossier articles/
team01.png
: depuis le dossier où se trouve l'article
+Texte alternatif. le texte décrivant l'image. Ce texte est utilisé dans la
+balise HTML <img alt="" title="">
et permet de rendre l'image plus
+accessible.
+
+Une image référencée peut être appelée par plusieurs marqueurs d'appels dans
+la partie dédiée aux contenus rédactionnels. Le marqueur d'appel est
+composé par ::
, suivi de l'identité donnée au marqueur d'entête. Vous
+ne devez mettre qu'un seul marqueur d'appel par ligne.
+
+Sans le signe |
(raccourci de <br>
en HTML) sur une nouvelle
+ligne, les images pourraient être affichées les unes à côté des autres ;
+(voir Rappel).
+
+Il y a 4 paramètres possibles et leur ordre est aléatoire. Après le marqueur +d'appel, ajouter les, en les séparant par une virgule. Si un seul paramètre +est défini, n'oubliez pas de rajouter une virgule. Voir les exemples d'appels +ci-dessous. Les paramètres sont: +
"c=CLASS"
: CLASS est le nom de la classe CSS."w=WIDTH"
: WIDTH est la largeur désirée"h=HEIGHT"
: HEIGHT est la hauteur désirée"f=LEGENDE"
: LEGENDE est le texte de légende (crée <figure>...
)
+Par défaut, la classe utilisée est celle dans la configuration du domaine,
+si le paramètre "c=CLASS"
n'est pas défini.
+
++ ++
- +
...
- +
::Identité2
- +
|
- +
# Un seul paramètre termine par une "," !
- +
::Identité2 "c=ClasseTeam",
- +
|
- +
::Identité2 "f=Une légende", "c=ClasseFigure"
- +
|
- +
# Sans unité aux dimmensions, "px" est ajouté
- +
::Identité2 "w=800", "h=20%", "c=Class", "f=Légende de l'image"
+Sachez qu'une image en HTML suit une disposition "en ligne", sauf si vous
+ajoutez une légende au marqueur d'appel. Dans ce cas, la balise HTML
+<figure>
(disposition en bloc) est utiliée. Toutefois, chaque image
+peut avoir une classe CSS. Dans le fichier styles.css
, il suffit
+d'ajouter, à la classe définie, une propriété de bloc, comme
+display: block;
, pour qu'elle suive une disposition "en bloc".
+
+++
- +
# L'image se trouve dans le dossier articles/images/team/
- +
image: fred01
- +
@team/fred_01.png
- +
Fred devant son PC
- +
- +
# Séparateur d'entête
- +
-----
- +
- +
::fred01 "c=bpic",