Xiawe - CMS

Xiawe v0.5 : Documentation

• Grâce à son système d'installation automatique, Xiawe est facile à installer. Pour cela suivez les instructions suivantes:
  
  • Décompresser les fichiers
    
  • Les placer sur le serveur d'installation
    
  • Aller à l'url des fichiers et suivre la procédure d'installation indiquée.
    
  • Si tout s'est bien passé, il ne reste plus qu'a supprimer le repertoire install/ (si l'installateur n'a pas pu s'en charger) et à rentrer les données de votre site. Vous pouvez personaliser le nom du site et toutes les autres configurations dans le panneau de configuration.
    
  
  

• Le panneau d'administration permet de remplir le plus grand nombre des tâches, mais pas toutes (enfin, pas celles auxquelles nous n'avons pas pensées ). Je vais ici détailler chacune des sections de l'administration, puis comment accomplir les tâches de la partie non existante (pour le moment ).
  
  1. Panneau d'administration
     
     • L'index :
       Depuis cette page vous pouvez accéder à toutes les sections du panneau d'administration par des liens. C'est aussi le seul endroit où sont listé l'intégrité des articles. Le mot entre parenthèse est la variable d'URL (le lien dans l'URL qui permet d'accéder à votre page).
       
     • Les BBCodes : d'ici on administre les différentes balises. Il est possible de les modifier ou d'en créer. Détail des différentes options :
       
       • Balise : c'est ce qui sera entre les crochets ( [ et ] ). Par exemple, dans la balise [balise], ce serait balise.
         
       • HTML (avant/après) : c'est ce par quoi seront remplacé les balises. La balise ouvrante sera remplacé par "avant" et la balise fermante par "après". Il est possible de laisser le champ "après" vide pour former une balise qui n'a pas besoin de balise fermante.
         
       • Type : définit le type du bbcode. Un bbcode "normal" sera utilisé comme [exemple], c'est à dire sans paramètres. Un bbcode "complexe" requiert un paramètre, c'est à dire [exemple=truc]. Un bbcode "spécial" peut en fait être n'importe quoi, puisqu'il s'agit d'une fonction PHP qui est appelée dans la classe BBcode (par exemple, les listes [ list ][ * ][ /list ] sont des bbcodes spéciaux).
         
       • Format du paramètre : définit la forme du paramètre. C'est la même syntaxe que les expressions régulières de PHP. Par défaut, il s'agit de [^]]+, c'est à dire un ou plusieurs caractères qui ne sont pas des crochet fermant.
         
       
       
     • Menu : c'est l'édition du menu. Les BBCodes et les Smilies sont acceptés. Cliquer sur "modifier" pour modifier le contenu du menu. Il utilise un fichier unique pour chaque thème afin d'être formé correctement, utilisant tout les champs que vous spécifiez.
       
     • Édition des smilies : l'interface est simple : vous indiquez les carractères à remplacer par un smilie (chaine) et le nom du fichier par raport au chemin du repertoire des smilies défini dans le fichier de configuration (par défaut ./smilies/)
       
     • Administration des commentaires : Certainement la partie la plus simple de l'administration. Elle permet la suppression de commentaires sans interêt. Pour en supprimer un cliquer simplement sur le bouton "supprimer" qui correspond. Les liens dans le haut du panneau permet de choisir de quelle page vous désirez afficher les commentaires.
       
     • Édition de texte simple : sur l'index de l'administration figure la liste des articles disponibles dans la base de données. Il est possible d'en ajouter en cliquant sur le lien "ajouter". Dans l'interface de modification/ajout, le bouton ajouter sert à ajouter le texte dans la base de données, le bouton modifier à modifier le texte, et le bouton supprimer à supprimer le texte. La case à cocher sert à activer ou non les commentaires en bas de la page. Il est maintenant possible de prévisualiser les pages. Attention : toute opération est irreversible.
       
     • Changement du mot de passe : permet de changer son mot de passe.
       
     
     
  2. Administration manuelle
     
     • Structure générale : Xiawe stocke ses données dans un systeme de tables assez simple. Les données qui sont affichés sont pour la plupart stockées dans la table donnees. Chaque donnée se voit atribuée un type de document. Les types de document définissent la page php qui traitera les données. Par défaut, il s'agit de texte.php .
       
     • Détails de la table donnees :
       
       • id : clé primaire. Sa valeur est automatiquement calculée.
         
       • nom : c'est le nom des données. Il sera affiché comme titre de la page, dans le cadre d'un texte.
         
       • url : la valeur de la variable page dans l'url
         
       • type : type de document, indique avec quel fichier il sera traité.
         
       • contenu : données qui seront traitée par la page donnée dans le type de document.
         
       • avec_commentaire : d'une valeur de 0 ou 1, active ou désactive les commentaires (ne marche pas avec tout les types de document).
         
       • commentaires : contient les commentaires pour la page de texte. Peut varier selon le type de document.
         
       • auteur : id de l'auteur
         
       
       
     • Détails de la table scripts :
       
       • id : clé primaire. Sa valeur est automatiquement calculée.
         
       • type : le nom du type de fichier. Correspond à "type" dans donnees.
         
       • fichier : fichier à utiliser pour traiter ce type de document.
         
       
       
     • Détails de la table utilisateurs :
       
       • id : clé primaire. Sa valeur est automatiquement calculée
         
       • nom : nom d'utilisateur utilisé pour s'authentifier. L'identification ne prend pas en compte les majuscules.
         
       • motdepasse : mot de passe utilisé pour s'authentifier. Attention, il est encodé en MD5
         
       • email : adresse mail de l'utilisateur
         
       • aut : définit le niveau d'accès de l'utilisateur. Il s'agit en fait d'un simili tableau, séparé par des points-virgules, selon les valeurs suivantes :
         
         • Administration globale => -1
           
         • Écriture des textes => 1
           
         • Administration des textes => 2
           
         • Écriture des news => 3
           
         • Administration des news => 4
           
         • Administration des bbcodes => 5
           
         • Administration des smilies => 6
           
         • Administration du menu => 7
           
         • Administration des commentaires => 8
           
         • Administration de la configuration => 9
           
         • Administration des scripts => 10
           
         • Administration de la base de données => 11
           
         • Administration des utilisateurs => 12
           
         • Utilisation du html (expérimental) => 13
           
         
         Ce qui veut dire qu'un administrateur global a un niveau d'accès de -1, c'est à dire automatiquement tout les autres. Un utilisateur ayant accès au panneau de gestion des utilisateurs ne peut pas modifier quelqu'un qui possède plus d'accès que lui-même.
         
       
       
     • Détails de la table sessions :
       
       • session_sid : clé unique. C'est l'identifiant de session.
         
       • membre_id : il s'agit de l'id du membre enregistré dans cette session.
         
       • membre_ip : la valeur de l'ip du membre lors de l'enregistrement. C'est une protection supplémentaire contre le vol de session.
         
       • session_debut : timestamp UNIX déterminant le début de la session du membre.
         
       • session_temps : timestamp UNIX permettant à Xiawe de supprimer les sessions une fois expirées.
         
       
       C'est la table la plus "volatile", ses données changent de loin le plus souvent. En temps normal, avec aucun utilisateur connecté, elle devrait redevenir vide.
       
     • Détails de la table config :
       
       • Cette table enregistre les configurations de Xiawe. Sans elle, il ne serait pas possible de faire fonctionner le tout.
         
       • id : clé primaire. Sa valeur est automatiquement calculée.
         
       • nom : identifiant de configuration. Chacun doit être unique.
         
       • valeur : C'est la valeur de la configuration.
         
       • type : Permet d'aider Xiawe à déterminer quel comportement adopter face à la configuration. Trois types sont possibles :
         • Text : C'est un champ texte tout simplement.
           
         • Hidden : Cette valeur sera cachée et ne pourra pas être modifiée via le panneau d'administration.
           
         • Bool : Configuration booléenne (c'est à dire 0 ou 1).
           
         
         
       
       
     • Détails de la table système :
       
       • Il s'agit tout simplement d'une extension de la table de configuration, mais cette fois les valeurs sont obligatoirement des "text" et permettent de stocker des données beaucoup plus larges.
         
       
       
     
     
  
  

Commentaires :

 

Dravick
[ dravick NOatSPAM tuxfamily dot org ]

Je tiens à préciser que la documentation concerne la v0.2 et la v0.3

snakeeater1
[ swc NOSPAM at sp DOT st ]

et à quand la doc sur l'utilisation du cache sous la v0.4 ?

Dravick
[ dravick _at_ tuxfamily _dot_ org ]

Bientôt Mais c'est un peu long à faire

Dravick
[ dravick NOSPAM at tuxfamily DOT org ]

Voila j'ai mis à jour la documentation pour la v0.5 .
À noter que l'ancienne doc pour la v0.2 est toujours accessible ici

Dravick
[ dravick AT tuxfamily DOT org ]

Petit problème technique, on peut pas tout lire, mais ça va revenir

Dravick
[ dravick NOatSPAM tuxfamily dot org ]

Et toc.