Ancestris - Développement - English

From Arvernes Wiki

HOW TO CONTRIBUTE TO ANCESTRIS

Contents 1 Translation 2 Development : Ancestris developer access 2.1 SVN Access 2.2 IDE - Integrated Development Environment 2.2.1 JDK 2.2.2 Apache Ant 2.2.3 Netbeans 2.2.3.1 Installation 2.2.3.2 Open the project with Netbeans 2.2.3.3 Problems while updating 2.3 Development Mailing List 2.3.1 The mailing list 2.3.2 Mailing List archives 2.4 How to put your development on Arvernes ftp site 2.5 The development web site - Trac 3 Ancestris anonymous access 4 Notes

Translation

The easiest way to help is to translate Ancestris to your own language, Even if we support your language, maybe some bundles are not updated, and/or sentences should be improved.

We have developped a tool named Trancestris to help you to translate the ressources files used by Ancestris. Please take a look to the translation section of our trac system. There you will have all information you need to translate, update, modify the translation we have made.

Development : Ancestris developer access

Don't forget to visit our Ancestris development site.

Please, we need you. Can you help us? This article, page, has to be translated. Thank you for your help To change, or add something you have to login.

Pour pouvoir commencer à participer au développement d'Ancestris, il vous faut le code source du logiciel.

Vous pouvez l'obtenir de deux manières :

• soit vous êtes développeur, alors il vous faut un accès "privilégié" pour pouvoir reprendre le dépôt, mais aussi écrire dans le dépôt.
• soit vous êtes simplement intéressé par le source, sans vouloir participer. Alors il vous suffit de le reprendre en tant qu'utilisateur "anonyme". On vous donnera ci-après les modalités pour le faire.

Ancestris est un logiciel Open Source, donc le core de l'application est disponible sous licence GPL. Plusieurs explications vous sont données sur ce qu'est la licence GPL. Une traduction est également à votre disposition.

SVN Access

Un site vous donne une bonne vision de ce qu'est subversion (SVN)

Un dépôt SVN permet à plusieurs personnes de collaborer à un même projet. Ce qui est intéressant, ce n'est pas l'importance du projet, mais plus l'aspect collaboratif. Un dépôt SVN peut très bien s'imaginer pour des gens qui décident de travailler sur un projet de logiciel, mais aussi un projet de revue, où certains vont faire un article, d'autres un autre, d'autres encore vont travailler à un sommaire, etc.

Pour avoir l'accès SVN en tant que développeur, vous devez :

• mettre un petit mot à Daniel pour qu'il vous donne accès en écriture sur le dépôt. De cette manière vous pourrez bien sûr reprendre le code, mais aussi remonter sur le dépôt vos développements, modifications, etc...
• Ensuite, il faut installer subversion (SVN) sur votre système. Voilà quelques liens :

• Installation de SVN sous Windows.
• Installation sous Linux.

(N'hésitez pas à mettre d'autres liens, ou de meilleurs liens)

Sous Linux, si vous préférez la ligne de commande, et avez installé svn sur votre système, vous pouvez reprendre le code en tapant dans un terminal :

cd
mkdir dev_ancestris
cd dev_ancestris
mkdir trunk
svn co http://arvernes.dyndns.org/fgenj/trunk /home/monrepertoire/dev_ancestris

(bien sûr vous devez changer le mot "monrepertoire" par le bon nom de votre répertoire personnel. Si en plus vous préférez mettre un autre nom que "dev_ancestris", changez en conséquence.)

A priori, vous devriez être en possession de tout le code d'Ancestris, vous allez pouvoir commencer à travailler sur le code.

IDE - Integrated Development Environment

Un IDE (Integrated Development Environment) va vous permettre de développer votre application java dans un environnement convivial et puissant. Nous utiliserons Netbeans comme IDE.

Trois choses sont nécessaires et obligatoires :

• Java. Normalement vous l'avez sûrement, mais il vous faut le JDK java de Sun et pas l'OpenJDK.
• Apache Ant
• Et enfin l'IDE, à savoir Netbeans.

JDK

Avant d'installer Netbeans, il convient de vérifier que vous avez bien java d'installé. Java mais surtout le JDK (Java Development Kit).

Installation manuelle (Windows, Linux...) :

Celui-ci (le JDK) est disponible pour une installation manuelle. Si vous allez sur la page de téléchargement de java, vous pourrez voir qu'il existe une possibilité de télécharger et d'installer, et le jdk, et netbeans. Je vous déconseille cette solution. Certains ont eu des problèmes. J'ai tendance à privilégier, et l'installation de java et l'installation de Netbeans séparemment. Pour télécharger le JDK, allez sur la page du site web vous permettant un tel téléchargement.

En fonction de votre système d'exploitation, Windows, Linux, .... choisissez la version qui vous convient.

Installation par synaptic sous Linux :

Synaptic vous permet de choisir les paquets à installer si vous êtes sous Linux Ubuntu. Lancez Synaptic, et choisissez d'installer :

• sun-java6-jdk
• java-common
• sun-java6-bin
• sun-java6-jre
• rhino
• libxerces2-java
• libjaxp1.3-java
• libaccess-bridge-java
• sun-java6-plugin
• unixodbc

Attention, si vous êtes sous Ubuntu 10.04, pour pouvoir choisir le jdk6.0, il vous faut activer le dépôt "http://archive.canonical.com/ubuntu/ lucid partner" que vous trouvez dans l'onglet "Autres logiciels" du menu "Dépôts" de Synaptic.

J'ai aussi choisi de désinstaller le openjdk qui est installé par défaut. A vous de voir, mais je le conseille vivement.

Vous pouvez aussi faire cela dans un terminal, en tapant :

• sudo apt-get install sun-java6-jdk java-common sun-java6-bin sun-java6-jre
• sudo apt-get install rhino libxerces2-java libjaxp1.3-java libaccess-bridge-java
• sudo apt-get install sun-java6-plugin unixodbc

Apache Ant

Maintenant, il est nécessaire d'installer "Ant" (Apache Ant). Rendez-vous sur le site de Apache Ant, et téléchargez la dernière version disponible. Il est nécessaire pour Netbeans d'avoir une version supérieure à la 1.7.0, donc la 1.8.0 qui est sortie lorsque j'écris ces lignes, et celle qu'il vous faut.

Allez sur la page "Binary distributions", et reprenez le fichier au format que vous préférez.

Netbeans

Installation

Pour que cela fonctionne du premier coup, suivez vraiment les conseils qui vous sont donnés ci-après, car certains ont eu des difficultés en voulant installer les choses de manière différente.

N'oubliez pas, il vous faut le jdk6.0. Ne tentez pas autre chose, ça risque de ne pas marcher.

• Tout d'abord il faut télécharger l'environnement NetBeans à cette adresse: http://netbeans.org/downloads/index.html. Prenez la dernière version (à ce jour c'est la 6.9.1) et en français (c'est le petit menu déroulant "Langue de l'IDE"), afin d'avoir tout ce qu'il faut. Seul le premier package est nécessaire (Java SE soit 66M avec le support du français). Il est même déconseillé, car certains ont connu des problèmes d'installation, de mettre un autre package, genre le plus gros pack (celui dénommé "java"). Celui de 66M, le Java SE, est celui qu'il faut mettre.
• Lancez ensuite l'installation en exécutant le programme juste téléchargé; laissez-vous ensuite guider. Tout ce qu'il faut pour développer pour Ancestris sera alors installé correctement.
• Vous devez avoir les sources d'Ancestris disponibles dans un répertoire de votre disque dur. On appellera le répertoire dans lequel vous avez mis les sources "ancestris".
• lancez NetBeans puis faites Fichier/Ouvrir un projet...
• Sélectionnez dans ancestris/trunk/ les deux projets que sont "GenjFrCore" et "GenjFrExtensions" (ces deux derniers, sont des sous-répertoires de genjf/trunk). Ces deux répertoires doivent être repérés différemment. Dans la partie gauche, vous devriez voir deux projets, Ancestris et GenjFrExtensions.

Open the project with Netbeans

• Si vous voulez reprendre le dernier code du dépôt SVN, pour travailler sur quelque chose qui soit à jour avec les modifications des autres développeurs, mon conseil est de ne rien renseigner dans Netbeans comme "login" et "mot de passe". Faites un petit "commit", vous modifiez une page sans conséquence, de toutes façons, vous pourrez toujours revenir en arrière. Lors de ce "commit", Netbeans va vous demander votre "login" et "mot de passe". Il vous suffira de renseigner ces deux éléments et de demander à Netbeans qu'il sauvegarde ces informations.
  Ensuite pour reprendre le code, vous faites un clic droit sur le projet "GenjFrApp", puis "subversion", puis "mise à jour", et votre code devrait se mettre à jour tout seul.^[1]
• Pour construire le projet:

• Clic droit sur Ancestris, "Nettoyer et construire"
• Clic droit sur GenjFrExtensions, "Tout nettoyer et générer"
• et pour le lancer, "exécuter projet"

• Pour créer l'archive zip: Clic droit sur Ancestris, "Générer la distribution des fichiers ZIP"

Problems while updating

Supposons que vous ayez quelques problèmes pour mettre à jour tous les fichiers source quand vous êtes dans Netbeans.

Il faut vous assurer que les informations pour le projet genjfr sont bien renseignées. Dans Netbeans, regardez dans "Equipe" - "Checkout". Là vous allez vérifiez que vous avez pour :
URL du référentiel : http://arvernes.dyndns.org/fgenj

Utilisateur : le nom d'utilisateur que vous avez donné à François pour accéder au dépôt SVN.
Mot de passe : le mot de passe que vous avez donnée à François pour accéder au dépôt SVN.
(x) Enregistrer le nom d'utilisateur et le mot de passe.
A priori pour proxy, rien de ne devrait être à changer.
Pour l'écran suivant, tout devrait être déjà paramétré comme il faut.

Là vous faites annuler, car si vous faites "Terminer", et que vous avez mis votre dépôt dans un autre endroit, ça va encore tout vous reprendre. Le but de la manoeuvre ci-dessus est de vérifier que l'URL est bonne.

Development Mailing List

The mailing list

Vous connaissez Ancestris, vous voulez participer à son développement en écrivant du code, en modifiant le code du programme.

Il vous suffit pour cela de vous abonner à la liste de discussion dédiée à cela.

• Procédure d'Abonnement :

Il vous suffit pour cela de rejoindre le forum de discussion en envoyant un simple message à l'intention de : "ancestris_dev-subscribe@ml.arvernes.com". Ne mettez rien dans le corps du message, mais dans la ligne du "sujet" mettez uniquement le mot subscribe et c'est tout.

N.B.

(Vous pouvez aussi si vous le souhaitez cliquer sur le nom du destinataire ci-dessous, cela ouvrira automatiquement votre logiciel de courrier et mettra le mot requis dans la ligne "sujet". Vous n'aurez qu'à l'envoyer) : ancestris_dev-subscribe@ml.arvernes.com

• Procédure de Désabonnement :

Pour vous désabonner de la liste, il suffit de faire un message à l'intention de "ancestris_dev-unsubscribe@ml.arvernes.com" et mettre le mot unsubscribe dans la ligne du sujet. Ou alors cliquez sur l'adresse ci-contre : ancestris_dev-unsubscribe@ml.arvernes.com

Et envoyez le message qui va être généré.

• Pour envoyer un message à l'Administrateur de la liste :

Il suffit de faire un message à l'intention de : ancestris_dev-owner@ml.arvernes.com

• Gestionnaire de la liste :

La personne en charge de cette liste est Daniel ANDRÉ.

Mailing List archives

N'oubliez pas que vous pouvez toujours consulter les archives de la liste de discussion ici.^[2]

How to put your development on Arvernes ftp site

Vous avez la possibilité de remonter des fichiers (vos réalisations) sur Arvernes dans un répertoire qui vous est dédié. Cela va permettre aux utilisateurs d'Ancestris de les télécharger, et donc de les utiliser/tester.

Toutes les personnes qui ont accés en ftp sur ce site, utilisent toutes le même login et le même password. Cela veut dire que vous pouvez visualiser, et voir même, modifier le ou les fichiers des autres utilisateurs. Il faut donc respecter le travail que les autres ont fait.

Pour bien distinguer votre travail, il est conseillé de mettre vos fichiers dans un sous-répertoire à votre nom. Si je m'appelle Jean Dupont, je vais créer un sous répertoire qui s'appellera "Dupont_Jean". J'ai tendance à mettre le nom avant le prénom pour des raisons de classement alphabétique. Je vous demande aussi de mettre un "underscore" (le petit tiret qui se trouve sous votre touche 8 de votre clavier : "_") pour relier différents mots de votre répertoire. Bien entendu, dans ce sous-répertoire que vous vous êtes attribué, vous pouvez créer autant de sous sous-répertoires que vous avez besoin.

Voilà comment vous devez insérer un lien sur le wiki pour que le fichier puisse être téléchargé :

[http://www.arvernes.com/V1/pages/compteur_dl.php?/files/ftparvernes/Dupont_Jean/le_nom_de_mon_fichier.zip le_nom_de_mon_fichier.zip]

Faites attention à la casse de vos mots. "Dupont_Jean", n'est pas pareil que "Dupont_jean" ou "dupont_jean", ou "dupont_Jean".

Dernière remarque : ne confiez pas vos login et mot de passe à d'autres personnes. Merci.

The development web site - Trac

Il existe en plus de ce wiki un site du suivi des bugs, demandes, etc... enfin tout ce qui concerne le développement géré par Daniel André sur le site Trac de Arvernes.

En visitant ce dernier site, vous verrez les différentes demandes qui ont été faites, les développements en cours sur certaines d'entre elles. Promenez-vous dans les pages du site, et vous comprendrez trés facilement comment tout cela fonctionne.

Ancestris anonymous access

Comme je le disais, vous pouvez avoir envie de reprendre le code source d'Ancestris, sans avoir l'intention de participer à son développement, tout au moins au début.

Vous pouvez reprendre ce source, par un accès anonyme.

Pour cela, si vous n'utilisez pas Netbeans, il vous faut un client en ligne de commande du genre : tortoisesvn, rapidsvn, ...

La ligne de commande à utiliser est :

svn co http://arvernes.dyndns.org/fgenj/trunk

Le login pour accéder aux sources est : "anonymous" sans les guillemets. Et le mot de passe à utiliser est : "password" sans les guillemets là aussi.

Une branche "GenjFrExtensions" qui sert de dépôt expérimental à destination des développeurs afin de développer et tester leurs composants additionnels n'est ouverte qu'à ces derniers.

Aucun support ou aide ne sera fourni pour cet accès anonyme. Aucune réponse ne sera apportée aux courriers envoyés concernant l'accès anonyme. Notre énergie doit être consacrée à Ancestris et à l'aide pour ceux qui participent au développement.

Notes