Codeeditor_XH - a CMSimple_XH Plugin

Codeeditor_XH provides a replacement for the simple textarea in CMSimple_XH's back-end to edit the template, the stylesheet and the plugin stylesheets. Furthermore it implements the editor interface of CMSimple_XH 1.5 (and up), so it can be used to edit the content of the website.

Instead of being a WYSIWYG or WYSIWYM editor, it allows to edit the source code directly, and currently offers syntax highlighting, line numbering, code indenting, bracket matching and optional line wrapping.

Please do read this documentation! Support might not be given otherwise. It's generally a good idea to read the documentation, before you encounter any problems!

Important Notice

The current version of Codeeditor_XH is BETA software. Use with caution!

Requirements

Codeeditor_XH is a plugin for CMSimple_XH. It requires an UTF-8 encoded version.

Installation

The installation is done as with many other CMSimple_XH plugins. See the CMSimple_XH wiki for further details.

  1. Backup the data on your server.
  2. Unzip the distribution on your computer.
  3. Upload the whole directory codeeditor/ to your server into CMSimple_XH's plugin directory.
  4. Set write permissions to the subdirectories config/, css/ and languages/.
  5. Switch to "Codeeditor" in the back-end to check if all requirements are fulfilled.

Settings

The plugin's configuration is done as with many other CMSimple_XH plugins in the website's back-end. Select "Codeeditor" from "Plugins".

You can change the default settings of Codeeditor_XH in "Plugin Config". Hints for the options will be displayed when hovering over the help icons with your mouse.

Localization is done in "Plugin Language". You can translate the character strings to your own language, or customize them according to your needs.

The style of Codeeditor_XH can be customized in "Plugin Stylesheet".

Usage

To use Codeeditor_XH as external editor for CMSimple_XH 1.5 (and up) go to Settings → CMS → Editor → External and enter "codeeditor". The usage of the editor is pretty much self-explaining, but one thing to note: pressing "Esc" while the cursor is in an editor instance toggles fullscreen mode.

License

Codeeditor_XH is licensed under GPLv3.

© 2012 Christoph M. Becker

Credits

Codeeditor_XH is powered by CodeMirror. Many thanks to Marijn Haverbeke for developing this great piece of software and releasing it under MIT license.

The plugin icon was taken from the Oxygen Icons. Many thanks for offering these icons under GPL.

This plugin uses free applications icons from Aha-Soft. Many thanks for making these icons freely available.

Many thanks to the community at the CMSimple forum for tips, suggestions and testing. Particularly I want to thank Gert, who contributed the ge theme.

And many thanks to all developers of CMSimple_XH without whom this amazing CMS wouldn't exist.