orchardckeditor Wiki Rss Feed

New Comment on "Configuration"

andrewmyhre — Mon, 11 Jun 2012 10:55:49 GMT

Is it possible to use this to set the stylesheetParser_validSelectors property? (It's not a string type it's a JS regex type).

Updated Wiki: Home

randompete — Wed, 05 Oct 2011 13:46:21 GMT

Project Description
Adds CKEditor 3.6.2 to your Orchard CMS website for HTML editing.
See Configuration for documentation on customizing CKEditor. We are working towards complete configuration from the Dashboard, and full integration with Orchard's Media Picker (in 1.1) as well as a Link Browser. See Roadmap for more detail.
For Orchard version 1.1+.

Latest: 1.0.9.2 - CKEditor 3.6.2 (HTML5, iOS 5) and standards compliant paragraphs.

Upgrade Notes

Please note when you upgrade the CKEditor module, files like config.js and ckeditor.js will be overwritten. We are in the process of providing non-intrusive ways to completely reconfigure CKEditor, so you , you will need to back up those changes before upgrading, because the config.js file will get overwritten during the upgrade. See the documentation on Configuration for best practices when customising CKEditor for Orchard.

Instructions for use

You can install the module through the Gallery interface in the Orchard Dashboard.
You'll also need to disable the default TinyMCE module to ensure the CKEditor takes precedence.
When you edit Pages or Html Fields, you'll now get the CKEditor instead of TinyMCE.

Theme Styles

The latest release will find the Site.css from your current theme and use that within the editor window, giving you proper WYSIWYG editing with the same styles as your front end. In Orchard Dashboard there's now a CKEditor settings page where you can change the stylesheet(s) that get referenced (or leave it blank to suppress the setting).

Updated Wiki: Home

randompete — Wed, 05 Oct 2011 13:46:07 GMT

Project Description
Adds CKEditor 3.6 to your Orchard CMS website for HTML editing.
See Configuration for documentation on customizing CKEditor. We are working towards complete configuration from the Dashboard, and full integration with Orchard's Media Picker (in 1.1) as well as a Link Browser. See Roadmap for more detail.
For Orchard version 1.1+.

Latest: 1.0.9.2 - CKEditor 3.6.2 (HTML5, iOS 5) and standards compliant paragraphs.

Upgrade Notes

Instructions for use

Theme Styles

Updated Wiki: Home

randompete — Wed, 05 Oct 2011 13:45:51 GMT

Project Description
Adds CKEditor 3.6 to your Orchard CMS website for HTML editing.
See Configuration for documentation on customizing CKEditor. We are working towards complete configuration from the Dashboard, and full integration with Orchard's Media Picker (in 1.1) as well as a Link Browser. See Roadmap for more detail.
For Orchard versions 1.0 and 1.1.

Latest: 1.0.9.2 - CKEditor 3.6.2 (HTML5, iOS 5) and standards compliant paragraphs.

Upgrade Notes

Instructions for use

Theme Styles

Updated Wiki: Configuration

randompete — Wed, 05 Oct 2011 13:45:27 GMT

CKEditor Configuration

CKEditor for Orchard provides some simple ways for you to configure the CKEditor application.

Settings Page

Once you've enabled CKEditor, in the Orchard Dashboard you'll find a CKEditor settings page. This allows you to modify a small number of options - we haven't added many yet!

Javacript config template

Advanced Configuration with ICKEditorConfigProvider

We've provided a way to add and manipulate settings from code, so this is perfect to use from modules but can be used in themes as well.

You just need to implement the ICKEditorConfigProvider interface, and from there you can add key/value pairs into the configuration context. These will all get written as Javascript config when the CKEditor is displayed.
Example:

    public class SampleConfigProvider : ICKEditorConfigProvider
    {

        public SampleConfigProvider(
            )
        {
        }

        public void PopulateConfiguration(CKEditorConfigContext config)
        {
                    config.Add(new CKEditorConfigString("stringSetting","foo"));
                    config.Add(new CKEditorConfigStringList("listSetting", new[]{"foo","bar"}));
        }
    }

You can also look at the CKEditor module to see how existing settings are implemented in the Dashboard - contributions are welcome if you feel like adding any more of CKEditor's built-in settings!

Updated Wiki: Configuration

randompete — Wed, 05 Oct 2011 13:45:15 GMT

CKEditor Configuration

CKEditor for Orchard provides some simple ways for you to configure the CKEditor application.

Settings Page

Once you've enabled CKEditor, in the Orchard Dashboard you'll find a CKEditor settings page. This allows you to modify a small number of options - we haven't added many yet!

Javacript config template

Advanced Configuration with ICKEditorConfigProvider

    public class SampleConfigProvider : ICKEditorConfigProvider
    {

        public SampleConfigProvider(
            )
        {
        }

        public void PopulateConfiguration(CKEditorConfigContext config)
        {
                    config.Add(new CKEditorConfigString("stringSetting","foo"));
                    config.Add(new CKEditorConfigStringList("listSetting", new[]{"foo","bar"}));
        }
    }

You can also look at the CKEditor module to see how existing settings are implemented in the Dashboard - contributions are welcome if you feel like adding any more of CKEditor's built-in settings!

Updated Wiki: VersionHistory

randompete — Wed, 05 Oct 2011 13:39:14 GMT

Version History

1.0.9.2

Use proper paragraphs - ENTER_BR is no longer the default (Configure enterMode from admin.)

1.0.9.1

Maintenance release
Updated CKEditor to version 3.6.2 (http://ckeditor.com/whatsnew)
Includes HTML5 and iOS 5 support
Fixed Id for compatibility with HtmlField (http://orchardckeditor.codeplex.com/discussions/271938)

1.0.9

Updated CKEditor to version 3.6
ICKEditorConfigProvider interface added for modifying configuration
Added settings for Extra Plugins and Clear Default Style Sets to support stylesheetparser (and other plugins)

1.0.8

Correctly handle empty Contents CSS by suppressing contentsCss from config output

1.0.7

CKEditor settings section in Dashboard; Contents CSS is the only setting thus far (but which now allows for multiple files)
Cleaned up project references avoiding Orchard 1.0.20 binaries getting distributed in package
Moved all ckeditor scripts into ~/Scripts/ckeditor; so integration plugins can go outside of ckeditor folders making ckeditor version update easier in the future; also could end up adding ~/Scripts/ckfinder if it looks like a good idea to add that as an optional feature

1.0.6

Site.css from your site theme now gets used in CKEditor_Config for the contentsCss setting; meaning proper WYSIWYG editing with the same styles as your front end

1.0.5

Included some files from CKEditor 3.5.3 in the project and therefore package that were previously omitted
Removed _source and _samples folders from project to reduce package size. You can delete the CKEditor folder and reinstall if you want to clean up your website files.

1.0.4

Fixed missing shape error in package due to project file changes not being saved

1.0.3

Improved configuration mechanic using CKEditor_Config shape (CKEditor.Config.cshtml)

1.0.2

Updated CKEditor to version 3.5.3

1.0.1

Fixed error with Return key

1.0.0

Original version including CKEditor 3.5

Updated Wiki: Documentation

randompete — Wed, 05 Oct 2011 13:35:05 GMT

CKEditor for Orchard Documentation

Version History - Current version: 1.0.9.2
Configuration

Updated Wiki: VersionHistory

randompete — Wed, 05 Oct 2011 13:32:04 GMT

Version History

1.0.9.1

Maintenance release
Updated CKEditor to version 3.6.2 (http://ckeditor.com/whatsnew)
Includes HTML5 and iOS 5 support
Fixed Id for compatibility with HtmlField (http://orchardckeditor.codeplex.com/discussions/271938)

1.0.9

Updated CKEditor to version 3.6
ICKEditorConfigProvider interface added for modifying configuration
Added settings for Extra Plugins and Clear Default Style Sets to support stylesheetparser (and other plugins)

1.0.8

Correctly handle empty Contents CSS by suppressing contentsCss from config output

1.0.7

CKEditor settings section in Dashboard; Contents CSS is the only setting thus far (but which now allows for multiple files)
Cleaned up project references avoiding Orchard 1.0.20 binaries getting distributed in package
Moved all ckeditor scripts into ~/Scripts/ckeditor; so integration plugins can go outside of ckeditor folders making ckeditor version update easier in the future; also could end up adding ~/Scripts/ckfinder if it looks like a good idea to add that as an optional feature

1.0.6

Site.css from your site theme now gets used in CKEditor_Config for the contentsCss setting; meaning proper WYSIWYG editing with the same styles as your front end

1.0.5

Included some files from CKEditor 3.5.3 in the project and therefore package that were previously omitted
Removed _source and _samples folders from project to reduce package size. You can delete the CKEditor folder and reinstall if you want to clean up your website files.

1.0.4

Fixed missing shape error in package due to project file changes not being saved

1.0.3

Improved configuration mechanic using CKEditor_Config shape (CKEditor.Config.cshtml)

1.0.2

Updated CKEditor to version 3.5.3

1.0.1

Fixed error with Return key

1.0.0

Original version including CKEditor 3.5

Updated Wiki: Home

randompete — Fri, 27 May 2011 11:31:36 GMT

Project Description
Adds CKEditor 3.6 to your Orchard CMS website for HTML editing.
See Configuration for documentation on customizing CKEditor. We are working towards complete configuration from the Dashboard, and full integration with Orchard's Media Picker (in 1.1) as well as a Link Browser. See Roadmap for more detail.
For Orchard versions 1.0 and 1.1.

Latest: 1.0.9 - stylesheetparser plugin can now automatically populate the Styles menu - ICKEditorConfigProvider interface for extending configuration - see release thread for details.

Upgrade Notes

Instructions for use

Theme Styles

Updated Wiki: Roadmap

randompete — Fri, 27 May 2011 11:31:03 GMT

Roadmap

Version	Features
1.1	Plugins list, Skins list, Main config options
1.2	Media Picker integration
1.3	Link browser

Updated Wiki: Configuration

randompete — Fri, 27 May 2011 11:26:13 GMT

CKEditor Configuration

CKEditor for Orchard provides some simple ways for you to configure the CKEditor application.

Settings Page

Once you've enabled CKEditor, in the Orchard Dashboard you'll find a CKEditor settings page. This allows you to modify a small number of options - we haven't added many yet!

Configuration with ICKEditorConfigProvider

    public class SampleConfigProvider : ICKEditorConfigProvider
    {

        public SampleConfigProvider(
            )
        {
        }

        public void PopulateConfiguration(CKEditorConfigContext config)
        {
                    config.Add(new CKEditorConfigString("stringSetting","foo"));
                    config.Add(new CKEditorConfigStringList("listSetting", new[]{"foo","bar"}));
        }
    }

You can also look at the CKEditor module to see how existing settings are implemented in the Dashboard - contributions are welcome if you feel like adding any more of CKEditor's built-in settings!

Config template

In the ~/Views folder there's a file called CKEditor.Config.cshtml. This writes out the Javascript config for the CKEDITOR.replace method. You can copy this file into the ~/Views folder of TheAdmin theme if you want to customise it; but the recommended method is to use ICKEditorConfigProvider for now until we add more options in the Dashboard UI. There are plans to extend config even further in the future and CKEditor.Config.cshtml will change.

Updated Wiki: Home

randompete — Fri, 27 May 2011 11:23:19 GMT

Project Description
Adds CKEditor 3.6 to your Orchard CMS website for HTML editing.
See Configuration for documentation on customizing CKEditor. We are working towards complete configuration from the Dashboard, and full integration with Orchard's Media Picker (in 1.1) as well as a Link Browser. See Roadmap for more detail.
For Orchard versions 1.0 and 1.1.

Latest: 1.0.9 - stylesheetparser plugin can now automatically populate the Styles menu - ICKEditorConfigProvider interface for extending configuration - see release thread for details.

Upgrade Notes

Instructions for use

Theme Styles

Updated Wiki: Configuration

randompete — Fri, 27 May 2011 11:12:49 GMT

CKEditor Configuration

CKEditor for Orchard provides some simple ways for you to configure the CKEditor application.

Settings Page

Once you've enabled CKEditor, in the Orchard Dashboard you'll find a CKEditor settings page. This allows you to modify a small number of options - we haven't added many yet!

Configuration with ICKEditorConfigProvider

    public class SampleConfigProvider : ICKEditorConfigProvider
    {

        public SampleConfigProvider(
            )
        {
        }

        public void PopulateConfiguration(CKEditorConfigContext config)
        {
                    config.Add(new CKEditorConfigString("stringSetting","foo"));
                    config.Add(new CKEditorConfigStringList("listSetting", new[]{"foo","bar"}));
        }
    }

You can also look at the CKEditor module to see how existing settings are implemented in the Dashboard - contributions are welcome if you feel like adding any more of CKEditor's built-in settings!

Config template

In the ~/Views folder there's a file called CKEditor.Config.cshtml. This writes out the Javascript config for the CKEDITOR.replace method. You can copy this file into the ~/Views folder of your theme if you want to customise it, but the recommended method is to use ICKEditorConfigProvider since there are plans to extend config even further in the future and CKEditor.Config.cshtml might get updated.

Updated Wiki: Configuration

randompete — Fri, 27 May 2011 11:12:35 GMT

CKEditor Configuration

CKEditor for Orchard provides some simple ways for you to configure the CKEditor application.

Settings Page

Once you've enabled CKEditor, in the Orchard Dashboard you'll find a CKEditor settings page. This allows you to modify a small number of options - we haven't added many yet!

Configuration with ICKEditorConfigProvider

    public class SampleConfigProvider : ICKEditorConfigProvider
    {

        public SampleConfigProvider(
            )
        {
        }

        public void PopulateConfiguration(CKEditorConfigContext config)
        {
                    config.Add(new CKEditorConfigString("stringSetting","foo"));
                    config.Add(new CKEditorConfigStringList("listSetting", new[]{"foo","bar"}));
        }
    }

You can also look at the CKEditor module to see how existing settings are implemented in the Dashboard - contributions are welcome if you feel like adding any more of CKEditor's built-in settings!

Config template

In the ~/Views folder there's a file called CKEditor.Config.cshtm. This writes out the Javascript config for the CKEDITOR.replace method. You can copy this file into the ~/Views folder of your theme if you want to customise it, but the recommended method is to use ICKEditorConfigProvider since there are plans to extend config even further in the future and CKEditor.Config.cshtml might get updated.

Updated Wiki: Home

randompete — Fri, 27 May 2011 11:11:54 GMT

Project Description
Adds CKEditor 3.6 to your Orchard CMS website for HTML editing.
We are planning full integration with Orchard's Media Picker as well as a Link Browser - coming soon!

Latest: 1.0.9 - stylesheetparser plugin can now automatically populate the Styles menu - ICKEditorConfigProvider interface for extending configuration - see release thread for details.

Upgrade Note

Please note if you are upgrading from version 1.0.1 of the CKEditor module and have made any changes to config.js, you will need to back up those changes before upgrading, because the config.js file will get overwritten during the upgrade.
The recommended method to configure CKEditor is now by creating a CKEditor.Config.cshtml in the Views folder (either in TheAdmin theme or in your own module). You can copy the existing default configuration from CKEditor/Views and add or change any configuration properties that you like. It is not recommended to change the original CKEditor.Config.cshtml in the CKEditor project itself - because that could also get overwritten in future releases! (For instance we could implement configuration in the Dashboard...)

Instructions for use

Theme Styles

Updated Wiki: Home

randompete — Fri, 27 May 2011 11:10:48 GMT

Upgrade Note

Instructions for use

Theme Styles

Updated Wiki: Documentation

randompete — Thu, 26 May 2011 21:48:45 GMT

CKEditor for Orchard Documentation

Version History - Current version: 1.0.9
Configuration

Updated Wiki: Configuration

randompete — Thu, 26 May 2011 21:47:58 GMT

CKEditor Configuration

CKEditor for Orchard provides some simple ways for you to configure the CKEditor application.

Settings Page

Once you've enabled CKEditor, in the Orchard Dashboard you'll find a CKEditor settings page. This allows you to modify a small number of options - we haven't added many yet!

Configuration with ICKEditorConfigProvider

    public class SampleConfigProvider : ICKEditorConfigProvider
    {

        public SampleConfigProvider(
            )
        {
        }

        public void PopulateConfiguration(CKEditorConfigContext config)
        {
                    config.Add(new CKEditorConfigString("stringSetting","foo"));
                    config.Add(new CKEditorConfigStringList("listSetting", new[]{"foo","bar"}));
        }
    }

You can also look at the CKEditor module to see how existing settings are implemented in the Dashboard - contributions are welcome if you feel like adding any more of CKEditor's built-in settings!

Config template

In the ~/Views folder there's a file called http://orchardckeditor.codeplex.com/SourceControl/changeset/view/578b9148f2af#Views%2fCKEditor.Config.cshtml. This writes out the Javascript config for the CKEDITOR.replace method. You can copy this file into the ~/Views folder of your theme if you want to customise it, but the recommended method is to use ICKEditorConfigProvider since there are plans to extend config even further in the future and CKEditor.Config.cshtml might get updated.

Updated Wiki: VersionHistory

randompete — Thu, 26 May 2011 21:33:44 GMT

Version History

1.0.9

Updated CKEditor to version 3.6
ICKEditorConfigProvider interface added for modifying configuration
Added settings for Extra Plugins and Clear Default Style Sets to support stylesheetparser (and other plugins)

1.0.8

Correctly handle empty Contents CSS by suppressing contentsCss from config output

1.0.7

CKEditor settings section in Dashboard; Contents CSS is the only setting thus far (but which now allows for multiple files)
Cleaned up project references avoiding Orchard 1.0.20 binaries getting distributed in package
Moved all ckeditor scripts into ~/Scripts/ckeditor; so integration plugins can go outside of ckeditor folders making ckeditor version update easier in the future; also could end up adding ~/Scripts/ckfinder if it looks like a good idea to add that as an optional feature

1.0.6

Site.css from your site theme now gets used in CKEditor_Config for the contentsCss setting; meaning proper WYSIWYG editing with the same styles as your front end

1.0.5

Included some files from CKEditor 3.5.3 in the project and therefore package that were previously omitted
Removed _source and _samples folders from project to reduce package size. You can delete the CKEditor folder and reinstall if you want to clean up your website files.

1.0.4

Fixed missing shape error in package due to project file changes not being saved

1.0.3

Improved configuration mechanic using CKEditor_Config shape (CKEditor.Config.cshtml)

1.0.2

Updated CKEditor to version 3.5.3

1.0.1

Fixed error with Return key

1.0.0

Original version including CKEditor 3.5