MoodleDocs:StyleGuide

Diese Seite ist noch nicht vollständig übersetzt.

Siehe en:MoodleDocs:Style guide

Kategorien

Eine Kategorie ist eine Übersichtsseite von Dokumentations-Seiten. Dh. 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.
• 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.
• Screenshots werden über den Block "Werkzeuge" auf der rechten Seite hochgeladen. Wählen Sie dort den Link Hochladen.
• Bitte benennen Sie Screenshots eindeutig und möglichst selbst beschreibend, um Verwechslungen zu vermeiden.
• Um einen Screenshot in einen Artikel, eine Seite einzufügen, verwenden Sie bitte folgenden Syntax: [[Bild:Screenshot.png|thumb|alt text]]. Screenshot.png wird dabei durch den eigentlichen Dateinamen ersetzt, "thumb" gibt an, dass der Screenshot als Vorschaubild angezeigt wird. Das Bild wird in voller Größe angezeigt, sobald man darauf klickt. Ersetzen Sie zum Schluss "alt text" durch eine kurze und prägnante Bildbeschreibung.
• 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.
• Weitere Informationen zum Einfügen und Platzieren von Bildern in MediaWiki-Systemen erhalten Sie auf den Seiten der Wikipedia: Wikipedia Hilfe Bilder].

Vorlagen

• In MediaWiki, a template is a page which can be inserted into another page. For example, the Moodle Docs help block on this page is a template.
• A template may be added to a page by typing {{Name}} for Template:Name.
• All pages (Template namespace) lists all Moodle Docs templates.
• Please refer to the MediaWiki Template help for further information.

Moodle Docs bearbeiten tags

• Deletion - If you find any page requiring deletion, type {{Deletion}} at the top of the page. Use the page comments if necessary to state the reason for deletion.
• Update - Features increase with each Moodle version. If you find a page requiring updating, type [[Template:Update]] at the top of the page.
• Stub - Developers and Moodle Docs administrators may add a new page with a {{Stub}} tag at the top, requesting help in adding content.
• You can also use the edit summary to communicate the need for more editing. For example in the page history you might see: "Added section, needs more work, see page comments".

PHP Syntax Hervorhebung

• Um PHP-Syntax (oder jeden beliebigen anderen Programmier-Code) speziell hervorzuheben, schließen Sie die Codezeilen in Tags ein. Nutzen Sie dazu folgende Befehle:

<code php>...Der Code folgt hier...</code>