:: Codulle - Lisez moi
:: Version 0.1.1
:: Auteur : SamRay1024
:: http://jebulle.net - http://forums.jebulle.net
:: webmaster@jebulle.net

// Encodage du fichier : UTF-8
// Fin de ligne : CR + LF
// Tabulation comme des espaces : Non
// Taille des tabulations : 4 caractères


SOMMAIRE
--------

	* REMERCIEMENTS
	* INTRODUCTION
	* AVERTISSEMENT
	* INSTALLATION / UTILISATION
	* PARAMETRAGE DU PROGRAMME
	* CHANGER LE STYLE DE LA PAGE
	* PROBLEMES CONNUS
	* AUTRES QUESTIONS


REMERCIEMENTS
-------------

	Nigel McNie pour sa classe GeSHI, sans laquelle la coloration syntaxique
de Codulle ne serait pas possible ;) (à moins d'un looong travail pour arriver
au même résultat !) (http://qbnz.com/highlighter/).


INTRODUCTION
------------

	Codulle est tout simplement un explorateur de codes sources. Il permet
la navigation parmi des projets de développement que vous aurez organisés
dans la base des projets. Vous pouvez tout aussi bien publier de simple fichiers
qui ne font pas forcément partie d'un projet ;-).

	J'ai créé Codulle dans le but de mettre en ligne mes propres codes sources
de mes projets Web principalement afin de pouvoir en disposer à tout moment sans
avoir mes fichiers avec moi (oui je sais, cela suppose que j'ai un accès
Internet ;-) ).

	Finalement, je me suis dis qu'il pourrait être intéressant de rendre ce
script disponible à la communauté PHP, pensant que d'autres que moi pourraient
être intéressés par une telle application.

	Codulle supporte tous les fichiers éditables (entendez par là, tout ce qui
n'est pas un fichier binaire ou compilé). Pour connaître la liste des fichiers
supportés, reportez-vous à la liste donnée sur la page officielle de GeSHI :
http://qbnz.com/highlighter/ (Il y en a tellement que je n'ai pas envie de les
remettre tous ici !).


AVERTISSEMENT
-------------

	Tous les fichiers php que vous trouverez dans ce projet sont encodés au
format UTF-8. Ainsi, VOUS NE DEVEZ EN AUCUN CAS LES EDITER AUTREMENT QU'EN
UTF-8 ! Si par mégarde vous en ouvrez un, ne l'enregistrez pas tant que votre
logiciel n'a pas été configuré pour enregistrer ses fichiers dans ce format ;
vous risquer d'endommager les fichiers et d'avoir alors des erreurs lors de
leur exécution.

	DE PLUS, en raison de disparités dans le format UTF-8, tous les éditeurs
ne sont pas recommandés pour effectuer cette tâche (le format UTF-8 est décliné
en deux versions, dont l'une ne convient pas aux serveurs PHP et peut provoquer
des erreurs). Les éditeurs que je vous recommande sont les suivants :

	- Unired : http://unired.sourceforge.net/, pour Windows uniquement.
	- Jext : http://jext.sourceforge.net/, multi plates-formes (écrit en Java).
	- Scite : http://www.scintilla.org/, linux et Windows (mon préféré ;-)).
		Attention : avec Scite, deux formats d'encodage UTF-8 sont disponibles !
			L'UTF-8 et l'UTF-8 Cookie. C'est ce dernier que vous devrez
			utiliser pour éditer correctement les fichiers, car l'autre
			ajoute un caractère non visible en tout début de fichier.
	- Vim : http://www.vim.org/, multi plates-formes.
	- Emacs : http://www.gnu.org/software/emacs/, multi plates-formes.
	
	(Pour les plus curieux d'entres vous, voici une explication beaucoup plus
complète que ces quelques lignes que je viens d'écrire : 
http://openweb.eu.org/articles/jeux_caracteres/ )


INSTALLATION / UTILISATION
--------------------------

	Rien de plus simple ! Dans le dossier extrait vous avez du trouver un dossier
nommé 'codulle'. Vous devez envoyer son contenu sur votre serveur Web par
l'intermédiaire de votre client FTP préféré.

	Pour le paramétrer, éditez le fichier includes/config.php. Tout y est expliqué.
	
	Ensuite, vous pouvez ajouter vos projets et fichiers sources directement dans le
dossier projets/. C'est tout !


PARAMETRAGE DU PROGRAMME
------------------------

	Vous pouvez parametrer le script pour l'adapter à vos besoins. Pour
cela, vous devrez éditer le fichier "config.php" qui sz trouve dans le dossier
"includes/".

	Ce fichier contient toutes les explications nécessaires pour le paramètrage
de Codulle prenez le temps de lire les commentaires pour ne pas faire de fausse
manipulation.


CHANGER LE STYLE DE LA PAGE
---------------------------

	Pour créer un nouveau thème pour Codulle, je ne saurais que vous conseiller
de prendre le thème par défaut, livré avec Codulle, d'en faire une copie au nom de
votre nouveau thème et de partir de lui.

	Toute la structure HTML de Codulle est contenu dans le fichier html.php.
Ce fichier contient du code php qu'il est obligatoire de conserver ! Vous devez
respecter la structure PHP et articuler votre structure HTML autour.

	La structure HTML de Codulle est accompagnée de deux autres fichiers CSS : structure.css
qui contient toutes les informations de placement et d'organisation de la page HTML et
style.css qui permet de définir le style graphique de la page (couleurs, bordures, images,
...). Pour modifier l'organisation des blocs dans la page éditez donc structure.css et pour
changer les couleurs éditez style.css.

	Pour faire un nouveau thème, il est nécessaire que vous ayez quelques bases sur
la programmation HTML et CSS.


PROBLEMES CONNUS
----------------

	Le thème par défaut n'est pas compatible avec le navigateur IE. Par manque de
temps et d'envie, je ne le rendrais pas compatible. C'est audacieux, je sais,
voire risqué (certain d'entre-vous n'apprécieront sûrement pas ce choix, d'autres
souriront à la lecture de ce paragraphe) mais je tiens à exprimer mon ras-le-bol
quant à IE. Il est vieux et truffé de bogues. Le développement sous IE est un
calvaire (il n'y a qu'a voir ce que donne Codulle sous IE...) et j'en ai plus
que marre de devoir doubler mon temps de mise en page HTML / CSS à cause de lui.

	Si vous avez le courage de prendre le thème par défaut et de le rendre
compatible IE, je le mettrais avec grand plaisir dans l'archive de Codulle.

	Toujours est-il que j'encourage un maximum de personnes à utiliser un
navigateur qui respecte un tant soit peu les normes (FireFox, Opera, Flock, ...,
Safari pour les MAC users). Et puis IE7 est pour bientôt normalement...


AUTRES QUESTIONS
----------------

	Si vous avez des problèmes, des questions, des suggestions, des critiques ou
tout autre chose, un forum est à votre disposition à l'adresse suivante :

	http://forums.jebulle.net,
	Rubrique "Scripts, classes et ressources PHP".
