bx:websearch
Dieses Tag ermöglicht die Darstellung von Suchergebnissen der Webseite. Die Suche ist über die Funktionen des Jakarta Lucene Projektes realisiert worden. Das Web muss vorher indiziert worden sein.
Zum Ausklammern von Bereichen aus der Suche verwendet man bx:scanner
Funktionen:
Eingabefeld
<bx:websearch.input />
Es wird ein Text-Inputfeld erzeugt, welches in Suchformularen verwendet werden kann. Falls schon eine Suche stattgefunden hat, enthält das Feld den Suchtext.
Hauptschleife
<bx:websearch [max="{n}"] [maxparam="{paramname}"] [indexparam="index"]> Inhalt </bx:websearch>
Dieses Tag bildet die Hauptschleife um die Suchergebnisse.
Zur Verwendung im Inhalt stehen die nun folgenden Tags bereit.
Bisher mußte der Blätterparameter „index“ heißen. Und bei den Containerfiltern (Teasern) in der Seite mußte man indexparam auf etwas anderes setzen. Nun kann der Parametername selbst definiert werden.
bx:websearch.previous|next|firstshown|lastshown lesen den neuen Parameter von der bx:websearch-Schleife und verlinken jetzt mit diesen Namen.
| max |
maximale Anzahl an Ausgaben |
| maxparam |
Request-Parameter, der den Zahlenwert für den Überlauf enthält
* (ab Version 2.5.9)* |
| indexparam |
Name des Blätterparameters |
websearch.title
<bx:websearch.title/>
gibt den Titel der Seite (
HTML-Tag) oder, falls dieser nicht existiert, "<ohne Titel>" aus
<h2 id="bkmrk-websearch.rank">websearch.rank</h2>
<pre><code class="language-xml"><bx:websearch.rank/>
</code></pre>
<p>Rangfolge des Ergebnisses, beginnend mit 1</p>
<pre><code>
</code></pre>
<h2 id="bkmrk-websearch.score">websearch.score</h2>
<pre><code class="language-xml"><bx:websearch.score/>
</code></pre>
<p>die Wertung des Suchergebnisses als Gleitkommazahl</p>
<h2 id="bkmrk-websearch.relevanz">websearch.relevanz</h2>
<pre><code class="language-xml"><bx:websearch.relevanz/>
</code></pre>
<p>eine Wertung des Ergebnisses als Ganzzahl mit Prozentzeichen</p>
<h2 id="bkmrk-websearch.stars">websearch.stars</h2>
<pre><code class="language-xml"><bx:websearch.stars [max="<n>"]> Inhalt </bx:websearch.stars>
</code></pre>
<p>Symbole als Relevanzanzeige ausgeben</p>
<table>
<thead>
<tr>
<th>max</th>
<th>maximale Anzahl an Symbolen (Standard: 5)<br>Der Inhalt bestimmt das Symbol, er kann z.B. ein<br><a href="http://wiki.batix.net/index.php/Bx:bild" target="_blank">bx:bild</a><br>-Tag enthalten</th>
</tr>
</thead>
</table>
<h2 id="bkmrk-websearch.link">websearch.link</h2>
<pre><code class="language-xml"><bx:websearch.link> Inhalt </bx:websearch.link>
<bx:websearch.link />
</code></pre>
<p>verlinkt den Inhalt mit der Fundstelle. Als geschlossenes Tag wird die URL verlinkt <em>(ab Version 2.5.9)</em></p>
<h2 id="bkmrk-websearch.url">websearch.url</h2>
<pre><code class="language-xml"><bx:websearch.url/>
</code></pre>
<p>gibt die URL der Fundstelle an. <em>ab Version 2.5.8</em></p>
<h2 id="bkmrk-websearch.path">websearch.path</h2>
<pre><code class="language-xml"><bx:websearch.path/>
</code></pre>
<p>gibt den Pfad zur Fundstelle an. Es handelt sich um die URL, deren Hostname abgeschnitten wurde. <em>ab Version 2.5.9</em></p>
<h2 id="bkmrk-websearch.descriptio">websearch.description</h2>
<pre><code class="language-xml"><bx:websearch.description/>
</code></pre>
<p>die Beschreibung des Dokuments (HTML <meta> Wert "description")</p>
<pre><code>
</code></pre>
<h2 id="bkmrk-websearch.navname">websearch.navname</h2>
<pre><code class="language-xml"><bx:websearch.navname/>
</code></pre>
<p>der Name des entsprechenden Navigationspunktes</p>
<h2 id="bkmrk-websearch.navid">websearch.navid</h2>
<pre><code class="language-xml"><bx:websearch.navid/>
</code></pre>
<p>die ID des entsprechenden Navigationspunktes</p>
<h2 id="bkmrk-websearch.previous">websearch.previous</h2>
<pre><code class="language-xml"><bx:websearch.previous [hide] [url="{link}"] />
<bx:websearch.previous [hide] [url="{link}"]> Linktext </bx:websearch.previous>
</code></pre>
<p>(steht außerhalb der Schleife) einen Link zur vorigen Ergebnisseite generieren</p>
<table>
<thead>
<tr>
<th>hide</th>
<th>es wird nichts ausgegeben wird, wenn es keine nächste Seite gibt</th>
</tr>
</thead>
<tbody>
<tr>
<td>url</td>
<td>Ziel-Dateiname festlegen (Standard ist die aktuelle Seite)</td>
</tr>
<tr>
<td>Linktext</td>
<td>Ein Linktext kann als Tag-Inhalt angegeben werden (Standard: "weiter >>").</td>
</tr>
</tbody>
</table>
<h2 id="bkmrk-websearch.next">websearch.next</h2>
<pre><code class="language-xml"><bx:websearch.next [hide] [url="{link}"] />
<bx:websearch.next [hide] [url="{link}"]> Linktext </bx:websearch.next>
</code></pre>
<p>(steht außerhalb der Schleife) einen Link zur nächsten Ergebnisseite generieren
<strong>Parameter: siehe unter websearch.previous</strong></p>
<h2 id="bkmrk-websearch.totalhits">websearch.totalhits</h2>
<pre><code class="language-xml"><bx:websearch.totalhits/>
</code></pre>
<p>(steht außerhalb der Schleife) Gesamtzahl der Ergebnisse</p>
<h2 id="bkmrk-websearch.firstshown">websearch.firstshown</h2>
<pre><code class="language-xml"><bx:websearch.firstshown/>
</code></pre>
<p>(steht außerhalb der Schleife) Nummer des ersten Ergebnisses auf der Seite</p>
<h2 id="bkmrk-websearch.lastshown">websearch.lastshown</h2>
<pre><code class="language-xml"><bx:websearch.lastshown/>
</code></pre>
<p>(steht außerhalb der Schleife) Nummer des letzten Ergebnisses auf der Seite</p>
<h2 id="bkmrk-websearch.query">websearch.query</h2>
<pre><code class="language-xml"><bx:websearch.query encode="typ"/>
</code></pre>
<p>(steht außerhalb der Schleife) der Begriff/Text, nach dem gesucht wurde</p>
<table>
<thead>
<tr>
<th>encode</th>
<th>Hiermit kann der ausgegebene Text für verschiedene Formate kodiert werden:<br>- html - javascript - sql (zur Verwendung in SQL für Strings) - sql-like (zur Verwendung in SQL mit LIKE) - sql-rlike (zur Verwendung in SQL mit RLIKE und REGEXP) - url - xml</th>
</tr>
</thead>
</table>
<h2 id="bkmrk-websearch.if">websearch.if</h2>
<pre><code class="language-xml"><bx:websearch.if [not] [empty | scrollable | morethan="<n>" | lessthan="<n>"] > Inhalt </bx:websearch.if>
</code></pre>
<p>(steht außerhalb der Schleife) zeigt Inhalt nur unter bestimmten Bedingungen an. Nur, wenn Suche bereits stattgefunden hat:
(Falls keiner der vier Parameter angegeben wurde, erfolgt die Ausgabe nur, wenn bereits eine Suche erfolgt ist (oder auch nich, bei <code>not</code>). )</p>
<table>
<thead>
<tr>
<th>empty</th>
<th>es wurden keine Suchergebnisse gefunden<br>darf auch innerhalb der Schleife verwendet werden. Um das Gegenteil abzufragen, wird<br><code>not</code><br>verwendet.</th>
</tr>
</thead>
<tbody>
<tr>
<td>scrollable</td>
<td>es sind mehr Seiten vorhanden (Anzahl Ergebnisse ><br><code>max</code><br>)</td>
</tr>
<tr>
<td>morethan<br>lessthan</td>
<td>es wurden mehr als<br><code><n></code><br>Ergebnisse gefunden<br>es wurden weniger als<br><code><n></code><br>Ergebnisse gefunden</td>
</tr>
</tbody>
</table>
<h2 id="bkmrk-eingabefeld-1">Eingabefeld</h2>
<pre><code class="language-xml"><bx:websearch.input />
</code></pre>
<p>Es wird ein Text-Inputfeld erzeugt, welches in Suchformularen verwendet werden kann. Falls schon eine Suche stattgefunden hat, enthält das Feld den Suchtext.</p>
<h3 id="bkmrk-beispiele">Beispiele</h3>
<p><strong>Beispiel Titel</strong></p>
<pre><code class="language-xml"><bx:tag.feature param="value" />
</code></pre>
<p>Weitere Beispiele unter <a href="/books/cms-handbuch-entwickler/page/websuche">Snippets/Websuche</a>.</p>
