developer.jelix.org is not used any more and exists only for history. Post new tickets on the Github account.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.

Changes between Initial Version and Version 1 of fr/conventions


Ignore:
Timestamp:
Oct 24, 2006, 10:16:14 PM (14 years ago)
Author:
laurentj
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • fr/conventions

    v1 v1  
     1= Conventions de codage =
     2
     3== Réglages de l'éditeur ==
     4
     5
     6Voici les règles à respecter lors de l'édition des sources de Jelix et donc ce qu'il faut configurer dans votre éditeur :
     7
     8 * l'encodage utilisé dans les sources est ISO-8859-1 (UTF-8 est prévu mais pas tout de suite).
     9 * pour l'indentation, 4 caractères "espace" sont utilisés (pas de caractère de tabulation)
     10
     11== Créer un nouveau fichier ==
     12
     13Vous devez mettre un cartouche en tête du source php :
     14
     15{{{
     16/**
     17* @package     package
     18* @subpackage  sous-package
     19* @version     $Id$
     20* @author      votre nom
     21* @contributor
     22* @copyright   2006 votre nom
     23* @link        http://www.jelix.org
     24* @licence     GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
     25*/
     26}}}
     27
     28
     29package en général, c'est Jelix. Sous-package, pour Jelix, c'est le nom du répertoire dans lib/jelix/.
     30
     31Vous devez indiquer votre nom sur la ligne @author et le copyright sur la ligne @copyright.
     32
     33La licence pour les fichiers de Jelix doit être la LGPL. Pour jelix-scripts c'est GPL. Pour les modules c'est au choix.
     34
     35== Modifier des sources existantes ==
     36
     37Pour des fichiers que vous modifiez et dont vous n'êtes pas l'auteur, vous devez indiquer votre nom dans le cartouche d'entête du source :
     38
     39 * au niveau de la ligne @contributor
     40 * ajouter une ligne @copyright avec votre copyright.
     41
     42Bien sûr, modifier un fichier existant implique que vous acceptez que vos modifications soient publiées sous la licence indiquée dans le cartouche.
     43
     44----
     45[/wiki Retour au sommaire]