Agrégateur d'Internet (flux RSS et tout le reste).
Gout est une extension Firefox pour récupérer des informations sur Internet (flux RSS, résultats d'API, parsing de sites Internet...) et les afficher dans une page Web. Les dashboards sont ces pages Web avec du JSON pour les widgets. Et il est aussi possible de développer des modules et des scrapers pour agréger de nouveaux sites Internet.
Un dashboard est une page Web qui contient des widgets. Elle doit importer le
moteur de rendu de Gout :
"https://cdn.jsdelivr.net/gh/regseb/gout@0/src/engine/script.js".
Voici un exemple de dashboard ayant quatre colonnes de widgets :
<!DOCTYPE html>
<html lang="fr-FR">
<head>
<meta charset="utf-8">
<link href="https://cdn.jsdelivr.net/gh/regseb/gout@0/src/engine/img/icon.svg"
rel="shortcut icon">
<title>Gout</title>
<script src="https://cdn.jsdelivr.net/gh/regseb/gout@0/src/engine/script.js"
type="module"></script>
<style>
body { display: flex; }
div { display: flex; flex-direction: column; }
</style>
</head>
<body>
<div style="width: 25%;">
<script type="application/json">{ "...": "..." }</script>
<script type="application/json">{ "...": "..." }</script>
<!-- ... -->
</div>
<div style="width: 25%;">
<script type="application/json">{ "...": "..." }</script>
</div>
<div style="width: 25%;">
<script type="application/json">{ "...": "..." }</script>
</div>
<div style="width: 25%;">
<script type="application/json">{ "...": "..." }</script>
<script type="application/json">{ "...": "..." }</script>
</div>
</body>
</html>Un widget est bloc du dashboard. C'est un élément <script> qui contient un
objet JSON définissant son module et ses scrapers :
"module": Un objet JSON contenant le règlage du module."scrapers": La liste des scrapers avec leur configuration.
Cette exemple de widget affiche les actualités du site LinuxFr.org.
<script type="application/json">
{
"module": {
"url": "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/module/list/list.js",
"config": {
"color": "#ffc107",
"cron": "*/10 * * * *",
"max": 5
}
},
"scrapers": [{
"url": "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js",
"config": {
"url": "https://linuxfr.org/news.atom"
}
}]
}
</script>Les modules sont les composants du widget définissant comment les données sont affichées (une liste de liens, une image...). Dans la configuration du widget, l'objet JSON du module est composé de trois propriétés :
"$extends": L'URL (avec le suffixe#module) vers la configuration d'un widget pour hériter des réglages de son module. Si cette propriété n'est pas renseignée, ce module n'a pas de préréglage."url": L'URL du script JavaScript du module (par exemple pour le module list :"https://cdn.jsdelivr.net/gh/regseb/gout@0/src/module/list/list.js"). Cette propriété est obligatoire sauf si le module a un préréglage (avec"$extends")."config": Un objet JSON contenant la configuration du module (qui est spécifique pour chaque module). Selon les modules, cette propriété est optionnelle.
Dans cet exemple, le module est une liste de podcasts (avec au maximum cinq
éléments) affichée dans un bloc bleu #2196f3 et actualisée toutes les dix
minutes :
<script type="application/json">
{
"module": {
"url": "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/module/list/list.js",
"config": {
"color": "#2196f3",
"cron": "*/10 * * * *",
"max": 5
}
},
"scrapers": [{ "...": "..." }]
}
</script>Les scrapers permettent d'extraire des données (flux RSS, parsing de page...) et de les transmettre à un module dans un format spécifique. Plusieurs scrapers peuvent être utilisés avec un module. Dans la configuration du widget, les scrapers sont définis dans un tableau d'objets JSON composés de trois propriétés :
"$extends": L'URL (avec le suffixe#scrapers[N]) vers la configuration d'un widget pour hériter des réglages d'un de ses scrapers (où N est son index). Si cette propriété n'est pas renseignée, ce scraper n'a pas de préréglages."url": L'URL du script JavaScript du scraper (par exemple pour le scraper list/rss :"https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js"). Cette propriété est obligatoire sauf si le scraper a un préréglage (avec"$extends")."config": un objet JSON contenant la configuration du scraper (qui est spécifique pour chaque scraper). Selon les scrapers, cette propriété est optionnelle.
Dans cet exemple, deux scrapers sont définis pour récupérer les dernières vidéos des chaines YouTube ARTE Cinema et ARTE Séries :
<script type="application/json">
{
"module": { "...": "..." },
"scrapers": [{
"url": "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js",
"config": {
"url": "https://www.youtube.com/feeds/videos.xml?channel_id=UClo03hULFynpoX3w1Jv7fhw",
}
}, {
"url": "https://cdn.jsdelivr.net/gh/regseb/gout@0/src/scraper/list/rss/rss.js",
"config": {
"url": "https://www.youtube.com/feeds/videos.xml?channel_id=UCzaf-8cAEiXfynukcmV5MXw"
}
}]
}
</script>L'extension est disponible sur Firefox Browser Add-ons. Après l'avoir installée, téléchargez un template d'un dashboard. Ouvrez le fichier avec un éditeur de texte. Ajoutez les widgets que vous souhaitez dans le code HTML. Ouvrez le fichier avec votre navigateur et ajoutez la page dans l'extension (en cliquant sur l'icône de l'extension dans la barre d'outils du navigateur). Actualisez la page pour voir apparaitre les widgets.
