Farben in Diagrammen

Legende Buyer Vom Buyer verwaltete Elemente BuyerCreated Vom Buyer erstellte Elemente Buyer->BuyerCreated BuyerModified Vom Buyer veränderte Elemente BuyerCreated->BuyerModified BuyerDeleted Vom Buyer gelöschte Elemente BuyerModified->BuyerDeleted Seller Vom Seller verwaltete Elemente SellerCreated Vom Seller erstellte Elemente Seller->SellerCreated SellerModified Vom Seller veränderte Elemente SellerCreated->SellerModified SellerDeleted Vom Seller gelöschte Elemente SellerModified->SellerDeleted

Es werden mehrere Navigations-Möglichkeiten von der Dokumentation bereitgestellt. Die Haupt-Navigation erfolgt über die links platzierte Navigationsspalte, die die wichtigsten Seiten zur Verfügung stellt. Auf vielen Unterseiten wird zusätzlich oben am Kopf der Navigationsspalte ein Link auf die übergeordnete Seite angeboten (“Höher”).

Zusätzlich wird eine Suche angeboten, mit der Seiten nach Stichwörtern durchforstet werden können.

Es wurde großen Wert darauf gelegt, die angebotenen Seiten untereinander zu verknüpfen. Neben den Links zu entsprechenden Seiten, gibt es noch zwei besondere Links:

  • Begriffe, die im Glossar aufgeführt sind, werden fett hinterlegt. Zum Beispiel Spot.
  • GraphQL-Elemente werden auf separaten Seiten genauer definitiert. Zum Beispiel RequestSpot.

Skalierung von Abbildungen

Im Text werden sehr große Abbildungen auf die Textbreite verkleinert. Abbildungen, die mit einem Klick auf sie vergrößert in einem separaten Fenster geöffnet werden, werden nur bis zu einem gewissen Grad verkleinert, da ansonsten die Beschriftungen in den Abbildungen nicht mehr gelesen werden können. Vertikal können diese Abbilden mittels des Mausrad verschoben werden, um auch verdeckte Teile sehen zu können. Um sie horizontal zu verschieben, muss zusätzlich die Strg-Taste gedrückt werden.

Callout-Boxen

Tipp Tipp:
Tipps zur Handhabung werden in grün angezeigt.

Info Hinweis:
Hinweis: Hinweise und Zusatzinformationen werden in blau dargestellt.

Status Aktueller Status
Der aktuelle Status wird in audioXchange-Magenta dargestellt.

Warning Warnung:
Warnungen und Hinweise zur besonderen Beachtung, werden in roten Boxen hervorgehoben.

Error (Möglicher) Fehler:
(Mögliche) Fehler und Unklarheiten in der Dokumentation.