3.1.2 Hitlist

Die Trefferliste zeigt die gefundenen Treffer an. Die automatisch eingetragenen Links ermöglichen dem Benutzer die gefundenen Dokumente zu laden. Gibt es Treffer in unteren Dokumentebenen, z. B. in einem Unterkapitel eines Dokuments, so können - zur besseren Orientierung innerhalb der Trefferliste die übergeordneten Dokumentebenen dargestellt werden. Es besteht die Möglichkeit - bei einer grossen Trefferanzahl - die Trefferliste in mehreren Trefferseiten darzustellen.

Das Kontextobjekt 'hitlist' wird zur Aufbereitung und Konfiguration der Trefferliste verwendet. Die folgenden Funktionen werden unterstützt:

• Funktion: $hitlist.hits

  Datentyp: Iterator

  Funktion erzeugt eine Liste der gefundenen Treffer. Mit einer foreach-Schleife kann man die einzelnen Treffer aus der Liste ansprechen.

  Beispiel:

  ...
  #foreach $hit in $hitlist.hits
   <td>
   #set $selection = "Attribut1,Attribut2,Attribut3"
   #foreach $a in $hit.attributes($selection)
     <b>$a.label</b>: $a.value <br>
   #end
   </td>
   ...
  #end
  ...
  

   

• Funktion: $hitlist.numofpages

  Datentyp: Integer

  Funktion liefert die Anzahl der Trefferseiten. Mit '$hitlist.numofpages' kann z. B. die Navigationsleiste gesteuert werden.

  Beispiel:

  ...
  #if ($hitlist.numofpages > 1)
    <div class="hl_info">#HitlistNavigationBar()
    </div>
  #end...
  

   

• Funktion: $hitlist.totalhits

  Datentyp: Integer

  '$hitlist.totalhits' beinhaltet die Gesamtanzahl aller gefundenen Treffer. In der Trefferliste kann sie folgendermaßen ausgegeben werden:

  Beispiel:

  ...
    #if (!$hitlist)
      <div class="textnohits">Es liegt kein Suchergebnis vor!</div>
    #elseif ($hitlist.totalhits == 0)
      <div class="textnohits">Ihre Suche ergab keinen Treffer!</div>
    #else
      <div>
        <tr><td>Ihre Suche ergab <b>$hitlist.totalhits</b> Treffer</td></tr>
        <tr><td id="3" colspan="3"></td></tr>
   ...     
  

   

• Funktionen: $hitlist.starthit und $hitlist.endhit

  Datentyp: Integer

  '$hitlist.starthit' enthält die erste Treffernummer der aktuellen Trefferseite. Zusammen mit '$hitlist.endhit' kann man z.B. den Treffermengenbereiche pro Trefferseite ausgeben:

  Beispiel:

  ...
  #if ($hitlist.totalhits > 0)
    <div>Ergebnisse:
      $hitlist.starthit - $hitlist.endhit</div>
    ...
  #end
   ...     
  

   

• Funktion: $hitlist.pagenums

  Datentyp: Integer

  '$hitlist.pagenums' enthält die Anzahl der Trefferseiten. Die Navigationsleiste der Trefferseiten kann mit '$hitlist.pagenums' modifiziert werden. Z. B. indem man in einer foreach-Schleife alle Werte durchgeht.

  Beispiel:

  ...
  #foreach $pagenum in $hitlist.pagenums
    #if ($hitlist.curpage == $pagenum)
      <b>$pagenum</b> | 
    #else
      <a href="$link.hitpage("hitlist2", $pagenum)">$pagenum</a> | 
    #end
  #end
   ...     
  

   

• Funktion: $hitlist.curpage

  Datentyp: Integer

  '$hitlist.curpage' enthält die aktuelle Trefferseite. Der Wert kann verwendet werden um die Navigationsleiste zu modifizieren'

  Beispiel:

  ...
  #if ($hitlist.curpage + 1 <= $hitlist.numofpages)
     <a href="$link.hitpage("hitlist2", $hitlist.curpage+1)">Weiter</a>
  #else
     Weiter
  #end
   ...     
  

   

• Funktion: $hitlist.searchdesc

  Datentyp: String

  '$hitlist.searchdesc' speichert die Suchanfrage des Benutzers. Die Variable wird verwendet, um in der Trefferliste anzuzeigen, was gesucht worden ist.

  Beispiel:

  ...
  <td valign="top" class="heading">Suchanfrage:</td>
  <td>#if ($hitlist.searchdesc) $hitlist.searchdesc #end</td>
   ...     
  

   

• Funktion: $hitlist.searchtime

  Datentyp: String

  '$hitlist.searchtime' speichert die Dauer der Suchanfrage. Diese Zeitangabe kann in der Trefferliste zusätzlich mitausgegeben werden.

  Beispiel:

  ...
  <td valign="top">Bearbeitungszeit:</td>
  <td width="100%">$hitlist.searchtime Sekunden</td>
   ...     
  

   

Weiteres Anwendungsbeispiel zur Trefferliste:

Die Trefferliste soll mit den Angaben des ersten und letzten Treffers der aktuellen Seite ($hitlist.starthit und $hitlist.endhit), mit der Gesamtzahl der Treffer ($hitlist.totalhits), mit dem Inhalt der Suche ($hitlist.searchdesc) und mit der Bearbeitungszeit ($hitlist.searchtime) eingeleitet werden, so daß die Anzeige im Browser etwa folgendermaßen aussehen könnte:

Hitlist

Die entsprechende Notation im Template müßte dann so aussehen:

...
<div id="Info">
  <table width="100%">
	  <tr>
		  <td valign="top">Treffer:</td>
		  <td>$hitlist.starthit - $hitlist.endhit von $numofhits</td>
	  </tr>
	  <tr>
		  <td valign="top">Suchanfrage:</td>
		  <td>$hitlist.searchdesc</td>
	  </tr>
	  <tr>
		  <td valign="top">Bearbeitungszeit:
		  <td>$hitlist.searchtime s</td>
	  </tr>
  </table>
</div>
 ...