Le Manuel

Bienvenue dans le Cookbook (Livre de cuisine), la documentation CakePHP. Le Cookbook est un système wiki, permettant les contributions publiques. Avec un système ouvert, nous espérons maintenir un haut niveau de qualité, de validité et de précision. Le Cookbook est aussi fait de telle sorte qu’il est facile à tout un chacun de contribuer.

Un *énorme* merci à AD7six qui s’est dévoué corps et âme au Cookbook, en y consacrant d’innombrables heures de développement, de test et d’amélioration.

Comment vous pouvez aider

Si vous notez une erreur, quelque chose qui est incomplet, quelque chose qui n’a pas encore été entièrement couvert ou quelque chose qui n’est tout simplement pas écrit comme vous le souhaiteriez, voici comment vous pouvez aider :

  1. Cliquez sur le lien Editer de la section que vous souhaitez modifier.
  2. Connectez-vous au Cookbook si nécessaire, avec votre compte Bakery. Tout le monde peut obtenir un compte Bakery !
  3. Relisez s’il vous plaît les directives à respecter lors du dépôt de vos propositions au Cookbook, pour vous assurer de leur cohérence.
  4. Soumettez vos ajouts/éditions en utilisant du HTML valide et sémantique.
  5. Suivez la progression de vos soumissions en utilisant les flux rss ou en venant vérifier ici le jour suivant, pour voir si vos modifications sont approuvées.

Traductions

Envoyez un email à l’équipe documentation (docs at cakephp dot org) ou retrouvez-le sur IRC (#cakephp sur freenode) pour discutez de tout effort de traduction auquel vous aimeriez participer.

Note des traducteurs francophones : une section du forum du portail CakePHP-fr.org est dédié à la traduction du CookBook. Il regroupe des informations et des conseils pour participer à cet effort. Avant de vous lancer dans un effort de traduction, nous vous invitons à souscrire à la mailing-list des traducteurs francophones pour vous présenter et poser vos questions !

Astuces pour les traducteurs :

  • Naviguez dans le manuel et éditez-le dans la langue pour laquelle vous voulez traduire le contenu, sinon vous ne verrez pas ce qui a déjà été traduit.
  • N’hésitez pas à vous investir si votre langue existe déjà dans le manuel.
  • Utilisez le menu todo (tout en haut à droite) pour voir quel partie réclame une attention particulière dans votre langue.
  • Utilisez les Formes informelles.
  • Traduisez en même temps le contenu et le titre d’une section.
  • Traduisez également les liens des références croisées pour qu’elles pointent vers des sections traduites (ou à traduire).
  • Modifiez les liens de références croisées pour qu’ils pointent vers les pages traduites.
  • Comparez avec le contenu anglais avant de soumettre une correction (si vous corrigez quelque chose, mais que vous n’intégrez pas une ‘remontée’ de la modification, votre soumission ne sera pas acceptée).
  • N’utilisez pas les entités HTML pour les caractères accentués, le manuel utilise l’UTF-8.
  • Si vous avez besoin d’écrire un terme anglais, entourez-le avec des balises <em>. Par exemple : “abcd abcd Controller abcd...” or “abcd abcd Contrôleur (Controller) abcd...” selon les besoins.
  • Ne soumettez pas de traductions partielles
  • N’éditez pas une rubrique pour laquelle un changement est en cours.
  • Ne changez pas le balisage de manière significative et n’ajoutez pas de nouveaux contenus. S’il manque une info dans la version originale, soumettez d’abord une mise à jour pour celle-ci.

Nous nous sommes engagés à fournir la meilleure documentation existante pour CakePHP. Nous espérons que vous vous joindrez à nous en utilisant le CookBook et en nous faisant vos retours sur ce projet, dont nous avons tous beaucoup bénéficié.