Literaturlisten aus heiBIB in eigene Seiten integrieren: Technische Information

Allgemein
Drupal Webkits
Imperia
HTTPS-API
JavaScript-API

Allgemein

Die in heiBIB nachgewiesenen Publikationen können als dynamischen Literaturlisten zu Einrichtungen und/oder Autoren bereitgestellt werden. Es ist möglich, diese Listen über die hier vorgestellten APIs in eigene Webseiten einzubetten. Zur Verfügung stehen Ihnen dabei folgende beiden APIs:

HTTPS-API
JavaScript-API

Die folgenden Informationen sollen Ihnen helfen, dynamische Literaturlisten zu erstellen. Dabei stehen Ihnen verschiedene Verfahren und Formate für den Abruf der Information aus heiBIB zur Verfügung. Sollten Sie Informationen vermissen oder weitere Selektions- oder Darstellungsmöglichkeiten wünschen, setzen Sie sich bitte mit uns in Verbindung.

Folgende CSS- bzw. JavaScript-Ressourcen stehen für die beiden unten vorgestellten APIs zur Verfügung. Je nach Nutzung der APIs sind sie obligatorisch einzubinden.

Die JavaScript-Funktionen setzen die Einbindung von jQuery ab Version 1.11.0 voraus.

<link rel="stylesheet" href="https://katalog.ub.uni-heidelberg.de/css/heibib-2.0.css">

Style-Definitionen für die verschiedenen Listenelemente (Listeneinträge, Gruppierungen, Facetten, ...). Diese Definitionen werden u.a. benötigt, wenn für die Gruppierungen und Facetten Auf- und Zuklappfunktionen eingesetzt werden. In allen anderen Fällen ist die Nutzung des CSS-Moduls ebenfalls empfehlenswert.
<script type="text/javascript" src="https://katalog.ub.uni-heidelberg.de/opacjs/heibib-2.0.js"></script>

Dieses JavaScript-Modul ist bei der Nutzung der JavaScript-API obligatorisch. Es wird auch für die Darstellung der Listen über die HTTPS-API benötigt, falls die Auf- und Zuklappfunktionen bei Gruppierungen oder Facettierungen oder die Darstellung von Facetten über Charts gewünscht wird.
<script type="text/javascript" src="https://katalog.ub.uni-heidelberg.de/opacjs/citeproc.js"></script>

citeproc-Modul für die Anzeige der CSL-basierten Zitationsstilen (American Medical Association, American Psychological Association, ...) bei Verwendung der JavaScript-API.

Drupal Webkits

heiBIB-Listen können in den Drupal Webkits für den Webauftritt im Uni-Layout per Plugin integriert werden. Eine Anleitung hierfür finden Sie hier. Bei Fragen wenden Sie sich bitte an die Internetredaktion.

Imperia

Bei Fragen zur Integration der Literaturlisten aus heiBIB in Imperia wenden Sie sich bitte an Brief website-services@urz.uni-heidelberg.de.

HTTPS-API

Über diese Variante können Sie Publikationslisten zu einer oder mehreren Einrichtungen bzw. zu einem oder mehreren Autoren in verschiedenen Ausgabeformaten und Darstellungsformen erstellen und mit Hilfe eigener Programme weiterverarbeiten. Ebenso ist es bei einer HTML-Ausgabe möglich, diese Listen als Link oder via iframe-Verfahren in Ihr Webangebot einzubinden. Für eine einfache Einbettung in vorhandene Webseiten empfehlen wir die Verwendung der JavaScript-API (siehe unten).

URL

https://katalog.ub.uni-heidelberg.de/cgi-bin/heibib.cgi

Parameter

Allgemein

Name	multipel?	Möglicher Wert	Bedeutung
konfig	nein	<Name einer Konfiguration>	Vorkonfigurierte Listen: Die im folgenden aufgeführten Parameter lassen sich in einer Konfigurationsdatei zusammenfassen, die auf dem heiBIB-Server hinterlegt wird. Die Adressierung der Listen wird dadurch vereinfacht, zudem bestehen noch weitere Konfigurationsmöglichkeiten, die über die u.g. Parameter nicht möglich sind. Falls Sie ein konfigurierte Liste benötigen, wenden Sie sich bitte an Herrn Maylein.
sprache	nein	GER (Default) ENG	Sprache
format	nein	isbd (Default): ISBD-Anzeige analog zur Trefferanzeige in HEIDI ubhdshort: Anzeige der wichtigsten Titelinformationen (für Kurzlisten) int: JSON-Datenstruktur mods: MODS rdf: RDF endnote: Endnote/RIS bibtex: BibTeX exini: Format zur Meldung im Rahmen der ExIni csl: Citation Style Language ama: Zitationsstil American Medical Association apa: Zitationsstil American Psychological Association 6th edition chicago: Zitationsstil Chicago Manual of Style 16th edition (author-date) ieee: Zitationsstil IEEE harvard1: Zitationsstil Harvard Reference format 1 (author-date) mla: Zitationsstil Modern Language Association 7th edition (MLA) din_1505_2: Zitationsstil DIN 1505 (author-date, German) taylor_and_francis: Zitationsstil Taylor & Francis - Numeric Q (+ DOI)	Ausgabeformat (Daten, Zitationen): Falls Sie weitere Zitationsstile wünschen, wenden Sie sich bitte an Herrn Maylein.
contenttype	nein	text/html: HTML application/json: JSON application/javascript: JSONP text/plain: Text text/xml: XML application/octet-stream: Octet-Stream (Endnote) text/csv: CSV	Ausgabeformat (Mime-Type): Die möglichen Mime-Types hängen vom gewählten Format (s.o.) ab, ebenso der jeweilige Standard (Default), wenn dieser Parameter nicht angegeben wird. Sofern ein Mime-Type gewählt wird, der von für das entsprechende Format nicht unterstützt wird, wird der Default-Mime-Type ausgegeben. Neben der Angabe über diesen Parameter ist auch die Angabe via Accept-Header möglich.

Selektion

Name	multipel?	Möglicher Wert	Bedeutung
pers	ja	<GND-Nummer>	Autoren/Herausgeber: Angegeben werden muss die GND-Nummer des Autors (GND=Gemeinsame Normdatei, national). Werden mehrere GND-Nummern (jeweils mit eigenem Parameter) angegeben, so werden diese mit oder verknüpft. GND-Nummer in HEIDI nachgewiesener Autoren ermitteln
perspos	nein	first co last conotlast	Position in Autorenaufzählung: Über diesen Parameter kann gesteuert werden, an welcher Position in der Autorenaufzählung die im Parameter 'pers' angegebenen Personen stehen sollen: first: Nur Erstautoren co: Nur Ko-Autoren last: Nur Letztautoren conotlast: Nur Ko-Autoren, die jedoch nicht Letztautor sind Wird dieser Parameter weggelassen, so werden standardmäßig die Autoren unabhängig von Ihrer Position in der Autorenaufzählung gesucht.
dstl	ja	<Dienststellennummer>	Einrichtungen: Werden mehrere Einrichtungsnummern (jeweils mit eigenem Parameter) angegeben, so werden diese mit oder verknüpft. Angegeben werden muss die offizielle (universitäre) fünf- oder sechsstellige Dienststellennummer der Einrichtung. Es können nur Dienstestellennummern von Fakultäten, Instituten oder zentralen Einrichtungen verwendet werden. Liste der aktuellen Dienststellennummern der ZUV (Link funktioniert nur vom Uninetz aus)
ej	ja	jjjj (Jahresangabe vierstellig) jjjj-jjjj (Jahresangaben für Zeitraum) -X (die letzten X Jahre)	Erscheinungsjahr: Werden mehrere Jahre (jeweils mit eigenem Parameter) angegeben, so werden diese mit oder verknüpft. Beispiele zur Angabe der letzten Jahre: ej=0: aktuelles Jahr ej=-1: aktuelles Jahr + Vorjahr ej=-2: aktuelles Jahr + beide vorangegangenen Jahre ...
doktyp	ja	<Dokumenttyp> -<Dokumenttyp>	Dokumenttyp: Werden mehrere Dokumenttypen (jeweils mit eigenem Parameter) angegeben, so werden diese mit oder verknüpft. Durch Voranstellen eines Minus-Zeichens können Dokumenttypen ausgeschlossen werden. Liste der möglichen Dokumenttypen: Monographie/Reihe, Artikel (Zeitschrift), Artikel (Monogr./Sammelbd), Hochschulschrift, Konferenzschrift, Aufsatzsammlung Rezension, Festschrift, Bibliografie, Quelle, Wörterbuch, Lehrbuch, Film, Ausstellungskatalog, Kommentar, Biografie, Forschungsdaten, Einführung, Zeitschrift, Fallsammlung, Katalog, Lehrmittel, Atlas, Erlebnisbericht, Literaturbericht, Fallstudiensammlung, Karte, Ratgeber, Report, Verzeichnis, Bildband, Anthologie, Aufgabensammlung, Briefsammlung, Predigthilfe, Übungssammlung, Testmaterial, Autobiografie, Entscheidungssammlung, Führer
bibjahr	ja	jjjj * true yes	Bibliographiejahr: Einschränkung auf bestimmte Bibliographiejahre. Die Angabe , true* oder yes dient dem Ausschluss von Zweitpublikationen (denen in heiBIB kein Bibliograpiejahr zugeordnet ist).

Name	multipel?	Möglicher Wert	Bedeutung
sort	nein	ejasc: Aufsteigend nach Erscheinungsjahr ejdesc: Absteigend nach Erscheinungsjahr bib (Default): Autor, Titel, Jahr newest: Absteigend nach Erfassungsdatum	Sortierung der Publikationsliste
groupby	ja	doktyp: Dokumenttyp ej: Erscheinungsjahr pers: Autor/Herausgeber	Gruppierung der Literautliste nach den angegebenen Kriterien. Werden mehrere Kriterien angegeben, werden die Gruppen hierarchisch geschachtelt.
groupselected	ja	<Gruppenbezeichung>	Die genannten Gruppen (jeweils als eigener Parameter) werden (bei einer HTML-Darstellung) aufgeklappt dargestellt, während alle anderen Gruppen im Ausgangszustand zugeklappt dargestellt werden. Ist dieser Parameter nicht angegeben, werden alle Gruppen aufgeklappt dargestellt. Bei einer JSON/JSONP-Ausgabe werden die Gruppen um ein zusätzliches Attribut ("selected") erweitert.
facette	ja	fac_ej: Erscheinungsjahr fac_hbp: Autor/Herausgeber fac_hbd: Einrichtung fac_fsw: Dokumenttyp	Drilldown-Facetten zur weiteren Einschränkung der Publikationslisten
facetteLimit	ja	all:<Zahl> fac_ej:<Zahl> fac_hbp:<Zahl> fac_hbd:<Zahl> fac_fsw:<Zahl>	Maximale Anzahl der Facetteneinträge entweder für alle ("all") oder für einzelne Facetten. Die Angabe für "all" wird durch eine feldspezifische Angabe überschrieben.
facetteSort	ja	all:alph fac_hbp:alph fac_hbd:alph fac_fsw:alph	Alphabetische Sortierung der entsprechenden Facetten.
css	ja	<Dateiname>	Angabe einer CSS-Datei, die eingebunden werden soll. Achtung: Diese CSS-Datei muss auf dem heiBIB-Server abgelegt sein. Für die Angabe mehrerer CSS-Dateien kann dieser Parameter wiederholt werden.
pagesize	nein	<Zahl>	Unterteilung der Literaturlisten in Einzelseiten mit <pagesize> Einträgen pro Seite. Dieser Parameter kann nicht zusammen mit Gruppierungsfunktionen (Parameter "groupby") verwendet werden. Default: Keine Unterteilung in Einzelseiten
page	nein	<Zahl>	Adressierung einer Anzeigeseite bei Unterteilung in Einzelseiten.
linktarget	nein	popup: Popup-Fenster mit heiBIB-Informationen heiditab: Link auf Titel in HEIDI in neuem Browsertab heidi: Link auf Titel in HEIDI in gleichem Browsertab	Ziel/Aktion des Links in den dargestellten Publikationen.
linkposition	nein	none: Kein Link default (Default): Abhängig von gewähltem Format (ganzes Zitat oder nur Titel) separate: Separater Link am Ende des Zitats	Darstellung des Links in den Publikationsangaben
listtype	nein	ul (Default): HTML: ungeordnete Liste ol: HTML: Liste mit Ordnungszahlen	Dieser Parameter hat nur bei der Ausgabe mit dem Mime-Type "text/html" Auswirkungen.
snippet	nein	true bzw. 1 false bzw. 0 (Default)	Dieser Parameter hat nur bei einer HTML-Ausgabe Auswirkungen. Bei "true" bzw. "1" wird lediglich ein HTML-Snippet statt einer kompletten HTML-Seite ausgegeben.

Beispiele

Autorenlisten:

Einrichtungslisten:

Einbindung in eigene Webseiten via IFrames

Beispiel:

<iframe src="https://katalog.ub.uni-heidelberg.de/cgi-bin/heibib.cgi?dstl=180000" width="50%" height="400" name="Literaturliste">
  <p>Ihr Browser kann leider keine eingebetteten Frames anzeigen:
  Sie können die eingebettete Seite über den folgenden Verweis
  aufrufen: <a href="https://katalog.ub.uni-heidelberg.de/cgi-bin/heibib.cgi?dstl=180000">
    Literaturliste</a></p>
</iframe>

JavaScript-API

Einbindung

Nach der Einbindung von heibib-2.0.js, heibib-2.0.css und ggf. citeproc.js (siehe oben) steht derzeit folgende JavaScript-Funktion zur Erzeugung von heiBIB-Publikationslisten zur Verfügung:

hbList(target,selection,display)
Zweck:
Erstellen einer Publikationsliste im HTML-Tag mit der ID target. Verwendet werden die in selection angegebenen Selektionskriterien sowie die Anzeigeoptionen, welche in display festgelegt werden.
Parameter:
- target {string}
  Die erzeugte Liste wird im HTML-Element mit der ID (id-Attribut) target ausgegeben. Soll die Liste selbst nicht ausgegeben (sondern z.B. nur einzelne Facetten (s.u.)), so muss hier ein Leerstring übergeben werden.
- selection {object}
  Mögliche Hash-Keys dieses Objekts sind die Selektionskriterien pers, perspos, dstl, ej und doktyp. Die Werte können dabei wahlweise als String oder als Array (mit den einzelne Strings als Selektionskriterien) angegeben werden. Ausnahme hiervon ist der Parameter perspos, bei dem als Angabe nur ein String erlaubt ist. Welche Werte bei den verschiedenen Selektionskriterien möglich sind, entnehmen Sie bitte den entsprechenden Angaben bei der HTTPS-API (siehe oben).
```
{
  pers:<String>,
  pers:[<String>, ...],
  perspos:<String>,
  dstl:<String>,
  dstl:[<String>, ...],
  ej:<String>,
  ej:[<String>, ...],
  doktyp:<String>,
  doktyp:[<String>, ...],
}
      
```
  Beispiel:
```
{dstl:'10200',ej:['2016','2015','2014']}
      
```
- display {object}
  Mögliche Hash-Keys dieses Objekts sind folgende Anzeigeoptionen:
```
{
  format:<String>,
  sort:<String>,
  sprache:<String>,
  groupby:<String>,
  groupby:[<String>, ...],
  groupselected:<String>,
  groupselected:[<String>, ...],
  listtype:<String>,
  pagesize:<Number>,
  page:<Number>,
  linkposition:<String>,
  linktarget:<String>,
  facette:{<String>:{target:<String>,chart:<String>,limit:<Number>}, ...},
}
      
```
  Welche Angaben für die einzelnen Parameter möglich sind, entnehmen Sie bitte den entsprechenden Angaben bei der HTTPS-API (siehe oben).
  
  Bitte beachten Sie, dass die Formate mods, exini und rdf in der JavaScript-API nicht zur Verfügung stehen.
  
  Bitte beachten Sie, dass beim Parameter linktarget die Option popup in der JavaScript-API nicht zur Verfügung stehen.
  
  Die Angaben für die Drilldown-Facetten setzen sich wie folgt zusammen: Für jedes Facettenfeld (z.B. fac_ej) muss obligatorisch als target ein HTML-Element (id-Attribut) angegeben werden, in dem die Facette als Liste dargestellt werden soll. Optional können bestimmte Facetten auch als Diagramm in dem über den Parameter chart angegebenen HTML-Element (id-Attribut) ausgegeben werden und/oder via limit auf eine bestimmte Anzahl von Einträgen eingeschränkt werden.
  
  Für die Diagramm-Darstellung der Facetten wird das Highstock-Javascript-Modul ab Version 4.2.5 benötigt.
Beispiel:
```
<html>
  <head>
    ...
    <script type="text/javascript" src="https://katalog.ub.uni-heidelberg.de/opacjs/jquery-1.11.1.min.js"></script>
    <script type="text/javascript" src="https://katalog.ub.uni-heidelberg.de/opacjs/heibib-2.0.js"></script>
    <link href="https://katalog.ub.uni-heidelberg.de/css/heibib-2.0.css" type="text/css" rel="stylesheet">
    <script type="text/javascript">
      $(document).ready(function() {
        hbList(
         'listenausgabe',
         {ej:[2016,2015,2014,2013,2012]},
         {groupby:'ej',groupselected:['2016','2015'],format:'isbd',facette:{fac_fsw:{target:'facettenliste',limit:10}}}
        );
      });
    </script>
  </head>
  <body>
    ...
    <div id="listenausgabe"></div>
    ...
    <div id="facettenliste"></div>
    ...
  </body>
</html>
  
```

Schnelleinstieg

Literaturlisten aus heiBIB in eigene Seiten integrieren: Technische Information

Allgemein

Drupal Webkits

Imperia

HTTPS-API

URL

Parameter

Allgemein

Selektion

Anzeige

Beispiele

Einbindung in eigene Webseiten via IFrames

JavaScript-API

Einbindung