Yanp_XH – ein CMSimple_XH-Plugin

Zeitung

YANP ist die Abkürzung von yet another news plugin (noch ein weiteres News-Plugin). Es ermöglicht halbautomatische Handhabung der Neuigkeiten einer CMSimple_XH Homepage, die in einer Newsbox angezeigt und als RSS-Feed verfügbar gemacht werden können. Betrachten Sie es als Alternative zur manuellen Erzeugung und Pflege von Newsboxen oder zur Verwendung einer vollautomatisierten Lösung, wie WhatsNew oder RSS Feed. Wenn Sie weiter gehende Ansprüche haben, sollten sie die Verwendung einer fortgeschrittenen Lösung, wie News oder Realblog_XH in Erwägung ziehen.

Bitte lesen Sie dieses Handbuch bevor Sie auf Probleme stoßen!

Vorraussetzungen

Yanp_XH ist ein Plugin für CMSimple_XH. Es benötigt eine UTF-8 kodierte Version.

Installation

Die Installation erfolgt wie bei vielen anderen CMSimple_XH-Plugins auch. Im CMSimple_XH Wiki finden sie ausführliche Hinweise.

  1. Sichern Sie die Daten auf Ihrem Server.
  2. Entpacken Sie die ZIP-Datei auf Ihrem Computer.
  3. Laden Sie das gesamte Verzeichnis yanp/ auf Ihren Server in das CMSimple_XH-Plugin-Verzeichnis hoch.
  4. Vergeben Sie falls nötig Schreibrechte für die Unterverzeichnisse config/, css/, languages/ und den Daten-Ordner des Plugins.
  5. Gehen Sie zu "Yanp" im Administrationsbereich, und prüfen Sie, ob alle Vorraussetzungen erfüllt sind.

Einstellungen

Die Konfiguration des Plugins erfolgt wie bei vielen anderen CMSimple_XH-Plugins auch im Administrationsbereich der Homepage. Wählen Sie "Plugins" → "Yanp".

Sie können die Voreinstellungen von Yanp_XH unter "Konfiguration" ändern. Beim Überfahren der Hilfe-Icons mit der Maus werden Hinweise zu den Einstellungen angezeigt.

Die Lokalisierung wird unter "Plugin-Sprache" vorgenommen. Sie können die Texte in Ihre eigene Sprache übersetzen (falls keine entsprechende Sprachdatei zur Verfügung steht), oder sie entsprechend Ihren Anforderungen anpassen. Achten Sie besonders auf die Einträge in den Abschnitten "Feed" und "News".

Das Aussehen von Yanp_XH kann unter "Stylesheet" angepasst werden, oder alternativ im Stylesheet Ihres Templates, da die Newsbox und der Feed-Link dort direkt eingebunden werden.

Verwendung

Yanp_XHs Neuigkeiten beziehen sich auf CMSimple-Seiten. Jede Seite kann einen Eintrag in den Neuigkeiten haben. Um dies zu steuern, wechseln Sie einfach in den Reiter "News" oberhalb des Editors. Wenn Sie dort Text als Beschreibung eintragen, wird die Seite zu den Neuigkeiten hinzugefügt. Wenn Sie die Beschreibung löschen, wird die Seite aus den Neuigkeiten entfernt. Der Zeitstempel der Neuigkeiten wird verwendet, um diese zu sortieren (aktuelle Neuigkeiten sind oben). Der Zeitstempel wird aktualisiert, wenn Sie den Reiter sichern, aber er kann nie aktueller sein als der Zeitstempel der letzten Bearbeitung der entsprechenden Seite. Wenn Sie also einen Tippfehler auf der Seite gemacht haben, den Sie später korrigieren, ändert das nicht den Zeitstempel der Neuigkeit. Wenn Sie andererseits die Neuigkeit später ändern, wird der Zeitstempel nicht geändert, solange sie nicht auch die Seite selbst speichern.

Anzeigen der Newsbox

Um die Newsbox anzuzeigen, müssen Sie Ihr Template bearbeiten; ersetzen Sie den bereits existierenden newsbox() Aufruf durch:

<?php echo yanp_newsbox()?>

oder fügen Sie dies ggf. zusätzlich zu bereits bestehenden newsbox() Aufrufen ein.

Weiterhin ist es möglich die Newsbox auf einer CMSimple-Seite anzuzeigen, indem Sie folgenden Plugin-Aufruf einfügen:

{{{PLUGIN:yanp_newsbox();}}}

RSS-Feed verfügbar machen

Der RSS-Feed wird vielen modernen Browsern automatisch zur Verfügung gestellt, da ein <link rel="alternate"> Tag im <head> der Seiten Ihrer Homepage von Yanp_XH eingefügt wird. Um zusätzlich das RSS-Icon mit einem Link zum RSS-Feed anzuzeigen, müssen Sie

<?php echo yanp_feedlink()?>

in Ihr Template einfügen. Das funktioniert analog zu mailformlink(). Wenn Sie ein anderes Feed-Icon anzeigen möchten, legen Sie es im images/ Ordner Ihres Templates ab, und geben Sie dessen Dateinamen als Parameter an:

<?php echo yanp_feedlink('dateiname.png')?>

Je nach Konfiguration Ihres Webservers wird der Feed als text/xml gesendet, was wegen der UTF-8-Kodierung problematisch ist. Daher sollte der Feed als application/rss+xml oder application/xml gesendet werden. Bei Apache-Servern erreichen Sie dies, indem Sie eine entsprechende .htaccess Datei im Datenordner des Plugins ablegen, was für den voreingestellten data/ Ordner bereits erfolgt ist. Alternativ können Sie "feed extension" auf "rss" stellen. Aber Sie sollten auf jeden Fall den RSS-Feed validieren, um mögliche Probleme zu erkennen.

Einschränkungen

Unter CMSimple_XH 1.6 - 1.6.2 wird beim Speichern eines News Reiters die falsche Fehlermeldung "Nicht abspeicherbar: Content-Datei" angezeigt. Dies wird durch einen Fehler in CMSimple_XH ausgelöst, und wird mit CMSimple_XH 1.6.3 behoben werden.

Wenn die Website mit und ohne www aufgerufen werden kann (z.B. www.example.com und example.com) ohne die eine Variante auf die andere weiter zu leiten, kann es passieren, dass der RSS Feed nicht korrekt zu sich selbst zurück verlinkt. Es wird grundsätzlich empfohlen, dass Sie einen 301 Redirect von www.example.com zu example.com oder umgekehrt einrichten.

Lizenz

Yanp_XH kann unter Einhaltung der GPLv3 verwendet werden.

© 2011-2014 Christoph M. Becker

Dänische Übersetzung © 2011-2012 Jens Maegard
Slovakische Übersetzung © 2011-2012 Dr. Martin Sereday
Tschechische Übersetzung © 2012 Josef Němec

Danksagung

Das Plugin-Icon wurde von cemagraphics entworfen. Dieses Plugin verwendet Feed-Icons von Perishable Press und "free application icons" von Aha-Soft. Vielen Dank für die Veröffentlichung als Freeware.

Vielen Dank an die Community im CMSimple_XH Forum für Tipps, Vorschläge und das Testen.

Zu guter letzt vielen Dank an Peter Harteg, den "Vater" von CMSimple, und alle Entwickler von CMSimple_XH, ohne die dieses phantastische CMS nicht existieren würde.