DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:ckgedit

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:ckgedit [2020-07-28 03:13] – [CKGEdit Plugin] turnermmplugin:ckgedit [2023-07-27 16:01] (current) – [CKGEdit Plugin] turnermm
Line 3: Line 3:
 ---- plugin ---- ---- plugin ----
 description: WYSIWYG editor based on the CKEditor description: WYSIWYG editor based on the CKEditor
-author     :  Myron Turner+author     : Myron Turner
 email      : turnermm02@shaw.ca email      : turnermm02@shaw.ca
 type       : syntax, action type       : syntax, action
-lastupdate :  2020-07-27 +lastupdate : 2022-10-06 
-compatible : Angua,Adora Belle, Weatherwax,Binky,Ponder Stibbons, Hrun, Detritus,Elenor of Tsort,Frusterick Manners,Greebo, Hogfather+compatible :  Detritus,Elenor of Tsort,Frusterick Manners,Greebo,Hogfather,Igor,Jack Jackrum
 depends    :  depends    : 
-conflicts  : creole, quickedit, yalist, tagentry, codemirror,fckg, numberedheadings,xbr,struct +conflicts  : creole, quickedit, yalist, tagentry, codemirror,fckg, numberedheadings, xbr, struct 
-similar    : ckgdoku +similar    :  
-tags       : wysiwyg,editor,editing, drag-and-drop +tags       : wysiwyg,editor,editing 
-downloadurl: https://github.com/turnermm/ckgedit/archive/hogfather-merged.zip+downloadurl: https://github.com/turnermm/ckgedit/archive/current.zip
 bugtracker : https://github.com/turnermm/ckgedit/issues bugtracker : https://github.com/turnermm/ckgedit/issues
 sourcerepo : https://github.com/turnermm/ckgedit sourcerepo : https://github.com/turnermm/ckgedit
Line 19: Line 19:
 screenshot_img : http://i.imgur.com/VtI6chK.png   screenshot_img : http://i.imgur.com/VtI6chK.png  
 ---- ----
 +
 +===== 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:imgpaste]].  Pasting images into the editor using CTRL+C/CTR+V will use the [[plugin:imgpaste]] ''filename'' setting. This feature is set to true by default but can be turned off in the Configuration Settings. The native ckgedit naming of images creates a name from the current namespace and the md5 hash of the image data.
 + 
  
 ===== Index to Ckgedit documentation on dokuwiki.org ===== ===== Index to Ckgedit documentation on dokuwiki.org =====
  
 ** [[plugin:ckgedit:index|Index to the complete ckgedit documentation on dokuwiki.org]] ** ** [[plugin:ckgedit:index|Index to the complete ckgedit documentation on dokuwiki.org]] **
 +
 ===== About ckgedit ===== ===== About ckgedit =====
 +
 Ckgedit is a graphical editor for Dokuwiki based on the open source CKEditor.  The ckgedit plugin supports the basic dokuwiki feature set; the only thing in ckgedit that is not part of that feature set is font styling, which is implemented by means of a dokuwiki plugin that is given special status in the ckgedit pre-processor.  Ckgedit is a graphical editor for Dokuwiki based on the open source CKEditor.  The ckgedit plugin supports the basic dokuwiki feature set; the only thing in ckgedit that is not part of that feature set is font styling, which is implemented by means of a dokuwiki plugin that is given special status in the ckgedit pre-processor. 
  
Line 29: Line 37:
  
  
 +===== 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.  There was another plugin ([[plugin:fckw|]]) which had already integrated FCKEditor into the browser and was using the Perl back-end.  For a while I  worked with that.   
- 
-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.  That became [[plugin:fckg|fckgLite]], which is still around and in use, but no longer being maintained.  Eventually FCKEditor was upgraded to [[http://ckeditor.com/|CKEDitor]] and [[plugin:fckg|fckgLite]] was replaced by ckgedit. 
- 
-===== Changelog ===== 
 ==== Last 15 commits ==== ==== Last 15 commits ====
  
-{{rss>https://github.com/turnermm/ckgedit/commits/master.atom date count=15}}+{{rss>https://github.com/turnermm/ckgedit/commits/current.atom date count=15}}
  
  
 ===== Installation ===== ===== Installation =====
  
-For the basic install use the Dokuwiki [[plugin:extension|Extension Manager]]. This should work without incident. If not, then for a manual install, follow the instructions at [[:plugin_installation_instructions#manual_instructions|Plugin Installation Instructions]].+For the basic install use the Dokuwiki [[plugin:extension|Extension Manager]]. This should work without incident. If not, then for a manual install, follow the instructions at [[:plugin_installation_instructions]].
  
  
Line 52: Line 55:
  
 ==== 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 point to the Dokuwiki ''data/media'' directory from ''ckgedit/fckeditor/userfiles''. It is by means of these links that the file browser accesses the media directory. Three links are required: ''media'', ''file'', and ''image''. If they fail to be installed,  you can create them yourself using the unix ''ln'' command. When the plugin is initally installed, you will get an information message saying that a set of symbolic links have been created.  These links point to the Dokuwiki ''data/media'' directory from ''ckgedit/fckeditor/userfiles''. It is by means of these links that the file browser accesses the media directory. Three links are required: ''media'', ''file'', and ''image''. If they fail to be installed,  you can create them yourself using the unix ''ln'' command.
    ln -s path_to/data/media media    ln -s path_to/data/media media
Line 61: Line 65:
    mklink /D image path_to\data\media       mklink /D image path_to\data\media   
 In all of the examples, it is assumed you are in ''fckeditor/userfiles'', otherwise you will have to specify the path to ''userfiles'' In all of the examples, it is assumed you are in ''fckeditor/userfiles'', otherwise you will have to specify the path to ''userfiles''
 +
 +For information about creating symbolic links in Windows using the Power Shell, see \\ https://github.com/turnermm/ckgedit/issues/550
  
 For a complete discussion of how to handle the security for this set-up, see the [[http://www.mturner.org/fckgLite/doku.php/media#security_and_the_media_directory|instructions]] on the fckgLite web site. 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://www.mturner.org/fckgLite/doku.php/media#security_and_the_media_directory|instructions]] on how to handle the media directory. For a complete discussion of how to handle the security for this set-up, see the [[http://www.mturner.org/fckgLite/doku.php/media#security_and_the_media_directory|instructions]] on the fckgLite web site. 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://www.mturner.org/fckgLite/doku.php/media#security_and_the_media_directory|instructions]] on how to handle the media directory.
Line 68: Line 74:
 There are extended instructions for  using the file browser on the fckgLite [[http://www.mturner.org/fckgLite/doku.php/media|web site]].  See also [[http://www.mturner.org/fckgLite/doku.php/file_browser_install#using_fckeditor_userfiles|using_fckeditor_userfiles]] There are extended instructions for  using the file browser on the fckgLite [[http://www.mturner.org/fckgLite/doku.php/media|web site]].  See also [[http://www.mturner.org/fckgLite/doku.php/file_browser_install#using_fckeditor_userfiles|using_fckeditor_userfiles]]
  
-Many  problems can be solved by using the [[plugin:ckgedit:configuration#winstyle|winstyle configuration option]] or by using the [[#ckgdoku]] distribution described below.+Many  problems can be solved by using the [[plugin:ckgedit:configuration#winstyle|winstyle configuration option]].
  
 ==== ckgdoku ==== ==== ckgdoku ====
Line 93: Line 99:
  
  
-=== Alternate Save Directory === +==== Alternate Save Directory ==== 
-If you set the [[:config:savedir|]] option to directory other than the default, there are two things that must be done: +In Windows systems, you may be able to use an alternate save directory without the following steps. But you should create the alternate directory relative to the wiki and use relative syntaxe.g. .''./../alternate-directory'', rather than using an absolute path. Additionally,ckgedit doesn't understand Windows drive syntax, i.e. C:\, D:\, etc. So, your alternate ''savedir'' on Windows servers must be on the same drive as your dokuwiki
-  - You must use the ''nix'' settingsthat is you cannot use the [[http://www.mturner.org/fckgLite/doku.php?id=configuration#conf_24|winstyle]] option if you are on a linux machine, and you must use the [[http://www.mturner.org/fckgLite/doku.php?id=configuration#conf_15|nix_style]] option if you are on a windows machine. +
-  The ''nix'' setup requires a set of symbolic links in fckeditor/userfiles which point to the media directory of the ''savedir'' directory.  The links should automatically be created when ckgedit is installed. If they are not correct, they must be changed.  You **must** make sure that the symbolic links point to your media directoryOn linux machine you use the ''ln -s'' command to make symbolic links:  +
-<code>  +
- ln -s /path/to/savedir/media file +
- ln -s /path/to/savedir/media image  +
- ln -s /path/to/savedir/media media +
-</code>+
  
-On Windows machines you can create links using ''mklink /D'' in the command window:  <code>mklink /D "C:\apache\htdocs\dokuwiki\lib\plugins\ckgedit\fckeditor\userfiles\image"  "C:\dokuwiki\data\media"</code> 
  
 +For any new save directory,and for Windows servers using the ''nix'' setting, follow the guidelines above in the [[#installation]] section. That is you must have ''image'' and ''file'' links in ''fckeditor/userfiles'' which point to the media directory. 
  
-For more information consult the fckgLite documentationhttp://www.mturner.org/fckgLite/doku.php?id=docs:auto_install&#background.+On Windows machines you can create links using ''mklink /D'' in the command window <code>mklink /D "C:\apache\htdocs\dokuwiki\lib\plugins\ckgedit\fckeditor\userfiles\image"  "C:\dokuwiki\data\media"</code>
  
  
-=== CKEditor Upgrades ===+For these to work properly for images, you have to install one of more lenient ''.htaccess'' files in the media directory, which you will find in the ''fckeditor/userfiles'' directory.  The one called ''.htaccess/security'' will allow most images through.   
 +==== 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   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 234: Line 234:
    <nowiki>%%</nowiki>    <nowiki>%%</nowiki>
 ===== HTML BLOCKS ===== ===== HTML BLOCKS =====
-**Note:** This feature requires that either Dokuwiki's ''htmlok'' option or ckgedit's ''htmlblock'' option be set to true.((See [[:plugin:ckgedit:configuration#htmlblock_ok]])) It is ''false'' by default.  +**Note:** This feature requires that either Dokuwiki's ''htmlok'' option or ckgedit's ''htmlblock_ok'' option be set to true.((See [[:plugin:ckgedit:configuration#htmlblock_ok]])) It is ''false'' by default.  
 Feature added 22 Apr 2015. Feature added 22 Apr 2015.
  
Line 312: Line 312:
  
 It is possible to handle images of 2 - 2.5 MB in Firefox using the MS Word plugin.  Simply paste the image into the msword ''text'' window and click ''OK'' Sometimes a vertically large image will stretch the msword window beyond the bottom margin of the browser.  To get it back to the default size click the ''instructions'' tab.  Then without going back to the text tab, click ''OK''. It is possible to handle images of 2 - 2.5 MB in Firefox using the MS Word plugin.  Simply paste the image into the msword ''text'' window and click ''OK'' Sometimes a vertically large image will stretch the msword window beyond the bottom margin of the browser.  To get it back to the default size click the ''instructions'' tab.  Then without going back to the text tab, click ''OK''.
- 
-A fool-proof method of copying and pasting is to install the [[plugin:imgpaste]] plugin. Then switch over to the DW Filebrowser.  Click on the ckgedit image button, then click on ''Browse Server'' and the Dokuwiki media manager will open.  You can then drag and drop your image onto the media manager. 
- 
  
  
Line 379: Line 376:
  
 ===== Compression ===== ===== Compression =====
-The ''.unc'' extension stands for "uncompressed" You can, however, compress these files using the [[https://github.com/yui/yuicompressor/releases|yuicompressor]].  The basic documentation is found at: https://github.com/yui/yuicompressor#global-options. For linux users, you can downlload a convenience script for compression: ** [[./ckgedit:compress.sh|any_cmpr]] **+The ''.unc'' extension stands for "uncompressed" You can, however, compress these files using the [[https://github.com/yui/yuicompressor/releases|yuicompressor]].  The basic documentation is found at: https://github.com/yui/yuicompressor#global-options. For linux users, you can download a convenience script for compression: ** [[./ckgedit:compress.sh|any_cmpr]] **
  
 ===== Editor Window Height ===== ===== Editor Window Height =====
Line 398: Line 395:
    
  
-| CTRL + I |italic| +| CTRL + I   | italic                          
-| CTRL + B |bold|  +| CTRL + B   | bold                            
-| CTRL  + U |underline| +| CTRL  + U  | underline                       
-| CTRL + Z |undo| +| CTRL + Z   | undo                            
-| CTRL + Y  |redo| +| CTRL + Y   | redo                            
-| CTRL + L |link| +| CTRL + L   | link                            
-| ALT + -   |numbered list| +| 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     | close editor and save document  |
  
 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 422: 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.  This feature is governed by the [[plugin:ckgedit:configuration#dw_edit_display]] configuration option.  This method of accessing the Dokuwiki editor will work when either the CKEditor or the Dokuwiki editor is in effect. 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.  This feature is governed by the [[plugin:ckgedit:configuration#dw_edit_display]] configuration option.  This method of accessing the Dokuwiki editor will work when either the CKEditor or the Dokuwiki editor is in effect.
  
-You may initially have to clear both the browser cache and your Dokuwiki cache. See: [[devel:caching]]. +You may initially have to clear both the browser cache and your Dokuwiki cache. See: [[devel:caching]]. 
 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's ''page tools'' menu.  It can be installed from the Extension Manager using the following url: [[https://github.com/turnermm/dwedit/tarball/master|]]. For users of the default Dokuwiki template this adds a ''DW Edit'' button to the page tools series at the right of the template.  If not using the Dokuwiki templateyou can add a ''DW Edit'' link to your template using the following code placed in a php block+The [[plugin:dwedit]] plugin is a small plugin that gives immediate direct access to the Dokuwiki editor from the Dokuwiki template's ''page tools'' menu.  For users of the default Dokuwiki template and templates based on it, the [[plugin:dwedit]] plugin adds a ''DW Edit'' button to the page tools series at the right of the template.  Like the deouble click methodthis method is also governed by the [[plugin:ckgedit:configuration#dw_edit_display]] configuration option. 
-     tpl_toolsevent('dweditlink', array()); + 
- + 
            
 ===== Dokuwiki Entities with left-hand angle brackets ===== ===== Dokuwiki Entities with left-hand angle brackets =====
Line 531: Line 529:
 [[plugin:ckgedit:discussion_3]] [[plugin:ckgedit:discussion_3]]
   - Unwanted code replacement    - Unwanted code replacement 
-  - blank page while click "Broswe Server" button in image properties popup+  - blank page while click "Browse Server" button in image properties popup
   - ckgedit for monobook and vector templates (skins)    - ckgedit for monobook and vector templates (skins) 
   - Importing Documents   - Importing Documents
plugin/ckgedit.1595898788.txt.gz · Last modified: 2020-07-28 03:13 by turnermm

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki