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
plugin:ckgedit:configuration [2020-08-07 15:02] – [ckgedit Configuration Options] turnermmplugin:ckgedit:configuration [2023-02-10 12:49] (current) – [Table] 85.232.31.60
Line 3: Line 3:
 ======  ckgedit Configuration Options ====== ======  ckgedit Configuration Options ======
  
-^ Name                                        ^ Setting                                                                                                                                                                                                                                                                     ^  Default Value    ^ +^ Name                                        ^ Setting                                                                                                                                                                                                                                                                                             ^  Default Value    ^ 
-| [[#guest_toolbar|guest_toolbar]]            | Display Toolbar to Guests                                                                                                                                                                                                                                                   | true              | +| [[#guest_toolbar|guest_toolbar]]            | Display Toolbar to Guests                                                                                                                                                                                                                                                                           | true              | 
-| [[#guest_media|guest_media]]                | Guest Can Link to Media Files                                                                                                                                                                                                                                               | true              | +| [[#guest_media|guest_media]]                | Guest Can Link to Media Files                                                                                                                                                                                                                                                                       | true              | 
-| [[#open_upload|open_upload]]                | Guests can upload                                                                                                                                                                                                                                                           | false             | +| [[#open_upload|open_upload]]                | Guests can upload                                                                                                                                                                                                                                                                                   | false             | 
-| [[#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             | 
-| [[#create_folder|create_folder]]            | Enable folder creation                                                                                                                                                                                                                                                      | n                 | +| [[#create_folder|create_folder]]            | Enable folder creation                                                                                                                                                                                                                                                                              | n                 | 
-| [[#dwedit_ns|dwedit_ns]]                    | Namespaces and/or files where DokuWiki Editor is activated                                                                                                                                                                                                                  | none              | +| [[#dwedit_ns|dwedit_ns]]                    | Namespaces and/or files where DokuWiki Editor is activated                                                                                                                                                                                                                                          | none              | 
-| [[#acl_del|acl_del]]                        | Strict ACL delete                                                                                                                                                                                                                                                           | false             | +| [[#acl_del|acl_del]]                        | Strict ACL delete                                                                                                                                                                                                                                                                                   | false             | 
-| [[#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             | 
-| [[#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                                                                                                                                                                                                                                                                             disabled          
-| [[#scayt_lang|scayt_lang]]                  | Set Scayt language                                                                                                                                                                                                                                                          | American English +| [[#scayt_lang|scayt_lang]]                  | Set Scayt language                                                                                                                                                                                                                                                                                  | American English 
-| [[#smiley_hack|smiley_hack]]                | See note                                                                                                                                                                                                                                                                    | false             | +| [[#smiley_hack|smiley_hack]]                | See note                                                                                                                                                                                                                                                                                            | false             | 
-| [[#complex_tables|complex_tables]]          | Turn on complex tables parser.                                                                                                                                                                                                                                              | true              | +| [[#complex_tables|complex_tables]]          | Turn on complex tables parser.                                                                                                                                                                                                                                                                      | true              | 
-| [[#duplicate_notes|duplicate_notes]]        | Enable notes with same text                                                                                                                                                                                                                                                 | false             | +| [[#duplicate_notes|duplicate_notes]]        | Enable notes with same text                                                                                                                                                                                                                                                                         | false             | 
-| [[#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 (removed in hogfather)                                                                                                                                                                                                                                              | 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             | 
-| [[#font_styling_options|nofont_styling]]    | Display font styles in editor as plugin markup                                                                                                                                                                                                                              | false             | +| [[#font_styling_options|nofont_styling]]    | Display font styles in editor as plugin markup                                                                                                                                                                                                                                                      | false             | 
-| [[#alt_toolbar|]]                           | Items to remove from CKEditor toolbar                                                                                                                                                                                                                                       | %%""%%            | +| [[#alt_toolbar|]]                           | Items to remove from CKEditor toolbar                                                                                                                                                                                                                                                               | %%""%%            | 
-| [[#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.                                                                                                                                                                                                                                                        | moono                  +| [[#gui]]                                    | Select CKEditor GUI.                                                                                                                                                                                                                                                                                | moono-lisa        
-| [[#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|+| [[#style_sheet]]                            | Use an alternate style sheet for the Ckeditor editing window                                                                                                                                                                                                                                        | false             | 
 +| [[#imgpaste]]                               | If the imgpaste plugin is installed, use the imgpaste naming system for naming your saved images.                                                                                                                                                                                                   | true              |
 ===== Notes ===== ===== Notes =====
  
-=== guest_toolbar ===+==== guest_toolbar ====
  
 The default settings allow guests to have access to the toolbars and to the link and image tools. However, guests cannot upload, unless **open_upload** is set to true. Setting **open_upload** to true could be used to implement a completely open wiki, where anyone can edit and upload. The default settings allow guests to have access to the toolbars and to the link and image tools. However, guests cannot upload, unless **open_upload** is set to true. Setting **open_upload** to true could be used to implement a completely open wiki, where anyone can edit and upload.
Line 51: Line 52:
 ---- ----
  
-=== guest_media ===+==== guest_media ====
  
 If “Display Toolbar to Guests” is set to false, guests are presented with a toolbar consisting of two items, About and Source. If “Display Toolbar to Guests” is set to false, guests are presented with a toolbar consisting of two items, About and Source.
Line 57: Line 58:
 ---- ----
  
-=== open_upload ===+==== open_upload ====
 If the toolbar is allowed and “Guests can Upload” is false, then visitors will not be able to upload files to the server by means of the image and link tools. However, they will still be able to view the contents of your data/media directories. See also [[#guest_toolbar|guest_toolbar]] If the toolbar is allowed and “Guests can Upload” is false, then visitors will not be able to upload files to the server by means of the image and link tools. However, they will still be able to view the contents of your data/media directories. See also [[#guest_toolbar|guest_toolbar]]
 ---- ----
  
-=== default_fb ===+==== default_fb ====
 The file browser is acl-compliant, but the administrator can turn off acl by changing this option to 'none' The file browser is acl-compliant, but the administrator can turn off acl by changing this option to 'none'
 ---- ----
  
-=== openfb ===+==== openfb ====
 Normally, the file browser opens in the the namespace of the page being edited or in the directory immediately above it, if the user has write/create permission in that directory. But if Open File Browsing is set to true, the user will be able to access the entire directory hierarchy; however, ACL permissions still will apply, unless they have been turned off. That means that the user will be able to read the contents of all directories for which he has Read permission but will not be able to upload to those directories for which he does not have upload permission. In the case of administrators, the browser will always open in the root directory. Normally, the file browser opens in the the namespace of the page being edited or in the directory immediately above it, if the user has write/create permission in that directory. But if Open File Browsing is set to true, the user will be able to access the entire directory hierarchy; however, ACL permissions still will apply, unless they have been turned off. That means that the user will be able to read the contents of all directories for which he has Read permission but will not be able to upload to those directories for which he does not have upload permission. In the case of administrators, the browser will always open in the root directory.
 ---- ----
  
-=== 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. 
 ---- ----
  
-=== smiley_as_text ===+==== smiley_as_text ====
 This governs how Dokuwiki smileys appear in the editor window. At the initial insertion, they will be inserted as images. They are, however, saved as text.  Setting this option to true will cause Dokuwiki smileys always to show up as text in the editing window. They will of course still appear as images in the browser. This governs how Dokuwiki smileys appear in the editor window. At the initial insertion, they will be inserted as images. They are, however, saved as text.  Setting this option to true will cause Dokuwiki smileys always to show up as text in the editing window. They will of course still appear as images in the browser.
 ---- ----
  
-=== editor_bak ===+==== editor_bak ====
 If true, a copy of the current state of the editing window will be saved to a meta file in the meta directory, with the same name as the document being edited but with a .ckgedit extension. If true, a copy of the current state of the editing window will be saved to a meta file in the meta directory, with the same name as the document being edited but with a .ckgedit extension.
 ---- ----
  
-=== create_folder ===+==== create_folder ====
 If set to 'y', a folder creation button will appear at the bottom of the fle browser. Folder cannot be created by guests.   If set to 'y', a folder creation button will appear at the bottom of the fle browser. Folder cannot be created by guests.  
 ---- ----
-=== dwedit_ns ===+==== dwedit_ns ====
 A comma separated list of files and namespace where the Dokuwiki editor is automatically loaded instead of the CKEditor.  The code looks only for partial matches.  So if you have "jack", it will find "blackjack" and "jack_pine". A comma separated list of files and namespace where the Dokuwiki editor is automatically loaded instead of the CKEditor.  The code looks only for partial matches.  So if you have "jack", it will find "blackjack" and "jack_pine".
 ---- ----
-=== acl_del ===+==== acl_del ====
 The filebrowser has been set up with a loose intepretation of the permission to delete files from a folder.  By default it allows users with upload permission in a folder to delete files from that folder.  This is not consistent with Dokuwiki's ACL rules which require delete permission. When this option is set to true deletes are consistent with the Dokuwiki ACLs. The filebrowser has been set up with a loose intepretation of the permission to delete files from a folder.  By default it allows users with upload permission in a folder to delete files from that folder.  This is not consistent with Dokuwiki's ACL rules which require delete permission. When this option is set to true deletes are consistent with the Dokuwiki ACLs.
 ---- ----
-=== auth_ci ===+==== auth_ci ====
 If logins are case insensitive, that is you can login as both USER and user, set this to true. If logins are case insensitive, that is you can login as both USER and user, set this to true.
 ---- ----
-=== 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.
 ---- ----
-=== direction ===+==== direction ====
 This option controls the language direction in the CKEditor.  There are three opitons: (1) 'nocheck', which in effect does nothing and is essentially the same as 'ltr'; (2) 'dokuwiki', which changes the language direction to the direction set by Dokuwiki, based on the current language selection; (3) 'ltr', which sets left-to-right, and (4) 'rtl', which enables right-to-left.  It is possible, with these options, to have your browser set to one direction and the FCKeditor to another. This option controls the language direction in the CKEditor.  There are three opitons: (1) 'nocheck', which in effect does nothing and is essentially the same as 'ltr'; (2) 'dokuwiki', which changes the language direction to the direction set by Dokuwiki, based on the current language selection; (3) 'ltr', which sets left-to-right, and (4) 'rtl', which enables right-to-left.  It is possible, with these options, to have your browser set to one direction and the FCKeditor to another.
 ---- ----
  
-=== scayt_auto === +==== scayt_off ==== 
-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 ====
 The default language is American English. The default language is American English.
 ---- ----
-=== smiley_hack ===+==== smiley_hack ====
 This option applies only to the CKEditor smileys, not the Dokuwiki smileys. If you move to a new server, turn this option on until all pages with these smileys have been converted to the new server address.  Turn it off when finished, otherwise it will keep re-writing URLs that have already been changed and needlessly using processing time. See the [[http://mturner.org/fckgLite/doku.php?id=faq#smileys|faq]] on smileys. This option applies only to the CKEditor smileys, not the Dokuwiki smileys. If you move to a new server, turn this option on until all pages with these smileys have been converted to the new server address.  Turn it off when finished, otherwise it will keep re-writing URLs that have already been changed and needlessly using processing time. See the [[http://mturner.org/fckgLite/doku.php?id=faq#smileys|faq]] on smileys.
 ---- ----
-=== complex_tables ===+==== complex_tables ====
 As of May 29/2016 this is set to ''true'' by default. It turns on the complex tables parser.  While aimed at tables that use multiple column  and row spans, it does not incur a perceptible performance hit for simple tables.  As of May 29/2016 this is set to ''true'' by default. It turns on the complex tables parser.  While aimed at tables that use multiple column  and row spans, it does not incur a perceptible performance hit for simple tables. 
 When this option is turned off in the Configuration Manager, a checkbox will appear below the editing window enabling you to turn on the complex table parse on a per page basis. It is also possible to turn on the complex tables parser on a per page basis by placing the ~~COMPLEX_TABLES~~ macro at the top of the page.  When this option is turned off in the Configuration Manager, a checkbox will appear below the editing window enabling you to turn on the complex table parse on a per page basis. It is also possible to turn on the complex tables parser on a per page basis by placing the ~~COMPLEX_TABLES~~ macro at the top of the page. 
Line 118: Line 124:
 **Note:** The complex tables parser is required if you are using font styles on the same page as tables.  **Note:** The complex tables parser is required if you are using font styles on the same page as tables. 
 ---- ----
-=== duplicate_notes ===+==== duplicate_notes ====
 When Dokuwiki encounters footnotes with identical texts, it merges the footnote references on a single line and displays the footnote text only once, instead of duplicating.  For instance:\\ When Dokuwiki encounters footnotes with identical texts, it merges the footnote references on a single line and displays the footnote text only once, instead of duplicating.  For instance:\\
-1), 3), 7) See [[http://www.dokuwiki.org/devel|http://www.dokuwiki.org/devel]]\\+1), 3), 7) See [[:development]]\\
 Ckgedit needs to know if your users are creating these kinds of notes.  If they do, then you must set this option to true; otherwise, the footnotes will become corrupted.  With this option set to true, in the editor each of the duplicate footnotes will appear on a separate line, but when in the browser, they will appear as above. Ckgedit needs to know if your users are creating these kinds of notes.  If they do, then you must set this option to true; otherwise, the footnotes will become corrupted.  With this option set to true, in the editor each of the duplicate footnotes will appear on a separate line, but when in the browser, they will appear as above.
 ---- ----
  
-=== winstyle ===+==== winstyle ====
 On linux systems, data/media is normally accessed through symbolic links in fckeditor/userstyles, which link to data/media.  The ''winstyle'' option gives direct access to data/media.  In order for it to work with apache servers, you must have the correct file in data/media. Current versions of ckgedit will install the correct .htaccess file to  data/media when the winstyle option is selected. The reason for this is that Dokuwiki by default prevents direct access to your data. For older version copy .htaccess.security from fckeditor/userfiles to data/media and rename it .htaccess. .htaccess.security relaxes this restriction with respect to the basic image formats: ''.gif'', ''.jpg'', ''.png'' See [[http://mturner.org/fckgLite/doku.php?id=media#security_and_the_media_directory|security_and_the_media_directory]]. **Note:**   On linux systems, data/media is normally accessed through symbolic links in fckeditor/userstyles, which link to data/media.  The ''winstyle'' option gives direct access to data/media.  In order for it to work with apache servers, you must have the correct file in data/media. Current versions of ckgedit will install the correct .htaccess file to  data/media when the winstyle option is selected. The reason for this is that Dokuwiki by default prevents direct access to your data. For older version copy .htaccess.security from fckeditor/userfiles to data/media and rename it .htaccess. .htaccess.security relaxes this restriction with respect to the basic image formats: ''.gif'', ''.jpg'', ''.png'' See [[http://mturner.org/fckgLite/doku.php?id=media#security_and_the_media_directory|security_and_the_media_directory]]. **Note:**  
 ---- ----
  
  
-=== other_lang ===+==== other_lang ====
 Select interface language for CKEditor: defaults to language set for browser.  This choice is independent of the Dokuwiki interface language option. Select interface language for CKEditor: defaults to language set for browser.  This choice is independent of the Dokuwiki interface language option.
 ---- ----
-=== 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 ====
 ** color_options **, ** font_options **, ** nofont_styling ** \\ ** color_options **, ** font_options **, ** nofont_styling ** \\
 These options are covered on the page devoted to [[plugin:ckgedit:font_styling#configuration_options_specific_to_font_styling|styling issues]]. These options are covered on the page devoted to [[plugin:ckgedit:font_styling#configuration_options_specific_to_font_styling|styling issues]].
  
 ---- ----
-=== alt_toolbar ===+==== alt_toolbar ====
 This setting  provides a checkbox listing of Ckeditor toolbar items.  To remove items from the toolbar, check their boxes.  See [[https://github.com/turnermm/ckgedit/issues/184|ckgedit issues number 184]]. This setting  provides a checkbox listing of Ckeditor toolbar items.  To remove items from the toolbar, check their boxes.  See [[https://github.com/turnermm/ckgedit/issues/184|ckgedit issues number 184]].
 ---- ----
-=== mfiles ===+==== mfiles ====
 The setting adds an ''m-files'' protocol entry to the link dialog.  See: https://www.m-files.com/en The setting adds an ''m-files'' protocol entry to the link dialog.  See: https://www.m-files.com/en
 ---- ----
-=== 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 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 extra plugins.\\
 *Note: the plugins directory can be found here: /lib/plugins/ckgedit/ckeditor/plugins *Note: the plugins directory can be found here: /lib/plugins/ckgedit/ckeditor/plugins
Line 156: 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 165: Line 175:
  
 ---- ----
-=== captcha_auth ===+==== captcha_auth ====
 Ckgedit's captcha support is integrated for use with the [[plugin:captcha|captcha plugin]] and will not work with other captcha plugins.  When the [[plugin:captcha]] plugin's ''foruser'' option is set to true, ''ckgedit'' makes it possible to set the ACL level for which users will get the captcha.  For this, the ''captcha_auth'' option supplies a drop-down menu of AUTH choices. Ckgedit's captcha support is integrated for use with the [[plugin:captcha|captcha plugin]] and will not work with other captcha plugins.  When the [[plugin:captcha]] plugin's ''foruser'' option is set to true, ''ckgedit'' makes it possible to set the ACL level for which users will get the captcha.  For this, the ''captcha_auth'' option supplies a drop-down menu of AUTH choices.
 ---- ----
-=== htmlblock_ok ===+==== htmlblock_ok ====
 When using ''HTML_BLOCK'' either this setting or Dokuwiki's ''htmlok'' option must be enabled. ''htmlblock_ok'' doesn't pose the same level of security  risk as ''htmlok'', because the parser is not designed to recognize scripted elements.  But there is never absolute security. Therefore, ''HTML_BLOCK''s should be used only in a trusted user environment, and certainly not in an open wiki.  If you are pasting HTML from an external source then htmlok must be enabled--but you do not need the ''html'' tags. When using ''HTML_BLOCK'' either this setting or Dokuwiki's ''htmlok'' option must be enabled. ''htmlblock_ok'' doesn't pose the same level of security  risk as ''htmlok'', because the parser is not designed to recognize scripted elements.  But there is never absolute security. Therefore, ''HTML_BLOCK''s should be used only in a trusted user environment, and certainly not in an open wiki.  If you are pasting HTML from an external source then htmlok must be enabled--but you do not need the ''html'' tags.
  
 ---- ----
  
-=== dblclk ===+==== dblclk ====
 Clicking on a dokuwiki section while ckgedit is active will open that section for editing in the native dokuwiki editor.  This feature is on by default and can be set to off with this option. Clicking on a dokuwiki section while ckgedit is active will open that section for editing in the native dokuwiki editor.  This feature is on by default and can be set to off with this option.
  
 ---- ----
-=== preserve_enc ===+==== preserve_enc ====
 When links are created with the link tool, when saved ckgedit converts these to their native forms if dokuwiki's [[config:deaccent]] setting is set to ''remove accents''. For instance ''%26'' will be converted to ''&'' If you need to keep these urlencodings in your urls, set this to true.  When links are created with the link tool, when saved ckgedit converts these to their native forms if dokuwiki's [[config:deaccent]] setting is set to ''remove accents''. For instance ''%26'' will be converted to ''&'' If you need to keep these urlencodings in your urls, set this to true. 
 ---- ----
-=== gui ===+==== gui ====
  
 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. 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 ====
 If this option is set to true internal links, and media links will automatically be converted to relative links.   If this option is set to true internal links, and media links will automatically be converted to relative links.  
  
 ---- ----
-=== allow_ckg_filebrowser ===+==== allow_ckg_filebrowser ====
 Choices are all, ckgedit, dokuwiki \\ Choices are all, ckgedit, dokuwiki \\
-See: [[plugin:ckgdoku#configuration|ckgdoku configuration]] 
 ---- ----
 === default_ckg_filebrowser === === default_ckg_filebrowser ===
 Choices are ckgedit, dokuwiki \\ Choices are ckgedit, dokuwiki \\
-See: [[plugin:ckgdoku#configuration|ckgdoku configuration]]  
- 
 ---- ----
  
-=== style_sheet ===+==== 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. 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.
 ---- ----
    
 +==== imgpaste ==== 
 +If [[:plugin:imgpaste]] is installed, ckgedit can use its [[plugin:imgpaste#configuration_and_settings|filename]] setting for naming saved images. Otherwise it constructs a name fro the md5 data of the image and saves it to the current directory.
plugin/ckgedit/configuration.1596805345.txt.gz · Last modified: 2020-08-07 15:02 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