Inhaltsverzeichnis

Sonderfunktionen des PofoWiki

Zur besseren Veranschaulichung bestimmter Sachverhalte oder aber zur aufgelockerten Darstellung von Artikel unterstützt das PofoWiki eine Reihe von Sonderfunktionen, die im Folgenden näher beschrieben sind.

Schwierigkeitsgrade

In Artikeln der Bereiche Soft- und Hardwareeentwicklung kann es unter Umständen für einen leser sehr hilfreich sein, wenn direkt zu erkennen ist, wie kompliziert die dargestellte Thematik ist.

Für diesen Zweck gibt es einen Skilllevel, der wie folgt verwendet wird:

Schwierigkeitsgrad Code Anzeige
kein1) {{skill>0/5}} 0/5
sehr leicht {{skill>1/5}} 1/5
leicht {{skill>2/5}} 2/5
normal {{skill>3/5}} 3/5
schwer {{skill>4/5}} 4/5
sehr schwer {{skill>5/5}} 5/5

Die Beschreibung dieser Schwierigkeitsgrade ist lediglich als Muster zu sehen. Letztlich gilt: Es stehen 5 Sterne zur Verfügung, die entsprechend des Grades der Anforderungen des Artikels gesetzt werden können.

Die Angabe des Schwierigkeitsgrades hat vor dem eigentlichen Beginn des Artikels zu erfolgen. Das bedeutet, dass die Angabe noch vor der Hauptüberschrift und damit der ersten Überschrift des Artikels erfolgen muss.
Die Funktion zur Darstellung des Schwierigkeitsgrades nutzt das Alpha-Blending des Browsers. Derzeit unterstützten alle gängigen Browser mit Ausnahme des Opera 8.x diese Funktion. Ab der Version 9 wird auch Opera diese Funktion unterstützen.

Hinweistexte innerhalb von Artikeln

Unter Umständen kann es nötig sein, dass innerhalb eines Artikels bestimmte Informationen hervorgehoben werden müssen, weil Sie eine Warnung enthalten oder schlicht einen Tipp zur Arbeitserleichterung.

Anmerkungen

<note classic>
Verwenden Sie diese Umgebung, wenn sie Texte einfügen möchten, die eher als eine Art Notiz oder Randanmerkung zu verstehen sind.
</note>
Verwenden Sie diese Umgebung, wenn sie Texte einfügen möchten, die eher als eine Art Notiz oder Randanmerkung zu verstehen sind.

Hinweise

tip
Verwenden Sie diese Umgebung um den Leser auf eine besondere Information, wie beispielsweise einen konkreten Tipp, zu geben.
</note>
Verwenden Sie diese Umgebung um den Leser auf eine besondere Information, wie beispielsweise einen konkreten Tipp, zu geben.

Wichtige Hinweise

<note important>
Verwenden Sie diese Umgebung um einen wichtigen Hinweis einzufügen. Dies können beispielsweise Hinweise sein, die auf eine mögliche Zerstörung von Komponenten bei falschem Einsatz hinweisen.
</note>
Verwenden Sie diese Umgebung um einen wichtigen Hinweis einzufügen. Dies können beispielsweise Hinweise sein, die auf eine mögliche Zerstörung von Komponenten bei falschem Einsatz hinweisen.

Kritische Warnungen

<note warning>
Diese Umgebung ist für kritische Warnungen reserviert. Verwenden Sie diese nur in den Fällen, in denen die Umgebung für Wichtige Hinweise der drohenden Gefahr nicht mehr gerecht wird.
</note>
Diese Umgebung ist für kritische Warnungen reserviert. Verwenden Sie diese nur in den Fällen, in denen die Umgebung für Wichtige Hinweise der drohenden Gefahr nicht mehr gerecht wird.

Bildergalerien einfügen

Eine besondere Funktion des PofoWiki ist die Möglichkeit Bilder, die sich in einem Namensraum befinden in Form einer Galerie darstellen zu können.
Dies kann bspw. dazu genutzt werden um eine eingescannte Anleitung, Fotos eines Treffens oder schlicht diverse Produktfotos, die im Artikel keine verwendug gefunden haben darzustellen.

Galerie erzeugen

Um alle Grafiken des, dem aktuellen Namensraumes übergeordneten darzustellen genügt der Befehl

{{gallery>info:wiki:contrib:manual}}
Sollen die Bilder der Galerie nicht mit den bereits im Artikel verwendeten Grafiken erstellt werden, so kann man sich ganz einfach damit behelfen, indem man eine Seite unterhalb des aktuellen Namensraumes anlegt, dort die Grafiken hochlädt und den Editor danach mit Abbrechen wieder verlässt. Die Galerie kann dan auf den neuen Namensraum verweisen und es werden auch nur die darin enthaltenen Bilder angezeigt.

Spaltenzahl vorgeben

Wenn Sie die vorgegebene Anzahl an Spalten verändern möchten, so ginge das in unserem obigen Beipsiel folgendermassen:

{{gallery>info:wiki:contrib:manual?8}}

Dateinamen anzeigen lassen

{{gallery>info:wiki:contrib:manual?showname}}
Alle Attribute können miteinander kombiniert werden. Die Reihenfolge ihres Auftretens ist dabei vollkommen egal.

Syntax-Highlighting von Programmcode

Um die Struktur eines Programms deulticher sichtbar zu machen bedient man sich der farblichen Hervorhebung von Befehlen, Attributen, usw. Dies wird auch vom PofoWiki unterstützt. Im Folgenden soll die Anwendung genauer beschrieben werden.

Das Syntax-Highlighting erfolgt über die schon bekannte Umgebung <code>...</code> und wird im Prinzip lediglich um die Kurzbezeichnung der verwendeten Programmiersprache erweitert.

Bei

@echo off
cls
echo Nur ein kleiner Testbatch

wurde für die Eröffnung der Code-Umgebung ein <code dos> verwendet.

Innerhalb der Code-Umgebung werden alle Zeilenumbrüche so bereücksichtigt, wie dargestellt. Es ist nicht nötig einen manuellen Umbruch einzufügen. Dadurch ist es zum Beispiel sehr einfach ein Programm aus einem Editor direkt in das Edit-Fenster des Wiki zu kopieren und auch die Einrückung beizubehalten.

Für das Syntax-Highlighting wird auf den Highligher GeSHi zurückgegriffen. Daher werden auch alle Sprachen unterstützt. Die am häufigsten, bei auf den Portfolio bezogenen Artikeln verwendeten Programmierpsrachen sind in der folgenden Tabelle aufgeführt.

Anweisung Sprache
asm Assembler
C C-Programme
C++ Programme in C++
dos MS-DOS-Batchdateien oder Befehle
Pascal Programme in Pascal oder TurboPascal
sdlbasic Basicprogramme in bspw. PBASIC oder PowerBASIC

Elektronische Visitenkarten bereitstellen

1)
Setzen Sie auch diesen Level, wenn der Artikel Ihrer Meinung nach keine besondere Schwierigkeit aufweist. Dadurch sehen andere Autoren, dass bereicht eine Festlegung stattgefunden hat und diese lediglich angepasst werden müsste