Difference between revisions of "URNPlugIn Doku"

From PKP Wiki
Jump to: navigation, search
m (URN-Plug-In für OJS)
Line 2: Line 2:
  
 
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)“ [http://www.cedis.fu-berlin.de/ojs-de] entwickelt worden ist.
 
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)“ [http://www.cedis.fu-berlin.de/ojs-de] entwickelt worden ist.
Das Plug-In unterstützt die Vergabe von URNs in OJS und die Automatisierung der URN-Meldung an die DNB.
+
Das Plug-In unterstützt die Vergabe von URN in OJS und die Automatisierung der URN-Meldung an die DNB.
  
 
'''Bemerkung''':  
 
'''Bemerkung''':  
  
Da URNs in der aktuellen Publikationspraxis meistens nur an Artikel vergeben werden und da Artikel das zentrale Objekt in OJS ist, wird zur Zeit die Ausgabe (und evtl. Registrierung) der URNs nur für Artikel berücksichtigt. Die Vergabe an andere Objekte (Ausgaben, Fahnen und Zusatzdateien) ist jedoch möglich. Die Ausgabe (und evtl. Registrierung) dieser URNs muss manuell, z.B. durch die Redakteur/innen, erfolgen.  
+
Da URN in der aktuellen Publikationspraxis meistens nur an Artikel vergeben werden und da Artikel das zentrale Objekt in OJS ist, wird zur Zeit die Ausgabe (und evtl. Registrierung) der URN nur für Artikel berücksichtigt. Die Vergabe an andere Objekte (Ausgaben, Fahnen und Zusatzdateien) ist jedoch möglich. Die Ausgabe (und evtl. Registrierung) dieser URN muss manuell, z.B. durch die Redakteur/innen, erfolgen.  
  
  
 
=== URN-Struktur ===
 
=== URN-Struktur ===
  
Die URN besteht aus zwei Teilen:<br>
+
Die URN besteht aus zwei Teilen:
1. Präfix -- der statische, feste und unveränderliche Teil.<br>
+
# 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).<br>
+
# 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 Dokumentatin verwiesen wird:
+
 
 +
 
 +
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'''
 
: '''urn:nbn:de:0114-fqs1102217'''
Line 35: Line 37:
 
=== Registrierung der Zeitschrift bei der VG Wort ===
 
=== Registrierung der Zeitschrift bei der VG Wort ===
  
Eine Zeitschrift sollte sich bei der DNB einen URN-Unternamensraum besorgen. Mehr über URNs und über den URN-Service der DNB erfährt man hier [http://www.d-nb.de/netzpub/erschl_lza/np_urn.htm].
+
Eine Zeitschrift sollte sich bei der DNB einen URN-Unternamensraum besorgen. Mehr über URN und über den URN-Service der DNB erfährt man hier [http://www.d-nb.de/netzpub/erschl_lza/np_urn.htm].
  
  
 
=== URN-Import/Export ===  
 
=== URN-Import/Export ===  
  
Die Zeitschriften die URNs in OJS schon manuell verwenden müssen als erstes die schon vergebenen URNs in das System importieren. Für den Import kann das URN-XML-Plug-In (Zeitschriftenverwaltung > Daten importieren/exportieren) verwendet werden. Dafür wird eine XML-Datei benötigt, die die URNs und ihre Zugehörigkeit/Verknüpfung zu OJS-Objekten beschreibt.
+
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 URN-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:
 
Hier ist eine Beispiel-Datei:
Line 55: Line 57:
 
  </urns>
 
  </urns>
  
Die ersten zwei Zeilen sind immer gleich und müssen in jeder URN-XML-Import-Datei existieren.<br>
+
Die ersten zwei Zeilen sind immer gleich und müssen in jeder URN-XML-Import-Datei existieren.
Die einzelne URNs müssen innerhalb des umfassenden Wurzel-Elements '<urns>...</urns>', zwischen dem Start- und End-Tag aufgelistet sein.<br>
+
 
 +
Die einzelne URN müssen innerhalb des umfassenden Wurzel-Elements '<urns>...</urns>', zwischen dem Start- und End-Tag aufgelistet sein.
 +
 
 
Jede URN wird mit dem Element '<urn>...</urn>' beschrieben: Die URN selbst befindet sich zwischen dem Start- und End-Tag. Das Attribut 'objectType' enthält einen der folgenden Werte: "issue", "article", "galley" oder "suppFile", je nachdem welchen Objekt die URN zugewiesen werden sollte. Das Attribut 'objectId' ist die von OJS intern vergebene ID des entsprechenden Objektes.
 
Jede URN wird mit dem Element '<urn>...</urn>' beschrieben: Die URN selbst befindet sich zwischen dem Start- und End-Tag. Das Attribut 'objectType' enthält einen der folgenden Werte: "issue", "article", "galley" oder "suppFile", je nachdem welchen Objekt die URN zugewiesen werden sollte. Das Attribut 'objectId' ist die von OJS intern vergebene ID des entsprechenden Objektes.
  
Das URN-XML-Plug-In ermöglicht auch den Export von URNs im selben XML-Format wie oben beschrieben.
+
Das URN-XML-Plug-In ermöglicht auch den Export von URN im selben XML-Format wie oben beschrieben.
  
  
Line 70: Line 74:
  
  
Die Objekte müssen ausgewählt werden, für die URNs vergeben werden. Die URNs können an Ausgaben, Artikeln, Fahnen oder Zusatzdateien in OJS vergeben werden.
+
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 und entspricht dem von der DNB vergebenen URN-Unternamensraum und dem Minus-Zeichen '-'.
 
Der URN-Präfix muss eingegeben werden. Er stellt den statischen, festen und unveränderlichen Bestandteil der URN dar und entspricht dem von der DNB vergebenen URN-Unternamensraum und dem Minus-Zeichen '-'.
Line 100: Line 104:
 
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'''".
 
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 URNs gelöscht werden. Diese Option ist z.B. dann nützlich, wenn sich die Eistellugnen 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 URNs schon veröffentlicht und zitiert und die URN-URL-Pärchen registriert sein konnten.
+
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.
  
  
Line 116: Line 120:
 
=== URN-Ausgabe ===  
 
=== URN-Ausgabe ===  
  
Im Moment werden nur Artikel-URNs (s. die Bemerkung oben) berücksichtigt und an folgenden Stellen im System automatisch ausgegeben:
+
Im Moment werden nur Artikel-URN (s. die Bemerkung oben) berücksichtigt und an folgenden Stellen im System automatisch ausgegeben:
 
* Im HTML-Quelltext der Artikel- und Fahnen-Ansicht,
 
* Im HTML-Quelltext der Artikel- und Fahnen-Ansicht,
 
* In den Metadaten in den Lesewerkzeugen,
 
* In den Metadaten in den Lesewerkzeugen,
 
* Über die OAI-Schnittstelle im DublinCore-Format.
 
* Über die OAI-Schnittstelle im DublinCore-Format.
  
Die Ausgabe der URNs auf der entsprechenden Webseite (z.B. Zusammenfassungs-Ansicht und/oder im Volltext) ist die Aufgabe der Redakteur/innen, da es hier unterschiedlichen Bedarf gibt.
+
Die Ausgabe der URN auf der entsprechenden Webseite (z.B. Zusammenfassungs-Ansicht und/oder im Volltext) ist die Aufgabe der Redakteur/innen, da es hier unterschiedlichen Bedarf gibt.
  
  
 
=== URN-Registrierung bei der DNB ===  
 
=== URN-Registrierung bei der DNB ===  
  
Die Registrierung der Artikel-URNs erfolgt automatisch über die OAI-Schnittstelle...
+
Die Registrierung der Artikel-URN erfolgt automatisch über die OAI-Schnittstelle...

Revision as of 01:40, 29 September 2011

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.

Bemerkung:

Da URN in der aktuellen Publikationspraxis meistens nur an Artikel vergeben werden und da Artikel das zentrale Objekt in OJS ist, wird zur Zeit die Ausgabe (und evtl. Registrierung) der URN nur für Artikel berücksichtigt. Die Vergabe an andere Objekte (Ausgaben, Fahnen und Zusatzdateien) ist jedoch möglich. Die Ausgabe (und evtl. Registrierung) dieser URN muss manuell, z.B. durch die Redakteur/innen, erfolgen.


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


Registrierung der Zeitschrift bei der VG Wort

Eine Zeitschrift sollte sich bei der DNB einen URN-Unternamensraum besorgen. Mehr über URN und über den URN-Service der DNB erfährt man hier [2].


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 URN-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 urns SYSTEM "urn.dtd" >
 
<urns>
 <urn objectType="issue" objectId="1">urn:nbn:de:0000-issue1URNSuffix</urn>
 <urn objectType="article" objectId="1">urn:nbn:de:0000-article1URNSuffix</urn>
 <urn objectType="galley" objectId="1">urn:nbn:de:0000-galley1URNSuffix</urn>
 <urn objectType="galley" objectId="2">urn:nbn:de:0000-galley2URNSuffix</urn>
 <urn objectType="suppFile" objectId="1">urn:nbn:de:0000-suppFile1URNSuffix</urn>
</urns>

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 '<urns>...</urns>', zwischen dem Start- und End-Tag aufgelistet sein.

Jede URN wird mit dem Element '<urn>...</urn>' beschrieben: Die URN selbst befindet sich zwischen dem Start- und End-Tag. Das Attribut 'objectType' enthält einen der folgenden Werte: "issue", "article", "galley" oder "suppFile", je nachdem welchen Objekt die URN zugewiesen werden sollte. Das Attribut 'objectId' ist die von OJS intern vergebene ID des entsprechenden Objektes.

Das URN-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 und entspricht 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.g%g.s%s für Zusatzdateien.
  • Der Suffix kann für jedes Objekt manuell eingegeben werden. Bei dieser Option sollte man einen sehr guten Überblick über die Suffixe behalten, so dass die Suffixe über alle Objekte eindeutig sind, d.h. ein Suffix nur ein Mal vorkommt.

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

Im Moment werden nur Artikel-URN (s. die Bemerkung oben) berücksichtigt und an folgenden Stellen im System automatisch ausgegeben:

  • Im HTML-Quelltext der Artikel- und Fahnen-Ansicht,
  • In den Metadaten in den Lesewerkzeugen,
  • Über die OAI-Schnittstelle im DublinCore-Format.

Die Ausgabe der URN auf der entsprechenden Webseite (z.B. Zusammenfassungs-Ansicht und/oder im Volltext) ist die Aufgabe der Redakteur/innen, da es hier unterschiedlichen Bedarf gibt.


URN-Registrierung bei der DNB

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