Kurier Handbuch

Voraussetzung

Das Interface wurde getestet mit den Browsern Internet Explorer und Firefox.

Die Eingabe von Artikeln für den GSI-Kurier wird von den Autoren selbst im Web-Interface eingestellt. Voraussetzung ist ein gültiger GSI-Web-Login-Account. Die Startseite kann in einem beliebigen Browser unter der Adresse https://kurier.gsi.de erreicht werden.

Die Ankündigung von Terminen erfolgt durch einen Import der eingetragenen Termine im Indico. Dabei müssen die gewünschten Kategorien entsprechend markiert sein. Bei Fragen dazu setzen Sie sich mit der Kurier-Redaktion mailto:kurier@gsi.de in Verbindung.

Es wird unterschieden zwischen zwei verschiedenen Modi:

• Autor
• Redakteur

Der Redaktionsschluss wird standardmäßig auf jeweils Donnerstag 12:00 Uhr verschoben. Die Verteilung erfolgt Montags per E-Mail an gsi-all, fair-all und phd-all.

Anmelden

Das folgende Anmeldefenster erscheint. Für die Option '''Im Backend einloggen''' benötigen Sie die erforderlichen Rechte.

Eingabe von Artikeln

Das Formular setzt sich aus verschiedenen Bereichen zusammen.

• Angaben zum Autoren
• Metadaten des Artikels (z.B. Erscheinungsdatum, extern oder intern)
• Text des Artikels

Angaben zum Autor

Zunächst wird angenommen, dass der eingeloggte Benutzer auch der Autor des Artikels ist. Alle bekannten LDAP-Daten, z.B. Vor- und Nachname, Telefonnummer, Abteilung usw. werden automatisch in die Formularfelder gefüllt. Ist das nicht richtig, muss die Option Für einen anderen Autor einen Artikel einstellen gesetzt und die Felder manuell ausgefüllt werden.

Metadaten des Artikels

Ein Artikel kann sowohl in deutscher oder englischer Sprache erstellt werden als auch nur in einer dieser Sprachen. Zum Schluss wird immer ein gesamter Kurier mit allen Artikeln erstellt.

Der Artikel-Flag entscheidet später über die Sichtbarkeit des Artikels im Web. Es besteht die Möglichkeit, einen Artikel sofort für mehrere auf einander folgende Wochen einzustellen.

Inhalt eines Artikel

Der verwendete Editor verfügt über viele Funktionen, von denen nur einige an dieser Stelle näher beschrieben werden.

Einfügen von Bildern

Zum Einfügen eines Bildes in den Artikel muss dieses zunächst hochgeladen werden.

Wählen Sie im neuen Explorer-Fenster die gewünschte Grafikdatei aus. Beachten Sie: das Bild darf '''max. 2 MB''' groß sein!

Ein Doppelklick auf die hochgeladene Datei fügt diese in den Artikel ein.

Hinweise für das Einbinden von Bildern in einem Artikel:

• Bilder möglichst in Originalgröße einbinden (bearbeiten Sie das Bild vorher mit einem Grafikprogramm, z.B. IrfanView oder gimp)
• Breite eines Bildes <= 600
• bei Skalierung Größenverhältnis beibehalten

Die Quellenangabe für Bild- bzw. Grafikmaterial ist zwingend notwendig.

Einfügen von Verknüpfungen

HTML für Besonderheiten

• Rahmen um einen Text setzen (z.B. für einen Nachruf):

  <div style='border: 1px solid black; padding: 10px;'>...</div>

• Bilder links oder rechts auf die Seite setzen:

  <div><img alt='' src='Bild' style='float: <b />left</b>; margin-right: 10px; width: 325px;' title='Bildunterschrift' /></div>

• Bild und Bildunterschrift im Block links auf die Seite setzen:

  <div style='margin-right: 10px; float: left;'><img alt='' src='Bild' style='height: 385px;' /><br /><small>Bildunterschrift</small></div>

Vorschau oder Bearbeiten eines Artikels

Gehen Sie über den Button Meine Artikel in die Liste aller Artikel, die von Ihnen eingestellt wurden.

Eine einfache Vorschau wird mit dem Button Anzeige realisiert. Zur Korrektur eines Artikels wählen Sie Bearbeiten

Eingabe von Terminen

Termine, die im Kurier erscheinen sollen, müssen

1. im Konferenzsystem Indico eingetragen und

2. Im Backend-Interface des Kuriers als zu übernehmende Veranstaltungsreihe gekennzeichnet

worden sein.

Die Termine, die in die Woche des zu erstellenden Kuriers fallen, erscheinen automatisch im Interface für den Redakteur und müssen durch diesen nochmal bestätigt (angekreuzt) werden.

Backend für den Redakteur

Im Backend wird der jeweils aktuelle Kurier durch einen Redakteur zusammengestellt und für den Druck aufbereitet. Es sind spezielle Rechte erforderlich.

Angaben zur Redaktion

Durch die Auswahl eines Redakteurs werden aus LDAP die notwendigen Daten in die Felder eingetragen.

Redaktionsschluss setzen/aufheben

Der Redaktionsschluss wird durch Klicken der Schaltfläche manuell gesetzt. Damit wird kein weiterer Artikel mehr für die ausgewählte Woche angenommen. Der Autor eines Artikels bekommt die nächste Kalenderwoche als frühesten Veröffentlichungstermin angeboten. Der Redaktionsschluss kann durch den Redakteur auch manuell wieder aufgehoben werden. Damit kann ein neuer Artikel wieder aufgenommen werden.

Zusammenstellen des Kuriers

Nach dem Setzen des Redaktionsschlusses muss der Redakteur die Ausgabe zusammenstellen. Das Backend setzt sich aus drei Bereichen zusammen:

• alle Artikel für die Wochenausgabe

• alle anstehenden Termine

Diese sollten kontrolliert und einzeln übernommen werden.

• aktueller Inhalt der neuen Ausgabe

Die Reihenfolge der Artikel kann einfach per Maus (Drag & Drop) geändert werden. Die Termine werden automatisch durch das Script aufsteigend sortiert.

Fertigstellen der neuen Ausgabe

Eine Vorschau auf den aktuellen Stand der neuen Ausgabe erreicht man über den Button Anzeigen

Durch den Button Fertigstellen wird die Ausgabe als endgültig gekennzeichnet. Diese Version wird dann durch einen Automatismus auf der Webseite https://www.gsi.de/kurier zur Verfügung gestellt.

Mit dem Button Druckausgabe und dem anschließenden Speichern der Webseite wird die entsprechende HTML-Datei erstellt, die dann im MS Word mit einem Makro für den eigentlichen Druck aufbereitet wird. Manuelle Änderungen bezüglich Seitenumbruch und Ähnlichem sind an dieser Stelle noch möglich. Die Dateien liegen alle unter \\winfilesvh\kurier$

Technische Umsetzung

Sourcen und Code

Die Sourcen für das Kurier-Backend, das über https://kurier.gsi.de erreichbar ist, befinden sich auf der produktiven Webmaschine www-apps unter dem Verzeichnis /srv/www/kurier. In diesem Verzeichnis ist der komplette Code vom Login über das Artikelformular bis hin zum Backend hinterlegt.

Die eigentliche Kurier-Ausgabe ist in eine Typo3 Extension integriert und auf der GSI-Seite zu sehen: https://www.gsi.de/kurier

Auf der Maschine lxcms3, auf der das produktive Typo3 der GSI läuft, ist die Extension im Verzeichnis /srv/www/t3lts62/typo3conf/ext/gsi_kurier_view/ zu finden.

Bibliotheken und Komponenten

Für den Kurier wurden Komponenten aus dem Framework "Symfony" verwendet und zusätzlich php Libraries wie Twig und Swiftmailer. Über den Paketmanager Composer lassen sich einzelne PHP Libraries und Komponenten installieren, eine Einleitung zum Installieren vom Composer findet sich unter https://getcomposer.org/. Nach der Installation vom Composer im Projektverzeichnis, das sich auf der Maschine lxcms3 unter /srv/www/t3lts62/typo3conf/ befindet, wird als default das Verzeichnis vendor erstellt, in diesem werden die installierten Libraries und Komponeten abgelegt.

Verwendete Symfony Komponenten

In der Datei composer.json die sich innerhalb des Projektverzeichnisses befindet sind alle installierten Libraries zu sehen:

• "twig/twig": Zum Erstellen von PHP Templates
• "swiftmailer/swiftmailer": Zum Erstellen und Versenden von E-Mails
• "symfony/form": Zum Erstellen und Verarbeiten von Formularen
• "twig/extensions":
• "symfony/twig-bridge": Integration vom Twig Templating mit PHP Bibliotheken
• "symfony/translation": Zum Übersetzen von Inhalten
• "symfony/config": Unterstützt das Finden, Laden, Zusammenführen, Vervollständigen und Validieren von Konfigurationswerten
• "symfony/validator": Zur Validierung von Formulardaten
• "symfony/http-foundation": Definiert eine Objekt-Orientierte Schicht zur HTTP-Spezifikation
• "symfony/security-csrf": Zum Schutz vor csrf-Attacken

Twig

Twig ist eine Template Engine für PHP. Mit dem Befehl 'composer require "twig/twig:~1.0"' wird diese im Projektverzeichnis installiert und findet sich unter vendor/twig wieder.

• gsi_kurier_view: Diese Extension erzeugt die aktuelle Kurier-Ausgabe und das Kurier-Archiv mit vergangenen Kurier-Ausgaben. Die dazugehörigen Template Dateien liegen unter /srv/www/t3lts62/typo3conf/ext/gsi_kurier_view/pi1/Templates.

SwiftMailer

Für das Erstellen und Senden von E-Mails wird die SwiftMailer Library verwendet. Der Befehl 'require swiftmailer/swiftmailer' installiert diese unter vendor/swiftmailer.

Falls der Inhalt von E-Mails verändert wurde, sollte vorher ein Testlauf dieser gemacht werden.

Beispielsweise für die wöchentliche Kurier-Mail. Dazu wird im Working-Directory folgendes Kommando ausgeführt.

/srv/www/kurier/app/console kurier:infomail --env=dev.

Jedoch sollte vorher in der entsprchenden Datei, die sich unter kurier/src/AppBundle/Command befindet, der Empfänger geändert werden. Diesen ersetzt man in der Zeile 61 mit seiner eigenen E-Mail Adresse.

-- KerstinSchiebel - 03 Feb 2016