Documentation

La documentation Apsionyx rassemble les informations nécessaires pour installer le CMS, administrer un site, publier du contenu et développer des thèmes ou des extensions.

Elle est organisée pour permettre à chacun de trouver rapidement ce dont il a besoin, sans devoir parcourir des informations techniques lorsqu’elles ne sont pas nécessaires.

Bien démarrer

Vous découvrez Apsionyx ?

Commencez par les étapes essentielles :

• installer Apsionyx ;

• accéder au tableau de bord ;

• personnaliser l’identité de votre site ;

• créer une première page ;

• publier un premier article ;

• gérer vos médias ;

• comprendre les principaux réglages.

L’objectif est de pouvoir commencer à publier rapidement sans devoir connaître le fonctionnement interne du CMS.

Installation

La documentation d’installation explique comment mettre Apsionyx en place sur différents types d’hébergement.

Elle couvre notamment :

• les prérequis ;

• l’installation sur un hébergement mutualisé ;

• l’installation sur un VPS ou un serveur dédié ;

• la configuration de la base de données ;

• les droits nécessaires sur les fichiers ;

• la configuration de la racine web ;

• HTTPS ;

• les URLs simplifiées ;

• les premiers diagnostics en cas de problème.

Apsionyx est conçu pour pouvoir fonctionner sur une infrastructure PHP classique sans imposer d’outils complexes.

Administration du site

La documentation d’administration présente les différentes parties du tableau de bord.

Vous y retrouverez notamment :

• le tableau de bord ;

• les articles ;

• les pages ;

• les médias ;

• les commentaires ;

• les membres ;

• l’apparence ;

• les fonctionnalités ;

• les langues ;

• les réglages ;

• les outils de maintenance.

Chaque partie est documentée en privilégiant les actions concrètes plutôt que le vocabulaire technique.

Publier du contenu

Apsionyx distingue notamment les articles et les pages.

La documentation éditoriale explique comment :

• créer un contenu ;

• utiliser l’éditeur ;

• enregistrer un brouillon ;

• prévisualiser une publication ;

• gérer les catégories et les mots-clés ;

• programmer une publication ;

• retrouver une révision précédente ;

• utiliser les brouillons de secours.

Les rédacteurs disposent ainsi des outils nécessaires pour préparer leur contenu sans devoir gérer les aspects techniques du site.

Médias

La médiathèque centralise les images utilisées dans les contenus et dans l’identité du site.

La documentation explique notamment :

• comment envoyer une image ;

• comment la réutiliser dans un contenu ;

• comment renseigner un texte alternatif ;

• quels formats sont acceptés ;

• comment Apsionyx contrôle les fichiers envoyés.

Une attention particulière est accordée à l’accessibilité des contenus visuels.

Membres et rôles

Apsionyx dispose d’un système de comptes et de permissions permettant de gérer différents types d’utilisateurs.

Les rôles principaux sont :

• Membre ;

• Rédacteur ;

• Modérateur ;

• Administrateur.

La documentation explique les possibilités associées à chaque rôle ainsi que la manière de gérer les inscriptions, les comptes, les permissions et les restrictions.

Commentaires et modération

Lorsqu’ils sont activés, les commentaires peuvent être associés à de véritables comptes membres.

Les outils de modération permettent notamment :

• d’examiner les commentaires ;

• de traiter les contenus problématiques ;

• de suspendre temporairement un compte ;

• de limiter la possibilité de commenter ;

• de bannir un membre ;

• de consulter l’historique des actions de modération.

La documentation précise également la différence entre la gestion d’un compte et la gestion de ses contenus.

Personnaliser l’apparence

L’apparence publique du site est gérée par les thèmes.

Depuis Apsionyx, vous pouvez notamment personnaliser l’identité du site avec :

• son nom ;

• sa phrase d’accroche ;

• sa description courte ;

• sa description complète ;

- son logo ;

• son icône.

La documentation des thèmes explique également comment installer, activer et personnaliser une apparence sans modifier le cœur du CMS.

Ajouter des fonctionnalités

Les extensions permettent d’ajouter de nouvelles possibilités à Apsionyx sans modifier son cœur.

Elles peuvent enrichir aussi bien le site public que son administration.

La documentation explique :

• comment installer une extension ;

• comment l’activer ou la désactiver ;

• comment vérifier sa compatibilité ;

• comment gérer ses réglages ;

• comment intervenir si une extension provoque un problème.

Les extensions disposent d’une API publique versionnée afin de limiter leur dépendance au fonctionnement interne du CMS.

Langues

Apsionyx dispose d’un système de langues évolutif.

La documentation explique comment :

• changer la langue du site ;

• choisir la langue de son compte ;

• importer une nouvelle langue ;

• gérer les traductions disponibles ;

• créer ou maintenir un catalogue de traduction.

Le système de langues est conçu pour permettre à la communauté de contribuer sans modifier le cœur du CMS.

Sauvegarde et restauration

La sauvegarde fait partie de la maintenance normale d’un site.

La documentation explique quels éléments doivent être conservés et comment préparer une restauration.

Une sauvegarde complète peut notamment concerner :

• la base de données ;

• la configuration ;

• les données du site ;

• les médias ;

• les langues ajoutées ;

• les extensions personnalisées ;

• les thèmes personnalisés.

Les sauvegardes proposées par votre hébergeur restent également recommandées.

Maintenance et diagnostic

Apsionyx dispose d’outils permettant d’identifier plus facilement un problème.

La documentation de maintenance couvre notamment :

• les journaux ;

• les références d’erreur ;

• le cache ;

• les informations système ;

• les vérifications de configuration ;

• les opérations de maintenance ;

• les outils disponibles en ligne de commande.

Les détails techniques restent séparés de l’expérience publique afin de ne pas exposer d’informations sensibles aux visiteurs.

Documentation pour développeurs

Apsionyx fournit une API publique destinée aux développeurs.

Cette documentation concerne notamment :

• l’architecture générale du CMS ;

• l’API des extensions ;

• l’API des thèmes ;

• les événements ;

• les routes ;

• les permissions ;

• les manifestes ;

• la compatibilité entre versions ;

• la politique de dépréciation.

Les développeurs sont encouragés à utiliser exclusivement les API publiques lorsqu’ils créent des extensions ou des thèmes destinés à être distribués.

API des extensions

L’API des extensions permet d’ajouter des fonctionnalités sans dépendre directement des classes internes du CMS.

Elle définit notamment les contrats nécessaires pour :

• enregistrer des événements ;

• ajouter des routes ;

• manipuler des réponses HTTP ;

• accéder aux données autorisées ;

• déclarer des dépendances ;

• vérifier la compatibilité.

La version de l’API évolue indépendamment de la version générale d’Apsionyx.

API des thèmes

L’API des thèmes définit les informations qu’un thème peut utiliser.

Elle fournit notamment les données relatives :

• au site ;

• aux contenus ;

• aux auteurs ;

• à la navigation ;

• au logo ;

• aux descriptions ;

• aux ressources du thème.

Un thème correctement développé ne doit pas dépendre directement des mécanismes internes d’Apsionyx.

Documentation en évolution

La documentation évolue avec le projet.

Certaines parties seront enrichies progressivement avec :

• des exemples pratiques ;

• des guides pas à pas ;

• des références pour développeurs ;

• des solutions aux problèmes fréquemment rencontrés ;

• des recommandations d’accessibilité ;

• des guides de migration.

Les retours des utilisateurs permettent également d’identifier les explications qui doivent être améliorées.

Besoin d’aide ?

Si une information manque ou si une explication n’est pas suffisamment claire, n’hésitez pas à le signaler.

Une bonne documentation ne doit pas seulement décrire le fonctionnement du logiciel.

Elle doit permettre de comprendre rapidement quoi faire, pourquoi le faire et comment résoudre un problème lorsqu’il apparaît.

---

Apsionyx veut rester aussi compréhensible à utiliser qu’à développer. Sa documentation fait partie intégrante du projet.