Benutzer:Schnark/js/highlight

Dieses Skript wird nicht mehr gepflegt. Wenn du es verwenden willst, kannst du dies tun, solange es noch funktioniert, danach musst du es entweder selbst weiterpflegen oder einen anderen dafür finden.

Dieses Skript stellt Funktionen bereit, um Wörter oder Ausdrücke hervorzuheben. Diese Dokumentation richtet sich ausdrücklich nicht an Anwender, sondern nur an Programmierer. Eine Anwendung ist Benutzer:Schnark/js/antispoof.

Einbindung

Das Skript muss vor dem eigentlichen Skript, das die Hervorhebung vornimmt, eingebunden werden.

Funktionen

Folgende Funktionen stehen nach dem Laden zur Verfügung:

• mw.libs.highlight.highlightWord(word, hint, color, class)
• mw.libs.highlight.highlightString(word, hint, color, class)
• mw.libs.highlight.highlight(expr, hint, color, class)

Für die Parameter gilt:

• word: string, vollständiges Wort oder Teilstring, nach dem gesucht werden soll
• expr: regulärer Ausdruck mit zwei Klammern: /(vorne)(hervorheben)hinten/g
• hint: mixed (optional, Standard: kein Hinweis)
  • string: Hinweis
  • function: wird mit Treffer aufgerufen, liefert Hinweis zurück
• color: mixed (optional, Standard: gelb)
  • string: Hintergrundfarbe
  • function: wird mit Treffer aufgerufen, liefert Hintergrundfarbe zurück
• class: mixed (optional, Standard: keine Klasse)
  • string: Klasse
  • function: wird mit Treffer aufgerufen, liefert Klasse zurück

Zurückgegeben wird die Anzahl der gefundenen Treffer.

Code

Der Javascript-Code befindet sich unter Benutzer:Schnark/js/highlight.js.