plugin:ckgedit
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:ckgedit [2017-11-19 02:42] – [Available Versions of ckgedit] turnermm | plugin:ckgedit [2023-07-27 16:01] (current) – [CKGEdit Plugin] turnermm | ||
---|---|---|---|
Line 3: | Line 3: | ||
---- plugin ---- | ---- plugin ---- | ||
description: | description: | ||
- | author | + | author |
email : turnermm02@shaw.ca | email : turnermm02@shaw.ca | ||
type : syntax, action | type : syntax, action | ||
- | lastupdate : 2017-10-26 | + | lastupdate : 2022-10-06 |
- | compatible : Angua,Adora Belle, Weatherwax, | + | compatible : Detritus, |
depends | depends | ||
- | conflicts | + | conflicts |
- | similar | + | similar |
tags : wysiwyg, | tags : wysiwyg, | ||
- | + | downloadurl: | |
- | downloadurl: | + | |
bugtracker : https:// | bugtracker : https:// | ||
- | sourcerepo : https:// | + | sourcerepo : https:// |
donationurl: | donationurl: | ||
screenshot_img : http:// | screenshot_img : http:// | ||
---- | ---- | ||
+ | |||
+ | ===== Version 2022-02-27 ===== | ||
+ | ==== This version adds two new features. ==== | ||
+ | - CTRL-Q will exit the editor and save any changes to the document | ||
+ | - Compatibility with [[plugin: | ||
+ | |||
+ | |||
===== Index to Ckgedit documentation on dokuwiki.org ===== | ===== Index to Ckgedit documentation on dokuwiki.org ===== | ||
** [[plugin: | ** [[plugin: | ||
+ | |||
===== About ckgedit ===== | ===== About ckgedit ===== | ||
+ | |||
Ckgedit is a graphical editor for Dokuwiki based on the open source CKEditor. | Ckgedit is a graphical editor for Dokuwiki based on the open source CKEditor. | ||
Line 29: | Line 37: | ||
- | Ckgedit is an upgrade from [[fckg|]], which uses the older FCKEditor. Much of the documentation for [[http:// | + | ===== Changelog ===== |
- | ==== History | + | |
- | The original of ckgedit was called DokuwikiFCK (about 2007) and was based on a Perl parser which converted HTML into wiki markup for a variety of wikis, including Dokuwiki. | + | |
- | In the meantime, I came across a javascript HTML parser written by John Resig (creator of jQuery) and realized I could convert html to markup in the browser. | ||
- | |||
- | ===== Changelog ===== | ||
==== Last 15 commits ==== | ==== Last 15 commits ==== | ||
- | {{rss> | + | {{rss> |
- | A more comprehensive account is included in the Changes file of the distribution. | ||
===== Installation ===== | ===== Installation ===== | ||
- | **Requires php 5.3.3 or later.** | ||
- | For the basic install use the Dokuwiki | + | For the basic install use the Dokuwiki |
- | for a manual install, follow | + | |
- | - Download the tarball, then upload it to your DokuWiki installation under the lib/plugins directory | + | This version of ckgedit uses the latest release of the CKEDitor (4.11.4). Should you experience any difficulties, |
- | - uncompress the file (e.g. tar -xzvf turn*) | + | |
- | - rename the resulting directory to ckgedit | + | |
- | - Go to your Extensions Manager interface as an admin user to confirm the plugin was installed correctly; correct any issues noted there. | + | |
- | + | ||
- | This version of ckgedit uses the latest release of the CKEDitor (4.5.7). Should you experience any difficulties, | + | |
**Issues:** You can post issues to the [[https:// | **Issues:** You can post issues to the [[https:// | ||
- | ==== Installing in an IFRAME ==== | + | |
- | See: https:// | + | |
==== File Browser ==== | ==== File Browser ==== | ||
- | When the plugin is initally installed, you will get an information message saying that a set of symbolic links have been created. | ||
- | These links are not needed on a Windows server and in some cases may fail to be created because of windows permissions. However, the .htaccess file in the data directory prevents access to your media directory . Therefore, proper security needs to be set up before you can access media files in the Windows set-up. This is also described in the [[http:// | + | When the plugin is initally installed, you will get an information message saying that a set of symbolic links have been created. |
+ | ln -s path_to/ | ||
+ | ln -s path_to/ | ||
+ | ln -s path_to/ | ||
+ | These links can be useful if, on a Windows server, you want to use the [[plugin: | ||
+ | | ||
+ | | ||
+ | | ||
+ | In all of the examples, it is assumed you are in '' | ||
+ | |||
+ | For information about creating symbolic links in Windows using the Power Shell, see \\ https:// | ||
+ | |||
+ | For a complete discussion of how to handle the security for this set-up, see the [[http:// | ||
It is possible to use the linux set-up on a windows machine by setting the [[plugin: | It is possible to use the linux set-up on a windows machine by setting the [[plugin: | ||
Line 68: | Line 74: | ||
There are extended instructions for using the file browser on the fckgLite [[http:// | There are extended instructions for using the file browser on the fckgLite [[http:// | ||
- | Many problems can be solved by using the [[plugin: | + | Many problems can be solved by using the [[plugin: |
==== ckgdoku ==== | ==== ckgdoku ==== | ||
- | [[plugin: | + | [[plugin: |
+ | </ | ||
+ | * **Note: | ||
Line 83: | Line 90: | ||
==== Reverse Proxy ==== | ==== Reverse Proxy ==== | ||
- | When dokuwiki is behind a reverse proxy, the save button does not work out of the box. Solution: inside the dokuwiki configuration set the baseurl setting to the outside url. This fixes all " | + | When dokuwiki is behind a reverse proxy, the save button does not work out of the box. Solution: inside the dokuwiki configuration set the baseurl setting to the outside url. This fixes all " |
=====Configuration and Set-up ===== | =====Configuration and Set-up ===== | ||
Line 92: | Line 99: | ||
- | === Alternate Save Directory === | + | ==== Alternate Save Directory |
- | If you set the [[: | + | In Windows systems, |
- | - You must use the '' | + | |
- | | + | |
- | < | + | |
- | ln -s / | + | |
- | ln -s / | + | |
- | ln -s / | + | |
- | </ | + | |
- | On Windows machines you can create links using '' | ||
+ | For any new save directory, | ||
- | For more information consult | + | On Windows machines you can create links using '' |
- | === CKEditor Upgrades === | + | For these to work properly for images, you have to install one of more lenient '' |
- | The current distribution of ckgedit has been upgraded from CKEditor 4.5.7 to 4.7. It had previously been upgraded from 4.01 to 4.2.2 and then to 4.4.3 and 4.5.1. | + | ==== CKEditor Upgrades |
+ | The current distribution of ckgedit has been upgraded from CKEditor 4.10 to 4.11.4. It had previously been upgraded from 4.01 to 4.2.2 and then to 4.4.3, 4.5.1 and 4.7 | ||
Line 139: | Line 140: | ||
=== Wrap Plugin === | === Wrap Plugin === | ||
- | As for the [[# | + | As for the [[# |
content: ' | content: ' | ||
boxes_title: | boxes_title: | ||
Line 151: | Line 152: | ||
;#; | ;#; | ||
when loaded into the ckgeditor it becomes: | when loaded into the ckgeditor it becomes: | ||
- | | + | |
- | To achieve the same effect when editing in the ckgeditor, you prepend the divaling2 markup elements with the '' | + | To achieve the same effect when editing in the ckgeditor, you prepend the divaling2 markup elements with the '' |
=== numbered headings === | === numbered headings === | ||
- | While the [[plugin: | + | While the [[plugin: |
==== Multi-Line Plugins ==== | ==== Multi-Line Plugins ==== | ||
Line 164: | Line 165: | ||
- | This preserves the line-breaks. | + | This preserves the line-breaks. Additional space is added below the opening tag and above the closing tag when in the editor but these are removed when saved to the file. |
- | + | ||
- | | + | === Example === |
+ | |||
+ | ~~MULTI_PLUGIN_OPEN~~ | ||
+ | < | ||
+ | user@host: | ||
+ | conf lang | ||
+ | info.txt | ||
+ | user@host: | ||
+ | | ||
+ | | ||
===== Geshi example ===== | ===== Geshi example ===== | ||
==== Geshi plugin ==== | ==== Geshi plugin ==== | ||
+ | === Basic instructions === | ||
Ckgedit includes a Geshi plugin in the CKEditor toolbar. | Ckgedit includes a Geshi plugin in the CKEditor toolbar. | ||
- | **Video:** [[http:// | + | **Video:** [[http:// |
+ | === Geshi CSS === | ||
+ | The Geshi highlighting does not appear until you reload your page. When you load the page back into the editor a basic level of highlighting will be applied to the snippet. | ||
+ | |||
+ | Remember to clear your browser cache when changing these settings. | ||
+ | === Syntax Highlighting === | ||
+ | Current versions of ckgedit support [[: | ||
+ | <code JavaScript> | ||
+ | /* [enable_line_numbers=" | ||
+ | var de = function() { | ||
+ | return (typeof(window.de) == ' | ||
+ | }(); | ||
+ | </ | ||
+ | For details on the extra highlighting features see the [[: | ||
+ | ===== Adding CKEditor plugins to the toolbar ===== | ||
+ | It is possible to add plugins to the CKEditor tool toolbar; these are defined in the configuration options as [[plugin: | ||
===== Removing a Code or File Block ===== | ===== Removing a Code or File Block ===== | ||
The code drop-down menu has a '' | The code drop-down menu has a '' | ||
Line 184: | Line 209: | ||
===== Font Styling ===== | ===== Font Styling ===== | ||
A completely revised description of the new font styling features is now on a [[: | A completely revised description of the new font styling features is now on a [[: | ||
- | If you are using font styling with tables, you must turn on the [[plugin: | + | If you are using font styling with tables, you must turn on the [[plugin: |
===== Footnotes ===== | ===== Footnotes ===== | ||
There is a footnote tool. But footnotes can still be created using the native Dokuwiki syntax, text enclosed in double parentheses: | There is a footnote tool. But footnotes can still be created using the native Dokuwiki syntax, text enclosed in double parentheses: | ||
Line 196: | Line 221: | ||
After a file has been saved, footnotes are edited in place, in the endnotes area at the bottom of the editing window. If you are section editing, edit the section in which the note appears. The notes will appear at the bottom of the editing window and you can edit them in place. The same is true if you edit the entire page. | After a file has been saved, footnotes are edited in place, in the endnotes area at the bottom of the editing window. If you are section editing, edit the section in which the note appears. The notes will appear at the bottom of the editing window and you can edit them in place. The same is true if you edit the entire page. | ||
- | To delete a footnote, you must delete the footnote both in the body of the text and in trh endnotes section at the bottom of the editing window. | + | To delete a footnote, you must delete the footnote both in the body of the text and in the endnotes section at the bottom of the editing window. |
===== Nowiki, Code, and File Singletons ===== | ===== Nowiki, Code, and File Singletons ===== | ||
When %%< | When %%< | ||
Line 209: | Line 234: | ||
< | < | ||
===== HTML BLOCKS ===== | ===== HTML BLOCKS ===== | ||
- | **Note:** This feature requires that either Dokuwiki' | + | **Note:** This feature requires that either Dokuwiki' |
Feature added 22 Apr 2015. | Feature added 22 Apr 2015. | ||
Line 220: | Line 245: | ||
It could be useful, for instance, to save a complex table that does not parse correctly, despite use of the complex tables setting. | It could be useful, for instance, to save a complex table that does not parse correctly, despite use of the complex tables setting. | ||
- | {{ | + | {{ |
When the html block is loaded back into the editor, it can be edited normally and re-saved with the changes. | When the html block is loaded back into the editor, it can be edited normally and re-saved with the changes. | ||
Line 235: | Line 260: | ||
~~CLOSE_HTML_BLOCK~~ | ~~CLOSE_HTML_BLOCK~~ | ||
</ | </ | ||
- | In this case, when you reload the ckgeditor, you will see only the Start and Close macros, but the html will still be there, as you can see if you use the '' | + | In this case, when you reload the ckgeditor, you will see only the Start and Close macros, but the html will still be there, as you can see if you use the '' |
When an HTML Block is processed by the ckgeditor and saved to the Doukwiki file, it is saved as a code block containing the HTML. When loaded back into the editor, the HTML is extracted from the code block and inserted back into the editor. | When an HTML Block is processed by the ckgeditor and saved to the Doukwiki file, it is saved as a code block containing the HTML. When loaded back into the editor, the HTML is extracted from the code block and inserted back into the editor. | ||
Line 263: | Line 288: | ||
The toolbar is defined in ckeditor/ | The toolbar is defined in ckeditor/ | ||
- | There are three toolbars and each can be changed. | + | There are three toolbars and each can be changed. |
=== Adding Plugins === | === Adding Plugins === | ||
Additional plugins (or '' | Additional plugins (or '' | ||
+ | === The Blockquote toolbar Button === | ||
+ | The Blockquote button has recently been added to the standard toolbar. In the editor, its CSS is controlled by the additional.css file. ((See the [[# | ||
===== Image Drag and Drop ===== | ===== Image Drag and Drop ===== | ||
- | In some browsers, images can be dragged into the editor from the desktop. | + | <del>In some browsers, images can be dragged into the editor from the desktop.</ |
- | See [[plugin: | + | This is no longer available (see [[plugin: |
===== Copy and Paste ===== | ===== Copy and Paste ===== | ||
Line 277: | Line 304: | ||
or | or | ||
Turn supplementary image paste support off | Turn supplementary image paste support off | ||
- | The supplementary paste support enables image pastes in browsers which don't enable it natively, Chrome is one of these. In others, like Firefox, when the additional paste support is turned on two copies of the image are pasted into the editor window, one by the browser itself and the other by the supplementary paste support. Therefore in Firefox it should be turned off and in Chrome turned on. | + | The supplementary paste support enables image pastes in browsers which don't enable it natively, Chrome is one of these. In others, like Firefox, when the additional paste support is turned on two copies of the image are pasted into the editor window, one by the browser itself and the other by the supplementary paste support. Therefore in Firefox it should be turned off and in Chrome turned on. It defaults to off. |
- | | + | ==== Limitations and Workarounds ==== |
+ | === Copying === | ||
+ | You may have to load the image into software which allows for the copying of image data, for instance Windows 10 '' | ||
+ | === Size === | ||
+ | There is a limit to how much raw image data can be pasted directly into the editor. | ||
+ | |||
+ | It is possible to handle images of 2 - 2.5 MB in Firefox using the MS Word plugin. | ||
+ | |||
+ | |||
+ | |||
==== Microsoft Office ==== | ==== Microsoft Office ==== | ||
Documents can be pasted from Office using Ctrl-V, but in complex cases, such as tables, [[# | Documents can be pasted from Office using Ctrl-V, but in complex cases, such as tables, [[# | ||
+ | === New Plugin === | ||
+ | There is now a new plugin for inserting Office documents. | ||
===== Smileys ===== | ===== Smileys ===== | ||
The Ckeditor comes with its own collection of smileys. | The Ckeditor comes with its own collection of smileys. | ||
Line 296: | Line 335: | ||
To use relative links for both internal links and media links , the ckgedit relative links configuration option must be set to true. See: [[plugin: | To use relative links for both internal links and media links , the ckgedit relative links configuration option must be set to true. See: [[plugin: | ||
- | + | ===== RSS Feeds ===== | |
+ | You can enter the Dokuwiki RSS feed markup directly into ckgedit' | ||
+ | However, on being reloaded into ckgedit' | ||
+ | {{rss> | ||
+ | will become this: | ||
+ | { { rss> | ||
+ | On being saved it will revert to the original Dokuwiki markup. Secure '' | ||
===== Examples ===== | ===== Examples ===== | ||
For some examples of using plugins with ckgedit and of some other features, such as line spacing, see: | For some examples of using plugins with ckgedit and of some other features, such as line spacing, see: | ||
Line 303: | Line 347: | ||
* [[http:// | * [[http:// | ||
- | ===== Language Support ===== | + | |
+ | ===== Language Support, Localization | ||
==== Filebrowser ==== | ==== Filebrowser ==== | ||
Line 313: | Line 358: | ||
==== Plugins ==== | ==== Plugins ==== | ||
- | There are also several plugins which have been written for ckgedit, such as the Font Assist plugin described above. The language template for these is also ckgedit/ | + | There are also several plugins which have been written for ckgedit. |
+ | |||
+ | === Older Style == | ||
+ | The plugins using this style are: fontassist, footnote, and signature. | ||
* '' | * '' | ||
+ | |||
+ | === Current Style === | ||
+ | This style is used by wrap, headerbuttons, | ||
+ | |||
+ | In the plugin directory for these you will find a '' | ||
+ | < | ||
+ | CKEDITOR.plugins.add( ' | ||
+ | lang: ' | ||
+ | </ | ||
+ | Add your ISO code and a comma, e.g.: ' | ||
===== Compression ===== | ===== Compression ===== | ||
- | The '' | + | The '' |
===== Editor Window Height ===== | ===== Editor Window Height ===== | ||
The height of the editor window can be set by entering a new value in the '' | The height of the editor window can be set by entering a new value in the '' | ||
- | {{ http:// | + | {{ http:// |
The new height will take effect when the editor is reloaded. | The new height will take effect when the editor is reloaded. | ||
+ | ===== Style Sheets for the CKEditor editing window ===== | ||
+ | Ckgedit comes with a default css scipt for the editing window. | ||
+ | ==== CKEditor editor CSS tool ==== | ||
+ | |||
+ | If you would like the styling of the editing window to match that of your template, you can create a template-specific css file that will be used instead of contents.css. | ||
+ | === additional.css === | ||
+ | To make modifications to your css, you can add rules to a file named '' | ||
===== Short-cut keys ===== | ===== Short-cut keys ===== | ||
- | | CTRL + I |italic| | + | | CTRL + I |
- | | CTRL + B |bold| | + | | CTRL + B |
- | | CTRL + U |underline| | + | | CTRL + U | underline |
- | | CTRL + Z |undo| | + | | CTRL + Z |
- | | CTRL + Y |redo| | + | | CTRL + Y |
- | | CTRL + L |link| | + | | CTRL + L |
- | | ALT + - | + | | ALT + - | numbered list |
- | | ALT + 8 |bulleted list| | + | | ALT + 8 | bulleted list |
- | | ALT + * |bulleted list| | + | | ALT + * | bulleted list |
- | | ALT + m |code| | + | | ALT + m | code | |
+ | | CTRL+Q | ||
The short-cut keys for inserting headers were changed form ALT+n to CTRL+n on 8/30/2013 in order to avoid conflicts with keyboards that use AltGR. | The short-cut keys for inserting headers were changed form ALT+n to CTRL+n on 8/30/2013 in order to avoid conflicts with keyboards that use AltGR. | ||
Line 354: | Line 420: | ||
With this method, the user clicks in the browser and the Dokuwiki Editor opens, loading the section of the page beneath the mouse pointer, just as it would if the section edit button were clicked. | With this method, the user clicks in the browser and the Dokuwiki Editor opens, loading the section of the page beneath the mouse pointer, just as it would if the section edit button were clicked. | ||
- | You may initially have to clear both the browser cache and your Dokuwiki cache. See: [[devel: | + | You may initially have to clear both the browser cache and your Dokuwiki cache. See: [[devel: |
If you do not want this feature, you can turn it off in the Configuration Manager. | If you do not want this feature, you can turn it off in the Configuration Manager. | ||
==== Page Tools Method ==== | ==== Page Tools Method ==== | ||
- | There is a small plugin that gives immediate direct access to the Dokuwiki editor from the Dokuwiki template' | + | The [[plugin: |
- | tpl_toolsevent(' | + | |
- | + | ||
===== Dokuwiki Entities with left-hand angle brackets ===== | ===== Dokuwiki Entities with left-hand angle brackets ===== | ||
Line 368: | Line 434: | ||
See more examples [[http:// | See more examples [[http:// | ||
===== Farms ===== | ===== Farms ===== | ||
- | There is a [[https:// | + | Up until November 28 2017, farms required |
- | and more detail can be found at [[tips: | + | |
Line 426: | Line 491: | ||
'' | '' | ||
==== Using the farmer plugin ==== | ==== Using the farmer plugin ==== | ||
- | The [[plugin: | + | <del>The [[plugin: |
+ | </ | ||
+ | ckgdoku is no longer supported; its functionality has been integrated into ckgedit. | ||
===== Video Clips ===== | ===== Video Clips ===== | ||
You can view various demonstrations on YouTube of how to use ckgedit:\\ | You can view various demonstrations on YouTube of how to use ckgedit:\\ | ||
Line 437: | Line 504: | ||
- | ===== Available Versions of ckgedit ===== | + | |
- | ^ Distribution | + | |
- | | [[https:// | + | |
- | | [[http:// | + | |
- | | [[https:// | + | |
- | | [[https:// | + | |
- | | [[https:// | + | |
===== Discussion ===== | ===== Discussion ===== | ||
**Note:** For all future discussion, please use the [[https:// | **Note:** For all future discussion, please use the [[https:// | ||
Line 467: | Line 529: | ||
[[plugin: | [[plugin: | ||
- Unwanted code replacement | - Unwanted code replacement | ||
- | - blank page while click "Broswe | + | - blank page while click "Browse |
- ckgedit for monobook and vector templates (skins) | - ckgedit for monobook and vector templates (skins) | ||
- Importing Documents | - Importing Documents |
plugin/ckgedit.1511055744.txt.gz · Last modified: 2017-11-19 02:42 by turnermm