Wikiup:BEACON/Format
Unter http://gbv.github.io/beaconspec/beacon.html ist der aktuelle Stand einer formalen BEACON-Spezifikation einsehbar. Diskussion und Änderungen sind unter https://github.com/gbv/beaconspec möglich. Die folgende Formatbeschreibung ist eher informell.
Meta-Zeilen
Pflichtfelder
Die BEACON-Datei beginnt mit den folgenden zwei Zeilen:[1] Die PREFIX-Zeile gibt an, dass die verwendeten Normdaten-Nummern (Identifier) solche der GND sind (in der GND ist die PND inzwischen aufgegangen, die PND-Nummern können ohne Änderung als GND verwendet werden).
#FORMAT: BEACON #PREFIX: http://d-nb.info/gnd/
Es folgt eine Zeile mit einem URL-Template, das angibt, wie die Verlinkungen anhand der Identifier zu konstruieren sind, z.B.
#TARGET: http://example.org/dir/{ID}
Durch Ersetzen der Zeichenkette {ID} durch eine der in den Daten-Zeilen im Hauptbereich der Datei aufgeführten Nummern muss sich ein direkter Link auf einen Treffer oder eine Trefferliste ergeben.
Optionale Felder
#VERSION: 0.1
Falls sich das Format ändert, bietet es sich an, die aktuelle Formatversion anzugeben. Optional.
#FEED: http://example.org/
http://example.org/ ist durch die URL der BEACON-Datei zu ersetzen. Optional.
#LINK: http://www.w3.org/2000/01/rdf-schema#seeAlso
Genaue Angabe um welche Art von Links es sich handelt. Als Wert muss die URI aus einer RDF-Ontologie angegeben werden wobei der Standardwert http://www.w3.org/2000/01/rdf-schema#seeAlso ist. Weitere sinnvolle Werte sind unter Anderem http://xmlns.com/foaf/0.1/isPrimaryTopicOf (FOAF) und http://www.w3.org/2002/07/owl#sameAs (OWL), oder eines der Concepts aus http://marc21rdf.info/terms/commonnat.rdf (MARC21-008: Nature of Contents).
#CONTACT: name <name@domain.tld>
Irgendeine Kontaktinformation (bevorzugt Email, Name, aber auch Jabber, Skype, Telefon, ICQ oder Postadresse) bei Problemen. Optional.
#INSTITUTION: ...
Herausgeber oder Betreiber der durch die BEACON-Datei erschlossenen Datensammlung. Beispiele: "Verein für dies und das", "Seminar für X der Fakultät Y der Universität Z". Optional.
#NAME: ...
Name der durch die BEACON-Datei erschlossenen Datensammlung, falls das durch #INSTITUTION oder #MESSAGE nicht gut genug ausgedrückt wird. Beispiel: "Registres Académie Royale de Prusse 1746 à 1786" (#INSTITUTION dabei hingegen "Berlin-Brandenburgische Akademie der Wissenschaften").
#MESSAGE: ...
Vorschlag, welcher Text genannt werden kann als Quelle des Textes. Beispiele: "Literatur im Katalog der XY-Bibliothek", "Eintrag in der XY-Datenbank", "Internet-Portal ABC". Optional.
#DESCRIPTION: ...
Kurze Infos, was in dieser Liste zu finden ist. Optional.
#TIMESTAMP: [Timestamp]
Timestamp, wann diese Datei erstellt wurde. Timestamp ein GMT-Datum nach ISO 8601, speziell in der Form JJJJ-MM-TT oder mit Uhrzeit in der Form JJJJ-MM-TTThh:mm:ssZ. Optional.
#UPDATE: Text
Hier kann angegeben werden, wie oft die Liste aktualisiert wird. Mögliche Werte sind always
, hourly
, daily
, weekly
, monthly
, yearly
und never
. Nur sinnvoll, wenn #FEED definiert ist. Optional.
#REVISIT: [Timestamp]
Voraussichtliches Datum, wann die Datei das nächste mal aktualisiert wurde. Nur sinnvoll, wenn #FEED definiert ist. Timestamp wie bei #TIMESTAMP nach ISO. Optional.
Daten-Zeilen
Über jede Daten-Zeile wird mitgeteilt, für welche Normdatei-Nummer Informationen auf der angegebenen Seite zu finden sind. Dabei werden drei Zeilenformate unterschieden:
123456789
Im einfachsten Fall enthält eine Zeile ausschließlich eine Normdatei-Nummer (z.B. eine der GND): so ist bekannt, dass es dazu Eintragungen gibt. Relevant bei reinen Verzeichnissen.
123456789|123
Zusätzlich kann mit einem senkrechten Strich getrennt eine Anzahl "Treffer" angegeben werden. Relevant bei Bibliotheken etc. Im Beispiel gibt es zur GND 123456789 auf der Seite 123 Treffer (beispielsweise in einem Bibliothekskatalog). Leerzeichen vor und nach dem Trenner sind erlaubt.
Sind drei Parameter angegeben (zwei |-Zeichen), gibt der dritte Parameter explizit an, auf welche Adresse verlinkt werden soll. In diesem Fall wird die URL entweder mittels Target-ID-Nummer und TARGET-Parameter zusammengesetzt, oder es wird ein vorhandener http- oder https-Link benutzt:
123456789||Hans_Mustermann 123456789||http://de.wikipedia.org/wiki/Hans_Mustermann
Die Nutzung des zweiten Parameters in diesem Fall ist noch undiskutiert.
Anmerkungen
- ↑ Ursprünglich war auch stattdessen die einzelne Zeile
#FORMAT: PND-BEACON
möglich. Diese Variante wird auch noch von den meisten Anwendern unterstützt, gilt jedoch als veraltet.