VGWortPlugIn Doku

From PKP Wiki
Revision as of 02:09, 30 May 2011 by Bozana (Talk | contribs)

Jump to: navigation, search

VG Wort Plug-In für OJS

Das ist die Benutzerdokumentation für das VG Wort Plug-In für OJS, das im Rahmen des Projekts „Funktionaler Ausbau von und Mehrwertdienste für 'Open Journal Systems' (OJS)“ [1] entwickelt wurde.

Für Redaktion

Für die Nutzung des VG Wort Plug-Ins in OJS wird die PHP-Version >= 5.0.1 benötigt, da das Plug-In einige PHP-Funktionen verwendet, die erst ab dieser Version zur Verfügung stehen. Dementsprechend muss diese PHP-Version auf dem Server, auf dem OJS läuft, vorhanden sein.

Registrierung der Zeitschrift bei der VG Wort

Eine Zeitschrift muss bei der VG Wort als Verlag registriert sein. Die Registrierung erfolgt über T.O.M. [2] (Texte Online Melden), das Registrierungs- und Meldeportal der VG Wort und besteht aus zwei, miteinander verbundenen Vorgängen:

  • die Online über das Meldesystem durchgeführte Registrierung
  • die fristgerechte, postalische Zusendung der unterschriebenen Unterlagen, die im Anschluss an die Registrierung im System heruntergeladen werden könne, an die VG WORT.

Erst wenn beide Vorgänge abgeschlossen und die eingesandten Unterlagen bearbeitet worden sind, kann das Meldesystem genutzt werden. Eine Benachrichtigung über die Freischaltung erfolgt elektronisch an die vom Nutzer bei der Registrierung angegebene Emailadresse.

VG Wort-Plug-In-Einstellungen in OJS

Um das VG Wort Plug-in in OJS zu benutzen muss der Zeitschriftenverwalter, nachdem er das Plug-In eingeschaltet hat, zuerst die Einstellungen für das VG Wort Plug-In in OJS vornehmen (s. Abbildung 2.1):

Die Zugangsdaten (Benutzername und Passwort), die die Zeitschrift für das Meldesystem T.O.M. verwendet (s. 1 Registrierung der Zeitschrift bei der VG Wort), müssen in VG Wort- Plug-In-Einstellungen eingegeben werden. Diese werden für die Authentifizierung für alle VG Wort-Services benutzt, die in OJS verwendet werden (Abruf von Zählmarken, Überprüfung der Karteinummer, Übermittlung der Meldung und Qualitätskontrolle).

Der Zeitschriftenverwalter muss die Redakteure auswählen, die berechtigt sind, in OJS die Zählpixel zu verwalten und die VG Wort-Services zu benutzen.

Außerdem muss der Zeitschriftenverwalter die minimale Anzahl der Zählmarken eingeben. Beim Erreichen der eingegebenen minimalen Anzahl der Zählmarken im System werden die berechtigten Redakteure per E-Mail benachrichtigt um neue Zählmarken abzurufen.

2.1Settings.png

Abbildung 2.1: VG Wort Plug-In-Einstellungen

Verwaltung der Zählmarken in OJS

Die berechtigte Redakteure, die in Plug-In-Einstellungen definiert sind, sehen den VG Wort-Bereich auf ihrer Startseite (s. Abbildung 3.1) und können die Zählmarken in OJS verwalten: abrufen, zuweisen, melden oder VG Wort Statistiken anschauen.

3.1Management.png

Abbildung 3.1: VG Wort-Bereich auf der Startseite des Redakteurs

Abruf der Zählmarken

Um Zählmarken den Texten in OJS zuweisen zu können, muss die Zeitschrift über freie Zählmarken in OJS verfügen. Unter den frei verfügbaren Zählmarken haben die berechtigten Redakteure die Möglichkeit neue Zählmarken zu bestellen (s. Abbildung 4.1). Die Anzahl der zu bestellenden Zählmarken muss zwischen 1 und 100 und sollte über den in den Plug-In-Einstellungen definierten minimalen Wert liegen.

4.1Order.png

Abbildung 4.1: Abruf neuer Zählmarken

Zuweisung einer Zählmarke

Die berechtigte Redakteure haben in der Beitragszusammenfassungsansicht die Möglichkeit, dem Beitrag eine in OJS frei verfügbare Zählmarke zuzuweisen (s. Abbildung 5.1). Falls keine frei verfügbaren Zählmarken vorhanden sind, müssen zuerst welche bestellt werden (s. 4 Abruf der Zählmarken).

5.1Assignment.png

Abbildung 5.1: Zuweisung einer Zählmarke

Bei der Zuweisung einer Zählmarke zu einem Text müssen die folgenden Anforderungen beachtet werden:

Für jeden Autor muss die VG Wort-Kateinummer existieren. Diese ist in der Autormetadaten einzugeben entweder bei der Einreichung eines Artikels oder später beim Editieren der Metadaten (s. Abbildung 5.2). D.h. jeder Autor muss bei der VG Wort als Autor registriert sein. Nach der erfolgreichen Registrierung erhält jeder VG Wort-Nutzer die Karteinummer.

5.2CardNo.png

Abbildung 5.2: Eingabe der Autor VG Wort Karteinummer

VG Wort unterscheidet im Moment zwischen einem Gedicht und anderen Texten. Die Texte, die kein Gedicht sind, müssen mindestens 1800 Zeichen (inkl. Leerzeichen) lang sein. Der Texttyp ist vom Redakteur bei der Zuweisung einer Zählmarke zu bestimmen.

Für Online-Texte berücksichtigt VG Wort im Moment nur HTML- und PDF-Formate. D.h. eine HTML- oder eine PDF-Fahne muss für den Text existieren, dem die Zählmarke zugewiesen wurde d.h. für den die Zählmarke eingebaut werden sollte.

Die Fahnen dürfen nicht mehr als 15MB groß sein.

Solange der Text bei der VG Wort nicht gemeldet ist, kann der Texttyp geändert werden.

Die Zählung kann jederzeit gestoppt werden indem die Zählmarke entfernt wird (s. Abbildung 5.3) oder wieder aktiviert werden indem die Zählmarke wieder eingebaut wird (s. Abbildung 5.4):

5.3Remove.png

Abbildung 5.3: Entfernen einer zugewiesenen Zählmarke

5.4Reinsert.png

Abbildung 5.4: Wieder einfügen einer entfernten Zählmarke

Textmeldung

Die korrekte Meldung ist Voraussetzung für die Ausschüttung und muss nur ein mal erfolgen.

Bei der Meldung einer Zählmarke bzw. eines Textes müssen die folgenden Anforderungen beachtet werden:

Der zu meldende Text sollte stabil sein. D.h. der Text sollte publiziert sein und sich möglichst nicht mehr ändern. Alle Fahnen sollten möglichst vorhanden sein und ihre URLs sich möglichst nicht mehr ändern.

Für jede Fahne (Textversion) wird bei VG Wort ein Webbereich mit einer URL (die von der Fahne) gemeldet. Der Fall, wenn eine Textversion über mehrere Webseiten verteilt wird (ein Webbereich mit mehreren URLs) wird hier nicht unterstützt.

Wenn die Meldung einmal erfolgt ist, kann sie nicht mehr geändert werden!!! Die einzig mögliche Änderung ist das manuelle Hinzufügen neuer Webbereiche im/über das VG Wort-Portal. Das könnte z.B. der Fall sein wenn eine zusätzliche Fahne hochgeladen/veröffentlicht wird oder sich die Zeitschriftendomain oder URLs ändern nachdem die Meldung schon erfolgt ist. Falls doch ein Fehler unterlaufen ist und der Text neu gemeldet werden muss, muss VG Wort kontaktiert werden.

Falls außer Autoren eines Beitrags auch Übersetzer an der Ausschüttung teilnehmen sollten, kann KEINE korrekte Meldung aus OJS erfolgen, da es in OJS keine Möglichkeit gibt, die benötigten Daten über den Übersetzer (den Vor- und Nachnamen sowie die VG Wort Karteinummer) zu erfassen. In so einem Fall muss die Meldung manuell, über das VG Wort-Portal erfolgen.

Die Meldung eines Textes sollte möglichst in der Nacht (zwischen 22:00 und 04:00 Uhr) erfolgen, wenn die Aktivitäten auf dem VG Wort-Server und die damit zusammenhängende Überlastung niedrig sind.

Nach der Textmeldung

Nachdem ein Text gemeldet ist, wir die Meldung von einem VG Wort-Mitarbeiter überprüft. Bei Problemen wird die Zeitschrift per E-Mail, die bei der Verlagsregistrierung angegeben ist, benachrichtigt. Beim Erreichen der Mindestzugriff werden alle Autoren von der VG Wort benachrichtigt.

Für Autoren

Um einen Online-Text melden zu können, muss jeder Autor des Textes bei der VG Wort als Autor registriert sein und die VG Wort-Karteinummer haben. Die Registrierung erfolgt über T.O.M. (Texte Online Melden), das Registrierungs- und Meldeportal der VG Wort und besteht aus zwei, miteinander verbundenen Vorgängen:

  • die Online über das Meldesystem durchgeführte Registrierung
  • die fristgerechte, postalische Zusendung der unterschriebenen Unterlagen, die im Anschluss an die Registrierung im System heruntergeladen werden könne, an die VG WORT.

Erst wenn beide Vorgänge abgeschlossen und die eingesandten Unterlagen bearbeitet worden sind, kann das Meldesystem genutzt werden. Eine Benachrichtigung über die Freischaltung erfolgt elektronisch an die vom Nutzer bei der Registrierung angegebene Emailadresse.

Die VG Wort-Karteinummern sind für jeden Autor bei der Einreichung eines Artikels oder evtl. später beim Editieren der Metadaten in OJS einzugeben (s. Abbildung 1).

Die Redaktion sollte über den Wunsch den Text zu melden benachrichtigt werden.

Die Texte, die kein Gedicht sind, müssen mindestens 1800 Zeichen (inkl. Leerzeichen) lang sein.

Die Zählmarke wird dem Text durch die Redaktion zugewiesen.

Der Text wird von der Redaktion bei der VG Wort gemeldet und eine Benachrichtigungs-E-Mail wird an alle Autoren verschickt.

Beim Erreichen der Mindestzugriff werden alle Autoren von der VG Wort benachrichtigt.