Schnellstart

Schnellstart für Hilfe-Autoren

Das Stud.IP-Hilfe-Wiki verwendet pmwiki als Grundlage. Über die Standardinstallation hinaus sind einige Erweiterungen installiert bzw. in wenigen Fällen gesondert programmiert worden. Dieses Dokument informiert Sie über die wichtigsten Editierregeln für pmwiki und über die spezifischen Arbeitsabläufe für die Stud.IP-Hilfe.

1. Login und Editierrechte

Ein Login ist erforderlich, um Seiten zu bearbeiten und Administrationsaufgaben wahrzunehmen.

Administrationsaufgaben sind:

  • Einrichten und Ändern von Accounts
  • Setzen und Ändern von Zugriffsrechten für einzelne Seiten und Gruppen
  • Einrichtung neuer Hilfewikis

Mit Klick auf "Login" (oben rechts) können Sie sich bei der Wiki-Hilfe einloggen. Die Logins für die Basishilfe werden derzeit noch von Tobias Thelen vergeben.

↑ Inhaltsverzeichnis

2. Vorhandene Seiten editieren

Ein Klick auf "Bearbeiten" öffnet eine gerade angezeigte Seite im Bearbeitungsmodus. Sie sehen dann den Seiteninhalt in einer speziellen Schreibweise, die Überschriften, Links, eingebundene Bilder, Fettdruck etc. auf einfache Weise abbildet.

Wenn Sie nach der Bearbeitung auf Speichern klicken, wird der Seiteninhalt aktualisiert. Die Vorschau-Funktion erlaubt es Ihnen, einen Blick auf die Formatierung der Seite zu werfen, ohne die Änderungen sofort zu speichern.

Das Feld Zusammenfassung nimmt eine Kurzzusammenfassung einer Änderung auf, die dann in der Übersicht der letzten Änderungen erscheint. Auf diese Weise erleichtern Sie sich und anderen den Überblick über Veränderungen im Wiki. Typische Zusammenfassungen könnten sein: Einige Tippfehler behoben, Neuer Abschnitt zu Rechteverwaltung oder Screenshots aktualisiert. Das Feld Autor sollte Ihren Namen enthalten - so sind Änderungen Personen zuordenbar.

↑ Inhaltsverzeichnis

3. Neue Seiten anlegen, Seitennamen

Wie in Wikis üblich, legen Sie Seiten dadurch an, dass Sie auf sie verlinken und anschließend auf den neu entstandenen Link klicken. In dieser pmwiki-Installation sind WikiWords abgeschaltet, d.h. Sie können ausschließlich die Form mit eckigen Klammern zum Verlinken verwenden (s. Textformatierungsregeln).

Eine Besonderheit von pmwiki sind so genannte Gruppen. Die Seiten eines Wikis können sich auf beliebig viele Gruppen verteilen, wobei jede Gruppe einen eigenen Namensraum bildet, d.h. z.B. die Seite Homepage kann in jeder Gruppe unabhängig von den anderen gefüllt werden. Gruppen können nicht hierarchisch verschachtelt werden.

Ein Wiki-Seiten-Name setzt sich demnach aus zwei Teilen zusammen: Gruppe.Seite oder Gruppe/Seite. Beide Schreibweisen sind synonym. Wird der Gruppenteil eines Namens z.B. bei Links weggelassen, verweist der Link auf die bezeichnete Seite der aktuellen Gruppe. Wenn nicht besonder e Effekte durch Weglassen des Gruppennamens erzielt werden sollen, ist es bei Wikis, die mehrere Gruppen verwenden (so wie dieses) immer ratsam, den Gruppennamen mit anzugeben.

Achtung: Seitennamen dürfen keine Punkte oder Schrägstriche enthalten!

Wenn versehentlich eine Seite Basis.Stud.IP oder Basis/Stud.IP angelegt wird, ignoriert pmwiki den ersten Teil des Bezeichners und legt tatsächlich eine Seite IP in der Gruppe Stud an.

↑ Inhaltsverzeichnis

4. Namenskonvention für Stud.IP-Hilfeseiten

Für die Verwendung innerhalb der Stud.IP-Hilfe sollten folgende Namenskonventionen beachtet werden, damit Namenskonflikte vermieden werden und die interne Verlinkung leichter fällt:

  • Alle Hilfeseiten für Funktionen der Stud.IP-Kerndistribution gehören in die Gruppe Basis
  • Seitennamen sind zweiteilig:
    • Modul-/Bereichsbezeichnung
    • Unterseitenbezeichnung innerhalb des Moduls
  • Die Start-/Einsprungseite einer Modulhilfe trägt nur den Modulnamen. Beispiele:
  • Die Unterseitenbezeichner bestehen aus einem oder mehreren ausgeschriebenen Wörtern, die mit Großbuchstaben beginnen. Beispiele:
  • Abkürzungen vermeiden!
  • Nicht zu lange Namen wählen, zwei bis drei Wörter sollten ausreichen.
  • Keine Artikel, Präpositionen und andere Funktionswörter in Seitennamen verwenden. NeueMitgliederZuDerEinrichtungHinzufügen ist ungünstig, besser ist hier EinrichtungMitgliederHinzufügen
  • Umlaute können in den Namen verwendet werden, ae, ue, oe etc. vermeiden!
  • KEINE Punkte oder Schrägstriche in den Namen. Stud.IP soll als StudIP geschrieben werden.

↑ Inhaltsverzeichnis

5. Formatierungssyntax

Die Formatierungssyntax wird unter jedem Eingabefeld kurz erläutert, Links auf die pmwiki-Dokumentation führen auf vertiefende Dokumentationsseiten. Eine Button-Leiste (6) erleichtert zudem die Eingabe.

An dieser Stelle wird die pmwiki-Syntax nicht weiter erläutert, sondern nur einige Punkte herausgestellt, die sich häufiger für Anfänger als problematisch herausgestellt haben.

5.1 Bilder/Dateien einbinden

In pmwiki können Bilder und Dateien hochgeladen und auf Wiki-Seiten verlinkt bzw. angezeigt werden. Dies ist ein zweischrittiges Verfahren:

  1. Verwenden des Markups Attach:dateiname.jpg und Absenden der Änderung
  2. Anschließend erscheint das Attach wie ein Link auf eine nicht vorhandene Wiki-Seite, ein Klick darauf führt zu einem Upload-Dialog. Anschließend ist die Datei in pmwiki vorhanden und der Link aktiv bzw. das Bild eingebunden.

Alle Bilder/Dateien einer Gruppe bilden einen gemeinsamen Namesraum. Sie können also z.B. die Datei achtung.gif auf vielen Seiten verwenden, ohne Sie mehrfach hochzuladen. Wählen Sie beschreibende, detaillierte Namen für Dateien, z.b. unter Einbeziehung des Modulnamens. literatur_suchen.jpg ist ein eher guter Name, screenshot.jpg ein eher ungeeigneter.

5.2 Bilder/Dateien ersetzen/aktualisieren

Um ein vorhandenes Bild (das folgende gilt analog für alle Arten von Dateien) zu ersetzen, kann zum einen der vorhandene Link geändert und ein neues Bild hochgeladen werden. Vorteil: das alte Bild kann ggf. rekonstruiert werden. Nachteile: Es ist schwierig, weitere gute Namen zu finden und es bleiben unreferenzierte Dateien zurück.

Alternativ kann ein gleichnamiges Bild hochgeladen werden, das das vorhandene Bild überschreibt. Hierzu ist die Sicht "upload" geeignet, die einen Upload-Dialog bietet. Laden Sie hier eine Datei hoch und tragen Sie unter "optional anderer Name" den Namen der zu ersetzenden Datei ein, falls die hochgeladene Datei nicht ohnehin so heißt.

5.3 Seiten löschen

Seiten werden gelöscht, indem der Text durch delete ersetzt wird.

Anschließend ist die Seite über das Wiki nicht mehr erreichbar, alle Versionsinformationen sind auch verloren. Intern wird die Datei umbenannt, so dass der Wiki-Administrator ggf. den Stand vor dem Löschen wiederherstellen kann.

↑ Inhaltsverzeichnis

6. Navigation und Menuspalte

Die Menuspalte links und die Trail-Navigation über den Überschriften (im Screenshot gelb hinterlegt) werden automatisch aus einer Wiki-Seite gewonnen, die alle relevanten Hilfe-Seiten für eine Stud.IP-Rechtestufe aufführt.

Die Trail-Navigation ermöglicht einen sequentielle Durchgang durch die Hilfeseiten mit dem Optionen vorherige Seite, Inhaltsverzeichnis und nächste Seite. Verschachtelungen werden hier nicht gesondert berücksichtigt.

Die Menuspalte links listet die Kapitellinks auf und klappt die mit der aktuellen Seite verbundenen Untereinträge (auch mehrfach geschachtelt) auf.

Trail-Navigation und Menuspalte werden über die Einträge auf der Wiki-Seite Basis.MenuBar? gesteuert. Bei der Bearbeitung dieser Seite bitte folgende Punkte beachten:

  • Es werden nur Seiten erkannt, die als Links in Aufzählungen, direkt nach dem Aufzählungszeichen stehen
    • ![[Basis.Forum]] wird nicht erkannt, weil es eine Überschrift ist
    • *[[Basis.Forum]] wird als Kapitelüberschrift erkannt
    • **[[Basis.ForumLetzteBeiträge]] wird als Unterkapitelüberschrift erkannt
    • * So können Sie [[Basis.LiteraturBearbeiten]] wird nicht erkannt, weil der Link nicht direkt hinter dem Aufzählungszeichen steht
  • Verwenden Sie kurze, treffende Beschreibungen für die Links, z.B. [[Basis.Homepage|Die eigene Homepage]]

Andere Einträge auf der Seite sind sinnvoll, da die Seite auch als Inhaltsverzeichnis verwendet wird. Überschriften, Erklärungen hinter den Links etc. werden für die Navigation ignoriert, stören diese auch nicht und mahen die Seite übersichtlicher.

↑ Inhaltsverzeichnis

7. Kurzfassung: DOs und DONTs

  • Do:
    • Alle Links sollen den Gruppennamen enthalten, also [[Basis.Forum]] statt nur [[Forum]]
    • Alle Hilfeseiten für die Kerndistribution in die Gruppe Basis
    • Beschreibende Seitennamen unter Einbeziehung des Moduls wählen, z.B. Basis.LiteraturSuchen
  • Don't:
    • Keine Seitennamen mit Punkten oder Schrägstrichen
    • Keine zu allgemeinen Namen für hochgeladene Bilder und Dateien. screenshot.jpg ist eine schlechte Wahl.
    • Keine Seiten anlegen, die nicht auf die Menu-Seite eingetragen werden, das bringt die Navigationsmechanismen durcheinander.

Letzte Änderung am 22.02.2011 15:14 Uhr von tthelen.

 
 

Hilfe zur Hilfe

Hier finden Sie Dokumentation für Hilfeautoren zum Stud.IP-Dokumentationswiki.

(c) Stud.IP e.V. und die Autoren der Stud.IP-Dokumentation.
Dieser Text ist unter der Lizenz "Creative commons Attribution/Share Alike" verfügbar.