PEIQ Knowledge Base
Mitwirkungspflichten: [0-17] Livingdocs API - Artikelvorlagen und Autor:innen
- Violetta Stegen
- Melanie Lutz
- Daniela Nguyen
Die Dokumentation zu dieser Schnittstelle befindet sich hier: [0-17] INBOUND Schnittstelle zu Livingdocs API | Artikel mit Bilder.
Funktionalitäten der Artikelvorlagen und Autor:innen bei Livingdocs-Artikeln
Verwendung der Logik für ASSIST
Verwendung unterschiedlicher Vorlagen beim Import von Livingdocs-Artikeln z. B. abhängig vom Formatnamen
Einlaufen der Autor:innen an unterschiedlichen Stellen des Artikels (z. B. Anfang oder Ende des Text-Bereichs) bspw. abhängig vom Formatnamen
Inhaltsverzeichnis
Allgemeine Beschreibung
Vorlagen
Standardmäßig sind zwei oder vier Vorlagen hinterlegt, in denen die Livingdocs-Artikel in PRINT NGEN einlaufen.
Wird die Infobox-Logik nicht genutzt, gib es insgesamt zwei Vorlagen: eine Vorlage, die einen Bildbereich enthält sowie eine zweite Vorlage, die keine Bildbereiche enthält. Die Livingdocs-Artikel ohne Bilder laufen in die Vorlage ohne Bildbereiche ein während die Livingdocs-Artikel mit Bildern in die Artikel-Vorlage mit einem Bildbereich einlaufen. Enthält der Artikel mehr als ein Bild, wird nur das erste Bild im Bildbereich platziert. Alle anderen Bilder sind am Artikel referenziert und stehen als Alternativ-Bilder zur Verfügung.
Wird die Infobox-Logik genutzt, gibt es zusätzlich zwei weitere Vorlagen für die Infobox-Artikel. Auch hier steht eine Vorlage mit und eine Vorlage ohne Bildbereich zur Verfügung.
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:
“LD_Standard_mit_Bild” für die Artikel mit Bildern
“LD_Standard_ohne_Bild” für die Artikel ohne Bilder
“LD_Infobox_mit_Bild” für Infoboxen mit Bildern
“LD_Infobox_ohne_Bild” für Infoboxen ohne Bilder
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.
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.
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 (tatsä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.
DOKUMENT 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.