Infiormations sur le Mod
L'entête du fichier texte contient les informations importantes sur le Mod comme son titre, sa version, son auteur, ou encore une description de ce à quoi il sert.
Titre
Le titre est le nom donné à un Mod. En général, il est assez court et explicite
Exemple :
## MOD Title: Scission de note récurrente
Version
La version permet à un utilisateur de se repérer lorsque qu'il y a des mises à jour sur le Mod
Le format est du type X.Y.Z, avec :
La version peut être suivie de RC pour indiquer que le Mod est en version de test (Release Candidate)
Exemple :
## MOD Version: 1.2.0
Auteur
L'auteur et la personne qui à écrit le Mod. Plusieurs auteurs peuvent être définis en les séparant par des virgules. Pour des raisons de simplicité, le nom de l'auteur correspond à son pseudo sur le forum de Phenix, mais peut également contenir son nom complet et son email.
Exemple :
## MOD Author: MaxWho17
Idée
L'idée est un paramètre facultatif qui permet d'indiquer le nom de la personne à l'origine du Mod. Les mêmes règles que pour l'auteur s'y appliquent.
Exemple :
## MOD Idee: feyhung
Description
La description peut être plus ou moins longue, mais il est préférable qu'elle ne dépasse pas quelques lignes. Ici sont décrites les fonctionnalités apportées par le Mod. Chaque nouvelle ligne doit commencer par ##, et une ligne sans autre caractère indique que le descriptif est terminé.
Exemple :
## MOD Description:
##
## Ce mod permet de scinder une note récurrente en deux notes indépendantes.
## Les occurrences situées avant la note de scission seront rattachées à la
## note principale, celles situées après seront rattachées à la note qui
## deviendra une note mère.
##
Version requise
La version requise précise la version de Phenix pour laquelle le Mod a été écrit et testé. Plusieurs peuvent être indiquées séparées par des virgules lorsque le Mod fonctionne sans modifications sur diverses versions de Phenix.
Exemple :
## PX Version Required: 5.0, 5.0a, 5.1
Niveau d'installation
Le niveau d'installation est le niveau de difficulté que l'utilisateur peut rencontrer lors d'une installation manuelle, ressenti par l'auteur.
Trois niveaux sont possibles :
Exemple :
## Installation Level: Easy
Temps d'installation
Le temps d'installation est le temps estimé par l'auteur pour une installation manuelle. Il dépend de la difficulté d'installation ainsi que du nombre de fichiers à éditer, et du nombre d'instructions à exécuter.
Exemple :
## Installation Time: 10 Minutes
Fichiers à éditer
La liste des fichiers à éditer est centralisée ici afin de permettre à l'utilisateur de sauvegarder uniquement les fichiers touchés par le Mod.
Exemple :
## Files To Edit:
## agenda.php
## agenda_hebdomadaire.php
## agenda_mensuel.php
## agenda_quotidien.php
## agenda_traitement.php
## lang/fr.php
## lang/en.php
Fichiers inclus
Ici se trouve la liste des fichiers inclus, lorsque le format de diffusion du Mod est un zip, et qui devront être copiés conformément aux instructions du Mod.
Exemple :
## Included Files:
## scinder.gif
## fr_mod-scission.php
## en_mod-scission.php
Historique
L'historique du Mod contient les dates de publications des différentes versions ainsi qu'une description des corrections et amélioration apportées. Chaque publication doit faire apparaître la date au format YYYY-MM-DD, suivi de numéro de version.
YYYY étant l'année sur 4 chiffres, MM le mois sur 2 chiffres comprenant le zéro, et DD le jour sur 2 chiffres. Chaque information devant commencer sur une nouvelle ligne par un trait d'union.
Exemple :
## MOD History:
##
## 2007-11-11 - Version 1.2.0
## - internationalisation du mod
## - modification de lficône de scission
##
## 2007-09-05 - Version 1.1.0
## - modification de compatibilité avec le mod "Appropriation d'une note V2"
##
## 2007-09-02 - Version 1.0.0
## - version initiale
Copyright © 2008 - Stéphane Teil
This help file has been generated by the freeware version of HelpNDoc