Introduction to CKEditor 3.X User's Guide

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 rewritten)
Line 1: Line 1:
−
User’s Guide is a documentation which includes all necessary information about The CKEditor and its features. It is meant for all users and has been created in a simple language. The purpose of this guide is to explain how the program works and to teach about all its functions. <br>
+
{{#CUSTOMTITLE:Introduction to CKEditor 3.X User's Guide}}
 +
__TOC__
 +
The '''User's Guide''' contains information about [http://ckeditor.com CKEditor] intended for end-users. It describes all features and options available in the application and shows how to use it to change the style and layout of the document as well as add media objects like images or Flash objects.
  
−
== Navigation<br> ==
+
== Navigation ==
  
−
The guide was design in a legible way. It contains several sections which are accessible through the [[CKEditor_3.x/Users Guide|Table of Contents]].<br>
+
The User's Guide is divided into several sections accessible through the [[CKEditor 3.x/Users Guide|Table of Contents]].
  
−
Each section includes detailed explanation of CKEditor’s functions or tasks.  At the top of the page links are located. Links help to return back to the main page or to any other pages.  
+
Each section outlines a problem area and gives its detailed description. To return to the main User's Guide page or to the pages from the same section, use the breadcrumb links located at the top of the page over the page title.
  
−
Example:
+
[[Image:CKEditor_UG_breadcrumbs.png|frame|center|CKEditor User's Guide breadcrumbs navigation]]
  
−
[[Image:CKEditor_goback_example.png]]
 
  
−
Some pages were divided into subsections, which explain additional function or group of functions. All available subsections are listed at the top of all pages.<br>
+
Some User's Guide pages, like this one, may be divided into sections. If this is the case, a '''Contents''' sidebar will appear in the upper right-hand corner of the page. Clicking one of the section title links from the sidebar will lead you to an appropriate article section.
  
−
Example:
+
== Screenshots and Walkthroughs ==
  
−
[[Image:CKEditor_content_example.png]]<br>
+
Most problem areas explained in the User's Guide contain screenshots that illustrate in detail how to perform an action described in the guide. The screenshots along with walkthrough descriptions will guide you through all steps necessary to achieve the desired result.
  
−
Clicking one of the items moves the page to the related subsection.<br>
+
[[Image: CKEditor_bulletedlist_properties.png|frame|center|An example of the CKEditor screenshot]]
  
−
== Examples ==
 
  
−
This document should help every User to understand how CKEditor operates. That is why a screenshot and an example come with almost every explained function.  The examples are always placed in a framed box with the "Example:" word before it.
+
== Typographic Conventions ==
 +
Menu and option names, program commands and buttons as well as other captions from SharePoint and CKEditor that are visible on the screen are written in '''bold'''.
 +
* Example:
 +
*: The '''Upload''' tab of the '''Flash Properties''' dialog window allows you to send your own Flash objects to the server.
  
−
Example:
+
Keyboard shortcuts are written in ''italics''.
 +
* Example:
 +
*: ''Page Up'' and ''Page Down'' let you jump up and down the text.
  
−
[[Image:Example window.png|Image:Example_window.png]]
+
URLs, file names, command line commands, and program code fragments are written in <code>fixed-width font</code>.
 +
* Example:
 +
*: <code><nowiki>http://example.com/about.html</nowiki></code>
  
−
== Important Notice<br> ==
+
== Important Notices ==
 +
Additional important information is inserted into the User's Guide text with an '''<ins>Important notice</ins>''' heading. These excerpts describe problems that are essential to the understanding of the product and should not be skipped.
  
−
CKEditor is extremely configurable and its functions are customized by the developer or by the system administrator. Please notice that not all of the functions described in the User's Guide may be available at owned installation. Some of the functions may not be found in the guide due to system’s customizations.  
+
== CKEditor Configuration ==
 +
Because CKEditor is highly configurable, its features can be customized by a developer or a system administrator. This is the reason why not all of the functions described in the User's Guide may be available in your CKEditor instance.
  
−
The editor interface can be different in its colors, icons and formats as well. This guide is based on the default editor interface.
+
Also notice that CKEditor interface can be customized and displayed with a different skin &mdash; colors, icons, or size. This guide is based on the default editor interface.

Revision as of 15:00, 26 November 2010

The User's Guide contains information about CKEditor intended for end-users. It describes all features and options available in the application and shows how to use it to change the style and layout of the document as well as add media objects like images or Flash objects.

Navigation

The User's Guide is divided into several sections accessible through the Table of Contents.

Each section outlines a problem area and gives its detailed description. To return to the main User's Guide page or to the pages from the same section, use the breadcrumb links located at the top of the page over the page title.

CKEditor User's Guide breadcrumbs navigation


Some User's Guide pages, like this one, may be divided into sections. If this is the case, a Contents sidebar will appear in the upper right-hand corner of the page. Clicking one of the section title links from the sidebar will lead you to an appropriate article section.

Screenshots and Walkthroughs

Most problem areas explained in the User's Guide contain screenshots that illustrate in detail how to perform an action described in the guide. The screenshots along with walkthrough descriptions will guide you through all steps necessary to achieve the desired result.

An example of the CKEditor screenshot


Typographic Conventions

Menu and option names, program commands and buttons as well as other captions from SharePoint and CKEditor that are visible on the screen are written in bold.

  • Example:
    The Upload tab of the Flash Properties dialog window allows you to send your own Flash objects to the server.

Keyboard shortcuts are written in italics.

  • Example:
    Page Up and Page Down let you jump up and down the text.

URLs, file names, command line commands, and program code fragments are written in fixed-width font.

  • Example:
    http://example.com/about.html

Important Notices

Additional important information is inserted into the User's Guide text with an Important notice heading. These excerpts describe problems that are essential to the understanding of the product and should not be skipped.

CKEditor Configuration

Because CKEditor is highly configurable, its features can be customized by a developer or a system administrator. This is the reason why not all of the functions described in the User's Guide may be available in your CKEditor instance.

Also notice that CKEditor interface can be customized and displayed with a different skin — colors, icons, or size. This guide is based on the default editor interface.

Retrieved from "https://docs-old.ckeditor.com/index.php?title=CKEditor_3.x/Users_Guide/Introduction&oldid=5198"