- + diff --git a/website_doc/404.tyto b/src/usr/share/tyto/docs/www/404.tyto similarity index 97% rename from website_doc/404.tyto rename to src/usr/share/tyto/docs/www/404.tyto index dda5e2b..bce9260 100644 --- a/website_doc/404.tyto +++ b/src/usr/share/tyto/docs/www/404.tyto @@ -4,6 +4,9 @@ date: 2024-01-13 tags: 404,erreur authors: echolib +! NOMAP +! NORSS + image: 404 VH_Tyto_404.png Image montrant la chouette, Tyto, perdue diff --git a/website_doc/VH_Tyto_404.png b/src/usr/share/tyto/docs/www/VH_Tyto_404.png similarity index 100% rename from website_doc/VH_Tyto_404.png rename to src/usr/share/tyto/docs/www/VH_Tyto_404.png diff --git a/website_doc/a-propos/index.html b/src/usr/share/tyto/docs/www/a-propos/index.html similarity index 98% rename from website_doc/a-propos/index.html rename to src/usr/share/tyto/docs/www/a-propos/index.html index 56b1e85..939bbe2 100644 --- a/website_doc/a-propos/index.html +++ b/src/usr/share/tyto/docs/www/a-propos/index.html @@ -33,7 +33,7 @@ - + Mentions Légales (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/a-propos/index.tyto b/src/usr/share/tyto/docs/www/a-propos/index.tyto similarity index 100% rename from website_doc/a-propos/index.tyto rename to src/usr/share/tyto/docs/www/a-propos/index.tyto diff --git a/website_doc/article/index.html b/src/usr/share/tyto/docs/www/article/index.html similarity index 73% rename from website_doc/article/index.html rename to src/usr/share/tyto/docs/www/article/index.html index aa07137..741abd0 100644 --- a/website_doc/article/index.html +++ b/src/usr/share/tyto/docs/www/article/index.html @@ -15,7 +15,7 @@ - + @@ -29,11 +29,11 @@ - + - + Écrire un article au format .tyto (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -64,13 +64,12 @@ echolib, 06/01/2024 [Le séparateur ? Dans l'entête -Les métadonnées indispensables -Les métadonnées optionnelles -Les marqueurs de gestion +Les métadonnées optionnelles +Les marqueurs de gestion -Dans la rédaction +Dans la rédaction -Rappel +Rappel Le format ".tyto" ? @@ -80,7 +79,9 @@ textuel brut en page HTML5, il faut utiliser des marqueurs, et respecter une 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 ----- @@ -97,49 +98,47 @@ marqueurs dédiés au formattge des textes. 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 -Les métadonnées indispensables +Les métadonnées optionnelles -Les métadonnées indispensables ont des marqueurs uniques qui doivent être -configurés sur une seule ligne. - -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 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 ::. -Écrire/créer des liens +Créer des liens Les URIs spécifiques -Les marqueurs de gestion +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 ! LOGO : Montre le logo de l'article près de son titre -Dans la rédaction +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 -Rappel +Rappel 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 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher des images (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher des images + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Le marqueur d'image dans l'entête + +Exemples de configurations +Paramètres du marqueur d'entête + +Première ligne +Seconde ligne +Troisième ligne + + +Le marqueur d'appel dans la rédaction + +Paramètres optionels du marqueur d'appel +Exemples d'appels + +Rappels + +Exemple final + + + +Le marqueur d'image dans l'entête + +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. + +Exemples de configurations + + +# 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 + +Paramètres du marqueur d'entête +Première ligne + +L'identité du marqueur. image: UniqueID. L'image doit avoir une +identité unique (y compris des autres marqueurs d'entête). + +Seconde ligne + +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 + + +Troisième ligne + +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. + +Le marqueur d'appel dans la rédaction + +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). + +Paramètres optionels du marqueur d'appel + +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. + +Exemples d'appels + + +... +::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" + + +Rappels + +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". + +Exemple final + + +# 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", + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/mere_images.tyto b/src/usr/share/tyto/docs/www/article/mere_images.tyto new file mode 100644 index 0000000..0d03b6a --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/mere_images.tyto @@ -0,0 +1,139 @@ +title: Afficher des images +about: Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur +tags: marqueurs,images +date: 2023-12-05 +authors: echolib + +link: les URIs spécifiques + ./metas_uris.html + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- + +! TOC + +#1 Le marqueur d'image dans l'entête +(( + 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. +)) + +#2 Exemples de configurations +{{ + # 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 +}} + + +#2 Paramètres du marqueur d'entête +#3 Première ligne +(( + L'identité du marqueur. {` image: UniqueID `}. L'image doit avoir une + identité unique (y compris des autres marqueurs d'entête). +)) +#3 Seconde ligne +(( + 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 + )= +)) +#3 Troisième ligne +(( + Texte alternatif. le texte décrivant l'image. Ce texte est utilisé dans la + balise HTML {` `} et permet de rendre l'image plus + accessible. +)) + + +#1 Le marqueur d'appel dans la rédaction +(( + 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 {` `} en HTML) sur une nouvelle + ligne, les images pourraient être affichées les unes à côté des autres ; + (>`rappel: voir Rappel`<). +)) + + +#2 Paramètres optionels du marqueur d'appel +(( + 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 {` ... `}) + )= +)) +(( + 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. +)) + +#2 Exemples d'appels +{{ + ... + ::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" +}} + + +-> rappel +#1 Rappels +(( + 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 + {` `} (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". +)) + +#2 Exemple final +{{ + # 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", +}} + diff --git a/website_doc/article/metas_liens.html b/src/usr/share/tyto/docs/www/article/metas_liens.html similarity index 92% rename from website_doc/article/metas_liens.html rename to src/usr/share/tyto/docs/www/article/metas_liens.html index bffb72f..6f5b5ea 100644 --- a/website_doc/article/metas_liens.html +++ b/src/usr/share/tyto/docs/www/article/metas_liens.html @@ -1,4 +1,4 @@ - + @@ -13,7 +13,7 @@ - + @@ -26,15 +26,15 @@ - + - -Écrire/créer des liens (echolib) | Tyto - Littérateur + +Créer des liens (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + -Écrire/créer des liens +Créer des liens -echolib, 08/01/2024 [Code source] +echolib, 08/01/2024 [Code source] Table des matières diff --git a/website_doc/article/metas_liens.tyto b/src/usr/share/tyto/docs/www/article/metas_liens.tyto similarity index 98% rename from website_doc/article/metas_liens.tyto rename to src/usr/share/tyto/docs/www/article/metas_liens.tyto index 32b2df7..8c6e4b7 100644 --- a/website_doc/article/metas_liens.tyto +++ b/src/usr/share/tyto/docs/www/article/metas_liens.tyto @@ -1,4 +1,4 @@ -title: Écrire/créer des liens +title: Créer des liens about: Comment écrire des liens pour Tyto - Littérateur date: 2024-01-08 tags: format .tyto,écrire,liens diff --git a/website_doc/article/metas_obligatoires.html b/src/usr/share/tyto/docs/www/article/metas_obligatoires.html similarity index 98% rename from website_doc/article/metas_obligatoires.html rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.html index 6aad0bc..68e1c35 100644 --- a/website_doc/article/metas_obligatoires.html +++ b/src/usr/share/tyto/docs/www/article/metas_obligatoires.html @@ -33,7 +33,7 @@ - + Écrire les métadonnées indispensables (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_obligatoires.tyto b/src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto similarity index 100% rename from website_doc/article/metas_obligatoires.tyto rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto diff --git a/website_doc/article/metas_uris.html b/src/usr/share/tyto/docs/www/article/metas_uris.html similarity index 98% rename from website_doc/article/metas_uris.html rename to src/usr/share/tyto/docs/www/article/metas_uris.html index a0fe4dd..05226a4 100644 --- a/website_doc/article/metas_uris.html +++ b/src/usr/share/tyto/docs/www/article/metas_uris.html @@ -33,7 +33,7 @@ - + Les URIs spécifiques (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_uris.tyto b/src/usr/share/tyto/docs/www/article/metas_uris.tyto similarity index 100% rename from website_doc/article/metas_uris.tyto rename to src/usr/share/tyto/docs/www/article/metas_uris.tyto diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.html b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html new file mode 100644 index 0000000..84532f3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html @@ -0,0 +1,143 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher du code en bloc (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher du code en bloc + + +echolib, 16/01/2024 [Code source] + + +Table des matières + + +Les marqueurs +Exemples de code en bloc + +Sortie HTML + + + +Les marqueurs + +Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture +{{ et de fermeture }}, et placer les lignes de codes dedans. +Il est recommandé d'indenter les lignes de codes dans le bloc. Tyto +prend en compte l'indentation de la première ligne de code pour l'affichage +HTML. + + +Les marqueurs d'ouverture et de fermeture doivent se trouver au +même niveau d'indentation dans l'article source, et sonts seuls sur une +ligne + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est "bcode". La classe est reprise dans les balises HTML. +Voir ci-dessous la sortie HTML des exemples suivants. + +Exemples de code en bloc + + +# Comment afficher du code pour Tyto - Littérateur +{{ + Placer du code ici + et encore là... +}} + + + +{{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) +}} + +Sortie HTML + + +<pre class="bcode_pre"> +<ol class="bcode_items"> +<li role="listitem" class="bcode_item"><code class="bcode_code"># Comment afficher du code pour Tyto - Littérateur</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">{{</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> Placer du code ici</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> et encore là...</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">}}</code></li> +</ol> +</pre> +<pre class="MonCode_pre"> +<ol class="MonCode_items"> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">{{ MonCode</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # ! Aucune propriété de style MonCode existe</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # dans styles.css. Affichage par défaut</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> def tyto_code(hello):</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> if hello:</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> print(hello)</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">}}</code></li> +</ol> +</pre> + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto new file mode 100644 index 0000000..25c3e9b --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto @@ -0,0 +1,71 @@ +title: Afficher du code en bloc +about: Comment afficher du code en bloc pour Tyto - Littérateur +tags: rédaction,marqueurs,blockcode +date: 2024-01-16 +authors: echolib + +------------------------------------------------------------------------------- +! TOC + +#1 Les marqueurs +(( + Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture + {` {{ `} et de fermeture {` }} `}, et placer les lignes de codes dedans. + Il est recommandé d'indenter les lignes de codes dans le bloc. :`Tyto`: + prend en compte l'indentation de la première ligne de code pour l'affichage + HTML. +)) +(( + Les marqueurs d'ouverture et de fermeture doivent se trouver *`au + même niveau d'indentation`* dans l'article source, et *`sonts seuls sur une + ligne`* +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est "bcode". La classe est reprise dans les balises HTML. + Voir ci-dessous la sortie HTML des exemples suivants. +)) + + +#1 Exemples de code en bloc +{{ + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} +}} + +{{ MonCode + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} +}} + +#2 Sortie HTML +{{ + + + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} + + + + + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} + + +}} diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.html b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html new file mode 100644 index 0000000..2dc55da --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html @@ -0,0 +1,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Écrire des paragraphes (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Écrire des paragraphes + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Les marqueurs + +Exemple de paragraphes + + + +Les marqueurs + +Les marqueurs de paragraphes forment un bloc. Pour écrire des +paragraphes <p></p> en HTML, et même les imbriquer, il faut écrire du +texte entre les marqueurs d'ouverture ((, et de fermeture )). +Ces marqueurs doivent être placés seuls au début d'une ligne. + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est celle dans la configuration du domaine. + + +Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, +indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. + +Exemple de paragraphes + + +(( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) +)) + +(( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B +)) + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto new file mode 100644 index 0000000..440f016 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto @@ -0,0 +1,49 @@ +title: Écrire des paragraphes +about: Comment écrire des paragraphes pour Tyto - Littérateur +tags: rédaction,marqueurs,paragraphes +date: 2023-12-05 +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- +! TOC + + +#1 Les marqueurs +(( + Les *`marqueurs de paragraphes`* forment un bloc. Pour écrire des + paragraphes {` `} en HTML, et même les imbriquer, il faut écrire du + texte entre les marqueurs d'ouverture {` (( `}, et de fermeture {` )) `}. + Ces marqueurs doivent être placés +`seuls au début d'une ligne`+. +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est celle dans la ::configuration du domaine. +)) +(( astuce + Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, + indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. +)) + + +#2 Exemple de paragraphes +{{ + (( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) + )) + + (( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B + )) +}} diff --git a/website_doc/article/redac_titres.html b/src/usr/share/tyto/docs/www/article/redac_titres.html similarity index 87% rename from website_doc/article/redac_titres.html rename to src/usr/share/tyto/docs/www/article/redac_titres.html index 56957f1..17e22f9 100644 --- a/website_doc/article/redac_titres.html +++ b/src/usr/share/tyto/docs/www/article/redac_titres.html @@ -1,4 +1,4 @@ - + @@ -13,10 +13,10 @@ - + - + @@ -26,15 +26,15 @@ - + - -Écrire les titres et sous-titres (echolib) | Tyto - Littérateur + +Écrire des titres et sous-titres (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + - + -Écrire les titres et sous-titres +Écrire des titres et sous-titres -echolib, 07/01/2024 [Code source] +echolib, 07/01/2024 [Code source] Table des matières diff --git a/website_doc/article/redac_titres.tyto b/src/usr/share/tyto/docs/www/article/redac_titres.tyto similarity index 93% rename from website_doc/article/redac_titres.tyto rename to src/usr/share/tyto/docs/www/article/redac_titres.tyto index 49ad6a1..339b4ff 100644 --- a/website_doc/article/redac_titres.tyto +++ b/src/usr/share/tyto/docs/www/article/redac_titres.tyto @@ -1,7 +1,7 @@ -title: Écrire les titres et sous-titres +title: Écrire des titres et sous-titres about: Comment écrire les titres et les sous-titres pour Tyto - Littérateur date: 2024-01-07 -tags: format .tyto,écrire,rédaction,titres,table des matières +tags: rédaction,marqueurs,titres,table des matières authors: echolib logo: @logos/tyto_titles_toc.png diff --git a/src/usr/share/tyto/docs/www/config/index.html b/src/usr/share/tyto/docs/www/config/index.html new file mode 100644 index 0000000..076ec9e --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Créer et configurer un domaine (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Créer et configurer un domaine + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Créer un domaine + +Les commandes à taper + +Répondre aux questions + +Exemple d'un domaine créé + + +Modifier la configuration + +Les valeurs importantes + + + + +Créer un domaine + +Tyto littérateur fonctionne dans un dossier ayant l'identité d'un nom de +domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez +le créer, à l'emplacement de votre choix. Ce dossier est votre +dossier de travail. Seulement une fois ce dossier ouvert (dans un +terminal), vous pouvez lancer la procédure de création du domaine afin de +créer votre nouveau site. + + +Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez +créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers +des domaines. + +Les commandes à taper + + +# Commande bash pour créer un dossier du domaine +mkdir -p domaine.tld + +# Se placer dans le dossier créé +cd domaine.tld + +# Créer et configurer le domaine "domaine.tld" +tyto new domain + +Répondre aux questions + + + +Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de +quelques renseignements concernant ce domaine, et notemment : + +le titre du domaine +la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) +la description du domaine +les étiquettes du domaine (séparées par une virugule) +le courriel de l'administrateur +la langue du domaine (celle du site web) sur 2 caractères (en, fr...) +le dossier du serveur root + + +Exemple d'un domaine créé + +Une fois toutes les questions répondues, le fichier tyto_domain.ini est +créé dans le dossier du domaine. Quelques données supplémentaires sont +configurables dans le fichier, qui est au format INI. Il est plus que +recommandé de l'ouvrir et de vérifier son contenu +avant de continuer. Vous pouvez le lire avec la commande +tyto show domain. Le domaine est désactivé après sa création. + + + +[DOMAIN] +name = tyto.echolib.re +work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ +activated = True +title = Tyto - Littérateur +date = 2022 +about = Documentation officielle du littérateur libre +tags = Tyto,littérateur,logiciel libre,documentation +mail = echolib+tyto@a-lec.org + +[WEBSITE] +wip_url = https://www-wip.echolib.re/ +www_url = https://tyto.echolib.re/ +css = tyto +separator = | +article_code = True +lang = fr +license = gfdl-1.3 +license_url = https://www.gnu.org/licenses/fdl-1.3.txt + +[WEBSITE_FOOTER] +link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" +link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" +link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" +link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + +[WEBSITE_MODULES] +sidebar_title = Articles recommandés +sidebar_items = 6 +rss_items = 100 +sitemaps = True + +[TEMPLATE_FILENAMES] +favicon = favicon.png +logo = VH_Tyto_logo.png +styles = styles.css +rss = rss.xml +stats = tyto_stats.ini + +[SERVER] +srv_root = /home/echolib/Projets/www/ + +[TYTO] +id = 23ac1f4c +conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini +user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini + +Modifier la configuration + +Le fichier tyto_domain.ini dispose de catégories, comme [WEBSITE], avec +les paramètres clé = valeur. Si vous modifiez une valeur, Tyto vérifiera +et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans +certains cas, il faudra toutes les reconstruire. Si les modifications +concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être +reconstruit. + +Les valeurs importantes + + +[DOMAIN] +# Remplacer par True pour activer +# ou utiliser la commande tyto start / tyto stop +activated = False + +[WEBSITE] +# L'adresse (URL) du site web temporaire (wip) +wip_url = https://www-wip.domaine.tld/ + +# L'adresse (URL) du site officiel (publish) +www_url = https://domaine.tld/ + +# La classe CSS par défaut +css = tyto + +# Le séparateur entre le titre de la page et le titre du site +# dans la balise HTML <title> +separator = - + +# Valeur booléane True/False (Oui/Non) +# Afficher le lien vers le code source de l'article +article_code = False + +# Langue des pages du site +# La traduction doit exister (fournies: en, fr) +lang = fr + +[WEBSITE_MODULES] +# Le nom de la barre latérale +sidebar_title = Articles recommandés + +# Nombre d'articles dans la barre latérale (0 pour désactiver) +sidebar_items = 6 + +# Nombre d'articles dans le flux RSS (0 pour désactiver) +rss_items = 100 + +# Création automatique du sitemap (sitemap.html) +sitemaps = True + +[WEBSITE_FOOTER] +# Les liens du pied de page dans [WEBSITE_FOOTER] +# les clés link_1 à link_4 sont créés automatiquement +# Pour désactiver, enlever la valeur, laisser la clé ! +# Format de clé +# l'URL peut être locale. Ex : "/about/cgu.html" +clé = "Nom à afficher", "URL", "Contenu de title=" + +[TEMPLATE_FILENAMES] +# Nom des fichiers +# (à ajouter dans le dossier .../wip/template/) +favicon = favicon.png +logo = logo.png +styles = styles.css + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/config/index.tyto b/src/usr/share/tyto/docs/www/config/index.tyto new file mode 100644 index 0000000..7392b4c --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.tyto @@ -0,0 +1,192 @@ +title: Créer et configurer un domaine +about: Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur +tags: configuration,domaine +date: 2023-12-05 +authors: echolib + +link: format INI + https://fr.wikipedia.org/wiki/Fichier_INI + Page wikipédia en FR "Fichier INI" + +image: domain-form + tyto_new_domain_form.png + Formulaire lors de la création d'un domaine avec Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + +#1 Créer un domaine +(( + *`Tyto littérateur`* fonctionne dans un dossier ayant l'identité d'un nom de + domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez + le créer, à l'emplacement de votre choix. Ce dossier est votre + +`dossier de travail`+. Seulement une fois ce dossier ouvert (dans un + terminal), vous pouvez lancer la procédure de création du domaine afin de + créer votre nouveau site. +)) + +(( astuce + Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez + créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers + des domaines. +)) + + +#2 Les commandes à taper +{{ + # Commande bash pour créer un dossier du domaine + mkdir -p domaine.tld + + # Se placer dans le dossier créé + cd domaine.tld + + # Créer et configurer le domaine "domaine.tld" + tyto new domain +}} + + +#3 Répondre aux questions +(( + ::domain-form "c=bandeau", + | + Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de + quelques renseignements concernant ce domaine, et notemment : + (= + = le titre du domaine + = la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) + = la description du domaine + = les étiquettes du domaine (séparées par une virugule) + = le courriel de l'administrateur + = la langue du domaine (celle du site web) sur 2 caractères (en, fr...) + = le dossier du serveur root + )= +)) + + +#4 Exemple d'un domaine créé +(( + Une fois toutes les questions répondues, le fichier [`tyto_domain.ini`] est + créé dans le dossier du domaine. Quelques données supplémentaires sont + configurables dans le fichier, qui est au ::format INI. Il est plus que + recommandé de l'ouvrir et de +`vérifier son contenu`+ + *`&_`avant de continuer`_&`*. Vous pouvez le lire avec la commande + {`tyto show domain`}. Le domaine est désactivé après sa création. +)) +{{ + [DOMAIN] + name = tyto.echolib.re + work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ + activated = True + title = Tyto - Littérateur + date = 2022 + about = Documentation officielle du littérateur libre + tags = Tyto,littérateur,logiciel libre,documentation + mail = echolib+tyto@a-lec.org + + [WEBSITE] + wip_url = https://www-wip.echolib.re/ + www_url = https://tyto.echolib.re/ + css = tyto + separator = | + article_code = True + lang = fr + license = gfdl-1.3 + license_url = https://www.gnu.org/licenses/fdl-1.3.txt + + [WEBSITE_FOOTER] + link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" + link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" + link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" + link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + + [WEBSITE_MODULES] + sidebar_title = Articles recommandés + sidebar_items = 6 + rss_items = 100 + sitemaps = True + + [TEMPLATE_FILENAMES] + favicon = favicon.png + logo = VH_Tyto_logo.png + styles = styles.css + rss = rss.xml + stats = tyto_stats.ini + + [SERVER] + srv_root = /home/echolib/Projets/www/ + + [TYTO] + id = 23ac1f4c + conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini + user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini +}} + + +#2 Modifier la configuration +(( + Le fichier [`tyto_domain.ini`] dispose de catégories, comme [WEBSITE], avec + les paramètres {`clé = valeur`}. Si vous modifiez une valeur, Tyto vérifiera + et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans + certains cas, il faudra toutes les reconstruire. Si les modifications + concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être + reconstruit. +)) + + +#3 Les valeurs importantes +{{ + [DOMAIN] + # Remplacer par True pour activer + # ou utiliser la commande tyto start / tyto stop + activated = False + + [WEBSITE] + # L'adresse (URL) du site web temporaire (wip) + wip_url = https://www-wip.domaine.tld/ + + # L'adresse (URL) du site officiel (publish) + www_url = https://domaine.tld/ + + # La classe CSS par défaut + css = tyto + + # Le séparateur entre le titre de la page et le titre du site + # dans la balise HTML + separator = - + + # Valeur booléane True/False (Oui/Non) + # Afficher le lien vers le code source de l'article + article_code = False + + # Langue des pages du site + # La traduction doit exister (fournies: en, fr) + lang = fr + + [WEBSITE_MODULES] + # Le nom de la barre latérale + sidebar_title = Articles recommandés + + # Nombre d'articles dans la barre latérale (0 pour désactiver) + sidebar_items = 6 + + # Nombre d'articles dans le flux RSS (0 pour désactiver) + rss_items = 100 + + # Création automatique du sitemap (sitemap.html) + sitemaps = True + + [WEBSITE_FOOTER] + # Les liens du pied de page dans [WEBSITE_FOOTER] + # les clés link_1 à link_4 sont créés automatiquement + # Pour désactiver, enlever la valeur, laisser la clé ! + # Format de clé + # l'URL peut être locale. Ex : "/about/cgu.html" + clé = "Nom à afficher", "URL", "Contenu de title=" + + [TEMPLATE_FILENAMES] + # Nom des fichiers + # (à ajouter dans le dossier .../wip/template/) + favicon = favicon.png + logo = logo.png + styles = styles.css +}} diff --git a/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png new file mode 100644 index 0000000..07feb3d Binary files /dev/null and b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png differ diff --git a/website_doc/images/logos/format_tyto.png b/src/usr/share/tyto/docs/www/images/logos/format_tyto.png similarity index 100% rename from website_doc/images/logos/format_tyto.png rename to src/usr/share/tyto/docs/www/images/logos/format_tyto.png diff --git a/website_doc/images/logos/justice_scales_cc0.png b/src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png similarity index 100% rename from website_doc/images/logos/justice_scales_cc0.png rename to src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png diff --git a/website_doc/images/logos/tyto_5_metas.png b/src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png similarity index 100% rename from website_doc/images/logos/tyto_5_metas.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png diff --git a/website_doc/images/logos/tyto_titles_toc.png b/src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png similarity index 100% rename from website_doc/images/logos/tyto_titles_toc.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png diff --git a/website_doc/images/logos/tyto_welcome.png b/src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png similarity index 100% rename from website_doc/images/logos/tyto_welcome.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png diff --git a/website_doc/index.html b/src/usr/share/tyto/docs/www/index.html similarity index 88% rename from website_doc/index.html rename to src/usr/share/tyto/docs/www/index.html index 9c129ff..731bd0a 100644 --- a/website_doc/index.html +++ b/src/usr/share/tyto/docs/www/index.html @@ -33,7 +33,7 @@ <meta property="og:image" content="https://tyto.echolib.re/images/logos/tyto_welcome.png"> <!-- Publication date and title --> -<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date"> +<meta itemprop="datePublished" content="2024-01-17 18:19:13" id="date"> <title>Bienvenue, librement (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -71,6 +71,7 @@ par mail ou, de préférence, via Gestion et personnalisation Utilisation Traductions +Pour commencer Le projet @@ -125,6 +126,12 @@ utilisée par le système, mais chaque site peut utiliser l'une ou l'autre, via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. +Pour commencer + +Configurer un domaine +Écrire un article +Configurer les modules + diff --git a/website_doc/index.tyto b/src/usr/share/tyto/docs/www/index.tyto similarity index 86% rename from website_doc/index.tyto rename to src/usr/share/tyto/docs/www/index.tyto index 7a77069..05e8055 100644 --- a/website_doc/index.tyto +++ b/src/usr/share/tyto/docs/www/index.tyto @@ -13,6 +13,18 @@ link: chouette effraie https://fr.wikipedia.org/wiki/Chouette_effraie Tyto alba • Effraie des clochers +link: Configurer un domaine + ./config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: Écrire un article + ./article/index.html + Comment écrire un article pour Tyto - Littérateur + +link: Configurer les modules + ./modules/index.html + Comment gérer les modules (nginx) de Tyto - Littérateur + ! LOGO ------------------------------------------------------------------------------- @@ -87,3 +99,11 @@ link: chouette effraie via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. )) + + +#1 Pour commencer +(= + + ::Configurer un domaine + + ::Écrire un article + + ::Configurer les modules +)= diff --git a/src/usr/share/tyto/docs/www/modules/index.html b/src/usr/share/tyto/docs/www/modules/index.html new file mode 100644 index 0000000..407acd3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Gérer les modules dans les pages (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Gérer les modules dans les pages + + +echolib, 18/12/2023 [Code source] + + +Table des matières + + +Définitions des modules + +Le module "metas" + +Exemple HTML des metas + +Le module "header" + +Exemple HTML d'une entête + +Le module "navbar" + +Exemple HTML d'un menu + +Le module "sidebar" + +Exemple HTML d'une barre latérale + +Le module "footer" + +Exemple HTML de pied de page + + +Forcer une nouvelle génération des modules HTML +Afficher les modules dans les pages avec nginx + + +Définitions des modules + +Tyto - Littérateur intègre dans chaque page du site, différents modules. +Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le +contenu du fichier de configuration du module a changé. Vous pouvez les gérer, +et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" +dans le dossier de travail du domaine. Chaque fichier dispose d'une petite +aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer +la génération d'un module avec la commande tyto wip [module_name] + +Le module "metas" + +Le module "metas", issu du fichier de configuration "metas.raw" insère des +balises HTML <meta>, prioritaires. Les balises utilisées par défaut : + +Exemple HTML des metas + + +<meta charset="UTF-8"> +<meta name="robots" content="all"> +<meta name="medium" content="website"> +<meta name="revisit-after" content="3 days"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> + +Le module "header" + +Le module "header", issu du fichier de configuration "header.raw" insère +l'entête HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Voici un exemple de sa structure HTML et des +identificateurs CSS : + +Exemple HTML d'une entête + + +<a role="link" id="site_link" href="/" title="%s"> +<header id="header"> +<div id="header_logo"> +<img id="header_logo_image" src="%s" alt="%s"> +</div> +<div id="header_abouts"> +<p id="header_title">%s</p> +<p id="header_about">%s</p> +</div> +</header> +</a> + +Le module "navbar" + +Le module "navbar" issu du fichier de configuration "navbar.raw" insère +la barre de manu principale, libellée pour l'accessibilité, "navigation-1". +Son contenu par défaut est vide. + + +Pour ajouter un onglet au menu du site : + +créer un dossier dans le dossier de travail du domaine ".../articles/" +créer un article "index.tyto" dans le nouveau dossier +créer l'article HTML via la commande "wip" +éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + + +Exemple HTML d'un menu + + +<nav id="menu" aria-labelledby="navigation-1"> +<menu role="menu" id="menu_items"> +<li role="menuitem" class="menu_item"> +<a role="link" class="menu_link" href="%s" title="%s">%s</a> +</li> +</menu> +</nav> + +Le module "sidebar" + +Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère +la barre latérale contenant des articles à mettre en avant. Son contenu +par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la +::configuration du domaine. La barre latérale est libéllée pour +l'accessibilité "navigation-2" + + +Pour ajouter un article à la barre latérale : + +créer un article .tyto +créer l'article HTML via la commande "wip" +éditer le fichier sidebar.raw en ajoutant l'URI de l'article (URI depuis le dossier de travail du domaine ".../article/") + + +Exemple HTML d'une barre latérale + + +<aside id="sidebar"> +<div id="sidebar_title">%s</div> +<nav role="navigation" id="sidebar_menu" aria-labelledby="navigation-2"> +<ul role="list" id="sidebar_items"> +<li role="listitem" class="sidebar_item"> +<div class="sidebar_post_title"> +<a role="link" class="sidebar_post_link" href="%s">%s</a> +</div> +<div class="sidebar_post_about"> +<p class="sidebar_post_about_p" title="%s -- %s, %s">%s</p> +</div> +</li> +</ul> +</nav> +</aside> + +Le module "footer" + +Le module "footer" issu du fichier de configuration "footer.raw" insère le +pied de page HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Un menu de navigation, libellé pour +l'accessibilité "navigation-3", est créé automatiquement. + +Exemple HTML de pied de page + + +<footer id="footer"> +<div id="footer_title">%s <strong>%s</strong></div> +<div id="footer_about_menu"> +<div id="footer_about"> +%s +</div> +<nav id="footer_menu" aria-labelledby="navigation-3"> +<ul role="list" id="footer_items"> +<li role="listitem" class="footer_item"> +<a role="link" class="footer_item_link" href="%s" title="%s %s">%s</a> +</li> +</ul> +</nav> +</div> +<div id="footer_credit"> +<p id="footer_copyright">%s</p> +<p id="footer_tyto">%s</p> +</div> +</footer> + +Forcer une nouvelle génération des modules HTML + +Même si un module a déjà été généré, si vous avez besoin de forcer une +nouvelle génération de modules, il suffit de le demander, via l'action "wip". + +Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + + +tyto wip modules # Créer TOUS les modules HTML +tyto wip metas # Créer le module metas.html +tyto wip header # Créer le module header.html +tyto wip navbar # Créer le module navbar.html +tyto wip sidebar # Créer le module sidebar.html +tyto wip footer # Créer le module footer.html + + + +Vous pouvez forcer la création d'un module HTML, mais, si le fichier de +configuration a été modifié, il sera automatiquement mis à jour à la +prochaine création d'un article via la commande "wip". Il faut toutefois +forcer la génération, si une métadonnée indispensable d'un article se +trouvant dans le module, a été modifiée + +Afficher les modules dans les pages avec nginx + +Même si les pages du site sont statiques, les modules doivent être appelés +par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer +le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un +commentaire HTML conttient # include_virtual="". Dans la configuration +du serveur nginx, il faut ajouter : + + + +ssi on; +ssi_last_modified on; +absolute_redirect off; + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/modules/index.tyto b/src/usr/share/tyto/docs/www/modules/index.tyto new file mode 100644 index 0000000..d1ef6d9 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.tyto @@ -0,0 +1,201 @@ +title: Gérer les modules dans les pages +about: Comment gérer les modules (nginx) de Tyto - Littérateur +date: 2023-12-18 +tags: modules,nginx,metas,header,navbar,sidebar,footer +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: métadonnée indispensable + ../article/metas_obligatoires.html + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + + +#1 Définitions des modules +(( + *`Tyto - Littérateur`* intègre dans chaque page du site, différents modules. + Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le + contenu du fichier de configuration du module a changé. Vous pouvez les gérer, + et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" + dans le dossier de travail du domaine. Chaque fichier dispose d'une petite + aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer + la génération d'un module avec la commande {` tyto wip [module_name]`} +)) + +#2 Le module "metas" +(( + Le module "metas", issu du fichier de configuration "metas.raw" insère des + balises HTML {``}, prioritaires. Les balises utilisées par défaut : +)) + +#3 Exemple HTML des metas +{{ + + + + + +}} + + +#2 Le module "header" +(( + Le module "header", issu du fichier de configuration "header.raw" insère + +`l'entête`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Voici un exemple de sa structure HTML et des + identificateurs CSS : +)) + +#3 Exemple HTML d'une entête +{{ + + + + + + + %s + %s + + + +}} + +#2 Le module "navbar" +(( + Le module "navbar" issu du fichier de configuration "navbar.raw" insère + la +`barre de manu`+ principale, libellée pour l'accessibilité, "navigation-1". + Son contenu par défaut est vide. +)) +(( + Pour ajouter un onglet au menu du site : + (= + = créer un dossier dans le dossier de travail du domaine ".../articles/" + = créer un article "index.tyto" dans le nouveau dossier + = créer l'article HTML via la commande "wip" + = éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + )= +)) + +#3 Exemple HTML d'un menu +{{ + + + + %s + + + +}} + +#2 Le module "sidebar" +(( + Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère + la /`barre latérale`/ contenant des articles à mettre en avant. Son contenu + par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la + ::configuration du domaine. La barre latérale est libéllée pour + l'accessibilité "navigation-2" +)) +(( + Pour ajouter un article à la barre latérale : + (= + = créer un article .tyto + = créer l'article HTML via la commande "wip" + = éditer le fichier sidebar.raw en ajoutant l'URI de l'article + (URI depuis le dossier de travail du domaine ".../article/") + )= +)) + +#3 Exemple HTML d'une barre latérale +{{ + +}} + +#2 Le module "footer" +(( + Le module "footer" issu du fichier de configuration "footer.raw" insère le + +`pied de page`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Un menu de navigation, libellé pour + l'accessibilité "navigation-3", est créé automatiquement. +)) + +#3 Exemple HTML de pied de page +{{ + +}} + + +#1 Forcer une nouvelle génération des modules HTML +(( + Même si un module a déjà été généré, si vous avez besoin de forcer une + nouvelle génération de modules, il suffit de le demander, via l'action "wip". + | + Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + {{ + tyto wip modules # Créer TOUS les modules HTML + tyto wip metas # Créer le module metas.html + tyto wip header # Créer le module header.html + tyto wip navbar # Créer le module navbar.html + tyto wip sidebar # Créer le module sidebar.html + tyto wip footer # Créer le module footer.html + }} +)) +(( note + Vous pouvez forcer la création d'un module HTML, mais, si le fichier de + configuration a été modifié, il sera automatiquement mis à jour à la + prochaine création d'un article via la commande "wip". Il faut toutefois + forcer la génération, si une ::métadonnée indispensable d'un article se + trouvant dans le module, a été modifiée +)) + + +#1 Afficher les modules dans les pages avec nginx +(( + Même si les pages du site sont statiques, les modules doivent être appelés + par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer + le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un + commentaire HTML conttient {`# include_virtual=""`}. Dans la configuration + du serveur nginx, il faut ajouter : +)) +{{ + ssi on; + ssi_last_modified on; + absolute_redirect off; +}} diff --git a/website_doc/rss.xml b/src/usr/share/tyto/docs/www/rss.xml similarity index 59% rename from website_doc/rss.xml rename to src/usr/share/tyto/docs/www/rss.xml index 5e29d80..1f764ae 100644 --- a/website_doc/rss.xml +++ b/src/usr/share/tyto/docs/www/rss.xml @@ -3,7 +3,7 @@ - + @@ -20,118 +20,13 @@ fr Tyto,littérateur,logiciel libre,documentation - Mon, 15 Jan 2024 18:28:34 + Wed, 17 Jan 2024 18:19:13 gfdl-1.3 echolib+tyto@a-lec.org Tyto - Littérateur - - Écrire les titres et sous-titres - https://tyto.echolib.re/article/redac_titres.html - https://tyto.echolib.re/article/redac_titres.html - Sun, 07 Jan 2024 - Comment écrire les titres et les sous-titres pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_titles_toc.png - Écrire les titres et sous-titres (logo) - https://tyto.echolib.re/article/redac_titres.html - - format .tyto,écrire,rédaction,titres,table des matières - - - - Mentions Légales - https://tyto.echolib.re/a-propos/index.html - https://tyto.echolib.re/a-propos/index.html - Sun, 14 Jan 2024 - Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/justice_scales_cc0.png - Mentions Légales (logo) - https://tyto.echolib.re/a-propos/index.html - - mentions légales,C.G.U,licence - - - - Écrire un article au format .tyto - https://tyto.echolib.re/article/index.html - https://tyto.echolib.re/article/index.html - Sat, 06 Jan 2024 - Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/format_tyto.png - Écrire un article au format .tyto (logo) - https://tyto.echolib.re/article/index.html - - format .tyto,écrire, - - - - Écrire les métadonnées indispensables - https://tyto.echolib.re/article/metas_obligatoires.html - https://tyto.echolib.re/article/metas_obligatoires.html - Sat, 06 Jan 2024 - Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_5_metas.png - Écrire les métadonnées indispensables (logo) - https://tyto.echolib.re/article/metas_obligatoires.html - - format .tyto,écrire,métadonnées,entête - - - - Les URIs spécifiques - https://tyto.echolib.re/article/metas_uris.html - https://tyto.echolib.re/article/metas_uris.html - Mon, 08 Jan 2024 - Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Les URIs spécifiques (logo) - https://tyto.echolib.re/article/metas_uris.html - - format .tyto,écrire,liens,URIs - - - - Écrire/créer des liens - https://tyto.echolib.re/article/metas_liens.html - https://tyto.echolib.re/article/metas_liens.html - Mon, 08 Jan 2024 - Comment écrire des liens pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Écrire/créer des liens (logo) - https://tyto.echolib.re/article/metas_liens.html - - format .tyto,écrire,liens - - - - Page non trouvée - https://tyto.echolib.re/404.html - https://tyto.echolib.re/404.html - Sat, 13 Jan 2024 - Page d'erreur 404, indiquant que la page demandée n'existe pas/plus - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Page non trouvée (logo) - https://tyto.echolib.re/404.html - - 404,erreur - - Bienvenue, librement https://tyto.echolib.re/index.html @@ -146,6 +41,171 @@ accueil,projet,description + + + Afficher du code en bloc + https://tyto.echolib.re/article/redac_blockcodes.html + https://tyto.echolib.re/article/redac_blockcodes.html + Tue, 16 Jan 2024 + Comment afficher du code en bloc pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher du code en bloc (logo) + https://tyto.echolib.re/article/redac_blockcodes.html + + rédaction,marqueurs,blockcode + + + + Les URIs spécifiques + https://tyto.echolib.re/article/metas_uris.html + https://tyto.echolib.re/article/metas_uris.html + Mon, 08 Jan 2024 + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Les URIs spécifiques (logo) + https://tyto.echolib.re/article/metas_uris.html + + format .tyto,écrire,liens,URIs + + + + Créer des liens + https://tyto.echolib.re/article/metas_liens.html + https://tyto.echolib.re/article/metas_liens.html + Mon, 08 Jan 2024 + Comment écrire des liens pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer des liens (logo) + https://tyto.echolib.re/article/metas_liens.html + + format .tyto,écrire,liens + + + + Écrire les métadonnées indispensables + https://tyto.echolib.re/article/metas_obligatoires.html + https://tyto.echolib.re/article/metas_obligatoires.html + Sat, 06 Jan 2024 + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_5_metas.png + Écrire les métadonnées indispensables (logo) + https://tyto.echolib.re/article/metas_obligatoires.html + + format .tyto,écrire,métadonnées,entête + + + + Écrire des paragraphes + https://tyto.echolib.re/article/redac_paragraphes.html + https://tyto.echolib.re/article/redac_paragraphes.html + Tue, 05 Dec 2023 + Comment écrire des paragraphes pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Écrire des paragraphes (logo) + https://tyto.echolib.re/article/redac_paragraphes.html + + rédaction,marqueurs,paragraphes + + + + Mentions Légales + https://tyto.echolib.re/a-propos/index.html + https://tyto.echolib.re/a-propos/index.html + Sun, 14 Jan 2024 + Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/justice_scales_cc0.png + Mentions Légales (logo) + https://tyto.echolib.re/a-propos/index.html + + mentions légales,C.G.U,licence + + + + Écrire des titres et sous-titres + https://tyto.echolib.re/article/redac_titres.html + https://tyto.echolib.re/article/redac_titres.html + Sun, 07 Jan 2024 + Comment écrire les titres et les sous-titres pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_titles_toc.png + Écrire des titres et sous-titres (logo) + https://tyto.echolib.re/article/redac_titres.html + + rédaction,marqueurs,titres,table des matières + + + + Écrire un article au format .tyto + https://tyto.echolib.re/article/index.html + https://tyto.echolib.re/article/index.html + Sat, 06 Jan 2024 + Comment écrire un article pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/format_tyto.png + Écrire un article au format .tyto (logo) + https://tyto.echolib.re/article/index.html + + format .tyto,écrire, + + + + Afficher des images + https://tyto.echolib.re/article/mere_images.html + https://tyto.echolib.re/article/mere_images.html + Tue, 05 Dec 2023 + Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher des images (logo) + https://tyto.echolib.re/article/mere_images.html + + marqueurs,images + + + + Gérer les modules dans les pages + https://tyto.echolib.re/modules/index.html + https://tyto.echolib.re/modules/index.html + Mon, 18 Dec 2023 + Comment gérer les modules (nginx) de Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Gérer les modules dans les pages (logo) + https://tyto.echolib.re/modules/index.html + + modules,nginx,metas,header,navbar,sidebar,footer + + + + Créer et configurer un domaine + https://tyto.echolib.re/config/index.html + https://tyto.echolib.re/config/index.html + Tue, 05 Dec 2023 + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer et configurer un domaine (logo) + https://tyto.echolib.re/config/index.html + + configuration,domaine + diff --git a/src/usr/share/tyto/docs/www/sitemap.html b/src/usr/share/tyto/docs/www/sitemap.html new file mode 100644 index 0000000..af9f55b --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.html @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Plan du site (Tyto) | Tyto - Littérateur + + + + + + + + + + + + + + + +Plan du site + + +Tyto, 17/01/2024 [Code source] + + +Liste des articles (12) + + +Bienvenue, librement +Afficher du code en bloc +Les URIs spécifiques +Créer des liens +Écrire les métadonnées indispensables +Écrire des paragraphes +Mentions Légales +Écrire des titres et sous-titres +Écrire un article au format .tyto +Afficher des images +Gérer les modules dans les pages +Créer et configurer un domaine + + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/sitemap.tyto b/src/usr/share/tyto/docs/www/sitemap.tyto new file mode 100644 index 0000000..273605e --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.tyto @@ -0,0 +1,29 @@ +# Tyto - Littérateur +! NOMAP +! NORSS + +title: Plan du site +about: Plan du site généré par Tyto - Littérateur +tags: Plan du site +authors: Tyto +date: 2024-01-17 + +----- +#1 Liste des articles (12) + +(( sitemap + (= sitemap_items + + Bienvenue, librement + + Afficher du code en bloc + + Les URIs spécifiques + + Créer des liens + + Écrire les métadonnées indispensables + + Écrire des paragraphes + + Mentions Légales + + Écrire des titres et sous-titres + + Écrire un article au format .tyto + + Afficher des images + + Gérer les modules dans les pages + + Créer et configurer un domaine + )= +)) diff --git a/website_doc/template/VH_Tyto_logo.png b/src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png similarity index 100% rename from website_doc/template/VH_Tyto_logo.png rename to src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png diff --git a/website_doc/template/favicon.png b/src/usr/share/tyto/docs/www/template/favicon.png similarity index 100% rename from website_doc/template/favicon.png rename to src/usr/share/tyto/docs/www/template/favicon.png diff --git a/website_doc/template/footer.html b/src/usr/share/tyto/docs/www/template/footer.html similarity index 96% rename from website_doc/template/footer.html rename to src/usr/share/tyto/docs/www/template/footer.html index b327fae..4090a32 100644 --- a/website_doc/template/footer.html +++ b/src/usr/share/tyto/docs/www/template/footer.html @@ -12,7 +12,7 @@ en Python par Cyrille Louarn (echol Le code source est composé (hors fichiers de traductions) de 18 fichiers -totalisant 5048 lignes dont 1231 lignes commentées, soit 2851 lignes de scripts. +totalisant 5051 lignes dont 1231 lignes commentées, soit 2853 lignes de scripts. Tyto - Littérateur (version 1.11.4) est fait avec amour <3 diff --git a/website_doc/template/header.html b/src/usr/share/tyto/docs/www/template/header.html similarity index 100% rename from website_doc/template/header.html rename to src/usr/share/tyto/docs/www/template/header.html diff --git a/website_doc/template/metas.html b/src/usr/share/tyto/docs/www/template/metas.html similarity index 100% rename from website_doc/template/metas.html rename to src/usr/share/tyto/docs/www/template/metas.html diff --git a/src/usr/share/tyto/docs/www/template/navbar.html b/src/usr/share/tyto/docs/www/template/navbar.html new file mode 100644 index 0000000..bbfa1d0 --- /dev/null +++ b/src/usr/share/tyto/docs/www/template/navbar.html @@ -0,0 +1,9 @@ + + + +config +article +modules +publier + + diff --git a/website_doc/template/sidebar.html b/src/usr/share/tyto/docs/www/template/sidebar.html similarity index 100% rename from website_doc/template/sidebar.html rename to src/usr/share/tyto/docs/www/template/sidebar.html diff --git a/website_doc/template/styles.css b/src/usr/share/tyto/docs/www/template/styles.css similarity index 99% rename from website_doc/template/styles.css rename to src/usr/share/tyto/docs/www/template/styles.css index 0818419..f4e1d69 100644 --- a/website_doc/template/styles.css +++ b/src/usr/share/tyto/docs/www/template/styles.css @@ -166,6 +166,10 @@ h6.tyto { font-size: 1.2rem; } +img.bandeau { + max-width: 100% +} + p.alert { color: #FFFDA5; font-weight: bold; @@ -254,6 +258,7 @@ ul.tyto :is(ol, ul) { footer#footer { border-top: 2px dotted gray; color: #FFF; + margin-top: 40px; } div#footer_title { diff --git a/website_doc/sitemap.html b/website_doc/sitemap.html deleted file mode 100644 index c643e3a..0000000 --- a/website_doc/sitemap.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plan du site (Tyto) | Tyto - Littérateur - - - - - - - - - - - - - - - -Plan du site - - -Tyto, 15/01/2024 [Code source] - - -Liste des articles (8) - - -Écrire les titres et sous-titres -Mentions Légales -Écrire un article au format .tyto -Écrire les métadonnées indispensables -Les URIs spécifiques -Écrire/créer des liens -Page non trouvée -Bienvenue, librement - - - - - - - - - - - - - - - - diff --git a/website_doc/sitemap.tyto b/website_doc/sitemap.tyto deleted file mode 100644 index 6099374..0000000 --- a/website_doc/sitemap.tyto +++ /dev/null @@ -1,25 +0,0 @@ -# Tyto - Littérateur -! NOMAP -! NORSS - -title: Plan du site -about: Plan du site généré par Tyto - Littérateur -tags: Plan du site -authors: Tyto -date: 2024-01-15 - ------ -#1 Liste des articles (8) - -(( sitemap - (= sitemap_items - + Écrire les titres et sous-titres - + Mentions Légales - + Écrire un article au format .tyto - + Écrire les métadonnées indispensables - + Les URIs spécifiques - + Écrire/créer des liens - + Page non trouvée - + Bienvenue, librement - )= -)) diff --git a/website_doc/template/navbar.html b/website_doc/template/navbar.html deleted file mode 100644 index 3a46f7b..0000000 --- a/website_doc/template/navbar.html +++ /dev/null @@ -1,6 +0,0 @@ - - - -article - -
- + diff --git a/website_doc/a-propos/index.tyto b/src/usr/share/tyto/docs/www/a-propos/index.tyto similarity index 100% rename from website_doc/a-propos/index.tyto rename to src/usr/share/tyto/docs/www/a-propos/index.tyto diff --git a/website_doc/article/index.html b/src/usr/share/tyto/docs/www/article/index.html similarity index 73% rename from website_doc/article/index.html rename to src/usr/share/tyto/docs/www/article/index.html index aa07137..741abd0 100644 --- a/website_doc/article/index.html +++ b/src/usr/share/tyto/docs/www/article/index.html @@ -15,7 +15,7 @@ - + @@ -29,11 +29,11 @@ - + - + Écrire un article au format .tyto (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -64,13 +64,12 @@ echolib, 06/01/2024 [Le séparateur ? Dans l'entête -Les métadonnées indispensables -Les métadonnées optionnelles -Les marqueurs de gestion +Les métadonnées optionnelles +Les marqueurs de gestion -Dans la rédaction +Dans la rédaction -Rappel +Rappel Le format ".tyto" ? @@ -80,7 +79,9 @@ textuel brut en page HTML5, il faut utiliser des marqueurs, et respecter une 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 ----- @@ -97,49 +98,47 @@ marqueurs dédiés au formattge des textes. 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 -Les métadonnées indispensables +Les métadonnées optionnelles -Les métadonnées indispensables ont des marqueurs uniques qui doivent être -configurés sur une seule ligne. - -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 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 ::. -Écrire/créer des liens +Créer des liens Les URIs spécifiques -Les marqueurs de gestion +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 ! LOGO : Montre le logo de l'article près de son titre -Dans la rédaction +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 -Rappel +Rappel 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 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher des images (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher des images + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Le marqueur d'image dans l'entête + +Exemples de configurations +Paramètres du marqueur d'entête + +Première ligne +Seconde ligne +Troisième ligne + + +Le marqueur d'appel dans la rédaction + +Paramètres optionels du marqueur d'appel +Exemples d'appels + +Rappels + +Exemple final + + + +Le marqueur d'image dans l'entête + +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. + +Exemples de configurations + + +# 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 + +Paramètres du marqueur d'entête +Première ligne + +L'identité du marqueur. image: UniqueID. L'image doit avoir une +identité unique (y compris des autres marqueurs d'entête). + +Seconde ligne + +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 + + +Troisième ligne + +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. + +Le marqueur d'appel dans la rédaction + +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). + +Paramètres optionels du marqueur d'appel + +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. + +Exemples d'appels + + +... +::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" + + +Rappels + +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". + +Exemple final + + +# 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", + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/mere_images.tyto b/src/usr/share/tyto/docs/www/article/mere_images.tyto new file mode 100644 index 0000000..0d03b6a --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/mere_images.tyto @@ -0,0 +1,139 @@ +title: Afficher des images +about: Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur +tags: marqueurs,images +date: 2023-12-05 +authors: echolib + +link: les URIs spécifiques + ./metas_uris.html + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- + +! TOC + +#1 Le marqueur d'image dans l'entête +(( + 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. +)) + +#2 Exemples de configurations +{{ + # 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 +}} + + +#2 Paramètres du marqueur d'entête +#3 Première ligne +(( + L'identité du marqueur. {` image: UniqueID `}. L'image doit avoir une + identité unique (y compris des autres marqueurs d'entête). +)) +#3 Seconde ligne +(( + 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 + )= +)) +#3 Troisième ligne +(( + Texte alternatif. le texte décrivant l'image. Ce texte est utilisé dans la + balise HTML {` `} et permet de rendre l'image plus + accessible. +)) + + +#1 Le marqueur d'appel dans la rédaction +(( + 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 {` `} en HTML) sur une nouvelle + ligne, les images pourraient être affichées les unes à côté des autres ; + (>`rappel: voir Rappel`<). +)) + + +#2 Paramètres optionels du marqueur d'appel +(( + 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 {` ... `}) + )= +)) +(( + 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. +)) + +#2 Exemples d'appels +{{ + ... + ::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" +}} + + +-> rappel +#1 Rappels +(( + 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 + {` `} (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". +)) + +#2 Exemple final +{{ + # 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", +}} + diff --git a/website_doc/article/metas_liens.html b/src/usr/share/tyto/docs/www/article/metas_liens.html similarity index 92% rename from website_doc/article/metas_liens.html rename to src/usr/share/tyto/docs/www/article/metas_liens.html index bffb72f..6f5b5ea 100644 --- a/website_doc/article/metas_liens.html +++ b/src/usr/share/tyto/docs/www/article/metas_liens.html @@ -1,4 +1,4 @@ - + @@ -13,7 +13,7 @@ - + @@ -26,15 +26,15 @@ - + - -Écrire/créer des liens (echolib) | Tyto - Littérateur + +Créer des liens (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + -Écrire/créer des liens +Créer des liens -echolib, 08/01/2024 [Code source] +echolib, 08/01/2024 [Code source] Table des matières diff --git a/website_doc/article/metas_liens.tyto b/src/usr/share/tyto/docs/www/article/metas_liens.tyto similarity index 98% rename from website_doc/article/metas_liens.tyto rename to src/usr/share/tyto/docs/www/article/metas_liens.tyto index 32b2df7..8c6e4b7 100644 --- a/website_doc/article/metas_liens.tyto +++ b/src/usr/share/tyto/docs/www/article/metas_liens.tyto @@ -1,4 +1,4 @@ -title: Écrire/créer des liens +title: Créer des liens about: Comment écrire des liens pour Tyto - Littérateur date: 2024-01-08 tags: format .tyto,écrire,liens diff --git a/website_doc/article/metas_obligatoires.html b/src/usr/share/tyto/docs/www/article/metas_obligatoires.html similarity index 98% rename from website_doc/article/metas_obligatoires.html rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.html index 6aad0bc..68e1c35 100644 --- a/website_doc/article/metas_obligatoires.html +++ b/src/usr/share/tyto/docs/www/article/metas_obligatoires.html @@ -33,7 +33,7 @@ - + Écrire les métadonnées indispensables (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_obligatoires.tyto b/src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto similarity index 100% rename from website_doc/article/metas_obligatoires.tyto rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto diff --git a/website_doc/article/metas_uris.html b/src/usr/share/tyto/docs/www/article/metas_uris.html similarity index 98% rename from website_doc/article/metas_uris.html rename to src/usr/share/tyto/docs/www/article/metas_uris.html index a0fe4dd..05226a4 100644 --- a/website_doc/article/metas_uris.html +++ b/src/usr/share/tyto/docs/www/article/metas_uris.html @@ -33,7 +33,7 @@ - + Les URIs spécifiques (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_uris.tyto b/src/usr/share/tyto/docs/www/article/metas_uris.tyto similarity index 100% rename from website_doc/article/metas_uris.tyto rename to src/usr/share/tyto/docs/www/article/metas_uris.tyto diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.html b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html new file mode 100644 index 0000000..84532f3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html @@ -0,0 +1,143 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher du code en bloc (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher du code en bloc + + +echolib, 16/01/2024 [Code source] + + +Table des matières + + +Les marqueurs +Exemples de code en bloc + +Sortie HTML + + + +Les marqueurs + +Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture +{{ et de fermeture }}, et placer les lignes de codes dedans. +Il est recommandé d'indenter les lignes de codes dans le bloc. Tyto +prend en compte l'indentation de la première ligne de code pour l'affichage +HTML. + + +Les marqueurs d'ouverture et de fermeture doivent se trouver au +même niveau d'indentation dans l'article source, et sonts seuls sur une +ligne + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est "bcode". La classe est reprise dans les balises HTML. +Voir ci-dessous la sortie HTML des exemples suivants. + +Exemples de code en bloc + + +# Comment afficher du code pour Tyto - Littérateur +{{ + Placer du code ici + et encore là... +}} + + + +{{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) +}} + +Sortie HTML + + +<pre class="bcode_pre"> +<ol class="bcode_items"> +<li role="listitem" class="bcode_item"><code class="bcode_code"># Comment afficher du code pour Tyto - Littérateur</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">{{</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> Placer du code ici</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> et encore là...</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">}}</code></li> +</ol> +</pre> +<pre class="MonCode_pre"> +<ol class="MonCode_items"> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">{{ MonCode</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # ! Aucune propriété de style MonCode existe</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # dans styles.css. Affichage par défaut</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> def tyto_code(hello):</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> if hello:</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> print(hello)</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">}}</code></li> +</ol> +</pre> + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto new file mode 100644 index 0000000..25c3e9b --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto @@ -0,0 +1,71 @@ +title: Afficher du code en bloc +about: Comment afficher du code en bloc pour Tyto - Littérateur +tags: rédaction,marqueurs,blockcode +date: 2024-01-16 +authors: echolib + +------------------------------------------------------------------------------- +! TOC + +#1 Les marqueurs +(( + Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture + {` {{ `} et de fermeture {` }} `}, et placer les lignes de codes dedans. + Il est recommandé d'indenter les lignes de codes dans le bloc. :`Tyto`: + prend en compte l'indentation de la première ligne de code pour l'affichage + HTML. +)) +(( + Les marqueurs d'ouverture et de fermeture doivent se trouver *`au + même niveau d'indentation`* dans l'article source, et *`sonts seuls sur une + ligne`* +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est "bcode". La classe est reprise dans les balises HTML. + Voir ci-dessous la sortie HTML des exemples suivants. +)) + + +#1 Exemples de code en bloc +{{ + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} +}} + +{{ MonCode + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} +}} + +#2 Sortie HTML +{{ + + + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} + + + + + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} + + +}} diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.html b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html new file mode 100644 index 0000000..2dc55da --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html @@ -0,0 +1,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Écrire des paragraphes (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Écrire des paragraphes + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Les marqueurs + +Exemple de paragraphes + + + +Les marqueurs + +Les marqueurs de paragraphes forment un bloc. Pour écrire des +paragraphes <p></p> en HTML, et même les imbriquer, il faut écrire du +texte entre les marqueurs d'ouverture ((, et de fermeture )). +Ces marqueurs doivent être placés seuls au début d'une ligne. + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est celle dans la configuration du domaine. + + +Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, +indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. + +Exemple de paragraphes + + +(( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) +)) + +(( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B +)) + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto new file mode 100644 index 0000000..440f016 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto @@ -0,0 +1,49 @@ +title: Écrire des paragraphes +about: Comment écrire des paragraphes pour Tyto - Littérateur +tags: rédaction,marqueurs,paragraphes +date: 2023-12-05 +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- +! TOC + + +#1 Les marqueurs +(( + Les *`marqueurs de paragraphes`* forment un bloc. Pour écrire des + paragraphes {` `} en HTML, et même les imbriquer, il faut écrire du + texte entre les marqueurs d'ouverture {` (( `}, et de fermeture {` )) `}. + Ces marqueurs doivent être placés +`seuls au début d'une ligne`+. +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est celle dans la ::configuration du domaine. +)) +(( astuce + Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, + indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. +)) + + +#2 Exemple de paragraphes +{{ + (( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) + )) + + (( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B + )) +}} diff --git a/website_doc/article/redac_titres.html b/src/usr/share/tyto/docs/www/article/redac_titres.html similarity index 87% rename from website_doc/article/redac_titres.html rename to src/usr/share/tyto/docs/www/article/redac_titres.html index 56957f1..17e22f9 100644 --- a/website_doc/article/redac_titres.html +++ b/src/usr/share/tyto/docs/www/article/redac_titres.html @@ -1,4 +1,4 @@ - + @@ -13,10 +13,10 @@ - + - + @@ -26,15 +26,15 @@ - + - -Écrire les titres et sous-titres (echolib) | Tyto - Littérateur + +Écrire des titres et sous-titres (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + - + -Écrire les titres et sous-titres +Écrire des titres et sous-titres -echolib, 07/01/2024 [Code source] +echolib, 07/01/2024 [Code source] Table des matières diff --git a/website_doc/article/redac_titres.tyto b/src/usr/share/tyto/docs/www/article/redac_titres.tyto similarity index 93% rename from website_doc/article/redac_titres.tyto rename to src/usr/share/tyto/docs/www/article/redac_titres.tyto index 49ad6a1..339b4ff 100644 --- a/website_doc/article/redac_titres.tyto +++ b/src/usr/share/tyto/docs/www/article/redac_titres.tyto @@ -1,7 +1,7 @@ -title: Écrire les titres et sous-titres +title: Écrire des titres et sous-titres about: Comment écrire les titres et les sous-titres pour Tyto - Littérateur date: 2024-01-07 -tags: format .tyto,écrire,rédaction,titres,table des matières +tags: rédaction,marqueurs,titres,table des matières authors: echolib logo: @logos/tyto_titles_toc.png diff --git a/src/usr/share/tyto/docs/www/config/index.html b/src/usr/share/tyto/docs/www/config/index.html new file mode 100644 index 0000000..076ec9e --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Créer et configurer un domaine (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Créer et configurer un domaine + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Créer un domaine + +Les commandes à taper + +Répondre aux questions + +Exemple d'un domaine créé + + +Modifier la configuration + +Les valeurs importantes + + + + +Créer un domaine + +Tyto littérateur fonctionne dans un dossier ayant l'identité d'un nom de +domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez +le créer, à l'emplacement de votre choix. Ce dossier est votre +dossier de travail. Seulement une fois ce dossier ouvert (dans un +terminal), vous pouvez lancer la procédure de création du domaine afin de +créer votre nouveau site. + + +Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez +créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers +des domaines. + +Les commandes à taper + + +# Commande bash pour créer un dossier du domaine +mkdir -p domaine.tld + +# Se placer dans le dossier créé +cd domaine.tld + +# Créer et configurer le domaine "domaine.tld" +tyto new domain + +Répondre aux questions + + + +Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de +quelques renseignements concernant ce domaine, et notemment : + +le titre du domaine +la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) +la description du domaine +les étiquettes du domaine (séparées par une virugule) +le courriel de l'administrateur +la langue du domaine (celle du site web) sur 2 caractères (en, fr...) +le dossier du serveur root + + +Exemple d'un domaine créé + +Une fois toutes les questions répondues, le fichier tyto_domain.ini est +créé dans le dossier du domaine. Quelques données supplémentaires sont +configurables dans le fichier, qui est au format INI. Il est plus que +recommandé de l'ouvrir et de vérifier son contenu +avant de continuer. Vous pouvez le lire avec la commande +tyto show domain. Le domaine est désactivé après sa création. + + + +[DOMAIN] +name = tyto.echolib.re +work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ +activated = True +title = Tyto - Littérateur +date = 2022 +about = Documentation officielle du littérateur libre +tags = Tyto,littérateur,logiciel libre,documentation +mail = echolib+tyto@a-lec.org + +[WEBSITE] +wip_url = https://www-wip.echolib.re/ +www_url = https://tyto.echolib.re/ +css = tyto +separator = | +article_code = True +lang = fr +license = gfdl-1.3 +license_url = https://www.gnu.org/licenses/fdl-1.3.txt + +[WEBSITE_FOOTER] +link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" +link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" +link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" +link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + +[WEBSITE_MODULES] +sidebar_title = Articles recommandés +sidebar_items = 6 +rss_items = 100 +sitemaps = True + +[TEMPLATE_FILENAMES] +favicon = favicon.png +logo = VH_Tyto_logo.png +styles = styles.css +rss = rss.xml +stats = tyto_stats.ini + +[SERVER] +srv_root = /home/echolib/Projets/www/ + +[TYTO] +id = 23ac1f4c +conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini +user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini + +Modifier la configuration + +Le fichier tyto_domain.ini dispose de catégories, comme [WEBSITE], avec +les paramètres clé = valeur. Si vous modifiez une valeur, Tyto vérifiera +et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans +certains cas, il faudra toutes les reconstruire. Si les modifications +concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être +reconstruit. + +Les valeurs importantes + + +[DOMAIN] +# Remplacer par True pour activer +# ou utiliser la commande tyto start / tyto stop +activated = False + +[WEBSITE] +# L'adresse (URL) du site web temporaire (wip) +wip_url = https://www-wip.domaine.tld/ + +# L'adresse (URL) du site officiel (publish) +www_url = https://domaine.tld/ + +# La classe CSS par défaut +css = tyto + +# Le séparateur entre le titre de la page et le titre du site +# dans la balise HTML <title> +separator = - + +# Valeur booléane True/False (Oui/Non) +# Afficher le lien vers le code source de l'article +article_code = False + +# Langue des pages du site +# La traduction doit exister (fournies: en, fr) +lang = fr + +[WEBSITE_MODULES] +# Le nom de la barre latérale +sidebar_title = Articles recommandés + +# Nombre d'articles dans la barre latérale (0 pour désactiver) +sidebar_items = 6 + +# Nombre d'articles dans le flux RSS (0 pour désactiver) +rss_items = 100 + +# Création automatique du sitemap (sitemap.html) +sitemaps = True + +[WEBSITE_FOOTER] +# Les liens du pied de page dans [WEBSITE_FOOTER] +# les clés link_1 à link_4 sont créés automatiquement +# Pour désactiver, enlever la valeur, laisser la clé ! +# Format de clé +# l'URL peut être locale. Ex : "/about/cgu.html" +clé = "Nom à afficher", "URL", "Contenu de title=" + +[TEMPLATE_FILENAMES] +# Nom des fichiers +# (à ajouter dans le dossier .../wip/template/) +favicon = favicon.png +logo = logo.png +styles = styles.css + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/config/index.tyto b/src/usr/share/tyto/docs/www/config/index.tyto new file mode 100644 index 0000000..7392b4c --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.tyto @@ -0,0 +1,192 @@ +title: Créer et configurer un domaine +about: Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur +tags: configuration,domaine +date: 2023-12-05 +authors: echolib + +link: format INI + https://fr.wikipedia.org/wiki/Fichier_INI + Page wikipédia en FR "Fichier INI" + +image: domain-form + tyto_new_domain_form.png + Formulaire lors de la création d'un domaine avec Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + +#1 Créer un domaine +(( + *`Tyto littérateur`* fonctionne dans un dossier ayant l'identité d'un nom de + domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez + le créer, à l'emplacement de votre choix. Ce dossier est votre + +`dossier de travail`+. Seulement une fois ce dossier ouvert (dans un + terminal), vous pouvez lancer la procédure de création du domaine afin de + créer votre nouveau site. +)) + +(( astuce + Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez + créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers + des domaines. +)) + + +#2 Les commandes à taper +{{ + # Commande bash pour créer un dossier du domaine + mkdir -p domaine.tld + + # Se placer dans le dossier créé + cd domaine.tld + + # Créer et configurer le domaine "domaine.tld" + tyto new domain +}} + + +#3 Répondre aux questions +(( + ::domain-form "c=bandeau", + | + Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de + quelques renseignements concernant ce domaine, et notemment : + (= + = le titre du domaine + = la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) + = la description du domaine + = les étiquettes du domaine (séparées par une virugule) + = le courriel de l'administrateur + = la langue du domaine (celle du site web) sur 2 caractères (en, fr...) + = le dossier du serveur root + )= +)) + + +#4 Exemple d'un domaine créé +(( + Une fois toutes les questions répondues, le fichier [`tyto_domain.ini`] est + créé dans le dossier du domaine. Quelques données supplémentaires sont + configurables dans le fichier, qui est au ::format INI. Il est plus que + recommandé de l'ouvrir et de +`vérifier son contenu`+ + *`&_`avant de continuer`_&`*. Vous pouvez le lire avec la commande + {`tyto show domain`}. Le domaine est désactivé après sa création. +)) +{{ + [DOMAIN] + name = tyto.echolib.re + work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ + activated = True + title = Tyto - Littérateur + date = 2022 + about = Documentation officielle du littérateur libre + tags = Tyto,littérateur,logiciel libre,documentation + mail = echolib+tyto@a-lec.org + + [WEBSITE] + wip_url = https://www-wip.echolib.re/ + www_url = https://tyto.echolib.re/ + css = tyto + separator = | + article_code = True + lang = fr + license = gfdl-1.3 + license_url = https://www.gnu.org/licenses/fdl-1.3.txt + + [WEBSITE_FOOTER] + link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" + link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" + link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" + link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + + [WEBSITE_MODULES] + sidebar_title = Articles recommandés + sidebar_items = 6 + rss_items = 100 + sitemaps = True + + [TEMPLATE_FILENAMES] + favicon = favicon.png + logo = VH_Tyto_logo.png + styles = styles.css + rss = rss.xml + stats = tyto_stats.ini + + [SERVER] + srv_root = /home/echolib/Projets/www/ + + [TYTO] + id = 23ac1f4c + conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini + user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini +}} + + +#2 Modifier la configuration +(( + Le fichier [`tyto_domain.ini`] dispose de catégories, comme [WEBSITE], avec + les paramètres {`clé = valeur`}. Si vous modifiez une valeur, Tyto vérifiera + et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans + certains cas, il faudra toutes les reconstruire. Si les modifications + concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être + reconstruit. +)) + + +#3 Les valeurs importantes +{{ + [DOMAIN] + # Remplacer par True pour activer + # ou utiliser la commande tyto start / tyto stop + activated = False + + [WEBSITE] + # L'adresse (URL) du site web temporaire (wip) + wip_url = https://www-wip.domaine.tld/ + + # L'adresse (URL) du site officiel (publish) + www_url = https://domaine.tld/ + + # La classe CSS par défaut + css = tyto + + # Le séparateur entre le titre de la page et le titre du site + # dans la balise HTML + separator = - + + # Valeur booléane True/False (Oui/Non) + # Afficher le lien vers le code source de l'article + article_code = False + + # Langue des pages du site + # La traduction doit exister (fournies: en, fr) + lang = fr + + [WEBSITE_MODULES] + # Le nom de la barre latérale + sidebar_title = Articles recommandés + + # Nombre d'articles dans la barre latérale (0 pour désactiver) + sidebar_items = 6 + + # Nombre d'articles dans le flux RSS (0 pour désactiver) + rss_items = 100 + + # Création automatique du sitemap (sitemap.html) + sitemaps = True + + [WEBSITE_FOOTER] + # Les liens du pied de page dans [WEBSITE_FOOTER] + # les clés link_1 à link_4 sont créés automatiquement + # Pour désactiver, enlever la valeur, laisser la clé ! + # Format de clé + # l'URL peut être locale. Ex : "/about/cgu.html" + clé = "Nom à afficher", "URL", "Contenu de title=" + + [TEMPLATE_FILENAMES] + # Nom des fichiers + # (à ajouter dans le dossier .../wip/template/) + favicon = favicon.png + logo = logo.png + styles = styles.css +}} diff --git a/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png new file mode 100644 index 0000000..07feb3d Binary files /dev/null and b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png differ diff --git a/website_doc/images/logos/format_tyto.png b/src/usr/share/tyto/docs/www/images/logos/format_tyto.png similarity index 100% rename from website_doc/images/logos/format_tyto.png rename to src/usr/share/tyto/docs/www/images/logos/format_tyto.png diff --git a/website_doc/images/logos/justice_scales_cc0.png b/src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png similarity index 100% rename from website_doc/images/logos/justice_scales_cc0.png rename to src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png diff --git a/website_doc/images/logos/tyto_5_metas.png b/src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png similarity index 100% rename from website_doc/images/logos/tyto_5_metas.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png diff --git a/website_doc/images/logos/tyto_titles_toc.png b/src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png similarity index 100% rename from website_doc/images/logos/tyto_titles_toc.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png diff --git a/website_doc/images/logos/tyto_welcome.png b/src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png similarity index 100% rename from website_doc/images/logos/tyto_welcome.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png diff --git a/website_doc/index.html b/src/usr/share/tyto/docs/www/index.html similarity index 88% rename from website_doc/index.html rename to src/usr/share/tyto/docs/www/index.html index 9c129ff..731bd0a 100644 --- a/website_doc/index.html +++ b/src/usr/share/tyto/docs/www/index.html @@ -33,7 +33,7 @@ <meta property="og:image" content="https://tyto.echolib.re/images/logos/tyto_welcome.png"> <!-- Publication date and title --> -<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date"> +<meta itemprop="datePublished" content="2024-01-17 18:19:13" id="date"> <title>Bienvenue, librement (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -71,6 +71,7 @@ par mail ou, de préférence, via Gestion et personnalisation Utilisation Traductions +Pour commencer Le projet @@ -125,6 +126,12 @@ utilisée par le système, mais chaque site peut utiliser l'une ou l'autre, via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. +Pour commencer + +Configurer un domaine +Écrire un article +Configurer les modules + diff --git a/website_doc/index.tyto b/src/usr/share/tyto/docs/www/index.tyto similarity index 86% rename from website_doc/index.tyto rename to src/usr/share/tyto/docs/www/index.tyto index 7a77069..05e8055 100644 --- a/website_doc/index.tyto +++ b/src/usr/share/tyto/docs/www/index.tyto @@ -13,6 +13,18 @@ link: chouette effraie https://fr.wikipedia.org/wiki/Chouette_effraie Tyto alba • Effraie des clochers +link: Configurer un domaine + ./config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: Écrire un article + ./article/index.html + Comment écrire un article pour Tyto - Littérateur + +link: Configurer les modules + ./modules/index.html + Comment gérer les modules (nginx) de Tyto - Littérateur + ! LOGO ------------------------------------------------------------------------------- @@ -87,3 +99,11 @@ link: chouette effraie via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. )) + + +#1 Pour commencer +(= + + ::Configurer un domaine + + ::Écrire un article + + ::Configurer les modules +)= diff --git a/src/usr/share/tyto/docs/www/modules/index.html b/src/usr/share/tyto/docs/www/modules/index.html new file mode 100644 index 0000000..407acd3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Gérer les modules dans les pages (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Gérer les modules dans les pages + + +echolib, 18/12/2023 [Code source] + + +Table des matières + + +Définitions des modules + +Le module "metas" + +Exemple HTML des metas + +Le module "header" + +Exemple HTML d'une entête + +Le module "navbar" + +Exemple HTML d'un menu + +Le module "sidebar" + +Exemple HTML d'une barre latérale + +Le module "footer" + +Exemple HTML de pied de page + + +Forcer une nouvelle génération des modules HTML +Afficher les modules dans les pages avec nginx + + +Définitions des modules + +Tyto - Littérateur intègre dans chaque page du site, différents modules. +Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le +contenu du fichier de configuration du module a changé. Vous pouvez les gérer, +et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" +dans le dossier de travail du domaine. Chaque fichier dispose d'une petite +aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer +la génération d'un module avec la commande tyto wip [module_name] + +Le module "metas" + +Le module "metas", issu du fichier de configuration "metas.raw" insère des +balises HTML <meta>, prioritaires. Les balises utilisées par défaut : + +Exemple HTML des metas + + +<meta charset="UTF-8"> +<meta name="robots" content="all"> +<meta name="medium" content="website"> +<meta name="revisit-after" content="3 days"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> + +Le module "header" + +Le module "header", issu du fichier de configuration "header.raw" insère +l'entête HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Voici un exemple de sa structure HTML et des +identificateurs CSS : + +Exemple HTML d'une entête + + +<a role="link" id="site_link" href="/" title="%s"> +<header id="header"> +<div id="header_logo"> +<img id="header_logo_image" src="%s" alt="%s"> +</div> +<div id="header_abouts"> +<p id="header_title">%s</p> +<p id="header_about">%s</p> +</div> +</header> +</a> + +Le module "navbar" + +Le module "navbar" issu du fichier de configuration "navbar.raw" insère +la barre de manu principale, libellée pour l'accessibilité, "navigation-1". +Son contenu par défaut est vide. + + +Pour ajouter un onglet au menu du site : + +créer un dossier dans le dossier de travail du domaine ".../articles/" +créer un article "index.tyto" dans le nouveau dossier +créer l'article HTML via la commande "wip" +éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + + +Exemple HTML d'un menu + + +<nav id="menu" aria-labelledby="navigation-1"> +<menu role="menu" id="menu_items"> +<li role="menuitem" class="menu_item"> +<a role="link" class="menu_link" href="%s" title="%s">%s</a> +</li> +</menu> +</nav> + +Le module "sidebar" + +Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère +la barre latérale contenant des articles à mettre en avant. Son contenu +par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la +::configuration du domaine. La barre latérale est libéllée pour +l'accessibilité "navigation-2" + + +Pour ajouter un article à la barre latérale : + +créer un article .tyto +créer l'article HTML via la commande "wip" +éditer le fichier sidebar.raw en ajoutant l'URI de l'article (URI depuis le dossier de travail du domaine ".../article/") + + +Exemple HTML d'une barre latérale + + +<aside id="sidebar"> +<div id="sidebar_title">%s</div> +<nav role="navigation" id="sidebar_menu" aria-labelledby="navigation-2"> +<ul role="list" id="sidebar_items"> +<li role="listitem" class="sidebar_item"> +<div class="sidebar_post_title"> +<a role="link" class="sidebar_post_link" href="%s">%s</a> +</div> +<div class="sidebar_post_about"> +<p class="sidebar_post_about_p" title="%s -- %s, %s">%s</p> +</div> +</li> +</ul> +</nav> +</aside> + +Le module "footer" + +Le module "footer" issu du fichier de configuration "footer.raw" insère le +pied de page HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Un menu de navigation, libellé pour +l'accessibilité "navigation-3", est créé automatiquement. + +Exemple HTML de pied de page + + +<footer id="footer"> +<div id="footer_title">%s <strong>%s</strong></div> +<div id="footer_about_menu"> +<div id="footer_about"> +%s +</div> +<nav id="footer_menu" aria-labelledby="navigation-3"> +<ul role="list" id="footer_items"> +<li role="listitem" class="footer_item"> +<a role="link" class="footer_item_link" href="%s" title="%s %s">%s</a> +</li> +</ul> +</nav> +</div> +<div id="footer_credit"> +<p id="footer_copyright">%s</p> +<p id="footer_tyto">%s</p> +</div> +</footer> + +Forcer une nouvelle génération des modules HTML + +Même si un module a déjà été généré, si vous avez besoin de forcer une +nouvelle génération de modules, il suffit de le demander, via l'action "wip". + +Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + + +tyto wip modules # Créer TOUS les modules HTML +tyto wip metas # Créer le module metas.html +tyto wip header # Créer le module header.html +tyto wip navbar # Créer le module navbar.html +tyto wip sidebar # Créer le module sidebar.html +tyto wip footer # Créer le module footer.html + + + +Vous pouvez forcer la création d'un module HTML, mais, si le fichier de +configuration a été modifié, il sera automatiquement mis à jour à la +prochaine création d'un article via la commande "wip". Il faut toutefois +forcer la génération, si une métadonnée indispensable d'un article se +trouvant dans le module, a été modifiée + +Afficher les modules dans les pages avec nginx + +Même si les pages du site sont statiques, les modules doivent être appelés +par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer +le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un +commentaire HTML conttient # include_virtual="". Dans la configuration +du serveur nginx, il faut ajouter : + + + +ssi on; +ssi_last_modified on; +absolute_redirect off; + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/modules/index.tyto b/src/usr/share/tyto/docs/www/modules/index.tyto new file mode 100644 index 0000000..d1ef6d9 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.tyto @@ -0,0 +1,201 @@ +title: Gérer les modules dans les pages +about: Comment gérer les modules (nginx) de Tyto - Littérateur +date: 2023-12-18 +tags: modules,nginx,metas,header,navbar,sidebar,footer +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: métadonnée indispensable + ../article/metas_obligatoires.html + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + + +#1 Définitions des modules +(( + *`Tyto - Littérateur`* intègre dans chaque page du site, différents modules. + Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le + contenu du fichier de configuration du module a changé. Vous pouvez les gérer, + et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" + dans le dossier de travail du domaine. Chaque fichier dispose d'une petite + aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer + la génération d'un module avec la commande {` tyto wip [module_name]`} +)) + +#2 Le module "metas" +(( + Le module "metas", issu du fichier de configuration "metas.raw" insère des + balises HTML {``}, prioritaires. Les balises utilisées par défaut : +)) + +#3 Exemple HTML des metas +{{ + + + + + +}} + + +#2 Le module "header" +(( + Le module "header", issu du fichier de configuration "header.raw" insère + +`l'entête`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Voici un exemple de sa structure HTML et des + identificateurs CSS : +)) + +#3 Exemple HTML d'une entête +{{ + + + + + + + %s + %s + + + +}} + +#2 Le module "navbar" +(( + Le module "navbar" issu du fichier de configuration "navbar.raw" insère + la +`barre de manu`+ principale, libellée pour l'accessibilité, "navigation-1". + Son contenu par défaut est vide. +)) +(( + Pour ajouter un onglet au menu du site : + (= + = créer un dossier dans le dossier de travail du domaine ".../articles/" + = créer un article "index.tyto" dans le nouveau dossier + = créer l'article HTML via la commande "wip" + = éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + )= +)) + +#3 Exemple HTML d'un menu +{{ + + + + %s + + + +}} + +#2 Le module "sidebar" +(( + Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère + la /`barre latérale`/ contenant des articles à mettre en avant. Son contenu + par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la + ::configuration du domaine. La barre latérale est libéllée pour + l'accessibilité "navigation-2" +)) +(( + Pour ajouter un article à la barre latérale : + (= + = créer un article .tyto + = créer l'article HTML via la commande "wip" + = éditer le fichier sidebar.raw en ajoutant l'URI de l'article + (URI depuis le dossier de travail du domaine ".../article/") + )= +)) + +#3 Exemple HTML d'une barre latérale +{{ + +}} + +#2 Le module "footer" +(( + Le module "footer" issu du fichier de configuration "footer.raw" insère le + +`pied de page`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Un menu de navigation, libellé pour + l'accessibilité "navigation-3", est créé automatiquement. +)) + +#3 Exemple HTML de pied de page +{{ + +}} + + +#1 Forcer une nouvelle génération des modules HTML +(( + Même si un module a déjà été généré, si vous avez besoin de forcer une + nouvelle génération de modules, il suffit de le demander, via l'action "wip". + | + Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + {{ + tyto wip modules # Créer TOUS les modules HTML + tyto wip metas # Créer le module metas.html + tyto wip header # Créer le module header.html + tyto wip navbar # Créer le module navbar.html + tyto wip sidebar # Créer le module sidebar.html + tyto wip footer # Créer le module footer.html + }} +)) +(( note + Vous pouvez forcer la création d'un module HTML, mais, si le fichier de + configuration a été modifié, il sera automatiquement mis à jour à la + prochaine création d'un article via la commande "wip". Il faut toutefois + forcer la génération, si une ::métadonnée indispensable d'un article se + trouvant dans le module, a été modifiée +)) + + +#1 Afficher les modules dans les pages avec nginx +(( + Même si les pages du site sont statiques, les modules doivent être appelés + par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer + le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un + commentaire HTML conttient {`# include_virtual=""`}. Dans la configuration + du serveur nginx, il faut ajouter : +)) +{{ + ssi on; + ssi_last_modified on; + absolute_redirect off; +}} diff --git a/website_doc/rss.xml b/src/usr/share/tyto/docs/www/rss.xml similarity index 59% rename from website_doc/rss.xml rename to src/usr/share/tyto/docs/www/rss.xml index 5e29d80..1f764ae 100644 --- a/website_doc/rss.xml +++ b/src/usr/share/tyto/docs/www/rss.xml @@ -3,7 +3,7 @@ - + @@ -20,118 +20,13 @@ fr Tyto,littérateur,logiciel libre,documentation - Mon, 15 Jan 2024 18:28:34 + Wed, 17 Jan 2024 18:19:13 gfdl-1.3 echolib+tyto@a-lec.org Tyto - Littérateur - - Écrire les titres et sous-titres - https://tyto.echolib.re/article/redac_titres.html - https://tyto.echolib.re/article/redac_titres.html - Sun, 07 Jan 2024 - Comment écrire les titres et les sous-titres pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_titles_toc.png - Écrire les titres et sous-titres (logo) - https://tyto.echolib.re/article/redac_titres.html - - format .tyto,écrire,rédaction,titres,table des matières - - - - Mentions Légales - https://tyto.echolib.re/a-propos/index.html - https://tyto.echolib.re/a-propos/index.html - Sun, 14 Jan 2024 - Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/justice_scales_cc0.png - Mentions Légales (logo) - https://tyto.echolib.re/a-propos/index.html - - mentions légales,C.G.U,licence - - - - Écrire un article au format .tyto - https://tyto.echolib.re/article/index.html - https://tyto.echolib.re/article/index.html - Sat, 06 Jan 2024 - Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/format_tyto.png - Écrire un article au format .tyto (logo) - https://tyto.echolib.re/article/index.html - - format .tyto,écrire, - - - - Écrire les métadonnées indispensables - https://tyto.echolib.re/article/metas_obligatoires.html - https://tyto.echolib.re/article/metas_obligatoires.html - Sat, 06 Jan 2024 - Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_5_metas.png - Écrire les métadonnées indispensables (logo) - https://tyto.echolib.re/article/metas_obligatoires.html - - format .tyto,écrire,métadonnées,entête - - - - Les URIs spécifiques - https://tyto.echolib.re/article/metas_uris.html - https://tyto.echolib.re/article/metas_uris.html - Mon, 08 Jan 2024 - Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Les URIs spécifiques (logo) - https://tyto.echolib.re/article/metas_uris.html - - format .tyto,écrire,liens,URIs - - - - Écrire/créer des liens - https://tyto.echolib.re/article/metas_liens.html - https://tyto.echolib.re/article/metas_liens.html - Mon, 08 Jan 2024 - Comment écrire des liens pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Écrire/créer des liens (logo) - https://tyto.echolib.re/article/metas_liens.html - - format .tyto,écrire,liens - - - - Page non trouvée - https://tyto.echolib.re/404.html - https://tyto.echolib.re/404.html - Sat, 13 Jan 2024 - Page d'erreur 404, indiquant que la page demandée n'existe pas/plus - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Page non trouvée (logo) - https://tyto.echolib.re/404.html - - 404,erreur - - Bienvenue, librement https://tyto.echolib.re/index.html @@ -146,6 +41,171 @@ accueil,projet,description + + + Afficher du code en bloc + https://tyto.echolib.re/article/redac_blockcodes.html + https://tyto.echolib.re/article/redac_blockcodes.html + Tue, 16 Jan 2024 + Comment afficher du code en bloc pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher du code en bloc (logo) + https://tyto.echolib.re/article/redac_blockcodes.html + + rédaction,marqueurs,blockcode + + + + Les URIs spécifiques + https://tyto.echolib.re/article/metas_uris.html + https://tyto.echolib.re/article/metas_uris.html + Mon, 08 Jan 2024 + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Les URIs spécifiques (logo) + https://tyto.echolib.re/article/metas_uris.html + + format .tyto,écrire,liens,URIs + + + + Créer des liens + https://tyto.echolib.re/article/metas_liens.html + https://tyto.echolib.re/article/metas_liens.html + Mon, 08 Jan 2024 + Comment écrire des liens pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer des liens (logo) + https://tyto.echolib.re/article/metas_liens.html + + format .tyto,écrire,liens + + + + Écrire les métadonnées indispensables + https://tyto.echolib.re/article/metas_obligatoires.html + https://tyto.echolib.re/article/metas_obligatoires.html + Sat, 06 Jan 2024 + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_5_metas.png + Écrire les métadonnées indispensables (logo) + https://tyto.echolib.re/article/metas_obligatoires.html + + format .tyto,écrire,métadonnées,entête + + + + Écrire des paragraphes + https://tyto.echolib.re/article/redac_paragraphes.html + https://tyto.echolib.re/article/redac_paragraphes.html + Tue, 05 Dec 2023 + Comment écrire des paragraphes pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Écrire des paragraphes (logo) + https://tyto.echolib.re/article/redac_paragraphes.html + + rédaction,marqueurs,paragraphes + + + + Mentions Légales + https://tyto.echolib.re/a-propos/index.html + https://tyto.echolib.re/a-propos/index.html + Sun, 14 Jan 2024 + Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/justice_scales_cc0.png + Mentions Légales (logo) + https://tyto.echolib.re/a-propos/index.html + + mentions légales,C.G.U,licence + + + + Écrire des titres et sous-titres + https://tyto.echolib.re/article/redac_titres.html + https://tyto.echolib.re/article/redac_titres.html + Sun, 07 Jan 2024 + Comment écrire les titres et les sous-titres pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_titles_toc.png + Écrire des titres et sous-titres (logo) + https://tyto.echolib.re/article/redac_titres.html + + rédaction,marqueurs,titres,table des matières + + + + Écrire un article au format .tyto + https://tyto.echolib.re/article/index.html + https://tyto.echolib.re/article/index.html + Sat, 06 Jan 2024 + Comment écrire un article pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/format_tyto.png + Écrire un article au format .tyto (logo) + https://tyto.echolib.re/article/index.html + + format .tyto,écrire, + + + + Afficher des images + https://tyto.echolib.re/article/mere_images.html + https://tyto.echolib.re/article/mere_images.html + Tue, 05 Dec 2023 + Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher des images (logo) + https://tyto.echolib.re/article/mere_images.html + + marqueurs,images + + + + Gérer les modules dans les pages + https://tyto.echolib.re/modules/index.html + https://tyto.echolib.re/modules/index.html + Mon, 18 Dec 2023 + Comment gérer les modules (nginx) de Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Gérer les modules dans les pages (logo) + https://tyto.echolib.re/modules/index.html + + modules,nginx,metas,header,navbar,sidebar,footer + + + + Créer et configurer un domaine + https://tyto.echolib.re/config/index.html + https://tyto.echolib.re/config/index.html + Tue, 05 Dec 2023 + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer et configurer un domaine (logo) + https://tyto.echolib.re/config/index.html + + configuration,domaine + diff --git a/src/usr/share/tyto/docs/www/sitemap.html b/src/usr/share/tyto/docs/www/sitemap.html new file mode 100644 index 0000000..af9f55b --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.html @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Plan du site (Tyto) | Tyto - Littérateur + + + + + + + + + + + + + + + +Plan du site + + +Tyto, 17/01/2024 [Code source] + + +Liste des articles (12) + + +Bienvenue, librement +Afficher du code en bloc +Les URIs spécifiques +Créer des liens +Écrire les métadonnées indispensables +Écrire des paragraphes +Mentions Légales +Écrire des titres et sous-titres +Écrire un article au format .tyto +Afficher des images +Gérer les modules dans les pages +Créer et configurer un domaine + + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/sitemap.tyto b/src/usr/share/tyto/docs/www/sitemap.tyto new file mode 100644 index 0000000..273605e --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.tyto @@ -0,0 +1,29 @@ +# Tyto - Littérateur +! NOMAP +! NORSS + +title: Plan du site +about: Plan du site généré par Tyto - Littérateur +tags: Plan du site +authors: Tyto +date: 2024-01-17 + +----- +#1 Liste des articles (12) + +(( sitemap + (= sitemap_items + + Bienvenue, librement + + Afficher du code en bloc + + Les URIs spécifiques + + Créer des liens + + Écrire les métadonnées indispensables + + Écrire des paragraphes + + Mentions Légales + + Écrire des titres et sous-titres + + Écrire un article au format .tyto + + Afficher des images + + Gérer les modules dans les pages + + Créer et configurer un domaine + )= +)) diff --git a/website_doc/template/VH_Tyto_logo.png b/src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png similarity index 100% rename from website_doc/template/VH_Tyto_logo.png rename to src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png diff --git a/website_doc/template/favicon.png b/src/usr/share/tyto/docs/www/template/favicon.png similarity index 100% rename from website_doc/template/favicon.png rename to src/usr/share/tyto/docs/www/template/favicon.png diff --git a/website_doc/template/footer.html b/src/usr/share/tyto/docs/www/template/footer.html similarity index 96% rename from website_doc/template/footer.html rename to src/usr/share/tyto/docs/www/template/footer.html index b327fae..4090a32 100644 --- a/website_doc/template/footer.html +++ b/src/usr/share/tyto/docs/www/template/footer.html @@ -12,7 +12,7 @@ en Python par Cyrille Louarn (echol Le code source est composé (hors fichiers de traductions) de 18 fichiers -totalisant 5048 lignes dont 1231 lignes commentées, soit 2851 lignes de scripts. +totalisant 5051 lignes dont 1231 lignes commentées, soit 2853 lignes de scripts. Tyto - Littérateur (version 1.11.4) est fait avec amour <3 diff --git a/website_doc/template/header.html b/src/usr/share/tyto/docs/www/template/header.html similarity index 100% rename from website_doc/template/header.html rename to src/usr/share/tyto/docs/www/template/header.html diff --git a/website_doc/template/metas.html b/src/usr/share/tyto/docs/www/template/metas.html similarity index 100% rename from website_doc/template/metas.html rename to src/usr/share/tyto/docs/www/template/metas.html diff --git a/src/usr/share/tyto/docs/www/template/navbar.html b/src/usr/share/tyto/docs/www/template/navbar.html new file mode 100644 index 0000000..bbfa1d0 --- /dev/null +++ b/src/usr/share/tyto/docs/www/template/navbar.html @@ -0,0 +1,9 @@ + + + +config +article +modules +publier + + diff --git a/website_doc/template/sidebar.html b/src/usr/share/tyto/docs/www/template/sidebar.html similarity index 100% rename from website_doc/template/sidebar.html rename to src/usr/share/tyto/docs/www/template/sidebar.html diff --git a/website_doc/template/styles.css b/src/usr/share/tyto/docs/www/template/styles.css similarity index 99% rename from website_doc/template/styles.css rename to src/usr/share/tyto/docs/www/template/styles.css index 0818419..f4e1d69 100644 --- a/website_doc/template/styles.css +++ b/src/usr/share/tyto/docs/www/template/styles.css @@ -166,6 +166,10 @@ h6.tyto { font-size: 1.2rem; } +img.bandeau { + max-width: 100% +} + p.alert { color: #FFFDA5; font-weight: bold; @@ -254,6 +258,7 @@ ul.tyto :is(ol, ul) { footer#footer { border-top: 2px dotted gray; color: #FFF; + margin-top: 40px; } div#footer_title { diff --git a/website_doc/sitemap.html b/website_doc/sitemap.html deleted file mode 100644 index c643e3a..0000000 --- a/website_doc/sitemap.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plan du site (Tyto) | Tyto - Littérateur - - - - - - - - - - - - - - - -Plan du site - - -Tyto, 15/01/2024 [Code source] - - -Liste des articles (8) - - -Écrire les titres et sous-titres -Mentions Légales -Écrire un article au format .tyto -Écrire les métadonnées indispensables -Les URIs spécifiques -Écrire/créer des liens -Page non trouvée -Bienvenue, librement - - - - - - - - - - - - - - - - diff --git a/website_doc/sitemap.tyto b/website_doc/sitemap.tyto deleted file mode 100644 index 6099374..0000000 --- a/website_doc/sitemap.tyto +++ /dev/null @@ -1,25 +0,0 @@ -# Tyto - Littérateur -! NOMAP -! NORSS - -title: Plan du site -about: Plan du site généré par Tyto - Littérateur -tags: Plan du site -authors: Tyto -date: 2024-01-15 - ------ -#1 Liste des articles (8) - -(( sitemap - (= sitemap_items - + Écrire les titres et sous-titres - + Mentions Légales - + Écrire un article au format .tyto - + Écrire les métadonnées indispensables - + Les URIs spécifiques - + Écrire/créer des liens - + Page non trouvée - + Bienvenue, librement - )= -)) diff --git a/website_doc/template/navbar.html b/website_doc/template/navbar.html deleted file mode 100644 index 3a46f7b..0000000 --- a/website_doc/template/navbar.html +++ /dev/null @@ -1,6 +0,0 @@ - - - -article - -
- + @@ -64,13 +64,12 @@ echolib, 06/01/2024 [Le séparateur ? Dans l'entête -Les métadonnées indispensables -Les métadonnées optionnelles -Les marqueurs de gestion +Les métadonnées optionnelles +Les marqueurs de gestion -Dans la rédaction +Dans la rédaction -Rappel +Rappel Le format ".tyto" ? @@ -80,7 +79,9 @@ textuel brut en page HTML5, il faut utiliser des marqueurs, et respecter une 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 ----- @@ -97,49 +98,47 @@ marqueurs dédiés au formattge des textes. 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 -Les métadonnées indispensables +Les métadonnées optionnelles -Les métadonnées indispensables ont des marqueurs uniques qui doivent être -configurés sur une seule ligne. - -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 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 ::. -Écrire/créer des liens +Créer des liens Les URIs spécifiques -Les marqueurs de gestion +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 ! LOGO : Montre le logo de l'article près de son titre -Dans la rédaction +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 -Rappel +Rappel 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 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher des images (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher des images + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Le marqueur d'image dans l'entête + +Exemples de configurations +Paramètres du marqueur d'entête + +Première ligne +Seconde ligne +Troisième ligne + + +Le marqueur d'appel dans la rédaction + +Paramètres optionels du marqueur d'appel +Exemples d'appels + +Rappels + +Exemple final + + + +Le marqueur d'image dans l'entête + +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. + +Exemples de configurations + + +# 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 + +Paramètres du marqueur d'entête +Première ligne + +L'identité du marqueur. image: UniqueID. L'image doit avoir une +identité unique (y compris des autres marqueurs d'entête). + +Seconde ligne + +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 + + +Troisième ligne + +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. + +Le marqueur d'appel dans la rédaction + +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). + +Paramètres optionels du marqueur d'appel + +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. + +Exemples d'appels + + +... +::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" + + +Rappels + +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". + +Exemple final + + +# 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", + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/mere_images.tyto b/src/usr/share/tyto/docs/www/article/mere_images.tyto new file mode 100644 index 0000000..0d03b6a --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/mere_images.tyto @@ -0,0 +1,139 @@ +title: Afficher des images +about: Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur +tags: marqueurs,images +date: 2023-12-05 +authors: echolib + +link: les URIs spécifiques + ./metas_uris.html + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- + +! TOC + +#1 Le marqueur d'image dans l'entête +(( + 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. +)) + +#2 Exemples de configurations +{{ + # 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 +}} + + +#2 Paramètres du marqueur d'entête +#3 Première ligne +(( + L'identité du marqueur. {` image: UniqueID `}. L'image doit avoir une + identité unique (y compris des autres marqueurs d'entête). +)) +#3 Seconde ligne +(( + 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 + )= +)) +#3 Troisième ligne +(( + Texte alternatif. le texte décrivant l'image. Ce texte est utilisé dans la + balise HTML {` `} et permet de rendre l'image plus + accessible. +)) + + +#1 Le marqueur d'appel dans la rédaction +(( + 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 {` `} en HTML) sur une nouvelle + ligne, les images pourraient être affichées les unes à côté des autres ; + (>`rappel: voir Rappel`<). +)) + + +#2 Paramètres optionels du marqueur d'appel +(( + 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 {` ... `}) + )= +)) +(( + 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. +)) + +#2 Exemples d'appels +{{ + ... + ::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" +}} + + +-> rappel +#1 Rappels +(( + 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 + {` `} (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". +)) + +#2 Exemple final +{{ + # 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", +}} + diff --git a/website_doc/article/metas_liens.html b/src/usr/share/tyto/docs/www/article/metas_liens.html similarity index 92% rename from website_doc/article/metas_liens.html rename to src/usr/share/tyto/docs/www/article/metas_liens.html index bffb72f..6f5b5ea 100644 --- a/website_doc/article/metas_liens.html +++ b/src/usr/share/tyto/docs/www/article/metas_liens.html @@ -1,4 +1,4 @@ - + @@ -13,7 +13,7 @@ - + @@ -26,15 +26,15 @@ - + - -Écrire/créer des liens (echolib) | Tyto - Littérateur + +Créer des liens (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + -Écrire/créer des liens +Créer des liens -echolib, 08/01/2024 [Code source] +echolib, 08/01/2024 [Code source] Table des matières diff --git a/website_doc/article/metas_liens.tyto b/src/usr/share/tyto/docs/www/article/metas_liens.tyto similarity index 98% rename from website_doc/article/metas_liens.tyto rename to src/usr/share/tyto/docs/www/article/metas_liens.tyto index 32b2df7..8c6e4b7 100644 --- a/website_doc/article/metas_liens.tyto +++ b/src/usr/share/tyto/docs/www/article/metas_liens.tyto @@ -1,4 +1,4 @@ -title: Écrire/créer des liens +title: Créer des liens about: Comment écrire des liens pour Tyto - Littérateur date: 2024-01-08 tags: format .tyto,écrire,liens diff --git a/website_doc/article/metas_obligatoires.html b/src/usr/share/tyto/docs/www/article/metas_obligatoires.html similarity index 98% rename from website_doc/article/metas_obligatoires.html rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.html index 6aad0bc..68e1c35 100644 --- a/website_doc/article/metas_obligatoires.html +++ b/src/usr/share/tyto/docs/www/article/metas_obligatoires.html @@ -33,7 +33,7 @@ - + Écrire les métadonnées indispensables (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_obligatoires.tyto b/src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto similarity index 100% rename from website_doc/article/metas_obligatoires.tyto rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto diff --git a/website_doc/article/metas_uris.html b/src/usr/share/tyto/docs/www/article/metas_uris.html similarity index 98% rename from website_doc/article/metas_uris.html rename to src/usr/share/tyto/docs/www/article/metas_uris.html index a0fe4dd..05226a4 100644 --- a/website_doc/article/metas_uris.html +++ b/src/usr/share/tyto/docs/www/article/metas_uris.html @@ -33,7 +33,7 @@ - + Les URIs spécifiques (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_uris.tyto b/src/usr/share/tyto/docs/www/article/metas_uris.tyto similarity index 100% rename from website_doc/article/metas_uris.tyto rename to src/usr/share/tyto/docs/www/article/metas_uris.tyto diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.html b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html new file mode 100644 index 0000000..84532f3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html @@ -0,0 +1,143 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher du code en bloc (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher du code en bloc + + +echolib, 16/01/2024 [Code source] + + +Table des matières + + +Les marqueurs +Exemples de code en bloc + +Sortie HTML + + + +Les marqueurs + +Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture +{{ et de fermeture }}, et placer les lignes de codes dedans. +Il est recommandé d'indenter les lignes de codes dans le bloc. Tyto +prend en compte l'indentation de la première ligne de code pour l'affichage +HTML. + + +Les marqueurs d'ouverture et de fermeture doivent se trouver au +même niveau d'indentation dans l'article source, et sonts seuls sur une +ligne + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est "bcode". La classe est reprise dans les balises HTML. +Voir ci-dessous la sortie HTML des exemples suivants. + +Exemples de code en bloc + + +# Comment afficher du code pour Tyto - Littérateur +{{ + Placer du code ici + et encore là... +}} + + + +{{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) +}} + +Sortie HTML + + +<pre class="bcode_pre"> +<ol class="bcode_items"> +<li role="listitem" class="bcode_item"><code class="bcode_code"># Comment afficher du code pour Tyto - Littérateur</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">{{</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> Placer du code ici</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> et encore là...</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">}}</code></li> +</ol> +</pre> +<pre class="MonCode_pre"> +<ol class="MonCode_items"> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">{{ MonCode</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # ! Aucune propriété de style MonCode existe</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # dans styles.css. Affichage par défaut</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> def tyto_code(hello):</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> if hello:</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> print(hello)</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">}}</code></li> +</ol> +</pre> + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto new file mode 100644 index 0000000..25c3e9b --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto @@ -0,0 +1,71 @@ +title: Afficher du code en bloc +about: Comment afficher du code en bloc pour Tyto - Littérateur +tags: rédaction,marqueurs,blockcode +date: 2024-01-16 +authors: echolib + +------------------------------------------------------------------------------- +! TOC + +#1 Les marqueurs +(( + Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture + {` {{ `} et de fermeture {` }} `}, et placer les lignes de codes dedans. + Il est recommandé d'indenter les lignes de codes dans le bloc. :`Tyto`: + prend en compte l'indentation de la première ligne de code pour l'affichage + HTML. +)) +(( + Les marqueurs d'ouverture et de fermeture doivent se trouver *`au + même niveau d'indentation`* dans l'article source, et *`sonts seuls sur une + ligne`* +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est "bcode". La classe est reprise dans les balises HTML. + Voir ci-dessous la sortie HTML des exemples suivants. +)) + + +#1 Exemples de code en bloc +{{ + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} +}} + +{{ MonCode + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} +}} + +#2 Sortie HTML +{{ + + + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} + + + + + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} + + +}} diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.html b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html new file mode 100644 index 0000000..2dc55da --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html @@ -0,0 +1,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Écrire des paragraphes (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Écrire des paragraphes + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Les marqueurs + +Exemple de paragraphes + + + +Les marqueurs + +Les marqueurs de paragraphes forment un bloc. Pour écrire des +paragraphes <p></p> en HTML, et même les imbriquer, il faut écrire du +texte entre les marqueurs d'ouverture ((, et de fermeture )). +Ces marqueurs doivent être placés seuls au début d'une ligne. + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est celle dans la configuration du domaine. + + +Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, +indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. + +Exemple de paragraphes + + +(( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) +)) + +(( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B +)) + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto new file mode 100644 index 0000000..440f016 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto @@ -0,0 +1,49 @@ +title: Écrire des paragraphes +about: Comment écrire des paragraphes pour Tyto - Littérateur +tags: rédaction,marqueurs,paragraphes +date: 2023-12-05 +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- +! TOC + + +#1 Les marqueurs +(( + Les *`marqueurs de paragraphes`* forment un bloc. Pour écrire des + paragraphes {` `} en HTML, et même les imbriquer, il faut écrire du + texte entre les marqueurs d'ouverture {` (( `}, et de fermeture {` )) `}. + Ces marqueurs doivent être placés +`seuls au début d'une ligne`+. +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est celle dans la ::configuration du domaine. +)) +(( astuce + Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, + indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. +)) + + +#2 Exemple de paragraphes +{{ + (( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) + )) + + (( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B + )) +}} diff --git a/website_doc/article/redac_titres.html b/src/usr/share/tyto/docs/www/article/redac_titres.html similarity index 87% rename from website_doc/article/redac_titres.html rename to src/usr/share/tyto/docs/www/article/redac_titres.html index 56957f1..17e22f9 100644 --- a/website_doc/article/redac_titres.html +++ b/src/usr/share/tyto/docs/www/article/redac_titres.html @@ -1,4 +1,4 @@ - + @@ -13,10 +13,10 @@ - + - + @@ -26,15 +26,15 @@ - + - -Écrire les titres et sous-titres (echolib) | Tyto - Littérateur + +Écrire des titres et sous-titres (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + - + -Écrire les titres et sous-titres +Écrire des titres et sous-titres -echolib, 07/01/2024 [Code source] +echolib, 07/01/2024 [Code source] Table des matières diff --git a/website_doc/article/redac_titres.tyto b/src/usr/share/tyto/docs/www/article/redac_titres.tyto similarity index 93% rename from website_doc/article/redac_titres.tyto rename to src/usr/share/tyto/docs/www/article/redac_titres.tyto index 49ad6a1..339b4ff 100644 --- a/website_doc/article/redac_titres.tyto +++ b/src/usr/share/tyto/docs/www/article/redac_titres.tyto @@ -1,7 +1,7 @@ -title: Écrire les titres et sous-titres +title: Écrire des titres et sous-titres about: Comment écrire les titres et les sous-titres pour Tyto - Littérateur date: 2024-01-07 -tags: format .tyto,écrire,rédaction,titres,table des matières +tags: rédaction,marqueurs,titres,table des matières authors: echolib logo: @logos/tyto_titles_toc.png diff --git a/src/usr/share/tyto/docs/www/config/index.html b/src/usr/share/tyto/docs/www/config/index.html new file mode 100644 index 0000000..076ec9e --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Créer et configurer un domaine (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Créer et configurer un domaine + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Créer un domaine + +Les commandes à taper + +Répondre aux questions + +Exemple d'un domaine créé + + +Modifier la configuration + +Les valeurs importantes + + + + +Créer un domaine + +Tyto littérateur fonctionne dans un dossier ayant l'identité d'un nom de +domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez +le créer, à l'emplacement de votre choix. Ce dossier est votre +dossier de travail. Seulement une fois ce dossier ouvert (dans un +terminal), vous pouvez lancer la procédure de création du domaine afin de +créer votre nouveau site. + + +Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez +créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers +des domaines. + +Les commandes à taper + + +# Commande bash pour créer un dossier du domaine +mkdir -p domaine.tld + +# Se placer dans le dossier créé +cd domaine.tld + +# Créer et configurer le domaine "domaine.tld" +tyto new domain + +Répondre aux questions + + + +Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de +quelques renseignements concernant ce domaine, et notemment : + +le titre du domaine +la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) +la description du domaine +les étiquettes du domaine (séparées par une virugule) +le courriel de l'administrateur +la langue du domaine (celle du site web) sur 2 caractères (en, fr...) +le dossier du serveur root + + +Exemple d'un domaine créé + +Une fois toutes les questions répondues, le fichier tyto_domain.ini est +créé dans le dossier du domaine. Quelques données supplémentaires sont +configurables dans le fichier, qui est au format INI. Il est plus que +recommandé de l'ouvrir et de vérifier son contenu +avant de continuer. Vous pouvez le lire avec la commande +tyto show domain. Le domaine est désactivé après sa création. + + + +[DOMAIN] +name = tyto.echolib.re +work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ +activated = True +title = Tyto - Littérateur +date = 2022 +about = Documentation officielle du littérateur libre +tags = Tyto,littérateur,logiciel libre,documentation +mail = echolib+tyto@a-lec.org + +[WEBSITE] +wip_url = https://www-wip.echolib.re/ +www_url = https://tyto.echolib.re/ +css = tyto +separator = | +article_code = True +lang = fr +license = gfdl-1.3 +license_url = https://www.gnu.org/licenses/fdl-1.3.txt + +[WEBSITE_FOOTER] +link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" +link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" +link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" +link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + +[WEBSITE_MODULES] +sidebar_title = Articles recommandés +sidebar_items = 6 +rss_items = 100 +sitemaps = True + +[TEMPLATE_FILENAMES] +favicon = favicon.png +logo = VH_Tyto_logo.png +styles = styles.css +rss = rss.xml +stats = tyto_stats.ini + +[SERVER] +srv_root = /home/echolib/Projets/www/ + +[TYTO] +id = 23ac1f4c +conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini +user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini + +Modifier la configuration + +Le fichier tyto_domain.ini dispose de catégories, comme [WEBSITE], avec +les paramètres clé = valeur. Si vous modifiez une valeur, Tyto vérifiera +et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans +certains cas, il faudra toutes les reconstruire. Si les modifications +concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être +reconstruit. + +Les valeurs importantes + + +[DOMAIN] +# Remplacer par True pour activer +# ou utiliser la commande tyto start / tyto stop +activated = False + +[WEBSITE] +# L'adresse (URL) du site web temporaire (wip) +wip_url = https://www-wip.domaine.tld/ + +# L'adresse (URL) du site officiel (publish) +www_url = https://domaine.tld/ + +# La classe CSS par défaut +css = tyto + +# Le séparateur entre le titre de la page et le titre du site +# dans la balise HTML <title> +separator = - + +# Valeur booléane True/False (Oui/Non) +# Afficher le lien vers le code source de l'article +article_code = False + +# Langue des pages du site +# La traduction doit exister (fournies: en, fr) +lang = fr + +[WEBSITE_MODULES] +# Le nom de la barre latérale +sidebar_title = Articles recommandés + +# Nombre d'articles dans la barre latérale (0 pour désactiver) +sidebar_items = 6 + +# Nombre d'articles dans le flux RSS (0 pour désactiver) +rss_items = 100 + +# Création automatique du sitemap (sitemap.html) +sitemaps = True + +[WEBSITE_FOOTER] +# Les liens du pied de page dans [WEBSITE_FOOTER] +# les clés link_1 à link_4 sont créés automatiquement +# Pour désactiver, enlever la valeur, laisser la clé ! +# Format de clé +# l'URL peut être locale. Ex : "/about/cgu.html" +clé = "Nom à afficher", "URL", "Contenu de title=" + +[TEMPLATE_FILENAMES] +# Nom des fichiers +# (à ajouter dans le dossier .../wip/template/) +favicon = favicon.png +logo = logo.png +styles = styles.css + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/config/index.tyto b/src/usr/share/tyto/docs/www/config/index.tyto new file mode 100644 index 0000000..7392b4c --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.tyto @@ -0,0 +1,192 @@ +title: Créer et configurer un domaine +about: Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur +tags: configuration,domaine +date: 2023-12-05 +authors: echolib + +link: format INI + https://fr.wikipedia.org/wiki/Fichier_INI + Page wikipédia en FR "Fichier INI" + +image: domain-form + tyto_new_domain_form.png + Formulaire lors de la création d'un domaine avec Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + +#1 Créer un domaine +(( + *`Tyto littérateur`* fonctionne dans un dossier ayant l'identité d'un nom de + domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez + le créer, à l'emplacement de votre choix. Ce dossier est votre + +`dossier de travail`+. Seulement une fois ce dossier ouvert (dans un + terminal), vous pouvez lancer la procédure de création du domaine afin de + créer votre nouveau site. +)) + +(( astuce + Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez + créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers + des domaines. +)) + + +#2 Les commandes à taper +{{ + # Commande bash pour créer un dossier du domaine + mkdir -p domaine.tld + + # Se placer dans le dossier créé + cd domaine.tld + + # Créer et configurer le domaine "domaine.tld" + tyto new domain +}} + + +#3 Répondre aux questions +(( + ::domain-form "c=bandeau", + | + Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de + quelques renseignements concernant ce domaine, et notemment : + (= + = le titre du domaine + = la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) + = la description du domaine + = les étiquettes du domaine (séparées par une virugule) + = le courriel de l'administrateur + = la langue du domaine (celle du site web) sur 2 caractères (en, fr...) + = le dossier du serveur root + )= +)) + + +#4 Exemple d'un domaine créé +(( + Une fois toutes les questions répondues, le fichier [`tyto_domain.ini`] est + créé dans le dossier du domaine. Quelques données supplémentaires sont + configurables dans le fichier, qui est au ::format INI. Il est plus que + recommandé de l'ouvrir et de +`vérifier son contenu`+ + *`&_`avant de continuer`_&`*. Vous pouvez le lire avec la commande + {`tyto show domain`}. Le domaine est désactivé après sa création. +)) +{{ + [DOMAIN] + name = tyto.echolib.re + work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ + activated = True + title = Tyto - Littérateur + date = 2022 + about = Documentation officielle du littérateur libre + tags = Tyto,littérateur,logiciel libre,documentation + mail = echolib+tyto@a-lec.org + + [WEBSITE] + wip_url = https://www-wip.echolib.re/ + www_url = https://tyto.echolib.re/ + css = tyto + separator = | + article_code = True + lang = fr + license = gfdl-1.3 + license_url = https://www.gnu.org/licenses/fdl-1.3.txt + + [WEBSITE_FOOTER] + link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" + link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" + link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" + link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + + [WEBSITE_MODULES] + sidebar_title = Articles recommandés + sidebar_items = 6 + rss_items = 100 + sitemaps = True + + [TEMPLATE_FILENAMES] + favicon = favicon.png + logo = VH_Tyto_logo.png + styles = styles.css + rss = rss.xml + stats = tyto_stats.ini + + [SERVER] + srv_root = /home/echolib/Projets/www/ + + [TYTO] + id = 23ac1f4c + conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini + user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini +}} + + +#2 Modifier la configuration +(( + Le fichier [`tyto_domain.ini`] dispose de catégories, comme [WEBSITE], avec + les paramètres {`clé = valeur`}. Si vous modifiez une valeur, Tyto vérifiera + et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans + certains cas, il faudra toutes les reconstruire. Si les modifications + concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être + reconstruit. +)) + + +#3 Les valeurs importantes +{{ + [DOMAIN] + # Remplacer par True pour activer + # ou utiliser la commande tyto start / tyto stop + activated = False + + [WEBSITE] + # L'adresse (URL) du site web temporaire (wip) + wip_url = https://www-wip.domaine.tld/ + + # L'adresse (URL) du site officiel (publish) + www_url = https://domaine.tld/ + + # La classe CSS par défaut + css = tyto + + # Le séparateur entre le titre de la page et le titre du site + # dans la balise HTML + separator = - + + # Valeur booléane True/False (Oui/Non) + # Afficher le lien vers le code source de l'article + article_code = False + + # Langue des pages du site + # La traduction doit exister (fournies: en, fr) + lang = fr + + [WEBSITE_MODULES] + # Le nom de la barre latérale + sidebar_title = Articles recommandés + + # Nombre d'articles dans la barre latérale (0 pour désactiver) + sidebar_items = 6 + + # Nombre d'articles dans le flux RSS (0 pour désactiver) + rss_items = 100 + + # Création automatique du sitemap (sitemap.html) + sitemaps = True + + [WEBSITE_FOOTER] + # Les liens du pied de page dans [WEBSITE_FOOTER] + # les clés link_1 à link_4 sont créés automatiquement + # Pour désactiver, enlever la valeur, laisser la clé ! + # Format de clé + # l'URL peut être locale. Ex : "/about/cgu.html" + clé = "Nom à afficher", "URL", "Contenu de title=" + + [TEMPLATE_FILENAMES] + # Nom des fichiers + # (à ajouter dans le dossier .../wip/template/) + favicon = favicon.png + logo = logo.png + styles = styles.css +}} diff --git a/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png new file mode 100644 index 0000000..07feb3d Binary files /dev/null and b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png differ diff --git a/website_doc/images/logos/format_tyto.png b/src/usr/share/tyto/docs/www/images/logos/format_tyto.png similarity index 100% rename from website_doc/images/logos/format_tyto.png rename to src/usr/share/tyto/docs/www/images/logos/format_tyto.png diff --git a/website_doc/images/logos/justice_scales_cc0.png b/src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png similarity index 100% rename from website_doc/images/logos/justice_scales_cc0.png rename to src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png diff --git a/website_doc/images/logos/tyto_5_metas.png b/src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png similarity index 100% rename from website_doc/images/logos/tyto_5_metas.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png diff --git a/website_doc/images/logos/tyto_titles_toc.png b/src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png similarity index 100% rename from website_doc/images/logos/tyto_titles_toc.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png diff --git a/website_doc/images/logos/tyto_welcome.png b/src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png similarity index 100% rename from website_doc/images/logos/tyto_welcome.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png diff --git a/website_doc/index.html b/src/usr/share/tyto/docs/www/index.html similarity index 88% rename from website_doc/index.html rename to src/usr/share/tyto/docs/www/index.html index 9c129ff..731bd0a 100644 --- a/website_doc/index.html +++ b/src/usr/share/tyto/docs/www/index.html @@ -33,7 +33,7 @@ <meta property="og:image" content="https://tyto.echolib.re/images/logos/tyto_welcome.png"> <!-- Publication date and title --> -<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date"> +<meta itemprop="datePublished" content="2024-01-17 18:19:13" id="date"> <title>Bienvenue, librement (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -71,6 +71,7 @@ par mail ou, de préférence, via Gestion et personnalisation Utilisation Traductions +Pour commencer Le projet @@ -125,6 +126,12 @@ utilisée par le système, mais chaque site peut utiliser l'une ou l'autre, via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. +Pour commencer + +Configurer un domaine +Écrire un article +Configurer les modules + diff --git a/website_doc/index.tyto b/src/usr/share/tyto/docs/www/index.tyto similarity index 86% rename from website_doc/index.tyto rename to src/usr/share/tyto/docs/www/index.tyto index 7a77069..05e8055 100644 --- a/website_doc/index.tyto +++ b/src/usr/share/tyto/docs/www/index.tyto @@ -13,6 +13,18 @@ link: chouette effraie https://fr.wikipedia.org/wiki/Chouette_effraie Tyto alba • Effraie des clochers +link: Configurer un domaine + ./config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: Écrire un article + ./article/index.html + Comment écrire un article pour Tyto - Littérateur + +link: Configurer les modules + ./modules/index.html + Comment gérer les modules (nginx) de Tyto - Littérateur + ! LOGO ------------------------------------------------------------------------------- @@ -87,3 +99,11 @@ link: chouette effraie via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. )) + + +#1 Pour commencer +(= + + ::Configurer un domaine + + ::Écrire un article + + ::Configurer les modules +)= diff --git a/src/usr/share/tyto/docs/www/modules/index.html b/src/usr/share/tyto/docs/www/modules/index.html new file mode 100644 index 0000000..407acd3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Gérer les modules dans les pages (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Gérer les modules dans les pages + + +echolib, 18/12/2023 [Code source] + + +Table des matières + + +Définitions des modules + +Le module "metas" + +Exemple HTML des metas + +Le module "header" + +Exemple HTML d'une entête + +Le module "navbar" + +Exemple HTML d'un menu + +Le module "sidebar" + +Exemple HTML d'une barre latérale + +Le module "footer" + +Exemple HTML de pied de page + + +Forcer une nouvelle génération des modules HTML +Afficher les modules dans les pages avec nginx + + +Définitions des modules + +Tyto - Littérateur intègre dans chaque page du site, différents modules. +Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le +contenu du fichier de configuration du module a changé. Vous pouvez les gérer, +et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" +dans le dossier de travail du domaine. Chaque fichier dispose d'une petite +aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer +la génération d'un module avec la commande tyto wip [module_name] + +Le module "metas" + +Le module "metas", issu du fichier de configuration "metas.raw" insère des +balises HTML <meta>, prioritaires. Les balises utilisées par défaut : + +Exemple HTML des metas + + +<meta charset="UTF-8"> +<meta name="robots" content="all"> +<meta name="medium" content="website"> +<meta name="revisit-after" content="3 days"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> + +Le module "header" + +Le module "header", issu du fichier de configuration "header.raw" insère +l'entête HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Voici un exemple de sa structure HTML et des +identificateurs CSS : + +Exemple HTML d'une entête + + +<a role="link" id="site_link" href="/" title="%s"> +<header id="header"> +<div id="header_logo"> +<img id="header_logo_image" src="%s" alt="%s"> +</div> +<div id="header_abouts"> +<p id="header_title">%s</p> +<p id="header_about">%s</p> +</div> +</header> +</a> + +Le module "navbar" + +Le module "navbar" issu du fichier de configuration "navbar.raw" insère +la barre de manu principale, libellée pour l'accessibilité, "navigation-1". +Son contenu par défaut est vide. + + +Pour ajouter un onglet au menu du site : + +créer un dossier dans le dossier de travail du domaine ".../articles/" +créer un article "index.tyto" dans le nouveau dossier +créer l'article HTML via la commande "wip" +éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + + +Exemple HTML d'un menu + + +<nav id="menu" aria-labelledby="navigation-1"> +<menu role="menu" id="menu_items"> +<li role="menuitem" class="menu_item"> +<a role="link" class="menu_link" href="%s" title="%s">%s</a> +</li> +</menu> +</nav> + +Le module "sidebar" + +Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère +la barre latérale contenant des articles à mettre en avant. Son contenu +par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la +::configuration du domaine. La barre latérale est libéllée pour +l'accessibilité "navigation-2" + + +Pour ajouter un article à la barre latérale : + +créer un article .tyto +créer l'article HTML via la commande "wip" +éditer le fichier sidebar.raw en ajoutant l'URI de l'article (URI depuis le dossier de travail du domaine ".../article/") + + +Exemple HTML d'une barre latérale + + +<aside id="sidebar"> +<div id="sidebar_title">%s</div> +<nav role="navigation" id="sidebar_menu" aria-labelledby="navigation-2"> +<ul role="list" id="sidebar_items"> +<li role="listitem" class="sidebar_item"> +<div class="sidebar_post_title"> +<a role="link" class="sidebar_post_link" href="%s">%s</a> +</div> +<div class="sidebar_post_about"> +<p class="sidebar_post_about_p" title="%s -- %s, %s">%s</p> +</div> +</li> +</ul> +</nav> +</aside> + +Le module "footer" + +Le module "footer" issu du fichier de configuration "footer.raw" insère le +pied de page HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Un menu de navigation, libellé pour +l'accessibilité "navigation-3", est créé automatiquement. + +Exemple HTML de pied de page + + +<footer id="footer"> +<div id="footer_title">%s <strong>%s</strong></div> +<div id="footer_about_menu"> +<div id="footer_about"> +%s +</div> +<nav id="footer_menu" aria-labelledby="navigation-3"> +<ul role="list" id="footer_items"> +<li role="listitem" class="footer_item"> +<a role="link" class="footer_item_link" href="%s" title="%s %s">%s</a> +</li> +</ul> +</nav> +</div> +<div id="footer_credit"> +<p id="footer_copyright">%s</p> +<p id="footer_tyto">%s</p> +</div> +</footer> + +Forcer une nouvelle génération des modules HTML + +Même si un module a déjà été généré, si vous avez besoin de forcer une +nouvelle génération de modules, il suffit de le demander, via l'action "wip". + +Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + + +tyto wip modules # Créer TOUS les modules HTML +tyto wip metas # Créer le module metas.html +tyto wip header # Créer le module header.html +tyto wip navbar # Créer le module navbar.html +tyto wip sidebar # Créer le module sidebar.html +tyto wip footer # Créer le module footer.html + + + +Vous pouvez forcer la création d'un module HTML, mais, si le fichier de +configuration a été modifié, il sera automatiquement mis à jour à la +prochaine création d'un article via la commande "wip". Il faut toutefois +forcer la génération, si une métadonnée indispensable d'un article se +trouvant dans le module, a été modifiée + +Afficher les modules dans les pages avec nginx + +Même si les pages du site sont statiques, les modules doivent être appelés +par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer +le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un +commentaire HTML conttient # include_virtual="". Dans la configuration +du serveur nginx, il faut ajouter : + + + +ssi on; +ssi_last_modified on; +absolute_redirect off; + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/modules/index.tyto b/src/usr/share/tyto/docs/www/modules/index.tyto new file mode 100644 index 0000000..d1ef6d9 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.tyto @@ -0,0 +1,201 @@ +title: Gérer les modules dans les pages +about: Comment gérer les modules (nginx) de Tyto - Littérateur +date: 2023-12-18 +tags: modules,nginx,metas,header,navbar,sidebar,footer +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: métadonnée indispensable + ../article/metas_obligatoires.html + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + + +#1 Définitions des modules +(( + *`Tyto - Littérateur`* intègre dans chaque page du site, différents modules. + Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le + contenu du fichier de configuration du module a changé. Vous pouvez les gérer, + et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" + dans le dossier de travail du domaine. Chaque fichier dispose d'une petite + aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer + la génération d'un module avec la commande {` tyto wip [module_name]`} +)) + +#2 Le module "metas" +(( + Le module "metas", issu du fichier de configuration "metas.raw" insère des + balises HTML {``}, prioritaires. Les balises utilisées par défaut : +)) + +#3 Exemple HTML des metas +{{ + + + + + +}} + + +#2 Le module "header" +(( + Le module "header", issu du fichier de configuration "header.raw" insère + +`l'entête`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Voici un exemple de sa structure HTML et des + identificateurs CSS : +)) + +#3 Exemple HTML d'une entête +{{ + + + + + + + %s + %s + + + +}} + +#2 Le module "navbar" +(( + Le module "navbar" issu du fichier de configuration "navbar.raw" insère + la +`barre de manu`+ principale, libellée pour l'accessibilité, "navigation-1". + Son contenu par défaut est vide. +)) +(( + Pour ajouter un onglet au menu du site : + (= + = créer un dossier dans le dossier de travail du domaine ".../articles/" + = créer un article "index.tyto" dans le nouveau dossier + = créer l'article HTML via la commande "wip" + = éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + )= +)) + +#3 Exemple HTML d'un menu +{{ + + + + %s + + + +}} + +#2 Le module "sidebar" +(( + Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère + la /`barre latérale`/ contenant des articles à mettre en avant. Son contenu + par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la + ::configuration du domaine. La barre latérale est libéllée pour + l'accessibilité "navigation-2" +)) +(( + Pour ajouter un article à la barre latérale : + (= + = créer un article .tyto + = créer l'article HTML via la commande "wip" + = éditer le fichier sidebar.raw en ajoutant l'URI de l'article + (URI depuis le dossier de travail du domaine ".../article/") + )= +)) + +#3 Exemple HTML d'une barre latérale +{{ + +}} + +#2 Le module "footer" +(( + Le module "footer" issu du fichier de configuration "footer.raw" insère le + +`pied de page`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Un menu de navigation, libellé pour + l'accessibilité "navigation-3", est créé automatiquement. +)) + +#3 Exemple HTML de pied de page +{{ + +}} + + +#1 Forcer une nouvelle génération des modules HTML +(( + Même si un module a déjà été généré, si vous avez besoin de forcer une + nouvelle génération de modules, il suffit de le demander, via l'action "wip". + | + Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + {{ + tyto wip modules # Créer TOUS les modules HTML + tyto wip metas # Créer le module metas.html + tyto wip header # Créer le module header.html + tyto wip navbar # Créer le module navbar.html + tyto wip sidebar # Créer le module sidebar.html + tyto wip footer # Créer le module footer.html + }} +)) +(( note + Vous pouvez forcer la création d'un module HTML, mais, si le fichier de + configuration a été modifié, il sera automatiquement mis à jour à la + prochaine création d'un article via la commande "wip". Il faut toutefois + forcer la génération, si une ::métadonnée indispensable d'un article se + trouvant dans le module, a été modifiée +)) + + +#1 Afficher les modules dans les pages avec nginx +(( + Même si les pages du site sont statiques, les modules doivent être appelés + par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer + le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un + commentaire HTML conttient {`# include_virtual=""`}. Dans la configuration + du serveur nginx, il faut ajouter : +)) +{{ + ssi on; + ssi_last_modified on; + absolute_redirect off; +}} diff --git a/website_doc/rss.xml b/src/usr/share/tyto/docs/www/rss.xml similarity index 59% rename from website_doc/rss.xml rename to src/usr/share/tyto/docs/www/rss.xml index 5e29d80..1f764ae 100644 --- a/website_doc/rss.xml +++ b/src/usr/share/tyto/docs/www/rss.xml @@ -3,7 +3,7 @@ - + @@ -20,118 +20,13 @@ fr Tyto,littérateur,logiciel libre,documentation - Mon, 15 Jan 2024 18:28:34 + Wed, 17 Jan 2024 18:19:13 gfdl-1.3 echolib+tyto@a-lec.org Tyto - Littérateur - - Écrire les titres et sous-titres - https://tyto.echolib.re/article/redac_titres.html - https://tyto.echolib.re/article/redac_titres.html - Sun, 07 Jan 2024 - Comment écrire les titres et les sous-titres pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_titles_toc.png - Écrire les titres et sous-titres (logo) - https://tyto.echolib.re/article/redac_titres.html - - format .tyto,écrire,rédaction,titres,table des matières - - - - Mentions Légales - https://tyto.echolib.re/a-propos/index.html - https://tyto.echolib.re/a-propos/index.html - Sun, 14 Jan 2024 - Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/justice_scales_cc0.png - Mentions Légales (logo) - https://tyto.echolib.re/a-propos/index.html - - mentions légales,C.G.U,licence - - - - Écrire un article au format .tyto - https://tyto.echolib.re/article/index.html - https://tyto.echolib.re/article/index.html - Sat, 06 Jan 2024 - Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/format_tyto.png - Écrire un article au format .tyto (logo) - https://tyto.echolib.re/article/index.html - - format .tyto,écrire, - - - - Écrire les métadonnées indispensables - https://tyto.echolib.re/article/metas_obligatoires.html - https://tyto.echolib.re/article/metas_obligatoires.html - Sat, 06 Jan 2024 - Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_5_metas.png - Écrire les métadonnées indispensables (logo) - https://tyto.echolib.re/article/metas_obligatoires.html - - format .tyto,écrire,métadonnées,entête - - - - Les URIs spécifiques - https://tyto.echolib.re/article/metas_uris.html - https://tyto.echolib.re/article/metas_uris.html - Mon, 08 Jan 2024 - Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Les URIs spécifiques (logo) - https://tyto.echolib.re/article/metas_uris.html - - format .tyto,écrire,liens,URIs - - - - Écrire/créer des liens - https://tyto.echolib.re/article/metas_liens.html - https://tyto.echolib.re/article/metas_liens.html - Mon, 08 Jan 2024 - Comment écrire des liens pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Écrire/créer des liens (logo) - https://tyto.echolib.re/article/metas_liens.html - - format .tyto,écrire,liens - - - - Page non trouvée - https://tyto.echolib.re/404.html - https://tyto.echolib.re/404.html - Sat, 13 Jan 2024 - Page d'erreur 404, indiquant que la page demandée n'existe pas/plus - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Page non trouvée (logo) - https://tyto.echolib.re/404.html - - 404,erreur - - Bienvenue, librement https://tyto.echolib.re/index.html @@ -146,6 +41,171 @@ accueil,projet,description + + + Afficher du code en bloc + https://tyto.echolib.re/article/redac_blockcodes.html + https://tyto.echolib.re/article/redac_blockcodes.html + Tue, 16 Jan 2024 + Comment afficher du code en bloc pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher du code en bloc (logo) + https://tyto.echolib.re/article/redac_blockcodes.html + + rédaction,marqueurs,blockcode + + + + Les URIs spécifiques + https://tyto.echolib.re/article/metas_uris.html + https://tyto.echolib.re/article/metas_uris.html + Mon, 08 Jan 2024 + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Les URIs spécifiques (logo) + https://tyto.echolib.re/article/metas_uris.html + + format .tyto,écrire,liens,URIs + + + + Créer des liens + https://tyto.echolib.re/article/metas_liens.html + https://tyto.echolib.re/article/metas_liens.html + Mon, 08 Jan 2024 + Comment écrire des liens pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer des liens (logo) + https://tyto.echolib.re/article/metas_liens.html + + format .tyto,écrire,liens + + + + Écrire les métadonnées indispensables + https://tyto.echolib.re/article/metas_obligatoires.html + https://tyto.echolib.re/article/metas_obligatoires.html + Sat, 06 Jan 2024 + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_5_metas.png + Écrire les métadonnées indispensables (logo) + https://tyto.echolib.re/article/metas_obligatoires.html + + format .tyto,écrire,métadonnées,entête + + + + Écrire des paragraphes + https://tyto.echolib.re/article/redac_paragraphes.html + https://tyto.echolib.re/article/redac_paragraphes.html + Tue, 05 Dec 2023 + Comment écrire des paragraphes pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Écrire des paragraphes (logo) + https://tyto.echolib.re/article/redac_paragraphes.html + + rédaction,marqueurs,paragraphes + + + + Mentions Légales + https://tyto.echolib.re/a-propos/index.html + https://tyto.echolib.re/a-propos/index.html + Sun, 14 Jan 2024 + Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/justice_scales_cc0.png + Mentions Légales (logo) + https://tyto.echolib.re/a-propos/index.html + + mentions légales,C.G.U,licence + + + + Écrire des titres et sous-titres + https://tyto.echolib.re/article/redac_titres.html + https://tyto.echolib.re/article/redac_titres.html + Sun, 07 Jan 2024 + Comment écrire les titres et les sous-titres pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_titles_toc.png + Écrire des titres et sous-titres (logo) + https://tyto.echolib.re/article/redac_titres.html + + rédaction,marqueurs,titres,table des matières + + + + Écrire un article au format .tyto + https://tyto.echolib.re/article/index.html + https://tyto.echolib.re/article/index.html + Sat, 06 Jan 2024 + Comment écrire un article pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/format_tyto.png + Écrire un article au format .tyto (logo) + https://tyto.echolib.re/article/index.html + + format .tyto,écrire, + + + + Afficher des images + https://tyto.echolib.re/article/mere_images.html + https://tyto.echolib.re/article/mere_images.html + Tue, 05 Dec 2023 + Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher des images (logo) + https://tyto.echolib.re/article/mere_images.html + + marqueurs,images + + + + Gérer les modules dans les pages + https://tyto.echolib.re/modules/index.html + https://tyto.echolib.re/modules/index.html + Mon, 18 Dec 2023 + Comment gérer les modules (nginx) de Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Gérer les modules dans les pages (logo) + https://tyto.echolib.re/modules/index.html + + modules,nginx,metas,header,navbar,sidebar,footer + + + + Créer et configurer un domaine + https://tyto.echolib.re/config/index.html + https://tyto.echolib.re/config/index.html + Tue, 05 Dec 2023 + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer et configurer un domaine (logo) + https://tyto.echolib.re/config/index.html + + configuration,domaine + diff --git a/src/usr/share/tyto/docs/www/sitemap.html b/src/usr/share/tyto/docs/www/sitemap.html new file mode 100644 index 0000000..af9f55b --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.html @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Plan du site (Tyto) | Tyto - Littérateur + + + + + + + + + + + + + + + +Plan du site + + +Tyto, 17/01/2024 [Code source] + + +Liste des articles (12) + + +Bienvenue, librement +Afficher du code en bloc +Les URIs spécifiques +Créer des liens +Écrire les métadonnées indispensables +Écrire des paragraphes +Mentions Légales +Écrire des titres et sous-titres +Écrire un article au format .tyto +Afficher des images +Gérer les modules dans les pages +Créer et configurer un domaine + + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/sitemap.tyto b/src/usr/share/tyto/docs/www/sitemap.tyto new file mode 100644 index 0000000..273605e --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.tyto @@ -0,0 +1,29 @@ +# Tyto - Littérateur +! NOMAP +! NORSS + +title: Plan du site +about: Plan du site généré par Tyto - Littérateur +tags: Plan du site +authors: Tyto +date: 2024-01-17 + +----- +#1 Liste des articles (12) + +(( sitemap + (= sitemap_items + + Bienvenue, librement + + Afficher du code en bloc + + Les URIs spécifiques + + Créer des liens + + Écrire les métadonnées indispensables + + Écrire des paragraphes + + Mentions Légales + + Écrire des titres et sous-titres + + Écrire un article au format .tyto + + Afficher des images + + Gérer les modules dans les pages + + Créer et configurer un domaine + )= +)) diff --git a/website_doc/template/VH_Tyto_logo.png b/src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png similarity index 100% rename from website_doc/template/VH_Tyto_logo.png rename to src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png diff --git a/website_doc/template/favicon.png b/src/usr/share/tyto/docs/www/template/favicon.png similarity index 100% rename from website_doc/template/favicon.png rename to src/usr/share/tyto/docs/www/template/favicon.png diff --git a/website_doc/template/footer.html b/src/usr/share/tyto/docs/www/template/footer.html similarity index 96% rename from website_doc/template/footer.html rename to src/usr/share/tyto/docs/www/template/footer.html index b327fae..4090a32 100644 --- a/website_doc/template/footer.html +++ b/src/usr/share/tyto/docs/www/template/footer.html @@ -12,7 +12,7 @@ en Python par Cyrille Louarn (echol Le code source est composé (hors fichiers de traductions) de 18 fichiers -totalisant 5048 lignes dont 1231 lignes commentées, soit 2851 lignes de scripts. +totalisant 5051 lignes dont 1231 lignes commentées, soit 2853 lignes de scripts. Tyto - Littérateur (version 1.11.4) est fait avec amour <3 diff --git a/website_doc/template/header.html b/src/usr/share/tyto/docs/www/template/header.html similarity index 100% rename from website_doc/template/header.html rename to src/usr/share/tyto/docs/www/template/header.html diff --git a/website_doc/template/metas.html b/src/usr/share/tyto/docs/www/template/metas.html similarity index 100% rename from website_doc/template/metas.html rename to src/usr/share/tyto/docs/www/template/metas.html diff --git a/src/usr/share/tyto/docs/www/template/navbar.html b/src/usr/share/tyto/docs/www/template/navbar.html new file mode 100644 index 0000000..bbfa1d0 --- /dev/null +++ b/src/usr/share/tyto/docs/www/template/navbar.html @@ -0,0 +1,9 @@ + + + +config +article +modules +publier + + diff --git a/website_doc/template/sidebar.html b/src/usr/share/tyto/docs/www/template/sidebar.html similarity index 100% rename from website_doc/template/sidebar.html rename to src/usr/share/tyto/docs/www/template/sidebar.html diff --git a/website_doc/template/styles.css b/src/usr/share/tyto/docs/www/template/styles.css similarity index 99% rename from website_doc/template/styles.css rename to src/usr/share/tyto/docs/www/template/styles.css index 0818419..f4e1d69 100644 --- a/website_doc/template/styles.css +++ b/src/usr/share/tyto/docs/www/template/styles.css @@ -166,6 +166,10 @@ h6.tyto { font-size: 1.2rem; } +img.bandeau { + max-width: 100% +} + p.alert { color: #FFFDA5; font-weight: bold; @@ -254,6 +258,7 @@ ul.tyto :is(ol, ul) { footer#footer { border-top: 2px dotted gray; color: #FFF; + margin-top: 40px; } div#footer_title { diff --git a/website_doc/sitemap.html b/website_doc/sitemap.html deleted file mode 100644 index c643e3a..0000000 --- a/website_doc/sitemap.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plan du site (Tyto) | Tyto - Littérateur - - - - - - - - - - - - - - - -Plan du site - - -Tyto, 15/01/2024 [Code source] - - -Liste des articles (8) - - -Écrire les titres et sous-titres -Mentions Légales -Écrire un article au format .tyto -Écrire les métadonnées indispensables -Les URIs spécifiques -Écrire/créer des liens -Page non trouvée -Bienvenue, librement - - - - - - - - - - - - - - - - diff --git a/website_doc/sitemap.tyto b/website_doc/sitemap.tyto deleted file mode 100644 index 6099374..0000000 --- a/website_doc/sitemap.tyto +++ /dev/null @@ -1,25 +0,0 @@ -# Tyto - Littérateur -! NOMAP -! NORSS - -title: Plan du site -about: Plan du site généré par Tyto - Littérateur -tags: Plan du site -authors: Tyto -date: 2024-01-15 - ------ -#1 Liste des articles (8) - -(( sitemap - (= sitemap_items - + Écrire les titres et sous-titres - + Mentions Légales - + Écrire un article au format .tyto - + Écrire les métadonnées indispensables - + Les URIs spécifiques - + Écrire/créer des liens - + Page non trouvée - + Bienvenue, librement - )= -)) diff --git a/website_doc/template/navbar.html b/website_doc/template/navbar.html deleted file mode 100644 index 3a46f7b..0000000 --- a/website_doc/template/navbar.html +++ /dev/null @@ -1,6 +0,0 @@ - - - -article - -
+ + + + +Afficher des images + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Le marqueur d'image dans l'entête + +Exemples de configurations +Paramètres du marqueur d'entête + +Première ligne +Seconde ligne +Troisième ligne + + +Le marqueur d'appel dans la rédaction + +Paramètres optionels du marqueur d'appel +Exemples d'appels + +Rappels + +Exemple final + + + +Le marqueur d'image dans l'entête + +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. + +Exemples de configurations + + +# 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 + +Paramètres du marqueur d'entête +Première ligne + +L'identité du marqueur. image: UniqueID. L'image doit avoir une +identité unique (y compris des autres marqueurs d'entête). + +Seconde ligne + +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 + + +Troisième ligne + +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. + +Le marqueur d'appel dans la rédaction + +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). + +Paramètres optionels du marqueur d'appel + +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. + +Exemples d'appels + + +... +::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" + + +Rappels + +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". + +Exemple final + + +# 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", + + +
- + -Écrire/créer des liens +Créer des liens -echolib, 08/01/2024 [Code source] +echolib, 08/01/2024 [Code source] Table des matières diff --git a/website_doc/article/metas_liens.tyto b/src/usr/share/tyto/docs/www/article/metas_liens.tyto similarity index 98% rename from website_doc/article/metas_liens.tyto rename to src/usr/share/tyto/docs/www/article/metas_liens.tyto index 32b2df7..8c6e4b7 100644 --- a/website_doc/article/metas_liens.tyto +++ b/src/usr/share/tyto/docs/www/article/metas_liens.tyto @@ -1,4 +1,4 @@ -title: Écrire/créer des liens +title: Créer des liens about: Comment écrire des liens pour Tyto - Littérateur date: 2024-01-08 tags: format .tyto,écrire,liens diff --git a/website_doc/article/metas_obligatoires.html b/src/usr/share/tyto/docs/www/article/metas_obligatoires.html similarity index 98% rename from website_doc/article/metas_obligatoires.html rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.html index 6aad0bc..68e1c35 100644 --- a/website_doc/article/metas_obligatoires.html +++ b/src/usr/share/tyto/docs/www/article/metas_obligatoires.html @@ -33,7 +33,7 @@ - + Écrire les métadonnées indispensables (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_obligatoires.tyto b/src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto similarity index 100% rename from website_doc/article/metas_obligatoires.tyto rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto diff --git a/website_doc/article/metas_uris.html b/src/usr/share/tyto/docs/www/article/metas_uris.html similarity index 98% rename from website_doc/article/metas_uris.html rename to src/usr/share/tyto/docs/www/article/metas_uris.html index a0fe4dd..05226a4 100644 --- a/website_doc/article/metas_uris.html +++ b/src/usr/share/tyto/docs/www/article/metas_uris.html @@ -33,7 +33,7 @@ - + Les URIs spécifiques (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_uris.tyto b/src/usr/share/tyto/docs/www/article/metas_uris.tyto similarity index 100% rename from website_doc/article/metas_uris.tyto rename to src/usr/share/tyto/docs/www/article/metas_uris.tyto diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.html b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html new file mode 100644 index 0000000..84532f3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html @@ -0,0 +1,143 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher du code en bloc (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher du code en bloc + + +echolib, 16/01/2024 [Code source] + + +Table des matières + + +Les marqueurs +Exemples de code en bloc + +Sortie HTML + + + +Les marqueurs + +Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture +{{ et de fermeture }}, et placer les lignes de codes dedans. +Il est recommandé d'indenter les lignes de codes dans le bloc. Tyto +prend en compte l'indentation de la première ligne de code pour l'affichage +HTML. + + +Les marqueurs d'ouverture et de fermeture doivent se trouver au +même niveau d'indentation dans l'article source, et sonts seuls sur une +ligne + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est "bcode". La classe est reprise dans les balises HTML. +Voir ci-dessous la sortie HTML des exemples suivants. + +Exemples de code en bloc + + +# Comment afficher du code pour Tyto - Littérateur +{{ + Placer du code ici + et encore là... +}} + + + +{{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) +}} + +Sortie HTML + + +<pre class="bcode_pre"> +<ol class="bcode_items"> +<li role="listitem" class="bcode_item"><code class="bcode_code"># Comment afficher du code pour Tyto - Littérateur</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">{{</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> Placer du code ici</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> et encore là...</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">}}</code></li> +</ol> +</pre> +<pre class="MonCode_pre"> +<ol class="MonCode_items"> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">{{ MonCode</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # ! Aucune propriété de style MonCode existe</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # dans styles.css. Affichage par défaut</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> def tyto_code(hello):</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> if hello:</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> print(hello)</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">}}</code></li> +</ol> +</pre> + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto new file mode 100644 index 0000000..25c3e9b --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto @@ -0,0 +1,71 @@ +title: Afficher du code en bloc +about: Comment afficher du code en bloc pour Tyto - Littérateur +tags: rédaction,marqueurs,blockcode +date: 2024-01-16 +authors: echolib + +------------------------------------------------------------------------------- +! TOC + +#1 Les marqueurs +(( + Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture + {` {{ `} et de fermeture {` }} `}, et placer les lignes de codes dedans. + Il est recommandé d'indenter les lignes de codes dans le bloc. :`Tyto`: + prend en compte l'indentation de la première ligne de code pour l'affichage + HTML. +)) +(( + Les marqueurs d'ouverture et de fermeture doivent se trouver *`au + même niveau d'indentation`* dans l'article source, et *`sonts seuls sur une + ligne`* +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est "bcode". La classe est reprise dans les balises HTML. + Voir ci-dessous la sortie HTML des exemples suivants. +)) + + +#1 Exemples de code en bloc +{{ + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} +}} + +{{ MonCode + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} +}} + +#2 Sortie HTML +{{ + + + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} + + + + + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} + + +}} diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.html b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html new file mode 100644 index 0000000..2dc55da --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html @@ -0,0 +1,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Écrire des paragraphes (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Écrire des paragraphes + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Les marqueurs + +Exemple de paragraphes + + + +Les marqueurs + +Les marqueurs de paragraphes forment un bloc. Pour écrire des +paragraphes <p></p> en HTML, et même les imbriquer, il faut écrire du +texte entre les marqueurs d'ouverture ((, et de fermeture )). +Ces marqueurs doivent être placés seuls au début d'une ligne. + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est celle dans la configuration du domaine. + + +Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, +indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. + +Exemple de paragraphes + + +(( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) +)) + +(( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B +)) + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto new file mode 100644 index 0000000..440f016 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto @@ -0,0 +1,49 @@ +title: Écrire des paragraphes +about: Comment écrire des paragraphes pour Tyto - Littérateur +tags: rédaction,marqueurs,paragraphes +date: 2023-12-05 +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- +! TOC + + +#1 Les marqueurs +(( + Les *`marqueurs de paragraphes`* forment un bloc. Pour écrire des + paragraphes {` `} en HTML, et même les imbriquer, il faut écrire du + texte entre les marqueurs d'ouverture {` (( `}, et de fermeture {` )) `}. + Ces marqueurs doivent être placés +`seuls au début d'une ligne`+. +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est celle dans la ::configuration du domaine. +)) +(( astuce + Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, + indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. +)) + + +#2 Exemple de paragraphes +{{ + (( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) + )) + + (( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B + )) +}} diff --git a/website_doc/article/redac_titres.html b/src/usr/share/tyto/docs/www/article/redac_titres.html similarity index 87% rename from website_doc/article/redac_titres.html rename to src/usr/share/tyto/docs/www/article/redac_titres.html index 56957f1..17e22f9 100644 --- a/website_doc/article/redac_titres.html +++ b/src/usr/share/tyto/docs/www/article/redac_titres.html @@ -1,4 +1,4 @@ - + @@ -13,10 +13,10 @@ - + - + @@ -26,15 +26,15 @@ - + - -Écrire les titres et sous-titres (echolib) | Tyto - Littérateur + +Écrire des titres et sous-titres (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + - + -Écrire les titres et sous-titres +Écrire des titres et sous-titres -echolib, 07/01/2024 [Code source] +echolib, 07/01/2024 [Code source] Table des matières diff --git a/website_doc/article/redac_titres.tyto b/src/usr/share/tyto/docs/www/article/redac_titres.tyto similarity index 93% rename from website_doc/article/redac_titres.tyto rename to src/usr/share/tyto/docs/www/article/redac_titres.tyto index 49ad6a1..339b4ff 100644 --- a/website_doc/article/redac_titres.tyto +++ b/src/usr/share/tyto/docs/www/article/redac_titres.tyto @@ -1,7 +1,7 @@ -title: Écrire les titres et sous-titres +title: Écrire des titres et sous-titres about: Comment écrire les titres et les sous-titres pour Tyto - Littérateur date: 2024-01-07 -tags: format .tyto,écrire,rédaction,titres,table des matières +tags: rédaction,marqueurs,titres,table des matières authors: echolib logo: @logos/tyto_titles_toc.png diff --git a/src/usr/share/tyto/docs/www/config/index.html b/src/usr/share/tyto/docs/www/config/index.html new file mode 100644 index 0000000..076ec9e --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Créer et configurer un domaine (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Créer et configurer un domaine + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Créer un domaine + +Les commandes à taper + +Répondre aux questions + +Exemple d'un domaine créé + + +Modifier la configuration + +Les valeurs importantes + + + + +Créer un domaine + +Tyto littérateur fonctionne dans un dossier ayant l'identité d'un nom de +domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez +le créer, à l'emplacement de votre choix. Ce dossier est votre +dossier de travail. Seulement une fois ce dossier ouvert (dans un +terminal), vous pouvez lancer la procédure de création du domaine afin de +créer votre nouveau site. + + +Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez +créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers +des domaines. + +Les commandes à taper + + +# Commande bash pour créer un dossier du domaine +mkdir -p domaine.tld + +# Se placer dans le dossier créé +cd domaine.tld + +# Créer et configurer le domaine "domaine.tld" +tyto new domain + +Répondre aux questions + + + +Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de +quelques renseignements concernant ce domaine, et notemment : + +le titre du domaine +la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) +la description du domaine +les étiquettes du domaine (séparées par une virugule) +le courriel de l'administrateur +la langue du domaine (celle du site web) sur 2 caractères (en, fr...) +le dossier du serveur root + + +Exemple d'un domaine créé + +Une fois toutes les questions répondues, le fichier tyto_domain.ini est +créé dans le dossier du domaine. Quelques données supplémentaires sont +configurables dans le fichier, qui est au format INI. Il est plus que +recommandé de l'ouvrir et de vérifier son contenu +avant de continuer. Vous pouvez le lire avec la commande +tyto show domain. Le domaine est désactivé après sa création. + + + +[DOMAIN] +name = tyto.echolib.re +work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ +activated = True +title = Tyto - Littérateur +date = 2022 +about = Documentation officielle du littérateur libre +tags = Tyto,littérateur,logiciel libre,documentation +mail = echolib+tyto@a-lec.org + +[WEBSITE] +wip_url = https://www-wip.echolib.re/ +www_url = https://tyto.echolib.re/ +css = tyto +separator = | +article_code = True +lang = fr +license = gfdl-1.3 +license_url = https://www.gnu.org/licenses/fdl-1.3.txt + +[WEBSITE_FOOTER] +link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" +link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" +link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" +link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + +[WEBSITE_MODULES] +sidebar_title = Articles recommandés +sidebar_items = 6 +rss_items = 100 +sitemaps = True + +[TEMPLATE_FILENAMES] +favicon = favicon.png +logo = VH_Tyto_logo.png +styles = styles.css +rss = rss.xml +stats = tyto_stats.ini + +[SERVER] +srv_root = /home/echolib/Projets/www/ + +[TYTO] +id = 23ac1f4c +conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini +user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini + +Modifier la configuration + +Le fichier tyto_domain.ini dispose de catégories, comme [WEBSITE], avec +les paramètres clé = valeur. Si vous modifiez une valeur, Tyto vérifiera +et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans +certains cas, il faudra toutes les reconstruire. Si les modifications +concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être +reconstruit. + +Les valeurs importantes + + +[DOMAIN] +# Remplacer par True pour activer +# ou utiliser la commande tyto start / tyto stop +activated = False + +[WEBSITE] +# L'adresse (URL) du site web temporaire (wip) +wip_url = https://www-wip.domaine.tld/ + +# L'adresse (URL) du site officiel (publish) +www_url = https://domaine.tld/ + +# La classe CSS par défaut +css = tyto + +# Le séparateur entre le titre de la page et le titre du site +# dans la balise HTML <title> +separator = - + +# Valeur booléane True/False (Oui/Non) +# Afficher le lien vers le code source de l'article +article_code = False + +# Langue des pages du site +# La traduction doit exister (fournies: en, fr) +lang = fr + +[WEBSITE_MODULES] +# Le nom de la barre latérale +sidebar_title = Articles recommandés + +# Nombre d'articles dans la barre latérale (0 pour désactiver) +sidebar_items = 6 + +# Nombre d'articles dans le flux RSS (0 pour désactiver) +rss_items = 100 + +# Création automatique du sitemap (sitemap.html) +sitemaps = True + +[WEBSITE_FOOTER] +# Les liens du pied de page dans [WEBSITE_FOOTER] +# les clés link_1 à link_4 sont créés automatiquement +# Pour désactiver, enlever la valeur, laisser la clé ! +# Format de clé +# l'URL peut être locale. Ex : "/about/cgu.html" +clé = "Nom à afficher", "URL", "Contenu de title=" + +[TEMPLATE_FILENAMES] +# Nom des fichiers +# (à ajouter dans le dossier .../wip/template/) +favicon = favicon.png +logo = logo.png +styles = styles.css + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/config/index.tyto b/src/usr/share/tyto/docs/www/config/index.tyto new file mode 100644 index 0000000..7392b4c --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.tyto @@ -0,0 +1,192 @@ +title: Créer et configurer un domaine +about: Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur +tags: configuration,domaine +date: 2023-12-05 +authors: echolib + +link: format INI + https://fr.wikipedia.org/wiki/Fichier_INI + Page wikipédia en FR "Fichier INI" + +image: domain-form + tyto_new_domain_form.png + Formulaire lors de la création d'un domaine avec Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + +#1 Créer un domaine +(( + *`Tyto littérateur`* fonctionne dans un dossier ayant l'identité d'un nom de + domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez + le créer, à l'emplacement de votre choix. Ce dossier est votre + +`dossier de travail`+. Seulement une fois ce dossier ouvert (dans un + terminal), vous pouvez lancer la procédure de création du domaine afin de + créer votre nouveau site. +)) + +(( astuce + Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez + créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers + des domaines. +)) + + +#2 Les commandes à taper +{{ + # Commande bash pour créer un dossier du domaine + mkdir -p domaine.tld + + # Se placer dans le dossier créé + cd domaine.tld + + # Créer et configurer le domaine "domaine.tld" + tyto new domain +}} + + +#3 Répondre aux questions +(( + ::domain-form "c=bandeau", + | + Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de + quelques renseignements concernant ce domaine, et notemment : + (= + = le titre du domaine + = la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) + = la description du domaine + = les étiquettes du domaine (séparées par une virugule) + = le courriel de l'administrateur + = la langue du domaine (celle du site web) sur 2 caractères (en, fr...) + = le dossier du serveur root + )= +)) + + +#4 Exemple d'un domaine créé +(( + Une fois toutes les questions répondues, le fichier [`tyto_domain.ini`] est + créé dans le dossier du domaine. Quelques données supplémentaires sont + configurables dans le fichier, qui est au ::format INI. Il est plus que + recommandé de l'ouvrir et de +`vérifier son contenu`+ + *`&_`avant de continuer`_&`*. Vous pouvez le lire avec la commande + {`tyto show domain`}. Le domaine est désactivé après sa création. +)) +{{ + [DOMAIN] + name = tyto.echolib.re + work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ + activated = True + title = Tyto - Littérateur + date = 2022 + about = Documentation officielle du littérateur libre + tags = Tyto,littérateur,logiciel libre,documentation + mail = echolib+tyto@a-lec.org + + [WEBSITE] + wip_url = https://www-wip.echolib.re/ + www_url = https://tyto.echolib.re/ + css = tyto + separator = | + article_code = True + lang = fr + license = gfdl-1.3 + license_url = https://www.gnu.org/licenses/fdl-1.3.txt + + [WEBSITE_FOOTER] + link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" + link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" + link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" + link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + + [WEBSITE_MODULES] + sidebar_title = Articles recommandés + sidebar_items = 6 + rss_items = 100 + sitemaps = True + + [TEMPLATE_FILENAMES] + favicon = favicon.png + logo = VH_Tyto_logo.png + styles = styles.css + rss = rss.xml + stats = tyto_stats.ini + + [SERVER] + srv_root = /home/echolib/Projets/www/ + + [TYTO] + id = 23ac1f4c + conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini + user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini +}} + + +#2 Modifier la configuration +(( + Le fichier [`tyto_domain.ini`] dispose de catégories, comme [WEBSITE], avec + les paramètres {`clé = valeur`}. Si vous modifiez une valeur, Tyto vérifiera + et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans + certains cas, il faudra toutes les reconstruire. Si les modifications + concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être + reconstruit. +)) + + +#3 Les valeurs importantes +{{ + [DOMAIN] + # Remplacer par True pour activer + # ou utiliser la commande tyto start / tyto stop + activated = False + + [WEBSITE] + # L'adresse (URL) du site web temporaire (wip) + wip_url = https://www-wip.domaine.tld/ + + # L'adresse (URL) du site officiel (publish) + www_url = https://domaine.tld/ + + # La classe CSS par défaut + css = tyto + + # Le séparateur entre le titre de la page et le titre du site + # dans la balise HTML + separator = - + + # Valeur booléane True/False (Oui/Non) + # Afficher le lien vers le code source de l'article + article_code = False + + # Langue des pages du site + # La traduction doit exister (fournies: en, fr) + lang = fr + + [WEBSITE_MODULES] + # Le nom de la barre latérale + sidebar_title = Articles recommandés + + # Nombre d'articles dans la barre latérale (0 pour désactiver) + sidebar_items = 6 + + # Nombre d'articles dans le flux RSS (0 pour désactiver) + rss_items = 100 + + # Création automatique du sitemap (sitemap.html) + sitemaps = True + + [WEBSITE_FOOTER] + # Les liens du pied de page dans [WEBSITE_FOOTER] + # les clés link_1 à link_4 sont créés automatiquement + # Pour désactiver, enlever la valeur, laisser la clé ! + # Format de clé + # l'URL peut être locale. Ex : "/about/cgu.html" + clé = "Nom à afficher", "URL", "Contenu de title=" + + [TEMPLATE_FILENAMES] + # Nom des fichiers + # (à ajouter dans le dossier .../wip/template/) + favicon = favicon.png + logo = logo.png + styles = styles.css +}} diff --git a/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png new file mode 100644 index 0000000..07feb3d Binary files /dev/null and b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png differ diff --git a/website_doc/images/logos/format_tyto.png b/src/usr/share/tyto/docs/www/images/logos/format_tyto.png similarity index 100% rename from website_doc/images/logos/format_tyto.png rename to src/usr/share/tyto/docs/www/images/logos/format_tyto.png diff --git a/website_doc/images/logos/justice_scales_cc0.png b/src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png similarity index 100% rename from website_doc/images/logos/justice_scales_cc0.png rename to src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png diff --git a/website_doc/images/logos/tyto_5_metas.png b/src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png similarity index 100% rename from website_doc/images/logos/tyto_5_metas.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png diff --git a/website_doc/images/logos/tyto_titles_toc.png b/src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png similarity index 100% rename from website_doc/images/logos/tyto_titles_toc.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png diff --git a/website_doc/images/logos/tyto_welcome.png b/src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png similarity index 100% rename from website_doc/images/logos/tyto_welcome.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png diff --git a/website_doc/index.html b/src/usr/share/tyto/docs/www/index.html similarity index 88% rename from website_doc/index.html rename to src/usr/share/tyto/docs/www/index.html index 9c129ff..731bd0a 100644 --- a/website_doc/index.html +++ b/src/usr/share/tyto/docs/www/index.html @@ -33,7 +33,7 @@ <meta property="og:image" content="https://tyto.echolib.re/images/logos/tyto_welcome.png"> <!-- Publication date and title --> -<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date"> +<meta itemprop="datePublished" content="2024-01-17 18:19:13" id="date"> <title>Bienvenue, librement (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -71,6 +71,7 @@ par mail ou, de préférence, via Gestion et personnalisation Utilisation Traductions +Pour commencer Le projet @@ -125,6 +126,12 @@ utilisée par le système, mais chaque site peut utiliser l'une ou l'autre, via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. +Pour commencer + +Configurer un domaine +Écrire un article +Configurer les modules + diff --git a/website_doc/index.tyto b/src/usr/share/tyto/docs/www/index.tyto similarity index 86% rename from website_doc/index.tyto rename to src/usr/share/tyto/docs/www/index.tyto index 7a77069..05e8055 100644 --- a/website_doc/index.tyto +++ b/src/usr/share/tyto/docs/www/index.tyto @@ -13,6 +13,18 @@ link: chouette effraie https://fr.wikipedia.org/wiki/Chouette_effraie Tyto alba • Effraie des clochers +link: Configurer un domaine + ./config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: Écrire un article + ./article/index.html + Comment écrire un article pour Tyto - Littérateur + +link: Configurer les modules + ./modules/index.html + Comment gérer les modules (nginx) de Tyto - Littérateur + ! LOGO ------------------------------------------------------------------------------- @@ -87,3 +99,11 @@ link: chouette effraie via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. )) + + +#1 Pour commencer +(= + + ::Configurer un domaine + + ::Écrire un article + + ::Configurer les modules +)= diff --git a/src/usr/share/tyto/docs/www/modules/index.html b/src/usr/share/tyto/docs/www/modules/index.html new file mode 100644 index 0000000..407acd3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Gérer les modules dans les pages (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Gérer les modules dans les pages + + +echolib, 18/12/2023 [Code source] + + +Table des matières + + +Définitions des modules + +Le module "metas" + +Exemple HTML des metas + +Le module "header" + +Exemple HTML d'une entête + +Le module "navbar" + +Exemple HTML d'un menu + +Le module "sidebar" + +Exemple HTML d'une barre latérale + +Le module "footer" + +Exemple HTML de pied de page + + +Forcer une nouvelle génération des modules HTML +Afficher les modules dans les pages avec nginx + + +Définitions des modules + +Tyto - Littérateur intègre dans chaque page du site, différents modules. +Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le +contenu du fichier de configuration du module a changé. Vous pouvez les gérer, +et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" +dans le dossier de travail du domaine. Chaque fichier dispose d'une petite +aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer +la génération d'un module avec la commande tyto wip [module_name] + +Le module "metas" + +Le module "metas", issu du fichier de configuration "metas.raw" insère des +balises HTML <meta>, prioritaires. Les balises utilisées par défaut : + +Exemple HTML des metas + + +<meta charset="UTF-8"> +<meta name="robots" content="all"> +<meta name="medium" content="website"> +<meta name="revisit-after" content="3 days"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> + +Le module "header" + +Le module "header", issu du fichier de configuration "header.raw" insère +l'entête HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Voici un exemple de sa structure HTML et des +identificateurs CSS : + +Exemple HTML d'une entête + + +<a role="link" id="site_link" href="/" title="%s"> +<header id="header"> +<div id="header_logo"> +<img id="header_logo_image" src="%s" alt="%s"> +</div> +<div id="header_abouts"> +<p id="header_title">%s</p> +<p id="header_about">%s</p> +</div> +</header> +</a> + +Le module "navbar" + +Le module "navbar" issu du fichier de configuration "navbar.raw" insère +la barre de manu principale, libellée pour l'accessibilité, "navigation-1". +Son contenu par défaut est vide. + + +Pour ajouter un onglet au menu du site : + +créer un dossier dans le dossier de travail du domaine ".../articles/" +créer un article "index.tyto" dans le nouveau dossier +créer l'article HTML via la commande "wip" +éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + + +Exemple HTML d'un menu + + +<nav id="menu" aria-labelledby="navigation-1"> +<menu role="menu" id="menu_items"> +<li role="menuitem" class="menu_item"> +<a role="link" class="menu_link" href="%s" title="%s">%s</a> +</li> +</menu> +</nav> + +Le module "sidebar" + +Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère +la barre latérale contenant des articles à mettre en avant. Son contenu +par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la +::configuration du domaine. La barre latérale est libéllée pour +l'accessibilité "navigation-2" + + +Pour ajouter un article à la barre latérale : + +créer un article .tyto +créer l'article HTML via la commande "wip" +éditer le fichier sidebar.raw en ajoutant l'URI de l'article (URI depuis le dossier de travail du domaine ".../article/") + + +Exemple HTML d'une barre latérale + + +<aside id="sidebar"> +<div id="sidebar_title">%s</div> +<nav role="navigation" id="sidebar_menu" aria-labelledby="navigation-2"> +<ul role="list" id="sidebar_items"> +<li role="listitem" class="sidebar_item"> +<div class="sidebar_post_title"> +<a role="link" class="sidebar_post_link" href="%s">%s</a> +</div> +<div class="sidebar_post_about"> +<p class="sidebar_post_about_p" title="%s -- %s, %s">%s</p> +</div> +</li> +</ul> +</nav> +</aside> + +Le module "footer" + +Le module "footer" issu du fichier de configuration "footer.raw" insère le +pied de page HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Un menu de navigation, libellé pour +l'accessibilité "navigation-3", est créé automatiquement. + +Exemple HTML de pied de page + + +<footer id="footer"> +<div id="footer_title">%s <strong>%s</strong></div> +<div id="footer_about_menu"> +<div id="footer_about"> +%s +</div> +<nav id="footer_menu" aria-labelledby="navigation-3"> +<ul role="list" id="footer_items"> +<li role="listitem" class="footer_item"> +<a role="link" class="footer_item_link" href="%s" title="%s %s">%s</a> +</li> +</ul> +</nav> +</div> +<div id="footer_credit"> +<p id="footer_copyright">%s</p> +<p id="footer_tyto">%s</p> +</div> +</footer> + +Forcer une nouvelle génération des modules HTML + +Même si un module a déjà été généré, si vous avez besoin de forcer une +nouvelle génération de modules, il suffit de le demander, via l'action "wip". + +Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + + +tyto wip modules # Créer TOUS les modules HTML +tyto wip metas # Créer le module metas.html +tyto wip header # Créer le module header.html +tyto wip navbar # Créer le module navbar.html +tyto wip sidebar # Créer le module sidebar.html +tyto wip footer # Créer le module footer.html + + + +Vous pouvez forcer la création d'un module HTML, mais, si le fichier de +configuration a été modifié, il sera automatiquement mis à jour à la +prochaine création d'un article via la commande "wip". Il faut toutefois +forcer la génération, si une métadonnée indispensable d'un article se +trouvant dans le module, a été modifiée + +Afficher les modules dans les pages avec nginx + +Même si les pages du site sont statiques, les modules doivent être appelés +par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer +le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un +commentaire HTML conttient # include_virtual="". Dans la configuration +du serveur nginx, il faut ajouter : + + + +ssi on; +ssi_last_modified on; +absolute_redirect off; + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/modules/index.tyto b/src/usr/share/tyto/docs/www/modules/index.tyto new file mode 100644 index 0000000..d1ef6d9 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.tyto @@ -0,0 +1,201 @@ +title: Gérer les modules dans les pages +about: Comment gérer les modules (nginx) de Tyto - Littérateur +date: 2023-12-18 +tags: modules,nginx,metas,header,navbar,sidebar,footer +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: métadonnée indispensable + ../article/metas_obligatoires.html + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + + +#1 Définitions des modules +(( + *`Tyto - Littérateur`* intègre dans chaque page du site, différents modules. + Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le + contenu du fichier de configuration du module a changé. Vous pouvez les gérer, + et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" + dans le dossier de travail du domaine. Chaque fichier dispose d'une petite + aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer + la génération d'un module avec la commande {` tyto wip [module_name]`} +)) + +#2 Le module "metas" +(( + Le module "metas", issu du fichier de configuration "metas.raw" insère des + balises HTML {``}, prioritaires. Les balises utilisées par défaut : +)) + +#3 Exemple HTML des metas +{{ + + + + + +}} + + +#2 Le module "header" +(( + Le module "header", issu du fichier de configuration "header.raw" insère + +`l'entête`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Voici un exemple de sa structure HTML et des + identificateurs CSS : +)) + +#3 Exemple HTML d'une entête +{{ + + + + + + + %s + %s + + + +}} + +#2 Le module "navbar" +(( + Le module "navbar" issu du fichier de configuration "navbar.raw" insère + la +`barre de manu`+ principale, libellée pour l'accessibilité, "navigation-1". + Son contenu par défaut est vide. +)) +(( + Pour ajouter un onglet au menu du site : + (= + = créer un dossier dans le dossier de travail du domaine ".../articles/" + = créer un article "index.tyto" dans le nouveau dossier + = créer l'article HTML via la commande "wip" + = éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + )= +)) + +#3 Exemple HTML d'un menu +{{ + + + + %s + + + +}} + +#2 Le module "sidebar" +(( + Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère + la /`barre latérale`/ contenant des articles à mettre en avant. Son contenu + par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la + ::configuration du domaine. La barre latérale est libéllée pour + l'accessibilité "navigation-2" +)) +(( + Pour ajouter un article à la barre latérale : + (= + = créer un article .tyto + = créer l'article HTML via la commande "wip" + = éditer le fichier sidebar.raw en ajoutant l'URI de l'article + (URI depuis le dossier de travail du domaine ".../article/") + )= +)) + +#3 Exemple HTML d'une barre latérale +{{ + +}} + +#2 Le module "footer" +(( + Le module "footer" issu du fichier de configuration "footer.raw" insère le + +`pied de page`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Un menu de navigation, libellé pour + l'accessibilité "navigation-3", est créé automatiquement. +)) + +#3 Exemple HTML de pied de page +{{ + +}} + + +#1 Forcer une nouvelle génération des modules HTML +(( + Même si un module a déjà été généré, si vous avez besoin de forcer une + nouvelle génération de modules, il suffit de le demander, via l'action "wip". + | + Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + {{ + tyto wip modules # Créer TOUS les modules HTML + tyto wip metas # Créer le module metas.html + tyto wip header # Créer le module header.html + tyto wip navbar # Créer le module navbar.html + tyto wip sidebar # Créer le module sidebar.html + tyto wip footer # Créer le module footer.html + }} +)) +(( note + Vous pouvez forcer la création d'un module HTML, mais, si le fichier de + configuration a été modifié, il sera automatiquement mis à jour à la + prochaine création d'un article via la commande "wip". Il faut toutefois + forcer la génération, si une ::métadonnée indispensable d'un article se + trouvant dans le module, a été modifiée +)) + + +#1 Afficher les modules dans les pages avec nginx +(( + Même si les pages du site sont statiques, les modules doivent être appelés + par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer + le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un + commentaire HTML conttient {`# include_virtual=""`}. Dans la configuration + du serveur nginx, il faut ajouter : +)) +{{ + ssi on; + ssi_last_modified on; + absolute_redirect off; +}} diff --git a/website_doc/rss.xml b/src/usr/share/tyto/docs/www/rss.xml similarity index 59% rename from website_doc/rss.xml rename to src/usr/share/tyto/docs/www/rss.xml index 5e29d80..1f764ae 100644 --- a/website_doc/rss.xml +++ b/src/usr/share/tyto/docs/www/rss.xml @@ -3,7 +3,7 @@ - + @@ -20,118 +20,13 @@ fr Tyto,littérateur,logiciel libre,documentation - Mon, 15 Jan 2024 18:28:34 + Wed, 17 Jan 2024 18:19:13 gfdl-1.3 echolib+tyto@a-lec.org Tyto - Littérateur - - Écrire les titres et sous-titres - https://tyto.echolib.re/article/redac_titres.html - https://tyto.echolib.re/article/redac_titres.html - Sun, 07 Jan 2024 - Comment écrire les titres et les sous-titres pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_titles_toc.png - Écrire les titres et sous-titres (logo) - https://tyto.echolib.re/article/redac_titres.html - - format .tyto,écrire,rédaction,titres,table des matières - - - - Mentions Légales - https://tyto.echolib.re/a-propos/index.html - https://tyto.echolib.re/a-propos/index.html - Sun, 14 Jan 2024 - Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/justice_scales_cc0.png - Mentions Légales (logo) - https://tyto.echolib.re/a-propos/index.html - - mentions légales,C.G.U,licence - - - - Écrire un article au format .tyto - https://tyto.echolib.re/article/index.html - https://tyto.echolib.re/article/index.html - Sat, 06 Jan 2024 - Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/format_tyto.png - Écrire un article au format .tyto (logo) - https://tyto.echolib.re/article/index.html - - format .tyto,écrire, - - - - Écrire les métadonnées indispensables - https://tyto.echolib.re/article/metas_obligatoires.html - https://tyto.echolib.re/article/metas_obligatoires.html - Sat, 06 Jan 2024 - Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_5_metas.png - Écrire les métadonnées indispensables (logo) - https://tyto.echolib.re/article/metas_obligatoires.html - - format .tyto,écrire,métadonnées,entête - - - - Les URIs spécifiques - https://tyto.echolib.re/article/metas_uris.html - https://tyto.echolib.re/article/metas_uris.html - Mon, 08 Jan 2024 - Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Les URIs spécifiques (logo) - https://tyto.echolib.re/article/metas_uris.html - - format .tyto,écrire,liens,URIs - - - - Écrire/créer des liens - https://tyto.echolib.re/article/metas_liens.html - https://tyto.echolib.re/article/metas_liens.html - Mon, 08 Jan 2024 - Comment écrire des liens pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Écrire/créer des liens (logo) - https://tyto.echolib.re/article/metas_liens.html - - format .tyto,écrire,liens - - - - Page non trouvée - https://tyto.echolib.re/404.html - https://tyto.echolib.re/404.html - Sat, 13 Jan 2024 - Page d'erreur 404, indiquant que la page demandée n'existe pas/plus - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Page non trouvée (logo) - https://tyto.echolib.re/404.html - - 404,erreur - - Bienvenue, librement https://tyto.echolib.re/index.html @@ -146,6 +41,171 @@ accueil,projet,description + + + Afficher du code en bloc + https://tyto.echolib.re/article/redac_blockcodes.html + https://tyto.echolib.re/article/redac_blockcodes.html + Tue, 16 Jan 2024 + Comment afficher du code en bloc pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher du code en bloc (logo) + https://tyto.echolib.re/article/redac_blockcodes.html + + rédaction,marqueurs,blockcode + + + + Les URIs spécifiques + https://tyto.echolib.re/article/metas_uris.html + https://tyto.echolib.re/article/metas_uris.html + Mon, 08 Jan 2024 + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Les URIs spécifiques (logo) + https://tyto.echolib.re/article/metas_uris.html + + format .tyto,écrire,liens,URIs + + + + Créer des liens + https://tyto.echolib.re/article/metas_liens.html + https://tyto.echolib.re/article/metas_liens.html + Mon, 08 Jan 2024 + Comment écrire des liens pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer des liens (logo) + https://tyto.echolib.re/article/metas_liens.html + + format .tyto,écrire,liens + + + + Écrire les métadonnées indispensables + https://tyto.echolib.re/article/metas_obligatoires.html + https://tyto.echolib.re/article/metas_obligatoires.html + Sat, 06 Jan 2024 + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_5_metas.png + Écrire les métadonnées indispensables (logo) + https://tyto.echolib.re/article/metas_obligatoires.html + + format .tyto,écrire,métadonnées,entête + + + + Écrire des paragraphes + https://tyto.echolib.re/article/redac_paragraphes.html + https://tyto.echolib.re/article/redac_paragraphes.html + Tue, 05 Dec 2023 + Comment écrire des paragraphes pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Écrire des paragraphes (logo) + https://tyto.echolib.re/article/redac_paragraphes.html + + rédaction,marqueurs,paragraphes + + + + Mentions Légales + https://tyto.echolib.re/a-propos/index.html + https://tyto.echolib.re/a-propos/index.html + Sun, 14 Jan 2024 + Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/justice_scales_cc0.png + Mentions Légales (logo) + https://tyto.echolib.re/a-propos/index.html + + mentions légales,C.G.U,licence + + + + Écrire des titres et sous-titres + https://tyto.echolib.re/article/redac_titres.html + https://tyto.echolib.re/article/redac_titres.html + Sun, 07 Jan 2024 + Comment écrire les titres et les sous-titres pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_titles_toc.png + Écrire des titres et sous-titres (logo) + https://tyto.echolib.re/article/redac_titres.html + + rédaction,marqueurs,titres,table des matières + + + + Écrire un article au format .tyto + https://tyto.echolib.re/article/index.html + https://tyto.echolib.re/article/index.html + Sat, 06 Jan 2024 + Comment écrire un article pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/format_tyto.png + Écrire un article au format .tyto (logo) + https://tyto.echolib.re/article/index.html + + format .tyto,écrire, + + + + Afficher des images + https://tyto.echolib.re/article/mere_images.html + https://tyto.echolib.re/article/mere_images.html + Tue, 05 Dec 2023 + Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher des images (logo) + https://tyto.echolib.re/article/mere_images.html + + marqueurs,images + + + + Gérer les modules dans les pages + https://tyto.echolib.re/modules/index.html + https://tyto.echolib.re/modules/index.html + Mon, 18 Dec 2023 + Comment gérer les modules (nginx) de Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Gérer les modules dans les pages (logo) + https://tyto.echolib.re/modules/index.html + + modules,nginx,metas,header,navbar,sidebar,footer + + + + Créer et configurer un domaine + https://tyto.echolib.re/config/index.html + https://tyto.echolib.re/config/index.html + Tue, 05 Dec 2023 + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer et configurer un domaine (logo) + https://tyto.echolib.re/config/index.html + + configuration,domaine + diff --git a/src/usr/share/tyto/docs/www/sitemap.html b/src/usr/share/tyto/docs/www/sitemap.html new file mode 100644 index 0000000..af9f55b --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.html @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Plan du site (Tyto) | Tyto - Littérateur + + + + + + + + + + + + + + + +Plan du site + + +Tyto, 17/01/2024 [Code source] + + +Liste des articles (12) + + +Bienvenue, librement +Afficher du code en bloc +Les URIs spécifiques +Créer des liens +Écrire les métadonnées indispensables +Écrire des paragraphes +Mentions Légales +Écrire des titres et sous-titres +Écrire un article au format .tyto +Afficher des images +Gérer les modules dans les pages +Créer et configurer un domaine + + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/sitemap.tyto b/src/usr/share/tyto/docs/www/sitemap.tyto new file mode 100644 index 0000000..273605e --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.tyto @@ -0,0 +1,29 @@ +# Tyto - Littérateur +! NOMAP +! NORSS + +title: Plan du site +about: Plan du site généré par Tyto - Littérateur +tags: Plan du site +authors: Tyto +date: 2024-01-17 + +----- +#1 Liste des articles (12) + +(( sitemap + (= sitemap_items + + Bienvenue, librement + + Afficher du code en bloc + + Les URIs spécifiques + + Créer des liens + + Écrire les métadonnées indispensables + + Écrire des paragraphes + + Mentions Légales + + Écrire des titres et sous-titres + + Écrire un article au format .tyto + + Afficher des images + + Gérer les modules dans les pages + + Créer et configurer un domaine + )= +)) diff --git a/website_doc/template/VH_Tyto_logo.png b/src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png similarity index 100% rename from website_doc/template/VH_Tyto_logo.png rename to src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png diff --git a/website_doc/template/favicon.png b/src/usr/share/tyto/docs/www/template/favicon.png similarity index 100% rename from website_doc/template/favicon.png rename to src/usr/share/tyto/docs/www/template/favicon.png diff --git a/website_doc/template/footer.html b/src/usr/share/tyto/docs/www/template/footer.html similarity index 96% rename from website_doc/template/footer.html rename to src/usr/share/tyto/docs/www/template/footer.html index b327fae..4090a32 100644 --- a/website_doc/template/footer.html +++ b/src/usr/share/tyto/docs/www/template/footer.html @@ -12,7 +12,7 @@ en Python par Cyrille Louarn (echol Le code source est composé (hors fichiers de traductions) de 18 fichiers -totalisant 5048 lignes dont 1231 lignes commentées, soit 2851 lignes de scripts. +totalisant 5051 lignes dont 1231 lignes commentées, soit 2853 lignes de scripts. Tyto - Littérateur (version 1.11.4) est fait avec amour <3 diff --git a/website_doc/template/header.html b/src/usr/share/tyto/docs/www/template/header.html similarity index 100% rename from website_doc/template/header.html rename to src/usr/share/tyto/docs/www/template/header.html diff --git a/website_doc/template/metas.html b/src/usr/share/tyto/docs/www/template/metas.html similarity index 100% rename from website_doc/template/metas.html rename to src/usr/share/tyto/docs/www/template/metas.html diff --git a/src/usr/share/tyto/docs/www/template/navbar.html b/src/usr/share/tyto/docs/www/template/navbar.html new file mode 100644 index 0000000..bbfa1d0 --- /dev/null +++ b/src/usr/share/tyto/docs/www/template/navbar.html @@ -0,0 +1,9 @@ + + + +config +article +modules +publier + + diff --git a/website_doc/template/sidebar.html b/src/usr/share/tyto/docs/www/template/sidebar.html similarity index 100% rename from website_doc/template/sidebar.html rename to src/usr/share/tyto/docs/www/template/sidebar.html diff --git a/website_doc/template/styles.css b/src/usr/share/tyto/docs/www/template/styles.css similarity index 99% rename from website_doc/template/styles.css rename to src/usr/share/tyto/docs/www/template/styles.css index 0818419..f4e1d69 100644 --- a/website_doc/template/styles.css +++ b/src/usr/share/tyto/docs/www/template/styles.css @@ -166,6 +166,10 @@ h6.tyto { font-size: 1.2rem; } +img.bandeau { + max-width: 100% +} + p.alert { color: #FFFDA5; font-weight: bold; @@ -254,6 +258,7 @@ ul.tyto :is(ol, ul) { footer#footer { border-top: 2px dotted gray; color: #FFF; + margin-top: 40px; } div#footer_title { diff --git a/website_doc/sitemap.html b/website_doc/sitemap.html deleted file mode 100644 index c643e3a..0000000 --- a/website_doc/sitemap.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plan du site (Tyto) | Tyto - Littérateur - - - - - - - - - - - - - - - -Plan du site - - -Tyto, 15/01/2024 [Code source] - - -Liste des articles (8) - - -Écrire les titres et sous-titres -Mentions Légales -Écrire un article au format .tyto -Écrire les métadonnées indispensables -Les URIs spécifiques -Écrire/créer des liens -Page non trouvée -Bienvenue, librement - - - - - - - - - - - - - - - - diff --git a/website_doc/sitemap.tyto b/website_doc/sitemap.tyto deleted file mode 100644 index 6099374..0000000 --- a/website_doc/sitemap.tyto +++ /dev/null @@ -1,25 +0,0 @@ -# Tyto - Littérateur -! NOMAP -! NORSS - -title: Plan du site -about: Plan du site généré par Tyto - Littérateur -tags: Plan du site -authors: Tyto -date: 2024-01-15 - ------ -#1 Liste des articles (8) - -(( sitemap - (= sitemap_items - + Écrire les titres et sous-titres - + Mentions Légales - + Écrire un article au format .tyto - + Écrire les métadonnées indispensables - + Les URIs spécifiques - + Écrire/créer des liens - + Page non trouvée - + Bienvenue, librement - )= -)) diff --git a/website_doc/template/navbar.html b/website_doc/template/navbar.html deleted file mode 100644 index 3a46f7b..0000000 --- a/website_doc/template/navbar.html +++ /dev/null @@ -1,6 +0,0 @@ - - - -article - -
- + diff --git a/website_doc/article/metas_obligatoires.tyto b/src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto similarity index 100% rename from website_doc/article/metas_obligatoires.tyto rename to src/usr/share/tyto/docs/www/article/metas_obligatoires.tyto diff --git a/website_doc/article/metas_uris.html b/src/usr/share/tyto/docs/www/article/metas_uris.html similarity index 98% rename from website_doc/article/metas_uris.html rename to src/usr/share/tyto/docs/www/article/metas_uris.html index a0fe4dd..05226a4 100644 --- a/website_doc/article/metas_uris.html +++ b/src/usr/share/tyto/docs/www/article/metas_uris.html @@ -33,7 +33,7 @@ - + Les URIs spécifiques (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + diff --git a/website_doc/article/metas_uris.tyto b/src/usr/share/tyto/docs/www/article/metas_uris.tyto similarity index 100% rename from website_doc/article/metas_uris.tyto rename to src/usr/share/tyto/docs/www/article/metas_uris.tyto diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.html b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html new file mode 100644 index 0000000..84532f3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html @@ -0,0 +1,143 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher du code en bloc (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher du code en bloc + + +echolib, 16/01/2024 [Code source] + + +Table des matières + + +Les marqueurs +Exemples de code en bloc + +Sortie HTML + + + +Les marqueurs + +Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture +{{ et de fermeture }}, et placer les lignes de codes dedans. +Il est recommandé d'indenter les lignes de codes dans le bloc. Tyto +prend en compte l'indentation de la première ligne de code pour l'affichage +HTML. + + +Les marqueurs d'ouverture et de fermeture doivent se trouver au +même niveau d'indentation dans l'article source, et sonts seuls sur une +ligne + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est "bcode". La classe est reprise dans les balises HTML. +Voir ci-dessous la sortie HTML des exemples suivants. + +Exemples de code en bloc + + +# Comment afficher du code pour Tyto - Littérateur +{{ + Placer du code ici + et encore là... +}} + + + +{{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) +}} + +Sortie HTML + + +<pre class="bcode_pre"> +<ol class="bcode_items"> +<li role="listitem" class="bcode_item"><code class="bcode_code"># Comment afficher du code pour Tyto - Littérateur</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">{{</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> Placer du code ici</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> et encore là...</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">}}</code></li> +</ol> +</pre> +<pre class="MonCode_pre"> +<ol class="MonCode_items"> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">{{ MonCode</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # ! Aucune propriété de style MonCode existe</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # dans styles.css. Affichage par défaut</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> def tyto_code(hello):</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> if hello:</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> print(hello)</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">}}</code></li> +</ol> +</pre> + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto new file mode 100644 index 0000000..25c3e9b --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto @@ -0,0 +1,71 @@ +title: Afficher du code en bloc +about: Comment afficher du code en bloc pour Tyto - Littérateur +tags: rédaction,marqueurs,blockcode +date: 2024-01-16 +authors: echolib + +------------------------------------------------------------------------------- +! TOC + +#1 Les marqueurs +(( + Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture + {` {{ `} et de fermeture {` }} `}, et placer les lignes de codes dedans. + Il est recommandé d'indenter les lignes de codes dans le bloc. :`Tyto`: + prend en compte l'indentation de la première ligne de code pour l'affichage + HTML. +)) +(( + Les marqueurs d'ouverture et de fermeture doivent se trouver *`au + même niveau d'indentation`* dans l'article source, et *`sonts seuls sur une + ligne`* +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est "bcode". La classe est reprise dans les balises HTML. + Voir ci-dessous la sortie HTML des exemples suivants. +)) + + +#1 Exemples de code en bloc +{{ + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} +}} + +{{ MonCode + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} +}} + +#2 Sortie HTML +{{ + + + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} + + + + + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} + + +}} diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.html b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html new file mode 100644 index 0000000..2dc55da --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html @@ -0,0 +1,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Écrire des paragraphes (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Écrire des paragraphes + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Les marqueurs + +Exemple de paragraphes + + + +Les marqueurs + +Les marqueurs de paragraphes forment un bloc. Pour écrire des +paragraphes <p></p> en HTML, et même les imbriquer, il faut écrire du +texte entre les marqueurs d'ouverture ((, et de fermeture )). +Ces marqueurs doivent être placés seuls au début d'une ligne. + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est celle dans la configuration du domaine. + + +Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, +indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. + +Exemple de paragraphes + + +(( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) +)) + +(( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B +)) + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto new file mode 100644 index 0000000..440f016 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto @@ -0,0 +1,49 @@ +title: Écrire des paragraphes +about: Comment écrire des paragraphes pour Tyto - Littérateur +tags: rédaction,marqueurs,paragraphes +date: 2023-12-05 +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- +! TOC + + +#1 Les marqueurs +(( + Les *`marqueurs de paragraphes`* forment un bloc. Pour écrire des + paragraphes {` `} en HTML, et même les imbriquer, il faut écrire du + texte entre les marqueurs d'ouverture {` (( `}, et de fermeture {` )) `}. + Ces marqueurs doivent être placés +`seuls au début d'une ligne`+. +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est celle dans la ::configuration du domaine. +)) +(( astuce + Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, + indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. +)) + + +#2 Exemple de paragraphes +{{ + (( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) + )) + + (( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B + )) +}} diff --git a/website_doc/article/redac_titres.html b/src/usr/share/tyto/docs/www/article/redac_titres.html similarity index 87% rename from website_doc/article/redac_titres.html rename to src/usr/share/tyto/docs/www/article/redac_titres.html index 56957f1..17e22f9 100644 --- a/website_doc/article/redac_titres.html +++ b/src/usr/share/tyto/docs/www/article/redac_titres.html @@ -1,4 +1,4 @@ - + @@ -13,10 +13,10 @@ - + - + @@ -26,15 +26,15 @@ - + - -Écrire les titres et sous-titres (echolib) | Tyto - Littérateur + +Écrire des titres et sous-titres (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + - + -Écrire les titres et sous-titres +Écrire des titres et sous-titres -echolib, 07/01/2024 [Code source] +echolib, 07/01/2024 [Code source] Table des matières diff --git a/website_doc/article/redac_titres.tyto b/src/usr/share/tyto/docs/www/article/redac_titres.tyto similarity index 93% rename from website_doc/article/redac_titres.tyto rename to src/usr/share/tyto/docs/www/article/redac_titres.tyto index 49ad6a1..339b4ff 100644 --- a/website_doc/article/redac_titres.tyto +++ b/src/usr/share/tyto/docs/www/article/redac_titres.tyto @@ -1,7 +1,7 @@ -title: Écrire les titres et sous-titres +title: Écrire des titres et sous-titres about: Comment écrire les titres et les sous-titres pour Tyto - Littérateur date: 2024-01-07 -tags: format .tyto,écrire,rédaction,titres,table des matières +tags: rédaction,marqueurs,titres,table des matières authors: echolib logo: @logos/tyto_titles_toc.png diff --git a/src/usr/share/tyto/docs/www/config/index.html b/src/usr/share/tyto/docs/www/config/index.html new file mode 100644 index 0000000..076ec9e --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Créer et configurer un domaine (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Créer et configurer un domaine + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Créer un domaine + +Les commandes à taper + +Répondre aux questions + +Exemple d'un domaine créé + + +Modifier la configuration + +Les valeurs importantes + + + + +Créer un domaine + +Tyto littérateur fonctionne dans un dossier ayant l'identité d'un nom de +domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez +le créer, à l'emplacement de votre choix. Ce dossier est votre +dossier de travail. Seulement une fois ce dossier ouvert (dans un +terminal), vous pouvez lancer la procédure de création du domaine afin de +créer votre nouveau site. + + +Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez +créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers +des domaines. + +Les commandes à taper + + +# Commande bash pour créer un dossier du domaine +mkdir -p domaine.tld + +# Se placer dans le dossier créé +cd domaine.tld + +# Créer et configurer le domaine "domaine.tld" +tyto new domain + +Répondre aux questions + + + +Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de +quelques renseignements concernant ce domaine, et notemment : + +le titre du domaine +la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) +la description du domaine +les étiquettes du domaine (séparées par une virugule) +le courriel de l'administrateur +la langue du domaine (celle du site web) sur 2 caractères (en, fr...) +le dossier du serveur root + + +Exemple d'un domaine créé + +Une fois toutes les questions répondues, le fichier tyto_domain.ini est +créé dans le dossier du domaine. Quelques données supplémentaires sont +configurables dans le fichier, qui est au format INI. Il est plus que +recommandé de l'ouvrir et de vérifier son contenu +avant de continuer. Vous pouvez le lire avec la commande +tyto show domain. Le domaine est désactivé après sa création. + + + +[DOMAIN] +name = tyto.echolib.re +work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ +activated = True +title = Tyto - Littérateur +date = 2022 +about = Documentation officielle du littérateur libre +tags = Tyto,littérateur,logiciel libre,documentation +mail = echolib+tyto@a-lec.org + +[WEBSITE] +wip_url = https://www-wip.echolib.re/ +www_url = https://tyto.echolib.re/ +css = tyto +separator = | +article_code = True +lang = fr +license = gfdl-1.3 +license_url = https://www.gnu.org/licenses/fdl-1.3.txt + +[WEBSITE_FOOTER] +link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" +link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" +link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" +link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + +[WEBSITE_MODULES] +sidebar_title = Articles recommandés +sidebar_items = 6 +rss_items = 100 +sitemaps = True + +[TEMPLATE_FILENAMES] +favicon = favicon.png +logo = VH_Tyto_logo.png +styles = styles.css +rss = rss.xml +stats = tyto_stats.ini + +[SERVER] +srv_root = /home/echolib/Projets/www/ + +[TYTO] +id = 23ac1f4c +conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini +user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini + +Modifier la configuration + +Le fichier tyto_domain.ini dispose de catégories, comme [WEBSITE], avec +les paramètres clé = valeur. Si vous modifiez une valeur, Tyto vérifiera +et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans +certains cas, il faudra toutes les reconstruire. Si les modifications +concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être +reconstruit. + +Les valeurs importantes + + +[DOMAIN] +# Remplacer par True pour activer +# ou utiliser la commande tyto start / tyto stop +activated = False + +[WEBSITE] +# L'adresse (URL) du site web temporaire (wip) +wip_url = https://www-wip.domaine.tld/ + +# L'adresse (URL) du site officiel (publish) +www_url = https://domaine.tld/ + +# La classe CSS par défaut +css = tyto + +# Le séparateur entre le titre de la page et le titre du site +# dans la balise HTML <title> +separator = - + +# Valeur booléane True/False (Oui/Non) +# Afficher le lien vers le code source de l'article +article_code = False + +# Langue des pages du site +# La traduction doit exister (fournies: en, fr) +lang = fr + +[WEBSITE_MODULES] +# Le nom de la barre latérale +sidebar_title = Articles recommandés + +# Nombre d'articles dans la barre latérale (0 pour désactiver) +sidebar_items = 6 + +# Nombre d'articles dans le flux RSS (0 pour désactiver) +rss_items = 100 + +# Création automatique du sitemap (sitemap.html) +sitemaps = True + +[WEBSITE_FOOTER] +# Les liens du pied de page dans [WEBSITE_FOOTER] +# les clés link_1 à link_4 sont créés automatiquement +# Pour désactiver, enlever la valeur, laisser la clé ! +# Format de clé +# l'URL peut être locale. Ex : "/about/cgu.html" +clé = "Nom à afficher", "URL", "Contenu de title=" + +[TEMPLATE_FILENAMES] +# Nom des fichiers +# (à ajouter dans le dossier .../wip/template/) +favicon = favicon.png +logo = logo.png +styles = styles.css + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/config/index.tyto b/src/usr/share/tyto/docs/www/config/index.tyto new file mode 100644 index 0000000..7392b4c --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.tyto @@ -0,0 +1,192 @@ +title: Créer et configurer un domaine +about: Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur +tags: configuration,domaine +date: 2023-12-05 +authors: echolib + +link: format INI + https://fr.wikipedia.org/wiki/Fichier_INI + Page wikipédia en FR "Fichier INI" + +image: domain-form + tyto_new_domain_form.png + Formulaire lors de la création d'un domaine avec Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + +#1 Créer un domaine +(( + *`Tyto littérateur`* fonctionne dans un dossier ayant l'identité d'un nom de + domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez + le créer, à l'emplacement de votre choix. Ce dossier est votre + +`dossier de travail`+. Seulement une fois ce dossier ouvert (dans un + terminal), vous pouvez lancer la procédure de création du domaine afin de + créer votre nouveau site. +)) + +(( astuce + Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez + créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers + des domaines. +)) + + +#2 Les commandes à taper +{{ + # Commande bash pour créer un dossier du domaine + mkdir -p domaine.tld + + # Se placer dans le dossier créé + cd domaine.tld + + # Créer et configurer le domaine "domaine.tld" + tyto new domain +}} + + +#3 Répondre aux questions +(( + ::domain-form "c=bandeau", + | + Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de + quelques renseignements concernant ce domaine, et notemment : + (= + = le titre du domaine + = la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) + = la description du domaine + = les étiquettes du domaine (séparées par une virugule) + = le courriel de l'administrateur + = la langue du domaine (celle du site web) sur 2 caractères (en, fr...) + = le dossier du serveur root + )= +)) + + +#4 Exemple d'un domaine créé +(( + Une fois toutes les questions répondues, le fichier [`tyto_domain.ini`] est + créé dans le dossier du domaine. Quelques données supplémentaires sont + configurables dans le fichier, qui est au ::format INI. Il est plus que + recommandé de l'ouvrir et de +`vérifier son contenu`+ + *`&_`avant de continuer`_&`*. Vous pouvez le lire avec la commande + {`tyto show domain`}. Le domaine est désactivé après sa création. +)) +{{ + [DOMAIN] + name = tyto.echolib.re + work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ + activated = True + title = Tyto - Littérateur + date = 2022 + about = Documentation officielle du littérateur libre + tags = Tyto,littérateur,logiciel libre,documentation + mail = echolib+tyto@a-lec.org + + [WEBSITE] + wip_url = https://www-wip.echolib.re/ + www_url = https://tyto.echolib.re/ + css = tyto + separator = | + article_code = True + lang = fr + license = gfdl-1.3 + license_url = https://www.gnu.org/licenses/fdl-1.3.txt + + [WEBSITE_FOOTER] + link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" + link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" + link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" + link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + + [WEBSITE_MODULES] + sidebar_title = Articles recommandés + sidebar_items = 6 + rss_items = 100 + sitemaps = True + + [TEMPLATE_FILENAMES] + favicon = favicon.png + logo = VH_Tyto_logo.png + styles = styles.css + rss = rss.xml + stats = tyto_stats.ini + + [SERVER] + srv_root = /home/echolib/Projets/www/ + + [TYTO] + id = 23ac1f4c + conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini + user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini +}} + + +#2 Modifier la configuration +(( + Le fichier [`tyto_domain.ini`] dispose de catégories, comme [WEBSITE], avec + les paramètres {`clé = valeur`}. Si vous modifiez une valeur, Tyto vérifiera + et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans + certains cas, il faudra toutes les reconstruire. Si les modifications + concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être + reconstruit. +)) + + +#3 Les valeurs importantes +{{ + [DOMAIN] + # Remplacer par True pour activer + # ou utiliser la commande tyto start / tyto stop + activated = False + + [WEBSITE] + # L'adresse (URL) du site web temporaire (wip) + wip_url = https://www-wip.domaine.tld/ + + # L'adresse (URL) du site officiel (publish) + www_url = https://domaine.tld/ + + # La classe CSS par défaut + css = tyto + + # Le séparateur entre le titre de la page et le titre du site + # dans la balise HTML + separator = - + + # Valeur booléane True/False (Oui/Non) + # Afficher le lien vers le code source de l'article + article_code = False + + # Langue des pages du site + # La traduction doit exister (fournies: en, fr) + lang = fr + + [WEBSITE_MODULES] + # Le nom de la barre latérale + sidebar_title = Articles recommandés + + # Nombre d'articles dans la barre latérale (0 pour désactiver) + sidebar_items = 6 + + # Nombre d'articles dans le flux RSS (0 pour désactiver) + rss_items = 100 + + # Création automatique du sitemap (sitemap.html) + sitemaps = True + + [WEBSITE_FOOTER] + # Les liens du pied de page dans [WEBSITE_FOOTER] + # les clés link_1 à link_4 sont créés automatiquement + # Pour désactiver, enlever la valeur, laisser la clé ! + # Format de clé + # l'URL peut être locale. Ex : "/about/cgu.html" + clé = "Nom à afficher", "URL", "Contenu de title=" + + [TEMPLATE_FILENAMES] + # Nom des fichiers + # (à ajouter dans le dossier .../wip/template/) + favicon = favicon.png + logo = logo.png + styles = styles.css +}} diff --git a/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png new file mode 100644 index 0000000..07feb3d Binary files /dev/null and b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png differ diff --git a/website_doc/images/logos/format_tyto.png b/src/usr/share/tyto/docs/www/images/logos/format_tyto.png similarity index 100% rename from website_doc/images/logos/format_tyto.png rename to src/usr/share/tyto/docs/www/images/logos/format_tyto.png diff --git a/website_doc/images/logos/justice_scales_cc0.png b/src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png similarity index 100% rename from website_doc/images/logos/justice_scales_cc0.png rename to src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png diff --git a/website_doc/images/logos/tyto_5_metas.png b/src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png similarity index 100% rename from website_doc/images/logos/tyto_5_metas.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png diff --git a/website_doc/images/logos/tyto_titles_toc.png b/src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png similarity index 100% rename from website_doc/images/logos/tyto_titles_toc.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png diff --git a/website_doc/images/logos/tyto_welcome.png b/src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png similarity index 100% rename from website_doc/images/logos/tyto_welcome.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png diff --git a/website_doc/index.html b/src/usr/share/tyto/docs/www/index.html similarity index 88% rename from website_doc/index.html rename to src/usr/share/tyto/docs/www/index.html index 9c129ff..731bd0a 100644 --- a/website_doc/index.html +++ b/src/usr/share/tyto/docs/www/index.html @@ -33,7 +33,7 @@ <meta property="og:image" content="https://tyto.echolib.re/images/logos/tyto_welcome.png"> <!-- Publication date and title --> -<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date"> +<meta itemprop="datePublished" content="2024-01-17 18:19:13" id="date"> <title>Bienvenue, librement (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -71,6 +71,7 @@ par mail ou, de préférence, via Gestion et personnalisation Utilisation Traductions +Pour commencer Le projet @@ -125,6 +126,12 @@ utilisée par le système, mais chaque site peut utiliser l'une ou l'autre, via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. +Pour commencer + +Configurer un domaine +Écrire un article +Configurer les modules + diff --git a/website_doc/index.tyto b/src/usr/share/tyto/docs/www/index.tyto similarity index 86% rename from website_doc/index.tyto rename to src/usr/share/tyto/docs/www/index.tyto index 7a77069..05e8055 100644 --- a/website_doc/index.tyto +++ b/src/usr/share/tyto/docs/www/index.tyto @@ -13,6 +13,18 @@ link: chouette effraie https://fr.wikipedia.org/wiki/Chouette_effraie Tyto alba • Effraie des clochers +link: Configurer un domaine + ./config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: Écrire un article + ./article/index.html + Comment écrire un article pour Tyto - Littérateur + +link: Configurer les modules + ./modules/index.html + Comment gérer les modules (nginx) de Tyto - Littérateur + ! LOGO ------------------------------------------------------------------------------- @@ -87,3 +99,11 @@ link: chouette effraie via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. )) + + +#1 Pour commencer +(= + + ::Configurer un domaine + + ::Écrire un article + + ::Configurer les modules +)= diff --git a/src/usr/share/tyto/docs/www/modules/index.html b/src/usr/share/tyto/docs/www/modules/index.html new file mode 100644 index 0000000..407acd3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Gérer les modules dans les pages (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Gérer les modules dans les pages + + +echolib, 18/12/2023 [Code source] + + +Table des matières + + +Définitions des modules + +Le module "metas" + +Exemple HTML des metas + +Le module "header" + +Exemple HTML d'une entête + +Le module "navbar" + +Exemple HTML d'un menu + +Le module "sidebar" + +Exemple HTML d'une barre latérale + +Le module "footer" + +Exemple HTML de pied de page + + +Forcer une nouvelle génération des modules HTML +Afficher les modules dans les pages avec nginx + + +Définitions des modules + +Tyto - Littérateur intègre dans chaque page du site, différents modules. +Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le +contenu du fichier de configuration du module a changé. Vous pouvez les gérer, +et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" +dans le dossier de travail du domaine. Chaque fichier dispose d'une petite +aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer +la génération d'un module avec la commande tyto wip [module_name] + +Le module "metas" + +Le module "metas", issu du fichier de configuration "metas.raw" insère des +balises HTML <meta>, prioritaires. Les balises utilisées par défaut : + +Exemple HTML des metas + + +<meta charset="UTF-8"> +<meta name="robots" content="all"> +<meta name="medium" content="website"> +<meta name="revisit-after" content="3 days"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> + +Le module "header" + +Le module "header", issu du fichier de configuration "header.raw" insère +l'entête HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Voici un exemple de sa structure HTML et des +identificateurs CSS : + +Exemple HTML d'une entête + + +<a role="link" id="site_link" href="/" title="%s"> +<header id="header"> +<div id="header_logo"> +<img id="header_logo_image" src="%s" alt="%s"> +</div> +<div id="header_abouts"> +<p id="header_title">%s</p> +<p id="header_about">%s</p> +</div> +</header> +</a> + +Le module "navbar" + +Le module "navbar" issu du fichier de configuration "navbar.raw" insère +la barre de manu principale, libellée pour l'accessibilité, "navigation-1". +Son contenu par défaut est vide. + + +Pour ajouter un onglet au menu du site : + +créer un dossier dans le dossier de travail du domaine ".../articles/" +créer un article "index.tyto" dans le nouveau dossier +créer l'article HTML via la commande "wip" +éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + + +Exemple HTML d'un menu + + +<nav id="menu" aria-labelledby="navigation-1"> +<menu role="menu" id="menu_items"> +<li role="menuitem" class="menu_item"> +<a role="link" class="menu_link" href="%s" title="%s">%s</a> +</li> +</menu> +</nav> + +Le module "sidebar" + +Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère +la barre latérale contenant des articles à mettre en avant. Son contenu +par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la +::configuration du domaine. La barre latérale est libéllée pour +l'accessibilité "navigation-2" + + +Pour ajouter un article à la barre latérale : + +créer un article .tyto +créer l'article HTML via la commande "wip" +éditer le fichier sidebar.raw en ajoutant l'URI de l'article (URI depuis le dossier de travail du domaine ".../article/") + + +Exemple HTML d'une barre latérale + + +<aside id="sidebar"> +<div id="sidebar_title">%s</div> +<nav role="navigation" id="sidebar_menu" aria-labelledby="navigation-2"> +<ul role="list" id="sidebar_items"> +<li role="listitem" class="sidebar_item"> +<div class="sidebar_post_title"> +<a role="link" class="sidebar_post_link" href="%s">%s</a> +</div> +<div class="sidebar_post_about"> +<p class="sidebar_post_about_p" title="%s -- %s, %s">%s</p> +</div> +</li> +</ul> +</nav> +</aside> + +Le module "footer" + +Le module "footer" issu du fichier de configuration "footer.raw" insère le +pied de page HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Un menu de navigation, libellé pour +l'accessibilité "navigation-3", est créé automatiquement. + +Exemple HTML de pied de page + + +<footer id="footer"> +<div id="footer_title">%s <strong>%s</strong></div> +<div id="footer_about_menu"> +<div id="footer_about"> +%s +</div> +<nav id="footer_menu" aria-labelledby="navigation-3"> +<ul role="list" id="footer_items"> +<li role="listitem" class="footer_item"> +<a role="link" class="footer_item_link" href="%s" title="%s %s">%s</a> +</li> +</ul> +</nav> +</div> +<div id="footer_credit"> +<p id="footer_copyright">%s</p> +<p id="footer_tyto">%s</p> +</div> +</footer> + +Forcer une nouvelle génération des modules HTML + +Même si un module a déjà été généré, si vous avez besoin de forcer une +nouvelle génération de modules, il suffit de le demander, via l'action "wip". + +Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + + +tyto wip modules # Créer TOUS les modules HTML +tyto wip metas # Créer le module metas.html +tyto wip header # Créer le module header.html +tyto wip navbar # Créer le module navbar.html +tyto wip sidebar # Créer le module sidebar.html +tyto wip footer # Créer le module footer.html + + + +Vous pouvez forcer la création d'un module HTML, mais, si le fichier de +configuration a été modifié, il sera automatiquement mis à jour à la +prochaine création d'un article via la commande "wip". Il faut toutefois +forcer la génération, si une métadonnée indispensable d'un article se +trouvant dans le module, a été modifiée + +Afficher les modules dans les pages avec nginx + +Même si les pages du site sont statiques, les modules doivent être appelés +par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer +le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un +commentaire HTML conttient # include_virtual="". Dans la configuration +du serveur nginx, il faut ajouter : + + + +ssi on; +ssi_last_modified on; +absolute_redirect off; + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/modules/index.tyto b/src/usr/share/tyto/docs/www/modules/index.tyto new file mode 100644 index 0000000..d1ef6d9 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.tyto @@ -0,0 +1,201 @@ +title: Gérer les modules dans les pages +about: Comment gérer les modules (nginx) de Tyto - Littérateur +date: 2023-12-18 +tags: modules,nginx,metas,header,navbar,sidebar,footer +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: métadonnée indispensable + ../article/metas_obligatoires.html + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + + +#1 Définitions des modules +(( + *`Tyto - Littérateur`* intègre dans chaque page du site, différents modules. + Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le + contenu du fichier de configuration du module a changé. Vous pouvez les gérer, + et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" + dans le dossier de travail du domaine. Chaque fichier dispose d'une petite + aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer + la génération d'un module avec la commande {` tyto wip [module_name]`} +)) + +#2 Le module "metas" +(( + Le module "metas", issu du fichier de configuration "metas.raw" insère des + balises HTML {``}, prioritaires. Les balises utilisées par défaut : +)) + +#3 Exemple HTML des metas +{{ + + + + + +}} + + +#2 Le module "header" +(( + Le module "header", issu du fichier de configuration "header.raw" insère + +`l'entête`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Voici un exemple de sa structure HTML et des + identificateurs CSS : +)) + +#3 Exemple HTML d'une entête +{{ + + + + + + + %s + %s + + + +}} + +#2 Le module "navbar" +(( + Le module "navbar" issu du fichier de configuration "navbar.raw" insère + la +`barre de manu`+ principale, libellée pour l'accessibilité, "navigation-1". + Son contenu par défaut est vide. +)) +(( + Pour ajouter un onglet au menu du site : + (= + = créer un dossier dans le dossier de travail du domaine ".../articles/" + = créer un article "index.tyto" dans le nouveau dossier + = créer l'article HTML via la commande "wip" + = éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + )= +)) + +#3 Exemple HTML d'un menu +{{ + + + + %s + + + +}} + +#2 Le module "sidebar" +(( + Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère + la /`barre latérale`/ contenant des articles à mettre en avant. Son contenu + par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la + ::configuration du domaine. La barre latérale est libéllée pour + l'accessibilité "navigation-2" +)) +(( + Pour ajouter un article à la barre latérale : + (= + = créer un article .tyto + = créer l'article HTML via la commande "wip" + = éditer le fichier sidebar.raw en ajoutant l'URI de l'article + (URI depuis le dossier de travail du domaine ".../article/") + )= +)) + +#3 Exemple HTML d'une barre latérale +{{ + +}} + +#2 Le module "footer" +(( + Le module "footer" issu du fichier de configuration "footer.raw" insère le + +`pied de page`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Un menu de navigation, libellé pour + l'accessibilité "navigation-3", est créé automatiquement. +)) + +#3 Exemple HTML de pied de page +{{ + +}} + + +#1 Forcer une nouvelle génération des modules HTML +(( + Même si un module a déjà été généré, si vous avez besoin de forcer une + nouvelle génération de modules, il suffit de le demander, via l'action "wip". + | + Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + {{ + tyto wip modules # Créer TOUS les modules HTML + tyto wip metas # Créer le module metas.html + tyto wip header # Créer le module header.html + tyto wip navbar # Créer le module navbar.html + tyto wip sidebar # Créer le module sidebar.html + tyto wip footer # Créer le module footer.html + }} +)) +(( note + Vous pouvez forcer la création d'un module HTML, mais, si le fichier de + configuration a été modifié, il sera automatiquement mis à jour à la + prochaine création d'un article via la commande "wip". Il faut toutefois + forcer la génération, si une ::métadonnée indispensable d'un article se + trouvant dans le module, a été modifiée +)) + + +#1 Afficher les modules dans les pages avec nginx +(( + Même si les pages du site sont statiques, les modules doivent être appelés + par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer + le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un + commentaire HTML conttient {`# include_virtual=""`}. Dans la configuration + du serveur nginx, il faut ajouter : +)) +{{ + ssi on; + ssi_last_modified on; + absolute_redirect off; +}} diff --git a/website_doc/rss.xml b/src/usr/share/tyto/docs/www/rss.xml similarity index 59% rename from website_doc/rss.xml rename to src/usr/share/tyto/docs/www/rss.xml index 5e29d80..1f764ae 100644 --- a/website_doc/rss.xml +++ b/src/usr/share/tyto/docs/www/rss.xml @@ -3,7 +3,7 @@ - + @@ -20,118 +20,13 @@ fr Tyto,littérateur,logiciel libre,documentation - Mon, 15 Jan 2024 18:28:34 + Wed, 17 Jan 2024 18:19:13 gfdl-1.3 echolib+tyto@a-lec.org Tyto - Littérateur - - Écrire les titres et sous-titres - https://tyto.echolib.re/article/redac_titres.html - https://tyto.echolib.re/article/redac_titres.html - Sun, 07 Jan 2024 - Comment écrire les titres et les sous-titres pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_titles_toc.png - Écrire les titres et sous-titres (logo) - https://tyto.echolib.re/article/redac_titres.html - - format .tyto,écrire,rédaction,titres,table des matières - - - - Mentions Légales - https://tyto.echolib.re/a-propos/index.html - https://tyto.echolib.re/a-propos/index.html - Sun, 14 Jan 2024 - Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/justice_scales_cc0.png - Mentions Légales (logo) - https://tyto.echolib.re/a-propos/index.html - - mentions légales,C.G.U,licence - - - - Écrire un article au format .tyto - https://tyto.echolib.re/article/index.html - https://tyto.echolib.re/article/index.html - Sat, 06 Jan 2024 - Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/format_tyto.png - Écrire un article au format .tyto (logo) - https://tyto.echolib.re/article/index.html - - format .tyto,écrire, - - - - Écrire les métadonnées indispensables - https://tyto.echolib.re/article/metas_obligatoires.html - https://tyto.echolib.re/article/metas_obligatoires.html - Sat, 06 Jan 2024 - Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_5_metas.png - Écrire les métadonnées indispensables (logo) - https://tyto.echolib.re/article/metas_obligatoires.html - - format .tyto,écrire,métadonnées,entête - - - - Les URIs spécifiques - https://tyto.echolib.re/article/metas_uris.html - https://tyto.echolib.re/article/metas_uris.html - Mon, 08 Jan 2024 - Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Les URIs spécifiques (logo) - https://tyto.echolib.re/article/metas_uris.html - - format .tyto,écrire,liens,URIs - - - - Écrire/créer des liens - https://tyto.echolib.re/article/metas_liens.html - https://tyto.echolib.re/article/metas_liens.html - Mon, 08 Jan 2024 - Comment écrire des liens pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Écrire/créer des liens (logo) - https://tyto.echolib.re/article/metas_liens.html - - format .tyto,écrire,liens - - - - Page non trouvée - https://tyto.echolib.re/404.html - https://tyto.echolib.re/404.html - Sat, 13 Jan 2024 - Page d'erreur 404, indiquant que la page demandée n'existe pas/plus - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Page non trouvée (logo) - https://tyto.echolib.re/404.html - - 404,erreur - - Bienvenue, librement https://tyto.echolib.re/index.html @@ -146,6 +41,171 @@ accueil,projet,description + + + Afficher du code en bloc + https://tyto.echolib.re/article/redac_blockcodes.html + https://tyto.echolib.re/article/redac_blockcodes.html + Tue, 16 Jan 2024 + Comment afficher du code en bloc pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher du code en bloc (logo) + https://tyto.echolib.re/article/redac_blockcodes.html + + rédaction,marqueurs,blockcode + + + + Les URIs spécifiques + https://tyto.echolib.re/article/metas_uris.html + https://tyto.echolib.re/article/metas_uris.html + Mon, 08 Jan 2024 + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Les URIs spécifiques (logo) + https://tyto.echolib.re/article/metas_uris.html + + format .tyto,écrire,liens,URIs + + + + Créer des liens + https://tyto.echolib.re/article/metas_liens.html + https://tyto.echolib.re/article/metas_liens.html + Mon, 08 Jan 2024 + Comment écrire des liens pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer des liens (logo) + https://tyto.echolib.re/article/metas_liens.html + + format .tyto,écrire,liens + + + + Écrire les métadonnées indispensables + https://tyto.echolib.re/article/metas_obligatoires.html + https://tyto.echolib.re/article/metas_obligatoires.html + Sat, 06 Jan 2024 + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_5_metas.png + Écrire les métadonnées indispensables (logo) + https://tyto.echolib.re/article/metas_obligatoires.html + + format .tyto,écrire,métadonnées,entête + + + + Écrire des paragraphes + https://tyto.echolib.re/article/redac_paragraphes.html + https://tyto.echolib.re/article/redac_paragraphes.html + Tue, 05 Dec 2023 + Comment écrire des paragraphes pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Écrire des paragraphes (logo) + https://tyto.echolib.re/article/redac_paragraphes.html + + rédaction,marqueurs,paragraphes + + + + Mentions Légales + https://tyto.echolib.re/a-propos/index.html + https://tyto.echolib.re/a-propos/index.html + Sun, 14 Jan 2024 + Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/justice_scales_cc0.png + Mentions Légales (logo) + https://tyto.echolib.re/a-propos/index.html + + mentions légales,C.G.U,licence + + + + Écrire des titres et sous-titres + https://tyto.echolib.re/article/redac_titres.html + https://tyto.echolib.re/article/redac_titres.html + Sun, 07 Jan 2024 + Comment écrire les titres et les sous-titres pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_titles_toc.png + Écrire des titres et sous-titres (logo) + https://tyto.echolib.re/article/redac_titres.html + + rédaction,marqueurs,titres,table des matières + + + + Écrire un article au format .tyto + https://tyto.echolib.re/article/index.html + https://tyto.echolib.re/article/index.html + Sat, 06 Jan 2024 + Comment écrire un article pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/format_tyto.png + Écrire un article au format .tyto (logo) + https://tyto.echolib.re/article/index.html + + format .tyto,écrire, + + + + Afficher des images + https://tyto.echolib.re/article/mere_images.html + https://tyto.echolib.re/article/mere_images.html + Tue, 05 Dec 2023 + Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher des images (logo) + https://tyto.echolib.re/article/mere_images.html + + marqueurs,images + + + + Gérer les modules dans les pages + https://tyto.echolib.re/modules/index.html + https://tyto.echolib.re/modules/index.html + Mon, 18 Dec 2023 + Comment gérer les modules (nginx) de Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Gérer les modules dans les pages (logo) + https://tyto.echolib.re/modules/index.html + + modules,nginx,metas,header,navbar,sidebar,footer + + + + Créer et configurer un domaine + https://tyto.echolib.re/config/index.html + https://tyto.echolib.re/config/index.html + Tue, 05 Dec 2023 + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer et configurer un domaine (logo) + https://tyto.echolib.re/config/index.html + + configuration,domaine + diff --git a/src/usr/share/tyto/docs/www/sitemap.html b/src/usr/share/tyto/docs/www/sitemap.html new file mode 100644 index 0000000..af9f55b --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.html @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Plan du site (Tyto) | Tyto - Littérateur + + + + + + + + + + + + + + + +Plan du site + + +Tyto, 17/01/2024 [Code source] + + +Liste des articles (12) + + +Bienvenue, librement +Afficher du code en bloc +Les URIs spécifiques +Créer des liens +Écrire les métadonnées indispensables +Écrire des paragraphes +Mentions Légales +Écrire des titres et sous-titres +Écrire un article au format .tyto +Afficher des images +Gérer les modules dans les pages +Créer et configurer un domaine + + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/sitemap.tyto b/src/usr/share/tyto/docs/www/sitemap.tyto new file mode 100644 index 0000000..273605e --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.tyto @@ -0,0 +1,29 @@ +# Tyto - Littérateur +! NOMAP +! NORSS + +title: Plan du site +about: Plan du site généré par Tyto - Littérateur +tags: Plan du site +authors: Tyto +date: 2024-01-17 + +----- +#1 Liste des articles (12) + +(( sitemap + (= sitemap_items + + Bienvenue, librement + + Afficher du code en bloc + + Les URIs spécifiques + + Créer des liens + + Écrire les métadonnées indispensables + + Écrire des paragraphes + + Mentions Légales + + Écrire des titres et sous-titres + + Écrire un article au format .tyto + + Afficher des images + + Gérer les modules dans les pages + + Créer et configurer un domaine + )= +)) diff --git a/website_doc/template/VH_Tyto_logo.png b/src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png similarity index 100% rename from website_doc/template/VH_Tyto_logo.png rename to src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png diff --git a/website_doc/template/favicon.png b/src/usr/share/tyto/docs/www/template/favicon.png similarity index 100% rename from website_doc/template/favicon.png rename to src/usr/share/tyto/docs/www/template/favicon.png diff --git a/website_doc/template/footer.html b/src/usr/share/tyto/docs/www/template/footer.html similarity index 96% rename from website_doc/template/footer.html rename to src/usr/share/tyto/docs/www/template/footer.html index b327fae..4090a32 100644 --- a/website_doc/template/footer.html +++ b/src/usr/share/tyto/docs/www/template/footer.html @@ -12,7 +12,7 @@ en Python par Cyrille Louarn (echol Le code source est composé (hors fichiers de traductions) de 18 fichiers -totalisant 5048 lignes dont 1231 lignes commentées, soit 2851 lignes de scripts. +totalisant 5051 lignes dont 1231 lignes commentées, soit 2853 lignes de scripts. Tyto - Littérateur (version 1.11.4) est fait avec amour <3 diff --git a/website_doc/template/header.html b/src/usr/share/tyto/docs/www/template/header.html similarity index 100% rename from website_doc/template/header.html rename to src/usr/share/tyto/docs/www/template/header.html diff --git a/website_doc/template/metas.html b/src/usr/share/tyto/docs/www/template/metas.html similarity index 100% rename from website_doc/template/metas.html rename to src/usr/share/tyto/docs/www/template/metas.html diff --git a/src/usr/share/tyto/docs/www/template/navbar.html b/src/usr/share/tyto/docs/www/template/navbar.html new file mode 100644 index 0000000..bbfa1d0 --- /dev/null +++ b/src/usr/share/tyto/docs/www/template/navbar.html @@ -0,0 +1,9 @@ + + + +config +article +modules +publier + + diff --git a/website_doc/template/sidebar.html b/src/usr/share/tyto/docs/www/template/sidebar.html similarity index 100% rename from website_doc/template/sidebar.html rename to src/usr/share/tyto/docs/www/template/sidebar.html diff --git a/website_doc/template/styles.css b/src/usr/share/tyto/docs/www/template/styles.css similarity index 99% rename from website_doc/template/styles.css rename to src/usr/share/tyto/docs/www/template/styles.css index 0818419..f4e1d69 100644 --- a/website_doc/template/styles.css +++ b/src/usr/share/tyto/docs/www/template/styles.css @@ -166,6 +166,10 @@ h6.tyto { font-size: 1.2rem; } +img.bandeau { + max-width: 100% +} + p.alert { color: #FFFDA5; font-weight: bold; @@ -254,6 +258,7 @@ ul.tyto :is(ol, ul) { footer#footer { border-top: 2px dotted gray; color: #FFF; + margin-top: 40px; } div#footer_title { diff --git a/website_doc/sitemap.html b/website_doc/sitemap.html deleted file mode 100644 index c643e3a..0000000 --- a/website_doc/sitemap.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plan du site (Tyto) | Tyto - Littérateur - - - - - - - - - - - - - - - -Plan du site - - -Tyto, 15/01/2024 [Code source] - - -Liste des articles (8) - - -Écrire les titres et sous-titres -Mentions Légales -Écrire un article au format .tyto -Écrire les métadonnées indispensables -Les URIs spécifiques -Écrire/créer des liens -Page non trouvée -Bienvenue, librement - - - - - - - - - - - - - - - - diff --git a/website_doc/sitemap.tyto b/website_doc/sitemap.tyto deleted file mode 100644 index 6099374..0000000 --- a/website_doc/sitemap.tyto +++ /dev/null @@ -1,25 +0,0 @@ -# Tyto - Littérateur -! NOMAP -! NORSS - -title: Plan du site -about: Plan du site généré par Tyto - Littérateur -tags: Plan du site -authors: Tyto -date: 2024-01-15 - ------ -#1 Liste des articles (8) - -(( sitemap - (= sitemap_items - + Écrire les titres et sous-titres - + Mentions Légales - + Écrire un article au format .tyto - + Écrire les métadonnées indispensables - + Les URIs spécifiques - + Écrire/créer des liens - + Page non trouvée - + Bienvenue, librement - )= -)) diff --git a/website_doc/template/navbar.html b/website_doc/template/navbar.html deleted file mode 100644 index 3a46f7b..0000000 --- a/website_doc/template/navbar.html +++ /dev/null @@ -1,6 +0,0 @@ - - - -article - -
- + diff --git a/website_doc/article/metas_uris.tyto b/src/usr/share/tyto/docs/www/article/metas_uris.tyto similarity index 100% rename from website_doc/article/metas_uris.tyto rename to src/usr/share/tyto/docs/www/article/metas_uris.tyto diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.html b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html new file mode 100644 index 0000000..84532f3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.html @@ -0,0 +1,143 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Afficher du code en bloc (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Afficher du code en bloc + + +echolib, 16/01/2024 [Code source] + + +Table des matières + + +Les marqueurs +Exemples de code en bloc + +Sortie HTML + + + +Les marqueurs + +Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture +{{ et de fermeture }}, et placer les lignes de codes dedans. +Il est recommandé d'indenter les lignes de codes dans le bloc. Tyto +prend en compte l'indentation de la première ligne de code pour l'affichage +HTML. + + +Les marqueurs d'ouverture et de fermeture doivent se trouver au +même niveau d'indentation dans l'article source, et sonts seuls sur une +ligne + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est "bcode". La classe est reprise dans les balises HTML. +Voir ci-dessous la sortie HTML des exemples suivants. + +Exemples de code en bloc + + +# Comment afficher du code pour Tyto - Littérateur +{{ + Placer du code ici + et encore là... +}} + + + +{{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) +}} + +Sortie HTML + + +<pre class="bcode_pre"> +<ol class="bcode_items"> +<li role="listitem" class="bcode_item"><code class="bcode_code"># Comment afficher du code pour Tyto - Littérateur</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">{{</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> Placer du code ici</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> et encore là...</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">}}</code></li> +</ol> +</pre> +<pre class="MonCode_pre"> +<ol class="MonCode_items"> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">{{ MonCode</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # ! Aucune propriété de style MonCode existe</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # dans styles.css. Affichage par défaut</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> def tyto_code(hello):</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> if hello:</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> print(hello)</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">}}</code></li> +</ol> +</pre> + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto new file mode 100644 index 0000000..25c3e9b --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_blockcodes.tyto @@ -0,0 +1,71 @@ +title: Afficher du code en bloc +about: Comment afficher du code en bloc pour Tyto - Littérateur +tags: rédaction,marqueurs,blockcode +date: 2024-01-16 +authors: echolib + +------------------------------------------------------------------------------- +! TOC + +#1 Les marqueurs +(( + Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture + {` {{ `} et de fermeture {` }} `}, et placer les lignes de codes dedans. + Il est recommandé d'indenter les lignes de codes dans le bloc. :`Tyto`: + prend en compte l'indentation de la première ligne de code pour l'affichage + HTML. +)) +(( + Les marqueurs d'ouverture et de fermeture doivent se trouver *`au + même niveau d'indentation`* dans l'article source, et *`sonts seuls sur une + ligne`* +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est "bcode". La classe est reprise dans les balises HTML. + Voir ci-dessous la sortie HTML des exemples suivants. +)) + + +#1 Exemples de code en bloc +{{ + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} +}} + +{{ MonCode + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} +}} + +#2 Sortie HTML +{{ + + + # Comment afficher du code pour Tyto - Littérateur + {{ + Placer du code ici + et encore là... + }} + + + + + {{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) + }} + + +}} diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.html b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html new file mode 100644 index 0000000..2dc55da --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.html @@ -0,0 +1,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Écrire des paragraphes (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Écrire des paragraphes + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Les marqueurs + +Exemple de paragraphes + + + +Les marqueurs + +Les marqueurs de paragraphes forment un bloc. Pour écrire des +paragraphes <p></p> en HTML, et même les imbriquer, il faut écrire du +texte entre les marqueurs d'ouverture ((, et de fermeture )). +Ces marqueurs doivent être placés seuls au début d'une ligne. + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est celle dans la configuration du domaine. + + +Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, +indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. + +Exemple de paragraphes + + +(( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) +)) + +(( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B +)) + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto new file mode 100644 index 0000000..440f016 --- /dev/null +++ b/src/usr/share/tyto/docs/www/article/redac_paragraphes.tyto @@ -0,0 +1,49 @@ +title: Écrire des paragraphes +about: Comment écrire des paragraphes pour Tyto - Littérateur +tags: rédaction,marqueurs,paragraphes +date: 2023-12-05 +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + + +------------------------------------------------------------------------------- +! TOC + + +#1 Les marqueurs +(( + Les *`marqueurs de paragraphes`* forment un bloc. Pour écrire des + paragraphes {` `} en HTML, et même les imbriquer, il faut écrire du + texte entre les marqueurs d'ouverture {` (( `}, et de fermeture {` )) `}. + Ces marqueurs doivent être placés +`seuls au début d'une ligne`+. +)) +(( + Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, + la classe utilisée est celle dans la ::configuration du domaine. +)) +(( astuce + Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, + indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. +)) + + +#2 Exemple de paragraphes +{{ + (( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) + )) + + (( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B + )) +}} diff --git a/website_doc/article/redac_titres.html b/src/usr/share/tyto/docs/www/article/redac_titres.html similarity index 87% rename from website_doc/article/redac_titres.html rename to src/usr/share/tyto/docs/www/article/redac_titres.html index 56957f1..17e22f9 100644 --- a/website_doc/article/redac_titres.html +++ b/src/usr/share/tyto/docs/www/article/redac_titres.html @@ -1,4 +1,4 @@ - + @@ -13,10 +13,10 @@ - + - + @@ -26,15 +26,15 @@ - + - -Écrire les titres et sous-titres (echolib) | Tyto - Littérateur + +Écrire des titres et sous-titres (echolib) | Tyto - Littérateur @@ -46,14 +46,14 @@ - + - + -Écrire les titres et sous-titres +Écrire des titres et sous-titres -echolib, 07/01/2024 [Code source] +echolib, 07/01/2024 [Code source] Table des matières diff --git a/website_doc/article/redac_titres.tyto b/src/usr/share/tyto/docs/www/article/redac_titres.tyto similarity index 93% rename from website_doc/article/redac_titres.tyto rename to src/usr/share/tyto/docs/www/article/redac_titres.tyto index 49ad6a1..339b4ff 100644 --- a/website_doc/article/redac_titres.tyto +++ b/src/usr/share/tyto/docs/www/article/redac_titres.tyto @@ -1,7 +1,7 @@ -title: Écrire les titres et sous-titres +title: Écrire des titres et sous-titres about: Comment écrire les titres et les sous-titres pour Tyto - Littérateur date: 2024-01-07 -tags: format .tyto,écrire,rédaction,titres,table des matières +tags: rédaction,marqueurs,titres,table des matières authors: echolib logo: @logos/tyto_titles_toc.png diff --git a/src/usr/share/tyto/docs/www/config/index.html b/src/usr/share/tyto/docs/www/config/index.html new file mode 100644 index 0000000..076ec9e --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Créer et configurer un domaine (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Créer et configurer un domaine + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Créer un domaine + +Les commandes à taper + +Répondre aux questions + +Exemple d'un domaine créé + + +Modifier la configuration + +Les valeurs importantes + + + + +Créer un domaine + +Tyto littérateur fonctionne dans un dossier ayant l'identité d'un nom de +domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez +le créer, à l'emplacement de votre choix. Ce dossier est votre +dossier de travail. Seulement une fois ce dossier ouvert (dans un +terminal), vous pouvez lancer la procédure de création du domaine afin de +créer votre nouveau site. + + +Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez +créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers +des domaines. + +Les commandes à taper + + +# Commande bash pour créer un dossier du domaine +mkdir -p domaine.tld + +# Se placer dans le dossier créé +cd domaine.tld + +# Créer et configurer le domaine "domaine.tld" +tyto new domain + +Répondre aux questions + + + +Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de +quelques renseignements concernant ce domaine, et notemment : + +le titre du domaine +la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) +la description du domaine +les étiquettes du domaine (séparées par une virugule) +le courriel de l'administrateur +la langue du domaine (celle du site web) sur 2 caractères (en, fr...) +le dossier du serveur root + + +Exemple d'un domaine créé + +Une fois toutes les questions répondues, le fichier tyto_domain.ini est +créé dans le dossier du domaine. Quelques données supplémentaires sont +configurables dans le fichier, qui est au format INI. Il est plus que +recommandé de l'ouvrir et de vérifier son contenu +avant de continuer. Vous pouvez le lire avec la commande +tyto show domain. Le domaine est désactivé après sa création. + + + +[DOMAIN] +name = tyto.echolib.re +work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ +activated = True +title = Tyto - Littérateur +date = 2022 +about = Documentation officielle du littérateur libre +tags = Tyto,littérateur,logiciel libre,documentation +mail = echolib+tyto@a-lec.org + +[WEBSITE] +wip_url = https://www-wip.echolib.re/ +www_url = https://tyto.echolib.re/ +css = tyto +separator = | +article_code = True +lang = fr +license = gfdl-1.3 +license_url = https://www.gnu.org/licenses/fdl-1.3.txt + +[WEBSITE_FOOTER] +link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" +link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" +link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" +link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + +[WEBSITE_MODULES] +sidebar_title = Articles recommandés +sidebar_items = 6 +rss_items = 100 +sitemaps = True + +[TEMPLATE_FILENAMES] +favicon = favicon.png +logo = VH_Tyto_logo.png +styles = styles.css +rss = rss.xml +stats = tyto_stats.ini + +[SERVER] +srv_root = /home/echolib/Projets/www/ + +[TYTO] +id = 23ac1f4c +conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini +user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini + +Modifier la configuration + +Le fichier tyto_domain.ini dispose de catégories, comme [WEBSITE], avec +les paramètres clé = valeur. Si vous modifiez une valeur, Tyto vérifiera +et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans +certains cas, il faudra toutes les reconstruire. Si les modifications +concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être +reconstruit. + +Les valeurs importantes + + +[DOMAIN] +# Remplacer par True pour activer +# ou utiliser la commande tyto start / tyto stop +activated = False + +[WEBSITE] +# L'adresse (URL) du site web temporaire (wip) +wip_url = https://www-wip.domaine.tld/ + +# L'adresse (URL) du site officiel (publish) +www_url = https://domaine.tld/ + +# La classe CSS par défaut +css = tyto + +# Le séparateur entre le titre de la page et le titre du site +# dans la balise HTML <title> +separator = - + +# Valeur booléane True/False (Oui/Non) +# Afficher le lien vers le code source de l'article +article_code = False + +# Langue des pages du site +# La traduction doit exister (fournies: en, fr) +lang = fr + +[WEBSITE_MODULES] +# Le nom de la barre latérale +sidebar_title = Articles recommandés + +# Nombre d'articles dans la barre latérale (0 pour désactiver) +sidebar_items = 6 + +# Nombre d'articles dans le flux RSS (0 pour désactiver) +rss_items = 100 + +# Création automatique du sitemap (sitemap.html) +sitemaps = True + +[WEBSITE_FOOTER] +# Les liens du pied de page dans [WEBSITE_FOOTER] +# les clés link_1 à link_4 sont créés automatiquement +# Pour désactiver, enlever la valeur, laisser la clé ! +# Format de clé +# l'URL peut être locale. Ex : "/about/cgu.html" +clé = "Nom à afficher", "URL", "Contenu de title=" + +[TEMPLATE_FILENAMES] +# Nom des fichiers +# (à ajouter dans le dossier .../wip/template/) +favicon = favicon.png +logo = logo.png +styles = styles.css + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/config/index.tyto b/src/usr/share/tyto/docs/www/config/index.tyto new file mode 100644 index 0000000..7392b4c --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.tyto @@ -0,0 +1,192 @@ +title: Créer et configurer un domaine +about: Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur +tags: configuration,domaine +date: 2023-12-05 +authors: echolib + +link: format INI + https://fr.wikipedia.org/wiki/Fichier_INI + Page wikipédia en FR "Fichier INI" + +image: domain-form + tyto_new_domain_form.png + Formulaire lors de la création d'un domaine avec Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + +#1 Créer un domaine +(( + *`Tyto littérateur`* fonctionne dans un dossier ayant l'identité d'un nom de + domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez + le créer, à l'emplacement de votre choix. Ce dossier est votre + +`dossier de travail`+. Seulement une fois ce dossier ouvert (dans un + terminal), vous pouvez lancer la procédure de création du domaine afin de + créer votre nouveau site. +)) + +(( astuce + Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez + créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers + des domaines. +)) + + +#2 Les commandes à taper +{{ + # Commande bash pour créer un dossier du domaine + mkdir -p domaine.tld + + # Se placer dans le dossier créé + cd domaine.tld + + # Créer et configurer le domaine "domaine.tld" + tyto new domain +}} + + +#3 Répondre aux questions +(( + ::domain-form "c=bandeau", + | + Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de + quelques renseignements concernant ce domaine, et notemment : + (= + = le titre du domaine + = la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) + = la description du domaine + = les étiquettes du domaine (séparées par une virugule) + = le courriel de l'administrateur + = la langue du domaine (celle du site web) sur 2 caractères (en, fr...) + = le dossier du serveur root + )= +)) + + +#4 Exemple d'un domaine créé +(( + Une fois toutes les questions répondues, le fichier [`tyto_domain.ini`] est + créé dans le dossier du domaine. Quelques données supplémentaires sont + configurables dans le fichier, qui est au ::format INI. Il est plus que + recommandé de l'ouvrir et de +`vérifier son contenu`+ + *`&_`avant de continuer`_&`*. Vous pouvez le lire avec la commande + {`tyto show domain`}. Le domaine est désactivé après sa création. +)) +{{ + [DOMAIN] + name = tyto.echolib.re + work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ + activated = True + title = Tyto - Littérateur + date = 2022 + about = Documentation officielle du littérateur libre + tags = Tyto,littérateur,logiciel libre,documentation + mail = echolib+tyto@a-lec.org + + [WEBSITE] + wip_url = https://www-wip.echolib.re/ + www_url = https://tyto.echolib.re/ + css = tyto + separator = | + article_code = True + lang = fr + license = gfdl-1.3 + license_url = https://www.gnu.org/licenses/fdl-1.3.txt + + [WEBSITE_FOOTER] + link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" + link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" + link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" + link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + + [WEBSITE_MODULES] + sidebar_title = Articles recommandés + sidebar_items = 6 + rss_items = 100 + sitemaps = True + + [TEMPLATE_FILENAMES] + favicon = favicon.png + logo = VH_Tyto_logo.png + styles = styles.css + rss = rss.xml + stats = tyto_stats.ini + + [SERVER] + srv_root = /home/echolib/Projets/www/ + + [TYTO] + id = 23ac1f4c + conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini + user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini +}} + + +#2 Modifier la configuration +(( + Le fichier [`tyto_domain.ini`] dispose de catégories, comme [WEBSITE], avec + les paramètres {`clé = valeur`}. Si vous modifiez une valeur, Tyto vérifiera + et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans + certains cas, il faudra toutes les reconstruire. Si les modifications + concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être + reconstruit. +)) + + +#3 Les valeurs importantes +{{ + [DOMAIN] + # Remplacer par True pour activer + # ou utiliser la commande tyto start / tyto stop + activated = False + + [WEBSITE] + # L'adresse (URL) du site web temporaire (wip) + wip_url = https://www-wip.domaine.tld/ + + # L'adresse (URL) du site officiel (publish) + www_url = https://domaine.tld/ + + # La classe CSS par défaut + css = tyto + + # Le séparateur entre le titre de la page et le titre du site + # dans la balise HTML + separator = - + + # Valeur booléane True/False (Oui/Non) + # Afficher le lien vers le code source de l'article + article_code = False + + # Langue des pages du site + # La traduction doit exister (fournies: en, fr) + lang = fr + + [WEBSITE_MODULES] + # Le nom de la barre latérale + sidebar_title = Articles recommandés + + # Nombre d'articles dans la barre latérale (0 pour désactiver) + sidebar_items = 6 + + # Nombre d'articles dans le flux RSS (0 pour désactiver) + rss_items = 100 + + # Création automatique du sitemap (sitemap.html) + sitemaps = True + + [WEBSITE_FOOTER] + # Les liens du pied de page dans [WEBSITE_FOOTER] + # les clés link_1 à link_4 sont créés automatiquement + # Pour désactiver, enlever la valeur, laisser la clé ! + # Format de clé + # l'URL peut être locale. Ex : "/about/cgu.html" + clé = "Nom à afficher", "URL", "Contenu de title=" + + [TEMPLATE_FILENAMES] + # Nom des fichiers + # (à ajouter dans le dossier .../wip/template/) + favicon = favicon.png + logo = logo.png + styles = styles.css +}} diff --git a/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png new file mode 100644 index 0000000..07feb3d Binary files /dev/null and b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png differ diff --git a/website_doc/images/logos/format_tyto.png b/src/usr/share/tyto/docs/www/images/logos/format_tyto.png similarity index 100% rename from website_doc/images/logos/format_tyto.png rename to src/usr/share/tyto/docs/www/images/logos/format_tyto.png diff --git a/website_doc/images/logos/justice_scales_cc0.png b/src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png similarity index 100% rename from website_doc/images/logos/justice_scales_cc0.png rename to src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png diff --git a/website_doc/images/logos/tyto_5_metas.png b/src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png similarity index 100% rename from website_doc/images/logos/tyto_5_metas.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png diff --git a/website_doc/images/logos/tyto_titles_toc.png b/src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png similarity index 100% rename from website_doc/images/logos/tyto_titles_toc.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png diff --git a/website_doc/images/logos/tyto_welcome.png b/src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png similarity index 100% rename from website_doc/images/logos/tyto_welcome.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png diff --git a/website_doc/index.html b/src/usr/share/tyto/docs/www/index.html similarity index 88% rename from website_doc/index.html rename to src/usr/share/tyto/docs/www/index.html index 9c129ff..731bd0a 100644 --- a/website_doc/index.html +++ b/src/usr/share/tyto/docs/www/index.html @@ -33,7 +33,7 @@ <meta property="og:image" content="https://tyto.echolib.re/images/logos/tyto_welcome.png"> <!-- Publication date and title --> -<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date"> +<meta itemprop="datePublished" content="2024-01-17 18:19:13" id="date"> <title>Bienvenue, librement (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -71,6 +71,7 @@ par mail ou, de préférence, via Gestion et personnalisation Utilisation Traductions +Pour commencer Le projet @@ -125,6 +126,12 @@ utilisée par le système, mais chaque site peut utiliser l'une ou l'autre, via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. +Pour commencer + +Configurer un domaine +Écrire un article +Configurer les modules + diff --git a/website_doc/index.tyto b/src/usr/share/tyto/docs/www/index.tyto similarity index 86% rename from website_doc/index.tyto rename to src/usr/share/tyto/docs/www/index.tyto index 7a77069..05e8055 100644 --- a/website_doc/index.tyto +++ b/src/usr/share/tyto/docs/www/index.tyto @@ -13,6 +13,18 @@ link: chouette effraie https://fr.wikipedia.org/wiki/Chouette_effraie Tyto alba • Effraie des clochers +link: Configurer un domaine + ./config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: Écrire un article + ./article/index.html + Comment écrire un article pour Tyto - Littérateur + +link: Configurer les modules + ./modules/index.html + Comment gérer les modules (nginx) de Tyto - Littérateur + ! LOGO ------------------------------------------------------------------------------- @@ -87,3 +99,11 @@ link: chouette effraie via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. )) + + +#1 Pour commencer +(= + + ::Configurer un domaine + + ::Écrire un article + + ::Configurer les modules +)= diff --git a/src/usr/share/tyto/docs/www/modules/index.html b/src/usr/share/tyto/docs/www/modules/index.html new file mode 100644 index 0000000..407acd3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Gérer les modules dans les pages (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Gérer les modules dans les pages + + +echolib, 18/12/2023 [Code source] + + +Table des matières + + +Définitions des modules + +Le module "metas" + +Exemple HTML des metas + +Le module "header" + +Exemple HTML d'une entête + +Le module "navbar" + +Exemple HTML d'un menu + +Le module "sidebar" + +Exemple HTML d'une barre latérale + +Le module "footer" + +Exemple HTML de pied de page + + +Forcer une nouvelle génération des modules HTML +Afficher les modules dans les pages avec nginx + + +Définitions des modules + +Tyto - Littérateur intègre dans chaque page du site, différents modules. +Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le +contenu du fichier de configuration du module a changé. Vous pouvez les gérer, +et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" +dans le dossier de travail du domaine. Chaque fichier dispose d'une petite +aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer +la génération d'un module avec la commande tyto wip [module_name] + +Le module "metas" + +Le module "metas", issu du fichier de configuration "metas.raw" insère des +balises HTML <meta>, prioritaires. Les balises utilisées par défaut : + +Exemple HTML des metas + + +<meta charset="UTF-8"> +<meta name="robots" content="all"> +<meta name="medium" content="website"> +<meta name="revisit-after" content="3 days"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> + +Le module "header" + +Le module "header", issu du fichier de configuration "header.raw" insère +l'entête HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Voici un exemple de sa structure HTML et des +identificateurs CSS : + +Exemple HTML d'une entête + + +<a role="link" id="site_link" href="/" title="%s"> +<header id="header"> +<div id="header_logo"> +<img id="header_logo_image" src="%s" alt="%s"> +</div> +<div id="header_abouts"> +<p id="header_title">%s</p> +<p id="header_about">%s</p> +</div> +</header> +</a> + +Le module "navbar" + +Le module "navbar" issu du fichier de configuration "navbar.raw" insère +la barre de manu principale, libellée pour l'accessibilité, "navigation-1". +Son contenu par défaut est vide. + + +Pour ajouter un onglet au menu du site : + +créer un dossier dans le dossier de travail du domaine ".../articles/" +créer un article "index.tyto" dans le nouveau dossier +créer l'article HTML via la commande "wip" +éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + + +Exemple HTML d'un menu + + +<nav id="menu" aria-labelledby="navigation-1"> +<menu role="menu" id="menu_items"> +<li role="menuitem" class="menu_item"> +<a role="link" class="menu_link" href="%s" title="%s">%s</a> +</li> +</menu> +</nav> + +Le module "sidebar" + +Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère +la barre latérale contenant des articles à mettre en avant. Son contenu +par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la +::configuration du domaine. La barre latérale est libéllée pour +l'accessibilité "navigation-2" + + +Pour ajouter un article à la barre latérale : + +créer un article .tyto +créer l'article HTML via la commande "wip" +éditer le fichier sidebar.raw en ajoutant l'URI de l'article (URI depuis le dossier de travail du domaine ".../article/") + + +Exemple HTML d'une barre latérale + + +<aside id="sidebar"> +<div id="sidebar_title">%s</div> +<nav role="navigation" id="sidebar_menu" aria-labelledby="navigation-2"> +<ul role="list" id="sidebar_items"> +<li role="listitem" class="sidebar_item"> +<div class="sidebar_post_title"> +<a role="link" class="sidebar_post_link" href="%s">%s</a> +</div> +<div class="sidebar_post_about"> +<p class="sidebar_post_about_p" title="%s -- %s, %s">%s</p> +</div> +</li> +</ul> +</nav> +</aside> + +Le module "footer" + +Le module "footer" issu du fichier de configuration "footer.raw" insère le +pied de page HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Un menu de navigation, libellé pour +l'accessibilité "navigation-3", est créé automatiquement. + +Exemple HTML de pied de page + + +<footer id="footer"> +<div id="footer_title">%s <strong>%s</strong></div> +<div id="footer_about_menu"> +<div id="footer_about"> +%s +</div> +<nav id="footer_menu" aria-labelledby="navigation-3"> +<ul role="list" id="footer_items"> +<li role="listitem" class="footer_item"> +<a role="link" class="footer_item_link" href="%s" title="%s %s">%s</a> +</li> +</ul> +</nav> +</div> +<div id="footer_credit"> +<p id="footer_copyright">%s</p> +<p id="footer_tyto">%s</p> +</div> +</footer> + +Forcer une nouvelle génération des modules HTML + +Même si un module a déjà été généré, si vous avez besoin de forcer une +nouvelle génération de modules, il suffit de le demander, via l'action "wip". + +Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + + +tyto wip modules # Créer TOUS les modules HTML +tyto wip metas # Créer le module metas.html +tyto wip header # Créer le module header.html +tyto wip navbar # Créer le module navbar.html +tyto wip sidebar # Créer le module sidebar.html +tyto wip footer # Créer le module footer.html + + + +Vous pouvez forcer la création d'un module HTML, mais, si le fichier de +configuration a été modifié, il sera automatiquement mis à jour à la +prochaine création d'un article via la commande "wip". Il faut toutefois +forcer la génération, si une métadonnée indispensable d'un article se +trouvant dans le module, a été modifiée + +Afficher les modules dans les pages avec nginx + +Même si les pages du site sont statiques, les modules doivent être appelés +par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer +le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un +commentaire HTML conttient # include_virtual="". Dans la configuration +du serveur nginx, il faut ajouter : + + + +ssi on; +ssi_last_modified on; +absolute_redirect off; + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/modules/index.tyto b/src/usr/share/tyto/docs/www/modules/index.tyto new file mode 100644 index 0000000..d1ef6d9 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.tyto @@ -0,0 +1,201 @@ +title: Gérer les modules dans les pages +about: Comment gérer les modules (nginx) de Tyto - Littérateur +date: 2023-12-18 +tags: modules,nginx,metas,header,navbar,sidebar,footer +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: métadonnée indispensable + ../article/metas_obligatoires.html + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + + +#1 Définitions des modules +(( + *`Tyto - Littérateur`* intègre dans chaque page du site, différents modules. + Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le + contenu du fichier de configuration du module a changé. Vous pouvez les gérer, + et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" + dans le dossier de travail du domaine. Chaque fichier dispose d'une petite + aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer + la génération d'un module avec la commande {` tyto wip [module_name]`} +)) + +#2 Le module "metas" +(( + Le module "metas", issu du fichier de configuration "metas.raw" insère des + balises HTML {``}, prioritaires. Les balises utilisées par défaut : +)) + +#3 Exemple HTML des metas +{{ + + + + + +}} + + +#2 Le module "header" +(( + Le module "header", issu du fichier de configuration "header.raw" insère + +`l'entête`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Voici un exemple de sa structure HTML et des + identificateurs CSS : +)) + +#3 Exemple HTML d'une entête +{{ + + + + + + + %s + %s + + + +}} + +#2 Le module "navbar" +(( + Le module "navbar" issu du fichier de configuration "navbar.raw" insère + la +`barre de manu`+ principale, libellée pour l'accessibilité, "navigation-1". + Son contenu par défaut est vide. +)) +(( + Pour ajouter un onglet au menu du site : + (= + = créer un dossier dans le dossier de travail du domaine ".../articles/" + = créer un article "index.tyto" dans le nouveau dossier + = créer l'article HTML via la commande "wip" + = éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + )= +)) + +#3 Exemple HTML d'un menu +{{ + + + + %s + + + +}} + +#2 Le module "sidebar" +(( + Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère + la /`barre latérale`/ contenant des articles à mettre en avant. Son contenu + par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la + ::configuration du domaine. La barre latérale est libéllée pour + l'accessibilité "navigation-2" +)) +(( + Pour ajouter un article à la barre latérale : + (= + = créer un article .tyto + = créer l'article HTML via la commande "wip" + = éditer le fichier sidebar.raw en ajoutant l'URI de l'article + (URI depuis le dossier de travail du domaine ".../article/") + )= +)) + +#3 Exemple HTML d'une barre latérale +{{ + +}} + +#2 Le module "footer" +(( + Le module "footer" issu du fichier de configuration "footer.raw" insère le + +`pied de page`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Un menu de navigation, libellé pour + l'accessibilité "navigation-3", est créé automatiquement. +)) + +#3 Exemple HTML de pied de page +{{ + +}} + + +#1 Forcer une nouvelle génération des modules HTML +(( + Même si un module a déjà été généré, si vous avez besoin de forcer une + nouvelle génération de modules, il suffit de le demander, via l'action "wip". + | + Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + {{ + tyto wip modules # Créer TOUS les modules HTML + tyto wip metas # Créer le module metas.html + tyto wip header # Créer le module header.html + tyto wip navbar # Créer le module navbar.html + tyto wip sidebar # Créer le module sidebar.html + tyto wip footer # Créer le module footer.html + }} +)) +(( note + Vous pouvez forcer la création d'un module HTML, mais, si le fichier de + configuration a été modifié, il sera automatiquement mis à jour à la + prochaine création d'un article via la commande "wip". Il faut toutefois + forcer la génération, si une ::métadonnée indispensable d'un article se + trouvant dans le module, a été modifiée +)) + + +#1 Afficher les modules dans les pages avec nginx +(( + Même si les pages du site sont statiques, les modules doivent être appelés + par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer + le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un + commentaire HTML conttient {`# include_virtual=""`}. Dans la configuration + du serveur nginx, il faut ajouter : +)) +{{ + ssi on; + ssi_last_modified on; + absolute_redirect off; +}} diff --git a/website_doc/rss.xml b/src/usr/share/tyto/docs/www/rss.xml similarity index 59% rename from website_doc/rss.xml rename to src/usr/share/tyto/docs/www/rss.xml index 5e29d80..1f764ae 100644 --- a/website_doc/rss.xml +++ b/src/usr/share/tyto/docs/www/rss.xml @@ -3,7 +3,7 @@ - + @@ -20,118 +20,13 @@ fr Tyto,littérateur,logiciel libre,documentation - Mon, 15 Jan 2024 18:28:34 + Wed, 17 Jan 2024 18:19:13 gfdl-1.3 echolib+tyto@a-lec.org Tyto - Littérateur - - Écrire les titres et sous-titres - https://tyto.echolib.re/article/redac_titres.html - https://tyto.echolib.re/article/redac_titres.html - Sun, 07 Jan 2024 - Comment écrire les titres et les sous-titres pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_titles_toc.png - Écrire les titres et sous-titres (logo) - https://tyto.echolib.re/article/redac_titres.html - - format .tyto,écrire,rédaction,titres,table des matières - - - - Mentions Légales - https://tyto.echolib.re/a-propos/index.html - https://tyto.echolib.re/a-propos/index.html - Sun, 14 Jan 2024 - Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/justice_scales_cc0.png - Mentions Légales (logo) - https://tyto.echolib.re/a-propos/index.html - - mentions légales,C.G.U,licence - - - - Écrire un article au format .tyto - https://tyto.echolib.re/article/index.html - https://tyto.echolib.re/article/index.html - Sat, 06 Jan 2024 - Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/format_tyto.png - Écrire un article au format .tyto (logo) - https://tyto.echolib.re/article/index.html - - format .tyto,écrire, - - - - Écrire les métadonnées indispensables - https://tyto.echolib.re/article/metas_obligatoires.html - https://tyto.echolib.re/article/metas_obligatoires.html - Sat, 06 Jan 2024 - Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_5_metas.png - Écrire les métadonnées indispensables (logo) - https://tyto.echolib.re/article/metas_obligatoires.html - - format .tyto,écrire,métadonnées,entête - - - - Les URIs spécifiques - https://tyto.echolib.re/article/metas_uris.html - https://tyto.echolib.re/article/metas_uris.html - Mon, 08 Jan 2024 - Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Les URIs spécifiques (logo) - https://tyto.echolib.re/article/metas_uris.html - - format .tyto,écrire,liens,URIs - - - - Écrire/créer des liens - https://tyto.echolib.re/article/metas_liens.html - https://tyto.echolib.re/article/metas_liens.html - Mon, 08 Jan 2024 - Comment écrire des liens pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Écrire/créer des liens (logo) - https://tyto.echolib.re/article/metas_liens.html - - format .tyto,écrire,liens - - - - Page non trouvée - https://tyto.echolib.re/404.html - https://tyto.echolib.re/404.html - Sat, 13 Jan 2024 - Page d'erreur 404, indiquant que la page demandée n'existe pas/plus - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Page non trouvée (logo) - https://tyto.echolib.re/404.html - - 404,erreur - - Bienvenue, librement https://tyto.echolib.re/index.html @@ -146,6 +41,171 @@ accueil,projet,description + + + Afficher du code en bloc + https://tyto.echolib.re/article/redac_blockcodes.html + https://tyto.echolib.re/article/redac_blockcodes.html + Tue, 16 Jan 2024 + Comment afficher du code en bloc pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher du code en bloc (logo) + https://tyto.echolib.re/article/redac_blockcodes.html + + rédaction,marqueurs,blockcode + + + + Les URIs spécifiques + https://tyto.echolib.re/article/metas_uris.html + https://tyto.echolib.re/article/metas_uris.html + Mon, 08 Jan 2024 + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Les URIs spécifiques (logo) + https://tyto.echolib.re/article/metas_uris.html + + format .tyto,écrire,liens,URIs + + + + Créer des liens + https://tyto.echolib.re/article/metas_liens.html + https://tyto.echolib.re/article/metas_liens.html + Mon, 08 Jan 2024 + Comment écrire des liens pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer des liens (logo) + https://tyto.echolib.re/article/metas_liens.html + + format .tyto,écrire,liens + + + + Écrire les métadonnées indispensables + https://tyto.echolib.re/article/metas_obligatoires.html + https://tyto.echolib.re/article/metas_obligatoires.html + Sat, 06 Jan 2024 + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_5_metas.png + Écrire les métadonnées indispensables (logo) + https://tyto.echolib.re/article/metas_obligatoires.html + + format .tyto,écrire,métadonnées,entête + + + + Écrire des paragraphes + https://tyto.echolib.re/article/redac_paragraphes.html + https://tyto.echolib.re/article/redac_paragraphes.html + Tue, 05 Dec 2023 + Comment écrire des paragraphes pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Écrire des paragraphes (logo) + https://tyto.echolib.re/article/redac_paragraphes.html + + rédaction,marqueurs,paragraphes + + + + Mentions Légales + https://tyto.echolib.re/a-propos/index.html + https://tyto.echolib.re/a-propos/index.html + Sun, 14 Jan 2024 + Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/justice_scales_cc0.png + Mentions Légales (logo) + https://tyto.echolib.re/a-propos/index.html + + mentions légales,C.G.U,licence + + + + Écrire des titres et sous-titres + https://tyto.echolib.re/article/redac_titres.html + https://tyto.echolib.re/article/redac_titres.html + Sun, 07 Jan 2024 + Comment écrire les titres et les sous-titres pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_titles_toc.png + Écrire des titres et sous-titres (logo) + https://tyto.echolib.re/article/redac_titres.html + + rédaction,marqueurs,titres,table des matières + + + + Écrire un article au format .tyto + https://tyto.echolib.re/article/index.html + https://tyto.echolib.re/article/index.html + Sat, 06 Jan 2024 + Comment écrire un article pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/format_tyto.png + Écrire un article au format .tyto (logo) + https://tyto.echolib.re/article/index.html + + format .tyto,écrire, + + + + Afficher des images + https://tyto.echolib.re/article/mere_images.html + https://tyto.echolib.re/article/mere_images.html + Tue, 05 Dec 2023 + Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher des images (logo) + https://tyto.echolib.re/article/mere_images.html + + marqueurs,images + + + + Gérer les modules dans les pages + https://tyto.echolib.re/modules/index.html + https://tyto.echolib.re/modules/index.html + Mon, 18 Dec 2023 + Comment gérer les modules (nginx) de Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Gérer les modules dans les pages (logo) + https://tyto.echolib.re/modules/index.html + + modules,nginx,metas,header,navbar,sidebar,footer + + + + Créer et configurer un domaine + https://tyto.echolib.re/config/index.html + https://tyto.echolib.re/config/index.html + Tue, 05 Dec 2023 + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer et configurer un domaine (logo) + https://tyto.echolib.re/config/index.html + + configuration,domaine + diff --git a/src/usr/share/tyto/docs/www/sitemap.html b/src/usr/share/tyto/docs/www/sitemap.html new file mode 100644 index 0000000..af9f55b --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.html @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Plan du site (Tyto) | Tyto - Littérateur + + + + + + + + + + + + + + + +Plan du site + + +Tyto, 17/01/2024 [Code source] + + +Liste des articles (12) + + +Bienvenue, librement +Afficher du code en bloc +Les URIs spécifiques +Créer des liens +Écrire les métadonnées indispensables +Écrire des paragraphes +Mentions Légales +Écrire des titres et sous-titres +Écrire un article au format .tyto +Afficher des images +Gérer les modules dans les pages +Créer et configurer un domaine + + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/sitemap.tyto b/src/usr/share/tyto/docs/www/sitemap.tyto new file mode 100644 index 0000000..273605e --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.tyto @@ -0,0 +1,29 @@ +# Tyto - Littérateur +! NOMAP +! NORSS + +title: Plan du site +about: Plan du site généré par Tyto - Littérateur +tags: Plan du site +authors: Tyto +date: 2024-01-17 + +----- +#1 Liste des articles (12) + +(( sitemap + (= sitemap_items + + Bienvenue, librement + + Afficher du code en bloc + + Les URIs spécifiques + + Créer des liens + + Écrire les métadonnées indispensables + + Écrire des paragraphes + + Mentions Légales + + Écrire des titres et sous-titres + + Écrire un article au format .tyto + + Afficher des images + + Gérer les modules dans les pages + + Créer et configurer un domaine + )= +)) diff --git a/website_doc/template/VH_Tyto_logo.png b/src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png similarity index 100% rename from website_doc/template/VH_Tyto_logo.png rename to src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png diff --git a/website_doc/template/favicon.png b/src/usr/share/tyto/docs/www/template/favicon.png similarity index 100% rename from website_doc/template/favicon.png rename to src/usr/share/tyto/docs/www/template/favicon.png diff --git a/website_doc/template/footer.html b/src/usr/share/tyto/docs/www/template/footer.html similarity index 96% rename from website_doc/template/footer.html rename to src/usr/share/tyto/docs/www/template/footer.html index b327fae..4090a32 100644 --- a/website_doc/template/footer.html +++ b/src/usr/share/tyto/docs/www/template/footer.html @@ -12,7 +12,7 @@ en Python par Cyrille Louarn (echol Le code source est composé (hors fichiers de traductions) de 18 fichiers -totalisant 5048 lignes dont 1231 lignes commentées, soit 2851 lignes de scripts. +totalisant 5051 lignes dont 1231 lignes commentées, soit 2853 lignes de scripts. Tyto - Littérateur (version 1.11.4) est fait avec amour <3 diff --git a/website_doc/template/header.html b/src/usr/share/tyto/docs/www/template/header.html similarity index 100% rename from website_doc/template/header.html rename to src/usr/share/tyto/docs/www/template/header.html diff --git a/website_doc/template/metas.html b/src/usr/share/tyto/docs/www/template/metas.html similarity index 100% rename from website_doc/template/metas.html rename to src/usr/share/tyto/docs/www/template/metas.html diff --git a/src/usr/share/tyto/docs/www/template/navbar.html b/src/usr/share/tyto/docs/www/template/navbar.html new file mode 100644 index 0000000..bbfa1d0 --- /dev/null +++ b/src/usr/share/tyto/docs/www/template/navbar.html @@ -0,0 +1,9 @@ + + + +config +article +modules +publier + + diff --git a/website_doc/template/sidebar.html b/src/usr/share/tyto/docs/www/template/sidebar.html similarity index 100% rename from website_doc/template/sidebar.html rename to src/usr/share/tyto/docs/www/template/sidebar.html diff --git a/website_doc/template/styles.css b/src/usr/share/tyto/docs/www/template/styles.css similarity index 99% rename from website_doc/template/styles.css rename to src/usr/share/tyto/docs/www/template/styles.css index 0818419..f4e1d69 100644 --- a/website_doc/template/styles.css +++ b/src/usr/share/tyto/docs/www/template/styles.css @@ -166,6 +166,10 @@ h6.tyto { font-size: 1.2rem; } +img.bandeau { + max-width: 100% +} + p.alert { color: #FFFDA5; font-weight: bold; @@ -254,6 +258,7 @@ ul.tyto :is(ol, ul) { footer#footer { border-top: 2px dotted gray; color: #FFF; + margin-top: 40px; } div#footer_title { diff --git a/website_doc/sitemap.html b/website_doc/sitemap.html deleted file mode 100644 index c643e3a..0000000 --- a/website_doc/sitemap.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plan du site (Tyto) | Tyto - Littérateur - - - - - - - - - - - - - - - -Plan du site - - -Tyto, 15/01/2024 [Code source] - - -Liste des articles (8) - - -Écrire les titres et sous-titres -Mentions Légales -Écrire un article au format .tyto -Écrire les métadonnées indispensables -Les URIs spécifiques -Écrire/créer des liens -Page non trouvée -Bienvenue, librement - - - - - - - - - - - - - - - - diff --git a/website_doc/sitemap.tyto b/website_doc/sitemap.tyto deleted file mode 100644 index 6099374..0000000 --- a/website_doc/sitemap.tyto +++ /dev/null @@ -1,25 +0,0 @@ -# Tyto - Littérateur -! NOMAP -! NORSS - -title: Plan du site -about: Plan du site généré par Tyto - Littérateur -tags: Plan du site -authors: Tyto -date: 2024-01-15 - ------ -#1 Liste des articles (8) - -(( sitemap - (= sitemap_items - + Écrire les titres et sous-titres - + Mentions Légales - + Écrire un article au format .tyto - + Écrire les métadonnées indispensables - + Les URIs spécifiques - + Écrire/créer des liens - + Page non trouvée - + Bienvenue, librement - )= -)) diff --git a/website_doc/template/navbar.html b/website_doc/template/navbar.html deleted file mode 100644 index 3a46f7b..0000000 --- a/website_doc/template/navbar.html +++ /dev/null @@ -1,6 +0,0 @@ - - - -article - -
+ + + + +Afficher du code en bloc + + +echolib, 16/01/2024 [Code source] + + +Table des matières + + +Les marqueurs +Exemples de code en bloc + +Sortie HTML + + + +Les marqueurs + +Pour afficher du code en bloc, il faut utiliser les marqueurs d'ouverture +{{ et de fermeture }}, et placer les lignes de codes dedans. +Il est recommandé d'indenter les lignes de codes dans le bloc. Tyto +prend en compte l'indentation de la première ligne de code pour l'affichage +HTML. + + +Les marqueurs d'ouverture et de fermeture doivent se trouver au +même niveau d'indentation dans l'article source, et sonts seuls sur une +ligne + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est "bcode". La classe est reprise dans les balises HTML. +Voir ci-dessous la sortie HTML des exemples suivants. + +Exemples de code en bloc + + +# Comment afficher du code pour Tyto - Littérateur +{{ + Placer du code ici + et encore là... +}} + + + +{{ MonCode + # ! Aucune propriété de style MonCode existe + # dans styles.css. Affichage par défaut + def tyto_code(hello): + if hello: + print(hello) +}} + +Sortie HTML + + +<pre class="bcode_pre"> +<ol class="bcode_items"> +<li role="listitem" class="bcode_item"><code class="bcode_code"># Comment afficher du code pour Tyto - Littérateur</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">{{</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> Placer du code ici</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code"> et encore là...</code></li> +<li role="listitem" class="bcode_item"><code class="bcode_code">}}</code></li> +</ol> +</pre> +<pre class="MonCode_pre"> +<ol class="MonCode_items"> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">{{ MonCode</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # ! Aucune propriété de style MonCode existe</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> # dans styles.css. Affichage par défaut</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> def tyto_code(hello):</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> if hello:</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code"> print(hello)</code></li> +<li role="listitem" class="MonCode_item"><code class="MonCode_code">}}</code></li> +</ol> +</pre> + + +
+ + + + +Écrire des paragraphes + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Les marqueurs + +Exemple de paragraphes + + + +Les marqueurs + +Les marqueurs de paragraphes forment un bloc. Pour écrire des +paragraphes <p></p> en HTML, et même les imbriquer, il faut écrire du +texte entre les marqueurs d'ouverture ((, et de fermeture )). +Ces marqueurs doivent être placés seuls au début d'une ligne. + + +Vous pouvez définir une classe CSS après le marqueur d'ouverture. Par défaut, +la classe utilisée est celle dans la configuration du domaine. + + +Les marqueurs peuvent être imbriqués. Pour que votre article reste lisible, +indentez les marqueurs, leurs contenus et aérer avec des retours à la ligne. + +Exemple de paragraphes + + +(( Par_A + Ceci est un 1er grand paragraphe... + ayant pour classe CSS Par_A + + (( Par_AA + Ceci est un sous-paragraphe... + ayant pour classe CSS Par_AA + )) +)) + +(( Par_B + Ceci est un 2nd grand paragraphes... + ayant pour classe CSS PAR_B +)) + + +
- + - + -Écrire les titres et sous-titres +Écrire des titres et sous-titres -echolib, 07/01/2024 [Code source] +echolib, 07/01/2024 [Code source] Table des matières diff --git a/website_doc/article/redac_titres.tyto b/src/usr/share/tyto/docs/www/article/redac_titres.tyto similarity index 93% rename from website_doc/article/redac_titres.tyto rename to src/usr/share/tyto/docs/www/article/redac_titres.tyto index 49ad6a1..339b4ff 100644 --- a/website_doc/article/redac_titres.tyto +++ b/src/usr/share/tyto/docs/www/article/redac_titres.tyto @@ -1,7 +1,7 @@ -title: Écrire les titres et sous-titres +title: Écrire des titres et sous-titres about: Comment écrire les titres et les sous-titres pour Tyto - Littérateur date: 2024-01-07 -tags: format .tyto,écrire,rédaction,titres,table des matières +tags: rédaction,marqueurs,titres,table des matières authors: echolib logo: @logos/tyto_titles_toc.png diff --git a/src/usr/share/tyto/docs/www/config/index.html b/src/usr/share/tyto/docs/www/config/index.html new file mode 100644 index 0000000..076ec9e --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Créer et configurer un domaine (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Créer et configurer un domaine + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Créer un domaine + +Les commandes à taper + +Répondre aux questions + +Exemple d'un domaine créé + + +Modifier la configuration + +Les valeurs importantes + + + + +Créer un domaine + +Tyto littérateur fonctionne dans un dossier ayant l'identité d'un nom de +domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez +le créer, à l'emplacement de votre choix. Ce dossier est votre +dossier de travail. Seulement une fois ce dossier ouvert (dans un +terminal), vous pouvez lancer la procédure de création du domaine afin de +créer votre nouveau site. + + +Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez +créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers +des domaines. + +Les commandes à taper + + +# Commande bash pour créer un dossier du domaine +mkdir -p domaine.tld + +# Se placer dans le dossier créé +cd domaine.tld + +# Créer et configurer le domaine "domaine.tld" +tyto new domain + +Répondre aux questions + + + +Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de +quelques renseignements concernant ce domaine, et notemment : + +le titre du domaine +la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) +la description du domaine +les étiquettes du domaine (séparées par une virugule) +le courriel de l'administrateur +la langue du domaine (celle du site web) sur 2 caractères (en, fr...) +le dossier du serveur root + + +Exemple d'un domaine créé + +Une fois toutes les questions répondues, le fichier tyto_domain.ini est +créé dans le dossier du domaine. Quelques données supplémentaires sont +configurables dans le fichier, qui est au format INI. Il est plus que +recommandé de l'ouvrir et de vérifier son contenu +avant de continuer. Vous pouvez le lire avec la commande +tyto show domain. Le domaine est désactivé après sa création. + + + +[DOMAIN] +name = tyto.echolib.re +work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ +activated = True +title = Tyto - Littérateur +date = 2022 +about = Documentation officielle du littérateur libre +tags = Tyto,littérateur,logiciel libre,documentation +mail = echolib+tyto@a-lec.org + +[WEBSITE] +wip_url = https://www-wip.echolib.re/ +www_url = https://tyto.echolib.re/ +css = tyto +separator = | +article_code = True +lang = fr +license = gfdl-1.3 +license_url = https://www.gnu.org/licenses/fdl-1.3.txt + +[WEBSITE_FOOTER] +link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" +link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" +link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" +link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + +[WEBSITE_MODULES] +sidebar_title = Articles recommandés +sidebar_items = 6 +rss_items = 100 +sitemaps = True + +[TEMPLATE_FILENAMES] +favicon = favicon.png +logo = VH_Tyto_logo.png +styles = styles.css +rss = rss.xml +stats = tyto_stats.ini + +[SERVER] +srv_root = /home/echolib/Projets/www/ + +[TYTO] +id = 23ac1f4c +conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini +user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini + +Modifier la configuration + +Le fichier tyto_domain.ini dispose de catégories, comme [WEBSITE], avec +les paramètres clé = valeur. Si vous modifiez une valeur, Tyto vérifiera +et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans +certains cas, il faudra toutes les reconstruire. Si les modifications +concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être +reconstruit. + +Les valeurs importantes + + +[DOMAIN] +# Remplacer par True pour activer +# ou utiliser la commande tyto start / tyto stop +activated = False + +[WEBSITE] +# L'adresse (URL) du site web temporaire (wip) +wip_url = https://www-wip.domaine.tld/ + +# L'adresse (URL) du site officiel (publish) +www_url = https://domaine.tld/ + +# La classe CSS par défaut +css = tyto + +# Le séparateur entre le titre de la page et le titre du site +# dans la balise HTML <title> +separator = - + +# Valeur booléane True/False (Oui/Non) +# Afficher le lien vers le code source de l'article +article_code = False + +# Langue des pages du site +# La traduction doit exister (fournies: en, fr) +lang = fr + +[WEBSITE_MODULES] +# Le nom de la barre latérale +sidebar_title = Articles recommandés + +# Nombre d'articles dans la barre latérale (0 pour désactiver) +sidebar_items = 6 + +# Nombre d'articles dans le flux RSS (0 pour désactiver) +rss_items = 100 + +# Création automatique du sitemap (sitemap.html) +sitemaps = True + +[WEBSITE_FOOTER] +# Les liens du pied de page dans [WEBSITE_FOOTER] +# les clés link_1 à link_4 sont créés automatiquement +# Pour désactiver, enlever la valeur, laisser la clé ! +# Format de clé +# l'URL peut être locale. Ex : "/about/cgu.html" +clé = "Nom à afficher", "URL", "Contenu de title=" + +[TEMPLATE_FILENAMES] +# Nom des fichiers +# (à ajouter dans le dossier .../wip/template/) +favicon = favicon.png +logo = logo.png +styles = styles.css + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/config/index.tyto b/src/usr/share/tyto/docs/www/config/index.tyto new file mode 100644 index 0000000..7392b4c --- /dev/null +++ b/src/usr/share/tyto/docs/www/config/index.tyto @@ -0,0 +1,192 @@ +title: Créer et configurer un domaine +about: Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur +tags: configuration,domaine +date: 2023-12-05 +authors: echolib + +link: format INI + https://fr.wikipedia.org/wiki/Fichier_INI + Page wikipédia en FR "Fichier INI" + +image: domain-form + tyto_new_domain_form.png + Formulaire lors de la création d'un domaine avec Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + +#1 Créer un domaine +(( + *`Tyto littérateur`* fonctionne dans un dossier ayant l'identité d'un nom de + domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez + le créer, à l'emplacement de votre choix. Ce dossier est votre + +`dossier de travail`+. Seulement une fois ce dossier ouvert (dans un + terminal), vous pouvez lancer la procédure de création du domaine afin de + créer votre nouveau site. +)) + +(( astuce + Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez + créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers + des domaines. +)) + + +#2 Les commandes à taper +{{ + # Commande bash pour créer un dossier du domaine + mkdir -p domaine.tld + + # Se placer dans le dossier créé + cd domaine.tld + + # Créer et configurer le domaine "domaine.tld" + tyto new domain +}} + + +#3 Répondre aux questions +(( + ::domain-form "c=bandeau", + | + Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de + quelques renseignements concernant ce domaine, et notemment : + (= + = le titre du domaine + = la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) + = la description du domaine + = les étiquettes du domaine (séparées par une virugule) + = le courriel de l'administrateur + = la langue du domaine (celle du site web) sur 2 caractères (en, fr...) + = le dossier du serveur root + )= +)) + + +#4 Exemple d'un domaine créé +(( + Une fois toutes les questions répondues, le fichier [`tyto_domain.ini`] est + créé dans le dossier du domaine. Quelques données supplémentaires sont + configurables dans le fichier, qui est au ::format INI. Il est plus que + recommandé de l'ouvrir et de +`vérifier son contenu`+ + *`&_`avant de continuer`_&`*. Vous pouvez le lire avec la commande + {`tyto show domain`}. Le domaine est désactivé après sa création. +)) +{{ + [DOMAIN] + name = tyto.echolib.re + work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ + activated = True + title = Tyto - Littérateur + date = 2022 + about = Documentation officielle du littérateur libre + tags = Tyto,littérateur,logiciel libre,documentation + mail = echolib+tyto@a-lec.org + + [WEBSITE] + wip_url = https://www-wip.echolib.re/ + www_url = https://tyto.echolib.re/ + css = tyto + separator = | + article_code = True + lang = fr + license = gfdl-1.3 + license_url = https://www.gnu.org/licenses/fdl-1.3.txt + + [WEBSITE_FOOTER] + link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" + link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" + link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" + link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + + [WEBSITE_MODULES] + sidebar_title = Articles recommandés + sidebar_items = 6 + rss_items = 100 + sitemaps = True + + [TEMPLATE_FILENAMES] + favicon = favicon.png + logo = VH_Tyto_logo.png + styles = styles.css + rss = rss.xml + stats = tyto_stats.ini + + [SERVER] + srv_root = /home/echolib/Projets/www/ + + [TYTO] + id = 23ac1f4c + conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini + user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini +}} + + +#2 Modifier la configuration +(( + Le fichier [`tyto_domain.ini`] dispose de catégories, comme [WEBSITE], avec + les paramètres {`clé = valeur`}. Si vous modifiez une valeur, Tyto vérifiera + et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans + certains cas, il faudra toutes les reconstruire. Si les modifications + concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être + reconstruit. +)) + + +#3 Les valeurs importantes +{{ + [DOMAIN] + # Remplacer par True pour activer + # ou utiliser la commande tyto start / tyto stop + activated = False + + [WEBSITE] + # L'adresse (URL) du site web temporaire (wip) + wip_url = https://www-wip.domaine.tld/ + + # L'adresse (URL) du site officiel (publish) + www_url = https://domaine.tld/ + + # La classe CSS par défaut + css = tyto + + # Le séparateur entre le titre de la page et le titre du site + # dans la balise HTML + separator = - + + # Valeur booléane True/False (Oui/Non) + # Afficher le lien vers le code source de l'article + article_code = False + + # Langue des pages du site + # La traduction doit exister (fournies: en, fr) + lang = fr + + [WEBSITE_MODULES] + # Le nom de la barre latérale + sidebar_title = Articles recommandés + + # Nombre d'articles dans la barre latérale (0 pour désactiver) + sidebar_items = 6 + + # Nombre d'articles dans le flux RSS (0 pour désactiver) + rss_items = 100 + + # Création automatique du sitemap (sitemap.html) + sitemaps = True + + [WEBSITE_FOOTER] + # Les liens du pied de page dans [WEBSITE_FOOTER] + # les clés link_1 à link_4 sont créés automatiquement + # Pour désactiver, enlever la valeur, laisser la clé ! + # Format de clé + # l'URL peut être locale. Ex : "/about/cgu.html" + clé = "Nom à afficher", "URL", "Contenu de title=" + + [TEMPLATE_FILENAMES] + # Nom des fichiers + # (à ajouter dans le dossier .../wip/template/) + favicon = favicon.png + logo = logo.png + styles = styles.css +}} diff --git a/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png new file mode 100644 index 0000000..07feb3d Binary files /dev/null and b/src/usr/share/tyto/docs/www/config/tyto_new_domain_form.png differ diff --git a/website_doc/images/logos/format_tyto.png b/src/usr/share/tyto/docs/www/images/logos/format_tyto.png similarity index 100% rename from website_doc/images/logos/format_tyto.png rename to src/usr/share/tyto/docs/www/images/logos/format_tyto.png diff --git a/website_doc/images/logos/justice_scales_cc0.png b/src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png similarity index 100% rename from website_doc/images/logos/justice_scales_cc0.png rename to src/usr/share/tyto/docs/www/images/logos/justice_scales_cc0.png diff --git a/website_doc/images/logos/tyto_5_metas.png b/src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png similarity index 100% rename from website_doc/images/logos/tyto_5_metas.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_5_metas.png diff --git a/website_doc/images/logos/tyto_titles_toc.png b/src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png similarity index 100% rename from website_doc/images/logos/tyto_titles_toc.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_titles_toc.png diff --git a/website_doc/images/logos/tyto_welcome.png b/src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png similarity index 100% rename from website_doc/images/logos/tyto_welcome.png rename to src/usr/share/tyto/docs/www/images/logos/tyto_welcome.png diff --git a/website_doc/index.html b/src/usr/share/tyto/docs/www/index.html similarity index 88% rename from website_doc/index.html rename to src/usr/share/tyto/docs/www/index.html index 9c129ff..731bd0a 100644 --- a/website_doc/index.html +++ b/src/usr/share/tyto/docs/www/index.html @@ -33,7 +33,7 @@ <meta property="og:image" content="https://tyto.echolib.re/images/logos/tyto_welcome.png"> <!-- Publication date and title --> -<meta itemprop="datePublished" content="2024-01-15 18:28:34" id="date"> +<meta itemprop="datePublished" content="2024-01-17 18:19:13" id="date"> <title>Bienvenue, librement (echolib) | Tyto - Littérateur @@ -46,7 +46,7 @@ - + @@ -71,6 +71,7 @@ par mail ou, de préférence, via Gestion et personnalisation Utilisation Traductions +Pour commencer Le projet @@ -125,6 +126,12 @@ utilisée par le système, mais chaque site peut utiliser l'une ou l'autre, via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. +Pour commencer + +Configurer un domaine +Écrire un article +Configurer les modules + diff --git a/website_doc/index.tyto b/src/usr/share/tyto/docs/www/index.tyto similarity index 86% rename from website_doc/index.tyto rename to src/usr/share/tyto/docs/www/index.tyto index 7a77069..05e8055 100644 --- a/website_doc/index.tyto +++ b/src/usr/share/tyto/docs/www/index.tyto @@ -13,6 +13,18 @@ link: chouette effraie https://fr.wikipedia.org/wiki/Chouette_effraie Tyto alba • Effraie des clochers +link: Configurer un domaine + ./config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: Écrire un article + ./article/index.html + Comment écrire un article pour Tyto - Littérateur + +link: Configurer les modules + ./modules/index.html + Comment gérer les modules (nginx) de Tyto - Littérateur + ! LOGO ------------------------------------------------------------------------------- @@ -87,3 +99,11 @@ link: chouette effraie via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. )) + + +#1 Pour commencer +(= + + ::Configurer un domaine + + ::Écrire un article + + ::Configurer les modules +)= diff --git a/src/usr/share/tyto/docs/www/modules/index.html b/src/usr/share/tyto/docs/www/modules/index.html new file mode 100644 index 0000000..407acd3 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Gérer les modules dans les pages (echolib) | Tyto - Littérateur + + + + + + + + + + + + + + + +Gérer les modules dans les pages + + +echolib, 18/12/2023 [Code source] + + +Table des matières + + +Définitions des modules + +Le module "metas" + +Exemple HTML des metas + +Le module "header" + +Exemple HTML d'une entête + +Le module "navbar" + +Exemple HTML d'un menu + +Le module "sidebar" + +Exemple HTML d'une barre latérale + +Le module "footer" + +Exemple HTML de pied de page + + +Forcer une nouvelle génération des modules HTML +Afficher les modules dans les pages avec nginx + + +Définitions des modules + +Tyto - Littérateur intègre dans chaque page du site, différents modules. +Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le +contenu du fichier de configuration du module a changé. Vous pouvez les gérer, +et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" +dans le dossier de travail du domaine. Chaque fichier dispose d'une petite +aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer +la génération d'un module avec la commande tyto wip [module_name] + +Le module "metas" + +Le module "metas", issu du fichier de configuration "metas.raw" insère des +balises HTML <meta>, prioritaires. Les balises utilisées par défaut : + +Exemple HTML des metas + + +<meta charset="UTF-8"> +<meta name="robots" content="all"> +<meta name="medium" content="website"> +<meta name="revisit-after" content="3 days"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> + +Le module "header" + +Le module "header", issu du fichier de configuration "header.raw" insère +l'entête HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Voici un exemple de sa structure HTML et des +identificateurs CSS : + +Exemple HTML d'une entête + + +<a role="link" id="site_link" href="/" title="%s"> +<header id="header"> +<div id="header_logo"> +<img id="header_logo_image" src="%s" alt="%s"> +</div> +<div id="header_abouts"> +<p id="header_title">%s</p> +<p id="header_about">%s</p> +</div> +</header> +</a> + +Le module "navbar" + +Le module "navbar" issu du fichier de configuration "navbar.raw" insère +la barre de manu principale, libellée pour l'accessibilité, "navigation-1". +Son contenu par défaut est vide. + + +Pour ajouter un onglet au menu du site : + +créer un dossier dans le dossier de travail du domaine ".../articles/" +créer un article "index.tyto" dans le nouveau dossier +créer l'article HTML via la commande "wip" +éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + + +Exemple HTML d'un menu + + +<nav id="menu" aria-labelledby="navigation-1"> +<menu role="menu" id="menu_items"> +<li role="menuitem" class="menu_item"> +<a role="link" class="menu_link" href="%s" title="%s">%s</a> +</li> +</menu> +</nav> + +Le module "sidebar" + +Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère +la barre latérale contenant des articles à mettre en avant. Son contenu +par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la +::configuration du domaine. La barre latérale est libéllée pour +l'accessibilité "navigation-2" + + +Pour ajouter un article à la barre latérale : + +créer un article .tyto +créer l'article HTML via la commande "wip" +éditer le fichier sidebar.raw en ajoutant l'URI de l'article (URI depuis le dossier de travail du domaine ".../article/") + + +Exemple HTML d'une barre latérale + + +<aside id="sidebar"> +<div id="sidebar_title">%s</div> +<nav role="navigation" id="sidebar_menu" aria-labelledby="navigation-2"> +<ul role="list" id="sidebar_items"> +<li role="listitem" class="sidebar_item"> +<div class="sidebar_post_title"> +<a role="link" class="sidebar_post_link" href="%s">%s</a> +</div> +<div class="sidebar_post_about"> +<p class="sidebar_post_about_p" title="%s -- %s, %s">%s</p> +</div> +</li> +</ul> +</nav> +</aside> + +Le module "footer" + +Le module "footer" issu du fichier de configuration "footer.raw" insère le +pied de page HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Un menu de navigation, libellé pour +l'accessibilité "navigation-3", est créé automatiquement. + +Exemple HTML de pied de page + + +<footer id="footer"> +<div id="footer_title">%s <strong>%s</strong></div> +<div id="footer_about_menu"> +<div id="footer_about"> +%s +</div> +<nav id="footer_menu" aria-labelledby="navigation-3"> +<ul role="list" id="footer_items"> +<li role="listitem" class="footer_item"> +<a role="link" class="footer_item_link" href="%s" title="%s %s">%s</a> +</li> +</ul> +</nav> +</div> +<div id="footer_credit"> +<p id="footer_copyright">%s</p> +<p id="footer_tyto">%s</p> +</div> +</footer> + +Forcer une nouvelle génération des modules HTML + +Même si un module a déjà été généré, si vous avez besoin de forcer une +nouvelle génération de modules, il suffit de le demander, via l'action "wip". + +Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + + +tyto wip modules # Créer TOUS les modules HTML +tyto wip metas # Créer le module metas.html +tyto wip header # Créer le module header.html +tyto wip navbar # Créer le module navbar.html +tyto wip sidebar # Créer le module sidebar.html +tyto wip footer # Créer le module footer.html + + + +Vous pouvez forcer la création d'un module HTML, mais, si le fichier de +configuration a été modifié, il sera automatiquement mis à jour à la +prochaine création d'un article via la commande "wip". Il faut toutefois +forcer la génération, si une métadonnée indispensable d'un article se +trouvant dans le module, a été modifiée + +Afficher les modules dans les pages avec nginx + +Même si les pages du site sont statiques, les modules doivent être appelés +par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer +le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un +commentaire HTML conttient # include_virtual="". Dans la configuration +du serveur nginx, il faut ajouter : + + + +ssi on; +ssi_last_modified on; +absolute_redirect off; + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/modules/index.tyto b/src/usr/share/tyto/docs/www/modules/index.tyto new file mode 100644 index 0000000..d1ef6d9 --- /dev/null +++ b/src/usr/share/tyto/docs/www/modules/index.tyto @@ -0,0 +1,201 @@ +title: Gérer les modules dans les pages +about: Comment gérer les modules (nginx) de Tyto - Littérateur +date: 2023-12-18 +tags: modules,nginx,metas,header,navbar,sidebar,footer +authors: echolib + +link: configuration du domaine + ../config/index.html + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + +link: métadonnée indispensable + ../article/metas_obligatoires.html + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + +------------------------------------------------------------------------------- +! TOC + + +#1 Définitions des modules +(( + *`Tyto - Littérateur`* intègre dans chaque page du site, différents modules. + Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le + contenu du fichier de configuration du module a changé. Vous pouvez les gérer, + et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" + dans le dossier de travail du domaine. Chaque fichier dispose d'une petite + aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer + la génération d'un module avec la commande {` tyto wip [module_name]`} +)) + +#2 Le module "metas" +(( + Le module "metas", issu du fichier de configuration "metas.raw" insère des + balises HTML {``}, prioritaires. Les balises utilisées par défaut : +)) + +#3 Exemple HTML des metas +{{ + + + + + +}} + + +#2 Le module "header" +(( + Le module "header", issu du fichier de configuration "header.raw" insère + +`l'entête`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Voici un exemple de sa structure HTML et des + identificateurs CSS : +)) + +#3 Exemple HTML d'une entête +{{ + + + + + + + %s + %s + + + +}} + +#2 Le module "navbar" +(( + Le module "navbar" issu du fichier de configuration "navbar.raw" insère + la +`barre de manu`+ principale, libellée pour l'accessibilité, "navigation-1". + Son contenu par défaut est vide. +)) +(( + Pour ajouter un onglet au menu du site : + (= + = créer un dossier dans le dossier de travail du domaine ".../articles/" + = créer un article "index.tyto" dans le nouveau dossier + = créer l'article HTML via la commande "wip" + = éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + )= +)) + +#3 Exemple HTML d'un menu +{{ + + + + %s + + + +}} + +#2 Le module "sidebar" +(( + Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère + la /`barre latérale`/ contenant des articles à mettre en avant. Son contenu + par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la + ::configuration du domaine. La barre latérale est libéllée pour + l'accessibilité "navigation-2" +)) +(( + Pour ajouter un article à la barre latérale : + (= + = créer un article .tyto + = créer l'article HTML via la commande "wip" + = éditer le fichier sidebar.raw en ajoutant l'URI de l'article + (URI depuis le dossier de travail du domaine ".../article/") + )= +)) + +#3 Exemple HTML d'une barre latérale +{{ + +}} + +#2 Le module "footer" +(( + Le module "footer" issu du fichier de configuration "footer.raw" insère le + +`pied de page`+ HTML dans les pages du site. Son contenu dépend de la + ::configuration du domaine. Un menu de navigation, libellé pour + l'accessibilité "navigation-3", est créé automatiquement. +)) + +#3 Exemple HTML de pied de page +{{ + +}} + + +#1 Forcer une nouvelle génération des modules HTML +(( + Même si un module a déjà été généré, si vous avez besoin de forcer une + nouvelle génération de modules, il suffit de le demander, via l'action "wip". + | + Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + {{ + tyto wip modules # Créer TOUS les modules HTML + tyto wip metas # Créer le module metas.html + tyto wip header # Créer le module header.html + tyto wip navbar # Créer le module navbar.html + tyto wip sidebar # Créer le module sidebar.html + tyto wip footer # Créer le module footer.html + }} +)) +(( note + Vous pouvez forcer la création d'un module HTML, mais, si le fichier de + configuration a été modifié, il sera automatiquement mis à jour à la + prochaine création d'un article via la commande "wip". Il faut toutefois + forcer la génération, si une ::métadonnée indispensable d'un article se + trouvant dans le module, a été modifiée +)) + + +#1 Afficher les modules dans les pages avec nginx +(( + Même si les pages du site sont statiques, les modules doivent être appelés + par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer + le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un + commentaire HTML conttient {`# include_virtual=""`}. Dans la configuration + du serveur nginx, il faut ajouter : +)) +{{ + ssi on; + ssi_last_modified on; + absolute_redirect off; +}} diff --git a/website_doc/rss.xml b/src/usr/share/tyto/docs/www/rss.xml similarity index 59% rename from website_doc/rss.xml rename to src/usr/share/tyto/docs/www/rss.xml index 5e29d80..1f764ae 100644 --- a/website_doc/rss.xml +++ b/src/usr/share/tyto/docs/www/rss.xml @@ -3,7 +3,7 @@ - + @@ -20,118 +20,13 @@ fr Tyto,littérateur,logiciel libre,documentation - Mon, 15 Jan 2024 18:28:34 + Wed, 17 Jan 2024 18:19:13 gfdl-1.3 echolib+tyto@a-lec.org Tyto - Littérateur - - Écrire les titres et sous-titres - https://tyto.echolib.re/article/redac_titres.html - https://tyto.echolib.re/article/redac_titres.html - Sun, 07 Jan 2024 - Comment écrire les titres et les sous-titres pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_titles_toc.png - Écrire les titres et sous-titres (logo) - https://tyto.echolib.re/article/redac_titres.html - - format .tyto,écrire,rédaction,titres,table des matières - - - - Mentions Légales - https://tyto.echolib.re/a-propos/index.html - https://tyto.echolib.re/a-propos/index.html - Sun, 14 Jan 2024 - Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/justice_scales_cc0.png - Mentions Légales (logo) - https://tyto.echolib.re/a-propos/index.html - - mentions légales,C.G.U,licence - - - - Écrire un article au format .tyto - https://tyto.echolib.re/article/index.html - https://tyto.echolib.re/article/index.html - Sat, 06 Jan 2024 - Page d'index référençant les articles dédiés à l'écriture des marqueurs utilisés par Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/format_tyto.png - Écrire un article au format .tyto (logo) - https://tyto.echolib.re/article/index.html - - format .tyto,écrire, - - - - Écrire les métadonnées indispensables - https://tyto.echolib.re/article/metas_obligatoires.html - https://tyto.echolib.re/article/metas_obligatoires.html - Sat, 06 Jan 2024 - Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/images/logos/tyto_5_metas.png - Écrire les métadonnées indispensables (logo) - https://tyto.echolib.re/article/metas_obligatoires.html - - format .tyto,écrire,métadonnées,entête - - - - Les URIs spécifiques - https://tyto.echolib.re/article/metas_uris.html - https://tyto.echolib.re/article/metas_uris.html - Mon, 08 Jan 2024 - Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Les URIs spécifiques (logo) - https://tyto.echolib.re/article/metas_uris.html - - format .tyto,écrire,liens,URIs - - - - Écrire/créer des liens - https://tyto.echolib.re/article/metas_liens.html - https://tyto.echolib.re/article/metas_liens.html - Mon, 08 Jan 2024 - Comment écrire des liens pour Tyto - Littérateur - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Écrire/créer des liens (logo) - https://tyto.echolib.re/article/metas_liens.html - - format .tyto,écrire,liens - - - - Page non trouvée - https://tyto.echolib.re/404.html - https://tyto.echolib.re/404.html - Sat, 13 Jan 2024 - Page d'erreur 404, indiquant que la page demandée n'existe pas/plus - echolib - - https://tyto.echolib.re/template/VH_Tyto_logo.png - Page non trouvée (logo) - https://tyto.echolib.re/404.html - - 404,erreur - - Bienvenue, librement https://tyto.echolib.re/index.html @@ -146,6 +41,171 @@ accueil,projet,description + + + Afficher du code en bloc + https://tyto.echolib.re/article/redac_blockcodes.html + https://tyto.echolib.re/article/redac_blockcodes.html + Tue, 16 Jan 2024 + Comment afficher du code en bloc pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher du code en bloc (logo) + https://tyto.echolib.re/article/redac_blockcodes.html + + rédaction,marqueurs,blockcode + + + + Les URIs spécifiques + https://tyto.echolib.re/article/metas_uris.html + https://tyto.echolib.re/article/metas_uris.html + Mon, 08 Jan 2024 + Comment cibler un fichier avec les URIs spécifiques des marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Les URIs spécifiques (logo) + https://tyto.echolib.re/article/metas_uris.html + + format .tyto,écrire,liens,URIs + + + + Créer des liens + https://tyto.echolib.re/article/metas_liens.html + https://tyto.echolib.re/article/metas_liens.html + Mon, 08 Jan 2024 + Comment écrire des liens pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer des liens (logo) + https://tyto.echolib.re/article/metas_liens.html + + format .tyto,écrire,liens + + + + Écrire les métadonnées indispensables + https://tyto.echolib.re/article/metas_obligatoires.html + https://tyto.echolib.re/article/metas_obligatoires.html + Sat, 06 Jan 2024 + Comment écrire les métadonnées obligatoires dans l'entête de l'article source pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_5_metas.png + Écrire les métadonnées indispensables (logo) + https://tyto.echolib.re/article/metas_obligatoires.html + + format .tyto,écrire,métadonnées,entête + + + + Écrire des paragraphes + https://tyto.echolib.re/article/redac_paragraphes.html + https://tyto.echolib.re/article/redac_paragraphes.html + Tue, 05 Dec 2023 + Comment écrire des paragraphes pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Écrire des paragraphes (logo) + https://tyto.echolib.re/article/redac_paragraphes.html + + rédaction,marqueurs,paragraphes + + + + Mentions Légales + https://tyto.echolib.re/a-propos/index.html + https://tyto.echolib.re/a-propos/index.html + Sun, 14 Jan 2024 + Mentions légales, condition d'utilisation et licence du site web officiel de Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/justice_scales_cc0.png + Mentions Légales (logo) + https://tyto.echolib.re/a-propos/index.html + + mentions légales,C.G.U,licence + + + + Écrire des titres et sous-titres + https://tyto.echolib.re/article/redac_titres.html + https://tyto.echolib.re/article/redac_titres.html + Sun, 07 Jan 2024 + Comment écrire les titres et les sous-titres pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/tyto_titles_toc.png + Écrire des titres et sous-titres (logo) + https://tyto.echolib.re/article/redac_titres.html + + rédaction,marqueurs,titres,table des matières + + + + Écrire un article au format .tyto + https://tyto.echolib.re/article/index.html + https://tyto.echolib.re/article/index.html + Sat, 06 Jan 2024 + Comment écrire un article pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/images/logos/format_tyto.png + Écrire un article au format .tyto (logo) + https://tyto.echolib.re/article/index.html + + format .tyto,écrire, + + + + Afficher des images + https://tyto.echolib.re/article/mere_images.html + https://tyto.echolib.re/article/mere_images.html + Tue, 05 Dec 2023 + Comment afficher des images et utiliser leurs marqueurs pour Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Afficher des images (logo) + https://tyto.echolib.re/article/mere_images.html + + marqueurs,images + + + + Gérer les modules dans les pages + https://tyto.echolib.re/modules/index.html + https://tyto.echolib.re/modules/index.html + Mon, 18 Dec 2023 + Comment gérer les modules (nginx) de Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Gérer les modules dans les pages (logo) + https://tyto.echolib.re/modules/index.html + + modules,nginx,metas,header,navbar,sidebar,footer + + + + Créer et configurer un domaine + https://tyto.echolib.re/config/index.html + https://tyto.echolib.re/config/index.html + Tue, 05 Dec 2023 + Comment créer un nouveau domaine valide et le configurer avec Tyto - Littérateur + echolib + + https://tyto.echolib.re/template/VH_Tyto_logo.png + Créer et configurer un domaine (logo) + https://tyto.echolib.re/config/index.html + + configuration,domaine + diff --git a/src/usr/share/tyto/docs/www/sitemap.html b/src/usr/share/tyto/docs/www/sitemap.html new file mode 100644 index 0000000..af9f55b --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.html @@ -0,0 +1,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +Plan du site (Tyto) | Tyto - Littérateur + + + + + + + + + + + + + + + +Plan du site + + +Tyto, 17/01/2024 [Code source] + + +Liste des articles (12) + + +Bienvenue, librement +Afficher du code en bloc +Les URIs spécifiques +Créer des liens +Écrire les métadonnées indispensables +Écrire des paragraphes +Mentions Légales +Écrire des titres et sous-titres +Écrire un article au format .tyto +Afficher des images +Gérer les modules dans les pages +Créer et configurer un domaine + + + + + + + + + + + + + + + + diff --git a/src/usr/share/tyto/docs/www/sitemap.tyto b/src/usr/share/tyto/docs/www/sitemap.tyto new file mode 100644 index 0000000..273605e --- /dev/null +++ b/src/usr/share/tyto/docs/www/sitemap.tyto @@ -0,0 +1,29 @@ +# Tyto - Littérateur +! NOMAP +! NORSS + +title: Plan du site +about: Plan du site généré par Tyto - Littérateur +tags: Plan du site +authors: Tyto +date: 2024-01-17 + +----- +#1 Liste des articles (12) + +(( sitemap + (= sitemap_items + + Bienvenue, librement + + Afficher du code en bloc + + Les URIs spécifiques + + Créer des liens + + Écrire les métadonnées indispensables + + Écrire des paragraphes + + Mentions Légales + + Écrire des titres et sous-titres + + Écrire un article au format .tyto + + Afficher des images + + Gérer les modules dans les pages + + Créer et configurer un domaine + )= +)) diff --git a/website_doc/template/VH_Tyto_logo.png b/src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png similarity index 100% rename from website_doc/template/VH_Tyto_logo.png rename to src/usr/share/tyto/docs/www/template/VH_Tyto_logo.png diff --git a/website_doc/template/favicon.png b/src/usr/share/tyto/docs/www/template/favicon.png similarity index 100% rename from website_doc/template/favicon.png rename to src/usr/share/tyto/docs/www/template/favicon.png diff --git a/website_doc/template/footer.html b/src/usr/share/tyto/docs/www/template/footer.html similarity index 96% rename from website_doc/template/footer.html rename to src/usr/share/tyto/docs/www/template/footer.html index b327fae..4090a32 100644 --- a/website_doc/template/footer.html +++ b/src/usr/share/tyto/docs/www/template/footer.html @@ -12,7 +12,7 @@ en Python par Cyrille Louarn (echol Le code source est composé (hors fichiers de traductions) de 18 fichiers -totalisant 5048 lignes dont 1231 lignes commentées, soit 2851 lignes de scripts. +totalisant 5051 lignes dont 1231 lignes commentées, soit 2853 lignes de scripts. Tyto - Littérateur (version 1.11.4) est fait avec amour <3 diff --git a/website_doc/template/header.html b/src/usr/share/tyto/docs/www/template/header.html similarity index 100% rename from website_doc/template/header.html rename to src/usr/share/tyto/docs/www/template/header.html diff --git a/website_doc/template/metas.html b/src/usr/share/tyto/docs/www/template/metas.html similarity index 100% rename from website_doc/template/metas.html rename to src/usr/share/tyto/docs/www/template/metas.html diff --git a/src/usr/share/tyto/docs/www/template/navbar.html b/src/usr/share/tyto/docs/www/template/navbar.html new file mode 100644 index 0000000..bbfa1d0 --- /dev/null +++ b/src/usr/share/tyto/docs/www/template/navbar.html @@ -0,0 +1,9 @@ + + + +config +article +modules +publier + + diff --git a/website_doc/template/sidebar.html b/src/usr/share/tyto/docs/www/template/sidebar.html similarity index 100% rename from website_doc/template/sidebar.html rename to src/usr/share/tyto/docs/www/template/sidebar.html diff --git a/website_doc/template/styles.css b/src/usr/share/tyto/docs/www/template/styles.css similarity index 99% rename from website_doc/template/styles.css rename to src/usr/share/tyto/docs/www/template/styles.css index 0818419..f4e1d69 100644 --- a/website_doc/template/styles.css +++ b/src/usr/share/tyto/docs/www/template/styles.css @@ -166,6 +166,10 @@ h6.tyto { font-size: 1.2rem; } +img.bandeau { + max-width: 100% +} + p.alert { color: #FFFDA5; font-weight: bold; @@ -254,6 +258,7 @@ ul.tyto :is(ol, ul) { footer#footer { border-top: 2px dotted gray; color: #FFF; + margin-top: 40px; } div#footer_title { diff --git a/website_doc/sitemap.html b/website_doc/sitemap.html deleted file mode 100644 index c643e3a..0000000 --- a/website_doc/sitemap.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plan du site (Tyto) | Tyto - Littérateur - - - - - - - - - - - - - - - -Plan du site - - -Tyto, 15/01/2024 [Code source] - - -Liste des articles (8) - - -Écrire les titres et sous-titres -Mentions Légales -Écrire un article au format .tyto -Écrire les métadonnées indispensables -Les URIs spécifiques -Écrire/créer des liens -Page non trouvée -Bienvenue, librement - - - - - - - - - - - - - - - - diff --git a/website_doc/sitemap.tyto b/website_doc/sitemap.tyto deleted file mode 100644 index 6099374..0000000 --- a/website_doc/sitemap.tyto +++ /dev/null @@ -1,25 +0,0 @@ -# Tyto - Littérateur -! NOMAP -! NORSS - -title: Plan du site -about: Plan du site généré par Tyto - Littérateur -tags: Plan du site -authors: Tyto -date: 2024-01-15 - ------ -#1 Liste des articles (8) - -(( sitemap - (= sitemap_items - + Écrire les titres et sous-titres - + Mentions Légales - + Écrire un article au format .tyto - + Écrire les métadonnées indispensables - + Les URIs spécifiques - + Écrire/créer des liens - + Page non trouvée - + Bienvenue, librement - )= -)) diff --git a/website_doc/template/navbar.html b/website_doc/template/navbar.html deleted file mode 100644 index 3a46f7b..0000000 --- a/website_doc/template/navbar.html +++ /dev/null @@ -1,6 +0,0 @@ - - - -article - -
+ + + + +Créer et configurer un domaine + + +echolib, 05/12/2023 [Code source] + + +Table des matières + + +Créer un domaine + +Les commandes à taper + +Répondre aux questions + +Exemple d'un domaine créé + + +Modifier la configuration + +Les valeurs importantes + + + + +Créer un domaine + +Tyto littérateur fonctionne dans un dossier ayant l'identité d'un nom de +domaine. Il faut qu'il soit au minimum au format "domaine.tld". Vous pouvez +le créer, à l'emplacement de votre choix. Ce dossier est votre +dossier de travail. Seulement une fois ce dossier ouvert (dans un +terminal), vous pouvez lancer la procédure de création du domaine afin de +créer votre nouveau site. + + +Tyto - Littérateur étant capable de gérer de nombreux domaines, vous pouvez +créer un dossier racine "mes_sites", et créer dedans tous les sous-dossiers +des domaines. + +Les commandes à taper + + +# Commande bash pour créer un dossier du domaine +mkdir -p domaine.tld + +# Se placer dans le dossier créé +cd domaine.tld + +# Créer et configurer le domaine "domaine.tld" +tyto new domain + +Répondre aux questions + + + +Pour configurer le domaine "domaine.tld", Tyto - Littérateur, a besoin de +quelques renseignements concernant ce domaine, et notemment : + +le titre du domaine +la date de création (format AAAA ou AAAA-MM ou AAAA-MM-JJ) +la description du domaine +les étiquettes du domaine (séparées par une virugule) +le courriel de l'administrateur +la langue du domaine (celle du site web) sur 2 caractères (en, fr...) +le dossier du serveur root + + +Exemple d'un domaine créé + +Une fois toutes les questions répondues, le fichier tyto_domain.ini est +créé dans le dossier du domaine. Quelques données supplémentaires sont +configurables dans le fichier, qui est au format INI. Il est plus que +recommandé de l'ouvrir et de vérifier son contenu +avant de continuer. Vous pouvez le lire avec la commande +tyto show domain. Le domaine est désactivé après sa création. + + + +[DOMAIN] +name = tyto.echolib.re +work = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/ +activated = True +title = Tyto - Littérateur +date = 2022 +about = Documentation officielle du littérateur libre +tags = Tyto,littérateur,logiciel libre,documentation +mail = echolib+tyto@a-lec.org + +[WEBSITE] +wip_url = https://www-wip.echolib.re/ +www_url = https://tyto.echolib.re/ +css = tyto +separator = | +article_code = True +lang = fr +license = gfdl-1.3 +license_url = https://www.gnu.org/licenses/fdl-1.3.txt + +[WEBSITE_FOOTER] +link_1 = "Licence : gfdl-1.3", "https://www.gnu.org/licenses/fdl-1.3.txt", "Licence du site web de Tyto - Littérateur" +link_2 = "Mentions légales", "/", "Mentions légales de Tyto - Littérateur" +link_3 = "C.G.U", "/", "C.G.U de Tyto - Littérateur" +link_4 = "Statuts", "/", "Statuts de Tyto - Littérateur" + +[WEBSITE_MODULES] +sidebar_title = Articles recommandés +sidebar_items = 6 +rss_items = 100 +sitemaps = True + +[TEMPLATE_FILENAMES] +favicon = favicon.png +logo = VH_Tyto_logo.png +styles = styles.css +rss = rss.xml +stats = tyto_stats.ini + +[SERVER] +srv_root = /home/echolib/Projets/www/ + +[TYTO] +id = 23ac1f4c +conf_uri = /home/echolib/Projets/Tyto/websites/tyto.echolib.re/tyto_domain.ini +user_uri = /home/echolib/.local/Tyto/23ac1f4c.ini + +Modifier la configuration + +Le fichier tyto_domain.ini dispose de catégories, comme [WEBSITE], avec +les paramètres clé = valeur. Si vous modifiez une valeur, Tyto vérifiera +et reconstruira à nouveau le fichier. Les pages du site étant statiques, dans +certains cas, il faudra toutes les reconstruire. Si les modifications +concernent la catégorie [WEBSITE_FOOTER], seul le pied de page devra être +reconstruit. + +Les valeurs importantes + + +[DOMAIN] +# Remplacer par True pour activer +# ou utiliser la commande tyto start / tyto stop +activated = False + +[WEBSITE] +# L'adresse (URL) du site web temporaire (wip) +wip_url = https://www-wip.domaine.tld/ + +# L'adresse (URL) du site officiel (publish) +www_url = https://domaine.tld/ + +# La classe CSS par défaut +css = tyto + +# Le séparateur entre le titre de la page et le titre du site +# dans la balise HTML <title> +separator = - + +# Valeur booléane True/False (Oui/Non) +# Afficher le lien vers le code source de l'article +article_code = False + +# Langue des pages du site +# La traduction doit exister (fournies: en, fr) +lang = fr + +[WEBSITE_MODULES] +# Le nom de la barre latérale +sidebar_title = Articles recommandés + +# Nombre d'articles dans la barre latérale (0 pour désactiver) +sidebar_items = 6 + +# Nombre d'articles dans le flux RSS (0 pour désactiver) +rss_items = 100 + +# Création automatique du sitemap (sitemap.html) +sitemaps = True + +[WEBSITE_FOOTER] +# Les liens du pied de page dans [WEBSITE_FOOTER] +# les clés link_1 à link_4 sont créés automatiquement +# Pour désactiver, enlever la valeur, laisser la clé ! +# Format de clé +# l'URL peut être locale. Ex : "/about/cgu.html" +clé = "Nom à afficher", "URL", "Contenu de title=" + +[TEMPLATE_FILENAMES] +# Nom des fichiers +# (à ajouter dans le dossier .../wip/template/) +favicon = favicon.png +logo = logo.png +styles = styles.css + + +
- + @@ -71,6 +71,7 @@ par mail ou, de préférence, via Gestion et personnalisation Utilisation Traductions +Pour commencer Le projet @@ -125,6 +126,12 @@ utilisée par le système, mais chaque site peut utiliser l'une ou l'autre, via la configuration du domaine. Il est aussi assez facile de rajouter des langues supplémentaires. +Pour commencer + +Configurer un domaine +Écrire un article +Configurer les modules +
+ + + + +Gérer les modules dans les pages + + +echolib, 18/12/2023 [Code source] + + +Table des matières + + +Définitions des modules + +Le module "metas" + +Exemple HTML des metas + +Le module "header" + +Exemple HTML d'une entête + +Le module "navbar" + +Exemple HTML d'un menu + +Le module "sidebar" + +Exemple HTML d'une barre latérale + +Le module "footer" + +Exemple HTML de pied de page + + +Forcer une nouvelle génération des modules HTML +Afficher les modules dans les pages avec nginx + + +Définitions des modules + +Tyto - Littérateur intègre dans chaque page du site, différents modules. +Ils sont créés automatiquement lors du 1er "wip" d'un article, ou si le +contenu du fichier de configuration du module a changé. Vous pouvez les gérer, +et modifier leurs contenus grâce aux fichiers ".../modules/[module].raw" +dans le dossier de travail du domaine. Chaque fichier dispose d'une petite +aide explicative, et de rappel d'URIs dans son entête. Vous pouvez forcer +la génération d'un module avec la commande tyto wip [module_name] + +Le module "metas" + +Le module "metas", issu du fichier de configuration "metas.raw" insère des +balises HTML <meta>, prioritaires. Les balises utilisées par défaut : + +Exemple HTML des metas + + +<meta charset="UTF-8"> +<meta name="robots" content="all"> +<meta name="medium" content="website"> +<meta name="revisit-after" content="3 days"> +<meta name="viewport" content="width=device-width, initial-scale=1.0"> + +Le module "header" + +Le module "header", issu du fichier de configuration "header.raw" insère +l'entête HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Voici un exemple de sa structure HTML et des +identificateurs CSS : + +Exemple HTML d'une entête + + +<a role="link" id="site_link" href="/" title="%s"> +<header id="header"> +<div id="header_logo"> +<img id="header_logo_image" src="%s" alt="%s"> +</div> +<div id="header_abouts"> +<p id="header_title">%s</p> +<p id="header_about">%s</p> +</div> +</header> +</a> + +Le module "navbar" + +Le module "navbar" issu du fichier de configuration "navbar.raw" insère +la barre de manu principale, libellée pour l'accessibilité, "navigation-1". +Son contenu par défaut est vide. + + +Pour ajouter un onglet au menu du site : + +créer un dossier dans le dossier de travail du domaine ".../articles/" +créer un article "index.tyto" dans le nouveau dossier +créer l'article HTML via la commande "wip" +éditer le fichier navbar.raw, en ajoutant le nom du nouveau dossier + + +Exemple HTML d'un menu + + +<nav id="menu" aria-labelledby="navigation-1"> +<menu role="menu" id="menu_items"> +<li role="menuitem" class="menu_item"> +<a role="link" class="menu_link" href="%s" title="%s">%s</a> +</li> +</menu> +</nav> + +Le module "sidebar" + +Le module "sidebar" issu du fichier de configuration "sidebar.raw" insère +la barre latérale contenant des articles à mettre en avant. Son contenu +par défaut est vide. Le nombre d'articles maximum est 6 par défaut, dans la +::configuration du domaine. La barre latérale est libéllée pour +l'accessibilité "navigation-2" + + +Pour ajouter un article à la barre latérale : + +créer un article .tyto +créer l'article HTML via la commande "wip" +éditer le fichier sidebar.raw en ajoutant l'URI de l'article (URI depuis le dossier de travail du domaine ".../article/") + + +Exemple HTML d'une barre latérale + + +<aside id="sidebar"> +<div id="sidebar_title">%s</div> +<nav role="navigation" id="sidebar_menu" aria-labelledby="navigation-2"> +<ul role="list" id="sidebar_items"> +<li role="listitem" class="sidebar_item"> +<div class="sidebar_post_title"> +<a role="link" class="sidebar_post_link" href="%s">%s</a> +</div> +<div class="sidebar_post_about"> +<p class="sidebar_post_about_p" title="%s -- %s, %s">%s</p> +</div> +</li> +</ul> +</nav> +</aside> + +Le module "footer" + +Le module "footer" issu du fichier de configuration "footer.raw" insère le +pied de page HTML dans les pages du site. Son contenu dépend de la +::configuration du domaine. Un menu de navigation, libellé pour +l'accessibilité "navigation-3", est créé automatiquement. + +Exemple HTML de pied de page + + +<footer id="footer"> +<div id="footer_title">%s <strong>%s</strong></div> +<div id="footer_about_menu"> +<div id="footer_about"> +%s +</div> +<nav id="footer_menu" aria-labelledby="navigation-3"> +<ul role="list" id="footer_items"> +<li role="listitem" class="footer_item"> +<a role="link" class="footer_item_link" href="%s" title="%s %s">%s</a> +</li> +</ul> +</nav> +</div> +<div id="footer_credit"> +<p id="footer_copyright">%s</p> +<p id="footer_tyto">%s</p> +</div> +</footer> + +Forcer une nouvelle génération des modules HTML + +Même si un module a déjà été généré, si vous avez besoin de forcer une +nouvelle génération de modules, il suffit de le demander, via l'action "wip". + +Les modules HTML se trouvent dans le dossier du serveur "...wip/template/" + + +tyto wip modules # Créer TOUS les modules HTML +tyto wip metas # Créer le module metas.html +tyto wip header # Créer le module header.html +tyto wip navbar # Créer le module navbar.html +tyto wip sidebar # Créer le module sidebar.html +tyto wip footer # Créer le module footer.html + + + +Vous pouvez forcer la création d'un module HTML, mais, si le fichier de +configuration a été modifié, il sera automatiquement mis à jour à la +prochaine création d'un article via la commande "wip". Il faut toutefois +forcer la génération, si une métadonnée indispensable d'un article se +trouvant dans le module, a été modifiée + +Afficher les modules dans les pages avec nginx + +Même si les pages du site sont statiques, les modules doivent être appelés +par le serveur. Nginx dispose d'une configuration qui lui permet d'insérer +le contenu d'un fichier dans une page. L'action se déclenche lorsqu'un +commentaire HTML conttient # include_virtual="". Dans la configuration +du serveur nginx, il faut ajouter : + + + +ssi on; +ssi_last_modified on; +absolute_redirect off; + + +
+ + + + +Plan du site + + +Tyto, 17/01/2024 [Code source] + + +Liste des articles (12) + + +Bienvenue, librement +Afficher du code en bloc +Les URIs spécifiques +Créer des liens +Écrire les métadonnées indispensables +Écrire des paragraphes +Mentions Légales +Écrire des titres et sous-titres +Écrire un article au format .tyto +Afficher des images +Gérer les modules dans les pages +Créer et configurer un domaine + + + +
- - - - -Plan du site - - -Tyto, 15/01/2024 [Code source] - - -Liste des articles (8) - - -Écrire les titres et sous-titres -Mentions Légales -Écrire un article au format .tyto -Écrire les métadonnées indispensables -Les URIs spécifiques -Écrire/créer des liens -Page non trouvée -Bienvenue, librement - - - -