[Rt-commit] rt branch 5.0/add-ckeditor-build-instructions created. rt-5.0.3-225-g065e4b9ddc

[BPS Git Server]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "rt".

The branch, 5.0/add-ckeditor-build-instructions has been created
        at  065e4b9ddc52d787beeffd1b0a135b67f515a07d (commit)

- Log -----------------------------------------------------------------
commit 065e4b9ddc52d787beeffd1b0a135b67f515a07d
Author: Jason Crome <jcrome at bestpractical.com>
Date:   Wed Jan 11 09:21:22 2023 -0500

    Add build instructions for CKEditor 4

diff --git a/devel/third-party/ckeditor-4.20.1/README b/devel/third-party/ckeditor-4.20.1/README
new file mode 100644
index 0000000000..a567b57817
--- /dev/null
+++ b/devel/third-party/ckeditor-4.20.1/README
@@ -0,0 +1,48 @@
+RT uses CKEditor as its WYSIWYG text editor. We build a customized download, then further customize it to get RT what it needs. This README explains how to get the right version of CKEditor and prepare it for use by RT.
+
+1. Download CKEditor 4: https://ckeditor.com/cke4/builder
+
+    * Click the "Upload build-config.js" button
+    * Upload the build-config.js file found in devel/third-party/ckeditor-4.20.1 (or whatever version happens to be in devel/third-party/)
+    * Check the "I agree..." checkbox at the bottom of the page
+    * Click the "Download CKEditor..." button.
+
+2. Install the updated version
+
+    * Copy share/static/RichText/config.js from 5.0-trunk branch in RT to a temporary location. You'll need it later.
+    * Unzip the CKEditor archive you downloaded
+    * Remove SECURITY.md and bender-runner.config.json from the extracted zip directory
+    * mkdir devel/third-party/ckeditor-4.xx.xx
+    * Copy README.md, LICENSE.md, CHANGES.md, build-config.js from the zip directory to devel/third-party/ckeditor-4.xx.xx
+    * Copy the remainder of the zip contents to share/static/RichText/
+    * Remove the old version of CKEditor from devel/third-party/:
+
+      $ rm -rf devel/third-party/ckeditor-4.20.1 # or whatever the version in devel/third-party/ happens to be
+
+3. Further customization
+
+    * Remove the pbckcode plugin:
+
+      $ rm -rf share/static/RichText/plugins/pbckcode
+
+    * Update content.css via the following patch:
+
+--- share/static/RichText/contents.css	2022-12-23 13:19:13.000000000 -0600
++++ /Users/jason/Downloads/contents.css	2022-12-29 09:42:05.000000000 -0600
+@@ -14,7 +14,7 @@
+ 	color: #333;
+ 
+ 	/* Remove the background color to make it transparent. */
+-	background-color: #fff;
++	background-color: transparent;
+ 
+ 	margin: 20px;
+ }
+
+    * Copy the config.js you saved off to a temporary location to share/static/RichText/. Update copyright if necessary.
+    * Update CKEditor version in devel/third-party/README
+    * Remove samples and docs:
+
+      $ rm -rf skins/bootstrapck/sample
+      $ rm -rf plugins/confighelper/docs/
+      $ rm -rf plugins/ccmsconfighelper/docs

-----------------------------------------------------------------------


hooks/post-receive
-- 
rt