Difference between revisions of "URNPlugIn Doku"

From PKP Wiki
Jump to: navigation, search
Line 15: Line 15:
 
==== DNB-Richtlinien ====
 
==== DNB-Richtlinien ====
  
Laut den DNB-Richtlinien dürfen URN nur an die Objekte vergeben werden, die langzeitarchiviert werden. Für OJS bedeutet das, dass URN nur an die PDF-Fahnen in der Artikelhauptsprache vergeben werden dürfen, da nur diese mit Hilfe des DNB-Plug-Ins (das noch in Entwicklung ist) automatisiert gemeldet werden können.  
+
Laut den DNB-Richtlinien dürfen URN nur an die Objekte vergeben werden, die langzeitarchiviert werden. Für '''OJS''' bedeutet das, dass URN '''nur an die PDF-Fahnen in der Artikelhauptsprache''' vergeben werden dürfen, da nur diese mit Hilfe des DNB-Plug-Ins (das noch in Entwicklung ist) automatisiert gemeldet werden können.  
  
 
</div>
 
</div>

Revision as of 06:58, 8 March 2013

DNB-URN-Plug-Ins für OJS

Das ist die Benutzer/innendokumentation für die URN-Plug-Ins für OJS, das im Rahmen des Projekts „Funktionaler Ausbau von und Mehrwertdienste für ‚Open Journal Systems‘ (OJS)“ [1] entwickelt worden ist:

  • URN-Import/Export-Plug-In (Import und Export von URN).
  • DNB-URN-Plug-In (die Vergabe von URN nach den Richtlinien der Deutschen Nationalbibliothek).
  • EPICUR-URN-Metadaten-Plug-In (URN-Meldung über die OJS-OAI-Schnittstelle an die DNB).


DNB-URN

DNB-Richtlinien

Laut den DNB-Richtlinien dürfen URN nur an die Objekte vergeben werden, die langzeitarchiviert werden. Für OJS bedeutet das, dass URN nur an die PDF-Fahnen in der Artikelhauptsprache vergeben werden dürfen, da nur diese mit Hilfe des DNB-Plug-Ins (das noch in Entwicklung ist) automatisiert gemeldet werden können.

URN-Struktur

Die URN besteht aus zwei Teilen:

  1. Präfix -- der statische, feste und unveränderliche Teil.
  2. Suffix -- kann variiert werden und beinhaltet einen eindeutigen String (Zeichenfolge, bestehend aus Buchstaben und Zahlen).


Das folgende Beispiel erläutert die Begriffe und die einzelnen Bestandteile einer URN, auf die in dieser Dokumentation verwiesen wird:

urn:nbn:de:0114-fqs1102217
Unternamensraum: urn:nbn:de:0114
Präfix: urn:nbn:de:0114-
Suffix: fqs110221
Prüfziffer: 7

Unternamensraum

Der URN-Unternamensraum wird von der DNB vergeben. Mehr über URN und über den URN-Service der DNB erfährt man hier [2].


URN-Import/Export-Plug-In

Die Zeitschriften, die URN in OJS schon manuell verwenden, müssen zunächst die schon vergebenen URN in das System importieren. Für den Import kann das Public Identifiers XML-Plug-In (Zeitschriftenverwaltung > Daten importieren/exportieren) verwendet werden. Dafür wird eine XML-Datei benötigt, die die URN und ihre Zugehörigkeit/Verknüpfung zu OJS-Fahnen beschreibt.

Hier ist eine Beispiel-Datei:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE pubIds SYSTEM "pubIds.dtd" >

<pubIds>
<pubId pubIdType="other::urnDNB" pubObjectType="Galley" pubObjectId="1">urn:nbn:de:1234-galley1URNSuffix</pubId>
<pubId pubIdType="other::urnDNB" pubObjectType="Galley" pubObjectId="2">urn:nbn:de:1234-galley2URNSuffix</pubId>
</pubIds>

Die ersten zwei Zeilen sind immer gleich und müssen in jeder URN-XML-Import-Datei existieren.

Die einzelne URN müssen innerhalb des umfassenden Wurzel-Elements '<pubIds>...</pubIds>', zwischen dem Start- und End-Tag aufgelistet sein.

Jede URN wird mit dem Element '<pubId>...</pubId>' beschrieben: Die URN selbst befindet sich zwischen dem Start- und End-Tag. Das Attribut 'pubIdType="other::urnDNB"' und das Attribut 'pubObjectType="Galley"' müssen immer vorhanden sein. 'urnDNB' ist ein OJS-intertes Typ, das sast, dass es sich um die URN der DNB handelt. Objekttyp ist immer 'Galley' da die URN laut DNB-Richtlinien (s.o.) nur an Fahnen zugewiesen werden dürfen. Das Attribut 'pubObjectId' ist die von OJS intern vergebene ID der entsprechenden Fahne.

Das Public Identifier XML-Plug-In ermöglicht auch den Export von URN im selben XML-Format wie oben beschrieben.


DNB-URN-Plug-In

Installieren

Plug-In heruntergeladen: ...

Bitte lesen Sie die README Datei für die Installation.

Achtung: Mit OJS kommt standartmäßig ein URN-Plug-In, das die vergabe von URN an alle Publikationsobjekte (Ausgaben, Artikeln, Fahnen und Zusatzdateien) ermöglicht. Das entspricht jedoch nicht den URN-Vergaberichtlinien der DNB. Daher sollte man zwischen den beiden Plug-Ins unterscheiden.

Aktivieren

Das Plug-In ist unter Zeitschriftenverwaltung > Plug-Ins > Public Identifier Plugins > DNB-URN zu finden. Klicken Sie auf "Einschalten" um das Plug-In zu aktivieren.

OJS DNB URN Plugin.png

Abbildung 1: DNB-URN-Plug-In


Einstellungen

Um das DNB-URN-Plug-in in OJS zu benutzen, muss der/die Zeitschriftenverwalter/in, nachdem er/sie das Plug-In aktiviert hat, zuerst die Einstellungen für das Plug-In vornehmen (siehe Abbildung 2):

OJS URN Plugin Settings.png

Abbildung 2: URN-Plug-In-Einstellungen


Der URN-Präfix muss eingegeben werden. Er stellt den statischen, festen und unveränderlichen Bestandteil der URN dar. (Meistens entspricht er dem von der DNB vergebenen URN-Unternamensraum und dem Minus-Zeichen '-').

Die Art, wie die URN-Suffixe definiert werden sollten, soll bestimmt werden:

  • Ein Muster kann definiert werden. Dabei kann man folgende Platzhalter verwenden:
 %j Kürzel der Zeitschrift
 %v Bandnummer
 %i Ausgabennummer
 %Y Jahr
 %a OJS-Artikel-ID
 %g OJS-Fahnen-ID
 %p Seitennummern
Bei dieser Option sollte man das Muster sehr gut überlegen, so dass die Suffixe über alle Fahnen eindeutig sind, d.h. ein Suffix nur ein Mal vorkommt.
  • Das Default-Muster kann verwendet werden:
 %j.v%vi%i.%a.g%g für Fahnen,
  • Die eindeutige Kennung für Fahnen (muss in Schritt 4.3 Kennung des Inhalts der Zeitschrift zugelassen werden) kann auch als URN-Suffix benutzt werden.
  • Der Suffix kann für jedes Objekt manuell eingegeben werden.

Der Namensraum für die Registrierung der URN-URL-Pärchen muss ausgewählt werden. Der Namensrauf für Deutschland ist "urn:nbn:de".

Mit dem Button „Clear URNs“ können alle vergebenen URN gelöscht werden. Diese Option ist z.B. dann nützlich, wenn sich die Einstellungen geändert haben und die neuen Einstellungen auf alle Fahnen angewendet werden sollten (auch auf die, die schon eine URN besitzen). Vorsicht: Diese Option ist mit äußerster Vorsicht zu begegnen, da die gelöschten URN schon veröffentlicht und zitiert und die URN-URL-Paare registriert sein konnten.

Ansicht der URN-Suffixe

Die URN-Suffixe können in den Metadaten des entsprechenden Objekts angesehen bzw. eingegeben werden (s. Abbildung 3a und 3b):

OJS URN Artikel Metadaten 1.png

Abbildung 3a: URN-Metadaten bei der Vergabe von Suffixen nach einem Muster

OJS URN Artikel Metadaten 2.png

Abbildung 3b: URN-Metadaten bei der manuellen Vergabe von Suffixen

URN-Ausgabe

Die URN werden an folgenden Stellen im System automatisch berücksichtigt/ausgegeben:

  • Auf Fahnen-Ansicht-Seiten,
  • Als meta-Tag im HTML-Quelltext der Fahnen-Ansicht,
  • Im Beiträge- und Ausgaben-XML-Plug-In,
  • Über die OAI-Schnittstelle im DublinCore-Format.


EPICUR-URN-Metadaten-Plug-In

Installieren

Plug-In heruntergeladen: ...

Bitte lesen Sie die README Datei für die Installation.

Nachdem das Plug-In installiert ist, ist es aktiv und unter Zeitschriftenverwaltung > Verwaltung der Plug-Ins > Plug-In für OAI-Metadaten-Format zu sehen.

OJS EPICUR URN Metadaten Plugin.png

Abbildung 4: EPICUR-URN-Metadaten-Format-Plug-In

EPICUR-Format ist jetzt auch unter .../oai?verb=ListMetadataFormats zu sehen und die Zeitschrift kann z.B. so nach URN geharvestet werden: .../oai?verb=ListRecords&metadataPrefix=epicur