URNPlugIn Doku

From PKP Wiki
Revision as of 03:03, 18 January 2012 by Bozana (Talk | contribs)

Jump to: navigation, search

URN-Plug-In für OJS

Das ist die Benutzer/innendokumentation für das URN-Plug-In für OJS, das im Rahmen des Projekts „Funktionaler Ausbau von und Mehrwertdienste für ‚Open Journal Systems‘ (OJS)“ [1] entwickelt worden ist. Das Plug-In unterstützt die Vergabe von URN in OJS und die Automatisierung der URN-Meldung an die DNB.


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


URN-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-Plug-In aktivieren

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


URN-Import/Export

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-Objekten beschreibt.

Hier ist eine Beispiel-Datei:

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

<pubIds>
<pubId pubIdType="other::urn" pubObjectType="Issue" pubObjectId="1">urn:nbn:de:1234-issue1URNSuffix</pubId>
<pubId pubIdType="other::urn" pubObjectType="Article" pubObjectId="1">urn:nbn:de:1234-article1URNSuffix</pubId>
<pubId pubIdType="other::urn" pubObjectType="Galley" pubObjectId="1">urn:nbn:de:1234-galley1URNSuffix</pubId>
<pubId pubIdType="other::urn" pubObjectType="Galley" pubObjectId="2">urn:nbn:de:1234-galley2URNSuffix</pubId>
<pubId pubIdType="other::urn" pubObjectType="SuppFile" pubObjectId="1">urn:nbn:de:1234-suppFile1URNSuffix</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::urn"' muss immer vorhanden sein. Das Attribut 'pubObjectType' enthält einen der folgenden Werte: "Issue", "Article", "Galley" oder "SuppFile", je nachdem welchem Objekt die URN zugewiesen werden sollte. Das Attribut 'pubObjectId' ist die von OJS intern vergebene ID des entsprechenden Objektes.

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


URN-Plug-In-Einstellungen in OJS

Um das 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 1):

OJS URN Plugin Settings.png

Abbildung 1: URN-Plug-In-Einstellungen


Die Objekte müssen ausgewählt werden, für die URN vergeben werden. Die URN können an Ausgaben, Artikeln, Fahnen oder Zusatzdateien in OJS vergeben werden.

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 für jedes Objekt 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
 %s OJS-Zusatzdatei-ID
 %p Seitennummern
Bei dieser Option sollte man das Muster sehr gut überlegen, so dass die Suffixe über alle Objekte eindeutig sind, d.h. ein Suffix nur ein Mal vorkommt.
  • Das Default-Muster kann verwendet werden:
 %j.v%vi%i für Ausgaben,
 %j.v%vi%i.%a für Artikel,
 %j.v%vi%i.%a.g%g für Fahnen,
 %j.v%vi%i.%a.s%s für Zusatzdateien.
  • Die eindeutige Kennung für Elemente (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.

Es muss bestimmt werden, ob die Prüfziffer verwendet werden sollte. Wenn die URN-Dienste der DNB verwendet werden, muss die Prüfziffer verwendet werden.

Der Namensraum für die Registrierung der URN-URL-Pärchen muss ausgewählt werden. Der Namensrauf für die Registrierung bei der DNB 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 Objekte 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 2a und 2b):

OJS URN Artikel Metadaten 1.png

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

OJS URN Artikel Metadaten 2.png

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


URN-Ausgabe

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

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

URN-Registrierung bei der DNB

Die Registrierung der Artikel-URN erfolgt automatisch über die OAI-Schnittstelle...