itemprop

Das itemprop globale Attribut wird verwendet, um einem Element Eigenschaften hinzuzufügen. Jedes HTML-Element kann ein itemprop-Attribut haben, das aus einem Namen-Wert-Paar besteht. Jedes Namen-Wert-Paar wird als Eigenschaft bezeichnet, und eine Gruppe von einer oder mehreren Eigenschaften bildet ein Element. Eigenschaftswerte sind entweder ein String oder eine URL und können mit einer sehr breiten Palette von Elementen verbunden sein, einschließlich <audio>, <embed>, <iframe>, <img>, <link>, <object>, <source>, <track> und <video>.

Beispiele

Das folgende Beispiel zeigt den Quellcode für eine Reihe von Elementen, die mit itemprop-Attributen versehen sind, gefolgt von einer Tabelle, die die resultierenden strukturierten Daten zeigt.

HTML

html
<div itemscope itemtype="http://schema.org/Movie">
  <h1 itemprop="name">Avatar</h1>
  <span>
    Director:
    <span itemprop="director">James Cameron</span>
    (born August 16, 1954)
  </span>
  <span itemprop="genre">Science fiction</span>
  <a href="../movies/avatar-theatrical-trailer.html" itemprop="trailer">
    Trailer
  </a>
</div>

Strukturierte Daten

Element
itemprop-Name itemprop-Wert
itemprop name Avatar
itemprop director James Cameron
itemprop genre Science fiction
itemprop trailer ../movies/avatar-theatrical-trailer.html

Eigenschaften

Eigenschaften haben Werte, die entweder ein String oder eine URL sind. Wenn ein Stringwert eine URL ist, wird er mit dem <a>-Element und seinem href-Attribut ausgedrückt, mit dem <img>-Element und seinem src-Attribut oder mit anderen Elementen, die zu externen Ressourcen verlinken oder einbetten.

Drei Eigenschaften mit Werten, die Strings sind

html
<div itemscope>
  <p>My name is <span itemprop="name">Neil</span>.</p>
  <p>My band is called <span itemprop="band">Four Parts Water</span>.</p>
  <p>I am <span itemprop="nationality">British</span>.</p>
</div>

Eine Eigenschaft, "image", deren Wert eine URL ist

html
<div itemscope>
  <img itemprop="image" src="google-logo.png" alt="Google" />
</div>

Wenn ein Stringwert nicht leicht von einer Person gelesen und verstanden werden kann (z. B. eine lange Zeichenkette von Zahlen und Buchstaben), kann er mit dem Wertattribut des Daten-Elements angezeigt werden, wobei die für Menschen besser verständliche Version im Inhalt des Elements angegeben wird (die nicht Teil der strukturierten Daten ist - siehe Beispiel unten).

Ein Element mit einer Eigenschaft, deren Wert eine Produkt-ID ist

Die ID ist nicht benutzerfreundlich, daher wird stattdessen der Name des Produkts verwendet.

html
<h1 itemscope>
  <data itemprop="product-id" value="9678AOU879">The Instigator 2000</data>
</h1>

Für numerische Daten können das Meter-Element und sein Wertattribut verwendet werden.

Ein Meter-Element

html
<div itemscope itemtype="http://schema.org/Product">
  <span itemprop="name">Panasonic White 60L Refrigerator</span>
  <img src="panasonic-fridge-60l-white.jpg" alt="" />
  <div
    itemprop="aggregateRating"
    itemscope
    itemtype="http://schema.org/AggregateRating">
    <meter itemprop="ratingValue" min="0" value="3.5" max="5">
      Rated 3.5/5
    </meter>
    (based on <span itemprop="reviewCount">11</span>
    customer reviews)
  </div>
</div>

Ähnlich können für daten- und zeitbezogene Daten das Time-Element und sein Datetime-Attribut verwendet werden.

Ein Element mit einer Eigenschaft "birthday", deren Wert ein Datum ist

html
<div itemscope>
  I was born on
  <time itemprop="birthday" datetime="1984-05-10">May 10th 1984</time>.
</div>

Eigenschaften können auch Gruppen von Namen-Wert-Paaren sein, indem das Itemskope-Attribut auf das Element gesetzt wird, das die Eigenschaft deklariert. Jeder Wert ist entweder ein String oder eine Gruppe von Namen-Wert-Paaren (d. h. ein Element).

Ein äußeres Element, das eine Person darstellt, und ein inneres, das eine Band darstellt

html
<div itemscope>
  <p>Name: <span itemprop="name">Amanda</span></p>
  <p>
    Band:
    <span itemprop="band" itemscope>
      <span itemprop="name">Jazz Band</span>
      (<span itemprop="size">12</span> players)
    </span>
  </p>
</div>

Das oben angezeigte äußere Element hat zwei Eigenschaften, "name" und "band". Der "name" ist "Amanda", und die "band" ist ein eigenes Element mit zwei Eigenschaften, "name" und "size". Der "name" der Band ist "Jazz Band", und die "size" ist "12". Das äußere Element in diesem Beispiel ist ein Top-Level-Microdata-Element. Elemente, die keine Teile anderer Elemente sind, werden als Top-Level-Microdata-Elemente bezeichnet.

Alle Eigenschaften getrennt von ihren Elementen

Dieses Beispiel ist dasselbe wie das vorherige, aber alle Eigenschaften sind von ihren Elementen getrennt.

html
<div itemscope id="amanda" itemref="a b"></div>
<p id="a">Name: <span itemprop="name">Amanda</span></p>
<div id="b" itemprop="band" itemscope itemref="c"></div>
<div id="c">
  <p>Band: <span itemprop="name">Jazz Band</span></p>
  <p>Size: <span itemprop="size">12</span> players</p>
</div>

Es ergibt dasselbe Ergebnis wie das vorherige Beispiel. Das erste Element hat zwei Eigenschaften, "name", gesetzt auf "Amanda", und "band", gesetzt auf ein anderes Element. Dieses zweite Element hat zwei weitere Eigenschaften, "name", gesetzt auf "Jazz Band", und "size", gesetzt auf "12".

Ein Element kann mehrere Eigenschaften mit demselben Namen und unterschiedlichen Werten haben.

Eiscreme mit zwei Geschmacksrichtungen

html
<div itemscope>
  <p>Flavors in my favorite ice cream:</p>
  <ul>
    <li itemprop="flavor">Lemon sorbet</li>
    <li itemprop="flavor">Apricot sorbet</li>
  </ul>
</div>

Dies ergibt ein Element mit zwei Eigenschaften, beide mit dem Namen "flavor" und den Werten "Lemon sorbet" und "Apricot sorbet".

Ein Element, das eine Eigenschaft einführt, kann auch mehrere Eigenschaften gleichzeitig einführen, um eine Duplizierung zu vermeiden, wenn einige der Eigenschaften denselben Wert haben.

Ein Element mit zwei Eigenschaften, "favorite-color" und "favorite-fruit", beide auf den Wert "orange" gesetzt

html
<div itemscope>
  <span
    itemprop="favorite-color
    favorite-fruit"
    >orange
  </span>
</div>

Hinweis: Es besteht keine Beziehung zwischen den Microdaten und dem Inhalt des Dokuments, in dem die Microdaten markiert sind.

Dieselben strukturierten Daten in zwei verschiedenen Weisen markiert

Es gibt keinen semantischen Unterschied zwischen den folgenden beiden Beispielen

html
<figure>
  <img src="castle.jpeg" />
  <figcaption>
    <span itemscope><span itemprop="name">The Castle</span></span> (1986)
  </figcaption>
</figure>
html
<span itemscope><meta itemprop="name" content="The Castle" /></span>
<figure>
  <img src="castle.jpeg" />
  <figcaption>The Castle (1986)</figcaption>
</figure>

Beide haben eine Figur mit einer Überschrift und beide haben ein Element mit einem Namen-Wert-Paar mit dem Namen "name" und dem Wert "The Castle", das komplett von der Figur unabhängig ist. Der einzige Unterschied ist, dass, wenn der Benutzer die Bildunterschrift aus dem Dokument herauszieht, das Element in den Drag-and-Drop-Daten enthalten sein wird. Das mit dem Element verbundene Bild wird nicht enthalten sein.

Namen und Werte

Eine Eigenschaft ist eine ungeordnete Menge von einzigartigen Token, die case-sensitiv sind und die Namen-Wert-Paare darstellen. Der Eigenschaftswert muss mindestens ein Token haben. Im folgenden Beispiel ist jede Datenzelle ein Token.

Namensbeispiele

Element
itemprop Name itemprop Wert
itemprop country Ireland
itemprop Option 2
itemprop https://www.flickr.com/photos/nlireland/6992065114/ Ring of Kerry
itemprop img https://www.flickr.com/photos/nlireland/6992065114/
itemprop website flickr
itemprop (token) (token)

Token sind entweder Strings oder URLs. Ein Element wird als typisiertes Element bezeichnet, wenn es sich um eine URL handelt. Ansonsten ist es ein String. Strings dürfen keinen Punkt oder Doppelpunkt enthalten (siehe unten).

  1. Wenn das Element ein typisiertes Element ist, muss es entweder sein:

    1. Ein definierter Eigenschaftenname, oder
    2. Eine gültige URL, die sich auf die Vokabeldefinition bezieht, oder
    3. Eine gültige URL, die als proprietärer Eigentumsname des Elements verwendet wird (d. h. einer, der nicht in einer öffentlichen Spezifikation definiert ist), oder
  2. Wenn das Element kein typisiertes Element ist, muss es sein:

    1. Ein String, der keine . (U+002E FULL STOP) Zeichen und keine : Zeichen (U+003A COLON) enthält und als proprietärer Eigentumsname des Elements verwendet wird (wiederum einer, der nicht in einer öffentlichen Spezifikation definiert ist).

Hinweis: Die obigen Regeln schließen ":"-Zeichen in Nicht-URL-Werten aus, weil sie sonst nicht von URLs unterschieden werden könnten. Werte mit "."-Zeichen sind für zukünftige Erweiterungen reserviert. Leerzeichen sind nicht erlaubt, da sonst die Werte als mehrere Token analysiert würden.

Werte

Der Eigenschaftswert eines Namen-Wert-Paares wird für den ersten passenden Fall in der folgenden Liste festgelegt:

  • Wenn das Element ein itemscope-Attribut hat

    • Der Wert ist das Element, das durch das Element erstellt wird
  • Wenn das Element ein meta-Element ist

    • Der Wert ist der Wert des content-Attributs des Elements
  • Wenn das Element ein audio, embed, iframe, img, source, track oder video-Element ist

    • Der Wert ist die resultierende URL-Zeichenkette, die durch das Parsen des Werts des src-Attributs des Elements relativ zum Knoten-Dokument (Teil der Microdata DOM API) des Elements zum Zeitpunkt der Festlegung des Attributs entsteht
  • Wenn das Element ein a, area oder link-Element ist

    • Der Wert ist die resultierende URL-Zeichenkette, die durch das Parsen des Werts des href-Attributs des Elements relativ zum Knoten-Dokument des Elements zum Zeitpunkt der Festlegung des Attributs entsteht
  • Wenn das Element ein object-Element ist

    • Der Wert ist die resultierende URL-Zeichenkette, die durch das Parsen des Werts des data-Attributs des Elements relativ zum Knoten-Dokument des Elements zum Zeitpunkt der Festlegung des Attributs entsteht
  • Wenn das Element ein data-Element ist

    • Der Wert ist der Wert des value-Attributs des Elements
  • Wenn das Element ein meter-Element ist

    • Der Wert ist der Wert des value-Attributs des Elements
  • Wenn das Element ein time-Element ist

    • Der Wert ist der datetime-Wert des Elements

Andernfalls

  • Der Wert ist der textContent des Elements.

Wenn der Wert einer Eigenschaft eine URL ist, muss die Eigenschaft unter Verwendung eines URL-Eigenschaftselements angegeben werden. Die URL-Eigenschaftselemente sind die a, area, audio, embed, iframe, img, link, object, source, track und video-Elemente.

Reihenfolge der Namen

Namen sind relativ zueinander ungeordnet, aber wenn ein bestimmter Name mehrere Werte hat, haben sie eine relative Reihenfolge.

Im folgenden Beispiel hat die "a"-Eigenschaft die Werte "1" und "2", in dieser Reihenfolge, aber ob die "a"-Eigenschaft vor der "b"-Eigenschaft kommt oder nicht, ist unwichtig.

html
<div itemscope>
  <p itemprop="a">1</p>
  <p itemprop="a">2</p>
  <p itemprop="b">test</p>
</div>

Hier sind mehrere äquivalente Beispiele:

html
<div itemscope>
  <p itemprop="b">test</p>
  <p itemprop="a">1</p>
  <p itemprop="a">2</p>
</div>
html
<div itemscope>
  <p itemprop="a">1</p>
  <p itemprop="b">test</p>
  <p itemprop="a">2</p>
</div>
html
<div id="x">
  <p itemprop="a">1</p>
</div>
<div itemscope itemref="x">
  <p itemprop="b">test</p>
  <p itemprop="a">2</p>
</div>

Darstellung von strukturierten Daten für ein Buch

Dieses Beispiel verwendet Microdata-Attribute, um die folgenden strukturierten Daten darzustellen:

itemscope itemtype: itemid https://schema.org/Book: urn:isbn:0-374-22848-5
itemprop title Owls of the Eastern Ice
itemprop author Jonathan C Slaght
itemprop datePublished 2020-08-04

HTML

html
<dl
  itemscope
  itemtype="https://schema.org/Book"
  itemid="urn:isbn:0-374-22848-5<">
  <dt>Title</dt>
  <dd itemprop="title">Owls of the Eastern Ice</dd>
  <dt>Author</dt>
  <dd itemprop="author">Jonathan C Slaght</dd>
  <dt>Publication date</dt>
  <dd>
    <time itemprop="datePublished" datetime="2020-08-04">August 4 2020</time>
  </dd>
</dl>

Ergebnis

Spezifikationen

Specification
HTML
# names:-the-itemprop-attribute

Siehe auch