Faire un zip pour poster votre code source sur delphifr...

Cette FAQ viens en complément du tutoriel fait par Tanguy ALTERT alias GrandVizir (que je n'avais malheureusement pas vu, à mon grand étonnement d'ailleurs).

Il se peu que je répète des choses identique dans cette FAQ. Je vous conseil donc, de lire le tuto de Tanguy qui explique beaucoup de choses sur le sujet, à cette adresse :

Optimisez le contenus de vos Zips

INTRODUCTION

Qu'est ce qu'un Zip ?

Un "Zip" est une archive compressée contenant un ou plusieurs fichiers. Cette archive permet de rassembler au sein d'un même fichier plusieurs autres tout en diminuant leurs taille, ce qui facilite la diffusions de ces derniers, surtout sur un support tel qu'Internet.

Il existe de nombreux formats d'archive avec des méthodes de compression plus ou moins efficace tel que RAR, 7Zip, ACE, TAR, GZ (GZip), pour ne citer que les plus communs.

Avec quel logiciel je peu faire un Zip ?

Beaucoup de logiciel de compression supporte ce format. Windows XP possède même ce format en "natif" sous le nom de "Dossier compressé" mais son efficacité reste plus que douteuse et cette fonctionnalité semble être inexistante sous certaines versions de Windows XP (pro / Corp.).
Il existe de nombreux logiciel gratuit permettant de faire des archives Zip, je passerais le passage des compresseurs en ligne de commande (Shell Dos) qui sont fastidieux à utiliser.

WinRar, WinZip, WinAce etc. Tous supportent ce format, mais malheureusement ils sont payant...
Dans les logiciels gratuits je demande "7-Zip"! Il supporte non seulement le Zip mais également de nombreux autres formats.
Nous travaillerons donc avec 7-Zip.

Ou télécharger 7-Zip ?

Tout simplement a cette adresse : www.7-zip.org
Je passe outre l'explication de comment l'installer etc. Vous trouverez tout ce qu'il faut sur le site de l'auteur, et je pars du principe que vous savez le faire.

J'aime pas l'anglais, y'a t'il un logiciel gratuit en français ?

Je comprends votre requête... tout simplement 7-Zip ... le site est en anglais mais le logiciel est disponible en Français.

PRES ? PARTEZ!

Quels fichiers puis-je diffuser ?

Tout simplement les fichiers .PAS, .DPR, .DFM, .RES, .DLL (dans le cas de librairies dont le code source n'est pas disponible et uniquement dans ce cas précis) et d'autres fichiers utile au programme, par exemple les images, les sons, les fichiers d'aide et j'en passe.

Si vous utilisez des composants non-standards dans votre programme, n'oubliez pas de les diffuser ou d'indiquer leurs liens de téléchargements.
Pensez aussi à citer dans votre source principale le nom des divers auteurs ou groupes dont les codes ou composants sont issus, ceci est la base même de l'Open Source : la reconnaissance et les remerciements!

Si il existe plusieurs version de vos sources (Delphi 6, 7, 2005 etc.) séparez les dans des dossiers respectif pour plus de clarté.

Une dernière chose, comme nous le rappel si bien DelphiProg, essayez de normaliser le nom de vos fichiers Zip et de vos fichiers source.
Evitez les accents et autre caractères spéciaux comme le caractère d'espacement par exemple, évitez également de les mettre purement en majuscules, évitez les fantaisies, les noms à rallonge etc.
N'oubliez pas non plus de créer une structure répertoire à votre programme pour éviter d'avoir trop de fichiers à sa racine. Mettez les images dans un répertoire "images" ou "gfxs", les sons dans "sons" ou "sounds" et les autres dans un répertoire "ressources" ou "res" par exemple...

Voici quelques exemples de ce qu'il faut faire (attention certaines version de Delphi ne supporte pas les tirets et underscores(_) dans les noms des fichiers Dpr et Pas... veillez donc à les ecrire sans espaces du tout) :

"ma-source.zip" "ma_source.zip" "monprograme.dpr" "monunite.pas" "madll.dll" "mon_image_01.jpg"

Et enfin ce qu'il ne faut pas faire :

"ma source qu'elle est bien.zip" "MON PROGRAME.DPR" "mon unité @ my self.pas" "x°0oO m4 d11 kI tu3! Oo0°x.dll"

Quels fichiers ne puis-je point diffuser ?

Très bonne question et de loin la plus importante... mais grosso modo, tout ceux cités ci-dessous en priorité :

Les fichiers .EXE: DelphiFr recommande de ne pas mettre l'exécutable de votre projet (prend de la place pour rien) mais vous pouvez inclure des exécutables utile au programme a condition que ceux-ci ne soit pas trop gros, au besoin, compressez les et incluez un fichier "lisezmoi" pour donner des instructions a ceux qui téléchargeront votre source...

Le fichier .DOF : ce fichier correspond a la disposition de votre interface Delphi ... ne le diffusez pas car il modifie la disposition de l'interface de celui qui ouvriras votre projet, ce qui est souvent ennuyeux voir énervant... (Je ne vise personne en particulier ^^)

Le fichier .CFG: ce fichier correspond à la configuration de votre compilateur. Inutile dans la plupart des cas car les directives "forcées" devraient logiquement être présente dans la source (pas) du programme. Donc ...ne pas le diffuser non plus.

Le fichier .DDP: ce fichier contient le diagramme de votre programme. Si vous n'en avez pas créés un pour votre application, ne diffusez pas ce fichier.

Les fichiers .DCU : ces fichiers sont le résultat de la compilation des unités du programme, ils seront recréés a la compilation donc inutile.

Les fichiers .~PAS .~DFM .~DPR .~DDP etc : ces fichiers sont des anciennes versions des fichiers (backup). Ils sont donc totalement inutiles.

Vous pouvez également télécharger et utiliser ce programme de ma conception pour nettoyer tout vos projets avant le les zipper :
Delphi Project Cleanner (DPC)

Et voila, vous pouvez maintenant envoyer votre Zip sur le site ...
N'oubliez pas, la qualité ne dépend pas que de la propreté de votre code... Il est également appréciable d'avoir de belles archives avec de bon programmes et cela démontre aussi a quel point vous êtes sérieux et minutieux.
Il serait dommage d'entacher une bonne réputation avec de mauvaises archives.

D'AUTRES QUESTIONS ?

J'ai mon Zip ... comment l'envoyer maintenant ?

Tout simplement lors de la création/modification de votre code source sur DelphiFr ... en bas de la page, il y a une zone prévue à cet effet. L'archive serra automatiquement envoyée lorsque vous appuierez sur le bouton "soumettre la source".

Dois-je tout remettre dans l'archive ou seulement les fichiers mis a jours ?

> Comment mettre a jours mon archive sur DelphiFR ?

Vous devez tout remettre dans votre archive. En effet, l'archive serra remplacée par la nouvelle. Donc veillez à bien rediffuser l'entièreté de votre programme. (Voir également la FAQ-01)

J'ai mis des exécutables important dans l'archive mais ils ont-été supprimés !

Zippez les dans l'archive elle même. Vous éviterez leur suppression. Vous pouvez indiquer dans le nom du zip ".exe.zip" pour préciser aux autres qu'il s'agit d'une archive contenant un ou plusieurs fichiers exécutable. (Lire le chapitre F du tuto)

Peut-on attraper des virus via les archives récupérées sur DelphiFr ?

Dois-je scanner avec un anti-virus mes archives avant de les envoyées ?

Prudence est mère de sureté ...
Scannez par habitude tout les fichiers que vous récupérez ou envoyez sur le net, qu'elle que soit leur provenance ou leur destination.
Ne précisez pas dans votre zip qu'il a été scanner et est garantis sans virus connus, aucun anti-virus n'est fiable a 100% et ce serrait d'ailleurs le meilleurs moyen d'attirer le doute de la part des utilisateurs (on se méfit plus facilement des choses qui tentent de se justifier trop rapidement).

J'ai bien suivis à la lettre tout le tuto mais pourtant je me retrouve avec une archives 7z !?

Merci de lire l'aide de 7-Zip ou autre logiciel de compression que vous pourriez utiliser.
(Voir également la réponse FAQ - 06).

Peut on envoyer d'autres formats d'archives différent du Zip sur DelphiFr ?

J'ai un problème avec mon archive Zip, elle ne doit pas être au bon format ?

J'ai le choix entre plusieurs formats Zip, lequel dois-je choisir ?

Votre archive doit être dans le format Zip standard (Zip deflate), vous pouvez néanmoins paramétrer la compression a son taux maximum, ce qui accéléreras son envois.
Dans le doute, laissez les paramètres par défaut dans votre compresseur ou rétablissez ces paramètres à leurs valeurs initiales.

Malgré tout, mon archive fait plusieurs méga-octet !

Ou puis-je trouver un hébergeur pour mon gros fichier source ?

Optimisez vos sources, diffusez simplement les fichiers utiles, utilisez des formats de fichiers a compressions tel que le mp3, jpeg, png, ogg vorbis etc. Les formats wav et bmp étant les plus lourds qu'il soit.

Hébergez les gros fichiers sur votre site perso par exemple, pour alléger le Zip et en précisant les liens de téléchargement des éléments additionnels. (Voir les chapitres E et F du tuto)

Vous pouvez également compresser vos exécutables avec des outils spécialisés comme UPX ou PKLite, le gain sera d'environ de 30 a 50%de la taille de l'exécutable.

Si votre projet deviens réellement conséquent, aboutis et vraiment utile, préférez l'hébergement externe a DelphiFR.
De nombreux sites gratuits proposent ce service, tel l'excellentissime SourceForge.net, qui met à votre disposition tout ce qu'il faut pour vos projets Freeware et Open Source et possède de nombreux site Miroir partout dans le monde.
Bref la solution parfaite pour tout projet a faible moyens.

Ce document intitulé « Faire un zip pour poster votre code source sur delphifr... » issu de CodeS SourceS (codes-sources.commentcamarche.net) est mis à disposition sous les termes de la licence Creative Commons. Vous pouvez copier, modifier des copies de cette page, dans les conditions fixées par la licence, tant que cette note apparaît clairement.
Rejoignez-nous