SimplePlugins_XH Edition KRL

Dieses Plugin ist eine sehr einfache Script-Bibliothek.

Bitte lesen Sie diese Dokumentation, damit Sie sich keine Probleme einhandeln!

Wichtiger Hinweis

Die aktuelle Version ist lediglich ein Entwurf.
Alles kann sich noch ändern, und es könnten schwerwiegende Fehler und Einschränkungen vorhanden sein, weil sie bisher kaum getestet ist.
Es handelt sich um eine so genannte Alpha-Version.
Verwenden Sie sie mit äußerster Vorsicht!

Nach oben

Anforderungen

SimplePlugins_XH ist ein Plugin für CMSimple_XH.

Nach oben

Installation

Die Installation erfolgt wie bei vielen anderen CMSimple_XH-Plugins. Weitere Details finden Sie im CMSimple_XH wiki.

  1. Sichern Sie die Daten auf Ihrem Server.
  2. Entpacken Sie die Distribution auf Ihrem Computer.
  3. Bearbeiten und Einstellen Ihres "Google AdSense-Code", "Google Map API Key"
    1. Google AdSense-Code: simpleplugins_xh/simpleplugins_library/g_adsense/index.php
    2. Google Map API Key: simpleplugins_xh/simpleplugins_library/simple_google_map/index.php
    3. Google Map API Key: simpleplugins_xh/simpleplugins_library/simple_google_map2/index.php
  4. Laden Sie das gesamte Verzeichnis auf Ihren Server in das Plugin-Verzeichnis CMSimple_XH hoch.
      ----> plugins/simpleplugins_xh/*.
  5. Die Funktion no_cookies_text erfordert die Installation des Plugins Privacy_XH.

Enthaltene Bibliotheken

  1. add_qrcode : Anzeige des QR-Codes
  2. admin_only : Dies wird nur angezeigt, wenn der Admin eingeloggt ist.
  3. bclock : Show Clock | Funktioniert nicht mehr mit dieser Version!
  4. browser-shots : Automatisiert die Aktion, Screenshots der Website aufzunehmen. | Funktioniert nicht mehr mit dieser Version!
  5. g_adsense : Google AdSense
  6. h_tag : H1,H2,H3 tag
  7. hellomyplugin: Blindfunktion gibt hier nur 'Hello My Plugin!' aus. Kann verwendet werden, um eigene Funktionen zu realisieren.
    Kann auch als Vorlage verwendet werden. Anleitung am Ende der Datei.
  8. mailaddress_hide : Konvertiert die Zeichen von E-Mail-Adressen in HTML-Entities, um Spam-Bots zu blockieren.
    Unklar, wie der Schutz der E-Mail Adresse wirklich funktionieren soll.
  9. mailaddress_hide_js : Konvertiert die Zeichen von E-Mail-Adressen per JavaScript, um Spam-Bots zu blockieren.
  10. mailaddress_hide_js2 : Konvertiert die Zeichen von E-Mail-Adressen in HTML-Entities, um Spam-Bots zu blockieren
    Unklar, wie der Schutz der E-Mail Adresse wirklich funktionieren soll.
  11. make_ruby : Anzeige des Ruby-Codes (HTML-TAG)
  12. Zeigt den einen oder den anderen Text an. Abhängig vom Wert (true/false) der Funktion privacy_agreed() des Privacy-Plugins.
    Der erste Text wird angezeigt, wenn Cookies nicht erlaubt sind, der zweite Text wird angezeigt, wenn Cookies erlaubt sind.
  13. recently_changed : Liste der zuletzt geänderten Seiten.
  14. responsive_iframe : Responsives iFrame
  15. simple_google_map : Zeigt Google MAP responsiv an.
  16. simple_google_map2 : Zeigt Google MAP durch JavaScript responsiv an.
Nach oben

Einstellungen

  1. Wählen Sie "Simpleplugins_xh" aus "Plugins".
  2. "Sprache" auswählen, Ihre Übersetzung erstellen.
  3. "Konfiguration" wählen, Ihre Konfigurationerstellen.
Nach oben

Für Entwickler: Sie möchten auch ein einfaches Plugin erstellen.

Schauen wir uns simpleplugins_xh/simpleplugins_library/***/index.php an. Sehr einfacher Code!

Das einfachste Plugin ist simpleplugins_library/hellomyplugin/index.php

Nach oben

Lizenz

  • Software Lizenzbestimmungen
    GPLv3.

© 2015 T. Uchiyama

Nach oben

 

Liste der Dateien

simpleplugins_xh
|- config
|- help
|- languages
|- simpleplugins_library
| |- add_qrcode
| |- admin_only
| |- bclock
| |- browser-shots
| |- g_adsense
| |- h_tag
| |- hellomyplugin
| |- mailaddress_hide_js
| |- mailaddress_hide_js2
| |- mailadoress_hide
| |- make_ruby
| |- no_cookies_text
| |- recently_changed
| |- responsive_iframe
| |- simple_google_map
| +- simple_google_map2
|- admin.php
|- index.php
|- README.txt
+- Simpleplugins_view.php
Nach oben

Bibliothek Erklärende Hinweise

Nach oben

add_qrcode

Useage : {{{add_qrcode($string[,$size]);}}}
Example : {{{add_qrcode('http://cmsimple-jp.org',80);}}}

Ausgabe des definierten Textes als QR-Code in der festgelegten Größe.

Nach oben

admin_only

Useage : {{{admin_only($string[,$class]);}}}
Example : {{{admin_only('This is Admin Only','xh_warning');}}}

Ausgabe des definierten Textes erfolgt ausschließlich in der Administratoren-Ansicht. Der Stil der Ausgabe entspricht der angegebenen Format-Klasse.

Nach oben

bclockMain

Useage : {{{bclockMain()}}}

Dieses Pyton-Script soll die Uhrzeit als Darstellung einer laufenden Analoguhr mit Datumsanzeige ausgeben. Dazu muss auf dem Server Python installiert sein. Das Script kollidiert u.U. im Editor-Modus mit bestimmten Templates.

Nach oben

browser_shots

Useage : {{{browser_shots($string [,$width, $height]);}}}
Example : {{{browser_shots('http://cmsimple-jp.org',300,225);}}}

Der diesem Script zugrunde liegende Service von Wordpress ist unter der im Script verwendeten Adresse nicht mehr erreichbar. Daher funktioniert die Ausgabe nicht.

Nach oben

g_adsense

Useage : {{{g_adsense();}}}

In Ermangelung eines Google Adsense Keys konnte die Funktion nicht getestet werden.

Nach oben

h_tag

Useage : {{{h_tag($string [, $h123 , $class])}}}
Example : {{{h_tag('Title2' , 2 , 'myclass')}}}

Diese Funktion gibt den String (erster Parameter) innerhalb von Tags aus.
Der zweite Parameter (hier x, Zahl zwischen 1 und 6) gibt an welcher Überschriftstyp zum Einsatz kommt.
Der dritte Parameter ist ein Klassennamen aus der Stylsheet-Datei des Templates, kann aber auch weggelassen werden.
Diese Funktion war nur für das alte CMSimple_XH (vor der Version 1.7.x) sinnvoll, da dort h1 - h3 für die Seitenorganisation verwendet wurden und als Überschriftformat nicht zur Verfügung standen.

Nach oben

hellomyplugin

Useage : {{{hellomyplugin()}}}
Example : {{{hellomyplugin()}}}

Blind-Funktion gibt hier nur 'Hello My Plugin!' aus. Kann dazu benutzt werden, um eigene Funktionen zu realisieren. Kann auch als Vorlage benutzt werden.

Instruktionen: Simpleplugins_xh um eigene Funktionen erweitern (addnew.htm)

Nach oben

mailaddress_hide_js

Useage : {{{mailaddress_hide_js($string)}}}
Example : {{{mailaddress_hide_js('yyy@xxxx.xxx')}}}

Der Funktion wird die E-Mail-Adresse als String übergeben (also 'empfängername@domin-name.tld') und gibt dafür ein Java-Script und den Text 'Mail' mit onclick-Link zum Java-Script aus. Dabei wird die E-Mail-Adresse im Java-Script verschlüsselt gespeichert
(1. CharCode(x-y), 2. y=shift-Wert).

Nach oben

mailaddress_hide_js2

Useage : {{{mailaddress_hide_js2($string)}}}
Example : {{{mailaddress_hide_js2('yyy@xxxx.xxx')}}}

Der Funktion wird die E-Mail-Adresse als String übergeben (also 'empfängername@domin-name.tld') und gibt dafür HTML-Code mit einer CSS-Klasse und einem E-Mail-Link aus. Der resultierende Quellcode enthält allerdings die E-Mailadresse im Klartext. Sie ist daher für heutige Spider auslesbar. Ich kann nicht erkennen, wodurch hier ein Schutz der E-Mailadresse realisiert werden soll.

Nach oben

mailaddress_hide

Useage : {{{mailaddress_hide($string)}}}
Example : {{{mailaddress_hide('yyy@xxxx.xxx')}}}

Der Funktion wird die E-Mail-Adresse als String übergeben (also 'empfängername@domin-name.tld') und gibt dafür HTML-Code mit einem DIV-Kontainer und einem E-Mail-Link aus. Der resultierende Quellcode enthält allerdings die E-Mailadresse im Klartext. Sie ist daher für heutige Spider auslesbar. Ich kann nicht erkennen wodurch, hier ein Schutz der E-Mailadresse realisiert werden soll.

Nach oben

make_ruby

Useage : {{{make_ruby($string , $rp_string);}}}
Example : {{{make_ruby('Guten Tag','guutn taak');}}}

Die Funktion dient zur Ausgabe der Lautschrift über einem Text. Der erste Parameter ist der String (z.B. 'Guten Tag') der als normaler Fließtext ausgegeben wird. Der zweite Parameter ist der Lautschrift-String (z.B. 'guutn taak'), der als kleine Lautschrift über dem ersten Text ausgegeben wird.

Nach oben

recently_changed

Useage : {{{recently_changed([$count])}}}
Example : {{{recently_changed(5)}}}

Die Funktion gibt eine Link-Liste der n zuletzt geänderten Seiten aus. Dabei ist n der der Funktion übergebene Parameter und legt die Anzahl der aufgelisteten Seiten fest. Der Default-Wert für n ist 5.

Nach oben

no_cookies_text

Usage : {{{no_cookies_text($string_no_cookies , $string_cookies_allowed)}}}
Example : {{{no_cookies_text('Bitte erlauben Sie das Setzen von Cookies','Cookies akzeptiert')}}}

Ergänzung zum Plugin Privacy_XH

Ausgabe von Text abhängig davon, ob Cookies zugelassen sind oder nicht in Privacy_XH.
Der Aufruf der Funktion im Artikeltext erfolgt wie jeder Funktionsaufruf:
{{{no_cookies_text('Text wenn Cookies abgelehnt sind', 'Text bei Cookie setzen erlaubt')}}}
Vorsicht mit einfachen Anführungszeichen! (').
Sind solche im auszugebenden Text, führt das zu einem schwerwiegenden Fehler, weil der PHP-Code zerstört wird.
Wenn man ' unbedingt benötigt, dann mit Maskierung angeben: \'
Das scheint in den Tests zu funktionieren.
Formatierungen, die per STYLE-Argumente erzeugt werden, enthalten möglicherweise einfache Anführungszeichen!
Unbedingt vermeiden!
Wenn eine Formatierung notwendig ist, bei der nicht bekannt ist, ob sie KEINE einfachen Anführungszeichen enthält, dann unbedingt über den gesamten Funktionsaufruf hinweg.
Also so, dass alle Angaben zur Formatierung außerhalb des Funktionsaufrufes liegen.
D.h. vor den drei öffnenden geschweiften Klammern {{{ oder nach den schließenden geschweiften Klammern }}}.

Nach oben

responsive_iframe

Useage : {{{responsive_iframe($url_string [,$background_color,$border_style,$max_width ,$min_width]); }}}
Example : {{{responsive_iframe('/ordner-im-root/zum-script/des/frame.html','#F8F8F8','3px solid #66FF66',640,280)}}}

Die ursprüngliche Funktion wurde durch eine allgemeine IFrame-Funktion ersetzt. Als Parameter reicht schon die URL zur Datei, die im iFrame angezeigt werden soll, alle anderen sind optional. Die URL kann sich auch auf eine Adresse im eigenen Server beziehen. Dann sollte sie als vollständige Adresse vom root des Servers aus angegeben werden. Die Hintergrundfarbe des IFrame (default: #F8F8F8) ist als Hex-Zahl anzugeben (egal ob mit oder ohne #). Das Styling des Rahmens (default: 1px solid #FFF) muss komplett mit Einheitenbenennung (px oder em) und Typ der Farbfestlegung (#, rgb, rgba, benannte Farbe) angegeben werden. Es erfolgt kein Abfang von Fehlern! Fehlerhafte Angaben schießen u.U. das Template ab! Die max. Breite (default: 1920px) und min. Breite (default: 300px) können, müssen aber nicht angegeben werden. Die Werte sind in px als reine Zahl anzugeben!

Nach oben

simple_google_map

Useage : {{{simple_google_map($string [,$zoom,$width,$height,$enablescrollwheel,$disablecontrols]);}}}
Example : {{{simple_google_map('Tokyo');}}}

In Ermangelung einer Google API konnte die Funktion nicht geprüft werden.

Nach oben

simple_google_map2

Useage : {{{simple_google_map2($address [,$zoom ,$description ,$width,$height ,$map_type_control]);}}}
Example : {{{simple_google_map2('Tokyo');}}}

In Ermangelung einer Google API konnte die Funktion nicht geprüft werden.

Nach oben