diff --git a/README.md b/README.md index b18129b7917836a2b08ec9d41ecc7f0da581089d..e6519ace6adb58c7052eccfbed632c2420421f19 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,71 @@ + + QUIQQER CKEditor 4 Bridge ======== -Paketname: +Packagename: quiqqer/ckeditor4 -Features (Funktionen) --------- +Features +---------- - CKEditor4 für QUIQQER -Pluginverwaltung --------- +CKEditor Plugin Management +-------------------------- -Das Paket liefert eine Pluginverwaltung für CKEditor Plugins ([Plugin Store](http://ckeditor.com/addons/plugins/all)). +The package adds a management interface for CKEditor plugin ([Plugin Store](http://ckeditor.com/addons/plugins/all)). -Das Paket liefert eine Auswahl von Plugins mit, diese werden in zwei Ordnern im Paket mitgelifert: -* ckeditor4/plugins/ckeditor4 (Plugins aus dem Pluginstore) -* ckeditor4/plugins/quiqqer (Von PCSG für QUIQQER entwickelte Editorplugins) +Some plugins will be bundled with this package by default. They get distributed in two directories: +* ckeditor4/plugins/ckeditor4 (Plugins from the plufin store) +* ckeditor4/plugins/quiqqer (Plugins that were developed for QUIQQER by PCSG) -Bei einem Paketsetup werden diese Plugins in das entsprechende QUIQQER-System installiert. +These plugins will get moved into the correct directories of your QUIQQER installation during the package setup. -Zu finden sind die installiert Pakete im "Var-Verzeichnis": +You can find your installed plugins in the `var`-directory: -* \<CMD_DIR>/var/package/quiqqer/ckedito4/plugins/installed (Installiert, aber inaktiv) -* \<CMD_DIR>/var/package/quiqqer/ckedito4/plugins/bin (Installiert und aktiviert) +* \<CMD_DIR>/var/package/quiqqer/ckedito4/plugins/installed (Installed,but deactivated) +* \<CMD_DIR>/var/package/quiqqer/ckedito4/plugins/bin (Installed and active) -Die Pluginverwaltung kann im Adminbereich unter `Einstellungen -> CKEditor` aufgerufen werden: +You can open the plugin management in QUIQQERs Admin interface `Settings -> CKEditor`: -Plugins installieren -------- +Install plugins +--------------- -Um zusätzliche Plugins zu installieren rufen Sie bitte die pluginverwaltung auf: -`ADMINBEREICH -> Einstellungen -> CKEditor` +Open the plugin manager in your QUIQQER admin interface: +`Adminarea -> Settings -> CKEditor` -1) Dort finden Sie eine Schaltfläche `Hochladen`. -2) Wählen Sie die Schaltfläche `Datei auswählen` -3) Selektieren Sie ein ZIP-Archiv im korrekten Format* -4) Betätigen Sie `Hochladen` -5) Das Plugin wird hochgeladen und installiert +1) Press the `Upload` button. +2) Press `Select file` +3) Pick an archive in the correct format* +4) Confirm with `Upload` +5) The plugin gets uploaded and installed -__**Das korrekte ZIP-Archiv Format:**__ +__**The correct ZIP-Archive format:**__ -Das ZIP muss in einem bestimmten Format aufgebaut sein. +The ZIP-File needs to be in a certain format to be valid. -Folgende Struktur muss eingehalten werden: -Das ZIP-Archiv darf in der ersten Ebene nur einen Ordner enthalten, der den Namen des Plugins trägt. -In diesem Ordner sind die Plugindateien enthalten. +Following directory structure needs to be adhered: +The first directory level must only contain one directory named like the plugin. +The plugin files are within that directory. Installation ------------ -Der Paketname ist: quiqqer/ckeditor4 +The package name is: quiqqer/ckeditor4 + +Install with composer: +``` +composer require quiqqer/ckeditor4 +``` -Mitwirken +Contribute ---------- - Issue Tracker: https://dev.quiqqer.com/quiqqer/ckeditor4/issues @@ -68,8 +75,8 @@ Mitwirken Support ------- -Falls Sie ein Fehler gefunden haben, oder Verbesserungen wünschen, -dann können Sie gerne an support@pcsg.de eine E-Mail schreiben. +Feel free to send us an email, if you encountered an error,want to provide feedback or suggest an idea. +Our E-Mail is: support@pcsg.de Lizenz @@ -77,5 +84,3 @@ Lizenz - GPL-2.0+ -Entwickler --------- diff --git a/README_de.md b/README_de.md new file mode 100644 index 0000000000000000000000000000000000000000..b3fdae0b1079370c4146bbb64734d99c6c3951eb --- /dev/null +++ b/README_de.md @@ -0,0 +1,81 @@ + + +QUIQQER CKEditor 4 Bridge +======== + +Paketname: + + quiqqer/ckeditor4 + + +Features (Funktionen) +-------- + +- CKEditor4 für QUIQQER + + +Pluginverwaltung +-------- + +Das Paket liefert eine Pluginverwaltung für CKEditor Plugins ([Plugin Store](http://ckeditor.com/addons/plugins/all)). + +Das Paket liefert eine Auswahl von Plugins mit, diese werden in zwei Ordnern im Paket mitgelifert: +* ckeditor4/plugins/ckeditor4 (Plugins aus dem Pluginstore) +* ckeditor4/plugins/quiqqer (Von PCSG für QUIQQER entwickelte Editorplugins) + +Bei einem Paketsetup werden diese Plugins in das entsprechende QUIQQER-System installiert. + +Zu finden sind die installiert Pakete im "Var-Verzeichnis": + +* \<CMD_DIR>/var/package/quiqqer/ckedito4/plugins/installed (Installiert, aber inaktiv) +* \<CMD_DIR>/var/package/quiqqer/ckedito4/plugins/bin (Installiert und aktiviert) + + +Die Pluginverwaltung kann im Adminbereich unter `Einstellungen -> CKEditor` aufgerufen werden: + + +Plugins installieren +------- + +Um zusätzliche Plugins zu installieren rufen Sie bitte die pluginverwaltung auf: +`ADMINBEREICH -> Einstellungen -> CKEditor` + +1) Dort finden Sie eine Schaltfläche `Hochladen`. +2) Wählen Sie die Schaltfläche `Datei auswählen` +3) Selektieren Sie ein ZIP-Archiv im korrekten Format* +4) Betätigen Sie `Hochladen` +5) Das Plugin wird hochgeladen und installiert + +__**Das korrekte ZIP-Archiv Format:**__ + +Das ZIP muss in einem bestimmten Format aufgebaut sein. + +Folgende Struktur muss eingehalten werden: +Das ZIP-Archiv darf in der ersten Ebene nur einen Ordner enthalten, der den Namen des Plugins trägt. +In diesem Ordner sind die Plugindateien enthalten. + +Installation +------------ + +Der Paketname ist: quiqqer/ckeditor4 + + +Mitwirken +---------- + +- Issue Tracker: https://dev.quiqqer.com/quiqqer/ckeditor4/issues +- Source Code: https://dev.quiqqer.com/quiqqer/ckeditor4/tree/master + + +Support +------- + +Falls Sie ein Fehler gefunden haben, oder Verbesserungen wünschen, +dann können Sie gerne an support@pcsg.de eine E-Mail schreiben. + + +Lizenz +------- + +- GPL-2.0+ + diff --git a/bin/images/Logo.jpg b/bin/images/Logo.jpg new file mode 100644 index 0000000000000000000000000000000000000000..a33d4ab9e5c64698d6e4e0dbabd579be2c33cd01 Binary files /dev/null and b/bin/images/Logo.jpg differ diff --git a/bin/images/Readme.jpg b/bin/images/Readme.jpg new file mode 100644 index 0000000000000000000000000000000000000000..9c5912938d8277b56ead3246bc83ecc32800f7bf Binary files /dev/null and b/bin/images/Readme.jpg differ diff --git a/bin/images/preview/editor.png b/bin/images/preview/editor.png new file mode 100644 index 0000000000000000000000000000000000000000..8c450c5316fb8bad8888c1499aee4ccf04885cb6 Binary files /dev/null and b/bin/images/preview/editor.png differ diff --git a/bin/images/preview/plugins.png b/bin/images/preview/plugins.png new file mode 100644 index 0000000000000000000000000000000000000000..a643558f469167b8a0c118b1eefd432e1ffa15e2 Binary files /dev/null and b/bin/images/preview/plugins.png differ diff --git a/bin/images/preview/toolbars.png b/bin/images/preview/toolbars.png new file mode 100644 index 0000000000000000000000000000000000000000..1fe6eb1f2fabd330dad4f83ee071900b0d8590a4 Binary files /dev/null and b/bin/images/preview/toolbars.png differ diff --git a/composer.json b/composer.json index 915fb1517f5e006f9667b7231b0aef82b480eaf7..f7d97ef220525ba789458768675a2257773e9097 100644 --- a/composer.json +++ b/composer.json @@ -1,9 +1,9 @@ { "name": "quiqqer\/ckeditor4", - "type": "quiqqer-library", + "type": "quiqqer-module", "description": "CKEditor for the QUIQQER CMS - enable the ckeditor for quiqqer", "version": "dev-dev", - "license": "GPL-2.0+", + "license": "GPL-2.0-or-later", "authors": [ { "name": "Henning Leutz", diff --git a/package.xml b/package.xml index b67b0c68951495f3df84c62efdf9be7d6243c989..e78e4a413f4c87d27d0ffd50fb4729d0a6e9c225 100644 --- a/package.xml +++ b/package.xml @@ -8,12 +8,23 @@ <locale group="quiqqer/ckeditor4" var="package.description"/> </description> + <!--Hauptbild --> + <image src="URL_OPT_DIR/quiqqer/ckeditor4/bin/images/Logo.jpg"/> + + <!-- Weitere Vorschaubilder --> + <preview> + <image src="URL_OPT_DIR/quiqqer/ckeditor4/bin/images/preview/editor.png"/> + <image src="URL_OPT_DIR/quiqqer/ckeditor4/bin/images/preview/plugins.png"/> + <image src="URL_OPT_DIR/quiqqer/ckeditor4/bin/images/preview/toolbars.png"/> + </preview> + + <support> <email><![CDATA[support@pcsg.de]]></email> <forum><![CDATA[https://community.quiqqer.com]]></forum> <source><![CDATA[https://dev.quiqqer.com/quiqqer/ckeditor4]]></source> <issues><![CDATA[https://dev.quiqqer.com/quiqqer/ckeditor4/issues]]></issues> - <wiki><![CDATA[]]></wiki> + <wiki><![CDATA[https://dev.quiqqer.com/quiqqer/ckeditor4/wikis/home]]></wiki> </support> <allowedPaths> @@ -22,7 +33,7 @@ <copyright> <name><![CDATA[PCSG - Computer & Internet Service OHG]]></name> - <license><![CDATA[]]></license> + <license><![CDATA[GPL-2.0+]]></license> </copyright> </package> </quiqqer> \ No newline at end of file