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.

m (fixed typo)
(→‎The Templates Definitions File Contents: Article section proof-read)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
With CKEditor, content writers can select a template from a list by clicking the "Templates" button in the toolbar. A template is a predefined piece of HTML that is placed inside the editor. In this way the user doesn't need to start writing from scratch. Designers can prepare well designed templates, avoiding user errors before they happen.
+
With CKEditor content writers can select a template from a list by clicking the [[Image:CKEditor_templates.png|Templates]] button in the toolbar. A template is a predefined piece of HTML that is inserted into a document. Using this feature, the user does not need to start formatting the text from scratch. Designers can prepare well designed templates which helps avoid user errors before they happen.
  
 
=== Template Definition Files ===
 
=== Template Definition Files ===
 +
CKEditor comes preinstalled with three sample [[CKEditor 3.x/Users Guide/Document/Templates|templates]] that are there just to show the way this feature works. They are defined in the <code>plugins/templates/templates/default.js</code> file. Developers should most definitely modify the default templates as they are not particularly useful to end users.
  
−
The editor comes with three sample templates that are there just to show the way it works. They are defined into the "plugins/templates/templates/default.js" file.
+
Note that a template definition file is a JavaScript file that is loaded when opening the '''Content Templates''' dialog window for the first time. This file may be modified to include custom templates, or you can create a separate template file outside the editor installation directory and configure the editor to use it.
  
−
Developers should definitely change the default templates as they are not especially useful to end users.
+
=== Pointing the Editor to a Custom Templates Definition File ===
−
 
+
Suppose you have created a custom template definition file named <code>mytemplates.js</code> (starting from a copy of <code>default.js</code>) and placed it in the root directory of your website. You can now add the following setting in the editor configuration:
−
Note that a template definition file is a JavaScript file that's loaded when opening the templates dialog for the first time. This file may be changed to include custom templates, or even better, you can create a separated template file outside the editor installation directory, configuring the editor to use it.
+
<source language="js">
−
 
 
−
=== Pointing the Editor to a Custom Templates Definitions File ===
 
−
 
 
−
Assuming you have created a custom Templates Definitions file named "mytemplates.js" (starting from a copy of default.js) and have placed it into the root of your web site. Now, just add the following setting in the editor configuration:
 
−
 
−
<pre>
 
 
config.templates_files = [ '/mytemplates.js' ];
 
config.templates_files = [ '/mytemplates.js' ];
−
</pre>  
+
</source>  
−
 
 
−
Note that the [http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.templates_files templates_files] setting is an array, which means that more than one templates file can be used.
 
  
−
=== The Templates Definitions File Contents ===
+
Note that the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.templates_files templates_files]</code> setting accepts an array, which means that more than one template file can be used at any time.
  
−
This is a sample Template Definition file that defines two simple templates:
+
=== Template Definition File Contents ===
 +
Below you will find a sample template definition file that defines two simple templates.
  
−
<pre>
+
<source language="js">
−
// Register a templates definition set named "default".
+
// Register a template definition set named "default".
 
CKEDITOR.addTemplates( 'default',
 
CKEDITOR.addTemplates( 'default',
 
{
 
{
−
// The name of sub folder which hold the shortcut preview images of the templates.
+
// The name of the subfolder that contains the preview images of the templates.
 
imagesPath : CKEDITOR.getUrl( CKEDITOR.plugins.getPath( 'templates' ) + 'templates/images/' ),
 
imagesPath : CKEDITOR.getUrl( CKEDITOR.plugins.getPath( 'templates' ) + 'templates/images/' ),
  
−
// The templates definitions.
+
// Template definitions.
 
templates :
 
templates :
 
[
 
[
Line 36: Line 30:
 
title: 'My Template 1',
 
title: 'My Template 1',
 
image: 'template1.gif',
 
image: 'template1.gif',
−
description: 'Description of my template 1.',
+
description: 'Description of My Template 1.',
 
html:
 
html:
 
'<h2>Template 1</h2>' +
 
'<h2>Template 1</h2>' +
−
'<p><img src="/logo.png" style="float:left" />Type the text here.</p>'
+
'<p><img src="/logo.png" style="float:left" />Type your text here.</p>'
 
},
 
},
 
{
 
{
Line 45: Line 39:
 
html:
 
html:
 
'<h3>Template 2</h3>' +
 
'<h3>Template 2</h3>' +
−
'<p>Type the text here.</p>'
+
'<p>Type your text here.</p>'
 
}
 
}
 
]
 
]
 
});
 
});
−
</pre>
+
</source>
  
−
As we can see here, the above is pure JavaScript code. It's a simple call to the [http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.html#.addTemplates CKEDITOR.addTemplates] function, which registers the templates under a unique name ("default"). This name can be then used by the [http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.templates templates] setting.
+
The above example contains pure JavaScript code. It is based on a call to the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.html#.addTemplates CKEDITOR.addTemplates]</code> function that registers the templates under a unique name (<code>default</code>). This name can be later used by the <code>[http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.config.html#.templates templates]</code> setting.

Latest revision as of 08:52, 31 January 2011

With CKEditor content writers can select a template from a list by clicking the Templates button in the toolbar. A template is a predefined piece of HTML that is inserted into a document. Using this feature, the user does not need to start formatting the text from scratch. Designers can prepare well designed templates which helps avoid user errors before they happen.

Template Definition Files

CKEditor comes preinstalled with three sample templates that are there just to show the way this feature works. They are defined in the plugins/templates/templates/default.js file. Developers should most definitely modify the default templates as they are not particularly useful to end users.

Note that a template definition file is a JavaScript file that is loaded when opening the Content Templates dialog window for the first time. This file may be modified to include custom templates, or you can create a separate template file outside the editor installation directory and configure the editor to use it.

Pointing the Editor to a Custom Templates Definition File

Suppose you have created a custom template definition file named mytemplates.js (starting from a copy of default.js) and placed it in the root directory of your website. You can now add the following setting in the editor configuration: 

config.templates_files = [ '/mytemplates.js' ];

Note that the templates_files setting accepts an array, which means that more than one template file can be used at any time.

Template Definition File Contents

Below you will find a sample template definition file that defines two simple templates. 

// Register a template definition set named "default".
CKEDITOR.addTemplates( 'default',
{
	// The name of the subfolder that contains the preview images of the templates.
	imagesPath : CKEDITOR.getUrl( CKEDITOR.plugins.getPath( 'templates' ) + 'templates/images/' ),

	// Template definitions.
	templates :
		[
			{
				title: 'My Template 1',
				image: 'template1.gif',
				description: 'Description of My Template 1.',
				html:
					'<h2>Template 1</h2>' +
					'<p><img src="/logo.png" style="float:left" />Type your text here.</p>'
			},
			{
				title: 'My Template 2',
				html:
					'<h3>Template 2</h3>' +
					'<p>Type your text here.</p>'
			}
		]
});

The above example contains pure JavaScript code. It is based on a call to the CKEDITOR.addTemplates function that registers the templates under a unique name (default). This name can be later used by the templates setting.

Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKEditor_3.x/Developers_Guide/Templates&oldid=5731"
This page was last edited on 31 January 2011, at 08:52.