header-xh-01 header-xh-02 header-xh-03 header-xh-04 header-xh-05 header-xh-06 header-xh-07 header-xh-08 header-xh-09 header-xh-10 header-xh-11 header-xh-12 header-xh-13 header-xh-14
Lembach's nichtkommerzielle Website rund um CMSimple_XH
Templates, Plugins, Tools, Programme
und Tips und Tricks die mir wichtig sind
Sie sind hier: Startseite > Plugins > version.nfo Definition etc.

version.nfo Definition & co.

In diesem Thread https://cmsimpleforum.com/viewtopic.php?f=16&t=17909&p=81242#p81240 hat Christoph auf meine Frage nach der Bauanleitung für die version.nfo geantwortet.

Da ich die Hilfe der hi_updatecheck nie gelesen hatte, wusste ich nicht, dass in der englischen Datei die Erklärung der version.nfo enthalten ist.

Diese habe ich nun ins Deutsche übersetzt. Siehe weiter unten.

Hier noch einmal der Download des gesamten gepatchten Plugins:

NameGrößeÄnderungsdatumHits
ZIP Datei128 KB11.09.2021 17:1514

Definition der version.nfo

Informationen für Entwickler

Wenn Sie ein Plugin-Entwickler sind, werden ich - und hoffentlich alle CMSimple_XH-Benutzer - froh sein, wenn Sie Ihre Plugins so vorbereiten, dass sie mit diesem Skript zusammenarbeiten.

Es ist wirklich einfach und Sie müssen keine Änderungen an Ihrem Plugin-Code vornehmen.
Alles, was Sie tun müssen, ist, eine kleine Datei namens "version.nfo" in den Root-Ordner Ihres Plugins zu legen und eine umbenannte Kopie irgendwo für die Welt lesbar auf Ihrem Server abzulegen.

Wie funktioniert es also?

UpdateCheck sucht in jedem Plugin-Ordner nach einer version.nfo - Datei, extrahiert die enthaltenen Informationen und vergleicht sie mit den Informationen auf Ihrem Server.
Je nach Ergebnis erhält der Benutzer Informationen über verfügbare Updates, den Link zur Downloadseite, kritische Updates oder einfach nur einen Hinweis, dass das Plugin auf dem neuesten Stand ist.

Erstellen einer version.nfo-Datei

Die version.nfo ist einfach eine csv-Datei mit genau den folgenden sieben Einträgen in einer Zeile:

Plugin_Name,Version,Readable_Version,Critical?,Additional_Infos,Download_Url,Url_to_remote_nfo

Beschreibung der Felder:

*Plugin_Name: Der lesbare Name Ihres Plugins, der für die Info-Meldungen in der (x)html-Ausgabe verwendet wird
Beispiel: Update-Check
*Version: Die Version des Plugins. Dieser Eintrag wird zum Vergleich der Versionen verwendet.
Format: alles, was PHPs version_compare() verstehen kann
Beispiele: 1.5.7 oder 1.3.2 RC ... oder Build(Daten) wie 2013051601, 2013051602
*Lesbare Version: Dieser Eintrag wird in der (x)html-Ausgabe dem Benutzer angezeigt
Beispiele: 1.5.3 - 2013-05-16 oder nur 1.5.2 oder alles, was für Sie nützlich ist
Kritisch? Dieses Feld wird verwendet, um den Benutzer über kritische Updates zu informieren.
Wenn Sie eine Version mit einem kritischen Fehler veröffentlicht haben,
geben Sie hier die Versionsnummer an und der Benutzer wird mit einer Warnmeldung benachrichtigt,
wenn seine installierte Version gleich oder älter als die hier angegebene ist.
Format: wie bei "Version" oben.
HINWEIS: Behalten Sie diesen Eintrag auch in zukünftigen Versionen bei,
falls ein Benutzer frühere Updates verpasst hat
Zusätzliche_Infos: Dieser Eintrag wird in der (x)html-Ausgabe an den Benutzer ausgegeben.
Normalerweise sollte dieses Feld leer bleiben.
Sie können nur einen kurzen zusätzlichen Hinweis in nur einer Sprache geben.
Außerdem werden alle Script-/HTML-Auszeichnungen entfernt.
*Download_Url Die vollständige URL zur Downloadseite der neuen Version. Dieser Eintrag wird verwendet,
um einen Link in der Nachricht zu erstellen, die dem Benutzer angezeigt wird.
Beispiel: http://www.domain.tld?Plugins:Pluginname
*Url_zu_remote_nfo Vollständige URL zur .nfo - Datei auf Ihrem Server mit den aktuellen Versionsinformationen des Plugins.
Diese Datei muss über das Internet zugänglich sein.
Denken Sie daran: diese URL sollte sich in Zukunft nicht ändern!
Beispiel: http://www.domain.tld/downloads/versioninfos/Pluginname_version.nfo

Hinweis: Die mit " * " gekennzeichneten Felder dürfen nicht leer sein. 
Und vergessen Sie nicht die Kommas, wenn Sie Felder leer lassen! Das Plugin prüft, ob genau sieben Einträge in der .nfo-Datei vorhanden sind und ignoriert das Plugin ansonsten.

Vollständiges Beispiel aus jQuery-Plugin:

(hier habe ich "Build" verwendet, um die Versionen zu vergleichen. "Critical?" und "Additional_Infos" sind leer):

Speichern Sie eine Datei mit den oben genannten Informationen im Stammverzeichnis Ihres Plugins - auf derselben Ebene wie index.php und admin.php. Der Dateiname muss "version.nfo" lauten. Legen Sie dann eine (umbenannte) Kopie dieser Datei auf Ihrem Server ab, die über die im letzten Feld "Url_to_remote_nfo" angegebene Url erreichbar ist.

Das ist alles - abgesehen davon, dass Sie die Datei(en) mit jeder neuen Version Ihres Plugins aktualisieren.

 

Das ist die deutschsprachige (ergänzte) Hilfedatei:

 

UpdateCheck für CMSimple_XH

Ein kleines CMSimple-Plugin, das hilft Ihre CMSimple_XH Installation aktuell zu halten

Version 1.2
© 2013-2014 Holger Irmler, http://CMSimple.HolgerIrmler.de.


Installation

  1. Legen Sie immer eine Sicherungskopie Ihrer Installation an bevor Sie ein neues Plugin hinzufügen.
  2. Entpacken Sie das Archiv und laden Sie die Dateien und Ordner in Ihren Plugins-Ordner.

    Es sollte so aussehen:

    • [Root]
      • [2lang]
      • [cmsimple]
      • ...
      • [plugins]
        • ...
        • [pluginloader]
        • [hi_updatecheck]
          • [config]
          • [css]
          • [help]
          • [languages]
          • admin.php
          • index.php
          • JSON.php
          • updatecheck.php
          • version.nfo
        • index.php
      • [...]
      • index.php
  3. Wenn Sie die Plugin-Administration online durchführen wollen, müssen Sie Schreibberechtigungen für die Order 'config', 'css' und 'languages' und für die enthaltenen Dateien vergeben.

  4. Konfiguration
    Die voreingestellte Konfiguration sollte für die meisten Anwender geeignet sein. Sie finden Hinweise zu den Konfigurationsoptionen, wenn Sie auf die blauen Fragenzeichen zeigen.

Verwendung

Per Voreinstellung (Konfigurationseinstellung "autocheck" = 1) führt das Plugin einen "stillen Quick-Check" im Hintergrund durch, direkt nach dem Sie sich in Ihre CMSimple_XH Installation eingeloggt haben. Wenn genügend Zeit vergeht bevor Sie den nächsten Klick im Backend tätigen, und Updates verfügbar sind, wird ein Info-Icon neben dem Logout-Schalter in der Menüleiste angezeigt.
Abgesehen davon wird eine Benachrichtigung zu Beginn der "System Info" Seite angezeigt ( Einstellungen -> Info ).


Info-Icon und Benachrichtigung auf der "System Info" Seite


Dieser "Quick-Check" wird nur einmal pro Sitzung durchgeführt.
Klicken Sie das Icon oder den Link auf der System-Info Seite an, um einen vollständigen Update-Check zu starten.



Beispiel Updatecheck Ergebnis


Von Zeit zu Zeit sollten Sie die Updateprüfung selbst anstoßen:

gehen Sie zu Plugins -> hi_updatecheck -> Nach Updates suchen

Kompatibilität

Seien Sie gewarnt! Dieses Plugin funktioniert nur mit dem original CMSimple_XH von www.cmsimple-xh.org.
Die Verwendung unter anderen Versionen / Derivaten kann zu Fehlern und/oder falschen Informationen führen!


Informationen für Entwickler

Wenn Sie ein Plugin-Entwickler sind, werden ich - und hoffentlich alle CMSimple_XH-Benutzer - froh sein, wenn Sie Ihre Plugins so vorbereiten, dass sie mit diesem Skript zusammenarbeiten.

Es ist wirklich einfach und Sie müssen keine Änderungen an Ihrem Plugin-Code vornehmen.
Alles, was Sie tun müssen, ist, eine kleine Datei namens "version.nfo" in den Root-Ordner Ihres Plugins zu legen und eine umbenannte Kopie irgendwo für die Welt lesbar auf Ihrem Server abzulegen.

Wie funktioniert es also?

UpdateCheck sucht in jedem Plugin-Ordner nach einer version.nfo - Datei, extrahiert die enthaltenen Informationen und vergleicht sie mit den Informationen auf Ihrem Server.
Je nach Ergebnis erhält der Benutzer Informationen über verfügbare Updates, den Link zur Downloadseite, kritische Updates oder einfach nur einen Hinweis, dass das Plugin auf dem neuesten Stand ist.


Erstellen einer version.nfo-Datei

Die version.nfo ist einfach eine csv-Datei mit genau den folgenden sieben Einträgen in einer Zeile:

Plugin_Name,Version,Readable_Version,Critical?,Additional_Infos,Download_Url,Url_to_remote_nfo

Beschreibung der Felder:

*Plugin_Name: Der lesbare Name Ihres Plugins, der für die Info-Meldungen in der (x)html-Ausgabe verwendet wird
Beispiel: Update-Check
*Version: Die Version des Plugins. Dieser Eintrag wird zum Vergleich der Versionen verwendet.
Format: alles, was PHPs version_compare() verstehen kann
Beispiele: 1.5.7 oder 1.3.2 RC ... oder Build(Daten) wie 2013051601, 2013051602
*Lesbare Version: Dieser Eintrag wird in der (x)html-Ausgabe dem Benutzer angezeigt
Beispiele: 1.5.3 - 2013-05-16 oder nur 1.5.2 oder alles, was für Sie nützlich ist
Kritisch? Dieses Feld wird verwendet, um den Benutzer über kritische Updates zu informieren.
Wenn Sie eine Version mit einem kritischen Fehler veröffentlicht haben, geben Sie hier die Versionsnummer an und der Benutzer wird mit einer Warnmeldung benachrichtigt, wenn seine installierte Version gleich oder älter als die hier angegebene ist.
Format: wie bei "Version" oben.
HINWEIS: Behalten Sie diesen Eintrag auch in zukünftigen Versionen bei, falls ein Benutzer frühere Updates verpasst hat
Zusätzliche_Infos: Dieser Eintrag wird in der (x)html-Ausgabe an den Benutzer ausgegeben.
Normalerweise sollte dieses Feld leer bleiben. Sie können nur einen kurzen zusätzlichen Hinweis in nur einer Sprache geben. Außerdem werden alle Script-/HTML-Auszeichnungen entfernt.
*Download_Url Die vollständige URL zur Downloadseite der neuen Version. Dieser Eintrag wird verwendet, um einen Link in der Nachricht zu erstellen, die dem Benutzer angezeigt wird.
Beispiel: http://www.domain.tld?Plugins:Pluginname
*Url_zu_remote_nfo Vollständige URL zur .nfo - Datei auf Ihrem Server mit den aktuellen Versionsinformationen des Plugins. Diese Datei muss über das Internet zugänglich sein.
Denken Sie daran: diese URL sollte sich in Zukunft nicht ändern!
Beispiel: http://www.domain.tld/downloads/versioninfos/Pluginname_version.nfo

Hinweis: Die mit " * " gekennzeichneten Felder dürfen nicht leer sein.
Und vergessen Sie nicht die Kommas, wenn Sie Felder leer lassen! Das Plugin prüft, ob genau sieben Einträge in der .nfo-Datei vorhanden sind und ignoriert das Plugin ansonsten.

Vollständiges Beispiel aus jQuery-Plugin:

(hier habe ich "Build" verwendet, um die Versionen zu vergleichen. "Critical?" und "Additional_Infos" sind leer):


Speichern Sie eine Datei mit den oben genannten Informationen im Stammverzeichnis Ihres Plugins - auf derselben Ebene wie index.php und admin.php. Der Dateiname muss "version.nfo" lauten. Legen Sie dann eine (umbenannte) Kopie dieser Datei auf Ihrem Server ab, die über die im letzten Feld "Url_to_remote_nfo" angegebene Url erreichbar ist.

Das ist alles - abgesehen davon, dass Sie die Datei(en) mit jeder neuen Version Ihres Plugins aktualisieren.

Danksagung

Das Design der Meldungen basiert auf einem Artikel von Janko Jovanovic.
Die Icons, die für die Meldungen verwendet werden, wurden von Miles Ponson erschaffen und frei zur Verfügung gestellt.
Das Plugin-Icon wurde von Alexandre Moore erschaffen und frei zur Verfügung gestellt.

Besonderer Dank an Christoph M. Becker für die Prüfung meines Codes, den Austausch von Ideen und konstruktives Feedback bezüglich dieses Plugins

Die dänische Übersetzung wurde von Jens Maegaard bereitgestellt - www.JmNet.dk - www.CMSimple-xh.dk

Copyright & Lizenz

Copyright ©2013-2014 Holger Irmler - alle Rechte vorbehalten

Lizenz: GPL3

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Sie brauchen Hilfe?

... besuchen Sie cmsimpleforum.com.



| Seitenanfang | |  - - - By CrazyStat - - -