Setting Custom Editor Styles and Templates

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(Article added, CSS files section)
(Article added, Template files section)
Line 3: Line 3:
  
 
== Adding Styles to the CKEditor Styles Drop-down List ==
 
== Adding Styles to the CKEditor Styles Drop-down List ==
−
If you want to add and display additional styles in the editor '''Styles''' drop-down list, proceed as described below.
+
If you want to add and display additional styles in the editor '''[[CKEditor_3.x/Users_Guide/Styling/Styles|Styles]]''' drop-down list, proceed as described below.
  
 
First of all, you need to create the [[CKEditor_3.x/Developers_Guide/Styles|JavaScript file containing style definitions]]. Pay special attention to the definition format. You can also take the default file that is distributed with CKEditor for Joomla! and adjust it to your needs.
 
First of all, you need to create the [[CKEditor_3.x/Developers_Guide/Styles|JavaScript file containing style definitions]]. Pay special attention to the definition format. You can also take the default file that is distributed with CKEditor for Joomla! and adjust it to your needs.
Line 15: Line 15:
  
  
−
When the file is added, enter the '''CKEditor Configuration''' section in Joomla! Administration. Go to the '''Advanced Settings''' tab and add the style definition file name (in this example <code>my_style.js</code>) to the '''Styles''' definition file field.
+
When the file is added, enter the '''CKEditor Configuration''' section in Joomla! Administration. Go to the '''Advanced Settings''' tab and add the style definition file name (in this example <code>my_style.js</code>) to the '''Styles definition file''' field.
  
 
[[Image:Joomla_adding_styles_02.png|frame|center|Adding a style definition file in CKEditor for Joomla!]]
 
[[Image:Joomla_adding_styles_02.png|frame|center|Adding a style definition file in CKEditor for Joomla!]]
Line 30: Line 30:
  
  
−
After the files are added, enter the '''CKEditor Configuration''' section in Joomla! Administration. Go to the '''Advanced Settings''' tab and add the semi-colon separated CSS file names (in this example <code>my_contents.css;my_new_contents.css</code>)  to the CSS files field.
+
After the files are added, enter the '''CKEditor Configuration''' section in Joomla! Administration. Go to the '''Advanced Settings''' tab and add the semi-colon separated CSS file names (in this example <code>my_contents.css;my_new_contents.css</code>)  to the '''CSS files''' field.
  
 
[[Image:Joomla_adding_CSS_02.png|frame|center|Adding a CSS file in CKEditor for Joomla!]]
 
[[Image:Joomla_adding_CSS_02.png|frame|center|Adding a CSS file in CKEditor for Joomla!]]
 +
 +
 +
== Adding Custom Templates to CKEditor ==
 +
If you want to add and display additional templates in the editor '''[[CKEditor_3.x/Users_Guide/Document/Templates|Templates]]''' feature, proceed as described below.
 +
 +
First of all, you need to create the [[CKEditor_3.x/Developers_Guide/Templates|JavaScript file containing template definitions]]. Pay special attention to the required template definition format. You can also take the default file that is distributed with CKEditor for Joomla! and adjust it to your needs.
 +
 +
The template definitions file needs to be added to the <code>''Joomla_site''/plugins/editors/ckeditor/templates</code> directory.
 +
 +
[[Image:Joomla_adding_templates_01.png|frame|center|Template definition files for CKEditor]]
 +
 +
 +
<note>The name given in the <code>addTemplates</code> definition must be the same as the file name without the <code>.js</code> extension, like in <code>CKEDITOR.addTemplates( 'template_src', )</code>.</note>
 +
 +
 +
When the file is added, enter the '''CKEditor Configuration''' section in Joomla! Administration. Go to the '''Advanced Settings''' tab and add the template definition file name (in this example <code>my_template_src.js</code>) to the '''Templates definition file''' field.
 +
 +
[[Image:Joomla_adding_templates_02.png|frame|center|Adding a template definition file for CKEditor]]
 +
 +
 +
Your newly defined templates will now be displayed in the '''Content Templates''' dialog window of CKEditor.

Revision as of 15:19, 30 November 2011

The look and feel of the editor installed in your Joomla! page can be modified to suit the character and style of your website. This article will explain how to add custom styles, CSS files, and templates to your CKEditor installation.

Adding Styles to the CKEditor Styles Drop-down List

If you want to add and display additional styles in the editor Styles drop-down list, proceed as described below.

First of all, you need to create the JavaScript file containing style definitions. Pay special attention to the definition format. You can also take the default file that is distributed with CKEditor for Joomla! and adjust it to your needs.

The style definitions file needs to be added to the Joomla_site/plugins/editors/ckeditor/styles directory.

Style definition files for CKEditor


important note
The name given in the addStylesSet definition must be the same as the file name without the .js extension, like in CKEDITOR.addStylesSet( 'my_style', ).


When the file is added, enter the CKEditor Configuration section in Joomla! Administration. Go to the Advanced Settings tab and add the style definition file name (in this example my_style.js) to the Styles definition file field.

Adding a style definition file in CKEditor for Joomla!


Your newly defined styles will now be displayed in the Styles drop-down list and used in the editing area of CKEditor.

Adding CSS Files to CKEditor

If you want to add additional CSS files to CKEditor, proceed as described below.

Once the CSS files are created, upload them to the Joomla_site/plugins/editors/ckeditor/css directory.

CSS files for CKEditor


After the files are added, enter the CKEditor Configuration section in Joomla! Administration. Go to the Advanced Settings tab and add the semi-colon separated CSS file names (in this example my_contents.css;my_new_contents.css) to the CSS files field.

Adding a CSS file in CKEditor for Joomla!


Adding Custom Templates to CKEditor

If you want to add and display additional templates in the editor Templates feature, proceed as described below.

First of all, you need to create the JavaScript file containing template definitions. Pay special attention to the required template definition format. You can also take the default file that is distributed with CKEditor for Joomla! and adjust it to your needs.

The template definitions file needs to be added to the Joomla_site/plugins/editors/ckeditor/templates directory.

Template definition files for CKEditor


important note
The name given in the addTemplates definition must be the same as the file name without the .js extension, like in CKEDITOR.addTemplates( 'template_src', ).


When the file is added, enter the CKEditor Configuration section in Joomla! Administration. Go to the Advanced Settings tab and add the template definition file name (in this example my_template_src.js) to the Templates definition file field.

Adding a template definition file for CKEditor


Your newly defined templates will now be displayed in the Content Templates dialog window of CKEditor.

Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKEditor_for_Joomla/Custom_Styles_and_Templates&oldid=6724"