Module de documentation et d’aide
Certaines modules ne nécessitent en réalité aucune action de votre part et fonctionnent simplement en arrière-plan. Cependant, ces modules n’ont probablement pas de paramètres personnalisables ou servent uniquement de dépendances pour d’autres modules.
Le module qui vous intéresse est généralement celui pour lequel vous pouvez configurer des permissions et des paramètres. Certains projets sont faciles à utiliser, c’est-à-dire qu’ils sont « intuitifs », et il vous sera relativement clair ce que vous pouvez configurer et ce que vous devez faire pour accomplir ce que vous voulez.
Si vous souhaitez connaître tous les détails nécessaires pour utiliser intelligemment un module que vous venez d’installer, je peux penser à quelques éléments ou endroits où chercher.
Les suggestions suivantes sont classées par facilité d’utilisation.
Malheureusement, pour les utilisateurs finaux débutants comme nous, Drupal est en constante évolution, et bien que nous ayons la chance de bénéficier de tout le travail considérable des développeurs, leur temps est limité, et je pense qu’on peut dire sans risque que les meilleurs développeurs ne sont pas toujours les plus assidus en matière de documentation destinée aux débutants comme nous ; sinon, vous et moi ne serions pas ici maintenant.
Je vous conseillerais de documenter et de publier vos essais et difficultés lorsque vous apprenez à utiliser Drupal, pour le bien de milliers de personnes qui seront à votre place dans les prochains jours, mois et années.
Je considère cela comme un défi ultime pour la création de cette documentation, malgré (ou à cause de) ce qui semble être des irritations, frustrations et aggravations infinies liées à l’utilisation de cette nouvelle section de documentation Drupal – et, dans une moindre mesure, pour éviter les problèmes d’apprentissage et d’utilisation de Drupal qui pourraient être évités si d’autres débutants, comme vous et moi, avaient précédemment créé des instructions adéquates pour les novices. Mais je suis surtout heureux que vous, mon ami, en tiriez profit.
Vous, comme moi, n’avez pas besoin de connaissances en « développement » ou en programmation pour partager ce que vous « savez » et avez appris.
Par essais et erreurs
Vous pouvez simplement vous lancer et commencer à utiliser un module ou à expérimenter ses réglages.
Lorsque vous ne comprenez pas ce que fait une option ou quelles pourraient être toutes les conséquences possibles de son utilisation, vous pouvez essayer ce que vous jugez préférable.
Chaque fois que vous devez deviner avec un module, vous ne devez pas hésiter à tester toutes les options disponibles, car la sauvegarde de votre site vous permettra toujours de revenir à une version antérieure. Vous sauvegardez bien votre site, n’est-ce pas ?
Comme il peut ne pas être évident immédiatement que tous les effets d’un module ou d’une option sont présents sur votre site, c’est pourquoi je recommande d’installer un module à la fois, et de parcourir chaque recoin de votre site en testant toutes les façons possibles de l’utiliser – créer des pages, tester différentes configurations – avant d’ajouter un autre module contrib.
Sinon, si vous activez plusieurs modules simultanément et rencontrez des problèmes ou des comportements étranges, vous ne saurez pas quel module en est la cause.
Contenu de la page du projet
La page du projet d’un module est sa page d’accueil sur drupal.org. C’est généralement là que je vais en premier lorsque je me demande si je dois tester un module, ou lorsque je rencontre un problème ou une question sur un module récemment activé.
Si vous lisez attentivement la page du projet en entier, vous aurez probablement toutes les informations importantes nécessaires. Par exemple, si un module nécessite d’autres modules pour fonctionner, ceux-ci seront listés quelque part sur la page du projet.
La page du projet peut aussi contenir d’autres liens utiles en relation avec ce module.
Le contenu de chaque page de projet est contrôlé par le créateur initial du projet et éventuellement quelques autres personnes à qui il a donné accès.
D’autres contributeurs de drupal.org, qui n’ont pas accès à la modification de la page du projet, créent souvent d’autres pages drupal.org avec des informations utiles sur le module que vous souhaitez connaître. Malheureusement, ces pages ne sont que rarement liées depuis la page du projet.
La recherche de ces pages non liées sera abordée plus loin dans la section sur la recherche Google limitée à drupal.org ⤵
Fichier README.txt du module
Historiquement, le fichier « README.txt » est l’endroit officiel où sont documentées toutes les informations vraiment importantes et nécessaires pour un module (ou un thème), y compris tout ce qui concerne la mise à jour du module (ou thème) vers une version plus récente.
Le fichier README.txt se trouve dans le dossier racine du module contrib (ou thème) une fois extrait, s’il existe.
Pour consulter le fichier README.txt d’un module (ou thème) sans rien télécharger, allez à :
http://cgit.drupalcode.org/project/PROJECT_MACHINE_NAME.git/blob/HEAD:/README.txt
Remplacez PROJECT_MACHINE_NAME dans l’URL ci-dessus par le « nom machine » du projet.
Le « nom machine » se trouve dans l’URL de la barre d’adresse de votre navigateur lorsque vous êtes sur une page de projet drupal.org, par exemple dans la partie « PROJECT_MACHINE_NAME » de cette URL type :
https://www.drupal.org/project/PROJECT_MACHINE_NAME
Si le fichier README.txt n’existe pas, il s’agit probablement d’un module sans paramètres configurables, fonctionnant en arrière-plan et nécessaire pour d’autres modules contrib.
Si le README.txt est absent ou si vous souhaitez consulter toute autre documentation du projet, utilisez l’URL suivante (en remplaçant « PROJECT_MACHINE_NAME ») :
http://cgit.drupalcode.org/PROJECT_MACHINE_NAME/tree/?id=HEAD
En haut à droite de cette page drupalcode.org, vous devrez peut-être « changer » pour la version du core Drupal que vous souhaitez examiner.
Recherche Google limitée à drupal.org
Pour limiter une recherche au site drupal.org, c’est la méthode que j’utilise fréquemment. Je vais sur google.com et je tape :
site:drupal.org
Notez qu’il n’y a pas d’espace après les deux-points (":") avant le nom de domaine. N’utilisez pas « www. » au début du nom de domaine.
Ajoutez un espace après le domaine et tapez les mots-clés, comme par exemple le nom du module.
Parfois, j’ajoute « Drupal 8 » entre guillemets pour limiter la recherche à Drupal 8 uniquement. Google retournera alors les pages contenant cette expression exacte.
Pour voir toutes les informations disponibles sur un module donné dans le monde entier, y compris en dehors de drupal.org, enlevez la partie « site:drupal.org ».
Pour obtenir 100 résultats Google par page au lieu de 10, lorsque vous êtes sur une page de résultats Google, cliquez sur l’icône « roue dentée » en haut à droite, puis sur « Paramètres de recherche ». Sur la page suivante, sous « Prédictions instantanées Google », sélectionnez « Ne jamais afficher les résultats instantanés ». Ensuite, sous « Résultats par page », glissez le curseur tout à droite. Vos recherches seront désormais légèrement plus longues mais plus complètes.
Opinion personnelle : vous pourriez penser utiliser le moteur de recherche intégré à drupal.org en haut de toutes les pages, mais je l’ai essayé plusieurs fois et je vous conseille d’essayer par vous-même si vous aimez les exercices inutiles.
Boutons/liens « Aide » sur la page « Étendre » de votre site (si disponible)
Sur la page « Étendre » de votre site, à droite du nom de chaque module, vous pouvez voir la première ligne de sa description si la fenêtre de votre navigateur est suffisamment large.
En cliquant sur cette première ligne, la description se déploie, révélant le reste du texte ainsi que les boutons/liens « Aide », « Permissions » et « Configurer » pour ce module, quand ces options sont disponibles.
Si vous ne voyez pas la première ligne de description à droite du nom du module et souhaitez la voir, suivez les instructions sur la page de configuration des modules.
Malheureusement, pour accéder à la page d’aide d’un module sur votre site, vous devez non seulement avoir activé ce module, mais le bouton/lien « Aide » ne sera visible que si le module est activé. De plus, tous les modules contrib ou core ne disposent pas d’un lien « Aide », vous ne saurez donc pas s’il est disponible tant que vous n’aurez pas activé le module.
Pour ces raisons, je ne me suis jamais fié ni utilisé les boutons « Aide », bien qu’en y regardant maintenant, ils mènent souvent à des pages contenant des informations utiles.