The CKEditor

Introduction

The CKEditor is an HTML editor for inserting text into text areas in BrassRing. HTML is a markup language that makes it possible to display content in a web page. The markup language consists of tags that signify the structure of the document (paragraph, heading, bulleted list, and numbered list) and some formatting options (bold, italic, underline; font face, size, and color, and so forth). The HTML tags tell the browser This is a paragraph or This is a level 1 heading, or this word is underlined. It is necessary to use an HTML editor for any type of content that is meant to be displayed online, such as emails and job postings. The CKEditor has an extensive toolbar for the formatting and handling of HTML pages. It produces structurally clean HTML tags, which are important for displaying HTML pages correctly in different browsers. It also supports several languages and spell check utilities.

The formatting toolbar of an HTML editor is limited relative to a sophisticated word-processing program such as Microsoft Word. Nonetheless, the CKEditor has an expanded formatting toolbar that is compared to the older editors, making it easier to create good-looking, well-formatted content.

In Build 20.07.28 the CKEditor is enabled for all clients. This change happened automatically for all clients that are not using the CK editor. No action is needed from clients to update existing content that was created using the legacy editor.

The default text and formats cannot be changed in the CKEditor. The default formatting can be overridden by using HTML for text that is sent through an integration into a req field.

The CK Editor pages

In BrassRing, the CKEditor appears on the pages:

Add blurb | Edit blurb
Add communications template | Edit communications template | Send communication (email).
Add document template | Edit document template | Create document.
Add document packet template | Edit document packet template | Send communication(document packet).
Add system email template | Edit system email template.
Formatting-enabled requisition fields: Job Description, Requisition Notes, and custom text area fields on pages where reqs are added or edited.

Browser differences in rendering HTML content: Browsers have become more compliant with standards that are developed by the World Wide Web Consortium (W3), which means that content is displayed more consistently across browser types. Nonetheless, each browser type and version makes default assumptions about displaying content with HTML tags. This might result in one browser displaying content marked up in a particular set of HTML tags a little differently than another browser. For example, one browser might include more white space between paragraphs than another browser does. In addition, users viewing content that you have created can personalize their browser settings and substitute their own font faces, sizes, and colors. Therefore, the control over the look of content that is viewed in a browser is limited. The best you can do is to create well-structured HTML that should be rendered in an acceptable manner in any browser.

Best Practices

When using the CKEditor for document templates, it is recommended to upload images into the document templates. If users do not follow this recommendation, when the document template is moved from one environment to another, the images do not display properly.
In the Send Communication workflow, if an administrator is creating, adding, or editing a communication template and adds candidate forms to the template, the candidate forms display as hyperlinks. It is imperative that NO formatting is added to the candidate form links. If any formatting is added to the candidate forms hyperlinks, the hyperlinks become inoperable.
When pasting text from Microsoft Word into the CKEditor, it is recommended that users paste the text into a text editor such as Notepad before pasting the text into the CKEditor. Pasting the text into Notepad, or an application like Notepad, removes any non-visible formatting elements and ensures a cleaner text entry in the CKEditor.