Anleitung zur Erstellung einer interaktiven Wikiseite

Herzlich Willkommen,

in dieser Anleitung möchten wir Ihnen die grundlegenden Funktionen von Programming-Wiki erklären. Wenn Sie bereits mit einem MediaWiki gearbeitet haben, können Sie den nächsten Abschnitt zur Bedienung eines Wikis überspringen.

Bedienung und Umgang mit einem Wiki

Editieren, anlegen und gestalten einer Wikiseite

Der Leser fragt sich nun vielleicht warum wurde bei diesem Abschnitt Editieren vor Anlegen genannt. Nun in einem Wiki werden typischerweise auf bestehenden Seite durch Editieren Referenzen (Links) zu Seiten eingefügt, die noch nicht existieren. Anschließend kann ein solcher (meist roter) Link angeklickt werden, um die noch nicht vorhandene Seite zu erstellen. Wir sollten uns also sinnvollerweise zunächst ansehen, wie man eine Wikiseite wie diese hier bearbeiten kann. Über dem Artikel finden Sie eine Reihe von Reitern (Tabs) wie der nachfolgenden Abbildung gezeigt:

Über den Tab Bearbeiten wechseln Sie in die Editieransicht. Wikiseiten werden in Wikiquelltext geschrieben. Dieser besitzt eine einfache Syntax unter Hilfe:Bearbeitungshilfe finden Sie eine Auflistung der wichtigsten Sprachelemente. Um einen Link auf eine neue (oder vorhandene) Seite zu erstellen, schreiben Sie einfach den Name wie folgt:

 [[Titel der Seite]] 

Manchmal passt der Seitentitel nicht gut in einen Fließtext (in einen Satz) hinein. In diesem Fall verwendet man üblicherweise einen alternativen Anzeigetext für diesen Link:

 Über die Seite [[Hilfe:Bearbeitungshilfe|Formatierungshilfe]] finden Sie ...

Um Abbildungen in eine Seite zu integriere, können Sie die Mediatoolbar (blau) im über dem Editierfenster verwenden. Wir möchten hier nicht zu sehr ins Detail gehen, aber es ist immer eine gute Idee, sich den Quelltext bestehender Seiten anzusehen, um sich hier und da etwas abzuschauen.

Zusammenarbeiten in einem Wiki

Mit mehreren Personen in einem Wiki zusammenzuarbeiten erfordert ein gewisses Umdenken. Wir sind es von Textverarbeitungen gewohnt, dass Dokumente lokal auf unserem Computer abgelegt werden und zum Austausch etwa per Email an Mitstreiter versendet werden. In einem Wiki hingegen liegt das Dokument im Web und alle Autoren können quasi gleichzeitig daran mitarbeiten. Dies kann natürlich auch zu Problemen führen, wenn etwa alle zeitgleich eine Änderung vornehmen wollen (welche Version soll denn nun behalten werden?!). MediaWiki löst dieses Problem wie folgt: Editiert man eine Wikiseite und bestätigt die Änderungen durch Speichern, wird geprüft ob es in der Zwischenzeit bereits eine neue Version gab. Ist dies der Fall, wird sich das Wiki entsprechend melden und der Autor kann vorab prüfen, welche Änderungen vorliegen und ob er diese in seine neue Version einbeziehen möchte.

Programming Wiki

Erstellen einer interaktiven Wikiseite

Das Programming-Wiki bietet eine Reihe von speziellen Sprachelementen, um interaktive Programmelemente in eine normale Wikiseite einzubauen. Hierfür wird in der Editieransicht der Seite eine zusätzliche Toolbar angezeigt:

Als wichtigste Funktion dient diese Toolbar zur Auswahl der Programmiersprache, in der Programmelemente innerhalb dieser Wikiseite verarbeitet werden sollen. Die Programmiersprache wird global für die ganze Seite bestimmt (es ist also nicht möglich sowohl Java als auch Pascal Programme in der gleichen Seite zu verwenden). Wenn Sie in der aktuellen Seite hingegen keine interaktiven Elemente verwenden, wählen Sie das leere Element in der Sprachliste aus. Die weiteren Schaltflächen dieser Toolbar dienen vorallem der einfacheren Bedienung und erstellen an der aktuellen Cursorposition die von Programming-Wiki unterstützten Spezialtags.

Programming-Wiki Sprachelemente

Eval Element

Dieses Element erstellt eine Codebox und eine Ausführen Schaltfläche.

Sie können Vorgabeprogrammtexte hinterlegen

Mit den Attributen rows und cols kann die Dimension der Codebox bestimmt werden.

 <eval> System.out.println("Hallo Welt"); </eval>
 <eval rows=3> ... </eval>
 <eval rows=3 cols=80> ... </eval>

Code Element

Erstellt eine einfache Codebox. Diese kann selbst nicht ausgeführt werden. Wird eine folgende Evalbox ausgeführt, werden auch alle Codebox Elemente bis zur vorherigen Evalbox mit ausgeführt.

Besonders hilfreich sind versteckte Codeboxen, die dem Betrachter der Wikiseite nicht angezeigt werden, jedoch bei einer darauffolgenden Evalbox mit ausgeführt werden. Um eine Codebox zu verstecken, geben Sie das Attribut hidden oder versteckt mit an.

Mit den Attributen rows und cols kann die Dimension der Codebox bestimmt werden.

 <code> function add(a,b) { return a+b} </code>
 <code hidden> ... </code><code versteckt> ... </code>
 <code rows=3 cols=80> ... </code>

Check Element

Erstellt eine Prüfschaltfläche und ist für einfache Kontrollzwecke gedacht.

Es muss eine Prüffunktion angegeben werden, die einen Wahrheitswert zurückliefert. Diese ist abhängig von der verwendeten Programmiersprache.

Es wir beim Klick auf die Prüfschaltfläche der gesammte Quellcode, der in allen Codeboxen definiert wurde ausgeführt.

 <check> return fibonacci(11)==89 && fibonacci(12)==144; </check>

Canvas Element

Erstellt eine Zeichenfläche für verschiedene Zeichenfunktionen und Turtlegrafiken.

Alle Canvas Elemente einer Seite werden nummeriert. Das erste Element wird etwa in Java über canvas oder canvas1 angesprochen. Das zweite Element mit canvas2 usw.

Über die Parameter lässt sich die Dimension der Zeichenfläche bestimmen.

 <canvas></canvas> 
 <canvas width=500 hight=300></canvas> 
 <canvas w=500 h=300></canvas> 

Speicherung von Benutzereingaben in Codeelemente

Programming-Wiki speichert die Eingaben von Benutzern in Code- und Evalboxen in einer Datenbank ab. Damit können Benutzer ihren Arbeitsplatz wechseln und sofort wieder auf ihren aktuellen Arbeitsstand zurückgreifen ohne Dateien auf einen anderen Rechner überspielen zu müssen. Der Inhalt einer Code-/Evalbox wird bei jedem Ausführen gespeichert und beim erneuten Betrachten der Wikiseite wieder geladen.

Wichtig: Programming-Wiki referenziert die Benutzereingaben der Code-/Evalboxen mit den Vorabewerten, die der Seitenautor hinterlegt hat. Beispielsweise wird der Benutzercode zu folgender Codebox:

<code> // geben Sie hier die Fibonacci Funktion ein </code>

unter dem Hash von " // geben Sie hier die Fibonacci Funktion ein " hinterlegt. Wenn Sie eine weitere Codebox auf dieser Wikiseite verwenden, dürfen Sie nicht erneut den gleichen Vorgabetext innerhalb des interaktiven Elements verwenden, da sonst keine eindeutige Zuordnung mehr möglich ist.

Es wurde bewusst auf eine Nummerierung der interkativen Element mit ID's verzichtet, um die Bedienung so leicht wie möglich zu gestalten. Gleichzeitig können Sie so eine Wikiseite beliebig bearbeiten, Elemente verschieben oder zusätzliche Elemente einfügen, ohne diese Referenzen zu verlieren.

Deshalb sollten Sie immer einen Vorgabewert definieren, sei es auch nur ein Kommentar oder ein Funktionsrumpf!