Difference between revisions of "VGWortPlugIn Doku"

From PKP Wiki
Jump to: navigation, search
Line 10: Line 10:
 
Bitte lesen Sie die README Datei für die Installation.  
 
Bitte lesen Sie die README Datei für die Installation.  
  
==== Bemerkungen ====
+
'''Bemerkungen''':
  
 
Wegen eines Bugs in OJS 2.3.6 kann das Plug-In '''NICHT''' von der/dem Zeitschriftenverwalter/in (Plug-Ins > Ein neues Plug-In installieren) korrekt installiert werden!
 
Wegen eines Bugs in OJS 2.3.6 kann das Plug-In '''NICHT''' von der/dem Zeitschriftenverwalter/in (Plug-Ins > Ein neues Plug-In installieren) korrekt installiert werden!

Revision as of 03:26, 26 July 2011

VG-Wort-Plug-In für OJS

Das ist die Benutzer/innendokumentation 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 worden ist.

Für Redaktion

Plug-In heruntergeladen: http://pkp.sfu.ca/support/forum/viewtopic.php?f=28&t=7758

Für die Nutzung des VG-Wort-Plug-Ins werden auf dem OJS-Server PHP-Version >= 5.0.1, PHP Soap und PHP OpenSSL extension modules benötigt.

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

Bemerkungen:

Wegen eines Bugs in OJS 2.3.6 kann das Plug-In NICHT von der/dem Zeitschriftenverwalter/in (Plug-Ins > Ein neues Plug-In installieren) korrekt installiert werden!

Da das XML-Korrekturfassungen-Plug-In einige Probleme aufweist, kann VG-Wort-Plug-In in Zusammenhang mit diesem Plug-In nicht korrekt verwendet werden.

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önnen, 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 von dem/der Nutzer/in bei der Registrierung angegebene E-Mail-Adresse.

VG-Wort-Plug-In-Einstellungen in OJS

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

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

Der/die Zeitschriftenverwalter/in muss die Redakteur/innen auswählen, die berechtigt sind, in OJS die Zählpixel zu verwalten und die VG-Wort-Dienste zu benutzen.

Außerdem muss der/die Zeitschriftenverwalter/in die minimale Anzahl der Zählmarken eingeben. Beim Erreichen der eingegebenen minimalen Anzahl der Zählmarken im System werden die berechtigten Redakteur/innen per E-Mail benachrichtigt, damit sie neue Zählmarken abrufen.

2.1Settings.png

Abbildung 2.1: VG-Wort-Plug-In-Einstellungen

Verwaltung der Zählmarken in OJS

Die berechtigten Redakteur/innen, die in den Plug-In-Einstellungen definiert sind, sehen einen neuen VG-Wort-Bereich auf ihrer Startseite (siehe 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/der Redakteurin

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 Redakteur/innen die Möglichkeit neue Zählmarken zu bestellen (siehe 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 berechtigten Redakteur/innen 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 (siehe 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 jede/n Autor/in muss die VG-Wort-Kateinummer existieren. Diese sollte in den Artikelmetadaten zum/zur Autor/in in Einreichungsschritt 3 oder bei späterer Bearbeitung der Metadaten in der Beitragszusammenfassungsansicht eingetragen werden (siehe Abbildung 5.2). Jede/r Autor/in muss bei der VG Wort als Autor/in registriert sein. Nach der erfolgreichen Registrierung erhält jede/r VG-Wort-Nutzer/in die Karteinummer.

5.2CardNo.png

Abbildung 5.2: Eingabe der VG-Wort-Karteinummer für eine/n Autor/in

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

Für Online-Texte berücksichtigt VG Wort im Moment nur HTML- und PDF-Formate. Es muss also mindestens eine HTML- oder PDF-Fahne für den Text existieren, dem die Zählmarke zugewiesen bzw. für den die Zählmarke eingebaut werden soll.

Die Fahnen dürfen nicht größer als 15 MB 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 (siehe Abbildung 5.3) oder wieder aktiviert werden indem die Zählmarke wieder eingebaut wird (siehe Abbildung 5.4):

5.3Remove.png

Abbildung 5.3: Entfernen einer zugewiesenen Zählmarke

5.4Reinsert.png

Abbildung 5.4: Wiedereinfü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 Autor/innen eines Beitrags auch Übersetzer/innen 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 die Übersetzer/innen (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, wird die Meldung von der VG Wort überprüft. Bei Problemen wird die Zeitschrift per E-Mail an die Adresse, die bei der Verlagsregistrierung angegeben worden ist, benachrichtigt.

Beim Erreichen der Mindestzugriffszahl werden alle Autor/innen von der VG Wort benachrichtigt.

Für Autoren

Um einen Online-Text melden zu können, muss jede/r Autor/in des Textes bei der VG Wort als Autor/in registriert sein und die VG-Wort-Karteinummer haben.

Die Registrierung erfolgt über T.O.M. [3] (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 von dem/der Nutzer/in bei der Registrierung angegebene E-Mail-Adresse.

Die VG-Wort-Karteinummern sind für jede/n Autor/in bei der Einreichung eines Artikels oder evtl. später beim Editieren der Metadaten in OJS einzugeben (siehe Abbildung 5.2 oben).

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 Mindestzugriffszahl werden alle Autor/innen von der VG Wort benachrichtigt.

Kontakt/Support

Für Support, Fehlerbehebung oder Kommentare benutzen Sie bitte das deutschsprachige OJS-Forum (http://www.carpet-project.net/forum/themen/ojs_ocs_omp_harvester.html) oder schicken Sie bitte eine E-Mail an die Autorin.

VG Wort Plug-In Bugtracking