DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:ckgedit:configuration

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
Both sides next revision
plugin:ckgedit:configuration [2018-11-15 12:56]
turnermm
plugin:ckgedit:configuration [2020-10-13 21:34] (current)
turnermm [Notes]
Line 9: Line 9:
 | [[#default_fb|default_fb]]                  | Default File Browsing Access                                                                                                                                                                                                                                                | acl               | | [[#default_fb|default_fb]]                  | Default File Browsing Access                                                                                                                                                                                                                                                | acl               |
 | [[#openfb|openfb]]                          | Open File Browsing                                                                                                                                                                                                                                                          | false             | | [[#openfb|openfb]]                          | Open File Browsing                                                                                                                                                                                                                                                          | false             |
-| [[#dw_edit_display|dw_edit_display]]        | Controls user access to "DW Edit" button                                                                                                                                                                                                                                    | all               |+| [[#dw_edit_display|dw_edit_display]]        | Controls user access to dwedit features.                                                                                                                                                                                                                                   | all               |
 | [[#smiley_as_text|smiley_as_text]]          | Display Douwiki smileys as text in editor                                                                                                                                                                                                                                   | false             | | [[#smiley_as_text|smiley_as_text]]          | Display Douwiki smileys as text in editor                                                                                                                                                                                                                                   | false             |
 | [[#editor_bak|editor_bak]]                  | Save backup on Refresh                                                                                                                                                                                                                                                      | false             | | [[#editor_bak|editor_bak]]                  | Save backup on Refresh                                                                                                                                                                                                                                                      | false             |
Line 17: Line 17:
 | [[#auth_ci|auth_ci]]                        | User login id is case insensitive                                                                                                                                                                                                                                           | false             | | [[#auth_ci|auth_ci]]                        | User login id is case insensitive                                                                                                                                                                                                                                           | false             |
 | [[#nix_style|nix_style]]                    | Access data/media via userfiles (Windows)                                                                                                                                                                                                                                   | false             | | [[#nix_style|nix_style]]                    | Access data/media via userfiles (Windows)                                                                                                                                                                                                                                   | false             |
-| [[#no_symlinks|no_symlinks]]                | Disable automatic creation of symbolic links  during install                                                                                                                                                                                                                | false             | 
 | [[#direction|direction]]                    | Set language direction                                                                                                                                                                                                                                                      | nocheck           | | [[#direction|direction]]                    | Set language direction                                                                                                                                                                                                                                                      | nocheck           |
 | [[#scayt_auto|scayt_auto]]                  | Scayt active at startup                                                                                                                                                                                                                                                     | on                | | [[#scayt_auto|scayt_auto]]                  | Scayt active at startup                                                                                                                                                                                                                                                     | on                |
Line 26: Line 25:
 | [[#winstyle|winstyle]]                      | Direct access to data/media                                                                                                                                                                                                                                                 | false             | | [[#winstyle|winstyle]]                      | Direct access to data/media                                                                                                                                                                                                                                                 | false             |
 | [[#other_lang|other_lang]]                  | Reset CKEditor language                                                                                                                                                                                                                                                     | default           | | [[#other_lang|other_lang]]                  | Reset CKEditor language                                                                                                                                                                                                                                                     | default           |
-| [[#preload_ckeditorjs|preload_ckeditorjs]]  | Preload CKEditor's javascript                                                                                                                                                                                                                                               | false             |+| [[#preload_ckeditorjs|preload_ckeditorjs]]  | Preload CKEditor's javascript (removed in hogfather)                                                                                                                                                                                                                                              | false             |
 | [[#font_styling_options|color_options]]     | Remove Color options                                                                                                                                                                                                                                                        | false             | | [[#font_styling_options|color_options]]     | Remove Color options                                                                                                                                                                                                                                                        | false             |
 | [[#font_styling_options|font_options]]      | Remove font options                                                                                                                                                                                                                                                         | false             | | [[#font_styling_options|font_options]]      | Remove font options                                                                                                                                                                                                                                                         | false             |
Line 33: Line 32:
 | [[#mfiles]]                                 | Enable mfile support                                                                                                                                                                                                                                                        | false             | | [[#mfiles]]                                 | Enable mfile support                                                                                                                                                                                                                                                        | false             |
 | [[#extra_plugins|]]                         | Comma-delimited list of user-defined tool bar items to be added to toolbar                                                                                                                                                                                                  | %%""%%            | | [[#extra_plugins|]]                         | Comma-delimited list of user-defined tool bar items to be added to toolbar                                                                                                                                                                                                  | %%""%%            |
-| [[#dw_priority|dw_priority]]                | Open with Dokuwiki Editor. See [[#dw_users]]. Not available in farms branches.                                                                                                                                                                                              | ckeditor          | +| [[#dw_priority|dw_priority]]                | Open with Dokuwiki Editor. See [[#dw_users]]. Not available in farms branches.  Incompatible with hogfather (removed).                                                                                                                                                                                            | ckeditor          | 
-| [[#dw_users|]]                              | Group whose editor defaults to the Dokuwiki editor when [[#dw_priority]] is set. When this option is given a value and ''dw_priority'' is set to true, then users can set the priority on an individual basis using the ''Update Profile'' link.  See [[#dw_users|below]].  | %%""%%            |+| [[#dw_users|]]                              | Group whose editor defaults to the Dokuwiki editor when [[#dw_priority]] is set. When this option is given a value and ''dw_priority'' is set to true, then users can set the priority on an individual basis using the ''Update Profile'' link.  Removed from hogfather. See [[#dw_users|below]].  | %%""%%            |
 | [[#captcha_auth]]                           | ACL level at which the captcha is turned off when the captcha plugin's forusers option is set to true.                                                                                                                                                                      | ACL_CREATE        | | [[#captcha_auth]]                           | ACL level at which the captcha is turned off when the captcha plugin's forusers option is set to true.                                                                                                                                                                      | ACL_CREATE        |
 | [[#htmlblock_ok]]                           | Enable ''HTML_BLOCK''                                                                                                                                                                                                                                                     | false             | | [[#htmlblock_ok]]                           | Enable ''HTML_BLOCK''                                                                                                                                                                                                                                                     | false             |
 | [[#dblclk]]                                 | Option to turn on or off double click access to the dokuwiki editor                                                                                                                                                                                                         | on                | | [[#dblclk]]                                 | Option to turn on or off double click access to the dokuwiki editor                                                                                                                                                                                                         | on                |
 | [[#preserve_enc]]                           | Preserve urlencoding in urls when the dokuwiki deaccent option is active                                                                                                                                                                                                    |false             | | [[#preserve_enc]]                           | Preserve urlencoding in urls when the dokuwiki deaccent option is active                                                                                                                                                                                                    |false             |
-| [[#gui]]                                    | Select CKEditor GUI.                                                                                                                                                                                                                                                        |                   |+| [[#gui]]                                    | Select CKEditor GUI.                                                                                                                                                                                                                                                        | moono                  |
 | [[#rel_links]]                              | Activate support for relative internal and image links                                                                                                                                                                                                                      |false            | | [[#rel_links]]                              | Activate support for relative internal and image links                                                                                                                                                                                                                      |false            |
 | [[#allow_ckg_filebrowser]]                  | Select which file/media browser(s) users can use                                                                                                                                                                                                                            | all               | | [[#allow_ckg_filebrowser]]                  | Select which file/media browser(s) users can use                                                                                                                                                                                                                            | all               |
 | [[#default_ckg_filebrowser]]                | Select default file/media browser; overridden if the selected browser is not allowed                                                                                                                                                                                        | ckgedit           | | [[#default_ckg_filebrowser]]                | Select default file/media browser; overridden if the selected browser is not allowed                                                                                                                                                                                        | ckgedit           |
 +|[[#style_sheet]]|Use an alternate style sheet for the Ckeditor editing window|false|
 ===== Notes ===== ===== Notes =====
  
Line 70: Line 70:
  
 === dw_edit_display === === dw_edit_display ===
-This option governs access to the 'DW Edit' button. There are three options: 'all', which gives access to all users; 'admin', which restricts access to administrators; and 'none', which hides the button from all users.  This option also governs the [[plugin:ckgedit#double_click_method|double-click method]] of opening the Dokuwiki editor.+This option governs the different methods of accessing the native dokuwiki editor: 
 +  - the 'DW Edit' button, located below ckgedit's editing window  
 +  - the double-click method of opening the editor for section editing 
 +  - the [[plugin:dwedit]] toolbar icon which can be inserted among the [[https://www.dokuwiki.org/main_window?s[]=page%20tools#page_tools|page tools]] 
 + 
 +There are three options: 'all', which gives access to all users; 'admin', which restricts access to administrators; and 'none', which hides the button from all users. 
 ---- ----
  
Line 95: Line 100:
 === nix_style === === nix_style ===
 For Windows Servers (Vista and Later). This setting makes it possible to access data\media through ckgedit\fckeditor\userfiles, if links to media and file have been successfully created in userfiles. This option is helpful in some cases where the savedir has been moved. For Windows Servers (Vista and Later). This setting makes it possible to access data\media through ckgedit\fckeditor\userfiles, if links to media and file have been successfully created in userfiles. This option is helpful in some cases where the savedir has been moved.
----- 
-=== no_symlinks === 
-Disable automatic creation of symbolic links in fckg/userfiles. This setting applies to installations, where ckgedit attempts to create symlinks.  
 ---- ----
 === direction === === direction ===
Line 104: Line 106:
  
 === scayt_auto === === scayt_auto ===
-When set to "on" the SCAYT check=as-you-type spell checker is immediately active when the editing window is opened.  When set to "off", users can click on the spell-check toolbar button and select "enable SCAYT" to make check-as-you-type active or use the "Check spelling" option.  When set to "disable" The spell checker is removed entirely. The Scayt service sends page-data back and forth between its servers for spell checking.  Users concerned that this is a security risk can read the exchange of views at https://github.com/turnermm/ckgedit/issues/434.+When set to "on" the SCAYT check-=as-you-type spell checker is immediately active when the editing window is opened.  When set to "off", users can click on the spell-check toolbar button and select "enable SCAYT" to make check-as-you-type active or use the "Check spelling" option.  When set to "disable" The spell checker is removed entirely. The Scayt service sends page-data back and forth between its servers for spell checking.  Users concerned that this is a security risk can read the exchange of views at https://github.com/turnermm/ckgedit/issues/434.
 ---- ----
 === scayt_lang === === scayt_lang ===
Line 136: Line 138:
 ---- ----
 === dw_priority === === dw_priority ===
 +** Removed from hogfather because of incompatibilities ** \\ 
 +** In hogfather you should remove any reference to it from ''local.php'' ** \\
 By default, the editor opens with the CKEditor.  Selecting this option will override the default behavior so that the Dokuwiki text-based editor will have priority.  Users can still switch back and forth between the editors, but when the browser is closed and re-opened, the Dokuwiki editor will be selected.  If the user logs off but does not close down the browser, the last editor to have been selected will open.  This behavior can be changed using the [[#dw_users|]] setting either alone or in conjunction with the selection options under ''Update Profile''. By default, the editor opens with the CKEditor.  Selecting this option will override the default behavior so that the Dokuwiki text-based editor will have priority.  Users can still switch back and forth between the editors, but when the browser is closed and re-opened, the Dokuwiki editor will be selected.  If the user logs off but does not close down the browser, the last editor to have been selected will open.  This behavior can be changed using the [[#dw_users|]] setting either alone or in conjunction with the selection options under ''Update Profile''.
 ---- ----
 === preload_ckeditorjs === === preload_ckeditorjs ===
-When set to true, this option will cause the ckeditor's javascript to be loaded on start up, instead of when the editor is first opened.  This speeds up the initial loading of the editor into the browser, because the javascript will have been saved in the browser's cache. Apart from icons and images, the ckeditor is implemented entirely in javascript.  This should have minimal affect on visitors to the site because the ckeditor's javascript is not output until after the curret page has been sent to the browser.+When set to true, this option will cause the ckeditor's javascript to be loaded on start up, instead of when the editor is first opened.  This speeds up the initial loading of the editor into the browser, because the javascript will have been saved in the browser's cache. Apart from icons and images, the ckeditor is implemented entirely in javascript.  This should have minimal affect on visitors to the site because the ckeditor's javascript is not output until after the curret page has been sent to the browser. (Removed in hogfather)
 ---- ----
 === Font Styling Options === === Font Styling Options ===
Line 153: Line 157:
 ---- ----
 === extra_plugins === === extra_plugins ===
-You can add your own plugins to the editor by creating, or downloading from the CKEditor site, a CKEditor plugin and including it in ''ckeditor/plugins''. The new plugin directory must be lower case. Use this setting to add new toolbar buttons for these additional  plugins. The name(s) of the item(s) must be the name(s) that define the toolbar button. Typically they begin with an upper case letter; these names will be converted to lower case and added to the list of exta plugins.+You can add your own plugins to the editor by creating, or downloading from the CKEditor site, a CKEditor plugin and including it in ''ckeditor/plugins''*. The new plugin directory must be lower case. Use this setting to add new toolbar buttons for these additional  plugins. The name(s) of the item(s) must be the name(s) that define the toolbar button. Typically they begin with an upper case letter; these names will be converted to lower case and added to the list of extra plugins.\\ 
 +*Note: the plugins directory can be found here: /lib/plugins/ckgedit/ckeditor/plugins
  
 An example extra plugin is included with the ckgedit distribution.  This is the ''timestamp'' plugin; its button name is ''Timestamp''. Therefore this setting must be ''Timestamp'' with the upper case ''T'', and not ''timestamp''. The language files for these plugins should conform to those found in ''timestamp''; they should be included in ''<your_plugin/lang>'', and an entry for each language file should be added to the ''lang'' property of the plugin file (see ''timestamp/plugin.js'').  The icons for these extra plugins will appear at the end of the toolbar.  The geshi plugin is also handled as an extra plugin. An example extra plugin is included with the ckgedit distribution.  This is the ''timestamp'' plugin; its button name is ''Timestamp''. Therefore this setting must be ''Timestamp'' with the upper case ''T'', and not ''timestamp''. The language files for these plugins should conform to those found in ''timestamp''; they should be included in ''<your_plugin/lang>'', and an entry for each language file should be added to the ''lang'' property of the plugin file (see ''timestamp/plugin.js'').  The icons for these extra plugins will appear at the end of the toolbar.  The geshi plugin is also handled as an extra plugin.
Line 159: Line 164:
 ---- ----
 === dw_users === === dw_users ===
 +** Removed from hogfather because of incompatibilities.**\\
 +** In hogfather you should remove any references to it from ''local.php''. ** \\
 Sets the ''dw_users'' group for use with [[#dw_priority|]]. There is a hierarchy of priority settings. Sets the ''dw_users'' group for use with [[#dw_priority|]]. There is a hierarchy of priority settings.
-  - If [[#dw_priority|]] has been set and no dw_users group has been supplied, then all users will get the dokuwiki editor as their default editor.+  - If [[#dw_priority|]] has been set and no dw_users group has been supplied, then all users will get the dokuwiki editor as their default editor. 
   - If the user has made a selection under ''Update Profile'', then the selected editor will be used.  In order to enable the ''Update Profile'' selection, both [[#dw_users|]] and [[#dw_priority|]] must be set.   - If the user has made a selection under ''Update Profile'', then the selected editor will be used.  In order to enable the ''Update Profile'' selection, both [[#dw_users|]] and [[#dw_priority|]] must be set.
   - If the user has not made a selection under ''Update Profile'', then the dw_users group determines the choice of editor.   - If the user has not made a selection under ''Update Profile'', then the dw_users group determines the choice of editor.
Line 184: Line 191:
 === gui === === gui ===
  
-Currently there are two CKEditor GUIs: [[https://ckeditor.com/addon/moono|moono]] and [[https://ckeditor.com/addon/moono-lisa|moono-lisa]]   Default is moono.+There are three CKEditor GUIs: [[https://ckeditor.com/addon/moono|moono]][[https://ckeditor.com/addon/moono-lisa|moono-lisa]], [[https://ckeditor.com/cke4/addon/kama|kama]].   Default is moono.
 ---- ----
 === rel_links === === rel_links ===
Line 200: Line 207:
 ---- ----
  
 +=== style_sheet ===
 +See [[:plugin:ckgedit:style_sheets|ckgedit:style_sheets]] for instructions on how to create and install a style sheet for the CKEditor editing window which is based on your template.
 +----
    
  
plugin/ckgedit/configuration.1542282988.txt.gz · Last modified: 2018-11-15 12:56 by turnermm