Un générateur de site statique - retour accueil
git clone git://bebou.netlib.re/catium
Log | Files | Refs | README |
commit 3604fc25b3e899aa8b2e18a0e86dd67f267e2fc2
parent 3ba549f97bf2c33d8972049b72372a0b7f6ef03d
Auterice: Arthur Pons <arthur.pons@unistra.fr>
Date: Wed, 25 Sep 2024 21:06:02 +0200
francium -> catium
Voir ce mail :
Salut à toutes et tous,
On m'a déjà plusieurs fois fait la remarque que francium était un nom
qui donnait une vibe un nationaliste. Je réponds toujours en expliquant
d'où le nom provient à savoir :
* on voulait un outil pour générer rapidement des pages html persos
pour les chercheureuses
* on voulait faire un exemple en choisissant une femme ayant fait de
la recherche à Strasbourg
* on a choisi Marguerite Perey, elle a découvert le francium, le nom
sonne bien et hop
C'est une histoire sympa à raconter, tout le monde comprend que le
souhait est de rendre hommage à une femme scientifique et non pas à
notre superbe nation et tout se passe bien.
Cela dit :
1. Ça peut être un peu fatiguant de "justifier" le nom à la longue
(bien que ce soit une opportunité de parler de sa génèse)
2. Il reste vrai que Perey a choisit ce nom "en hommage au pays dans
lequel avait eu lieu la découverte" dixit wikipedia ce qui, sans
être grave, me fait un peu rouler des yeux
Je ne m'en faisais pas vraiment un souci jusque là mais en relisant sa
page wikipedia je découvre qu'elle avait initialement choisi le nom
"catium" pour une histoire de quantité de cation (suis pas chimiste).
Irène Joliot-Curie (la fille de ses parents) l'en a dissuadé parce que
cela faisait trop penser aux chats.
Je me demande alors si ce n'est pas une superbe opportunité de :
1. se débarrasser du léger inconvénient d'avoir un nom un peu "make
france great again"
2. faire une super référence au fait que la dernière étape de la
génération des pages dans francium est un cat
3. laisser les gens penser qu'il y a peut-être une référence à des
chatons là dedans (toujours populaire chez les libristes)
4. ne rien perdre de la référence à la genèse de francium ni de
l'occasion de parler de Marguerite Perey (en lui rendant même
encore plus hommage puisque l'on aurait choisi son nom de coeur)
Qu'est-ce que vous en pensez ?
Bonne journée 🙂 Arthur
Diffstat:
| M | CONSTRUIRE | | | 14 | +++++++------- |
| M | README | | | 48 | ++++++++++++++++++++++++------------------------ |
| M | USAGE | | | 24 | ++++++++++++------------ |
| M | contents/index.sh | | | 6 | +++--- |
| M | page | | | 2 | +- |
5 files changed, 47 insertions(+), 47 deletions(-)
diff --git a/CONSTRUIRE b/CONSTRUIRE @@ -1,4 +1,4 @@ -# Comment vous aussi vous auriez pu construire francium +# Comment vous aussi vous auriez pu construire catium Imaginez vouloir construire une site et être doté.e d'un outil qui traduit le format dans lequel vous préférez écrire en html. Peut-être que vous aimez @@ -169,10 +169,10 @@ pourtant sur une autre solution que nous allons partir, une solution qui nous permettera plus de flexibilité par la suite et surtout la possibilité de dynamiquement créer certaines parties du contenu markdown. -### le format "à la francium" et la prolifération des scripts shell +### le format "à la catium" et la prolifération des scripts shell Cette autre solution consiste à faire du document index.md lui même -un script. Et oui, dans francium, si c'est pas une makefile, c'est +un script. Et oui, dans catium, si c'est pas une makefile, c'est un script shell. Comme le dit le meme : @@ -405,7 +405,7 @@ de l'avoir, est toujours une bonne information à prendre. Ce système peut êtr utilisé pour créer des typologies de pages (article, notes etc) qui seraient générées de manières différentes. -En réalité dans Francium c'est le shebang +En réalité dans Catium c'est le shebang #! /usr/bin/env ./page @@ -507,7 +507,7 @@ nouveau dossier : save() cat >> "$tmpdir/$1" show() cmark "$tmpdir/$1" -Et voilà, à une exception près[^8] vous avez recréé absolument tout Francium +Et voilà, à une exception près[^8] vous avez recréé absolument tout Catium dans sa version non étendue. Bravo ! ## Automatiser la génération, le makefile @@ -530,7 +530,7 @@ créer orchestrer la génération de notre site. Tous le nécessaire pour que make puisse fonctionner doit être inscrit dans un fichier nommé `makefile` à la racine du projet. -Francium utilise Gnu Make et quelques syntaxes lui sont très spécifiques. +Catium utilise Gnu Make et quelques syntaxes lui sont très spécifiques. ## Le but @@ -696,7 +696,7 @@ déclenchera plus. C'est pour palier ce genre de scénarios qu'il existe une directive `.PHONY` qui permet de lister ce genre de règles[^9]. Ainsi make saura qu'il faut, pour ces règles, ignorer la préexistence de la cible. -Et voilà, vous avez réécri le makefile de francium tel qu'il existe aujourd'hui +Et voilà, vous avez réécri le makefile de catium tel qu'il existe aujourd'hui ! [^1]: que l'on utilisera pour les exemples dans ce document diff --git a/README b/README @@ -1,4 +1,4 @@ -# Francium +# Catium ``` shshsh shshsh shshsh sh sh shshsh shshsh sh sh sh sh @@ -12,7 +12,7 @@ sh sh sh sh sh sh sh shshsh shshsh shshsh sh sh 🚶🔫🚶 - Always has been ``` -## Une histoire de Francium +## Une histoire de Catium Je discutais un jour avec une personne du contenu que l'on consommait sur internet. Le dialogue était à peu près le suivant, elle commence : @@ -76,7 +76,7 @@ il est possible d'argumenter qu'hugo est un logiciel trop complexe et faisant trop de choix pour vous. On pourrait épiloguer là dessus, pour une autre fois et une autre personne peut-être. -Si ces outils ont relancé l'intérêt pour les sites statiques, Francium souhaite +Si ces outils ont relancé l'intérêt pour les sites statiques, Catium souhaite à son tour profiter de l'intérêt nouveau pour les sites statiques afin de relancer l'intérêt pour une certaine approche du développement d'outils numériques, que l'on choisit à tort ou à raison d'appeler convivialiste. Plus @@ -85,39 +85,39 @@ Strasbourg autour du besoin de générer des sites statiques pour le domaine de la recherche. L'une des utilisations identifiées était la création de page personnelles pour les chercheureuses. Pour en faire une démonstration il avait été décidé de faire la page de Marguerity Perey, chercheuse française ayant -travaillé à l'université de Strasbourg et ayant découvert... le francium.\ +travaillé à l'université de Strasbourg et ayant découvert... le catium.\ Ce projet initial de générer des pages personnelles de chercheureuses n'est pas mort. Un template html et une feuille de style adéquate, à l'identité visuelle Unistra, pourrait aider à le concrétiser. C'est finalement la page perso de Marc Chantreux aujourd'hui hors ligne qui -sera le premier site généré et publié grâce à Francium. A date du 11 janvier -2023 le site généré par ce dépôt est le seul en ligne généré par Francium. Le +sera le premier site généré et publié grâce à Catium. A date du 11 janvier +2023 le site généré par ce dépôt est le seul en ligne généré par Catium. Le socle du projet a été conçu et développé par Marc Chantreux. Après la mise en ligne de ce site le développement s'est étendu à d'autres membres du collectif Kaztele. Il y aurait bien d'autres choses à dire sur la genèse du projet, d'où le titre -de cette rubrique, *Une* histoire de Francium. J'invite les autres parties +de cette rubrique, *Une* histoire de Catium. J'invite les autres parties prenantes à écrire la leur. -## Sur la nature de Francium +## Sur la nature de Catium Un jour Marc et moi sortions de plusieurs heures de discussions pendant -lesquelles nous avons plusieurs fois fait référence à Francium comme un outil +lesquelles nous avons plusieurs fois fait référence à Catium comme un outil atomique, se suffisant à lui même. En disant ça nous mettions peut-être dans la tête de nos interlocuteurs l'image d'un simple couteau qui tient dans la main, dont les contours sont nettes et la forme plus ou moins identique pour tous ses utilisateurices. En sortant nous nous sommes partagés une intuition commune : cette image n'est pas celle qui se formait dans nos têtes quand on parlait de -Francium. Il est compliqué de définir le périmètre exact de ce qu'est Francium. +Catium. Il est compliqué de définir le périmètre exact de ce qu'est Catium. Où est-ce que l'outil commence, où est-ce qu'il se termine ? Qu'est-ce qui relève du générateur et qu'est-ce qui relève du contenu du site ? Ces interrogations se retrouvent dans certains choix techniques que le projet est -amené à prendre. Ce dépôt permet aujourd'hui de versionner à la fois Francium +amené à prendre. Ce dépôt permet aujourd'hui de versionner à la fois Catium (sans savoir ce que c'est exactement) et le contenu du site de Katzele. Si nous -voulions créer un dépôt Francium pour d'autres projets nous devrions répondre à +voulions créer un dépôt Catium pour d'autres projets nous devrions répondre à ces questions pour détricoter l'un de l'autre. Pourquoi n'est-ce pas trivial ? @@ -150,22 +150,22 @@ par défaut tel que fourni dans le dépôt source s'il existe un jour ? La versi actuelle maintenue pour le site de Katzele ? L'idée de générer un flux atom via du shell ? Bref on en a pas fini. -Nous pourrions décliner ces questions pour toutes les parties de Francium. Pour +Nous pourrions décliner ces questions pour toutes les parties de Catium. Pour revenir à l'échange avec Marc, il avait d'avantage mûri la question que moi. -Francium ne devrait pas être pensé comme, un outil indivisible mais une comme +Catium ne devrait pas être pensé comme, un outil indivisible mais une comme armature intellectuelle soutenant des outils, certains pré existants, d'autres créés pour l'occasion. D'ailleurs pour le site de Katzele sed est un outil autant nécessaire qu'atomic même si l'un a été développé pour et l'autre non.\ Si l'on voulait pousser cette idée d'armature intellectuelle jusqu'au bout nous -pourrions dire que Francium est un système décrit à travers de la documentation +pourrions dire que Catium est un système décrit à travers de la documentation et non pas ses implémentations. Il n'existerait donc pas de sous-ensemble de ce -dépôt que l'on pourrait raisonnablement appelé Francium. Ce dépôt ne serait que -la première implémentation de Francium, celle sous une forme qui rend les +dépôt que l'on pourrait raisonnablement appelé Catium. Ce dépôt ne serait que +la première implémentation de Catium, celle sous une forme qui rend les services dont le collectif Katzele a besoin à un instant T. -Il existera probablement un jour un dépôt Francium dont le contenu aura été le +Il existera probablement un jour un dépôt Catium dont le contenu aura été le résultat de choix plus ou moins raisonnables, fait en fonction des projets qui -veulent utiliser Francium sur le moment. Ce sera certainement pour le mieux. Si +veulent utiliser Catium sur le moment. Ce sera certainement pour le mieux. Si le concept un peu prétentieux d'armature intellectuelle nous sert à quelque chose ce sera de faire sens de cette tension : construire un outil convivialiste qui respecte autant que possible l'autonomie des personnes qui @@ -179,7 +179,7 @@ conversant entre humains, en vivant ensemble. ## Stop le blabla, comment ça fonctionne ? Comme expliqué précédemment la description suivante va mélanger ce qui pourrait -relever de Francium seul et du projet du site de Katzele. +relever de Catium seul et du projet du site de Katzele. ### Descriptif des dossiers et fichiers du projet @@ -239,7 +239,7 @@ L'arborescence des fichiers sources. Pour Katzele ### Fonctionnement général Pour ce "manuel" j'ai fait le choix d'expliquer comment les choses fonctionnent -en reconstruisant ensemble Francium à un degré d'abstraction que l'on juge +en reconstruisant ensemble Catium à un degré d'abstraction que l'on juge convenable. Non seulement je pense que c'est une approche pédagogique intéressante mais ce sera aussi la démonstration que penser, construire et modifier ce genre de systèmes est à la portée de beaucoup plus de gens qu'on ne @@ -249,7 +249,7 @@ mais dans les grandes lignes. Si à la lecture de ce qui suit vous vous dîtes a moins une ou deux fois "Ah oui pas bête, j'aurais éventuellement pu y penser !" alors l'objectif sera accompli.\ Le fait de pouvoir raconter l'histoire fictive d'une personne reconstruisant -tout Francium dans un simple document texte faisant +tout Catium dans un simple document texte faisant echo "$(wc -l < README) lignes dont $(grep "^ " < README | wc -l) de code soit environ $(dc -e "$(wc -l < README) 50 / p") pages A4, $(dc -e "$(wc -l < README) $(grep '^ ' < README | wc -l) - 50 / p") sans les exemples de code" @@ -264,8 +264,8 @@ trentaine de page c'est beaucoup mais il faut garder en tête que cela inclu similaire serait plus ou moins inconcevable pour une large part des logiciels que l'on utilise aujourd'hui. -Le but de Francium est de prendre les fichiers du dossier src et d'en faire un -site logeant dans root. Pour ce faire Francium mobilise plusieurs exécutables +Le but de Catium est de prendre les fichiers du dossier src et d'en faire un +site logeant dans root. Pour ce faire Catium mobilise plusieurs exécutables ou scripts qui transforment les sources et placent les données là où il faut dans les schémas de données. diff --git a/USAGE b/USAGE @@ -1,23 +1,23 @@ -# Comment utiliser Francium +# Comment utiliser Catium -Ce document existe pour apprendre à utiliser Francium sans pour autant lire +Ce document existe pour apprendre à utiliser Catium sans pour autant lire toute la documentation se trouvant aujourd'hui dans le fichier CONSTRUIRE qui -explique également comment et pourquoi Francium fonctionne de la sorte. +explique également comment et pourquoi Catium fonctionne de la sorte. -A noter, Francium est conçu pour être modifiable et même inciter à l'être. -Ainsi ce document documente comment utiliser Francium dans sa version +A noter, Catium est conçu pour être modifiable et même inciter à l'être. +Ainsi ce document documente comment utiliser Catium dans sa version "minimale". Des cas de modifications relativement simples seront couverts à la fin de ce document. -Il ne faut pas s'attendre à pouvoir modifier Francium facilement sans aucune -compétence en make/markdown/shell/html. L'idée est de faire de Francium un +Il ne faut pas s'attendre à pouvoir modifier Catium facilement sans aucune +compétence en make/markdown/shell/html. L'idée est de faire de Catium un logiciel favorisant l'apprentissage des ces technologies dont on estime qu'elles constituent un socle de compétences de bases en informatique. On pourrait évidemment débattre de ce que l'on inclu dans ce socle ou pas. ## Dépendances -En l'état Francium nécessite +En l'état Catium nécessite * de choisir un ou plusieurs formats dans lesquels écrire le site (du markdown par ex) @@ -31,7 +31,7 @@ markdown. ## Générer le site -Francium utilise GNU Make pour orchestrer la génération du site. Les règles de +Catium utilise GNU Make pour orchestrer la génération du site. Les règles de génération sont écrites dans le fichier `makefile`. Pour lancer la génération faire @@ -142,7 +142,7 @@ exécutables. Ils doivent commencer par la ligne #! /usr/bin/env ./page pour être préprocessés par le script `page`. Ils doivent ensuite contenir un -ensemble de métadonnée. En l'état Francium propose +ensemble de métadonnée. En l'état Catium propose * `title: "titre de la page"` pour renseigner le contenu de la balise `<title>`, à savoir ce qui s'affiche dans le titre de l'onglet de votre navigateur @@ -267,14 +267,14 @@ d'autres morceaux du site, de la date etc. Voilà, à partir de là si vous savez écrire du markdown et que vous n'avez pas besoin d'autre chose que des pages simplistes comme celles générées avec le template fourni vous avez les cartes en main pour créer votre site avec -Francium. Cela dit l'esprit de l'outil est qu'il est de nature "hackable" avec +Catium. Cela dit l'esprit de l'outil est qu'il est de nature "hackable" avec des compétences que l'on juge, dans le collectif, comme étant de bonnes candidates pour être des compétences "socles" dans l'informatique. En dessous nous voyons quelques cas de modifications qui pourraient vous intéresser ou vous mettre sur la bonne piste. -## Modifier Francium +## Modifier Catium Admettons que vous vouliez apporter les modifications suivantes à l'existant : diff --git a/contents/index.sh b/contents/index.sh @@ -1,12 +1,12 @@ #! /usr/bin/env ./page title: Un exemple de page author: katzele -description: Un exemple de page Francium démontrant une partie des fonctionnalités +description: Un exemple de page Catium démontrant une partie des fonctionnalités section: main -# Un exemple de page dans Francium +# Un exemple de page dans Catium -Cette page est un exemple simple de ce que l'on peut faire avec Francium +Cette page est un exemple simple de ce que l'on peut faire avec Catium Ici c'est du markdown : diff --git a/page b/page @@ -33,7 +33,7 @@ alias section:='<<\endsection save' # SUPPRIMEZ DE LA <<. >&2 cat ---------------------------- -Première exécution de francium, merci d'aller modifier le code juste en dessous +Première exécution de catium, merci d'aller modifier le code juste en dessous de ce paragraphe dans le fichier "page". Cela vous permettra de choisir un ou plusieurs transcripteurs pour votre site. Si une ou plusieurs des lignes déjà présentes vous conviennent vous pouvez la ou les décommenter en retirant le "#"