Using the CKEditor Web Part

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.

(Adding a Web Part Page added)
(Section headings and TOC added)
Line 1: Line 1:
 +
__TOC__
 
{{#CUSTOMTITLE:Using the CKEditor Web Part}}
 
{{#CUSTOMTITLE:Using the CKEditor Web Part}}
 
After you enable '''CKEditor for SharePoint''' for a site collection or individual site, CKEditor will automatically replace the default rich text editor for various content types, including a blog post, or a calendar appointment. Furthermore you can also use CKEditor to edit a page that is built with SharePoint web parts. This option lets you add and format content inserted into your pages quickly and efficiently, by using the numerous CKEditor toolbar features.
 
After you enable '''CKEditor for SharePoint''' for a site collection or individual site, CKEditor will automatically replace the default rich text editor for various content types, including a blog post, or a calendar appointment. Furthermore you can also use CKEditor to edit a page that is built with SharePoint web parts. This option lets you add and format content inserted into your pages quickly and efficiently, by using the numerous CKEditor toolbar features.
Line 12: Line 13:
  
  
 +
== Adding the CKEditor Web Part ==
 
In order to add the '''CKEditor Web Part''' you need to choose the '''Add a Web Part''' option for the desired web part zone.
 
In order to add the '''CKEditor Web Part''' you need to choose the '''Add a Web Part''' option for the desired web part zone.
  
Line 34: Line 36:
  
  
 +
== Modifying the CKEditor Web Part ==
 
To modify the content of the '''CKEditor Web Part''', open the web part tool pane by clicking the "open the tool pane" link or choosing the '''Edit Web Part''' option from the drop-down menu.
 
To modify the content of the '''CKEditor Web Part''', open the web part tool pane by clicking the "open the tool pane" link or choosing the '''Edit Web Part''' option from the drop-down menu.
  
Line 39: Line 42:
  
  
 +
=== Web Part Properties ===
 
The '''Appearance''', '''Layout''', and '''Advanced''' options let you customize the look and feel of the '''CKEditor Web Part'''. Click the [[Image:plusicon.png|plus]] icon to expand a configuration category and gain access to appropriate settings.
 
The '''Appearance''', '''Layout''', and '''Advanced''' options let you customize the look and feel of the '''CKEditor Web Part'''. Click the [[Image:plusicon.png|plus]] icon to expand a configuration category and gain access to appropriate settings.
  
Line 56: Line 60:
  
  
 +
=== Web Part Content ===
 
When you are happy with your '''CKEditor Web Part''' customization, you can start adding content in the WYSIWYG editing area. The text entered in the editor can be formatted using all available toolbar buttons. Depending on the system settings, you might also add other content types to your web part, including images, links, emoticons, or Flash objects. When you are ready, click the '''OK''' button to save the changes.
 
When you are happy with your '''CKEditor Web Part''' customization, you can start adding content in the WYSIWYG editing area. The text entered in the editor can be formatted using all available toolbar buttons. Depending on the system settings, you might also add other content types to your web part, including images, links, emoticons, or Flash objects. When you are ready, click the '''OK''' button to save the changes.
  

Revision as of 07:57, 24 November 2010

After you enable CKEditor for SharePoint for a site collection or individual site, CKEditor will automatically replace the default rich text editor for various content types, including a blog post, or a calendar appointment. Furthermore you can also use CKEditor to edit a page that is built with SharePoint web parts. This option lets you add and format content inserted into your pages quickly and efficiently, by using the numerous CKEditor toolbar features.

To use the CKEditor Web Part, use an existing web part page or create a new one using the More Options page from the Site Actions menu, and choose the Web Part Page type from the Pages and Sites section.

Web Part Page created in SharePoint 2010


When the web part page is ready, go to its Site Actions menu, and choose the Edit Page option.

Edit Page option in the Site Action menu of SharePoint 2010


Adding the CKEditor Web Part

In order to add the CKEditor Web Part you need to choose the Add a Web Part option for the desired web part zone.

Adding a Web Part in SharePoint 2010


The All Web Parts list from the Add Web Parts page should contain an entry for CKEditor for SharePoint. After you select the CKEditor Web Part from the list click the Add button.

CKEditor Web Part tool pane in SharePoint 2010


The CKEditor Web Part will now be added to the page in the appropriate web part zone.

Important note: When CKEditor for SharePoint is in trial mode, the CKEditor Web Part contains a "Demonstration version" note and copyright information.

CKEditor Web Part in demo mode in SharePoint 2010


Once you purchase a product licence and activate your copy of CKEditor for SharePoint, the copyright message will disappear.

CKEditor Web Part in licensed mode in SharePoint 2010


Modifying the CKEditor Web Part

To modify the content of the CKEditor Web Part, open the web part tool pane by clicking the "open the tool pane" link or choosing the Edit Web Part option from the drop-down menu.

Modifying the CKEditor Web Part content in SharePoint 2010


Web Part Properties

The Appearance, Layout, and Advanced options let you customize the look and feel of the CKEditor Web Part. Click the plus icon to expand a configuration category and gain access to appropriate settings.

The Appearance category lets you change the title of the web part, replacing th default CKEditor Web Part title. If the web part should have a fixed size, use the width and height settings. You can also control the chrome appearance, minimizing it or displaying without the title and/or border.

Appearance options for the CKEditor Web Part in SharePoint 2010


The Layout category lets you hide the web part, move it to a different zone, or change its position within the zone. You can also set the direction of the web part, choosing between left to right and right to left.

Layout options for the CKEditor Web Part in SharePoint 2010


The Advanced category is directed at administrators and contains various permission settings that let you control whether the user will be able to modify the web part, its display, and position. You can also change the default description of the web part, the import error message, URLs, and icons.

Advanced options for the CKEditor Web Part in SharePoint 2010


Web Part Content

When you are happy with your CKEditor Web Part customization, you can start adding content in the WYSIWYG editing area. The text entered in the editor can be formatted using all available toolbar buttons. Depending on the system settings, you might also add other content types to your web part, including images, links, emoticons, or Flash objects. When you are ready, click the OK button to save the changes.

Modifying the CKEditor Web Part content in SharePoint 2010


The CKEditor Web Part should now show the content added in the Edit Web Part window, edited and formatted in CKEditor.

CKEditor Web Part content in SharePoint 2010