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.

(Final proof-reading)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
A template is CKEditor's function which allows user to change the page layout, style and to organize user's document better.In order to activate it press [[Image:CKEditor_templates.png]] button on the toolbar. A pop up window called "Content Templates" will appear:
+
A '''Content Template''' is a CKEditor feature that lets you control the structure of the document and preserve consistency across multiple documents. Templates are pre-defined, ready-made document forms with page layout, text formatting and styling as well as other elements.  
  
[[Image:CKEditor_templates_window.png]]
+
To use one of CKEditor templates, press the [[Image:CKEditor_templates.png|Templates]] button on the toolbar. The following '''Content Templates''' dialog window will be displayed on the screen.
  
* '''Image and Title''': one main image with a title and text that surround the image.
+
[[Image:CKEditor_templates_window.png|frame|center|CKEditor Content Templates dialog window]]
* '''Strange Template''': a template that defines two columns, each one with title, and some text.
 
* '''Text and Table''': a title with some text and a table.
 
  
'''Replace actual contents''': If user checks this option, current content will be replace by the new one.
 
  
If you chose a template double-click on it and it will appear in your document.
+
{{CKEditor Dialog Windows}}
  
Example:
+
The dialog window shows a list of pre-defined templates that are available in your system. The standard installation of CKEditor contains three basic templates, however, this list may be expanded as needed. Since [[CKEditor_3.x/Developers_Guide/Templates|creating and adding new templates]] is an advanced feature, please contact your system administrator if you need a special template for your purposes.
  
[[Image:CKEditor_templetes_example.png]]
+
Each template listed in the window contains a title, an image presenting the schematic outline of the template as well as its description.
 +
 
 +
In order to select a template, choose it from the list in the '''Content Templates''' dialog window and click once. The dialog window will close and the selected template will be applied to the document.
 +
 
 +
The '''Content Templates''' dialog window contains only one configuration option: '''Replace actual contents'''.
 +
 
 +
Leaving it checked means that the inserted template will also replace the content entered previously into the CKEditor window, deleting it in the process. This is a potentially destructive operation, so if you unintentionally remove the text using this option, you can always revert this operation by pressing the [[Image:CKEditor_undo.png|Undo]] button on the toolbar or the ''Ctrl+Z'' shortcut on your keyboard.
 +
 
 +
If you leave the '''Replace actual contents''' option unchecked, the template will be inserted in the current position of the cursor in the document.
 +
 
 +
The figure below shows the editing area of CKEditor after inserting the template called "Strange Template" that defines a two-column-layout with headings and a text placeholder. Since the '''Replace actual contents''' option was selected, the template replaced the text that was previously entered into the editing area.
 +
 
 +
[[Image:CKEditor_template_example.png|frame|center|"Strange Template" inserted into a document in CKEditor]]

Latest revision as of 10:47, 13 December 2010

A Content Template is a CKEditor feature that lets you control the structure of the document and preserve consistency across multiple documents. Templates are pre-defined, ready-made document forms with page layout, text formatting and styling as well as other elements.

To use one of CKEditor templates, press the Templates button on the toolbar. The following Content Templates dialog window will be displayed on the screen.

CKEditor Content Templates dialog window


For general information on using dialog windows please refer to the Dialog Windows section of the User's Guide.

The dialog window shows a list of pre-defined templates that are available in your system. The standard installation of CKEditor contains three basic templates, however, this list may be expanded as needed. Since creating and adding new templates is an advanced feature, please contact your system administrator if you need a special template for your purposes.

Each template listed in the window contains a title, an image presenting the schematic outline of the template as well as its description.

In order to select a template, choose it from the list in the Content Templates dialog window and click once. The dialog window will close and the selected template will be applied to the document.

The Content Templates dialog window contains only one configuration option: Replace actual contents.

Leaving it checked means that the inserted template will also replace the content entered previously into the CKEditor window, deleting it in the process. This is a potentially destructive operation, so if you unintentionally remove the text using this option, you can always revert this operation by pressing the Undo button on the toolbar or the Ctrl+Z shortcut on your keyboard.

If you leave the Replace actual contents option unchecked, the template will be inserted in the current position of the cursor in the document.

The figure below shows the editing area of CKEditor after inserting the template called "Strange Template" that defines a two-column-layout with headings and a text placeholder. Since the Replace actual contents option was selected, the template replaced the text that was previously entered into the editing area.

"Strange Template" inserted into a document in CKEditor
This page was last edited on 13 December 2010, at 10:47.