Acrolinx IQ. Acrolinx IQ Web Checker Administrationshandbuch 2.9

Transkript

1 Acrolinx IQ Acrolinx IQ Web Checker Administrationshandbuch 2.9

2 2 Inhalt Übersicht 3 Informationen über dieses Handbuch...3 Was ist der Acrolinx IQ Web Checker?...3 Installation 4 Kopieren des Acrolinx IQ Plug-in Installationspakets...4 Benutzerauthentifizierung...4 Erstellen einer universellen Benutzerkennung für das Acrolinx IQ Plug-in...5 Konfigurieren von Single Sign-on...5 Konfigurieren des Webservers...8 Integrieren des Webcheckers auf Webseiten...9 Konfiguration und Aktualisierung 11 Konfigurieren der Schaltflächen in der Symbolleiste...11 Festlegen der standardmäßigen Prüfoptionen...11 Konfigurieren des Namens der geprüften Datei für den Prüfbericht...13 Konfigurieren der Kontextdaten...14 Aktualisieren des Acrolinx IQ Plug-ins...15

3 3 1 Übersicht Informationen über dieses Handbuch Verwendungszweck Das Acrolinx IQ Web Checker Administrationshandbuch enthält Informationen zur Installation und Konfiguration des Acrolinx IQ Web Checker. Zielgruppe Das Acrolinx IQ Web Checker Administrationshandbuch richtet sich an technische Mitarbeiter, die das Acrolinx IQ Web Checker installieren, konfigurieren und verwalten. Was ist der Acrolinx IQ Web Checker? Der Acrolinx IQ Web Checker ist ein jquery-basiertes Tool, das in jede beliebige Webseite integriert werden kann. Sie integrieren den Web Checker, indem Sie die entsprechenden Dateien installieren und den Quellcode der Webseiten aktualisieren. Der Acrolinx IQ Web Checker wurde mit jquery Version 1.7 getestet. Andere Versionen können funktionieren, wurden aber nicht getestet. Weitere Informationen zur jquery-syntax finden Sie auf der jquery-website.

4 4 Installation 2 Installation Sie installieren den Acrolinx IQ Web Checker, indem Sie das Paket mit dem Acrolinx IQ Web Checker auf Ihren Webserver kopieren. Um die Installation abzuschließen, müssen Sie außerdem verschiedene Anpassungen am Quellcode der Webseiten vornehmen. Die Installation setzt sich aus folgenden Hauptschritten zusammen: 1. Herunterladen des Installationspakets für den Acrolinx IQ Web Checker. 2. Kopieren des Installationspakets für den Web Checker zum Webserver. 3. Konfigurieren einer universellen Benutzerkennung oder Aktivieren von Single Sign-on für Acrolinx IQ. 4. Konfigurieren des Webservers zur Kommunikation mit Acrolinx IQ Server. 5. Integrieren des Web Checkers auf einer oder mehreren Webseiten. Sie können die im Installationsverzeichnis des Web Checkers enthaltene Beispieldatei als Referenz verwenden. Kopieren des Acrolinx IQ Plug-in Installationspakets Um den Web Checker zu installieren, müssen Sie die Dateien aus dem Installationspaket in das Verzeichnis auf Ihrem Webserver kopieren, in dem die Webserver-Software nach den Dateien sucht, die für die Domain verwendet werden. Bei einem Apache-Webserver müssen Sie das Installationspaket zum Beispiel in das Verzeichnis htdocs kopieren. Bei IIS müssen Sie das Installationspaket dagegen in das Verzeichnis wwwroot kopieren. â So kopieren Sie das Acrolinx IQ Plug-in 1. Entpacken Sie das Installationspaket. 2. Kopieren Sie die Dateien aus dem Installationspaket in das Verzeichnis auf Ihrem Webserver, in dem die Webserver-Software nach den Dateien sucht, die für die Domain verwendet werden. Beispiel: C:\Program Files\Apache Software Foundation\Apache2.4 \htdocs\ Benutzerauthentifizierung Im Rahmen der Installation müssen Sie festlegen, wie der Web Checker sich am Acrolinx IQ Server authentifiziert. Die Authentifizierung kann dabei entweder mit einer universellen Benutzerkennung durchgeführt werden, oder es können die Benutzerdaten an den Server übermittelt werden, die zur Anmeldung in einer anderen Webanwendung verwendet wurden, zum Beispiel bei der Anmeldung in einer Single Sign-on-Umgebung.

5 5 In beiden Fällen müssen Sie die Installation von Acrolinx IQ Server aktualisieren, bevor Sie den Web Checker einsetzen können. Erstellen einer universellen Benutzerkennung für das Acrolinx IQ Plug-in Sie müssen die Benutzerkennung im Acrolinx IQ Server erstellen, bevor Sie den Acrolinx IQ Web Checker so konfigurieren können, dass eine Verbindung mit einer universellen Benutzerkennung hergestellt werden kann. Die universelle Benutzerkennung wird verwendet, um auf den Acrolinx IQ Web Checker zuzugreifen, die Anmeldung am Acrolinx IQ Server durchzuführen und sie wird in den Prüfberichten angezeigt. Der erstellte Benutzer muss die Standardrolle Technical Writer haben oder, wenn diese Rolle entfernt oder umbenannt wurde, eine Rolle mit den Benutzerrechten Dokumente prüfen und Termextraktion ausführen haben. â So legen Sie den Benutzernamen für den Web Checker fest Melden Sie sich am Acrolinx IQ Dashboard an und erstellen Sie einen Benutzer im Abschnitt Benutzer. Notieren Sie sich die erstellte Benutzerkennung, weil Sie diese bei der Konfiguration des Plug-ins benötigen. Konfigurieren von Single Sign-on Wenn Ihre Webanwendungen in einer Single Sign-on-Umgebung ausgeführt werden, können Sie den Acrolinx IQ Web Checker so konfigurieren, dass er ebenfalls in dieser Umgebung funktioniert. Sie konfigurieren Single Sign-on, indem Sie die Konfiguration des Web Checkers und die Acrolinx IQ Hauptserver-Eigenschaften bearbeiten. Was ist Single Sign-on? Single Sign-on (SSO) ist ein Verfahren zur Benutzerauthentifizierung. Wenn SSO verwendet wird, müssen Benutzer ihre Anmeldedaten nur einmal eingeben, um auf mehrere Anwendungen zugreifen zu können. So wird gewährleistet, dass Benutzer sich nicht jedesmal erneut anmelden müssen, wenn sie die Anwendung wechseln. Netzwerkadministratoren können SSO so konfigurieren, dass Benutzer nur auf bestimmte Anwendungen zugreifen können. Web SSO funktioniert nur mit Anwendungen, auf die mit einem Webbrowser zugegriffen wird. Die Anfrage für den Zugriff auf die Webressource wird dabei entweder von einer Komponente im Webserver oder der Anwendung selbst abgefangen. Unautorisierte Benutzer werden zu einem Authentifizierungsdienst umgeleitet und erhalten nur nach erfolgreicher Authentifizierung Zugriff. Welche Kommunikationsmethoden werden von Acrolinx IQ unterstützt? Sie können die folgenden Methoden verwenden, um die SSO-Details eines Benutzers zu ermitteln. Central Authentication Service (CAS)

6 6 Installation Der Acrolinx Server authentifiziert Benutzer über das CAS-Protokoll. CAS ist ein Webprotokoll, das speziell für die Authentifizierung von Benutzern mit SSO verwendet wird. Sie benötigen einen CAS-Server, um CAS zu verwenden. Basic Access Authentication Der Acrolinx Server liest die Benutzerdaten, die während der Basic Access Authentication übermittelt werden. Webbrowser können diese grundlegende Authentifizierung verwenden, um Benutzernamen und Passwort zu übermitteln. Sie können die Benutzerdaten übermitteln, indem Sie den Benutzernamen und das Passwort, getrennt von einem Doppelpunkt, der URL voranstellen: Die Benutzerdaten werden dann verschlüsselt und an den Server übertragen. Sie können den Acrolinx Server so konfigurieren, dass dieser in den verschlüsselten Daten nach den Benutzerdaten sucht. Header Der Acrolinx Server sucht die Benutzerdaten in den HTTP-Header-Feldern, die bei Datenübertragungen zwischen Webbrowser und Webserver enthalten sind. Sie müssen den Webserver zunächst so konfigurieren, dass die Anmeldedaten in den HTTP-Header-Feldern eingeschlossen wird. Request Parameter Der Acrolinx Server sucht die Benutzerdaten in den Parametern, die während einer HTTP-Anfrage übermittelt werden, zum Beispiel die Parameter, die in der URL während einer GET-Anfrage enthalten sind. Sie müssen Ihre Webseiten zunächst so konfigurieren, dass die Benutzerdaten in den Request-Parametern eingeschlossen werden. Wie gestaltet sich die Interaktion zwischen dem Webserver und dem Acrolinx Server beim Authentifizieren von Benutzern? Der Acrolinx IQ Server sucht in den während einer Anfrage übermittelten Daten nach dem Schlüssel mit dem Benutzernamen und Passwort, wenn sich Benutzer bei einer Webanwendung anmelden und eine Prüfung mit dem Web Checker durchführen. Wenn der Benutzer bereits vorhanden ist, sind keine weiteren Schritte erforderlich. Wenn der Benutzer noch nicht vorhanden ist, wird er automatisch in der Acrolinx IQ Datenbank erstellt und erhält dabei dieselben Anmeldedaten, die zur Anmeldung in der Webanwendung verwendet wurden. Wenn kein entsprechender Schlüssel gefunden wird, meldet der Acrolinx IQ Server einen Authentifizierungsfehler und die Prüfung kann nicht durchgeführt werden. Aktivieren von Single Sign-on Um den Acrolinx IQ Web Checker für Ihre SSO-Umgebung einzurichten, müssen Sie SSO zunächst in den Konfigurationseigenschaften aktivieren. â So aktivieren Sie SSO 1. Öffnen Sie den Quelltext einer Webseite oder einer entsprechenden Vorlage, in der Sie den Acrolinx Web Checker konfiguriert haben. 2. Fügen Sie die folgende Zeile zu den Einstellungen für den Web Checker hinzu:

7 7 enablesinglesignon: true, Die vollständige Konfiguration kann dann wie im folgenden Beispiel aussehen: jquery(function() { acrolinx.addwebchecker('textarea',{ serverproxypath: '/acrolinx', enablesinglesignon: true, }); }); 3. Speichern Sie die Datei und Konfigurieren der SSO-Eigenschaften auf Seite 7. Konfigurieren der SSO-Eigenschaften Um Acrolinx IQ in Ihrer Single Sign-on-Umgebung zu integrieren, müssen Sie die entsprechenden Eigenschaften im Acrolinx IQ Server konfigurieren. â So konfigurieren Sie die SSO-Eigenschaften 1. Öffnen Sie die Hauptserver-Eigenschaftendatei und fügen Sie die folgende Eigenschaft hinzu: singlesignon.method=<methode_name> Mögliche Werte sind: cas, basic_authentication, header, request_parameter Konfigurieren Sie die Eigenschaft folgendermaßen, um den Server so zu konfigurieren, dass nach dem SSO-Identifier im Request-Header gesucht wird: singlesignon.method=header 2. (Optional) Sie können die folgende Eigenschaft verwenden, um das generische Passwort Ihrer SSO-Umgebung zu verwenden: singlesignon.genericpassword=<passwort> Beispiel: singlesignon.genericpassword=sus5abut Durch generische Passwörter müssen Benutzer nicht in jeder Anwendung ein eigenes Passwort anlegen. Benutzer von Acrolinx werden ohne Passwörter erstellt, wenn Sie ein generisches Passwort konfigurieren. Sie müssen ein gesondertes Passwort für alle Benutzer konfigurieren, die Zugriff auf die Term Contribution benötigen. Term Contribution ist kein Bestandteil des Supports von Acrolinx für Single Sign-on. Wenn Sie einen Benutzer bearbeiten und im Dashboard ein Passwort hinzufügen, wird dieses Passwort für die Term Contribution verwendet. Bei der Authentifizierung des Benutzers im Web Client wird das Passwort jedoch ignoriert. Stattdessen wird das generische Passwort verwendet. 3. Fügen Sie die folgende Eigenschaft hinzu, um Single Sign-on auf eine bestimmte Gruppe konfigurierbarer Hosts zu begrenzen: singlesignon.allowedremoteaddresses=<adressen> Im folgenden Beispiel wurde eine kommagetrennte Liste sicherer Remote-Adressen mithilfe regulärer Ausdrücke eingegeben: singlesignon.allowedremoteaddresses=10\.10\..*\..*,192\.168\..*\..*

8 8 Installation Hinweis: Reguläre Ausdrücke müssen in der Java-Syntax für reguläre Ausdrücke eingegeben werden. Bereichsqualifizierer wie \d{1,3} werden nicht unterstützt, weil die darin enthaltenen Kommas zu Fehlern bei der Interpretation der Eigenschaft führen. 4. Fügen Sie die folgenden Eigenschaften hinzu, um die Namen der Schlüssel der Benutzernamen und Passwörter zu definieren: singlesignon.usernamekey=username singlesignon.passwordkey=password Im folgenden Beispiel sind alle Eigenschaften aufgeführt, die zur Konfiguration von SSO erforderlich sind. singlesignon.method=header singlesignon.genericpassword=sus5abut singlesignon.usernamekey=username singlesignon.passwordkey=password singlesignon.allowedremoteaddresses=10\.10\..*\..*,192\.168\..*\..* 5. Speichern Sie die Datei und starten Sie den Hauptserver neu. Konfigurieren des Webservers Um die Prüfungsfunktionen im Acrolinx IQ Web Checker zu aktivieren, müssen Sie Ihren Webserver so konfigurieren, dass dieser die internen Prüfanfragen an die Installation von Acrolinx IQ Server weiterleitet. Dafür müssen Sie einen Reverse Proxy auf Ihrem Webserver einrichten. Die dafür erforderlichen Schritte sind bei jedem Webserver anders. Im folgenden Beispiel wird beschrieben, wie Sie einen Reverse Proxy auf einem Apache-Server einrichten. Wenn Sie einen IIS-Server verwenden, finden Sie Informationen zur Konfiguration eines Reverse Proxy mit ARR (Application Request Routing) im IIS-Blog. â So konfigurieren Sie einen Apache-Webserver zur Weiterleitung der Prüfanfragen an den Acrolinx IQ Server 1. Öffnen Sie die Konfigurationsdatei des Webservers. Beispiel: \apache\conf\httpd.conf 2. Entfernen Sie das Kommentarzeichen in den folgenden Zeilen, um die Module für die Reverse Proxy-Funktionalität zu aktivieren. #LoadModule proxy_module modules/mod_proxy.so #LoadModule proxy_http_module modules/mod_proxy_http.so 3. Fügen Sie die folgenden Zeilen am Ende der Konfigurationsdatei hinzu und aktualisieren Sie die Variable <SERVER_ADRESSE> mit der Adresse Ihres Acrolinx IQ Server: ProxyPass /acrolinx ProxyPassReverse /acrolinx Wenn die externe Basis-URL ein langer Pfad ist, müssen Sie unter Umständen auch die Verweise in der Termhilfevorlage aktualisieren. Relative Verweise wie zum Beispiel die URLs von Abbildungen werden möglicherweise nicht korrekt dargestellt, wenn Sie die Termhilfevorlage nicht mit der Variablen der externen Basis-URL aktualisieren. Weitere

9 9 Informationen finden Sie in den Informationen zur Variablen $external BaseUrl im Abschnitt über die Variablen der Termhilfevorlagen im Acrolinx IQ Terminologiemanager Benutzerhandbuch. 4. Speichern Sie die Datei und starten Sie den Webserver neu. Integrieren des Webcheckers auf Webseiten Sie müssen den Quellcode Ihrer Webseiten modifizieren, damit Sie den Acrolinx IQ Web Checker verwenden können. Wenn Sie Ihre Webseiten aus einer Vorlage erstellen, müssen Sie entsprechend diese Vorlage anpassen. Im Installationsverzeichnis des Web Checkers ist die Beispieldatei example. html enthalten, die Sie als Referenz beim Anpassen der Webseiten verwenden können. â So integrieren Sie den Web Checker auf einer Webseite 1. Öffnen Sie den Quellcode einer Webseite oder die entsprechende Vorlage, in der Sie den Web Checker integrieren möchten. Beispiel: C:\Program Files\Apache Software Foundation\Apache2.4 \htdocs\tospin\forms\registration.html 2. Fügen Sie Verweise zu den Dateien des Web Checkers hinzu, indem Sie die folgenden Inhalte nach dem Tag <head> auf der Webseite einfügen: <link rel="stylesheet" href="acrolinx-web-checker/libs/jquery-ui/css/ui-lightness/jquery-ui.custom.css"> <link rel="stylesheet" href="acrolinx-web-checker/libs/jquery.contextmenu.css"> <link rel="stylesheet" href="acrolinx-web-checker/css/acrolinx-web-checker.css"> <script type="text/javascript" src="acrolinx-web-checker/libs/jquery.min.js"></script> <script type="text/javascript" src="acrolinx-web-checker/libs/jquery-ui/js/jquery-ui.custom.min.js"></script> <script type="text/javascript" src="acrolinx-web-checker/libs/jquery.contextmenu.js"></script> <script type="text/javascript" src="acrolinx-web-checker/js/acrolinx-web-checker.js"></script> In diesem Beispiel wird angenommen, dass der Web Checker im selben Verzeichnis wie die Webseiten gespeichert ist. Konfigurieren Sie einen absoluten Pfad zu jeder Datei des Web Checkers, wenn Sie den Web Checker in Webseiten integrieren möchten, die auf einem anderen Server oder in einem anderen Verzeichnis gespeichert sind. Bei einem absoluten Pfad würde zum Beispiel die erste Zeile des vorigen Beispiels folgendermaßen lauten: <link rel="stylesheet" href=" 3. Konfigurieren Sie die standardmäßigen Prüfoptionen, indem Sie die folgenden Inhalte nach dem schließenden Tag </head> auf der Webseite einfügen:

10 10 Installation <script type="text/javascript"> jquery(function() { acrolinx.addwebchecker('<feld_auswahl>',{ <KONFIGURATION_EINSTELLUNGEN>, }); }); </script> 4. Legen Sie fest, in welchen Textfeldern auf der Webseite die Acrolinx Symbolleiste angezeigt werden soll, indem Sie die Auswahlkriterien anstelle des Platzhalters <FELD_AUSWAHL> eingeben. Die Syntax zur Auswahl eines Felds basiert auf den jquery-selektoren zum Abgleichen einer bestimmten Menge von Elementen in einem Dokument. Um die Symbolleiste zum Beispiel in alle Textfelder einer Webseite zu integrieren, müssen Sie den Quellcode folgendermaßen anpassen: acrolinx.addwebchecker('textarea',{ Um die Symbolleiste in alle Textfelder mit der ID comment zu integrieren, müssen Sie den Quellcode folgendermaßen anpassen: acrolinx.addwebchecker('#comment',{ Um die Symbolleiste in alle Textfelder mit der Klasse textinput zu integrieren, müssen Sie den Quellcode folgendermaßen anpassen: acrolinx.addwebchecker('.textinput',{ 5. Konfigurieren Sie die Authentifizierungs- und Verbindungseinstellungen, indem Sie indem Sie die Verbindungseinstellungen anstelle des Platzhalters <KONFIGURATION_EINSTELLUNGEN> eingeben. Fügen Sie die folgenden Zeilen hinzu, um den Pfad zu Acrolinx IQ Server zu definieren und Single Sign-on zu aktivieren, wenn Sie das Plug-in in einer Umgebung mit Single Sign-on verwenden: acrolinx.addwebchecker('textarea',{ serverproxypath: '/acrolinx', enablesinglesignon: true, }); Fügen Sie die folgende Zeile hinzu, um den Pfad zu Acrolinx IQ Server zu definieren und die universelle Benutzerkennung zu konfigurieren, wenn Sie eine universelle Benutzerkennung (siehe "universelle Benutzerkennung") verwenden: acrolinx.addwebchecker('textarea',{ serverproxypath: '/acrolinx', username: <BENUTZERKENNUNG>', password: <PASSWORT>', }); Ersetzen Sie die Platzhalter mit der Benutzerkennung und dem Passwort, die Sie im Dashboard konfiguriert haben, damit die Zeile ähnlich wie im folgenden Beispiel aussieht: acrolinx.addwebchecker('textarea',{ serverproxypath: '/acrolinx', username: 'webchecker', password: '8aPebeRa', }); 6. Speichern Sie die Datei, laden Sie die Webseite neu und prüfen Sie, ob in den gewünschten Textfeldern die Acrolinx Symbolleiste angezeigt wird.

11 11 3 Konfiguration und Aktualisierung Konfigurieren der Schaltflächen in der Symbolleiste Sie können konfigurieren, welche Schaltflächen in der Acrolinx IQ Symbolleiste dargestellt werden. Dies ist hilfreich, um festzulegen, auf welche Funktionen die Benutzer zugreifen dürfen. Sie können zum Beispiel die Schaltfläche Optionen entfernen, wenn Benutzer immer die vom Administrator festgelegten Optionen verwenden sollen. Wichtig: Wenn Sie die Schaltfläche Optionen deaktivieren, müssen Sie zuvor die korrekten Prüfoptionen definieren (siehe "Festlegen der standardmäßigen Prüfoptionen" auf Seite 11). â So konfigurieren Sie die Schaltflächen in der Symbolleiste 1. Öffnen Sie den Quelltext einer Webseite oder einer entsprechenden Vorlage, in der Sie den Acrolinx Web Checker konfiguriert haben. 2. Fügen Sie die folgende Zeile zu den Einstellungen für den Web Checker hinzu: toolbarbuttons: ['check','options','remove-flags','report','help','about'] 3. Entfernen Sie die Einträge für die Schaltflächen, die Sie deaktivieren möchten. Um zum Beispiel die Schaltflächen Über... und Optionen zu deaktivieren, müssen Sie die Zeile toolbarbuttons wie im folgenden Beispiel aktualisieren: jquery(function() { acrolinx.addwebchecker('textarea',{ serverproxypath: '/acrolinx', username: 'webchecker', password: '8aPebeRa', toolbarbuttons: ['check','remove-flags','report','help'] }); }); 4. Speichern Sie die Datei, laden Sie die Webseite neu und prüfen Sie, ob die gewünschten Schaltflächen angezeigt werden. Festlegen der standardmäßigen Prüfoptionen Administratoren können standardmäßige Prüfoptionen konfigurieren, die automatisch im Web Checker ausgewählt sind. Diese Funktion ist in Umgebungen hilfreich, in denen Benutzer normalerweise mit demselben Dokumenttyp arbeiten (zum Beispiel Posts in einem Blog) und immer dieselben Prüfoptionen benötigen. Außerdem kann diese Funktion Fehler verhindern, die auftreten, wenn Benutzer die falschen Prüfoptionen wählen.

12 12 Konfiguration und Aktualisierung Es gibt zwei Arten vorkonfigurierbarer Prüfoptionen: Standardmäßige Prüfoptionen, die dauerhaft vom Benutzer geändert werden können. Benutzer erhalten zwar die vorkonfigurierten Prüfoptionen, können diese aber ändern und ihre Änderungen auch speichern. Wenn ein Benutzer die Seite neu lädt oder eine neues Dokument öffnet, werden die geänderten Prüfoptionen angewendet. Standardmäßige Prüfoptionen, die temporär vom Benutzer geändert werden können. Benutzer können die vorkonfigurierten Prüfoptionen zwar ändern, diese Änderungen aber nicht speichern. Wenn ein Benutzer die Seite neu lädt oder eine neues Dokument öffnet, werden wieder die vorkonfigurierten Prüfoptionen angewendet. â So konfigurieren Sie die standardmäßigen Prüfoptionen 1. Öffnen Sie den Quelltext einer Webseite oder einer entsprechenden Vorlage, in der Sie den Acrolinx Web Checker konfiguriert haben. 2. Fügen Sie die folgenden Zeilen zu den Einstellungen für den Web Checker hinzu: defaultchecksettings:{, um die Prüfoptionen festzulegen, die beim erstmaligen Öffnen des Web Checkers angewendet werden. Vom Benutzer durchgeführte Änderungen werden im Cache des Webbrowsers gespeichert. checksettings:{, um Prüfoptionen festzulegen, die bei jedem Neuladen der Seite und bei jedem neuen Dokument angewendet werden. Vom Benutzer durchgeführte Änderungen werden nicht gespeichert. 3. Fügen Sie in der nächsten Zeile die folgenden Zeilen hinzu, um die Prüfoptionen zu definieren: language: <SPRACH_ID>', rulesetname: <REGEL_SET>', checkspelling: <TRUE/FALSE>, checkgrammar: <TRUE/FALSE>, checkstyle: <TRUE/FALSE>, checkreuse: <TRUE/FALSE>, harvestterms: <TRUE/FALSE>, termstatuses: [ '<TERM_STATUS_NAME>','<TERM_STATUS_NAME>' ] termsets: [ '<TERM_SET_NAME>', '<TERM_SET_NAME>' ], } Für <TERM_STATUS_NAME> können Sie einen oder mehrere der folgenden Werte eingeben: TERMINOLOGY_DEPRECATED zur Prüfung auf gesperrte Terme. TERMINOLOGY_ADMITTED zur Prüfung auf erlaubte Terme. TERMINOLOGY_VALID zur Prüfung auf gültige Terme. Die vollständige Konfiguration kann dann wie im folgenden Beispiel aussehen:

13 13 jquery(function() { acrolinx.addwebchecker('textarea',{ serverproxypath: '/acrolinx', username: 'webchecker', password: '8aPebeRa', toolbarbuttons: ['check','remove-flags','report','help'], checksettings : { language : en, rulesetname : Standard_US, clientinformation : {}, checkspelling : true, checkgrammar : false, checkstyle : false, checkreuse : false, harvestterms : true, termstatuses : [ TERMINOLOGY_DEPRECATED, TERMINOLOGY_ADMITTED, TERMINOLOGY_VALID ] termsets : [ Standard, Switches ], } }); }); 4. Speichern Sie die Datei, laden Sie die Webseite neu und prüfen Sie, ob die Prüfoptionen den gemachten Änderungen entsprechen. Konfigurieren des Namens der geprüften Datei für den Prüfbericht Im Acrolinx IQ Prüfbericht sind unter anderem verschiedene administrative Informationen enthalten, zum Beispiel darüber, wer das Dokument geprüft hat, welches Plug-in verwendet wurde und wie der Name des geprüften Dokuments lautet. Weil in Textfeldern keine Dateinamen verwendet werden, wird im Prüfbericht automatisch ein standardmäßiger Dateiname verwendet. Diesen können Sie anpassen, indem Sie Ihre Integration des Web Checkers bearbeiten. So können Sie zum Beispiel den Dokumentnamen anpassen, damit bei der Überprüfung der Prüfberichte klar unterschieden werden kann zwischen Prüfungen, die mit dem Web Checker durchgeführt wurden, und Prüfungen, die mit anderen Produkten von Acrolinx IQ durchgeführt wurden, die auch keine Dokumentnamen kennen (zum Beispiel der Acrolinx IQ Desktop Checker). â So konfigurieren Sie den Namen der geprüften Datei für den Prüfbericht 1. Öffnen Sie den Quelltext einer Webseite oder einer entsprechenden Vorlage, in der Sie den Acrolinx Web Checker konfiguriert haben. 2. Fügen Sie die folgende Zeile zu den Einstellungen für den Web Checker hinzu: documentfilename: '<DOKUMENT_NAME>' Die vollständige Konfiguration kann dann wie im folgenden Beispiel aussehen: jquery(function() { acrolinx.addwebchecker('textarea',{ serverproxypath: '/acrolinx', username: 'webchecker', password: '8aPebeRa', toolbarbuttons: ['check','remove-flags','report','help'], documentfilename: 'web-checker-page', }); }); 3. Speichern Sie die Datei, laden Sie die Webseite neu, führen Sie eine Prüfung durch und prüfen Sie, ob der gewünschte Dokumentname angezeigt wird.

14 14 Konfiguration und Aktualisierung Konfigurieren der Kontextdaten Sie können den Web Checker so konfigurieren, dass Kontextdaten bestimmter Felder übermittelt werden. So stellen Sie sicher, dass verschiedene Kontexte korrekt geprüft werden. Einige Prüfregeln von Acrolinx lassen sich nur anwenden, wenn der geprüfte Text in einem bestimmten Kontext identifiziert wird. So wird Text, der als Titel identifiziert wird, daraufhin geprüft, dass die korrekte Titelform verwendet wird. Die meisten Acrolinx IQ Plug-ins übermitteln zusätzliche Daten über Sätze, die in Titel-Tags oder mit einer entsprechenden Formatvorlage formatiert sind, an den Acrolinx IQ Server, um sicherzustellen, dass Titel korrekt geprüft werden. Auf eine ähnliche Weise kann auch der Web Checker zusätzliche Daten über Titelfelder und andere Kontexte übermitteln. â So fügen Sie die Kontextdaten für ein Feld hinzu 1. Öffnen Sie den Quelltext einer Webseite, in der Sie den Web Checker integriert haben, und fügen Sie die folgende Zeile zu den Konfigurationseinstellungen hinzu: contextinfos: ['<KONTEXT_NAME>'], Die für diese Konfiguration verfügbaren Kontextnamen sind davon abhängig, wie viele kontextspezifische Regeln in den Sprachressourcen enthalten sind. Die meisten Sprachressourcen enthalten Regeln für Titelformen. Wenden Sie sich an Ihren Acrolinx Projektberater, wenn Sie besondere Regeln für andere Kontexte einsetzen und gewährleisten möchten, dass Sie dafür die korrekten Kontextnamen verwenden. So kann die vollständige Konfiguration wie im folgenden Beispiel aussehen, wenn Sie sicherstellen möchten, dass Benutzer die korrekte Titelform verwenden, wenn sie Text im Feld Page Title bearbeiten: jquery(function() { acrolinx.addwebchecker('#pagetitle',{ serverproxypath: '/acrolinx', username: 'webchecker', password: '8aPebeRa', contextinfos: ['h1'], }); }); Sie können den Web Checker zweimal hinzufügen, wenn auf einer Seite ein Feld für den Titel und ein Feld für den Textkörper vorhanden sind; dabei wird für eine Instanz die Einstellung für Kontexte und für die andere Instanz eine Einstellung wie im folgenden Beispiel verwendet: jquery(function() { acrolinx.addwebchecker('#pagetitle',{ serverproxypath: '/acrolinx', username: 'webchecker', password: '8aPebeRa', contextinfos: ['h1'], }); acrolinx.addwebchecker('#bodytext',{ serverproxypath: '/acrolinx', username: 'webchecker', password: '8aPebeRa', }); }); 2. Speichern Sie die Datei, laden Sie die Webseite neu und prüfen Sie Text in einem Feld mit einem Kontext, um sicherzustellen, dass die kontextrelevante Regel korrekt angewendet wird. Wenn Sie zum Beispiel einen Titelkontext konfiguriert haben, können Sie im Titelfeld kleingeschriebenen Text eingeben und prüfen, um sicherzustellen, dass der Text wegen der fehlenden Großschreibung markiert wird.

15 15 Aktualisieren des Acrolinx IQ Plug-ins Sie müssen alte Versionen des Plug-ins nicht deinstallieren, wenn Sie eine neue Version installieren. â So aktualisieren Sie das Acrolinx IQ Plug-in Kopieren Sie das Verzeichnis mit den aktualisierten Dateien des Acrolinx IQ Plug-ins auf den Webserver und ersetzen Sie die vorhandenen Dateien mit den neuen Versionen.

16 16 Index Index B Benutzerauthentifizierung 4 E Einleitung 3 I K Konfigurieren der Kontextdaten 14 Konfigurieren der SSO-Eigenschaften 7 U Übersicht 3 Informationen über dieses Handbuch 3