Bekanntlich lebt die Open-Source-Entwicklung von den Beiträgen der User. Nachdem wir Zikula schon viele Jahre für unsere Website hier nutzen und währenddessen schon einige Verbesserungen zur deutschen Übersetzung beigetragen hatten, ist nun auch ein Stück Programmcode aus unserer Feder in den Zikula-Core eingegangen [3].

Es handelt sich dabei um eine Funktion, die den in der Trefferliste der Volltextsuche wiedergegebenen Textabschnitt aufbereitet. Die vorherige Version der Prozedur funktionierte nicht richtig. Sie gab statt des gewünschten kurzen Textabschnitts (Dessen Länge ist einstellbar über den Parameter "limitsummary" in der Konfiguration des Moduls "Suche") zumeist fast den gesamten Text des Fundstücks wieder. Die Trefferliste wurde dadurch sehr lang und entsprechend unübersichtlich.

Mit der neuen von mir gestifteten Version der Funktion "highlightWords" in der Klasse "StringUtil" gelingt die Kürzung des Textabschnitts nun wunschgemäß :-)

Überdies habe ich die Funktion im Sinne der Perfomance optimiert (s.u.), den Code reichhaltig kommentiert sowie mit Funktionsheader zur Dokumentation ausgestattet.

Verbesserungen der Funktionsweise im Einzelnen:

• Markierung der Suchbegriffe nur im angezeigten gekürzten Textabschnitt. (Die alte Funktion bearbeitete den gesamten Text)
• Zuverlässiges Auffinden der Suchbegriffe, indem nach den Begriffen gefahndet wird. (Die vorherige Version ging davon aus, dass das Auftauchen des Zeichens "<" im Text bedeutet, dass ein HTML-Tag folgen würde. Das muss aber nicht so sein. Es kann auch einzeln im Text verwendet werden, was dann zu fehlerhafter Abgrenzung des Abschnitts geführt hätte.)
• Kürze nur Texte, die wirklich gekürzt werden müssen. (Die alte Funktion analysierte und behandelte auch Texte, die ohnehin schon kurz genug waren um in voller Länge angezeigt zu werden.)

Wie aufgrund der Verbesserungen zu erwarten war, wurde der Patch erfreut in die Code-Base von Zikula [4] aufgenommen. Zuvor war jedoch noch die Unterzeichnung des sogenannten Zikula Foundation Contributor Agreement [5] erforderlich. Damit wird die Zikula Foundation Miteigentümerin am Code und erhält volle Handlungsfreiheit für einen ggf. in Zukunft gewünschten oder erforderlichen Wechsel der Lizenz.

Ich hätte mir gewünscht, dass die Zikula Foundation den AutorInnen im Gegenzug zusichert, dass sie den Code so offen, wie irgend möglich, halten wird. Leider fand ich in dem Dokument [6] keine entsprechende Selbstverpflichtung.

Als besseren Angang in diesem Sinne empfinde ich das Fiduciary Licence Agreement (FLA) [7] der FSFE [8].

Soweit der Bericht und besten Gruß,

Gabriele