MoodleDocs:StyleGuide

Kategorien

Eine Kategorie ist eine Übersichtsseite von Dokumentationsseiten. D.h. Seiten, die zu einem bestimmen Thema zusammengefasst werden, finden sich in einer Kategorie wieder.

• Eine Seite kann zu einer Kategorie hinzugefügt werden, in dem Sie die entsprechende Kategorie in die Seite einfügen. Dies geschieht durch folgenden Wiki-Syntax: [[Category:Kategorie-name]], zum Beispiel [[Category:Trainer]], am Ende der Seite. Sie können mehrere unterschiedliche Kategorien zu einer Seite hinzufügen, wenn Sie die Seite in unterschiedliche Kategorien aufnehmen möchten. Aber Sie können nicht unterschiedliche Kategorien in den Tag aufnehmen. Beispiel:

[[Category:Trainer]]
[[Category:Teilnehmer]] 

• Um sicherzustellen, dass die Seiten in alphabetischer Reihenfolge bei Aufruf der Kategorie-Übersicht aufgelistet werden, sollte der Seitenname in den Kategorie-Link mit aufgenommen werden. Z.B.: [[Category:Entwickler|Neuer Seiten Name]].
• Der Link Kategorien listet alle Moodle Docs Kategorien auf. Der Link kann auch über den Block "Werkzeuge" auf der rechten Seite unter dem Menüpunkt "Spezialseiten" aufgerufen werden.

• Um das Durchsuchen der Moodle Docs nach Kategorien zu erleichtern, empfiehlt es sich die Kategorie-Seiten ebenfalls zu kategorisieren. Folglich entstehen Unterkategorien. Z.B.: Category:Fähigkeiten ist den Kategorien "Administrator" sowie "Rollen" zugewiesen und erscheint zusätzlich als Unterkategorie in Category:Administrator und Category:Rollen.
• Es ist nicht notwendig Seiten in einer Unterkategorie mit der selben Kategorie zu versehen, wie die Haupt-Kategorie-Seite. Z.B.: keine der Seiten in Category:Fähigkeiten müssen als "Administrator" oder "Rollen" kategorisiert werden.
• Weitere Informationen zu Kategorien und ihre Einsatzmöglichkeiten in einem MediaWiki-System erhalten Sie z.B. auf den entsprechenden Wikipedia-Seiten: Wikipedia:Kategorien.

Screenshots

Wenn Sie Artikel für die Moodle Docs verfassen, wäre es schön und ratsam, dass Sie Ihre Artikel mit entsprechenden Screenshots versehen. Das erleichtert Moodle-Einsteigern nicht nur das Verständnis der Materie, es hilft auch erfahreren Nutzern sich schneller in ihrer eigenen Moodle-Umgebung zurecht zu finden. Um diese Screenshots erstellen zu können, steht Ihnen die offizielle Moodle demo Seite zur Verfügung oder jede andere Moodle-Seite, die das Standard-Thema von Moodle verwendet.

Format

• Screenshots sollten nicht breiter sein als 800 Pixel, in Ausnahmefällen (wenn der Inhalt der Seite nicht eindeutig dargestellt werden kann) ist auch eine Breite von 1024 Pixel möglich.
• Verwenden Sie bitte folgende Bildformate: GIF, JPEG oder PNG mit einer Auflösung von 72ppi.
• Achten Sie darauf, dass die Standardschriftgrösse des von Ihnen verwendeten Browsers eingestellt ist, damit alle Informationen auf dem Screenshot angezeigt werden. Wenn Sie eine größere Darstellung wählen kann es vorkommen, dass nicht alle Inhalte auf der entsprechenden Seite angezeigt werden. Die Einstellungen für die Schriftgröße finden Sie meistens im Browser-Menü: Ansicht > Zoom oder Ansicht > Textgröße.
• Bitte verwenden Sie keine Bildeffekte, Rahmen, Wasserzeichen oder Schatten auf den Screenshots. Nur so kann sicher gestellt werden, dass alle eingefügten Screenshots einheitlich aussehen und angezeigt werden.

Benennung

Bitte benennen Sie Screenshots eindeutig und möglichst selbst beschreibend, um Verwechslungen zu vermeiden. Als hilfreich hat sich erwiesen, wenn man die jeweilige Seitenüberschrift im Dateinamen benutzt oder einen Kontext zum passenden Artikel herstellt. Ein guter Dateiname wäre z.B. "Aufgabe_eingereichte_ansehen". Aus diesem Namen wird ersichtlich, dass es sich um die Aufgabenaktivität handelt und der Link zum Ansehen der eingereichten Arbeiten dargestellt werden soll.

Screenshots einfügen

Hilfe und weitere Informationen zum Einbinden von Bildern finden Sie in der Hilfe zu Bildern.

Vorlagen

• Vorlagen sind Seiten, die in andere Seiten eingefügt werden können. Wenn Sie rechts oben auf die Seite sehen, finden Sie dort den Block: Hilfe. Der Inhalt dieses Blocks ist eine Vorlage.
• Vorlagen werden genutzt, um ähnliche Seiten einfacher erstellen zu können.
• Eine Vorlage kann zu einer Seite mit folgendem Syntax hinzugefügt werden: {{Name}} für eine Vorlage: "Name".
• Alle Seiten (Vorlage) listet alle bestehenden Vorlagen in den dt. Moodle Docs auf.
• Für weitere Informationen steht Ihnen auch die entsprechende Hilfe der Wikipedia zur Verfügung: Wikipedia Hilfe Vorlagen.

Zusätzliche Moodle Docs Markierungen

• Löschen - Wenn Sie der Meinung sind, dass eine Seite gelöscht werden soll, dann fügen Sie {{Löschen}} oben auf der betreffenden Seite ein. Nutzen Sie die Diskussions-Seite des Artikels, um die Gründe für die Löschung bekannt zu geben.
• Überarbeiten - Mit jeder neuen Version von Moodle finden Aktualisierungen und Erweiterungen an Moodle selbst statt. Wenn Sie eine Seite finden, die aktualisiert gehört, fügen Sie {{Überarbeiten}} am Beginn der Seite ein.
• Zum Übersetzen - Diese Seiten wurden aus den englischsprachigen MoodleDocs übernommen und müssen in die Deutsch übersetzt werden. Diese Artikel / Seiten werden mit der Vorlage {{Zum Übersetzen}} gekennzeichnet.
• Unvollständig - Entwickler und Administratoren können neue Seiten zu neuen Funktionen oder Eigenschaften erstellen. Mit der Vorlage {{Unvollständig}} werden MoodleDocs-Autoren gebeten Beiträge zur Dokumentationserstellung zu leisten.
• Nutzen Sie die Diskussions- und Kommentarfunktionen der MoodleDocs um andere Moodle-Docs Autoren um Mithilfe zu bitten. Zum Beispiel finden sich immer wieder Kommentare in der Diskussionsseite wie: "Hinzugefügter Abschnitt muss bearbeitet werden..." oder ähnliches.
• Um neue Eigenschaften / Funktionalitäten neuer Moodle-Versionen speziell zu kennzeichnen, stehen Ihnen die Vorlagen für Moodle-Versionen zur Verfügung.

Vorlagen für verschiedene Moodle-Versionen

• Wenn Sie eine neue Funktionalität in Moodle dokumentieren, ergänzen Sie bitte Ihren eigentlichen Text durch die entsprechende Vorlage, z.B. {{Moodle 1.9}} für Moodle 1.9-Funktionalität.
• Diese speziellen Moodle-Versionsvorlagen ordnen eine MoodleDocs-Seite, in der sie vorkommen, automatisch der entsprechenden Seitenkategorie zu, z.B. der Seitenkategorie Moodle 1.9.
• Vorlagen von alten Moodle-Versionen, die nicht mehr auf moodle.org zur Verfügung stehen, können durch einfachen Text ersetzt werden, z.B. ab Moodle 1.5 ....

Zusammenfassung

Sobald Sie eine bearbeitete Seite speichern wollen, haben Sie die Gelegenheit eine Zeile "Zusammenfassung" auszufüllen. Es empfiehlt sich, die durchgeführten Änderungen bzw. Erweiterungen in Stichworten in diesem Feld eben zusammenzufassen, um die Lesbarkeit der Versionshistorie der jeweiligen Seite zu erhöhen. Darüber hinaus wird anderen MoodleDocs Autoren auf den ersten Blick ersichtlich, welche Änderungen / Erweiterungen genau durchgeführt wurden.