Skip to content

Latest commit

 

History

History
127 lines (80 loc) · 6.34 KB

README.md

File metadata and controls

127 lines (80 loc) · 6.34 KB
Raw

X-Updare Store XOOPSCube powered-by-electricity XCL

Project Status: Active – The project has reached a stable, usable state and is being actively developed. License GPL X-Updare Store

///// — CKEditor4 :: WYSIWYG editor + Web-based File manager

CKEditor Wysiwig Editor for XCL. Full version with plugins for BBCode and X-elFinder File Manager

Test and customize here :
https://xoopscube.github.io/ckeditor4/

MODULE CKEditor4
Description Battle-tested WYSIWYG editor with X-elFinder web-based file manager running on JavaScript + PHP.
Render Engine Smarty v2 and XCube Layout
Version 4.22.1
Author @nao-pon Naoki Sawada
Maintainer Update @gigamaster Nuno Luciano (XCL7)
Copyright 2005-2023 Authors
License XCL module is distributed under a GPL 2.3 License.
License elFinder is distributed under a 3-Clause BSD License.
💻 The Minimum Requirements
      Apache, Nginx, etc. PHP 8.x.x
      MySQL 5.7, MariaDB  InnoDB utf8 / utf8mb4
      XCL version 2.4.0

EOL

CKEditor 4 is now end-of-life software. Security patches are only released for CKEditor 4 LTS, which is available exclusively in the Extended Support Model Package.

Overview

CKEditor 4 is built from plugins, just like XOOPSCube is built from modules, which makes it easy to create a custom build tailored to your needs. Nevertheless, to make the initial trial and installation process easier, from the three pre-configured installation packages (Basic, Standard and Full), we have chose to customize the Full package for learning about the available features and setups.

Following the recommendation of the CKEditor Team, the installation packages are just predefined setups that aim to satisfy some common use cases. It is always recommended to build a custom CKEditor4 package adjusted to your production website special needs.

Features of module CKEditor4

The XOOPSCube module CKEditor4 is released by default with a customized Full package bundle and provides out of the box:

  • Control Panel preferences settings e.g. toolbars, user group permissions, ui color.
  • Localization languages installed by default : English, French, Japanese, Portuguese.
  • Template a Single File Component for frontend and backend.
  • Automatic change of editor HTML or BBCode depending on modules and user group permissions.
  • Automatic switch of ToolBar based on modules preferences and user group permissions.
  • BBCode editor extends the CKEditor standard bbcode plugin
  • HTML editor with custom Toolbar for each user group
  • Extra Plugins customized CodeMirror, oEmbed, Paste (raw text, formatted or code).
  • PHP mode for PHP code blocks without the <?php opening tag.
  • Smarty mode for Smarty Template Engine code blocks.
  • elFinder open-source web file manager with cloud storage settings.

Control Panel Preferences

CKEditor Settings

CKEditor's settings

  • Toolbar UI Color
  • "config.toolbar" for administrators (i.e webmaster)
  • "config.toolbar" for special group (i.e. moderators)
  • "config.toolbar" for registered users
  • "config.toolbar" for guests (comments, forum)
  • "config.extraPlugins"
  • "config.customConfig"
  • "config.enterMode"
  • "config.shiftEnterMode"
  • "config.allowedContent"
  • "config.autoParagraph"

X-elFinder web file manager

  • Set X-elFinder directory name for server browser.
  • Upload Target of Drag & Drop (X-elFinder)
  • Init image size of Drag & Drop(X-elFinder)

Extra Plugins

CKEditor-CodeMirror-Plugin by @w8tcha
Syntax Highlighting for the CKEditor (Source View and Source Dialog) with the CodeMirror Plugin

Plugin CodeMirror

Parameters

If you're using the default dhtmltarea you don't need to change the value.

Otherwise you need to escape the value as follows:

<{ck4dhtmltarea value=VALUE|escape editor=html}>

<{ck4dhtmltarea value=VALUE|escape editor=bbcode}>

Option Description
editor The editor to use (html or bbcode)
toolbar You can specify the toolbar to display in JSON format

Support

For topics, questions, and requests about CKEditor, please refer to CKEditor.
For topics, questions, and requests about elFinder, please refer to elFinder.