Dokumentations- und Hilfemodul

Manche Module erfordern tatsächlich nicht, dass Sie etwas tun, und sie machen einfach ihre Arbeit im Hintergrund. Diese Module haben wahrscheinlich keine konfigurierbaren Einstellungen oder dienen nur als Abhängigkeiten für andere Module.

Am häufigsten ist das Modul, das Sie interessiert, eines, für das Sie Berechtigungen und Einstellungen anpassen können. Einige Projekte sind einfach zu bedienen, das heißt, ihre Nutzung ist „intuitiv“, und es wird Ihnen relativ klar sein, was Sie einstellen können und was Sie tun müssen, um das zu erreichen, was Sie wollen.

Wenn Sie alle Details erfahren möchten, die Sie benötigen, um ein gerade installiertes Modul intelligent zu nutzen, kann ich Ihnen einige Dinge oder Orte nennen, an denen Sie nachsehen können.

Die folgenden Vorschläge sind nach Einfachheit der Nutzung geordnet.

Leider für Anfänger-Endanwender wie uns befindet sich Drupal in ständiger Entwicklung, und obwohl wir das Glück haben, von der enormen Arbeit der Entwickler frei profitieren zu können, ist deren Zeit begrenzt. Ich denke, man kann mit Sicherheit sagen, dass die besten Entwickler nicht unbedingt die fleißigsten Dokumentationsschreiber für Einsteiger sind, wie wir es sind – sonst wären Sie und ich jetzt nicht hier.

Ich würde Ihnen empfehlen, Ihre eigenen Erfahrungen und Schwierigkeiten beim Lernen von Drupal zu dokumentieren und zu veröffentlichen, zum Wohle der Tausenden, die in den kommenden Tagen, Monaten und Jahren an Ihrer Stelle sein werden.

Ich betrachte dies als die große Herausforderung beim Erstellen dieser Dokumentation, trotz (oder gerade wegen) der scheinbar endlosen Ärgernisse, Frustrationen und Herausforderungen bei der Nutzung eines neuen Dokumentationsbereichs in Drupal – und in geringerem Maße, um die Lern- und Nutzungsprobleme von Drupal zu mindern, die behoben werden könnten, wenn andere Anfänger wie Sie und ich früher angemessene Einsteigeranleitungen erstellt hätten. Besonders freue ich mich aber, dass Sie, mein Freund, davon profitieren werden.

Sie müssen – ebenso wie ich – nichts über „Entwicklung“ oder Programmierung wissen, um das, was Sie „wissen“ und gelernt haben, zu teilen.

Trial and Error (Versuch und Irrtum)

Sie können einfach loslegen und das Modul benutzen oder mit seinen Einstellungen experimentieren.

Wenn Sie nach Ihrer Recherche nicht herausfinden können, was eine Option bewirkt oder welche möglichen Auswirkungen ihre Nutzung hat, können Sie einfach alles ausprobieren, was Ihre abenteuerlustige Seele für am besten hält.

Wann immer Sie an einen Punkt kommen, an dem das Modul von Ihnen Vermutungen verlangt, müssen Sie sich wirklich keine Sorgen machen, alle verfügbaren Optionen auszuprobieren, denn ein Backup Ihrer Seite hilft Ihnen immer, zur vorherigen Version zurückzukehren. Sie machen doch Backups Ihrer Seite, oder?

Da es für Sie nicht sofort offensichtlich sein kann, dass alle Auswirkungen, die ein Modul oder eine bestimmte Option dieses Moduls auf Ihrer Seite hat, tatsächlich präsent sind, empfehle ich Ihnen aus diesem Grund, jeweils nur ein Modul zu testen. Außerdem sollten Sie jede Ecke Ihrer Seite erkunden und versuchen, Ihre Seite auf alle möglichen Arten zu nutzen – neue Seiten erstellen, verschiedene Konfigurationen ausprobieren – bevor Sie ein weiteres Contrib-Modul hinzufügen.

Andernfalls, wenn Sie mehr als ein neues Modul aktivieren und dann auf Probleme oder seltsame Situationen stoßen, wissen Sie nicht, welches der neuen Module die Ursache für die Probleme ist.

Inhalt der Projektseite

Jede Projektseite eines Moduls ist seine Startseite auf drupal.org. Normalerweise besuche ich die Projektseite zuerst, wenn ich überlege, ob ich ein Modul ausprobieren soll, oder wenn ich auf Probleme stoße oder Fragen zu einem gerade aktivierten Modul habe.

Wenn Sie die Projektseite sorgfältig vollständig lesen, können Sie relativ sicher sein, dass Sie alle wichtigen Informationen haben, die Sie benötigen. Zum Beispiel, wenn Sie prüfen, ob ein Modul ausprobiert werden soll, werden auf der Projektseite alle anderen Module aufgeführt, die für den Betrieb dieses Moduls erforderlich sind.

Die Projektseite kann auch weitere nützliche Links enthalten, die für viele Aspekte dieses Moduls interessant sind.

Der Inhalt der Projektseite kann für neue Drupal-Nutzer gedacht sein oder sich an fortgeschrittene Benutzer / Entwickler richten.

Link zur Projektseite „Dokumentation lesen“ (wenn vorhanden)

In der rechten Spalte (die bei Mobilgeräten oder schmalen Browserfenstern bis zum Seitenende nach unten fällt) finden Sie immer die Überschrift „Ressourcen“, unter der Sie möglicherweise den Link „Dokumentation lesen“ finden oder auch nicht.

Allerdings haben nicht alle Projektseiten den Link „Dokumentation lesen“. In diesem Fall hoffen wir, dass Sie nützliche Dokumentationslinks im Hauptinhalt der Projektseite finden.

Wenn es den Link „Dokumentation lesen“ gibt, ist dies das, was die Entwickler als die geeignetste Ressource ansehen, um mit der Suche nach weiteren Informationen zu beginnen.

Der Inhalt jeder Projektseite wird vom ursprünglichen Ersteller des Projekts und möglicherweise einigen anderen Personen, denen der Ersteller die Erlaubnis erteilt hat, bestimmt und verwaltet.

Andere drupal.org-Mitglieder ohne Bearbeitungsrechte für die Projektseite erstellen jedoch häufig weitere Seiten auf drupal.org mit wertvollen Informationen zu dem Modul, über das Sie mehr erfahren möchten. Leider werden diese Seiten selten auf der Projektseite verlinkt.

Wie Sie Seiten finden, die auf der Projektseite nicht verlinkt sind, wird weiter unten im Abschnitt zur Suche Google, begrenzt auf drupal.org ⤵ erläutert.

Modul-„README.txt“-Datei

Die Datei „README.txt“ war historisch gesehen der offizielle Ort, an dem alle wirklich wichtigen und notwendigen Informationen zu einem Modul (oder Theme) dokumentiert wurden, einschließlich aller Hinweise zur Aktualisierung des Moduls (oder Themes) auf eine neuere Version.

Die README.txt-Datei befindet sich im obersten Verzeichnis des Contrib-Moduls (oder Themes), nachdem es entpackt wurde, falls sie existiert.

Um die README.txt-Datei eines Moduls (oder Themes) anzusehen, ohne etwas herunterzuladen, besuchen Sie den Link:

http://cgit.drupalcode.org/project/PROJECT_MACHINE_NAME.git/blob/HEAD:/README.txt

Ersetzen Sie im obigen URL-Ausdruck PROJECT_MACHINE_NAME durch den kurzen „Maschinennamen“ des jeweiligen Projekts.

Der „Maschinenname“ befindet sich in der URL-Zeile Ihres Browsers, wenn Sie auf einer beliebigen Projektseite von drupal.org sind, z. B. als Teil „PROJECT_MACHINE_NAME“ in diesem Beispiel einer URL – eine URL, ähnlich der für jedes Projekt:

https://www.drupal.org/project/PROJECT_MACHINE_NAME

Wenn die README.txt-Datei nicht existiert, handelt es sich wahrscheinlich um ein Modul ohne konfigurierbare Einstellungen, das einfach im Hintergrund läuft und von anderen Contrib-Modulen benötigt wird.

Wenn keine README.txt-Datei vorhanden ist oder Sie einfach die gesamte andere Dokumentation für das Projekt einsehen möchten, verwenden Sie die folgende URL (ersetzen Sie „PROJECT_MACHINE_NAME“):

http://cgit.drupalcode.org/PROJECT_MACHINE_NAME/tree/?id=HEAD

Oben rechts auf dieser Seite „drupalcode.org“ müssen Sie möglicherweise auf die Drupal-Kernversion umschalten, die Sie untersuchen möchten.

Google-Suche, eingeschränkt auf drupal.org

Wenn Sie eine Suche auf der gesamten Website drupal.org einschränken möchten, ist dies das Vorgehen, das ich häufig nutze. Ich verwende diese Methode regelmäßig, um drupal.org oder jede andere Domain meiner Wahl zu durchsuchen.

Ich gehe auf google.com ⎘ und gebe ein:

site:drupal.org

Beachten Sie, dass nach dem Doppelpunkt („:“) kein Leerzeichen vor dem Domainnamen steht. Verwenden Sie auch kein „www.“ am Anfang eines Domainnamens.

Fügen Sie nach dem Domainnamen ein Leerzeichen hinzu und geben Sie die Schlüsselwörter ein, die Ihnen einfallen, zum Beispiel für unser heutiges Thema den Modulnamen.

Manchmal finde ich es auch hilfreich, die Google-Suche auf „Drupal 8“ einzuschränken (anstatt Ergebnisse für D6, D7 usw. zu erhalten), indem ich „Drupal 8“ in das Suchfeld eingebe. Wenn Sie doppelte Anführungszeichen verwenden, liefert Google Ergebnisse für Seiten, die genau den Ausdruck aus zwei oder mehr Wörtern in Anführungszeichen enthalten (hauptsächlich).

Um Informationen für ein bestimmtes Modul weltweit zu finden, einschließlich Seiten auf und außerhalb von drupal.org, lassen Sie „site:drupal.org“ weg.

Um 100 Google-Suchergebnisse pro Seite statt 10 zu erhalten, klicken Sie auf jeder Google-Ergebnisseite oben rechts auf das „Zahnradsymbol“ und wählen Sie im Dropdown-Menü „Sucheinstellungen“. Auf der nächsten Seite unter „Google Instant Predictions“ schalten Sie „Nie sofortige Ergebnisse anzeigen“ ein. Ziehen Sie dann unter „Ergebnisse pro Seite“ den Regler ganz nach rechts. Ihre Suche wird nun nur wenige Millisekunden länger dauern.

Eine persönliche Meinung: Sie könnten daran denken, die Suchfunktion von drupal.org zu verwenden, die oben auf allen drupal.org-Seiten angeboten wird. Ich habe das ein paar Mal ausprobiert und rate Ihnen, es selbst zu testen, wenn Sie Lust auf frustrierende Übungen haben.

„Hilfe“-Buttons/-Links auf der „Erweitern“-Seite Ihrer Website (falls vorhanden)

Auf der „Erweitern“-Seite Ihrer Website sehen Sie rechts vom Namen jedes Moduls die erste Zeile seiner Beschreibung, wenn Ihr Browserfenster breit genug ist.

Wenn Sie auf diese erste Zeile der Beschreibung klicken, klappt sie nach unten auf und zeigt den restlichen Teil der Beschreibung sowie „Hilfe“-, „Berechtigungen“- und „Konfigurieren“-Buttons/-Links für dieses Modul an, sofern diese verfügbar sind.

Wenn Sie die erste Zeile der Modulbeschreibung rechts vom Modulnamen nicht sofort sehen und sie sehen möchten, befolgen Sie die Anweisungen auf der Konfigurationsseite des Moduls.

Leider ist der „Hilfe“-Button/-Link für ein Modul nur sichtbar, wenn das Modul auf Ihrer Seite aktiviert ist. Und leider haben nicht alle Contrib- oder Core-Module eine „Hilfe“-Schaltfläche/-Link, so dass Sie nicht wissen können, ob eine verfügbar ist, bevor Sie das Modul aktivieren.

Aus diesen problematischen Gründen habe ich mich nie auf die „Hilfe“-Buttons verlassen oder sie benutzt, obwohl ich jetzt sehe, dass sie oft auf Seiten mit nützlichen Informationen führen.