(Introduction text expanded to reflect 2 new articles) |
(Important notice -> Important note) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{#CUSTOMTITLE:Introduction to CKEditor for SharePoint {{{version}}} User's Guide}} | {{#CUSTOMTITLE:Introduction to CKEditor for SharePoint {{{version}}} User's Guide}} | ||
__TOC__ | __TOC__ | ||
| − | The '''User's Guide''' contains information about [http://ckeditor.com/sharepoint CKEditor for SharePoint {{{version}}}] intended for end-users. It describes how to use CKEditor as an automatic replacement of the default SharePoint rich text editor once the [[CKEditor for SharePoint/{{{version}}}/Administrators Guide|system administrator installs and configures]] the CKEditor solution for the SharePoint {{{version}}} farm. It also shows how a user can add the CKEditor Web Part to his or her SharePoint pages | + | The '''User's Guide''' contains information about [http://ckeditor.com/sharepoint CKEditor for SharePoint {{{version}}}] intended for end-users. It describes how to use CKEditor as an automatic replacement of the default SharePoint rich text editor once the [[CKEditor for SharePoint/{{{version}}}/Administrators Guide|system administrator installs and configures]] the CKEditor solution for the SharePoint {{{version}}} farm. It also shows how a user can add the CKEditor Web Part to his or her SharePoint pages. |
To learn about CKEditor, its usage, and all features, refer to the [http://docs.cksource.com/ CKEditor User's Guide]. | To learn about CKEditor, its usage, and all features, refer to the [http://docs.cksource.com/ CKEditor User's Guide]. | ||
== Navigation == | == Navigation == | ||
| − | |||
The User's Guide is divided into several sections accessible through the [[CKEditor for SharePoint/{{{version}}}/Users Guide|Table of Contents]]. | The User's Guide is divided into several sections accessible through the [[CKEditor for SharePoint/{{{version}}}/Users Guide|Table of Contents]]. | ||
| Line 17: | Line 16: | ||
== Screenshots and Walkthroughs == | == 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 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: | ||
*: To overcome this problem you should add <code>about:blank</code> to the '''Trusted sites''' zone. | *: To overcome this problem you should add <code>about:blank</code> to the '''Trusted sites''' zone. | ||
| − | == Important | + | == 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 with an '''<ins>Important | ||
== CKEditor Configuration == | == CKEditor Configuration == | ||
| − | |||
Because both '''CKEditor for SharePoint''' and the editor itself are highly configurable products, their 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 SharePoint installation. | Because both '''CKEditor for SharePoint''' and the editor itself are highly configurable products, their 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 SharePoint installation. | ||
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 in most cases presented in a default SharePoint site theme. | 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 in most cases presented in a default SharePoint site theme. | ||
Latest revision as of 13:32, 2 December 2010
Contents
The User's Guide contains information about CKEditor for SharePoint {{{version}}} intended for end-users. It describes how to use CKEditor as an automatic replacement of the default SharePoint rich text editor once the [[CKEditor for SharePoint/{{{version}}}/Administrators Guide|system administrator installs and configures]] the CKEditor solution for the SharePoint {{{version}}} farm. It also shows how a user can add the CKEditor Web Part to his or her SharePoint pages.
To learn about CKEditor, its usage, and all features, refer to the CKEditor User's Guide.
The User's Guide is divided into several sections accessible through the [[CKEditor for SharePoint/{{{version}}}/Users Guide|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.
[[Image:CKESP{{{version}}}_UG_breadcrumbs.png|frame|center|CKEditor for SharePoint {{{version}}} 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.
[[Image:CKESP{{{version}}}_webpart03.png|frame|center|An example of the CKEditor for SharePoint {{{version}}} 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 All Web Parts list from the Add Web Parts page should contain an entry for CKEditor for SharePoint.
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:
- To overcome this problem you should add
about:blankto the Trusted sites zone.
- To overcome this problem you should add
Important Notes
Additional important information is inserted into the User's Guide text with an Important note heading. These excerpts describe problems that are essential to the understanding of the product and should not be skipped.
CKEditor Configuration
Because both CKEditor for SharePoint and the editor itself are highly configurable products, their 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 SharePoint installation.
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 in most cases presented in a default SharePoint site theme.