Superbaillot.net
Superbaillot.net
Aeres
Mode d'emploi d'Aeres (V2.4.1)
Superbaillot le 26/07/2012 - mise à jour 06/05/2013

Sommaire

Installation

Retour au sommaire

Rien de bien compliqué. Il suffit de décompresser l'archive, de copier le répertoire Aeres sur votre serveur et de lancer le fichier index.php. Lors du premier lancement, vous tomberez sur la page de configuration.
Première connexion
Vous devrez saisir au moins un nouveau mot de passe (l'ancien étant vide) et enregistrer. Vous pourrez alors accéder à la page Liste des flux et Gérer mes flux.

Liste des flux

Retour au sommaire

Dans la partie titre, vous avez le module de connexion. Il vous suffit de saisir votre mot de passe pour passer en mode connecté. Le mot de passe est sensible à la casse (différentiation des majuscules et des minuscules).
Connexion

J'ai mis en place un système anti brutforce. Il sera impossible à tout le monde, vous y compris, de vous connecter aprés 10 mots de passes erronés dans la même journée. Vous devrez attendre le lendemain pour pouvoir à nouveau vous connecter.
Je me dis que pour se planter 10 fois, il faut soit ne pas être le maitre des lieux, soit être complêtement bourré et dans ce cas, attendre le lendemain pour ne pas faire de bêtise ne vous fera pas de mal.

En fait, si quelqu'un a bloqué votre connexion, vous pouvez toujours supprimer de répertoire "connexion". Vous repartirez à 0.

De même, si vous ne vous souvenez plus de votre mot de passe, supprimez le fichier "config.xml" qui se trouve dans le répertoire "Save".

A gauche, vous avez la liste de vos flux rangés par catégories.
Liste des flux

Dans le titre de ce module, il y a plusieurs informations et boutons :

  • Nombre de flux : Le nombre de flux visibles. Si vous avez des flux privés, ils ne seront comptabilisés que si vous êtes connecté.
  • Nombre total d'items archivés : Le nombre total d'items archivés. Si vous cliquez sur ce nombre, ils s'afficheront dans le partie "Détail".
  • Nombre total d'items non-lus : Le nombre total d'items non-lus. Si vous cliquez sur ce nombre, ils s'afficheront dans le partie "Détail".
  • bouton actualisé : Bouton qui permet d'actualisé les flux. Le rafraichissement peut prendre du temps si vous avez beaucoup de flux. Pour ne pas bloquer le serveur, Aeres fait une requête par flux, avec une fréquence par défaut de 2 secondes entre 2 requêtes (ceci peut être configuré dans les options). Du coup, le serveur n'est pas bloqué, mais peut être ralenti et la fréquence de 2 seconde entre 2 requêtes évite au serveur de considérer Aeres comme une attaque. Lorsque vous utilisez ce bouton, les favicon ne seront pas rafraichis par défaut. En effet, cela prend du temps et c'est dans la grande majorité des cas inutile. Toutefois, vous avez la possibilité de forcer le rafraichissement des favicon avec ce bouton dans les options de configuration d'Aeres, mais ce n'est pas conseillé.
  • bouton cacher la liste : Ce bouton permet de masquer la liste des flux pour avoir plus de place pour lire un article. Il vous suffira de recliquer sur ce bouton pour la faire réapparaitre.

La liste de vos flux est triée par catégorie. Cliquer sur le nom d'une catégorie pour afficher/cacher la liste des flux RSS de cette catégorie.

Pour chaque ligne (flux ou catégorie), vous pouvez avoir 2 nombres d'affichés à droitenombres d'items non-lus et archivés.

  • Le premier désigne le nombre d'items archivés. Ceux que vous voulez garder.
  • Le second est le nombre d'items non-lus.
Si l'un des 2 nombre vaut 0, il ne sera alors pas affiché.
En cliquant sur l'un de ces deux nombres, vous afficherez les items correspondants dans la partie de droite. Vous pouvez donc afficher la liste des items d'un seul flux ou bien d'une catégorie entière.
Vous pouvez aussi cliquer sur le nom d'un flux pour afficher les items archivés et non-lus.
Dans la liste des flux, les flux dont Aeres n'a pas réussi à mettre à jour la liste des items apparait en rouge. Cela peut être dû à la fermeture du site en question, ou bien à une panne temporaire du serveur. Si un flux apparait en rouge, je vous recommande de bien vérifier si le site qui ne répond pas a un problème temporaire ou non avant de le supprimer.
Les flux privés apparaissent en italic.

A droite, vous avez la liste des items d'un flux ou d'une catégorie.
Détail d'un flux

Dans le titre, à droite, vous avez la zone de recherche. recherche
En survolant cette zone avec la souris, des options apparaissent pour afficner la recherche.
recherche

Vous avez ensuite le nom du site ou de la catégorie suivi du descriptif du site dans le cas d'un flux.

Titre d'un flux

Vous avez ensuite une ligne de bouton permettant de faire quelques actions.
Dans le cas de l'affichage des items d'une catégorie :
Si vous n'êtes pas connecté, vous aurez trois boutons.

  • bouton Tout déplier : vous permet de voir le détail de tous les items affichés.
  • bouton Tout cacher : vous permet de masquer le détail de tous les items affichés.
  • bouton Inverser tri : vous permet d'inversé le tri actuel (deplus récent au plus ancien ou inversement).

Si vous êtes connecté, vous avez trois boutons en plus:
  • : vous permet de cocher tous ou aucun des items
  • bouton marquer lu : vous permet des marquer les items cochés comme lus (et donc de ne plus les faire apparaitre).
  • bouton archiver : vous permet des marquer les items cochés comme archivés.
Dans le cas de l'affichage des items d'un flux vous aurez accès à deux boutons supplémentaire que vous soyez connecté ou non :
  • bouton voir lu : vous permet d'afficher les items lus d'un flux. Si vous sélectionnez ces items, vous pouvez les refaire passer en archivés ou non-lus en cliquant sur le bouton correspondant. Attention : vous ne retrouverez pas ici tous les items que vous avez lu. Aeres ne garde que les items non lu, archivés et ceux qui sont dans la dernière version du flux RSS récupéré. Lorsqu'un item n'est plus dans le flux RSS du site et qu'il a été marqué comme lu, il est supprimé. Cela évite d'avoir des fichiers de plus en gros qui ralentissent l'application.
  • bouton actualiser : vous permet de rafraichir le flux. Si vous utilisez ce bouton, le favicon sera rafraichi.

Ensuite, vous avez la liste des items du flux ou de la catégorie. Dans le cas de la liste d'une catégorie, si vous cliquez sur le favicon d'un item, vous afficherez les items du flux.

Vous avez une ligne de bouton pour chaque item.

  • Le bouton bouton détail permet d'afficher le détail de l'item.
  • Le bouton bouton Marquer lu permet de marquer l'item comme lu sans avoir à le cocher puis a cliquer sur marquer lu. C'est plus rapide dans le cas d'un seul item.
  • Le bouton bouton Marquer archivé permet de marquer l'item comme archivé, de la même manière que le bouton précédant.
Enfin, si vous cliquez sur le titre de l'item, vous ouvrirez une nouvelle page sur le site d'origine de l'item.

Gérer mes flux

Retour au sommaire

Vous avez accés au formulaire pour ajouter un flux ou une catégorie.
Formulaire d'ajout
Pour faire apparaitre ce formulaire, il suffit de cliquer sur Ajouter un flux ou une catégorie.
Pour ajouter un flux, vous n'avez qu'à saisir l'url du flux, choisir une catégorie (ou en créer une), choisir si le flux est privé ou non et cliquer sur le bouton ajouter
A droite de ce formulaire, il y a un bouton Ajout. Ce bouton sert à créer un marque page en le faisant glisser dans votre barre personnelle (elle s'appelle barre personnelle sous firefox, volet des favoris sous Internet Explorer, barre de favoris sous Chrome ou barre d'outils sous Opéra). Ensuite, lorsque vous avez affiché un flux RSS, il vous suffit de cliquer sur ce bouton pour faire apparaitre un popup avec le formulaire précédent déjà pré-rempli. Si vous n'êtes pas connecté, votre mot de passe vous sera alors demandé en supplément.
J'ai "empruté" ce bouton à Sebsauvage sur son Shaarli. Merci à lui pour cette excellente idée.

Ensuite, vous avez la liste de vos flux triés par catégorie.
A côté de chaque catégorie, vous avez quatres éléments.

  • bouton édition : il vous permet de faire apparaitre le formulaire qui va vous permettre de modifier l'intitulé d'une categorie.
  • bouton bas : il vous permet de descendre la catégorie pour afficher les catégories dans l'ordre que vous avez choisi.
  • bouton haut : il vous permet de monter la catégorie pour afficher les catégories dans l'ordre que vous avez choisi.
  • bouton supprimer : il vous permet de supprimer la catégorie

Si vous cliquez sur le nom d'une catégorie, vous aurez la liste des flux de cette catégorie. A côté de chaque catégorie, vous avez cinq éléments :
  • privé : il vous permet de mettre ou pas, un flux en privé. Si le flux est privé, il ne sera affiché que si vous êtes connecté.
  • : il vous permet de changer un flux de catégorie.
  • bouton bas : il vous permet de descendre le flux pour afficher les flux dans l'ordre que vous avez choisi.
  • bouton haut : il vous permet de monter le flux pour afficher les flux dans l'ordre que vous avez choisi.
  • bouton supprimer : il vous permet de supprimer le flux.

Enfin, vous avez les options pour exporter ou importer un fichier opml ainsi que de faire une sauvegarde facilement de votre Aeres.

  • Import
    Import
    il vous suffit de selectionner votre ficher opml et de cliquer sur le bouton "Importer le fichier OPML". Lorsque vous importez une liste de flux, ces derniers ne sont pas actualisés à ce moment. Il vous faudra retourner sur la page "Liste des flux" pour les actualiser. Les favicon ne seront alors pas récupérés. C'est pour cela que j'ai ajouter l'option "Autoriser le rafraichissement automatique des favicons". En activant cette option puis en rafraichissant les flux, les favicon seront alors récupérés. Mais cette option utilise plus de ressource et peut prendre du temps, c'est pourquoi, je vous conseille de la désactiver une fois que vous avez récupéré vos favicons.
  • Export
    Export
    il vous suffit de cliquer sur le bouton "Exporter en OPML" pour générer un fichier OPML de vos flux.
  • Chargement
    Chargement
    il vous suffit de selectionner votre ficher zip et de cliquer sur le bouton "Charger". Votre Aeres reviendra dans l'état de la sauvegarde : la liste des flux, le tri par catégorie, les items non-lus et archivés, les favicons et les options.
  • Sauvegarde
    Sauvegarde
    il vous suffit de cliquer sur le bouton "Sauvegarder" pour générer un fichier zip qui contient le répertoire "Save". Vous pourrez alors le recharger pour revenir dans le même état.

Page de configuration

Retour au sommaire


Configuration
C'est la même page que la page affiché lorsque vous lancez Aeres pour la première fois. Vous pouvez :

  • changer votre pseudo
  • Changer votre mot de passe
  • changer votre logo
  • autoriser ou non l'acces public à votre liste de flux
  • définir le nombre d'item affiché par page
  • choisir le tri par défaut des items : du plus récent au plus ancien ou de plus ancien au plus récent.
  • choisir si le détail des items est visible ou non au chargement des items
  • choisir si le détail des items est charger ou non au chargement des items. Dans le cas où ils ne sont pas chargés, ils le seront lors du clic sur "détail". Cette action prendra donc un peu plus de temps. Par contre le chargement de la liste des items sera plus rapide.
  • N'afficher qu'un seul détail. Si vous affichez un détail alors qu'un autre est visible, ce dernier sera alors masqué.
  • autoriser ou non le rafraichissement automatique : si vous laissez votre navigateur ouvert, Aeres peut mettre à jour les flux automatiquement.
  • changer la fréquence de rafraichissement : si vous avez coché l'option ci-dessus, vous pouvez définir la fréquence de rafraichissement des flux.
  • changer le décalage des rafraichissements : Rafraichir une grande liste de flux prends du temps. Pour éviter un timeout, Aeres rafraichi les flux un par un. Pour ne pas saturer le serveur ni être concidéré comme une attaque, il convient de décaler le rafraichissement des flux. Cette option permet de définir le décalage entre le rafraichissement de deux flux.
  • autoriser ou non le rafraichissement des favicon : lors d'un rafraichissement des flux, par défaut, je ne met pas à jour les favicons. Cela prend du temps et des ressources inutilement car les favicon ne changent pas souvent. Le favicon est récupéré à l'ajout d'un flux ou via un rafrachissement d'un seul flux depuis le détail du flux. En fait, j'ai mis cette option uniquement dans le cas d'un import d'un fichier opml. Dans ce cas, aucun flux n'est mis à jour pendant l'import et donc les favicons ne seront jamais récupéré. Donc après avoir fait un import, si vous voulez récupérer les favicon, activez cette option, et faites un rafrachissement. Je vous conseille de désactiver cette option pour une utilisation normale
  • choisir la langue : Par défaut, je développe en français. Mais j'ai externalisé tous les textes pour pouvoir facilement les traduires, ou adapter des termes.

Sauvegarde

Retour au sommaire

Pour faire une sauvegarde, il vous suffit de sauvegarder le répertoire "Save".
Ce répertoire contient :

  • un répertoire flux : c'est dans ce répertoire que sont sauvegardé vos flux. Il y a un fichier par flux.
  • un répertoire favicon : c'est dans ce répertoire que sont sauvegardé les favicon de vos flux.
  • le fichier listeCat.xml : c'est dans ce fichier que sont sauvegarder les catégories.
  • le fichier config.xml : c'est dans ce fichier que sont sauvegarder vos préférences pour Aeres.

Depuis la version 2.4.1, j'ai ajouter un bouton qui permet de sauvegarder facilement ce répertoire en un fichier Zip dans la partie "Gérer mes flux". Il est bien sûr possible de recharger tout aussi facilement ce fichier.