# Redaktionsleitfaden für die Knowledge Base von Moodle an Hochschulen e.V.

[https://kb.moodle-an-hochschulen.de](https://kb.moodle-an-hochschulen.de)

## Ziel

Wir sammeln an einem zentralen Ort Wissen über Moodle, das in verschiedenen Kanälen zu finden oder aus  
internen Quellen oder Erfahrungen stammt und von allgemeinem Interesse ist.

## Zielgruppe

Unsere Zielgruppe besteht aus Hochschulakteuren (bewusst aber nicht direkt Lehrende und Studierende). Dazu  
gehören z.B. Personen aus folgenden Bereichen:

- Service (alle, die Support oder Schulungen machen)
- Moodle-Administration
- Moodle-Entwicklung
- Hochschuldidaktische Beratung

Die Zielgruppe orientiert sich vor allem an den Angehörigen des Community-Kurses „Moodle an Hochschulen im  
deutschsprachigen Raum“ (https://forum.moodle-an-hochschulen.de).

Die Inhalte sollen, sofern möglich, einer interessierten Öffentlichkeit ohne Beschränkung zugänglich sein.

## Wie sollen die Inhalte angelegt werden?

Die Einträge sollen auf **Deutsch** und in eigenen Worten verfasst werden.

Eine **Illustration** durch Medien (z.B. Videos, Bilder, Screenshots oder Code-Beispiele) kann hilfreich sein.

Außerdem sind hilfreiche **Links** z.B. auf die offizielle Moodle-Doku oder den Moodle-Quellcode  
(https://github.com/moodle/moodle) nützlich.

Jeder Eintrag soll mit einem oder mehreren **Tags** versehen werden.

Jeder Eintrag bekommt eine bzw. mehrere **Autorensignaturen** (von der/den Personen, die den Artikel verfasst  
haben).

Die Namen sollen dabei mit der **Profilseite** im Moodle-an-Hochschulen-Moodle verlinkt werden.

## Struktur der Inhalte

### Regale

[Regale](https://kb.moodle-an-hochschulen.de/shelves) versammeln Bücher, die thematisch zusammengehören.

Es gibt die Regale „Community“, „Didaktische Szenarien und Materialien“, „E-Assessment“, „Entwicklung,  
Fehleranalyse und Debugging“, „Moodle-Administration (Core)“, „Plugins“, „Server-Administration“.

### Bücher

[Bücher](https://kb.moodle-an-hochschulen.de/books) enthalten Artikel zu einem bestimmten Thema, z.B. „Nutzerverwaltung“, „Support-Materialien“ oder  
„Update-Management“.

### Kapitel

Kapitel dienen der Strukturierung von Büchern und sind sinnvoll, sobald sich Unterthemen zusammenfassen  
lassen. *Beispiele*:

Kapitel „Config-Settings“ mit den Unterseiten „Nützliche Config-Settings“ und „Geheime Config-Settings“ im Buch  
„Moodle Konfiguration“.

### Seiten

**Überschriften**: Die Hauptüberschriften eines Artikel sollen mit „Große Überschrift“ (= h2) formatiert werden.  
Weitere Unterüberschriften dann hierarisch mit „Mittlere Überschrift“ (= h3), „Kleine Überschrift“ (= h4) und „Sehr  
kleine Überschrift“ (= h5).

Vorteil: Wenn man die vorgegebenen Überschriften zur Strukturierung des Artikels nutzt, wird automatisch links  
oben auf der Seite ein **Inhaltsverzeichnis** des Artikels erstellt. Außerdem werden dann die Anforderungen der  
Barrierefreiheit erfüllt.

**Kursive Formatierung** für:

- Klickpfade (z.B. *Website-Administration* > *Nutzer/innen* > *Nutzerkonten* > *Nutzerliste hochladen*)
- Moodle-spezifische Begriffe, Buttons oder Menüpunkte

**Code Formatierung** für:

- Quellcode (z.B. `$CFG->debugdisplay = 1;`)
- System-URLs (z.B. `/admin/tool/task/scheduledtasks.php`)
- System-Befehle (z.B. `df –h`)

## Nutzung von Tags

Hintergrund: Kommentare und Tags hängen mit ihrer Sichtbarkeit an der Sichtbarkeit der Seite – sie sind also für  
die Rolle "Public" sichtbar, aber nicht bearbeitbar.

**Alle Artikel sollen mit den passenden Tags versehen werden**.

**Eindeutigkeit und Einheitlichkeit**: Bei der Verschlagwortung von Artikeln schlägt BookStack die bestehenden  
Tags vor, wenn man anfängt zu tippen. Bitte darauf achten, keine unterschiedlichen Schreibweisen von Begriffen  
zu verwenden!

Tags können **Werte** haben, mit denen man die Tags genauer beschreiben kann.

Der Tag „needs-enhancement“ kann bei Bedarf gesetzt werden (Werte z.B.: „Formatierung“, „Illustrationen“,  
„Texterweiterung“).

## Angabe von Quellen und Copyright

Wenn möglich, soll eine Quelle für die Informationen angegeben werden.

Für die Nutzung fremder Medien (z.B. Texte, Bilder und Code-Beispiele) gilt, dass die jeweiligen  
Lizenzbedingungen beachtet werden müssen.

Alle Inhalte in der Knowledge Base unterliegen grundsätzlich der CC-Lizenz „[CC BY-NC-SA](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.de)“ (Teilen und  
bearbeiten mit Namensnennung, Weiternutzung nur nicht kommerziell). In begründeten Fällen kann in Absprache  
mit der AG Community-Arbeit davon abgewichen werden.

## Inhalte wiederverwenden

Wenn Inhalte an mehreren Stellen gebraucht werden, müssen sie nicht mehrfach angelegt werden.

Es genügt, eine zweite Seite anzulegen und den Inhalt mit Eingabe von `{{@page_id}}` zu verlinken. Anzeigen der ID: Text in zu kopierendem Artikel markieren (Lesemodus, nicht beim editieren), es öffnet  
sich ein modal, dort links auf das Link-icon klicken, dann springt die Anzeige auf die Text-ID um.

Dasselbe Prinzip ist auch mit Absätzen möglich.

Anleitung siehe [https://www.bookstackapp.com/docs/user/reusing-page-content/](https://www.bookstackapp.com/docs/user/reusing-page-content/)

Hinweis: Die Original-Seite ist zu finden durch Eingabe von `/link/xx`, wobei `xx` die `page_id` bzw.  
`page_id#bkmrk-content-area` ist!

Beispiel: `/link/19` führt zu `/books/buch-debugging/page/plugin-tool-userdebug`

## Themen-Patenschaften

Die Aufgabe der Themen-Paten besteht darin, neue Inhalte Korrektur zu lesen, und zwar sowohl in Hinsicht auf  
Rechtschreibung, Grammatik und Verständlichkeit als auch auf inhaltliche Richtigkeit.

Idealerweise wird die Patenschaft für ein Thema von 2-3 Personen übernommen.

[Patenschaften in tabellarischer Übersicht](https://kb.moodle-an-hochschulen.de/books/arbeitsgruppen/page/infos-zur-ag-community-arbeit "AG Community-Arbeit")