Plug-in Guidelines

This documentation is designed to help you seamlessly integrate and customize the Rich Text Editor Pro in your Oracle APEX applications. Whether you are installing the plug-in, implementing advanced features, or customizing the user interface, this guide provides step-by-step instructions and detailed information to assist you every step of the way. Explore the sections below to get started and make the most out of your Rich Text Editor Pro experience.

Download

The download section provides detailed, step-by-step instructions for accessing the Rich Text Editor Pro through the Plug-ins Pro portal. It also outlines the contents of the zip archive you will receive upon download.

topics

• Download instructions
• Download contents

Installation

The installation section provides comprehensive instructions on how to install the Rich Text Editor Pro plug-in in an APEX schema using various methods. It ensures a smooth setup process tailored to different Oracle APEX versions and configurations.

topics

• Introduction
• Install using manual (DDL Script)
• Install using sample application for Oracle APEX 19.2+
• Install using sample application for Oracle APEX 22.2+
• License activation
• Set Salt String

Implementation

The implementation guidelines provide detailed instructions for integrating the Rich Text Editor Pro into Oracle APEX applications. This includes scenarios where CLOB values are not natively supported, as well as leveraging native APEX features when CLOB support is available. These guidelines ensure you can effectively use the Rich Text Editor Pro regardless of your APEX version.

Oracle APEX 19.2 onwards

For Oracle APEX 19.2 and above, these guidelines cover methods to implement the Rich Text Editor Pro in environments where CLOB support is not native. You'll find instructions on utilizing the plug-in's PL/SQL API, configuring native form components with the supporting process plug-in, and more.

topics

• Prerequisites
• Using the plug-in PL/SQL API only
• Using native form component and supporting process plug-in
• Using the supporting process plug-in only

Oracle APEX 22.2 onwards

For Oracle APEX 22.2 and above, these guidelines focus on leveraging the native CLOB support available in the platform. You’ll find instructions on using the native APEX form component and the native APEX PL/SQL API to integrate the Rich Text Editor Pro seamlessly into your applications.

topics

• Prerequisites
• Using native APEX form component
• Using native APEX PL/SQL API

Third-party integrations

The plug-in can be integrated with third-party tools enhancing end-user experience when working with rich text documents.

topics

• In-Document Image Editing using TOAST UI Image Editor
• Track Changes
• Write Math and Chemistry formulas using Wiris MathType
• Advanced Spell Check using WProofreader Text Checker
• Real Time Colaboration using Codox.io

Customizations

The customization guidelines provide comprehensive instructions for tailoring the Rich Text Editor Pro to meet specific requirements. This includes JavaScript options for customizing the toolbar, image settings, the plug-in upload workflow and creating a custom RESTful service.

Toolbar

Detailed instructions on customizing the toolbar, including defining custom buttons, responsive layouts, and various text formatting options.

topics

• Index of toolbar related JavaScript options
• Define custom toolbar buttons and responsive layout using JavaScript code
• Define custom toolbar buttons and responsive layout using PL/SQL code
• Explore example toolbar layouts with sample JavaScript code
• Customize emoticons available to the end-user
• Customize Font Awesome icons available to the end-user
• Customize link related features
• Customize special characters available to the end-user
• Customize table related features
• Customize font family, font size, styles and colors for text
• Customize paragraph formats, styles and line height
• Customize toolbar settings and help dialog shortcuts

Images

Guidelines for customizing various image-related settings and functionalities, including context menus, validation, and RESTful service parameters.

topics

• Index of image related JavaScript options
• Customize image settings
• Customize image context menu
• Customize RESTful service query parameters for uploaded image
• Customize RESTful service query parameters for image browser
• Customize RESTful service query parameters for delete requests
• Customize image validation before uploading an image

Upload Workflow

Instructions for configuring the plug-in's upload and update workflow to enhance the end-user experience when uploading images and saving rich text documents.

topics

• Configure the plug-in upload and update workflow to assist end-user when saving a document

RESTful Service

Guidelines for creating and managing RESTful services related to image handling, including uploading, displaying, browsing, and deleting images.

topics

• Introduction
• Create POST handler uploading images
• Create GET handler displaying an uploaded image
• Create GET handler browsing uploaded images
• Create POST handler deleting an image using image browser