diff --git a/CONVENTIONS.md b/CONVENTIONS.md index 5b9da225e..f1892e244 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -2,7 +2,14 @@ en cours de rédaction +## Translations + +Par bundle, toutes les traductions des pages twig se trouvent dans un seul fichier `translations/messages.fr.yaml`. + +## Emplacement des fichiers + +Les controllers, form type & templates twig sont placés à la racine des dossiers `Controller`, `Form` & `Ressources/views`, respectivement. Pour les pages Admin, on ne les mets plus dans des sous-dossiers Admin. ## Assets: nommage des entrypoints Trois types d'entrypoint: @@ -146,19 +153,20 @@ Ces règles n'ont pas toujours été utilisées par le passé. Elles sont souhai Les routes sont nommées de cette manière: -`chill_bundle_entite_action` +`chill_(api|crud)_bundle_(api)_entite_action` 1. d'abord chill_ (pour tous les modules chill) -2. ensuite une string qui est identique, par bundle -3. si le point est un point d'api (json), alors ajouter la string `api` -4. ensuite une string qui indique sur quelle entité porte la route, voire également les sous-entités -5. ensuite une action (`list`, `view`, `edit`, `new`, ...) +2. ensuite `crud` ou `api`, optionnel, automatiquement ajouté si la route est générée par la configuration +3. ensuite une string qui indique le bundle (`main`, `person`, `activity`, ...) +4. ensuite, `api`, si la route est une route d'api. +5. ensuite une string qui indique sur quelle entité porte la route, voire également les sous-entités +6. ensuite une action (`list`, `view`, `edit`, `new`, ...) -Le fait d'indiquer `api` en 3 permet de distinguer les routes d'api qui sont générées par la configuration (qui sont toutes préfixées par `chill_api`, de celles générées manuellement. (Exemple: `chill_api_household__index`, et `chill_person_api_household_members_move`) +Le fait d'indiquer `api` en quatrième position permet de distinguer les routes d'api qui sont générées par la configuration (qui sont toutes préfixées par `chill_api`, de celles générées manuellement. (Exemple: `chill_api_household__index`, et `chill_person_api_household_members_move`) Si les points 4 et 5 sont inexistants, alors ils sont remplacés par d'autres éléments de manière à garantir l'unicité de la route, et sa bonne compréhension. -### URL +### Nommage des URL Les URL respectent également une convention: @@ -219,6 +227,14 @@ Les éléments suivants devraient se trouver dans la liste: Ces éléments peuvent être entrecoupés de l'identifiant d'une entité. Dans ce cas, cet identifiant se place juste après l'entité auquel il se rapporte. +#### Pour les URL de l'espace Admin + +Même conventions que dans les autres pages html de l'application, **mais `admin` est ajouté en deuxième position**. Soit: + + +`/{_locale}/admin/bundle/entity/{id}/action` + + ## Règles UI chill ### Titre des pages