Webparts für Inhaltssuche–Teil 3: Darstellung anpassen mit Displaytemplates

VonNico Thiemer SharePoint

SharePoint Display-Templates_AnzeigevorlagenDritter Beitrag zum Webpart für Inhaltssuche in SharePoint 2013: Nach dem Einstieg in die Konfiguration des Webparts und dem Gestalten der Suchabfrage geht es jetzt darum, wie wir die Suchanfrage optisch aufpeppen können. Prinzipiell stehen dafür bereits Vorlagen bereit, doch diese sind abgesehen von den Funktionen für Bilder eher technisch orientiert. Wir zeigen im Folgenden ein einfaches Anwendungsbeispiel, das das Prinzip vermittelt und schnell zur Umsetzung eigener Lösungen verhilft.

Die Vorlagen heißen Displaytemplates (deutsch: Anzeigevorlagen) und von diesen gibt es eine ganze Menge in SharePoint. Displaytemplates legen fest, wie einerseits die Anzeige der Suchergebnisse mit Tabellen, Listen oder Slideshows aussieht, sie steuern aber auch das Aussehen der einzelnen Elemente, also, welche Metadaten angezeigt werden oder wie groß ein Bild ist. Ebenso werden Anzeigevorlagen dafür genutzt, um die Vorschau beim Überfahren eines Elementes (Hover) darzustellen.

Für unser Beispiel passen wir eine bestehende Vorlage an und ergänzen diese. Im ersten Teil haben wir das Displaytemplate ‚Two Lines‘ verwendet, und dort zusätzlich das Metadatum Author eingefügt. Jetzt möchten wir erreichen, dass vor dem Metadatum der Begriff ‚Autor‘ steht. Folgende Schritte sind dafür notwendig:

clip_image0011. Zunächst das vorhandene Displaytemplate kopieren, um in der Kopie die Anpassung vorzunehmen. Zu finden sind die Displaytemplates im Pfad https:///_catalogs/masterpage/Display%20Templates. Es kann sein, dass dieser Pfad beziehungsweise sein Inhalt nicht immer im Browser sichtbar sind. In diesem Fall muss das SharePoint Publishingfeature aktiviert werden.

2. Um zum Pfad zu navigieren, gehen Sie zu den Site Settings (Websiteeinstellungen) und dann zu Master pages and page layouts im Abschnitt Web Designer Galleries. Auch diesen Link finden Sie erst nach der Aktivierung des Features. Sie sehen eine Bibliothek, in welcher alle Pagelayouts und Masterpages liegen, sowie einige Ordner. Suchen Sie den Ordner Display Templates und öffnen Sie diesen. Die Displaytemplates für den Webpart für Inhaltssuche liegen im Unterordner Content Web Parts. Dort finden Sie jetzt alle Displaytemplates , welche Sie auch im Webpart auswählen können.

3. Um die Arbeit mit den Vorlagen zu vereinfachen, öffnen Sie die Bibliothek im Windows Explorer. Klicken Sie dazu auf das Menüband Library und im Abschnitt Connect & Export auf Open with Explorer. Zusätzlich können Sie dem Pfad auch einen Laufwerkbuchstabe zuweisen. Das Bearbeiten geht prinzipiell mit jedem beliebigen HTML-Designer, denn die Vorlagen bestehen nur aus HTML und JavaScript. Beide zusammen bilden dann jeweils ein Displaytemplate.

4. Angepasst werden immer nur die HTML-Dateien, niemals die JS-Dateien. Die JS-Dateien werden von SharePoint automatisch erzeugt wenn eine HTML Datei gespeichert wird, sie sind für clip_image002die Bearbeitung tabu. Suchen Sie die Datei Item_TwoLines.html und kopieren Sie diese zu Item_TwoLines_with_Author.html. Sie werden sehen, dass unmittelbar danach auch die entsprechende JS Datei erstellt wird. In unserem Fall öffnen wir die kopierte HTML-Datei in Notepad++, aber natürlich geht auch jede beliebige anderer Editor. clip_image003

5. Es lohnt sich, die Datei einmal in Ruhe zu inspizieren. Sie zeigt viele Möglichkeiten auf, was sich mit Displaytemplates alles realisieren lässt. Wir bieten hier nur einen kleinen Abriss, um zu zeigen, wie man ein eigenes Displaytemplate modifizieren sollte. Als erstes ändern wir den Titel in Zeile drei. Unter diesen Namen können wir nämlich später das Displaytemplate im Webpart auswählen. Unschön wäre es, wenn wir zwei Anzeigevorlagen mit dem selben Namen vorfinden würden. Unseres nennen wir ‚TwoLines with Author‘.

<html xmlns:mso="urn:schemas-microsoft-com:office:office" xmlns:msdt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882">
<head>
&amp;lt;title&amp;gt;TwoLines with Author&amp;lt;/title&amp;gt;<span data-mce-type="bookmark" style="display: inline-block; width: 0px; overflow: hidden; line-height: 0;" class="mce_SELRES_start"></span>

6. Als nächstes interessiert uns die Zeile acht. Hier legen Sie fest, mit welchen verwalteten Eigenschaften Sie im Displaytemplate arbeiten möchten. Dabei gibt es immer ein Wertepaar, interne Bezeichnung der Eigenschaft und Anzeigename. Da in unseren Fall allerdings die Werte über Eingabefelder (Line1 und und Line2) übergeben werden, brauchen wir die Eigenschaften hier nicht extra zu benennen.

7. Es folgt einiger JavaScript Code, welcher in Token

[code language=“javascript“]&amp;lt;!–#_ _#–&amp;gt;

eingeschlossen ist. Die eigentliche Darstellung erfolgt erst ab Zeile 63. In Zeile 73 steht die Darstellung der zweiten Zeile.

[code language=“javascript“]

&amp;lt;div class="cbs-Line2 ms-noWrap" title="_#= $htmlEncode(line2.defaultValueRenderer(line2)) =#_" id="_#= line2Id =#_"&amp;gt;_#= line2 =#_&amp;lt;/div&amp;gt;

Wir können jetzt erkennen, dass hier sowohl reines HTML als auch JavaScript vermischt wird. Der JavaScript Code steht wieder in Token. Der Wert der Eigenschaft steht vor dem letzten Div in _#= line2 =#_ . Also ändere ich die Zeile folgendermaßen indem ich direkt davor Author schreibe:
Orginal


&amp;lt;div class="cbs-Line2 ms-noWrap" title="_#= $htmlEncode(line2.defaultValueRenderer(line2)) =#_" id="_#= line2Id =#_"&amp;gt;_#= line2 =#_&amp;lt;/div&amp;gt;

Mit Änderung

&amp;lt;div class="cbs-Line2 ms-noWrap" title="_#= $htmlEncode(line2.defaultValueRenderer(line2)) =#_" id="_#= line2Id =#_"&amp;gt;Author: _#= line2 =#_&amp;lt;/div&amp;gt;

Speichern Sie jetzt die Änderung.clip_image004

8. Achtung: Damit alle Benutzer die Änderung später sehen, muss das geänderte Displaytemplate noch veröffentlicht werden. Gehen Sie im Browser deshalb zur Bibliothek, markieren Sie die Datei und wählen Sie aus der Menüleiste Publish. Dieser Vorgang ist jedes Mal erforderlich, wenn Sie ein fertiges Displaytemplate zur Verfügung stellen wollen. Veröffentlichen Sie nur die HTML-Datei, um die JS-Datei kümmert sich SharePoint alleine. clip_image005

9. Damit Sie das neue Displaytemplate auswählen können, müssen Sie die Seite neu laden, die den Webpart für Inhaltssuche enthält, und diesen wieder zur Bearbeitung auswählen.

10. Unter Property Mappings können wir das Metadatum Author auswählen, welches dann auch in der zweiten Zeile zusammen mit dem Suffix angezeigt wird. Natürlich wird jetzt immer der Präfix Author angezeigt, aber als Beispiel soll es genügen.

Fazit

Das gezeigte soll nur als Beispiel dienen. Wenn man alles konsequent zu Ende denkt, kann auf diesem Weg eine Anwendung entstehen, wie sie beispielsweise clip_image006Maggi für Rezepte erstellt hat (https://www.maggi.de/rezepte). Die Rezepte arbeiten mit der Suche, die Präsentation der Suchergebnisse erfolgt mit Displaytemplates. .

Displaytemplates sind das  Mittel zur Wahl zur Präsentation von Inhalten in SharePoint. Auch, aber nicht nur deswegen sollte man überlegen, mehr Inhalte über die Suche zu erschließen und auf Drilldown- Strukturen weitgehend zu verzichten.

Latest posts by Nico Thiemer (see all)

Verwandte Beiträge:

  1. Die Top-5-Limits und Einschränkungen in SharePoint Online und OneDrive
  2. Was ist Microsoft SharePoint? Eine Anleitung für Einsteiger
  3. Microsoft plant intelligentere Versionsverwaltung für Dokumente in SharePoint Online und OneDrive
  4. Effizientere SharePoint-Architektur: Warum mehrere kleine Websites besser sind als eine große
  5. Metadaten effizient bearbeiten – das sind die Möglichkeiten in SharePoint Online

2 Comments

  1. Hallo Herr Thiemer,
    Gibt es eigentlich auch die Möglichkeit Suchergebnisse mehrspaltig anzeigen zu lassen? Ich suche schon sehr lange nach Beispielen konnte aber leider bisher noch nichts finden… haben sie eine Idee, die mir weiterhelfen könnte? Ich danke Ihnen für die Mühe!

    Viele Grüße
    Axel otto

Comments are closed.