Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Die Dokumentation zu dieser Schnittstelle befindet sich hier: [0-17] INBOUND Schnittstelle zu Living-Docs Livingdocs API | Artikel mit Bilder.

...

Expand
titleInhaltsverzeichnis anzeigen
Table of Contents
maxLevel4

Allgemeine Beschreibung

Vorlagen

Standardmäßig sind zwei oder vier Vorlagen hinterlegt, in denen die Livingdocs-Artikel in PRINT NGEN einlaufen.

...

Abzustimmender Ausnahmefall: Wird z. B. die Logik genutzt, dass die Livingdocs-Artikel mit unterschiedlichen Formatnamen in PRINT NGEN einlaufen, kann es sinnvoll sein, für die unterschiedlichen Formatnamen auch jeweils unterschiedliche Vorlagen zu verwenden.

Vorlagennamen

Per Default greifen aus einer Master-Layout-Bibliothek die Vorlagen mit folgenden Namen:

...

Sollen kundenspezifische Vorlagen greifen, werden diese auf Anfrage hin in einer kundenspezifischen Layout-Bibliothek “IMPORT_Livingdocs_<Kundenkürzel/Objektkürzel>” erstellt. Die Namensgebung der kundenspezifischen Vorlagen erfolgt analog zu den Master-Vorlagen nach dem Muster “LD_<FormatName>_<mit/ohne>_Bild”.

Autor:innen

Standardmäßig laufen die Autor:innen im “Autor”-Tag am Anfang des Text-Bereichs in PRINT NGEN ein.

Abzustimmender Ausnahmefall: Je nach gewählter Vorlage kann es sinnvoll sein, dass der/die Autor:in z. B. nicht am Anfang des Text-Bereichs, sondern am Ende einläuft oder statt als Tag im “AutorBereich”.

Autor:innenkürzel

Standardmäßig laufen die Autor:innenkürzel im “Kuerzel”-Tag am Ende des Text-Bereichs in PRINT NGEN ein.

Abzustimmender Ausnahmefall: Je nach gewählter Vorlage kann es sinnvoll sein, dass das Autor:innenkürzel z. B. nicht am Ende des Text-Bereichs, sondern am Anfang einläuft oder komplett wegfällt.

Steuerung der Autor:in-Position

Je nach dem, ob das Feld "content": { component: "head" oder: "header", content: { "author" }} bzw. "content": { component: "head" oder: "header", content: { "authorShortnames" }} im JSON befüllt ist, läuft der/die Autor:in per Default im “Autor”-Tag am Anfang des Text-Bereichs bzw. im “Kuerzel”-Tag am Ende des Text-Bereichs in PRINT NGEN ein.

Abzustimmender Ausnahmefall:

Je nach gewählter Vorlage kann es sinnvoll sein, dass das Autor:innenkürzel z. B. nicht am Ende des Text-Bereichs, sondern am Anfang einläuft oder komplett wegfällt.

Zudem kann ein Artikel für mehrere Ausgaben und in diesen Ausgaben für unterschiedliche FormatNamen vorgesehen sein. Für die verschiedenen Ausgaben bzw. FormatNamen kann eine unterschiedliche Position des/der Autor:in sinnvoll sein. In diesem Fall kann die Logik zur “AutorPosition” über das JSON-Feld "metadata": { "publications" oder: "publication": [{"authorPosition”}] eingeführt werden.

Mögliche Werte für die “AutorPosition” (im JSON “authorPosition”) sind:

  • AutorBereich → Vor- und Nachname des/der Autor:in im AutorBereich des Artikels

  • AutorAnfang → Vor- und Nachname des/der Autor:in im Autor-Tag am Anfang des Text-Bereichs des Artikels

  • KuerzelAnfang → Kürzel des/der Autor:in im Kuerzel-Tag am Anfang des Text-Bereichs des Artikels

  • KuerzelEnde → Kürzel des/der Autor:in im Kuerzel-Tag am Ende des Text-Bereichs vor dem letzten Absatzende des Artikels

  • OhneAutor → weder Vor- und Nachname, noch Kürzel des/der Autor:in im Artikel

Für die verschiedenen Positionen des/der Autor:in werden ggf. verschiedene Vorlagen benötigt, d.h. eine Vorlage mit AutorBereich und eine Vorlage ohne AutorBereich. Die Vorlage ohne AutorBereich erhält dann den Default-Namen “LD_<FormatName>_<mit/ohne>_Bild”. Die Vorlage mit AutorBereich erhält den Namen “LD_<FormatName>_mit_AutorBereich_<mit/ohne>_Bild”

Wichtig: Drittsystem-seitig muss sichergestellt sein, dass nie “AutorBereich” als AutorPosition übergeben wird, wenn der Artikel gar keinen Autor hat oder der Vor- und Nachname des/der Autor:in nicht mitkommt. In diesen Fällen sollte “OhneAutor” als Position übergeben werden. Andernfalls kann es zu einem Fehler in Assist kommen, dass ein leerer AutorBereich im Artikel enthalten ist.

Hinweis: Wird nach dem Einlaufen eines Artikels am Artikel in PRINT NGEN der FormatName geändert, ändert sich damit nicht die Position des Autors. Beispiel: Bei einem Kunden ist bei Randspaltern der/die Autor:in immer als KuerzelEnde platziert, bei Standard-Artikeln als AutorBereich, wenn im JSON die Position “AutorBereich” mitgegeben wurde. Wird in diesem Fall vom Standard-Artikel in einen Randspalter gewechselt, bleibt im XML des Artikels der nun ausgeblendete AutorBereich enthalten. Ein Kuerzel-Tag am Ende des Text-Bereichs muss bei Bedarf manuell im Randspalter eingefügt werden.

Mitwirkungen

Sollen mehr als die im Standard vorgesehenen zwei bzw. vier Vorlagen verwendet werden oder die Autor:innen oder Autor:innenkürzel an einer anderen Stelle als standardmäßig vorgesehen einlaufen, wird folgende Tabelle ausgefüllt benötigt:

Objekt

Ausgabe

Ressort

Formatname in PRINT NGEN

AutorPosition (im JSON: authorPosition)

Anzahl Bilder

Infobox (ja/nein)

Vorlage

Autor:in in PRINT NGEN (“Autor”-Tag und Position, “AutorBereich”, “Kuerzel”-Tag und Positiontatsächliche Position im NGEN Artikel: AutorAnfang, AutorBereich, KuerzelAnfang, KuerzelEnde, OhneAutor)

Es können auch Sternchen “*” angegeben werden, wenn z. B. für alle Ausgaben, alle Ressorts das Gleiche gilt.

Status
titleDOKUMENT BEREITSTELLEN

Testing

Nach der Einrichtung durch PEIQ sind kund:innenseitig eigenständige Tests in den dafür vorbereiteten Umgebungen durchzuführen. Insbesondere ist zu testen, ob immer die richtige Vorlage verwendet wird und der/die Autor:in und das Autor:innenkürzel an der richtigen Position einläuft.

Standard-Werte

Standardmäßig sind zwei oder vier Vorlagen hinterlegt, in denen die Livingdocs-Artikel in PRINT NGEN einlaufen.

Darüber hinaus laufen die Autor:innen standardmäßig im “Autor”-Tag am Anfang (mit anschließendem Absatz) und das Autor:innenkürzel im “Kuerzel”-Tag am Ende des Text-Bereichs (ohne vorherigen Absatz) in PRINT NGEN ein.

Einrichtung durch Kund:innen

Die Einrichtung übernimmt PEIQ.

Verwandte Seiten

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "livingdocs" and space = "PPSD"

...