Listings

Beispiel
<loop_listing title="Listingtitel" description="Listingbeschreibung">
<source lang="java" line="true">
public class 
...
}
</source>
</loop_listing>

Das Ergebnis auf der Seite sieht dann wie folgt aus:

Download [{{#file:Thread1.java}} Thread1.java]

  1. public class Thread1 extends Thread {
  2. 	private int counter = 0;
  3. 	private boolean doCount;
  4. 	JTextField textField = null;
  5.  
  6. 	public Thread1(JTextField textField,
  7. 			boolean doCount ) {
  8. 		this.textField = textField;
  9. 		this.doCount = doCount;
  10. 	} // Konstruktor
  11.  
  12.  
  13.  
  14. } // class Thread1


Parameter

Über Parameter haben Sie die Möglichkeit das Verhalten des Tags loop_listing zu beinflussen.

Parameter gültige Werte Standard
title Text nicht gesetzt
description Text nicht gesetzt
copyright Text nicht gesetzt
index true, false true
render none, icon, marked marked bzw. Wert der Konfigurationsvariable $wgLoopTableDefaultRenderOption
show_copyright true, false false

Im folgenden werden die einzelnen Parameter detailierter erklärt.


title

Parameter title
gültige Werte Text
Standard nicht gesetzt

Mit dem Paramter title können Sie den Titel des Listings setzen. Der Titel wird oberhalb des Listings und im Listingverzeichnis angezeigt.

Beispiel
<loop_listing title="Listingtitel">
 Programmcode
</loop_listing>
Wichtig

Wichtig: Nur wenn Sie einen Titel angegeben haben funktioniert ein Springen aus dem Listingverzeichnis an die richtige Stelle der Seite. Ist kein Titel angegeben führt der Link im Listingverzeichnis zwar auf die richtige Seite aber nicht direkt zu der Stelle an der sich das Listing befindet.

description

Parameter description
gültige Werte Text
Standard nicht gesetzt

Mit dem Paramter description können Sie die Beschreibung des Listings setzen. Die Beschreibung wird unterhalb des Listings und im Listingverzeichnis angezeigt.

Beispiel
<loop_listing description="Listingbeschreibung">
 Programmcode
</loop_listing>

copyright

Parameter copyright
gültige Werte Text
Standard nicht gesetzt

Mit dem Paramter copyright können Sie die Copyrighthinweis des Listings setzen. Der Copyrighthinweis wird unterhalb der Beschreibung und im Listingverzeichnis angezeigt.

Hinweis

Der Copyrighthinweis wird nur angezeigt wenn der Parameter show_copyright denn Wert true besitzt.

Beispiel
<loop_listing copyright="Copyrighthinweis">
 Programmcode
</loop_listing>

index

Parameter index
gültige Werte true, false
Standard true

Mit dem Parameter index können Sie beinflussen, ob das Listing im Listingverzeichnis angezeigt werden oder nicht. Auf die Anzeige des Listings auf der Seite hat der Parameter keinen Einfluss (siehe hierzu render).

Beispiel
<loop_listing index="false">
 Programmcode
</loop_listing>

render

Parameter render
gültige Werte none, icon, marked
Standard marked bzw. Wert der Konfigurationsvariable $wgLoopTableDefaultRenderOption

Mit dem Parameter render können Sie beinflussen wie Listings auf der Seite dargestellt werden. Auf die Indexierung des Listings für das Listingverzeichnis hat der Parameter keinen Einfluss (siehe hierzu index).

Ist der Parameter render nicht angeben wird der Standardwert marked verwendet. Dieser Standard kann in der Konfigurationsdatei LocalSettings.php über die Variable $wgLoopListingDefaultRenderOption auf einen der Werte none, icon oder marked gesetzt werden.

Beispiel

none

<loop_listing render="none">
 Programmcode
</loop_listing>


Programmcode



Beispiel

icon

<loop_listing render="icon">
 Programmcode
</loop_listing>
Programmcode


Beispiel

marked

<loop_listing render="marked">
 Programmcode
</loop_listing>
Programmcode

show_copyright

Parameter show_copyright
gültige Werte true, false
Standard false

Mit dem Parameter copyright können Sie beinflussen, ob unterhalb der Beschreibung ein Copyrighthinweis angezeigt wird, oder nicht.

Beispiel
<loop_listing copyright="Copyrighthinweis" show_copyright="true">
 Programmcode
</loop_listing>


Programmcode


Code

Es gibt übrigens auch einen Seitenbereich vom Typ sourcecode