Hilfe:Quelltexte

Aus Informatik-Box
Zur Navigation springen Zur Suche springen

Es gibt verschiedene Möglichkeiten, Quelltexte im Wiki verfügbar zu machen. Entweder als Teil einer Wikiseite oder als eigenes Dokument im Namensraum Quelltext.

Quelltexte auf Wikiseiten

MediaWiki bietet drei Tags an, mit denen Quelltexte direkt in Wikiseiten eingebunden werden können.

code
code kann benutzt werden um Textabschnitte als Quelltext auszuzeichnen und entsprechend zu formatieren. code Ist vor allem dazu geeignet, kurze Quelltextausschnitte (nur einzelne oder wenige Wörter) innerhalb von Fließtexten auszuzeichnen.
Markup Ergebnis
<code>public void halloWelt()</code> public void halloWelt()
pre
pre ist ähnlich zu code, stellt den Inhalt aber als Blockelement dar. Daher eignet es sich eher, um längere Quelltexte darzustellen, die nicht innerhalb des Fließtextes auftauchen sollen. Der Tag bietet keine erweiterten Formatierungen wie Syntaxhervorhebungen oder Zeilennummern, dafür wird der Inhalt des Tags vom Wiki nicht als Wikisyntax behandelt. So kann zum Beispiel auch Wikicode auf Seiten dargestellt werden.
Markup Ergebnis
<pre>Dieser Text wird nicht durch '''Wikisyntax''' beeinflusst.</pre>
Dieser Text wird nicht durch '''Wikisyntax''' beeinflusst.
syntaxhighlight
syntaxhighlight ist das Tag mit der umfangreichsten Formatierung von Quelltexten. Es bietet Syntaxhervorhebungen und Zeilennummerierung, falls gewünscht. Dazu müssen die Programmiersprache (lang=) und ob Zeilennummern (lines=) gewünscht sind als Argumente angegeben werden.
Das Tag wird von der mediawiki:Extension:SyntaxHighlight bereitgestellt. Eine Liste der unterstützten Programmiersprachen und weitere Details zur Nutzung sind dort dokumentiert.
public class Käfig<Tierart> {
    private Tierart tier;

    public Käfig( Tierart pTier ) {
        tier = pTier;
    }

    public Tierart getTier() {
        return tier;
    }

    public void setTier( Tierart pTier ) {
        tier = pTier;
    }

    public boolean istBesetzt() {
        return tier != null;
    }
}


Der Quelltext Namensraum

Um umfangreichere Quelltexte verfügbar zu machen, deren Einbindung direkt auf einer Wikiseite zum Beispiel zu unübersichtlich wäre, gibt es den Namensraum Quelltext. Seiten in diesem speziellen Namensraum müssen dem Dateinamen der Quelltextdatei entsprechen, die sie abbilden. Vor allem muss die Dateiendung die Programmiersprache abbilden, und er der Quelltext verfasst ist. Der Inhalt der Seite darf ausschließlich den Quelltext der Klasse umfassen, sonst nichts.

Icon Info.png
Der Namensraum soll in Zukunft um spezielle Funktionen erweitert werden, die das Herunterladen und interagieren mit Quelltexten erleichtern. Da diese Funktionen derzeit noch nicht installiert sind, können die Quelltexte zunächst noch um ein syntaxhighlight-Tag ergänzt werden.

Beispiele: