CKEditor 3.x/Users Guide/Introduction - Revision history

Anna: Minor rewording

2010-12-13T07:43:28Z

Minor rewording

Anna: Important note added, minor rewriting

2010-12-13T07:20:28Z

Important note added, minor rewriting

Anna: About CKEditor information added

2010-12-03T12:40:54Z

About CKEditor information added

Anna: Important notice -> Important note

2010-12-02T12:33:57Z

Important notice -> Important note

Anna: Important notice -> Important note

2010-12-02T11:48:19Z

Important notice -> Important note

Anna: moved CKEditor 3.x/Users Guide/Introduction to the User's Guide to CKEditor 3.x/Users Guide/Introduction: Link shortening

2010-12-01T14:48:23Z

moved CKEditor 3.x/Users Guide/Introduction to the User's Guide to CKEditor 3.x/Users Guide/Introduction: Link shortening

Anna: Article rewritten

2010-11-26T14:00:46Z

Article rewritten

Magdalena.stachnik at 05:15, 13 September 2010

2010-09-13T05:15:43Z

Magdalena.stachnik at 14:40, 31 August 2010

2010-08-31T14:40:29Z

Magdalena.stachnik at 12:06, 30 August 2010

2010-08-30T12:06:32Z

← Older revision		Revision as of 07:43, 13 December 2010
Line 16:		Line 16:
	Most problem areas explained in the User's Guide include 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.		Most problem areas explained in the User's Guide include 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.

−	[[Image: CKEditor_bulletedlist_properties.png\|frame\|center\|An example of ~~the~~ CKEditor screenshot]]	+	[[Image: CKEditor_bulletedlist_properties.png\|frame\|center\|An example of a CKEditor screenshot]]

@@ Line 11: / Line 11: @@
-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.
+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 a selected 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.
+Most problem areas explained in the User's Guide include 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.
 [[Image: CKEditor_bulletedlist_properties.png|frame|center|An example of the CKEditor screenshot]]
@@ Line 20: / Line 20: @@
 == 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'''.
+Menu and option names, program commands and buttons as well as other captions from 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.
@@ Line 33: / Line 33: @@
 == Important Notes ==
-Additional important information is inserted into the User's Guide text with an '''<ins>Important note</ins>''' heading. These excerpts describe problems that are essential to the understanding of the product and should not be skipped.
+Additional important information is inserted into the User's Guide text as a note displayed with a gray background and a blue exclamation mark icon.
 == CKEditor Version ==
 Latest CKEditor is always greatest CKEditor. We are continuously improving our product, adding new features and fixing bugs that inevitably appear from time to time. This documentation covers CKEditor 3.X, in its latest version. If you find that some features do not work as described, please check what version of CKEditor you are using.
-To check the CKEditor version, press the [[File:CKEditor_about.png|About CKEditor]] toolbar button. The '''About CKEditor''' dialog window that will open displays the version information along with the revision number, the product website, the licensing link and the copyright notice.
+To check the CKEditor version, press the [[File:CKEditor_about.png|About CKEditor]] toolbar button. The '''About CKEditor''' dialog window that will open displays version information along with revision number, product website, licensing link and copyright notice.
 [[Image: CKEditor_about_popup.png|frame|center|About CKEditor dialog window]]
@@ Line 46: / Line 49: @@
 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 &mdash; colors, icons, or size. This guide is based on the default editor interface.
+Also note 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 that can also be seen on the [http://ckeditor.com/demo demo] site.

@@ Line 4: / Line 4: @@
 == Navigation ==
 The User's Guide is divided into several sections accessible through the [[CKEditor 3.x/Users Guide|Table of Contents]].
@@ Line 15: / Line 14: @@
 == 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.
@@ Line 36: / Line 34: @@
 == Important Notes ==
 Additional important information is inserted into the User's Guide text with an '''<ins>Important note</ins>''' heading. These excerpts describe problems that are essential to the understanding of the product and should not be skipped.
 == CKEditor Configuration ==

@@ Line 34: / Line 34: @@
 *: <code><nowiki>http://example.com/about.html</nowiki></code>
-== Important Notices ==
+== Important Notes ==
 Additional important information is inserted into the User's Guide text with an '''<ins>Important note</ins>''' heading. These excerpts describe problems that are essential to the understanding of the product and should not be skipped.

@@ Line 35: / Line 35: @@
 == 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.
+Additional important information is inserted into the User's Guide text with an '''<ins>Important note</ins>''' heading. These excerpts describe problems that are essential to the understanding of the product and should not be skipped.
 == CKEditor Configuration ==

← Older revision	Revision as of 14:48, 1 December 2010
(No difference)

@@ 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}}
-== 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]]
-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]]
-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 ==
-Example:
+Keyboard shortcuts are written in ''italics''.
-[[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>.
-== Important Notice<br> ==
+== Important Notices ==
-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 ==
-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.

@@ Line 1: / Line 1: @@
-The '''User's Guide''' is a documentation regarding to all the features of CKEditor. It explains how the program works and gives an opportunity to learn about all its functions.<br>
+The '''User's Guide''' is a documentation regarding all the features of CKEditor. It explains how the program works and gives an opportunity to learn about all its functions.<br>
 == Navigation<br> ==
@@ Line 5: / Line 5: @@
 The guide is divided into several sections, mainly accessible through the [[CKEditor_3.x/Users Guide|Table of Contents]].<br>
-Each section represents a group of functions or tasks and their detailed explanation. You can always return back to the main page or to the pages categorized in the same section by using the links situated at the top of the page.
+Each section represents a group of functions or tasks and their detailed explanation. By using the links situated at the top of the page User can easily return back to the main page or to the page.
 Example:
@@ Line 21: / Line 21: @@
 == Examples ==
-Every function explained in the guide usually comes with a screenshot and an example. The examples are always placed in a framed box with the "Example:" word before it.
+Every function explained in the guide usually includes a screenshot and an example. The examples are always placed in a framed box with the "Example:" word before it.
 Example:
@@ Line 31: / Line 31: @@
 Because CKEditor is extremelly configurable and its functions are customized by the developer or system administrator, not all of the functions explained in the User's Guide may be available at your installation. Other functions may not be found in the guide due to your system customizations.
-Also have notice that the editor interface can be different in its colors, icons and formats. This guide is based on the default editor interface.'''<br>'''
+Have notice that the editor interface can be different in its colors, icons and formats as well. This guide is based on the default editor interface.'''<br>'''